Documentation

EnvelopeAttachment
in package
implements ModelInterface, ArrayAccess

EnvelopeAttachment 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
getAccessControl()  : string|null
Gets access_control
getAttachmentId()  : string|null
Gets attachment_id
getAttachmentType()  : string|null
Gets attachment_type
getErrorDetails()  : ErrorDetails
Gets error_details
getLabel()  : string|null
Gets label
getModelName()  : string
The original name of the model.
getName()  : string|null
Gets name
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
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.
setAccessControl()  : $this
Sets access_control
setAttachmentId()  : $this
Sets attachment_id
setAttachmentType()  : $this
Sets attachment_type
setErrorDetails()  : $this
Sets error_details
setLabel()  : $this
Sets label
setName()  : $this
Sets name
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
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_control' => 'accessControl', 'attachment_id' => 'attachmentId', 'attachment_type' => 'attachmentType', 'error_details' => 'errorDetails', 'label' => 'label', 'name' => 'name']

$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_control' => 'getAccessControl', 'attachment_id' => 'getAttachmentId', 'attachment_type' => 'getAttachmentType', 'error_details' => 'getErrorDetails', 'label' => 'getLabel', 'name' => 'getName']

$setters

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

protected static array<string|int, string> $setters = ['access_control' => 'setAccessControl', 'attachment_id' => 'setAttachmentId', 'attachment_type' => 'setAttachmentType', 'error_details' => 'setErrorDetails', 'label' => 'setLabel', 'name' => 'setName']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['access_control' => null, 'attachment_id' => null, 'attachment_type' => null, 'error_details' => null, 'label' => null, 'name' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'envelopeAttachment'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['access_control' => '?string', 'attachment_id' => '?string', 'attachment_type' => '?string', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'label' => '?string', 'name' => '?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>

getAccessControl()

Gets access_control

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

getAttachmentId()

Gets attachment_id

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

getAttachmentType()

Gets attachment_type

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

getLabel()

Gets label

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getName()

Gets name

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

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

setAccessControl()

Sets access_control

public setAccessControl(string|null $access_control) : $this
Parameters
$access_control : string|null
Return values
$this

setAttachmentId()

Sets attachment_id

public setAttachmentId(string|null $attachment_id) : $this
Parameters
$attachment_id : string|null
Return values
$this

setAttachmentType()

Sets attachment_type

public setAttachmentType(string|null $attachment_type) : $this
Parameters
$attachment_type : string|null
Return values
$this

setLabel()

Sets label

public setLabel(string|null $label) : $this
Parameters
$label : string|null
Return values
$this

setName()

Sets name

public setName(string|null $name) : $this
Parameters
$name : 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>

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