Documentation

WorkspaceUserAuthorization
in package
implements ModelInterface, ArrayAccess

WorkspaceUserAuthorization Class Doc Comment

Tags
category

Class

description

Provides properties that describe user authorization to a workspace.

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
getCanDelete()  : string|null
Gets can_delete
getCanMove()  : string|null
Gets can_move
getCanTransact()  : string|null
Gets can_transact
getCanView()  : string|null
Gets can_view
getCreated()  : string|null
Gets created
getCreatedById()  : string|null
Gets created_by_id
getErrorDetails()  : ErrorDetails
Gets error_details
getModelName()  : string
The original name of the model.
getModified()  : string|null
Gets modified
getModifiedById()  : string|null
Gets modified_by_id
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getWorkspaceUserId()  : string|null
Gets workspace_user_id
getWorkspaceUserInformation()  : WorkspaceUser
Gets workspace_user_information
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.
setCanDelete()  : $this
Sets can_delete
setCanMove()  : $this
Sets can_move
setCanTransact()  : $this
Sets can_transact
setCanView()  : $this
Sets can_view
setCreated()  : $this
Sets created
setCreatedById()  : $this
Sets created_by_id
setErrorDetails()  : $this
Sets error_details
setModified()  : $this
Sets modified
setModifiedById()  : $this
Sets modified_by_id
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setWorkspaceUserId()  : $this
Sets workspace_user_id
setWorkspaceUserInformation()  : $this
Sets workspace_user_information
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 = ['can_delete' => 'canDelete', 'can_move' => 'canMove', 'can_transact' => 'canTransact', 'can_view' => 'canView', 'created' => 'created', 'created_by_id' => 'createdById', 'error_details' => 'errorDetails', 'modified' => 'modified', 'modified_by_id' => 'modifiedById', 'workspace_user_id' => 'workspaceUserId', 'workspace_user_information' => 'workspaceUserInformation']

$getters

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

protected static array<string|int, string> $getters = ['can_delete' => 'getCanDelete', 'can_move' => 'getCanMove', 'can_transact' => 'getCanTransact', 'can_view' => 'getCanView', 'created' => 'getCreated', 'created_by_id' => 'getCreatedById', 'error_details' => 'getErrorDetails', 'modified' => 'getModified', 'modified_by_id' => 'getModifiedById', 'workspace_user_id' => 'getWorkspaceUserId', 'workspace_user_information' => 'getWorkspaceUserInformation']

$setters

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

protected static array<string|int, string> $setters = ['can_delete' => 'setCanDelete', 'can_move' => 'setCanMove', 'can_transact' => 'setCanTransact', 'can_view' => 'setCanView', 'created' => 'setCreated', 'created_by_id' => 'setCreatedById', 'error_details' => 'setErrorDetails', 'modified' => 'setModified', 'modified_by_id' => 'setModifiedById', 'workspace_user_id' => 'setWorkspaceUserId', 'workspace_user_information' => 'setWorkspaceUserInformation']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['can_delete' => null, 'can_move' => null, 'can_transact' => null, 'can_view' => null, 'created' => null, 'created_by_id' => null, 'error_details' => null, 'modified' => null, 'modified_by_id' => null, 'workspace_user_id' => null, 'workspace_user_information' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'workspaceUserAuthorization'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['can_delete' => '?string', 'can_move' => '?string', 'can_transact' => '?string', 'can_view' => '?string', 'created' => '?string', 'created_by_id' => '?string', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'modified' => '?string', 'modified_by_id' => '?string', 'workspace_user_id' => '?string', 'workspace_user_information' => '\\DocuSign\\eSign\\Model\\WorkspaceUser']

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 —

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

getters()

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

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

getWorkspaceUserId()

Gets workspace_user_id

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

setCanDelete()

Sets can_delete

public setCanDelete(string|null $can_delete) : $this
Parameters
$can_delete : string|null
Return values
$this —

setCanMove()

Sets can_move

public setCanMove(string|null $can_move) : $this
Parameters
$can_move : string|null
Return values
$this —

setCanTransact()

Sets can_transact

public setCanTransact(string|null $can_transact) : $this
Parameters
$can_transact : string|null
Return values
$this —

setCanView()

Sets can_view

public setCanView(string|null $can_view) : $this
Parameters
$can_view : string|null
Return values
$this —

setCreated()

Sets created

public setCreated(string|null $created) : $this
Parameters
$created : string|null

The UTC DateTime when the workspace user authorization was created.

Return values
$this —

setCreatedById()

Sets created_by_id

public setCreatedById(string|null $created_by_id) : $this
Parameters
$created_by_id : string|null
Return values
$this —

setModified()

Sets modified

public setModified(string|null $modified) : $this
Parameters
$modified : string|null
Return values
$this —

setModifiedById()

Sets modified_by_id

public setModifiedById(string|null $modified_by_id) : $this
Parameters
$modified_by_id : string|null
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> —

setWorkspaceUserId()

Sets workspace_user_id

public setWorkspaceUserId(string|null $workspace_user_id) : $this
Parameters
$workspace_user_id : string|null
Return values
$this —

setWorkspaceUserInformation()

Sets workspace_user_information

public setWorkspaceUserInformation(WorkspaceUser $workspace_user_information) : $this
Parameters
$workspace_user_information : WorkspaceUser

An object that provides details about the workspace user.

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