Documentation

MergeField
in package
implements ModelInterface, ArrayAccess

MergeField Class Doc Comment

Tags
category

Class

description

Contains information for transfering values between Salesforce data fields and DocuSign Tabs.

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
getAllowSenderToEdit()  : string|null
Gets allow_sender_to_edit
getAllowSenderToEditMetadata()  : PropertyMetadata
Gets allow_sender_to_edit_metadata
getConfigurationType()  : string|null
Gets configuration_type
getConfigurationTypeMetadata()  : PropertyMetadata
Gets configuration_type_metadata
getModelName()  : string
The original name of the model.
getPath()  : string|null
Gets path
getPathExtended()  : array<string|int, PathExtendedElement>
Gets path_extended
getPathExtendedMetadata()  : PropertyMetadata
Gets path_extended_metadata
getPathMetadata()  : PropertyMetadata
Gets path_metadata
getRow()  : string|null
Gets row
getRowMetadata()  : PropertyMetadata
Gets row_metadata
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getWriteBack()  : string|null
Gets write_back
getWriteBackMetadata()  : PropertyMetadata
Gets write_back_metadata
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.
setAllowSenderToEdit()  : $this
Sets allow_sender_to_edit
setAllowSenderToEditMetadata()  : $this
Sets allow_sender_to_edit_metadata
setConfigurationType()  : $this
Sets configuration_type
setConfigurationTypeMetadata()  : $this
Sets configuration_type_metadata
setPath()  : $this
Sets path
setPathExtended()  : $this
Sets path_extended
setPathExtendedMetadata()  : $this
Sets path_extended_metadata
setPathMetadata()  : $this
Sets path_metadata
setRow()  : $this
Sets row
setRowMetadata()  : $this
Sets row_metadata
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setWriteBack()  : $this
Sets write_back
setWriteBackMetadata()  : $this
Sets write_back_metadata
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 = ['allow_sender_to_edit' => 'allowSenderToEdit', 'allow_sender_to_edit_metadata' => 'allowSenderToEditMetadata', 'configuration_type' => 'configurationType', 'configuration_type_metadata' => 'configurationTypeMetadata', 'path' => 'path', 'path_extended' => 'pathExtended', 'path_extended_metadata' => 'pathExtendedMetadata', 'path_metadata' => 'pathMetadata', 'row' => 'row', 'row_metadata' => 'rowMetadata', 'write_back' => 'writeBack', 'write_back_metadata' => 'writeBackMetadata']

$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 = ['allow_sender_to_edit' => 'getAllowSenderToEdit', 'allow_sender_to_edit_metadata' => 'getAllowSenderToEditMetadata', 'configuration_type' => 'getConfigurationType', 'configuration_type_metadata' => 'getConfigurationTypeMetadata', 'path' => 'getPath', 'path_extended' => 'getPathExtended', 'path_extended_metadata' => 'getPathExtendedMetadata', 'path_metadata' => 'getPathMetadata', 'row' => 'getRow', 'row_metadata' => 'getRowMetadata', 'write_back' => 'getWriteBack', 'write_back_metadata' => 'getWriteBackMetadata']

$setters

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

protected static array<string|int, string> $setters = ['allow_sender_to_edit' => 'setAllowSenderToEdit', 'allow_sender_to_edit_metadata' => 'setAllowSenderToEditMetadata', 'configuration_type' => 'setConfigurationType', 'configuration_type_metadata' => 'setConfigurationTypeMetadata', 'path' => 'setPath', 'path_extended' => 'setPathExtended', 'path_extended_metadata' => 'setPathExtendedMetadata', 'path_metadata' => 'setPathMetadata', 'row' => 'setRow', 'row_metadata' => 'setRowMetadata', 'write_back' => 'setWriteBack', 'write_back_metadata' => 'setWriteBackMetadata']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['allow_sender_to_edit' => null, 'allow_sender_to_edit_metadata' => null, 'configuration_type' => null, 'configuration_type_metadata' => null, 'path' => null, 'path_extended' => null, 'path_extended_metadata' => null, 'path_metadata' => null, 'row' => null, 'row_metadata' => null, 'write_back' => null, 'write_back_metadata' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'mergeField'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['allow_sender_to_edit' => '?string', 'allow_sender_to_edit_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'configuration_type' => '?string', 'configuration_type_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'path' => '?string', 'path_extended' => '\\DocuSign\\eSign\\Model\\PathExtendedElement[]', 'path_extended_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'path_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'row' => '?string', 'row_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'write_back' => '?string', 'write_back_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata']

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

getAllowSenderToEdit()

Gets allow_sender_to_edit

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

getConfigurationType()

Gets configuration_type

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getPath()

Gets path

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

getRow()

Gets row

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

getWriteBack()

Gets write_back

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

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 —

setAllowSenderToEdit()

Sets allow_sender_to_edit

public setAllowSenderToEdit(string|null $allow_sender_to_edit) : $this
Parameters
$allow_sender_to_edit : string|null

When set to true, the sender can modify the value of the custom tab during the sending process.

Return values
$this —

setAllowSenderToEditMetadata()

Sets allow_sender_to_edit_metadata

public setAllowSenderToEditMetadata(PropertyMetadata $allow_sender_to_edit_metadata) : $this
Parameters
$allow_sender_to_edit_metadata : PropertyMetadata

Metadata that indicates if the sender can edit the allowSenderToEdit property.

Return values
$this —

setConfigurationType()

Sets configuration_type

public setConfigurationType(string|null $configuration_type) : $this
Parameters
$configuration_type : string|null

If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce.

Return values
$this —

setConfigurationTypeMetadata()

Sets configuration_type_metadata

public setConfigurationTypeMetadata(PropertyMetadata $configuration_type_metadata) : $this
Parameters
$configuration_type_metadata : PropertyMetadata

Metadata that indicates if the sender can edit the configurationType property.

Return values
$this —

setPath()

Sets path

public setPath(string|null $path) : $this
Parameters
$path : string|null

Sets the object associated with the custom tab. Currently this is the Salesforce Object.

Return values
$this —

setPathExtendedMetadata()

Sets path_extended_metadata

public setPathExtendedMetadata(PropertyMetadata $path_extended_metadata) : $this
Parameters
$path_extended_metadata : PropertyMetadata

Reserved for DocuSign.

Return values
$this —

setPathMetadata()

Sets path_metadata

public setPathMetadata(PropertyMetadata $path_metadata) : $this
Parameters
$path_metadata : PropertyMetadata

Metadata that indicates whether the path property is editable.

Return values
$this —

setRow()

Sets row

public setRow(string|null $row) : $this
Parameters
$row : string|null

Specifies the row number in a Salesforce table that the merge field value corresponds to.

Return values
$this —

setRowMetadata()

Sets row_metadata

public setRowMetadata(PropertyMetadata $row_metadata) : $this
Parameters
$row_metadata : PropertyMetadata

Metadata that indicates whether the row property is editable.

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

setWriteBack()

Sets write_back

public setWriteBack(string|null $write_back) : $this
Parameters
$write_back : string|null

When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed.

Return values
$this —

setWriteBackMetadata()

Sets write_back_metadata

public setWriteBackMetadata(PropertyMetadata $write_back_metadata) : $this
Parameters
$write_back_metadata : PropertyMetadata

Metadata that indicates if the sender can edit the writeBack property.

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