Documentation

Stamp
in package
implements ModelInterface, ArrayAccess

Stamp 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
getLastModifiedDateTime()  : string|null
Gets last_modified_date_time
getModelName()  : string
The original name of the model.
getPhoneticName()  : string|null
Gets phonetic_name
getSignatureName()  : string|null
Gets signature_name
getStampFormat()  : string|null
Gets stamp_format
getStampImageUri()  : string|null
Gets stamp_image_uri
getStampSizeMm()  : string|null
Gets stamp_size_mm
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
setLastModifiedDateTime()  : $this
Sets last_modified_date_time
setPhoneticName()  : $this
Sets phonetic_name
setSignatureName()  : $this
Sets signature_name
setStampFormat()  : $this
Sets stamp_format
setStampImageUri()  : $this
Sets stamp_image_uri
setStampSizeMm()  : $this
Sets stamp_size_mm
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

DISCRIMINATOR

public mixed DISCRIMINATOR = null

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', 'last_modified_date_time' => 'lastModifiedDateTime', 'phonetic_name' => 'phoneticName', 'signature_name' => 'signatureName', 'stamp_format' => 'stampFormat', 'stamp_image_uri' => 'stampImageUri', 'stamp_size_mm' => 'stampSizeMM', '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', 'last_modified_date_time' => 'getLastModifiedDateTime', 'phonetic_name' => 'getPhoneticName', 'signature_name' => 'getSignatureName', 'stamp_format' => 'getStampFormat', 'stamp_image_uri' => 'getStampImageUri', 'stamp_size_mm' => 'getStampSizeMm', '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', 'last_modified_date_time' => 'setLastModifiedDateTime', 'phonetic_name' => 'setPhoneticName', 'signature_name' => 'setSignatureName', 'stamp_format' => 'setStampFormat', 'stamp_image_uri' => 'setStampImageUri', 'stamp_size_mm' => 'setStampSizeMm', '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, 'last_modified_date_time' => null, 'phonetic_name' => null, 'signature_name' => null, 'stamp_format' => null, 'stamp_image_uri' => null, 'stamp_size_mm' => null, 'status' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'stamp'

$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', 'last_modified_date_time' => '?string', 'phonetic_name' => '?string', 'signature_name' => '?string', 'stamp_format' => '?string', 'stamp_image_uri' => '?string', 'stamp_size_mm' => '?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

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

getPhoneticName()

Gets phonetic_name

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

getSignatureName()

Gets signature_name

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

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

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

setPhoneticName()

Sets phonetic_name

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

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

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