Documentation

AccountSignatureDefinition
in package
implements ModelInterface, ArrayAccess

AccountSignatureDefinition 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
getDateStampProperties()  : DateStampProperties
Gets date_stamp_properties
getDisallowUserResizeStamp()  : string|null
Gets disallow_user_resize_stamp
getExternalId()  : string|null
Gets external_id
getImageType()  : string|null
Gets image_type
getIsDefault()  : string|null
Gets is_default
getModelName()  : string
The original name of the model.
getNrdsId()  : string|null
Gets nrds_id
getNrdsLastName()  : string|null
Gets nrds_last_name
getPhoneticName()  : string|null
Gets phonetic_name
getSignatureFont()  : string|null
Gets signature_font
getSignatureGroups()  : array<string|int, SignatureGroupDef>
Gets signature_groups
getSignatureId()  : string|null
Gets signature_id
getSignatureInitials()  : string|null
Gets signature_initials
getSignatureName()  : string|null
Gets signature_name
getSignatureType()  : string|null
Gets signature_type
getSignatureUsers()  : array<string|int, SignatureUserDef>
Gets signature_users
getStampFormat()  : string|null
Gets stamp_format
getStampSizeMm()  : string|null
Gets stamp_size_mm
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.
setDateStampProperties()  : $this
Sets date_stamp_properties
setDisallowUserResizeStamp()  : $this
Sets disallow_user_resize_stamp
setExternalId()  : $this
Sets external_id
setImageType()  : $this
Sets image_type
setIsDefault()  : $this
Sets is_default
setNrdsId()  : $this
Sets nrds_id
setNrdsLastName()  : $this
Sets nrds_last_name
setPhoneticName()  : $this
Sets phonetic_name
setSignatureFont()  : $this
Sets signature_font
setSignatureGroups()  : $this
Sets signature_groups
setSignatureId()  : $this
Sets signature_id
setSignatureInitials()  : $this
Sets signature_initials
setSignatureName()  : $this
Sets signature_name
setSignatureType()  : $this
Sets signature_type
setSignatureUsers()  : $this
Sets signature_users
setStampFormat()  : $this
Sets stamp_format
setStampSizeMm()  : $this
Sets stamp_size_mm
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 = ['date_stamp_properties' => 'dateStampProperties', 'disallow_user_resize_stamp' => 'disallowUserResizeStamp', 'external_id' => 'externalID', 'image_type' => 'imageType', 'is_default' => 'isDefault', 'nrds_id' => 'nrdsId', 'nrds_last_name' => 'nrdsLastName', 'phonetic_name' => 'phoneticName', 'signature_font' => 'signatureFont', 'signature_groups' => 'signatureGroups', 'signature_id' => 'signatureId', 'signature_initials' => 'signatureInitials', 'signature_name' => 'signatureName', 'signature_type' => 'signatureType', 'signature_users' => 'signatureUsers', 'stamp_format' => 'stampFormat', 'stamp_size_mm' => 'stampSizeMM']

$getters

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

protected static array<string|int, string> $getters = ['date_stamp_properties' => 'getDateStampProperties', 'disallow_user_resize_stamp' => 'getDisallowUserResizeStamp', 'external_id' => 'getExternalId', 'image_type' => 'getImageType', 'is_default' => 'getIsDefault', 'nrds_id' => 'getNrdsId', 'nrds_last_name' => 'getNrdsLastName', 'phonetic_name' => 'getPhoneticName', 'signature_font' => 'getSignatureFont', 'signature_groups' => 'getSignatureGroups', 'signature_id' => 'getSignatureId', 'signature_initials' => 'getSignatureInitials', 'signature_name' => 'getSignatureName', 'signature_type' => 'getSignatureType', 'signature_users' => 'getSignatureUsers', 'stamp_format' => 'getStampFormat', 'stamp_size_mm' => 'getStampSizeMm']

$setters

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

protected static array<string|int, string> $setters = ['date_stamp_properties' => 'setDateStampProperties', 'disallow_user_resize_stamp' => 'setDisallowUserResizeStamp', 'external_id' => 'setExternalId', 'image_type' => 'setImageType', 'is_default' => 'setIsDefault', 'nrds_id' => 'setNrdsId', 'nrds_last_name' => 'setNrdsLastName', 'phonetic_name' => 'setPhoneticName', 'signature_font' => 'setSignatureFont', 'signature_groups' => 'setSignatureGroups', 'signature_id' => 'setSignatureId', 'signature_initials' => 'setSignatureInitials', 'signature_name' => 'setSignatureName', 'signature_type' => 'setSignatureType', 'signature_users' => 'setSignatureUsers', 'stamp_format' => 'setStampFormat', 'stamp_size_mm' => 'setStampSizeMm']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['date_stamp_properties' => null, 'disallow_user_resize_stamp' => null, 'external_id' => null, 'image_type' => null, 'is_default' => null, 'nrds_id' => null, 'nrds_last_name' => null, 'phonetic_name' => null, 'signature_font' => null, 'signature_groups' => null, 'signature_id' => null, 'signature_initials' => null, 'signature_name' => null, 'signature_type' => null, 'signature_users' => null, 'stamp_format' => null, 'stamp_size_mm' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'accountSignatureDefinition'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['date_stamp_properties' => '\\DocuSign\\eSign\\Model\\DateStampProperties', 'disallow_user_resize_stamp' => '?string', 'external_id' => '?string', 'image_type' => '?string', 'is_default' => '?string', 'nrds_id' => '?string', 'nrds_last_name' => '?string', 'phonetic_name' => '?string', 'signature_font' => '?string', 'signature_groups' => '\\DocuSign\\eSign\\Model\\SignatureGroupDef[]', 'signature_id' => '?string', 'signature_initials' => '?string', 'signature_name' => '?string', 'signature_type' => '?string', 'signature_users' => '\\DocuSign\\eSign\\Model\\SignatureUserDef[]', 'stamp_format' => '?string', 'stamp_size_mm' => '?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 —

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

getDisallowUserResizeStamp()

Gets disallow_user_resize_stamp

public getDisallowUserResizeStamp() : string|null
Return values
string|null —

getSignatureInitials()

Gets signature_initials

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

setDateStampProperties()

Sets date_stamp_properties

public setDateStampProperties(DateStampProperties $date_stamp_properties) : $this
Parameters
$date_stamp_properties : DateStampProperties

Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. This property contains the following information about the central rectangle: - DateAreaX: The X axis position of the top-left corner. - DateAreaY: The Y axis position of the top-left corner. - DateAreaWidth: The width of the rectangle. - DateAreaHeight: The height of the rectangle.

Return values
$this —

setDisallowUserResizeStamp()

Sets disallow_user_resize_stamp

public setDisallowUserResizeStamp(string|null $disallow_user_resize_stamp) : $this
Parameters
$disallow_user_resize_stamp : string|null
Return values
$this —

setExternalId()

Sets external_id

public setExternalId(string|null $external_id) : $this
Parameters
$external_id : string|null
Return values
$this —

setImageType()

Sets image_type

public setImageType(string|null $image_type) : $this
Parameters
$image_type : string|null
Return values
$this —

setIsDefault()

Sets is_default

public setIsDefault(string|null $is_default) : $this
Parameters
$is_default : string|null
Return values
$this —

setNrdsId()

Sets nrds_id

public setNrdsId(string|null $nrds_id) : $this
Parameters
$nrds_id : string|null
Return values
$this —

setNrdsLastName()

Sets nrds_last_name

public setNrdsLastName(string|null $nrds_last_name) : $this
Parameters
$nrds_last_name : string|null
Return values
$this —

setPhoneticName()

Sets phonetic_name

public setPhoneticName(string|null $phonetic_name) : $this
Parameters
$phonetic_name : string|null
Return values
$this —

setSignatureFont()

Sets signature_font

public setSignatureFont(string|null $signature_font) : $this
Parameters
$signature_font : string|null
Return values
$this —

setSignatureId()

Sets signature_id

public setSignatureId(string|null $signature_id) : $this
Parameters
$signature_id : string|null

Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the signatureName property in the body is used. This allows the use of special characters (such as "&", "<", ">") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID.

Return values
$this —

setSignatureInitials()

Sets signature_initials

public setSignatureInitials(string|null $signature_initials) : $this
Parameters
$signature_initials : string|null
Return values
$this —

setSignatureName()

Sets signature_name

public setSignatureName(string|null $signature_name) : $this
Parameters
$signature_name : string|null

Specifies the user signature name.

Return values
$this —

setSignatureType()

Sets signature_type

public setSignatureType(string|null $signature_type) : $this
Parameters
$signature_type : string|null
Return values
$this —

setStampFormat()

Sets stamp_format

public setStampFormat(string|null $stamp_format) : $this
Parameters
$stamp_format : string|null
Return values
$this —

setStampSizeMm()

Sets stamp_size_mm

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