***

# Client





* Full name: `\Seven\Api\Client`


## Constants

| Constant | Visibility | Type | Value |
|:---------|:-----------|:-----|:------|
|`BASE_URI`|public| |'https://gateway.seven.io/api'|

## Properties


### headers



```php
protected string[] $headers
```






***

### apiKey



```php
protected string $apiKey
```






***

### sentWith



```php
protected string $sentWith
```






***

### signingSecret



```php
protected ?string $signingSecret
```






***

## Methods


### __construct



```php
public __construct(string $apiKey, string $sentWith = 'php-api', ?string $signingSecret = null): mixed
```








**Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| `$apiKey` | **string** |  |
| `$sentWith` | **string** |  |
| `$signingSecret` | **?string** |  |




**Throws:**

- [`InvalidArgumentException`](../../InvalidArgumentException.md)



***

### getApiKey



```php
public getApiKey(): string
```












***

### getSentWith



```php
public getSentWith(): string
```












***

### setApiKey



```php
public setApiKey(string $apiKey): self
```








**Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| `$apiKey` | **string** |  |





***

### delete



```php
public delete(string $path, array $options = []): mixed
```








**Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| `$path` | **string** |  |
| `$options` | **array** |  |




**Throws:**

- [`ForbiddenIpException`](./Exception/ForbiddenIpException.md)

- [`SigningHashVerificationException`](./Exception/SigningHashVerificationException.md)

- [`RandomException`](../../Random/RandomException.md)

- [`UnexpectedApiResponseException`](./Exception/UnexpectedApiResponseException.md)

- [`InvalidApiKeyException`](./Exception/InvalidApiKeyException.md)

- [`MissingAccessRightsException`](./Exception/MissingAccessRightsException.md)



***

### request



```php
protected request(string $path, \Seven\Api\Library\HttpMethod $method, array $payload = []): mixed
```








**Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| `$path` | **string** |  |
| `$method` | **\Seven\Api\Library\HttpMethod** |  |
| `$payload` | **array** |  |




**Throws:**

- [`UnexpectedApiResponseException`](./Exception/UnexpectedApiResponseException.md)

- [`RandomException`](../../Random/RandomException.md)

- [`InvalidApiKeyException`](./Exception/InvalidApiKeyException.md)

- [`ForbiddenIpException`](./Exception/ForbiddenIpException.md)

- [`MissingAccessRightsException`](./Exception/MissingAccessRightsException.md)

- [`SigningHashVerificationException`](./Exception/SigningHashVerificationException.md)



***

### patch



```php
public patch(string $path, array $payload = []): mixed
```








**Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| `$path` | **string** |  |
| `$payload` | **array** |  |




**Throws:**

- [`ForbiddenIpException`](./Exception/ForbiddenIpException.md)

- [`SigningHashVerificationException`](./Exception/SigningHashVerificationException.md)

- [`UnexpectedApiResponseException`](./Exception/UnexpectedApiResponseException.md)

- [`RandomException`](../../Random/RandomException.md)

- [`MissingAccessRightsException`](./Exception/MissingAccessRightsException.md)

- [`InvalidApiKeyException`](./Exception/InvalidApiKeyException.md)



***

### post



```php
public post(string $path, array $payload = []): mixed
```








**Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| `$path` | **string** |  |
| `$payload` | **array** |  |




**Throws:**

- [`ForbiddenIpException`](./Exception/ForbiddenIpException.md)

- [`SigningHashVerificationException`](./Exception/SigningHashVerificationException.md)

- [`UnexpectedApiResponseException`](./Exception/UnexpectedApiResponseException.md)

- [`RandomException`](../../Random/RandomException.md)

- [`InvalidApiKeyException`](./Exception/InvalidApiKeyException.md)

- [`MissingAccessRightsException`](./Exception/MissingAccessRightsException.md)



***

### get



```php
public get(string $path, array $params = []): mixed
```








**Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| `$path` | **string** |  |
| `$params` | **array** |  |




**Throws:**

- [`ForbiddenIpException`](./Exception/ForbiddenIpException.md)

- [`SigningHashVerificationException`](./Exception/SigningHashVerificationException.md)

- [`UnexpectedApiResponseException`](./Exception/UnexpectedApiResponseException.md)

- [`RandomException`](../../Random/RandomException.md)

- [`InvalidApiKeyException`](./Exception/InvalidApiKeyException.md)

- [`MissingAccessRightsException`](./Exception/MissingAccessRightsException.md)



***


***
> Automatically generated on 2025-02-06