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

Public Member Functions
	__construct (?string $id=null, ?string $name=null, ?string $scope=null, ?string $secret=null, ?DateTimeImmutable $lastUsedAt=null, ?DateTimeImmutable $deleteAt=null, ?DateTimeImmutable $createdAt=null, ?int $accessTokenValiditySeconds=null, ?int $refreshTokenValiditySeconds=null)

	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)

	jsonSerialize ()

Public Member Functions inherited from Commercetools\Base\JsonObjectModel
	get (string $field)

	with (callable $callable=null)

Protected Attributes
	$id

	$name

	$scope

	$secret

	$lastUsedAt

	$deleteAt

	$createdAt

	$accessTokenValiditySeconds

	$refreshTokenValiditySeconds

Additional Inherited Members
Static Public Member Functions inherited from Commercetools\Base\BaseJsonObject
static	of ($data=null)

static	fromStdClass (stdClass $data=null)

static	fromArray (array $data=[])

Public Attributes inherited from Commercetools\Api\Models\ApiClient\ApiClient
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'

Protected Member Functions inherited from Commercetools\Base\JsonObjectModel
	toArray ()

Protected Member Functions inherited from Commercetools\Base\BaseJsonObject
	raw (string $field)

	getRawDataArray ()

Detailed Description

Definition at line 21 of file ApiClientModel.php.

Constructor & Destructor Documentation

◆ __construct()

Commercetools\Api\Models\ApiClient\ApiClientModel::__construct	(	?string	$id = `null`,
		?string	$name = `null`,
		?string	$scope = `null`,
		?string	$secret = `null`,
		?DateTimeImmutable	$lastUsedAt = `null`,
		?DateTimeImmutable	$deleteAt = `null`,
		?DateTimeImmutable	$createdAt = `null`,
		?int	$accessTokenValiditySeconds = `null`,
		?int	$refreshTokenValiditySeconds = `null`
	)

@psalm-suppress MissingParamType

Definition at line 81 of file ApiClientModel.php.

Member Function Documentation

◆ getAccessTokenValiditySeconds()

Commercetools\Api\Models\ApiClient\ApiClientModel::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

@psalm-var ?int $data

Implements Commercetools\Api\Models\ApiClient\ApiClient.

Definition at line 262 of file ApiClientModel.php.

◆ getCreatedAt()

Commercetools\Api\Models\ApiClient\ApiClientModel::getCreatedAt ( )

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

Returns: null|DateTimeImmutable

@psalm-var ?string $data

Implements Commercetools\Api\Models\ApiClient\ApiClient.

Definition at line 238 of file ApiClientModel.php.

◆ getDeleteAt()

Commercetools\Api\Models\ApiClient\ApiClientModel::getDeleteAt ( )

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

Returns: null|DateTimeImmutable

@psalm-var ?string $data

Implements Commercetools\Api\Models\ApiClient\ApiClient.

Definition at line 214 of file ApiClientModel.php.

◆ getId()

Commercetools\Api\Models\ApiClient\ApiClientModel::getId ( )

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

Returns: null|string

@psalm-var ?string $data

Implements Commercetools\Api\Models\ApiClient\ApiClient.

Definition at line 109 of file ApiClientModel.php.

◆ getLastUsedAt()

Commercetools\Api\Models\ApiClient\ApiClientModel::getLastUsedAt ( )

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

Returns: null|DateTimeImmutable

@psalm-var ?string $data

Implements Commercetools\Api\Models\ApiClient\ApiClient.

Definition at line 190 of file ApiClientModel.php.

◆ getName()

Commercetools\Api\Models\ApiClient\ApiClientModel::getName ( )

Name of the APIClient.

Returns: null|string

@psalm-var ?string $data

Implements Commercetools\Api\Models\ApiClient\ApiClient.

Definition at line 129 of file ApiClientModel.php.

◆ getRefreshTokenValiditySeconds()

Commercetools\Api\Models\ApiClient\ApiClientModel::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

@psalm-var ?int $data

Implements Commercetools\Api\Models\ApiClient\ApiClient.

Definition at line 282 of file ApiClientModel.php.

◆ getScope()

Commercetools\Api\Models\ApiClient\ApiClientModel::getScope ( )

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

Returns: null|string

@psalm-var ?string $data

Implements Commercetools\Api\Models\ApiClient\ApiClient.

Definition at line 149 of file ApiClientModel.php.

◆ getSecret()

Commercetools\Api\Models\ApiClient\ApiClientModel::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

@psalm-var ?string $data

Implements Commercetools\Api\Models\ApiClient\ApiClient.

Definition at line 170 of file ApiClientModel.php.

◆ jsonSerialize()

Commercetools\Api\Models\ApiClient\ApiClientModel::jsonSerialize ( )

Reimplemented from Commercetools\Base\BaseJsonObject.

Definition at line 371 of file ApiClientModel.php.

◆ setAccessTokenValiditySeconds()

Commercetools\Api\Models\ApiClient\ApiClientModel::setAccessTokenValiditySeconds ( ?int $accessTokenValiditySeconds )

Parameters

?int	$accessTokenValiditySeconds

Implements Commercetools\Api\Models\ApiClient\ApiClient.

Definition at line 356 of file ApiClientModel.php.

◆ setCreatedAt()

Commercetools\Api\Models\ApiClient\ApiClientModel::setCreatedAt ( ?DateTimeImmutable $createdAt )

Parameters

?DateTimeImmutable $createdAt

Implements Commercetools\Api\Models\ApiClient\ApiClient.

Definition at line 348 of file ApiClientModel.php.

◆ setDeleteAt()

Commercetools\Api\Models\ApiClient\ApiClientModel::setDeleteAt ( ?DateTimeImmutable $deleteAt )

Parameters

?DateTimeImmutable $deleteAt

Implements Commercetools\Api\Models\ApiClient\ApiClient.

Definition at line 340 of file ApiClientModel.php.

◆ setId()

Commercetools\Api\Models\ApiClient\ApiClientModel::setId ( ?string $id )

Parameters

?string $id

Implements Commercetools\Api\Models\ApiClient\ApiClient.

Definition at line 300 of file ApiClientModel.php.

◆ setLastUsedAt()

Commercetools\Api\Models\ApiClient\ApiClientModel::setLastUsedAt ( ?DateTimeImmutable $lastUsedAt )

Parameters

?DateTimeImmutable $lastUsedAt

Implements Commercetools\Api\Models\ApiClient\ApiClient.

Definition at line 332 of file ApiClientModel.php.

◆ setName()

Commercetools\Api\Models\ApiClient\ApiClientModel::setName ( ?string $name )

Parameters

?string $name

Implements Commercetools\Api\Models\ApiClient\ApiClient.

Definition at line 308 of file ApiClientModel.php.

◆ setRefreshTokenValiditySeconds()

Commercetools\Api\Models\ApiClient\ApiClientModel::setRefreshTokenValiditySeconds ( ?int $refreshTokenValiditySeconds )

Parameters

?int	$refreshTokenValiditySeconds

Implements Commercetools\Api\Models\ApiClient\ApiClient.

Definition at line 364 of file ApiClientModel.php.

◆ setScope()

Commercetools\Api\Models\ApiClient\ApiClientModel::setScope ( ?string $scope )

Parameters

?string $scope

Implements Commercetools\Api\Models\ApiClient\ApiClient.

Definition at line 316 of file ApiClientModel.php.

◆ setSecret()

Commercetools\Api\Models\ApiClient\ApiClientModel::setSecret ( ?string $secret )

Parameters

?string $secret

Implements Commercetools\Api\Models\ApiClient\ApiClient.

Definition at line 324 of file ApiClientModel.php.

Member Data Documentation

◆ $accessTokenValiditySeconds

Commercetools\Api\Models\ApiClient\ApiClientModel::$accessTokenValiditySeconds

protected

Definition at line 69 of file ApiClientModel.php.

◆ $createdAt

Commercetools\Api\Models\ApiClient\ApiClientModel::$createdAt

protected

Definition at line 63 of file ApiClientModel.php.

◆ $deleteAt

Commercetools\Api\Models\ApiClient\ApiClientModel::$deleteAt

protected

Definition at line 57 of file ApiClientModel.php.

◆ $id

Commercetools\Api\Models\ApiClient\ApiClientModel::$id

protected

Definition at line 27 of file ApiClientModel.php.

◆ $lastUsedAt

Commercetools\Api\Models\ApiClient\ApiClientModel::$lastUsedAt

protected

Definition at line 51 of file ApiClientModel.php.

◆ $name

Commercetools\Api\Models\ApiClient\ApiClientModel::$name

protected

Definition at line 33 of file ApiClientModel.php.

◆ $refreshTokenValiditySeconds

Commercetools\Api\Models\ApiClient\ApiClientModel::$refreshTokenValiditySeconds

protected

Definition at line 75 of file ApiClientModel.php.

◆ $scope

Commercetools\Api\Models\ApiClient\ApiClientModel::$scope

protected

Definition at line 39 of file ApiClientModel.php.

◆ $secret

Commercetools\Api\Models\ApiClient\ApiClientModel::$secret

protected

Definition at line 45 of file ApiClientModel.php.

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAccessTokenValiditySeconds()

◆ getCreatedAt()

◆ getDeleteAt()

◆ getId()

◆ getLastUsedAt()

◆ getName()

◆ getRefreshTokenValiditySeconds()

◆ getScope()

◆ getSecret()

◆ jsonSerialize()

◆ setAccessTokenValiditySeconds()

◆ setCreatedAt()

◆ setDeleteAt()

◆ setId()

◆ setLastUsedAt()

◆ setName()

◆ setRefreshTokenValiditySeconds()

◆ setScope()

◆ setSecret()

Member Data Documentation

◆ $accessTokenValiditySeconds

◆ $createdAt

◆ $deleteAt

◆ $id

◆ $lastUsedAt

◆ $name

◆ $refreshTokenValiditySeconds

◆ $scope

◆ $secret