Documentation

ConnectSalesforceField
in package
implements ModelInterface, ArrayAccess

ConnectSalesforceField Class Doc Comment

Tags
category

Class

description

This object is used to match a DocuSign field to a Salesforce field so that Docusign can send information to your Salesforce account.

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
getDsAttribute()  : string|null
Gets ds_attribute
getDsLink()  : string|null
Gets ds_link
getDsNode()  : string|null
Gets ds_node
getId()  : string|null
Gets id
getModelName()  : string
The original name of the model.
getSfField()  : string|null
Gets sf_field
getSfFieldName()  : string|null
Gets sf_field_name
getSfFolder()  : string|null
Gets sf_folder
getSfLockedValue()  : string|null
Gets sf_locked_value
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.
setDsAttribute()  : $this
Sets ds_attribute
setDsLink()  : $this
Sets ds_link
setDsNode()  : $this
Sets ds_node
setId()  : $this
Sets id
setSfField()  : $this
Sets sf_field
setSfFieldName()  : $this
Sets sf_field_name
setSfFolder()  : $this
Sets sf_folder
setSfLockedValue()  : $this
Sets sf_locked_value
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 = ['ds_attribute' => 'dsAttribute', 'ds_link' => 'dsLink', 'ds_node' => 'dsNode', 'id' => 'id', 'sf_field' => 'sfField', 'sf_field_name' => 'sfFieldName', 'sf_folder' => 'sfFolder', 'sf_locked_value' => 'sfLockedValue']

$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 = ['ds_attribute' => 'getDsAttribute', 'ds_link' => 'getDsLink', 'ds_node' => 'getDsNode', 'id' => 'getId', 'sf_field' => 'getSfField', 'sf_field_name' => 'getSfFieldName', 'sf_folder' => 'getSfFolder', 'sf_locked_value' => 'getSfLockedValue']

$setters

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

protected static array<string|int, string> $setters = ['ds_attribute' => 'setDsAttribute', 'ds_link' => 'setDsLink', 'ds_node' => 'setDsNode', 'id' => 'setId', 'sf_field' => 'setSfField', 'sf_field_name' => 'setSfFieldName', 'sf_folder' => 'setSfFolder', 'sf_locked_value' => 'setSfLockedValue']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['ds_attribute' => null, 'ds_link' => null, 'ds_node' => null, 'id' => null, 'sf_field' => null, 'sf_field_name' => null, 'sf_folder' => null, 'sf_locked_value' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'connectSalesforceField'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['ds_attribute' => '?string', 'ds_link' => '?string', 'ds_node' => '?string', 'id' => '?string', 'sf_field' => '?string', 'sf_field_name' => '?string', 'sf_folder' => '?string', 'sf_locked_value' => '?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>

getDsAttribute()

Gets ds_attribute

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getSfFieldName()

Gets sf_field_name

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

getSfLockedValue()

Gets sf_locked_value

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

setDsAttribute()

Sets ds_attribute

public setDsAttribute(string|null $ds_attribute) : $this
Parameters
$ds_attribute : string|null
Return values
$this

Sets ds_link

public setDsLink(string|null $ds_link) : $this
Parameters
$ds_link : string|null
Return values
$this

setDsNode()

Sets ds_node

public setDsNode(string|null $ds_node) : $this
Parameters
$ds_node : string|null
Return values
$this

setId()

Sets id

public setId(string|null $id) : $this
Parameters
$id : string|null
Return values
$this

setSfField()

Sets sf_field

public setSfField(string|null $sf_field) : $this
Parameters
$sf_field : string|null
Return values
$this

setSfFieldName()

Sets sf_field_name

public setSfFieldName(string|null $sf_field_name) : $this
Parameters
$sf_field_name : string|null
Return values
$this

setSfFolder()

Sets sf_folder

public setSfFolder(string|null $sf_folder) : $this
Parameters
$sf_folder : string|null
Return values
$this

setSfLockedValue()

Sets sf_locked_value

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