CreateVersionsTokenRequest
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
CreateVersionsTokenRequest Class Doc Comment
Tags
Table of Contents
Interfaces
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Constants
- DISCRIMINATOR : mixed = null
Properties
- $attributeMap : array<string, 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, string>
- Array of attributes to getter functions (for serialization of requests)
- $openAPIFormats : array<string, string|null>
- Array of property to format mappings. Used for (de)serialization
- $openAPIModelName : string
- The original name of the model.
- $openAPINullables : array<string, bool>
- Array of nullable properties. Used for (de)serialization
- $openAPINullablesSetToNull : array<string, bool>
- If a nullable field gets set to null, insert it here
- $openAPITypes : array<string, string>
- Array of property to type mappings. Used for (de)serialization
- $setters : array<string, 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, string>
- Array of attributes where the key is the local name, and the value is the original name
- getExpiresSeconds() : int
- Gets expires_seconds
- getIpAddresses() : array<string|int, string>|null
- Gets ip_addresses
- getLockToCalledIp() : bool|null
- Gets lock_to_called_ip
- getModelName() : string
- The original name of the model.
- getResponseFormat() : AuthResponseFormat|null
- Gets response_format
- getScopes() : array<string|int, Scope>|null
- Gets scopes
- getTasks() : array<string|int, string>|null
- Gets tasks
- getters() : array<string, string>
- Array of attributes to getter functions (for serialization of requests)
- getVersionUuids() : array<string|int, string>
- Gets version_uuids
- 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, string>
- 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, string|null>
- Array of property to format mappings. Used for (de)serialization
- openAPITypes() : array<string, string>
- Array of property to type mappings. Used for (de)serialization
- setExpiresSeconds() : $this
- Sets expires_seconds
- setIpAddresses() : $this
- Sets ip_addresses
- setLockToCalledIp() : $this
- Sets lock_to_called_ip
- setResponseFormat() : $this
- Sets response_format
- setScopes() : $this
- Sets scopes
- setTasks() : $this
- Sets tasks
- setters() : array<string, string>
- Array of attributes to setter functions (for deserialization of responses)
- setVersionUuids() : $this
- Sets version_uuids
- 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, bool>
- Array of nullable properties
- fillIfExists() : 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
- getOpenAPINullablesSetToNull() : array<string, bool>
- Array of nullable field names deliberately set to null
- setOpenAPINullablesSetToNull() : void
- Setter - Array of nullable field names deliberately set to null
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string, string>
$attributeMap
= ['expires_seconds' => 'expires_seconds', 'version_uuids' => 'version_uuids', 'tasks' => 'tasks', 'scopes' => 'scopes', 'ip_addresses' => 'ip_addresses', 'lock_to_called_ip' => 'lock_to_called_ip', 'response_format' => 'response_format']
$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, string>
$getters
= ['expires_seconds' => 'getExpiresSeconds', 'version_uuids' => 'getVersionUuids', 'tasks' => 'getTasks', 'scopes' => 'getScopes', 'ip_addresses' => 'getIpAddresses', 'lock_to_called_ip' => 'getLockToCalledIp', 'response_format' => 'getResponseFormat']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string, string|null>
$openAPIFormats
= ['expires_seconds' => null, 'version_uuids' => 'uuid', 'tasks' => null, 'scopes' => null, 'ip_addresses' => null, 'lock_to_called_ip' => null, 'response_format' => null]
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'CreateVersionsTokenRequest'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string, bool>
$openAPINullables
= ['expires_seconds' => false, 'version_uuids' => false, 'tasks' => false, 'scopes' => false, 'ip_addresses' => false, 'lock_to_called_ip' => false, 'response_format' => false]
$openAPINullablesSetToNull
If a nullable field gets set to null, insert it here
protected
array<string, bool>
$openAPINullablesSetToNull
= []
$openAPITypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string, string>
$openAPITypes
= ['expires_seconds' => 'int', 'version_uuids' => 'string[]', 'tasks' => 'string[]', 'scopes' => '\BIMworks\Model\Scope[]', 'ip_addresses' => 'string[]', 'lock_to_called_ip' => 'bool', 'response_format' => '\BIMworks\Model\AuthResponseFormat']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string, string>
$setters
= ['expires_seconds' => 'setExpiresSeconds', 'version_uuids' => 'setVersionUuids', 'tasks' => 'setTasks', 'scopes' => 'setScopes', 'ip_addresses' => 'setIpAddresses', 'lock_to_called_ip' => 'setLockToCalledIp', 'response_format' => 'setResponseFormat']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
stringattributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string, string>
Return values
array<string, string>getExpiresSeconds()
Gets expires_seconds
public
getExpiresSeconds() : int
Return values
intgetIpAddresses()
Gets ip_addresses
public
getIpAddresses() : array<string|int, string>|null
Return values
array<string|int, string>|nullgetLockToCalledIp()
Gets lock_to_called_ip
public
getLockToCalledIp() : bool|null
Return values
bool|nullgetModelName()
The original name of the model.
public
getModelName() : string
Return values
stringgetResponseFormat()
Gets response_format
public
getResponseFormat() : AuthResponseFormat|null
Return values
AuthResponseFormat|nullgetScopes()
Gets scopes
public
getScopes() : array<string|int, Scope>|null
Return values
array<string|int, Scope>|nullgetTasks()
Gets tasks
public
getTasks() : array<string|int, string>|null
Return values
array<string|int, string>|nullgetters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string, string>
Return values
array<string, string>getVersionUuids()
Gets version_uuids
public
getVersionUuids() : array<string|int, string>
Return values
array<string|int, string>isNullable()
Checks if a property is nullable
public
static isNullable(string $property) : bool
Parameters
- $property : string
Return values
boolisNullableSetToNull()
Checks if a nullable property is set to null.
public
isNullableSetToNull(string $property) : bool
Parameters
- $property : string
Return values
booljsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
public
jsonSerialize() : mixed
Tags
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, string>
Return values
array<string|int, string> —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
booloffsetGet()
Gets offset.
public
offsetGet(int|string $offset) : mixed|null
Parameters
- $offset : int|string
-
Offset
Attributes
- #[ReturnTypeWillChange]
Return values
mixed|nulloffsetSet()
Sets value based on offset.
public
offsetSet(int|string|null $offset, mixed $value) : void
Parameters
- $offset : int|string|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, string|null>
Return values
array<string, string|null>openAPITypes()
Array of property to type mappings. Used for (de)serialization
public
static openAPITypes() : array<string, string>
Return values
array<string, string>setExpiresSeconds()
Sets expires_seconds
public
setExpiresSeconds(int $expires_seconds) : $this
Parameters
- $expires_seconds : int
-
expires_seconds
Return values
$thissetIpAddresses()
Sets ip_addresses
public
setIpAddresses(array<string|int, string>|null $ip_addresses) : $this
Parameters
- $ip_addresses : array<string|int, string>|null
-
ip_addresses
Return values
$thissetLockToCalledIp()
Sets lock_to_called_ip
public
setLockToCalledIp(bool|null $lock_to_called_ip) : $this
Parameters
- $lock_to_called_ip : bool|null
-
lock_to_called_ip
Return values
$thissetResponseFormat()
Sets response_format
public
setResponseFormat(AuthResponseFormat|null $response_format) : $this
Parameters
- $response_format : AuthResponseFormat|null
-
response_format
Return values
$thissetScopes()
Sets scopes
public
setScopes(array<string|int, Scope>|null $scopes) : $this
Parameters
- $scopes : array<string|int, Scope>|null
-
Scopes granted to the token (preferred over tasks - scopes keep working when new API calls are added); the issued scopes can never exceed the issuing credential's scopes
Return values
$thissetTasks()
Sets tasks
public
setTasks(array<string|int, string>|null $tasks) : $this
Parameters
- $tasks : array<string|int, string>|null
-
Deprecated - use scopes instead. Task-name allow-lists do not cover API calls added later and can name tasks that no longer exist.
Return values
$thissetters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string, string>
Return values
array<string, string>setVersionUuids()
Sets version_uuids
public
setVersionUuids(array<string|int, string> $version_uuids) : $this
Parameters
- $version_uuids : array<string|int, string>
-
version_uuids
Return values
$thistoHeaderValue()
Gets a header-safe presentation of the object
public
toHeaderValue() : string
Return values
stringvalid()
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, bool>
Return values
array<string, bool>fillIfExists()
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
fillIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
- $variableName : string
- $fields : array<string|int, mixed>
- $defaultValue : mixed
getOpenAPINullablesSetToNull()
Array of nullable field names deliberately set to null
private
getOpenAPINullablesSetToNull() : array<string, bool>
Return values
array<string, bool>setOpenAPINullablesSetToNull()
Setter - Array of nullable field names deliberately set to null
private
setOpenAPINullablesSetToNull(array<string, bool> $openAPINullablesSetToNull) : void
Parameters
- $openAPINullablesSetToNull : array<string, bool>