Documentation

ApiToken
in package
implements ModelInterface, ArrayAccess, JsonSerializable

ApiToken Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

Table of Contents

Interfaces

ModelInterface
Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

CREDENTIALS_READ  : mixed = 'READ'
CREDENTIALS_WRITE  : mixed = 'WRITE'
DISCRIMINATOR  : mixed = null
STATUS_ACTIVE  : mixed = 'ACTIVE'
STATUS_DELETED  : mixed = 'DELETED'

Properties

$attributeMap  : array<string|int, string>
Array of attributes where the key is the local name, and the value is the original name
$container  : array<string|int, mixed>
Associative array for storing property values
$getters  : array<string|int, string>
Array of attributes to getter functions (for serialization of requests)
$openAPIFormats  : array<string|int, string>
Array of property to format mappings. Used for (de)serialization
$openAPIModelName  : string
The original name of the model.
$openAPINullables  : array<string|int, bool>
Array of nullable properties. Used for (de)serialization
$openAPINullablesSetToNull  : array<string|int, bool>
If a nullable field gets set to null, insert it here
$openAPITypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
$setters  : array<string|int, string>
Array of attributes to setter functions (for deserialization of responses)

Methods

__construct()  : mixed
Constructor
__toString()  : string
Gets the string presentation of the object
attributeMap()  : array<string|int, mixed>
Array of attributes where the key is the local name, and the value is the original name
getBimContext()  : string|null
Gets bim_context
getCorsEnabledAddresses()  : array<string|int, string>|null
Gets cors_enabled_addresses
getCreatedBy()  : string|null
Gets created_by
getCreatedOn()  : string|null
Gets created_on
getCredentials()  : array<string|int, string>|null
Gets credentials
getCredentialsAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getExpiresOn()  : string|null
Gets expires_on
getLastFour()  : string|null
Gets last_four
getLastLogin()  : string|null
Gets last_login
getModelName()  : string
The original name of the model.
getName()  : string|null
Gets name
getOnlyCorsEnabledAddresses()  : bool|null
Gets only_cors_enabled_addresses
getOnlyWhiteListedIpAddresses()  : bool|null
Gets only_white_listed_ip_addresses
getOrganizationUuid()  : string|null
Gets organization_uuid
getRootNodeUuid()  : string|null
Gets root_node_uuid
getScopes()  : array<string|int, string>|null
Gets scopes
getStatus()  : string|null
Gets status
getStatusAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getToken()  : string|null
Gets token
getUuid()  : string|null
Gets uuid
getWhiteListedIpAddresses()  : array<string|int, string>|null
Gets white_listed_ip_addresses
isNullable()  : bool
Checks if a property is nullable
isNullableSetToNull()  : bool
Checks if a nullable property is set to null.
jsonSerialize()  : mixed
Serializes the object to a value that can be serialized natively by json_encode().
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed|null
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
openAPIFormats()  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization
openAPITypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization
setBimContext()  : self
Sets bim_context
setCorsEnabledAddresses()  : self
Sets cors_enabled_addresses
setCreatedBy()  : self
Sets created_by
setCreatedOn()  : self
Sets created_on
setCredentials()  : self
Sets credentials
setExpiresOn()  : self
Sets expires_on
setLastFour()  : self
Sets last_four
setLastLogin()  : self
Sets last_login
setName()  : self
Sets name
setOnlyCorsEnabledAddresses()  : self
Sets only_cors_enabled_addresses
setOnlyWhiteListedIpAddresses()  : self
Sets only_white_listed_ip_addresses
setOrganizationUuid()  : self
Sets organization_uuid
setRootNodeUuid()  : self
Sets root_node_uuid
setScopes()  : self
Sets scopes
setStatus()  : self
Sets status
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setToken()  : self
Sets token
setUuid()  : self
Sets uuid
setWhiteListedIpAddresses()  : self
Sets white_listed_ip_addresses
toHeaderValue()  : string
Gets a header-safe presentation of the object
valid()  : bool
Validate all the properties in the model return true if all passed
openAPINullables()  : array<string|int, mixed>
Array of nullable properties
getOpenAPINullablesSetToNull()  : array<string|int, bool>
Array of nullable field names deliberately set to null
setIfExists()  : void
Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
setOpenAPINullablesSetToNull()  : void
Setter - Array of nullable field names deliberately set to null

Constants

CREDENTIALS_READ

public mixed CREDENTIALS_READ = 'READ'

CREDENTIALS_WRITE

public mixed CREDENTIALS_WRITE = 'WRITE'

DISCRIMINATOR

public mixed DISCRIMINATOR = null

STATUS_ACTIVE

public mixed STATUS_ACTIVE = 'ACTIVE'

STATUS_DELETED

public mixed STATUS_DELETED = 'DELETED'

Properties

$attributeMap

Array of attributes where the key is the local name, and the value is the original name

protected static array<string|int, string> $attributeMap = ['uuid' => 'uuid', 'name' => 'name', 'organization_uuid' => 'organization_uuid', 'created_by' => 'created_by', 'created_on' => 'created_on', 'root_node_uuid' => 'root_node_uuid', 'status' => 'status', 'last_login' => 'last_login', 'scopes' => 'scopes', 'credentials' => 'credentials', 'bim_context' => 'bim_context', 'last_four' => 'last_four', 'expires_on' => 'expires_on', 'only_cors_enabled_addresses' => 'only_cors_enabled_addresses', 'cors_enabled_addresses' => 'cors_enabled_addresses', 'only_white_listed_ip_addresses' => 'only_white_listed_ip_addresses', 'white_listed_ip_addresses' => 'white_listed_ip_addresses', 'token' => 'token']

$container

Associative array for storing property values

protected array<string|int, mixed> $container = []

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['uuid' => 'getUuid', 'name' => 'getName', 'organization_uuid' => 'getOrganizationUuid', 'created_by' => 'getCreatedBy', 'created_on' => 'getCreatedOn', 'root_node_uuid' => 'getRootNodeUuid', 'status' => 'getStatus', 'last_login' => 'getLastLogin', 'scopes' => 'getScopes', 'credentials' => 'getCredentials', 'bim_context' => 'getBimContext', 'last_four' => 'getLastFour', 'expires_on' => 'getExpiresOn', 'only_cors_enabled_addresses' => 'getOnlyCorsEnabledAddresses', 'cors_enabled_addresses' => 'getCorsEnabledAddresses', 'only_white_listed_ip_addresses' => 'getOnlyWhiteListedIpAddresses', 'white_listed_ip_addresses' => 'getWhiteListedIpAddresses', 'token' => 'getToken']

$openAPIFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $openAPIFormats = ['uuid' => 'uuid', 'name' => null, 'organization_uuid' => 'uuid', 'created_by' => null, 'created_on' => null, 'root_node_uuid' => 'uuid', 'status' => null, 'last_login' => null, 'scopes' => null, 'credentials' => null, 'bim_context' => null, 'last_four' => null, 'expires_on' => null, 'only_cors_enabled_addresses' => null, 'cors_enabled_addresses' => null, 'only_white_listed_ip_addresses' => null, 'white_listed_ip_addresses' => null, 'token' => 'password']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'ApiToken'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['uuid' => false, 'name' => false, 'organization_uuid' => false, 'created_by' => false, 'created_on' => false, 'root_node_uuid' => false, 'status' => false, 'last_login' => true, 'scopes' => true, 'credentials' => true, 'bim_context' => false, 'last_four' => true, 'expires_on' => true, 'only_cors_enabled_addresses' => false, 'cors_enabled_addresses' => true, 'only_white_listed_ip_addresses' => false, 'white_listed_ip_addresses' => true, 'token' => false]

$openAPINullablesSetToNull

If a nullable field gets set to null, insert it here

protected array<string|int, bool> $openAPINullablesSetToNull = []

$openAPITypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $openAPITypes = ['uuid' => 'string', 'name' => 'string', 'organization_uuid' => 'string', 'created_by' => 'string', 'created_on' => 'string', 'root_node_uuid' => 'string', 'status' => 'string', 'last_login' => 'string', 'scopes' => 'string[]', 'credentials' => 'string[]', 'bim_context' => 'string', 'last_four' => 'string', 'expires_on' => 'string', 'only_cors_enabled_addresses' => 'bool', 'cors_enabled_addresses' => 'string[]', 'only_white_listed_ip_addresses' => 'bool', 'white_listed_ip_addresses' => 'string[]', 'token' => 'string']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['uuid' => 'setUuid', 'name' => 'setName', 'organization_uuid' => 'setOrganizationUuid', 'created_by' => 'setCreatedBy', 'created_on' => 'setCreatedOn', 'root_node_uuid' => 'setRootNodeUuid', 'status' => 'setStatus', 'last_login' => 'setLastLogin', 'scopes' => 'setScopes', 'credentials' => 'setCredentials', 'bim_context' => 'setBimContext', 'last_four' => 'setLastFour', 'expires_on' => 'setExpiresOn', 'only_cors_enabled_addresses' => 'setOnlyCorsEnabledAddresses', 'cors_enabled_addresses' => 'setCorsEnabledAddresses', 'only_white_listed_ip_addresses' => 'setOnlyWhiteListedIpAddresses', 'white_listed_ip_addresses' => 'setWhiteListedIpAddresses', 'token' => 'setToken']

Methods

__construct()

Constructor

public __construct([array<string|int, mixed>|null $data = null ]) : mixed
Parameters
$data : array<string|int, mixed>|null = null

Associated array of property values initializing the model

__toString()

Gets the string presentation of the object

public __toString() : string
Return values
string

attributeMap()

Array of attributes where the key is the local name, and the value is the original name

public static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed>

getBimContext()

Gets bim_context

public getBimContext() : string|null
Return values
string|null

getCorsEnabledAddresses()

Gets cors_enabled_addresses

public getCorsEnabledAddresses() : array<string|int, string>|null
Return values
array<string|int, string>|null

getCreatedBy()

Gets created_by

public getCreatedBy() : string|null
Return values
string|null

getCreatedOn()

Gets created_on

public getCreatedOn() : string|null
Return values
string|null

getCredentials()

Gets credentials

public getCredentials() : array<string|int, string>|null
Return values
array<string|int, string>|null

getCredentialsAllowableValues()

Gets allowable values of the enum

public getCredentialsAllowableValues() : array<string|int, string>
Return values
array<string|int, string>

getExpiresOn()

Gets expires_on

public getExpiresOn() : string|null
Return values
string|null

getLastFour()

Gets last_four

public getLastFour() : string|null
Return values
string|null

getLastLogin()

Gets last_login

public getLastLogin() : string|null
Return values
string|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getName()

Gets name

public getName() : string|null
Return values
string|null

getOnlyCorsEnabledAddresses()

Gets only_cors_enabled_addresses

public getOnlyCorsEnabledAddresses() : bool|null
Return values
bool|null

getOnlyWhiteListedIpAddresses()

Gets only_white_listed_ip_addresses

public getOnlyWhiteListedIpAddresses() : bool|null
Return values
bool|null

getOrganizationUuid()

Gets organization_uuid

public getOrganizationUuid() : string|null
Return values
string|null

getRootNodeUuid()

Gets root_node_uuid

public getRootNodeUuid() : string|null
Return values
string|null

getScopes()

Gets scopes

public getScopes() : array<string|int, string>|null
Return values
array<string|int, string>|null

getStatus()

Gets status

public getStatus() : string|null
Return values
string|null

getStatusAllowableValues()

Gets allowable values of the enum

public getStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, string>

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed>

getToken()

Gets token

public getToken() : string|null
Return values
string|null

getUuid()

Gets uuid

public getUuid() : string|null
Return values
string|null

getWhiteListedIpAddresses()

Gets white_listed_ip_addresses

public getWhiteListedIpAddresses() : array<string|int, string>|null
Return values
array<string|int, string>|null

isNullable()

Checks if a property is nullable

public static isNullable(string $property) : bool
Parameters
$property : string
Return values
bool

isNullableSetToNull()

Checks if a nullable property is set to null.

public isNullableSetToNull(string $property) : bool
Parameters
$property : string
Return values
bool

jsonSerialize()

Serializes the object to a value that can be serialized natively by json_encode().

public jsonSerialize() : mixed
Tags
link
https://www.php.net/manual/en/jsonserializable.jsonserialize.php
Attributes
#[ReturnTypeWillChange]
Return values
mixed —

Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.

listInvalidProperties()

Show all the invalid properties with reasons.

public listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —

invalid properties with reasons

offsetExists()

Returns true if offset exists. False otherwise.

public offsetExists(int|string $offset) : bool
Parameters
$offset : int|string

Offset

Return values
bool

offsetGet()

Gets offset.

public offsetGet(int|string $offset) : mixed|null
Parameters
$offset : int|string

Offset

Attributes
#[ReturnTypeWillChange]
Return values
mixed|null

offsetSet()

Sets value based on offset.

public offsetSet(int|null $offset, mixed $value) : void
Parameters
$offset : int|null

Offset

$value : mixed

Value to be set

offsetUnset()

Unsets offset.

public offsetUnset(int|string $offset) : void
Parameters
$offset : int|string

Offset

openAPIFormats()

Array of property to format mappings. Used for (de)serialization

public static openAPIFormats() : array<string|int, mixed>
Return values
array<string|int, mixed>

openAPITypes()

Array of property to type mappings. Used for (de)serialization

public static openAPITypes() : array<string|int, mixed>
Return values
array<string|int, mixed>

setBimContext()

Sets bim_context

public setBimContext(string|null $bim_context) : self
Parameters
$bim_context : string|null

bim_context

Return values
self

setCorsEnabledAddresses()

Sets cors_enabled_addresses

public setCorsEnabledAddresses(array<string|int, string>|null $cors_enabled_addresses) : self
Parameters
$cors_enabled_addresses : array<string|int, string>|null

cors_enabled_addresses

Return values
self

setCreatedBy()

Sets created_by

public setCreatedBy(string|null $created_by) : self
Parameters
$created_by : string|null

created_by

Return values
self

setCreatedOn()

Sets created_on

public setCreatedOn(string|null $created_on) : self
Parameters
$created_on : string|null

ISO date-time, UTC

Return values
self

setCredentials()

Sets credentials

public setCredentials(array<string|int, string>|null $credentials) : self
Parameters
$credentials : array<string|int, string>|null

The legacy rights, derived from the scopes

Return values
self

setExpiresOn()

Sets expires_on

public setExpiresOn(string|null $expires_on) : self
Parameters
$expires_on : string|null

ISO date-time, UTC; null for a token that never expires

Return values
self

setLastFour()

Sets last_four

public setLastFour(string|null $last_four) : self
Parameters
$last_four : string|null

The end of the secret

Return values
self

setLastLogin()

Sets last_login

public setLastLogin(string|null $last_login) : self
Parameters
$last_login : string|null

last_login

Return values
self

setName()

Sets name

public setName(string|null $name) : self
Parameters
$name : string|null

name

Return values
self

setOnlyCorsEnabledAddresses()

Sets only_cors_enabled_addresses

public setOnlyCorsEnabledAddresses(bool|null $only_cors_enabled_addresses) : self
Parameters
$only_cors_enabled_addresses : bool|null

only_cors_enabled_addresses

Return values
self

setOnlyWhiteListedIpAddresses()

Sets only_white_listed_ip_addresses

public setOnlyWhiteListedIpAddresses(bool|null $only_white_listed_ip_addresses) : self
Parameters
$only_white_listed_ip_addresses : bool|null

only_white_listed_ip_addresses

Return values
self

setOrganizationUuid()

Sets organization_uuid

public setOrganizationUuid(string|null $organization_uuid) : self
Parameters
$organization_uuid : string|null

organization_uuid

Return values
self

setRootNodeUuid()

Sets root_node_uuid

public setRootNodeUuid(string|null $root_node_uuid) : self
Parameters
$root_node_uuid : string|null

root_node_uuid

Return values
self

setScopes()

Sets scopes

public setScopes(array<string|int, string>|null $scopes) : self
Parameters
$scopes : array<string|int, string>|null

null for a token from before scopes (see credentials)

Return values
self

setStatus()

Sets status

public setStatus(string|null $status) : self
Parameters
$status : string|null

status

Return values
self

setters()

Array of attributes to setter functions (for deserialization of responses)

public static setters() : array<string|int, mixed>
Return values
array<string|int, mixed>

setToken()

Sets token

public setToken(string|null $token) : self
Parameters
$token : string|null

UpdateApiToken with rotate_secret only: the new secret, shown once

Return values
self

setUuid()

Sets uuid

public setUuid(string|null $uuid) : self
Parameters
$uuid : string|null

uuid

Return values
self

setWhiteListedIpAddresses()

Sets white_listed_ip_addresses

public setWhiteListedIpAddresses(array<string|int, string>|null $white_listed_ip_addresses) : self
Parameters
$white_listed_ip_addresses : array<string|int, string>|null

white_listed_ip_addresses

Return values
self

toHeaderValue()

Gets a header-safe presentation of the object

public toHeaderValue() : string
Return values
string

valid()

Validate all the properties in the model return true if all passed

public valid() : bool
Return values
bool —

True if all properties are valid

openAPINullables()

Array of nullable properties

protected static openAPINullables() : array<string|int, mixed>
Return values
array<string|int, mixed>

getOpenAPINullablesSetToNull()

Array of nullable field names deliberately set to null

private getOpenAPINullablesSetToNull() : array<string|int, bool>
Return values
array<string|int, bool>

setIfExists()

Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array

private setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
$variableName : string
$fields : array<string|int, mixed>
$defaultValue : mixed

setOpenAPINullablesSetToNull()

Setter - Array of nullable field names deliberately set to null

private setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void
Parameters
$openAPINullablesSetToNull : array<string|int, bool>
On this page

Search results