Documentation

UpdateApiTokenRequest
in package

BIMworks

implements ModelInterface, ArrayAccess, JsonSerializable

UpdateApiTokenRequest Class Doc Comment

Interfaces

ModelInterface: Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

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
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|null: Gets name
getOnlyCorsEnabledAddresses() : bool|null: Gets only_cors_enabled_addresses
getOnlyWhiteListedIpAddresses() : bool|null: Gets only_white_listed_ip_addresses
getRotateSecret() : bool|null: Gets rotate_secret
getScopes() : array<string|int, string>|null: Gets scopes
getters() : array<string|int, mixed>: Array of attributes to getter functions (for serialization of requests)
getUuid() : string: 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
setCorsEnabledDomains() : self: Sets cors_enabled_domains
setExpiresOn() : self: Sets expires_on
setName() : self: Sets name
setOnlyCorsEnabledAddresses() : self: Sets only_cors_enabled_addresses
setOnlyWhiteListedIpAddresses() : self: Sets only_white_listed_ip_addresses
setRotateSecret() : self: Sets rotate_secret
setScopes() : self: Sets scopes
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
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

DISCRIMINATOR


    public
        mixed
    DISCRIMINATOR
    = null

$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', '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', 'rotate_secret' => 'rotate_secret']

$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', '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', 'rotate_secret' => 'getRotateSecret']

$openAPIFormats

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


        protected
        static    array<string|int, string>
    $openAPIFormats
     = ['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, 'rotate_secret' => null]

$openAPIModelName

The original name of the model.


        protected
        static    string
    $openAPIModelName
     = 'UpdateApiTokenRequest'

$openAPINullables

Array of nullable properties. Used for (de)serialization


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

$setters

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


        protected
        static    array<string|int, string>
    $setters
     = ['uuid' => 'setUuid', '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', 'rotate_secret' => 'setRotateSecret']

__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>

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

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

getRotateSecret()

Gets rotate_secret


    public
                    getRotateSecret() : bool|null

Return values

bool|null

getScopes()

Gets scopes


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

Return values

array<string|int, string>|null

getters()

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


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

Return values

array<string|int, mixed>

getUuid()

Gets uuid


    public
                    getUuid() : string

Return values

string

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

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

#[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>

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|null $name) : self

Parameters

$name : string|null: The name of the token

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

setRotateSecret()

Sets rotate_secret


    public
                    setRotateSecret(bool|null $rotate_secret) : self

Parameters

$rotate_secret : bool|null: Replace the secret; the new one is answered once in token. Needs tokens:issue as well

Return values

self

setScopes()

Sets scopes


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

Parameters

$scopes : array<string|int, string>|null: 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>

setUuid()

Sets uuid


    public
                    setUuid(string $uuid) : self

Parameters

$uuid : string: The token

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: 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>

UpdateApiTokenRequest in package BIMworks implements ModelInterface, ArrayAccess, JsonSerializable

Tags

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

DISCRIMINATOR

Properties

$attributeMap

$container

$getters

$openAPIFormats

Tags

$openAPIModelName

$openAPINullables

$openAPINullablesSetToNull

$openAPITypes

$setters

Methods

__construct()

Parameters

__toString()

Return values

attributeMap()

Return values

getCorsEnabledDomains()

Return values

getExpiresOn()

Return values

getModelName()

Return values

getName()

Return values

getOnlyCorsEnabledAddresses()

Return values

getOnlyWhiteListedIpAddresses()

Return values

getRotateSecret()

Return values

getScopes()

Return values

getters()

Return values

getUuid()

Return values

getWhiteListedIpAddresses()

Return values

isNullable()

Parameters

Return values

isNullableSetToNull()

Parameters

Return values

jsonSerialize()

Tags

Attributes

Return values

listInvalidProperties()

Return values

offsetExists()

Parameters

Return values

offsetGet()

Parameters

Attributes

Return values

offsetSet()

Parameters

offsetUnset()

Parameters

openAPIFormats()

Return values

openAPITypes()

Return values

setCorsEnabledDomains()

Parameters

Return values

setExpiresOn()

UpdateApiTokenRequest
in package

BIMworks

implements ModelInterface, ArrayAccess, JsonSerializable