Documentation

SigningGroup
in package
implements ModelInterface, ArrayAccess

SigningGroup Class Doc Comment

Tags
category

Class

description

Contains details about a signing group. Signing groups enable you to send an envelope to a predefined group of recipients and have any one member of the group sign your documents. When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature.

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
getCreated()  : string|null
Gets created
getCreatedBy()  : string|null
Gets created_by
getErrorDetails()  : ErrorDetails
Gets error_details
getGroupEmail()  : string|null
Gets group_email
getGroupName()  : string|null
Gets group_name
getGroupType()  : string|null
Gets group_type
getModelName()  : string
The original name of the model.
getModified()  : string|null
Gets modified
getModifiedBy()  : string|null
Gets modified_by
getSigningGroupId()  : string|null
Gets signing_group_id
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUsers()  : array<string|int, SigningGroupUser>
Gets users
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.
setCreated()  : $this
Sets created
setCreatedBy()  : $this
Sets created_by
setErrorDetails()  : $this
Sets error_details
setGroupEmail()  : $this
Sets group_email
setGroupName()  : $this
Sets group_name
setGroupType()  : $this
Sets group_type
setModified()  : $this
Sets modified
setModifiedBy()  : $this
Sets modified_by
setSigningGroupId()  : $this
Sets signing_group_id
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUsers()  : $this
Sets users
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 = ['created' => 'created', 'created_by' => 'createdBy', 'error_details' => 'errorDetails', 'group_email' => 'groupEmail', 'group_name' => 'groupName', 'group_type' => 'groupType', 'modified' => 'modified', 'modified_by' => 'modifiedBy', 'signing_group_id' => 'signingGroupId', 'users' => 'users']

$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 = ['created' => 'getCreated', 'created_by' => 'getCreatedBy', 'error_details' => 'getErrorDetails', 'group_email' => 'getGroupEmail', 'group_name' => 'getGroupName', 'group_type' => 'getGroupType', 'modified' => 'getModified', 'modified_by' => 'getModifiedBy', 'signing_group_id' => 'getSigningGroupId', 'users' => 'getUsers']

$setters

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

protected static array<string|int, string> $setters = ['created' => 'setCreated', 'created_by' => 'setCreatedBy', 'error_details' => 'setErrorDetails', 'group_email' => 'setGroupEmail', 'group_name' => 'setGroupName', 'group_type' => 'setGroupType', 'modified' => 'setModified', 'modified_by' => 'setModifiedBy', 'signing_group_id' => 'setSigningGroupId', 'users' => 'setUsers']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['created' => null, 'created_by' => null, 'error_details' => null, 'group_email' => null, 'group_name' => null, 'group_type' => null, 'modified' => null, 'modified_by' => null, 'signing_group_id' => null, 'users' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'signingGroup'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['created' => '?string', 'created_by' => '?string', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'group_email' => '?string', 'group_name' => '?string', 'group_type' => '?string', 'modified' => '?string', 'modified_by' => '?string', 'signing_group_id' => '?string', 'users' => '\\DocuSign\\eSign\\Model\\SigningGroupUser[]']

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

getCreated()

Gets created

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

getCreatedBy()

Gets created_by

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

getGroupEmail()

Gets group_email

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

getGroupName()

Gets group_name

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

getGroupType()

Gets group_type

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getModified()

Gets modified

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

getModifiedBy()

Gets modified_by

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

getSigningGroupId()

Gets signing_group_id

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

setCreated()

Sets created

public setCreated(string|null $created) : $this
Parameters
$created : string|null
Return values
$this —

setCreatedBy()

Sets created_by

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

setGroupEmail()

Sets group_email

public setGroupEmail(string|null $group_email) : $this
Parameters
$group_email : string|null
Return values
$this —

setGroupName()

Sets group_name

public setGroupName(string|null $group_name) : $this
Parameters
$group_name : string|null

The name of the group.

Return values
$this —

setGroupType()

Sets group_type

public setGroupType(string|null $group_type) : $this
Parameters
$group_type : string|null
Return values
$this —

setModified()

Sets modified

public setModified(string|null $modified) : $this
Parameters
$modified : string|null
Return values
$this —

setModifiedBy()

Sets modified_by

public setModifiedBy(string|null $modified_by) : $this
Parameters
$modified_by : string|null
Return values
$this —

setSigningGroupId()

Sets signing_group_id

public setSigningGroupId(string|null $signing_group_id) : $this
Parameters
$signing_group_id : string|null

When set to true and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).

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