Documentation

UserSignature
in package
implements ModelInterface, ArrayAccess

UserSignature 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
getAdoptedDateTime()  : string|null
Gets adopted_date_time
getCreatedDateTime()  : string|null
Gets created_date_time
getCustomField()  : string|null
Gets custom_field
getDateStampProperties()  : DateStampProperties
Gets date_stamp_properties
getDisallowUserResizeStamp()  : string|null
Gets disallow_user_resize_stamp
getErrorDetails()  : ErrorDetails
Gets error_details
getExternalId()  : string|null
Gets external_id
getImageBase64()  : string|null
Gets image_base64
getImageType()  : string|null
Gets image_type
getInitials150ImageId()  : string|null
Gets initials150_image_id
getInitialsImageUri()  : string|null
Gets initials_image_uri
getIsDefault()  : string|null
Gets is_default
getLastModifiedDateTime()  : string|null
Gets last_modified_date_time
getModelName()  : string
The original name of the model.
getNrdsId()  : string|null
Gets nrds_id
getNrdsLastName()  : string|null
Gets nrds_last_name
getNrdsStatus()  : string|null
Gets nrds_status
getPhoneticName()  : string|null
Gets phonetic_name
getSignature150ImageId()  : string|null
Gets signature150_image_id
getSignatureFont()  : string|null
Gets signature_font
getSignatureId()  : string|null
Gets signature_id
getSignatureImageUri()  : string|null
Gets signature_image_uri
getSignatureInitials()  : string|null
Gets signature_initials
getSignatureName()  : string|null
Gets signature_name
getSignatureRights()  : string|null
Gets signature_rights
getSignatureType()  : string|null
Gets signature_type
getStampFormat()  : string|null
Gets stamp_format
getStampImageUri()  : string|null
Gets stamp_image_uri
getStampSizeMm()  : string|null
Gets stamp_size_mm
getStampType()  : string|null
Gets stamp_type
getStatus()  : string|null
Gets status
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.
setAdoptedDateTime()  : $this
Sets adopted_date_time
setCreatedDateTime()  : $this
Sets created_date_time
setCustomField()  : $this
Sets custom_field
setDateStampProperties()  : $this
Sets date_stamp_properties
setDisallowUserResizeStamp()  : $this
Sets disallow_user_resize_stamp
setErrorDetails()  : $this
Sets error_details
setExternalId()  : $this
Sets external_id
setImageBase64()  : $this
Sets image_base64
setImageType()  : $this
Sets image_type
setInitials150ImageId()  : $this
Sets initials150_image_id
setInitialsImageUri()  : $this
Sets initials_image_uri
setIsDefault()  : $this
Sets is_default
setLastModifiedDateTime()  : $this
Sets last_modified_date_time
setNrdsId()  : $this
Sets nrds_id
setNrdsLastName()  : $this
Sets nrds_last_name
setNrdsStatus()  : $this
Sets nrds_status
setPhoneticName()  : $this
Sets phonetic_name
setSignature150ImageId()  : $this
Sets signature150_image_id
setSignatureFont()  : $this
Sets signature_font
setSignatureId()  : $this
Sets signature_id
setSignatureImageUri()  : $this
Sets signature_image_uri
setSignatureInitials()  : $this
Sets signature_initials
setSignatureName()  : $this
Sets signature_name
setSignatureRights()  : $this
Sets signature_rights
setSignatureType()  : $this
Sets signature_type
setStampFormat()  : $this
Sets stamp_format
setStampImageUri()  : $this
Sets stamp_image_uri
setStampSizeMm()  : $this
Sets stamp_size_mm
setStampType()  : $this
Sets stamp_type
setStatus()  : $this
Sets status
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 = ['adopted_date_time' => 'adoptedDateTime', 'created_date_time' => 'createdDateTime', 'custom_field' => 'customField', 'date_stamp_properties' => 'dateStampProperties', 'disallow_user_resize_stamp' => 'disallowUserResizeStamp', 'error_details' => 'errorDetails', 'external_id' => 'externalID', 'image_base64' => 'imageBase64', 'image_type' => 'imageType', 'initials150_image_id' => 'initials150ImageId', 'initials_image_uri' => 'initialsImageUri', 'is_default' => 'isDefault', 'last_modified_date_time' => 'lastModifiedDateTime', 'nrds_id' => 'nrdsId', 'nrds_last_name' => 'nrdsLastName', 'nrds_status' => 'nrdsStatus', 'phonetic_name' => 'phoneticName', 'signature150_image_id' => 'signature150ImageId', 'signature_font' => 'signatureFont', 'signature_id' => 'signatureId', 'signature_image_uri' => 'signatureImageUri', 'signature_initials' => 'signatureInitials', 'signature_name' => 'signatureName', 'signature_rights' => 'signatureRights', 'signature_type' => 'signatureType', 'stamp_format' => 'stampFormat', 'stamp_image_uri' => 'stampImageUri', 'stamp_size_mm' => 'stampSizeMM', 'stamp_type' => 'stampType', 'status' => 'status']

$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 = ['adopted_date_time' => 'getAdoptedDateTime', 'created_date_time' => 'getCreatedDateTime', 'custom_field' => 'getCustomField', 'date_stamp_properties' => 'getDateStampProperties', 'disallow_user_resize_stamp' => 'getDisallowUserResizeStamp', 'error_details' => 'getErrorDetails', 'external_id' => 'getExternalId', 'image_base64' => 'getImageBase64', 'image_type' => 'getImageType', 'initials150_image_id' => 'getInitials150ImageId', 'initials_image_uri' => 'getInitialsImageUri', 'is_default' => 'getIsDefault', 'last_modified_date_time' => 'getLastModifiedDateTime', 'nrds_id' => 'getNrdsId', 'nrds_last_name' => 'getNrdsLastName', 'nrds_status' => 'getNrdsStatus', 'phonetic_name' => 'getPhoneticName', 'signature150_image_id' => 'getSignature150ImageId', 'signature_font' => 'getSignatureFont', 'signature_id' => 'getSignatureId', 'signature_image_uri' => 'getSignatureImageUri', 'signature_initials' => 'getSignatureInitials', 'signature_name' => 'getSignatureName', 'signature_rights' => 'getSignatureRights', 'signature_type' => 'getSignatureType', 'stamp_format' => 'getStampFormat', 'stamp_image_uri' => 'getStampImageUri', 'stamp_size_mm' => 'getStampSizeMm', 'stamp_type' => 'getStampType', 'status' => 'getStatus']

$setters

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

protected static array<string|int, string> $setters = ['adopted_date_time' => 'setAdoptedDateTime', 'created_date_time' => 'setCreatedDateTime', 'custom_field' => 'setCustomField', 'date_stamp_properties' => 'setDateStampProperties', 'disallow_user_resize_stamp' => 'setDisallowUserResizeStamp', 'error_details' => 'setErrorDetails', 'external_id' => 'setExternalId', 'image_base64' => 'setImageBase64', 'image_type' => 'setImageType', 'initials150_image_id' => 'setInitials150ImageId', 'initials_image_uri' => 'setInitialsImageUri', 'is_default' => 'setIsDefault', 'last_modified_date_time' => 'setLastModifiedDateTime', 'nrds_id' => 'setNrdsId', 'nrds_last_name' => 'setNrdsLastName', 'nrds_status' => 'setNrdsStatus', 'phonetic_name' => 'setPhoneticName', 'signature150_image_id' => 'setSignature150ImageId', 'signature_font' => 'setSignatureFont', 'signature_id' => 'setSignatureId', 'signature_image_uri' => 'setSignatureImageUri', 'signature_initials' => 'setSignatureInitials', 'signature_name' => 'setSignatureName', 'signature_rights' => 'setSignatureRights', 'signature_type' => 'setSignatureType', 'stamp_format' => 'setStampFormat', 'stamp_image_uri' => 'setStampImageUri', 'stamp_size_mm' => 'setStampSizeMm', 'stamp_type' => 'setStampType', 'status' => 'setStatus']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['adopted_date_time' => null, 'created_date_time' => null, 'custom_field' => null, 'date_stamp_properties' => null, 'disallow_user_resize_stamp' => null, 'error_details' => null, 'external_id' => null, 'image_base64' => null, 'image_type' => null, 'initials150_image_id' => null, 'initials_image_uri' => null, 'is_default' => null, 'last_modified_date_time' => null, 'nrds_id' => null, 'nrds_last_name' => null, 'nrds_status' => null, 'phonetic_name' => null, 'signature150_image_id' => null, 'signature_font' => null, 'signature_id' => null, 'signature_image_uri' => null, 'signature_initials' => null, 'signature_name' => null, 'signature_rights' => null, 'signature_type' => null, 'stamp_format' => null, 'stamp_image_uri' => null, 'stamp_size_mm' => null, 'stamp_type' => null, 'status' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'userSignature'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['adopted_date_time' => '?string', 'created_date_time' => '?string', 'custom_field' => '?string', 'date_stamp_properties' => '\\DocuSign\\eSign\\Model\\DateStampProperties', 'disallow_user_resize_stamp' => '?string', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'external_id' => '?string', 'image_base64' => '?string', 'image_type' => '?string', 'initials150_image_id' => '?string', 'initials_image_uri' => '?string', 'is_default' => '?string', 'last_modified_date_time' => '?string', 'nrds_id' => '?string', 'nrds_last_name' => '?string', 'nrds_status' => '?string', 'phonetic_name' => '?string', 'signature150_image_id' => '?string', 'signature_font' => '?string', 'signature_id' => '?string', 'signature_image_uri' => '?string', 'signature_initials' => '?string', 'signature_name' => '?string', 'signature_rights' => '?string', 'signature_type' => '?string', 'stamp_format' => '?string', 'stamp_image_uri' => '?string', 'stamp_size_mm' => '?string', 'stamp_type' => '?string', 'status' => '?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> —

getAdoptedDateTime()

Gets adopted_date_time

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

getCreatedDateTime()

Gets created_date_time

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

getCustomField()

Gets custom_field

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

getDisallowUserResizeStamp()

Gets disallow_user_resize_stamp

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

getExternalId()

Gets external_id

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

getImageBase64()

Gets image_base64

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

getImageType()

Gets image_type

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

getInitials150ImageId()

Gets initials150_image_id

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

getInitialsImageUri()

Gets initials_image_uri

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

getIsDefault()

Gets is_default

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

getLastModifiedDateTime()

Gets last_modified_date_time

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getNrdsId()

Gets nrds_id

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

getNrdsLastName()

Gets nrds_last_name

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

getNrdsStatus()

Gets nrds_status

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

getPhoneticName()

Gets phonetic_name

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

getSignature150ImageId()

Gets signature150_image_id

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

getSignatureFont()

Gets signature_font

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

getSignatureId()

Gets signature_id

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

getSignatureImageUri()

Gets signature_image_uri

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

getSignatureInitials()

Gets signature_initials

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

getSignatureName()

Gets signature_name

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

getSignatureRights()

Gets signature_rights

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

getSignatureType()

Gets signature_type

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

getStampFormat()

Gets stamp_format

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

getStampImageUri()

Gets stamp_image_uri

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

getStampSizeMm()

Gets stamp_size_mm

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

getStampType()

Gets stamp_type

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

getStatus()

Gets status

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

setAdoptedDateTime()

Sets adopted_date_time

public setAdoptedDateTime(string|null $adopted_date_time) : $this
Parameters
$adopted_date_time : string|null

The date and time the user adopted their signature.

Return values
$this —

setCreatedDateTime()

Sets created_date_time

public setCreatedDateTime(string|null $created_date_time) : $this
Parameters
$created_date_time : string|null

Indicates the date and time the item was created.

Return values
$this —

setCustomField()

Sets custom_field

public setCustomField(string|null $custom_field) : $this
Parameters
$custom_field : string|null
Return values
$this —

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 —

setErrorDetails()

Sets error_details

public setErrorDetails(ErrorDetails $error_details) : $this
Parameters
$error_details : ErrorDetails

Array or errors.

Return values
$this —

setExternalId()

Sets external_id

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

setImageBase64()

Sets image_base64

public setImageBase64(string|null $image_base64) : $this
Parameters
$image_base64 : string|null
Return values
$this —

setImageType()

Sets image_type

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

setInitials150ImageId()

Sets initials150_image_id

public setInitials150ImageId(string|null $initials150_image_id) : $this
Parameters
$initials150_image_id : string|null
Return values
$this —

setInitialsImageUri()

Sets initials_image_uri

public setInitialsImageUri(string|null $initials_image_uri) : $this
Parameters
$initials_image_uri : string|null

Contains the URI for an endpoint that you can use to retrieve the initials image.

Return values
$this —

setIsDefault()

Sets is_default

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

setLastModifiedDateTime()

Sets last_modified_date_time

public setLastModifiedDateTime(string|null $last_modified_date_time) : $this
Parameters
$last_modified_date_time : string|null

The date and time the item was last modified.

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 —

setNrdsStatus()

Sets nrds_status

public setNrdsStatus(string|null $nrds_status) : $this
Parameters
$nrds_status : string|null
Return values
$this —

setPhoneticName()

Sets phonetic_name

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

setSignature150ImageId()

Sets signature150_image_id

public setSignature150ImageId(string|null $signature150_image_id) : $this
Parameters
$signature150_image_id : string|null
Return values
$this —

setSignatureFont()

Sets signature_font

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

The font type for the signature, if the signature is not drawn. The supported font types are: "7_DocuSign", "1_DocuSign", "6_DocuSign", "8_DocuSign", "3_DocuSign", "Mistral", "4_DocuSign", "2_DocuSign", "5_DocuSign", "Rage Italic"

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 —

setSignatureImageUri()

Sets signature_image_uri

public setSignatureImageUri(string|null $signature_image_uri) : $this
Parameters
$signature_image_uri : string|null

Contains the URI for an endpoint that you can use to retrieve the signature image.

Return values
$this —

setSignatureInitials()

Sets signature_initials

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

The initials associated with the signature.

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 —

setSignatureRights()

Sets signature_rights

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

setStampImageUri()

Sets stamp_image_uri

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

setStampType()

Sets stamp_type

public setStampType(string|null $stamp_type) : $this
Parameters
$stamp_type : string|null
Return values
$this —

setStatus()

Sets status

public setStatus(string|null $status) : $this
Parameters
$status : string|null

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.

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