Documentation

EnvelopeTemplateDefinition
in package
implements ArrayAccess

EnvelopeTemplateDefinition Class Doc Comment

Tags
category

Class

description

A complex element containing the following information: templateId: Unique identifier of the template. If this is not provided, DocuSign will generate a value. name: Name of the template. Maximum length: 100 characters. shared: When set to true, the template is shared with the Everyone group in the account. If false, the template is only shared with the Administrator group. password: Password, if the template is locked. description: Description of the template. Maximum Length: 500 characters. pageCount: Number of document pages in the template. folderName: The name of the folder the template is located in. folderId: The ID for the folder. owner: The userName, email, userId, userType, and userStatus for the template owner.

author

Swagger Codegen team

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes, Traits and Enums

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)
$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()  : mixed
getCreated()  : string
Gets created
getDescription()  : string
Gets description
getFolderId()  : string
Gets folder_id
getFolderName()  : string
Gets folder_name
getFolderUri()  : string
Gets folder_uri
getLastModified()  : string
Gets last_modified
getLastModifiedBy()  : UserInfo
Gets last_modified_by
getName()  : string
Gets name
getNewPassword()  : string
Gets new_password
getOwner()  : UserInfo
Gets owner
getPageCount()  : int
Gets page_count
getParentFolderUri()  : string
Gets parent_folder_uri
getPassword()  : string
Gets password
getShared()  : string
Gets shared
getTemplateId()  : string
Gets template_id
getters()  : mixed
getUri()  : string
Gets uri
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
setDescription()  : $this
Sets description
setFolderId()  : $this
Sets folder_id
setFolderName()  : $this
Sets folder_name
setFolderUri()  : $this
Sets folder_uri
setLastModified()  : $this
Sets last_modified
setLastModifiedBy()  : $this
Sets last_modified_by
setName()  : $this
Sets name
setNewPassword()  : $this
Sets new_password
setOwner()  : $this
Sets owner
setPageCount()  : $this
Sets page_count
setParentFolderUri()  : $this
Sets parent_folder_uri
setPassword()  : $this
Sets password
setShared()  : $this
Sets shared
setTemplateId()  : $this
Sets template_id
setters()  : mixed
setUri()  : $this
Sets uri
swaggerTypes()  : mixed
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', 'description' => 'description', 'folder_id' => 'folderId', 'folder_name' => 'folderName', 'folder_uri' => 'folderUri', 'last_modified' => 'lastModified', 'last_modified_by' => 'lastModifiedBy', 'name' => 'name', 'new_password' => 'newPassword', 'owner' => 'owner', 'page_count' => 'pageCount', 'parent_folder_uri' => 'parentFolderUri', 'password' => 'password', 'shared' => 'shared', 'template_id' => 'templateId', 'uri' => 'uri']

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['created' => 'getCreated', 'description' => 'getDescription', 'folder_id' => 'getFolderId', 'folder_name' => 'getFolderName', 'folder_uri' => 'getFolderUri', 'last_modified' => 'getLastModified', 'last_modified_by' => 'getLastModifiedBy', 'name' => 'getName', 'new_password' => 'getNewPassword', 'owner' => 'getOwner', 'page_count' => 'getPageCount', 'parent_folder_uri' => 'getParentFolderUri', 'password' => 'getPassword', 'shared' => 'getShared', 'template_id' => 'getTemplateId', 'uri' => 'getUri']

$setters

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

protected static array<string|int, string> $setters = ['created' => 'setCreated', 'description' => 'setDescription', 'folder_id' => 'setFolderId', 'folder_name' => 'setFolderName', 'folder_uri' => 'setFolderUri', 'last_modified' => 'setLastModified', 'last_modified_by' => 'setLastModifiedBy', 'name' => 'setName', 'new_password' => 'setNewPassword', 'owner' => 'setOwner', 'page_count' => 'setPageCount', 'parent_folder_uri' => 'setParentFolderUri', 'password' => 'setPassword', 'shared' => 'setShared', 'template_id' => 'setTemplateId', 'uri' => 'setUri']

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'envelopeTemplateDefinition'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['created' => 'string', 'description' => 'string', 'folder_id' => 'string', 'folder_name' => 'string', 'folder_uri' => 'string', 'last_modified' => 'string', 'last_modified_by' => '\\DocuSign\\eSign\\Model\\UserInfo', 'name' => 'string', 'new_password' => 'string', 'owner' => '\\DocuSign\\eSign\\Model\\UserInfo', 'page_count' => 'int', 'parent_folder_uri' => 'string', 'password' => 'string', 'shared' => 'string', 'template_id' => 'string', 'uri' => '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 —

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 $created) : $this
Parameters
$created : string
Return values
$this —

setDescription()

Sets description

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

setFolderId()

Sets folder_id

public setFolderId(string $folder_id) : $this
Parameters
$folder_id : string

The ID for the folder.

Return values
$this —

setFolderName()

Sets folder_name

public setFolderName(string $folder_name) : $this
Parameters
$folder_name : string

The name of the folder in which the template is located.

Return values
$this —

setFolderUri()

Sets folder_uri

public setFolderUri(string $folder_uri) : $this
Parameters
$folder_uri : string

The URI of the folder.

Return values
$this —

setLastModified()

Sets last_modified

public setLastModified(string $last_modified) : $this
Parameters
$last_modified : string
Return values
$this —

setNewPassword()

Sets new_password

public setNewPassword(string $new_password) : $this
Parameters
$new_password : string
Return values
$this —

setPageCount()

Sets page_count

public setPageCount(int $page_count) : $this
Parameters
$page_count : int

An integer value specifying the number of document pages in the template. Omit this property if not submitting a page count.

Return values
$this —

setParentFolderUri()

Sets parent_folder_uri

public setParentFolderUri(string $parent_folder_uri) : $this
Parameters
$parent_folder_uri : string
Return values
$this —

setPassword()

Sets password

public setPassword(string $password) : $this
Parameters
$password : string
Return values
$this —

setShared()

Sets shared

public setShared(string $shared) : $this
Parameters
$shared : string

When set to true, this custom tab is shared.

Return values
$this —

setTemplateId()

Sets template_id

public setTemplateId(string $template_id) : $this
Parameters
$template_id : string

The unique identifier of the template. If this is not provided, DocuSign will generate a value.

Return values
$this —

valid()

validate all the properties in the model return true if all passed

public valid() : bool
Return values
bool —

True if all properteis are valid

Search results