Documentation

CreateApiTokenRequest
in package
implements ModelInterface, ArrayAccess, JsonSerializable

CreateApiTokenRequest 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

BIM_CONTEXT__DEFAULT  : mixed = 'DEFAULT'
BIM_CONTEXT_GB  : mixed = 'GB'
BIM_CONTEXT_HONG_KONG  : mixed = 'HONG_KONG'
BIM_CONTEXT_MKM  : mixed = 'MKM'
BIM_CONTEXT_NL  : mixed = 'NL'
DISCRIMINATOR  : mixed = null

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
getBimContextAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getCorsEnabledDomains()  : array<string|int, string>|null
Gets cors_enabled_domains
getExpiresOn()  : string|null
Gets expires_on
getModelName()  : string
The original name of the model.
getName()  : string
Gets name
getNodeUuid()  : string
Gets node_uuid
getOnlyCorsEnabledAddresses()  : bool|null
Gets only_cors_enabled_addresses
getOnlyWhiteListedIpAddresses()  : bool|null
Gets only_white_listed_ip_addresses
getScopes()  : array<string|int, string>
Gets scopes
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
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
setCorsEnabledDomains()  : self
Sets cors_enabled_domains
setExpiresOn()  : self
Sets expires_on
setName()  : self
Sets name
setNodeUuid()  : self
Sets node_uuid
setOnlyCorsEnabledAddresses()  : self
Sets only_cors_enabled_addresses
setOnlyWhiteListedIpAddresses()  : self
Sets only_white_listed_ip_addresses
setScopes()  : self
Sets scopes
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
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

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 = ['node_uuid' => 'node_uuid', 'name' => 'name', 'scopes' => 'scopes', 'expires_on' => 'expires_on', 'cors_enabled_domains' => 'cors_enabled_domains', 'only_cors_enabled_addresses' => 'only_cors_enabled_addresses', 'white_listed_ip_addresses' => 'white_listed_ip_addresses', 'only_white_listed_ip_addresses' => 'only_white_listed_ip_addresses', 'bim_context' => 'bim_context']

$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 = ['node_uuid' => 'getNodeUuid', 'name' => 'getName', 'scopes' => 'getScopes', 'expires_on' => 'getExpiresOn', 'cors_enabled_domains' => 'getCorsEnabledDomains', 'only_cors_enabled_addresses' => 'getOnlyCorsEnabledAddresses', 'white_listed_ip_addresses' => 'getWhiteListedIpAddresses', 'only_white_listed_ip_addresses' => 'getOnlyWhiteListedIpAddresses', 'bim_context' => 'getBimContext']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['node_uuid' => 'uuid', 'name' => null, 'scopes' => null, 'expires_on' => null, 'cors_enabled_domains' => null, 'only_cors_enabled_addresses' => null, 'white_listed_ip_addresses' => null, 'only_white_listed_ip_addresses' => null, 'bim_context' => null]
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'CreateApiTokenRequest'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['node_uuid' => false, 'name' => false, 'scopes' => false, 'expires_on' => false, 'cors_enabled_domains' => false, 'only_cors_enabled_addresses' => false, 'white_listed_ip_addresses' => false, 'only_white_listed_ip_addresses' => false, 'bim_context' => 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 = ['node_uuid' => 'string', 'name' => 'string', 'scopes' => 'string[]', 'expires_on' => 'string', 'cors_enabled_domains' => 'string[]', 'only_cors_enabled_addresses' => 'bool', 'white_listed_ip_addresses' => 'string[]', 'only_white_listed_ip_addresses' => 'bool', 'bim_context' => 'string']

$setters

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

protected static array<string|int, string> $setters = ['node_uuid' => 'setNodeUuid', 'name' => 'setName', 'scopes' => 'setScopes', 'expires_on' => 'setExpiresOn', 'cors_enabled_domains' => 'setCorsEnabledDomains', 'only_cors_enabled_addresses' => 'setOnlyCorsEnabledAddresses', 'white_listed_ip_addresses' => 'setWhiteListedIpAddresses', 'only_white_listed_ip_addresses' => 'setOnlyWhiteListedIpAddresses', 'bim_context' => 'setBimContext']

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

getBimContextAllowableValues()

Gets allowable values of the enum

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

getCorsEnabledDomains()

Gets cors_enabled_domains

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

getExpiresOn()

Gets expires_on

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

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

getScopes()

Gets scopes

public getScopes() : 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>

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

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

The regional context of the token

Return values
self

setCorsEnabledDomains()

Sets cors_enabled_domains

public setCorsEnabledDomains(array<string|int, string>|null $cors_enabled_domains) : self
Parameters
$cors_enabled_domains : array<string|int, string>|null

The browser origins that may use the token, with only_cors_enabled_addresses

Return values
self

setExpiresOn()

Sets expires_on

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

When the token expires: a date (YYYY-MM-DD, the end of that day in UTC) or a date-time. At most auth.api_token_max_expiry ahead (3 years by default); 1 month when absent

Return values
self

setName()

Sets name

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

The name of the token

Return values
self

setNodeUuid()

Sets node_uuid

public setNodeUuid(string $node_uuid) : self
Parameters
$node_uuid : string

The Node (folder) the token is rooted at; needs write rights on it

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

Refuse calls from other origins than cors_enabled_domains

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

Refuse calls from other addresses than white_listed_ip_addresses

Return values
self

setScopes()

Sets scopes

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

The scopes the token grants, as wire names (fs:read, model:upload, ...). A scoped caller can grant no more than it has itself

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>

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

The client addresses that may use the token, with only_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