Client

---

Client

• Full name: \Seven\Api\Client

Constants

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

Properties

headers

protected string[] $headers

---

apiKey

protected string $apiKey

---

sentWith

protected string $sentWith

---

signingSecret

protected ?string $signingSecret

---

Methods

__construct

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

Parameters:

Parameter	Type	Description
$apiKey	string
$sentWith	string
$signingSecret	?string

Throws:

• InvalidArgumentException

---

getApiKey

public getApiKey(): string

---

getSentWith

public getSentWith(): string

---

setApiKey

public setApiKey(string $apiKey): self

Parameters:

Parameter	Type	Description
$apiKey	string

---

delete

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

Parameters:

Parameter	Type	Description
$path	string
$options	array

Throws:

• ForbiddenIpException

• SigningHashVerificationException

• RandomException

• UnexpectedApiResponseException

• InvalidApiKeyException

• MissingAccessRightsException

---

request

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

• RandomException

• InvalidApiKeyException

• ForbiddenIpException

• MissingAccessRightsException

• SigningHashVerificationException

---

patch

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

Parameters:

Parameter	Type	Description
$path	string
$payload	array

Throws:

• ForbiddenIpException

• SigningHashVerificationException

• UnexpectedApiResponseException

• RandomException

• MissingAccessRightsException

• InvalidApiKeyException

---

post

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

Parameters:

Parameter	Type	Description
$path	string
$payload	array

Throws:

• ForbiddenIpException

• SigningHashVerificationException

• UnexpectedApiResponseException

• RandomException

• InvalidApiKeyException

• MissingAccessRightsException

---

get

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

Parameters:

Parameter	Type	Description
$path	string
$params	array

Throws:

• ForbiddenIpException

• SigningHashVerificationException

• UnexpectedApiResponseException

• RandomException

• InvalidApiKeyException

• MissingAccessRightsException

---

---

Automatically generated on 2025-02-06