Documentation

ConnectSalesforceObject
in package
implements ModelInterface, ArrayAccess

ConnectSalesforceObject Class Doc Comment

Tags
category

Class

description

A `connectSalesforceObject` is an object that updates envelope and document status or recipient status in your Salesforce account. When you install DocuSign Connect for Salesforce, the service automatically sets up two Connect objects: one that updates envelope status and documents and one that updates recipient status. You can also customize DocuSign Connect for Salesforce by associating DocuSign objects with Salesforce objects so that DocuSign Connect for Salesforce updates or inserts the information into the Salesforce object. For more information, see DocuSign for Salesforce - Adding Completed Documents to the Notes and Attachments.

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
getActive()  : string|null
Gets active
getDescription()  : string|null
Gets description
getId()  : string|null
Gets id
getInsert()  : string|null
Gets insert
getModelName()  : string
The original name of the model.
getOnCompleteOnly()  : string|null
Gets on_complete_only
getSelectFields()  : array<string|int, ConnectSalesforceField>
Gets select_fields
getSfObject()  : string|null
Gets sf_object
getSfObjectName()  : string|null
Gets sf_object_name
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUpdateFields()  : array<string|int, ConnectSalesforceField>
Gets update_fields
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.
setActive()  : $this
Sets active
setDescription()  : $this
Sets description
setId()  : $this
Sets id
setInsert()  : $this
Sets insert
setOnCompleteOnly()  : $this
Sets on_complete_only
setSelectFields()  : $this
Sets select_fields
setSfObject()  : $this
Sets sf_object
setSfObjectName()  : $this
Sets sf_object_name
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUpdateFields()  : $this
Sets update_fields
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 = ['active' => 'active', 'description' => 'description', 'id' => 'id', 'insert' => 'insert', 'on_complete_only' => 'onCompleteOnly', 'select_fields' => 'selectFields', 'sf_object' => 'sfObject', 'sf_object_name' => 'sfObjectName', 'update_fields' => 'updateFields']

$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 = ['active' => 'getActive', 'description' => 'getDescription', 'id' => 'getId', 'insert' => 'getInsert', 'on_complete_only' => 'getOnCompleteOnly', 'select_fields' => 'getSelectFields', 'sf_object' => 'getSfObject', 'sf_object_name' => 'getSfObjectName', 'update_fields' => 'getUpdateFields']

$setters

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

protected static array<string|int, string> $setters = ['active' => 'setActive', 'description' => 'setDescription', 'id' => 'setId', 'insert' => 'setInsert', 'on_complete_only' => 'setOnCompleteOnly', 'select_fields' => 'setSelectFields', 'sf_object' => 'setSfObject', 'sf_object_name' => 'setSfObjectName', 'update_fields' => 'setUpdateFields']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['active' => null, 'description' => null, 'id' => null, 'insert' => null, 'on_complete_only' => null, 'select_fields' => null, 'sf_object' => null, 'sf_object_name' => null, 'update_fields' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'connectSalesforceObject'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['active' => '?string', 'description' => '?string', 'id' => '?string', 'insert' => '?string', 'on_complete_only' => '?string', 'select_fields' => '\\DocuSign\\eSign\\Model\\ConnectSalesforceField[]', 'sf_object' => '?string', 'sf_object_name' => '?string', 'update_fields' => '\\DocuSign\\eSign\\Model\\ConnectSalesforceField[]']

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

getDescription()

Gets description

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getOnCompleteOnly()

Gets on_complete_only

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

getSfObjectName()

Gets sf_object_name

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

setActive()

Sets active

public setActive(string|null $active) : $this
Parameters
$active : string|null
Return values
$this —

setDescription()

Sets description

public setDescription(string|null $description) : $this
Parameters
$description : string|null
Return values
$this —

setId()

Sets id

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

setInsert()

Sets insert

public setInsert(string|null $insert) : $this
Parameters
$insert : string|null
Return values
$this —

setOnCompleteOnly()

Sets on_complete_only

public setOnCompleteOnly(string|null $on_complete_only) : $this
Parameters
$on_complete_only : string|null
Return values
$this —

setSfObject()

Sets sf_object

public setSfObject(string|null $sf_object) : $this
Parameters
$sf_object : string|null
Return values
$this —

setSfObjectName()

Sets sf_object_name

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