Documentation

MemberSharedItems
in package
implements ModelInterface, ArrayAccess

MemberSharedItems Class Doc Comment

Tags
category

Class

description

Information about shared items.

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
getEnvelopes()  : array<string|int, SharedItem>
Gets envelopes
getErrorDetails()  : ErrorDetails
Gets error_details
getFolders()  : array<string|int, FolderSharedItem>
Gets folders
getModelName()  : string
The original name of the model.
getTemplates()  : array<string|int, TemplateSharedItem>
Gets templates
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUser()  : UserInfo
Gets user
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.
setEnvelopes()  : $this
Sets envelopes
setErrorDetails()  : $this
Sets error_details
setFolders()  : $this
Sets folders
setTemplates()  : $this
Sets templates
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUser()  : $this
Sets user
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 = ['envelopes' => 'envelopes', 'error_details' => 'errorDetails', 'folders' => 'folders', 'templates' => 'templates', 'user' => 'user']

$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 = ['envelopes' => 'getEnvelopes', 'error_details' => 'getErrorDetails', 'folders' => 'getFolders', 'templates' => 'getTemplates', 'user' => 'getUser']

$setters

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

protected static array<string|int, string> $setters = ['envelopes' => 'setEnvelopes', 'error_details' => 'setErrorDetails', 'folders' => 'setFolders', 'templates' => 'setTemplates', 'user' => 'setUser']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['envelopes' => null, 'error_details' => null, 'folders' => null, 'templates' => null, 'user' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'memberSharedItems'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['envelopes' => '\\DocuSign\\eSign\\Model\\SharedItem[]', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'folders' => '\\DocuSign\\eSign\\Model\\FolderSharedItem[]', 'templates' => '\\DocuSign\\eSign\\Model\\TemplateSharedItem[]', 'user' => '\\DocuSign\\eSign\\Model\\UserInfo']

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>

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getters()

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

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

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

setEnvelopes()

Sets envelopes

public setEnvelopes(array<string|int, SharedItem$envelopes) : $this
Parameters
$envelopes : array<string|int, SharedItem>
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>

setUser()

Sets user

public setUser(UserInfo $user) : $this
Parameters
$user : UserInfo

Information about the user requesting sharing information.

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