Commercetools\Api\Models\ApiClient\ApiClient Interface Reference

Inheritance diagram for Commercetools\Api\Models\ApiClient\ApiClient:

Public Member Functions
	getId ()
	getName ()
	getScope ()
	getSecret ()
	getLastUsedAt ()
	getDeleteAt ()
	getCreatedAt ()
	getAccessTokenValiditySeconds ()
	getRefreshTokenValiditySeconds ()
	setId (?string $id)
	setName (?string $name)
	setScope (?string $scope)
	setSecret (?string $secret)
	setLastUsedAt (?DateTimeImmutable $lastUsedAt)
	setDeleteAt (?DateTimeImmutable $deleteAt)
	setCreatedAt (?DateTimeImmutable $createdAt)
	setAccessTokenValiditySeconds (?int $accessTokenValiditySeconds)
	setRefreshTokenValiditySeconds (?int $refreshTokenValiditySeconds)
Public Member Functions inherited from Commercetools\Base\JsonObject
	get (string $field)
	with (callable $callable=null)

Public Attributes
const	FIELD_ID = 'id'
const	FIELD_NAME = 'name'
const	FIELD_SCOPE = 'scope'
const	FIELD_SECRET = 'secret'
const	FIELD_LAST_USED_AT = 'lastUsedAt'
const	FIELD_DELETE_AT = 'deleteAt'
const	FIELD_CREATED_AT = 'createdAt'
const	FIELD_ACCESS_TOKEN_VALIDITY_SECONDS = 'accessTokenValiditySeconds'
const	FIELD_REFRESH_TOKEN_VALIDITY_SECONDS = 'refreshTokenValiditySeconds'

Additional Inherited Members
Static Public Member Functions inherited from Commercetools\Base\JsonObject
static	of ($data=null)
static	fromArray (array $data=[])
static	fromStdClass (stdClass $data=null)

Detailed Description

Definition at line 15 of file ApiClient.php.

Member Function Documentation

getAccessTokenValiditySeconds()

Commercetools\Api\Models\ApiClient\ApiClient::getAccessTokenValiditySeconds

(

)

Expiration time in seconds for each access token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.

Returns

null|int

Implemented in Commercetools\Api\Models\ApiClient\ApiClientModel.

getCreatedAt()

Commercetools\Api\Models\ApiClient\ApiClient::getCreatedAt

(

)

Date and time (UTC) the APIClient was initially created.

Returns

null|DateTimeImmutable

Implemented in Commercetools\Api\Models\ApiClient\ApiClientModel.

getDeleteAt()

Commercetools\Api\Models\ApiClient\ApiClient::getDeleteAt

(

)

If set, the Client will be deleted on (or shortly after) this point in time.

Returns

null|DateTimeImmutable

Implemented in Commercetools\Api\Models\ApiClient\ApiClientModel.

getId()

Commercetools\Api\Models\ApiClient\ApiClient::getId

(

)

The OAuth2 client_id that can be used to obtain an access token.

Returns

null|string

Implemented in Commercetools\Api\Models\ApiClient\ApiClientModel.

getLastUsedAt()

Commercetools\Api\Models\ApiClient\ApiClient::getLastUsedAt

(

)

Date of the last day this APIClient was used to obtain an access token.

Returns

null|DateTimeImmutable

Implemented in Commercetools\Api\Models\ApiClient\ApiClientModel.

getName()

Commercetools\Api\Models\ApiClient\ApiClient::getName

(

)

Name of the APIClient.

Returns

null|string

Implemented in Commercetools\Api\Models\ApiClient\ApiClientModel.

getRefreshTokenValiditySeconds()

Commercetools\Api\Models\ApiClient\ApiClient::getRefreshTokenValiditySeconds

(

)

Inactivity expiration time in seconds for each refresh token obtained by the APIClient. Only present when set with the APIClientDraft. If not present the default value applies.

Returns

null|int

Implemented in Commercetools\Api\Models\ApiClient\ApiClientModel.

getScope()

Commercetools\Api\Models\ApiClient\ApiClient::getScope

(

)

Whitespace-separated list of OAuth scopes that can be used when obtaining an access token.

Returns

null|string

Implemented in Commercetools\Api\Models\ApiClient\ApiClientModel.

getSecret()

Commercetools\Api\Models\ApiClient\ApiClient::getSecret

(

)

Only shown once in the response of creating the APIClient. This is the OAuth2 client_secret that can be used to obtain an access token.

Returns

null|string

Implemented in Commercetools\Api\Models\ApiClient\ApiClientModel.

setAccessTokenValiditySeconds()

Commercetools\Api\Models\ApiClient\ApiClient::setAccessTokenValiditySeconds

(

?int

$accessTokenValiditySeconds

)

Parameters

?int	$accessTokenValiditySeconds

Implemented in Commercetools\Api\Models\ApiClient\ApiClientModel.

setCreatedAt()

Commercetools\Api\Models\ApiClient\ApiClient::setCreatedAt

(

?DateTimeImmutable

$createdAt

)

Parameters

?DateTimeImmutable

$createdAt

Implemented in Commercetools\Api\Models\ApiClient\ApiClientModel.

setDeleteAt()

Commercetools\Api\Models\ApiClient\ApiClient::setDeleteAt

(

?DateTimeImmutable

$deleteAt

)

Parameters

?DateTimeImmutable

$deleteAt

Implemented in Commercetools\Api\Models\ApiClient\ApiClientModel.

setId()

Commercetools\Api\Models\ApiClient\ApiClient::setId

(

?string

$id

)

Parameters

?string

$id

Implemented in Commercetools\Api\Models\ApiClient\ApiClientModel.

setLastUsedAt()

Commercetools\Api\Models\ApiClient\ApiClient::setLastUsedAt

(

?DateTimeImmutable

$lastUsedAt

)

Parameters

?DateTimeImmutable

$lastUsedAt

Implemented in Commercetools\Api\Models\ApiClient\ApiClientModel.

setName()

Commercetools\Api\Models\ApiClient\ApiClient::setName

(

?string

$name

)

Parameters

?string

$name

Implemented in Commercetools\Api\Models\ApiClient\ApiClientModel.

setRefreshTokenValiditySeconds()

Commercetools\Api\Models\ApiClient\ApiClient::setRefreshTokenValiditySeconds

(

?int

$refreshTokenValiditySeconds

)

Parameters

?int	$refreshTokenValiditySeconds

Implemented in Commercetools\Api\Models\ApiClient\ApiClientModel.

setScope()

Commercetools\Api\Models\ApiClient\ApiClient::setScope

(

?string

$scope

)

Parameters

?string

$scope

Implemented in Commercetools\Api\Models\ApiClient\ApiClientModel.

setSecret()

Commercetools\Api\Models\ApiClient\ApiClient::setSecret

(

?string

$secret

)

Parameters

?string

$secret

Implemented in Commercetools\Api\Models\ApiClient\ApiClientModel.

Member Data Documentation

FIELD_ACCESS_TOKEN_VALIDITY_SECONDS

const Commercetools\Api\Models\ApiClient\ApiClient::FIELD_ACCESS_TOKEN_VALIDITY_SECONDS = 'accessTokenValiditySeconds'

Definition at line 24 of file ApiClient.php.

FIELD_CREATED_AT

const Commercetools\Api\Models\ApiClient\ApiClient::FIELD_CREATED_AT = 'createdAt'

Definition at line 23 of file ApiClient.php.

FIELD_DELETE_AT

const Commercetools\Api\Models\ApiClient\ApiClient::FIELD_DELETE_AT = 'deleteAt'

Definition at line 22 of file ApiClient.php.

FIELD_ID

const Commercetools\Api\Models\ApiClient\ApiClient::FIELD_ID = 'id'

Definition at line 17 of file ApiClient.php.

FIELD_LAST_USED_AT

const Commercetools\Api\Models\ApiClient\ApiClient::FIELD_LAST_USED_AT = 'lastUsedAt'

Definition at line 21 of file ApiClient.php.

FIELD_NAME

const Commercetools\Api\Models\ApiClient\ApiClient::FIELD_NAME = 'name'

Definition at line 18 of file ApiClient.php.

FIELD_REFRESH_TOKEN_VALIDITY_SECONDS

const Commercetools\Api\Models\ApiClient\ApiClient::FIELD_REFRESH_TOKEN_VALIDITY_SECONDS = 'refreshTokenValiditySeconds'

Definition at line 25 of file ApiClient.php.

FIELD_SCOPE

const Commercetools\Api\Models\ApiClient\ApiClient::FIELD_SCOPE = 'scope'

Definition at line 19 of file ApiClient.php.

FIELD_SECRET

const Commercetools\Api\Models\ApiClient\ApiClient::FIELD_SECRET = 'secret'

Definition at line 20 of file ApiClient.php.

---

The documentation for this interface was generated from the following file:

• lib/commercetools-api/src/Models/ApiClient/ApiClient.php