TemplateSharedItem
in package
implements
ModelInterface, ArrayAccess
TemplateSharedItem Class Doc Comment
Tags
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
- getErrorDetails() : ErrorDetails
- Gets error_details
- getModelName() : string
- The original name of the model.
- getOwner() : UserInfo
- Gets owner
- getPassword() : string|null
- Gets password
- getShared() : string|null
- Gets shared
- getSharedGroups() : array<string|int, MemberGroupSharedItem>
- Gets shared_groups
- getSharedUsers() : array<string|int, UserSharedItem>
- Gets shared_users
- getTemplateId() : string|null
- Gets template_id
- getTemplateName() : string|null
- Gets template_name
- 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.
- setErrorDetails() : $this
- Sets error_details
- setOwner() : $this
- Sets owner
- setPassword() : $this
- Sets password
- setShared() : $this
- Sets shared
- setSharedGroups() : $this
- Sets shared_groups
- setSharedUsers() : $this
- Sets shared_users
- setTemplateId() : $this
- Sets template_id
- setTemplateName() : $this
- Sets template_name
- 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
= ['error_details' => 'errorDetails', 'owner' => 'owner', 'password' => 'password', 'shared' => 'shared', 'shared_groups' => 'sharedGroups', 'shared_users' => 'sharedUsers', 'template_id' => 'templateId', 'template_name' => 'templateName']
$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
= ['error_details' => 'getErrorDetails', 'owner' => 'getOwner', 'password' => 'getPassword', 'shared' => 'getShared', 'shared_groups' => 'getSharedGroups', 'shared_users' => 'getSharedUsers', 'template_id' => 'getTemplateId', 'template_name' => 'getTemplateName']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['error_details' => 'setErrorDetails', 'owner' => 'setOwner', 'password' => 'setPassword', 'shared' => 'setShared', 'shared_groups' => 'setSharedGroups', 'shared_users' => 'setSharedUsers', 'template_id' => 'setTemplateId', 'template_name' => 'setTemplateName']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['error_details' => null, 'owner' => null, 'password' => null, 'shared' => null, 'shared_groups' => null, 'shared_users' => null, 'template_id' => null, 'template_name' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'templateSharedItem'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'owner' => '\\DocuSign\\eSign\\Model\\UserInfo', 'password' => '?string', 'shared' => '?string', 'shared_groups' => '\\DocuSign\\eSign\\Model\\MemberGroupSharedItem[]', 'shared_users' => '\\DocuSign\\eSign\\Model\\UserSharedItem[]', 'template_id' => '?string', 'template_name' => '?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> —getErrorDetails()
Gets error_details
public
getErrorDetails() : ErrorDetails
Return values
ErrorDetails —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getOwner()
Gets owner
public
getOwner() : UserInfo
Return values
UserInfo —getPassword()
Gets password
public
getPassword() : string|null
Return values
string|null —getShared()
Gets shared
public
getShared() : string|null
Return values
string|null —getSharedGroups()
Gets shared_groups
public
getSharedGroups() : array<string|int, MemberGroupSharedItem>
Return values
array<string|int, MemberGroupSharedItem> —getSharedUsers()
Gets shared_users
public
getSharedUsers() : array<string|int, UserSharedItem>
Return values
array<string|int, UserSharedItem> —getTemplateId()
Gets template_id
public
getTemplateId() : string|null
Return values
string|null —getTemplateName()
Gets template_name
public
getTemplateName() : 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 —setErrorDetails()
Sets error_details
public
setErrorDetails(ErrorDetails $error_details) : $this
Parameters
- $error_details : ErrorDetails
-
Array or errors.
Return values
$this —setOwner()
Sets owner
public
setOwner(UserInfo $owner) : $this
Parameters
- $owner : UserInfo
-
Information about the user who owns the template.
Return values
$this —setPassword()
Sets password
public
setPassword(string|null $password) : $this
Parameters
- $password : string|null
Return values
$this —setShared()
Sets shared
public
setShared(string|null $shared) : $this
Parameters
- $shared : string|null
-
When set to true, this custom tab is shared.
Return values
$this —setSharedGroups()
Sets shared_groups
public
setSharedGroups(array<string|int, MemberGroupSharedItem> $shared_groups) : $this
Parameters
- $shared_groups : array<string|int, MemberGroupSharedItem>
Return values
$this —setSharedUsers()
Sets shared_users
public
setSharedUsers(array<string|int, UserSharedItem> $shared_users) : $this
Parameters
- $shared_users : array<string|int, UserSharedItem>
Return values
$this —setTemplateId()
Sets template_id
public
setTemplateId(string|null $template_id) : $this
Parameters
- $template_id : string|null
-
The unique identifier of the template. If this is not provided, DocuSign will generate a value.
Return values
$this —setTemplateName()
Sets template_name
public
setTemplateName(string|null $template_name) : $this
Parameters
- $template_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