Documentation

OauthAccess
in package
implements ModelInterface, ArrayAccess

OauthAccess Class Doc Comment

Tags
category

Class

author

Swagger Codegen team apihelp@docusign.com

license

The DocuSign PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess

Table of Contents

DISCRIMINATOR  = null
$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)
$setters  : array<string|int, string>
Array of attributes to setter functions (for deserialization of responses)
$swaggerFormats  : array<string|int, string>
Array of property to format mappings. Used for (de)serialization
$swaggerModelName  : string
The original name of the model.
$swaggerTypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
__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
getAccessToken()  : string|null
Gets access_token
getData()  : array<string|int, NameValue>
Gets data
getExpiresIn()  : string|null
Gets expires_in
getModelName()  : string
The original name of the model.
getRefreshToken()  : string|null
Gets refresh_token
getScope()  : string|null
Gets scope
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTokenType()  : string|null
Gets token_type
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setAccessToken()  : $this
Sets access_token
setData()  : $this
Sets data
setExpiresIn()  : $this
Sets expires_in
setRefreshToken()  : $this
Sets refresh_token
setScope()  : $this
Sets scope
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTokenType()  : $this
Sets token_type
swaggerFormats()  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization
swaggerTypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization
valid()  : bool
Validate all the properties in the model return true if all passed

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 = ['access_token' => 'access_token', 'data' => 'data', 'expires_in' => 'expires_in', 'refresh_token' => 'refresh_token', 'scope' => 'scope', 'token_type' => 'token_type']

$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 = ['access_token' => 'getAccessToken', 'data' => 'getData', 'expires_in' => 'getExpiresIn', 'refresh_token' => 'getRefreshToken', 'scope' => 'getScope', 'token_type' => 'getTokenType']

$setters

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

protected static array<string|int, string> $setters = ['access_token' => 'setAccessToken', 'data' => 'setData', 'expires_in' => 'setExpiresIn', 'refresh_token' => 'setRefreshToken', 'scope' => 'setScope', 'token_type' => 'setTokenType']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['access_token' => null, 'data' => null, 'expires_in' => null, 'refresh_token' => null, 'scope' => null, 'token_type' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'oauthAccess'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['access_token' => '?string', 'data' => '\\DocuSign\\eSign\\Model\\NameValue[]', 'expires_in' => '?string', 'refresh_token' => '?string', 'scope' => '?string', 'token_type' => '?string']

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

Return values
mixed

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

getAccessToken()

Gets access_token

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

getExpiresIn()

Gets expires_in

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getRefreshToken()

Gets refresh_token

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

getScope()

Gets scope

public getScope() : string|null
Return values
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>

getTokenType()

Gets token_type

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

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 $offset) : bool
Parameters
$offset : int

Offset

Return values
bool

offsetGet()

Gets offset.

public offsetGet(int $offset) : mixed
Parameters
$offset : int

Offset

Return values
mixed

offsetSet()

Sets value based on offset.

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

Offset

$value : mixed

Value to be set

Return values
void

offsetUnset()

Unsets offset.

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

Offset

Return values
void

setAccessToken()

Sets access_token

public setAccessToken(string|null $access_token) : $this
Parameters
$access_token : string|null

Access token information.

Return values
$this

setData()

Sets data

public setData(array<string|int, NameValue$data) : $this
Parameters
$data : array<string|int, NameValue>
Return values
$this

setExpiresIn()

Sets expires_in

public setExpiresIn(string|null $expires_in) : $this
Parameters
$expires_in : string|null
Return values
$this

setRefreshToken()

Sets refresh_token

public setRefreshToken(string|null $refresh_token) : $this
Parameters
$refresh_token : string|null
Return values
$this

setScope()

Sets scope

public setScope(string|null $scope) : $this
Parameters
$scope : string|null

Must be set to "api".

Return values
$this

setters()

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

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

setTokenType()

Sets token_type

public setTokenType(string|null $token_type) : $this
Parameters
$token_type : string|null
Return values
$this

swaggerFormats()

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

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

swaggerTypes()

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

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

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

Search results