Documentation

AccountSettings
in package

BIMworks

implements ModelInterface, ArrayAccess, JsonSerializable

AccountSettings Class Doc Comment

Interfaces

ModelInterface: Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

DISCRIMINATOR : mixed = null
UI_MODE_DEVELOPER : mixed = 'DEVELOPER'
UI_MODE_END_USER : mixed = 'END_USER'

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
getCountryCode() : string|null: Gets country_code
getEmailAboutVulnerabilities() : bool|null: Gets email_about_vulnerabilities
getFullName() : string|null: Gets full_name
getModelName() : string: The original name of the model.
getPreferredLanguage() : string|null: Gets preferred_language
getShowDeletedNodes() : bool|null: Gets show_deleted_nodes
getters() : array<string|int, mixed>: Array of attributes to getter functions (for serialization of requests)
getTimeZoneId() : string|null: Gets time_zone_id
getUiMode() : string|null: Gets ui_mode
getUiModeAllowableValues() : array<string|int, string>: Gets allowable values of the enum
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
setCountryCode() : self: Sets country_code
setEmailAboutVulnerabilities() : self: Sets email_about_vulnerabilities
setFullName() : self: Sets full_name
setPreferredLanguage() : self: Sets preferred_language
setShowDeletedNodes() : self: Sets show_deleted_nodes
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
setTimeZoneId() : self: Sets time_zone_id
setUiMode() : self: Sets ui_mode
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

UI_MODE_DEVELOPER


    public
        mixed
    UI_MODE_DEVELOPER
    = 'DEVELOPER'

UI_MODE_END_USER


    public
        mixed
    UI_MODE_END_USER
    = 'END_USER'

$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
     = ['full_name' => 'full_name', 'country_code' => 'country_code', 'preferred_language' => 'preferred_language', 'time_zone_id' => 'time_zone_id', 'bim_context' => 'bim_context', 'show_deleted_nodes' => 'show_deleted_nodes', 'email_about_vulnerabilities' => 'email_about_vulnerabilities', 'ui_mode' => 'ui_mode']

$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
     = ['full_name' => 'getFullName', 'country_code' => 'getCountryCode', 'preferred_language' => 'getPreferredLanguage', 'time_zone_id' => 'getTimeZoneId', 'bim_context' => 'getBimContext', 'show_deleted_nodes' => 'getShowDeletedNodes', 'email_about_vulnerabilities' => 'getEmailAboutVulnerabilities', 'ui_mode' => 'getUiMode']

$openAPIFormats

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


        protected
        static    array<string|int, string>
    $openAPIFormats
     = ['full_name' => null, 'country_code' => null, 'preferred_language' => null, 'time_zone_id' => null, 'bim_context' => null, 'show_deleted_nodes' => null, 'email_about_vulnerabilities' => null, 'ui_mode' => null]

$openAPIModelName

The original name of the model.


        protected
        static    string
    $openAPIModelName
     = 'AccountSettings'

$openAPINullables

Array of nullable properties. Used for (de)serialization


        protected
        static    array<string|int, bool>
    $openAPINullables
     = ['full_name' => false, 'country_code' => false, 'preferred_language' => false, 'time_zone_id' => false, 'bim_context' => false, 'show_deleted_nodes' => false, 'email_about_vulnerabilities' => false, 'ui_mode' => 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
     = ['full_name' => 'string', 'country_code' => 'string', 'preferred_language' => 'string', 'time_zone_id' => 'string', 'bim_context' => 'string', 'show_deleted_nodes' => 'bool', 'email_about_vulnerabilities' => 'bool', 'ui_mode' => 'string']

$setters

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


        protected
        static    array<string|int, string>
    $setters
     = ['full_name' => 'setFullName', 'country_code' => 'setCountryCode', 'preferred_language' => 'setPreferredLanguage', 'time_zone_id' => 'setTimeZoneId', 'bim_context' => 'setBimContext', 'show_deleted_nodes' => 'setShowDeletedNodes', 'email_about_vulnerabilities' => 'setEmailAboutVulnerabilities', 'ui_mode' => 'setUiMode']

__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

getCountryCode()

Gets country_code


    public
                    getCountryCode() : string|null

Return values

string|null

getEmailAboutVulnerabilities()

Gets email_about_vulnerabilities


    public
                    getEmailAboutVulnerabilities() : bool|null

Return values

bool|null

getFullName()

Gets full_name


    public
                    getFullName() : string|null

Return values

string|null

getModelName()

The original name of the model.


    public
                    getModelName() : string

Return values

string

getPreferredLanguage()

Gets preferred_language


    public
                    getPreferredLanguage() : string|null

Return values

string|null

getShowDeletedNodes()

Gets show_deleted_nodes


    public
                    getShowDeletedNodes() : bool|null

Return values

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

getTimeZoneId()

Gets time_zone_id


    public
                    getTimeZoneId() : string|null

Return values

string|null

getUiMode()

Gets ui_mode


    public
                    getUiMode() : string|null

Return values

string|null

getUiModeAllowableValues()

Gets allowable values of the enum


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

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>

setBimContext()

Sets bim_context


    public
                    setBimContext(string|null $bim_context) : self

Parameters

$bim_context : string|null: bim_context

Return values

self

setCountryCode()

Sets country_code


    public
                    setCountryCode(string|null $country_code) : self

Parameters

$country_code : string|null: ISO 3166 (ListReferenceValues countries)

Return values

self

setEmailAboutVulnerabilities()

Sets email_about_vulnerabilities


    public
                    setEmailAboutVulnerabilities(bool|null $email_about_vulnerabilities) : self

Parameters

$email_about_vulnerabilities : bool|null: email_about_vulnerabilities

Return values

self

setFullName()

Sets full_name


    public
                    setFullName(string|null $full_name) : self

Parameters

$full_name : string|null: full_name

Return values

self

setPreferredLanguage()

Sets preferred_language


    public
                    setPreferredLanguage(string|null $preferred_language) : self

Parameters

$preferred_language : string|null: ISO 639-1 (ListReferenceValues languages)

Return values

self

setShowDeletedNodes()

Sets show_deleted_nodes


    public
                    setShowDeletedNodes(bool|null $show_deleted_nodes) : self

Parameters

$show_deleted_nodes : bool|null: show_deleted_nodes

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>

setTimeZoneId()

Sets time_zone_id


    public
                    setTimeZoneId(string|null $time_zone_id) : self

Parameters

$time_zone_id : string|null: A tz identifier (ListReferenceValues time_zones)

Return values

self

setUiMode()

Sets ui_mode


    public
                    setUiMode(string|null $ui_mode) : self

Parameters

$ui_mode : string|null: ui_mode

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>

AccountSettings in package BIMworks implements ModelInterface, ArrayAccess, JsonSerializable

Tags

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

DISCRIMINATOR

UI_MODE_DEVELOPER

UI_MODE_END_USER

Properties

$attributeMap

$container

$getters

$openAPIFormats

Tags

$openAPIModelName

$openAPINullables

$openAPINullablesSetToNull

$openAPITypes

$setters

Methods

__construct()

Parameters

__toString()

Return values

attributeMap()

Return values

getBimContext()

Return values

getCountryCode()

Return values

getEmailAboutVulnerabilities()

Return values

getFullName()

Return values

getModelName()

Return values

getPreferredLanguage()

Return values

getShowDeletedNodes()

Return values

getters()

Return values

getTimeZoneId()

Return values

getUiMode()

Return values

getUiModeAllowableValues()

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

setBimContext()

Parameters

AccountSettings
in package

BIMworks

implements ModelInterface, ArrayAccess, JsonSerializable