EnvelopePublishTransaction
in package
implements
ModelInterface, ArrayAccess
EnvelopePublishTransaction 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
- getApplyConnectSettings() : string|null
- Gets apply_connect_settings
- getEnvelopeCount() : string|null
- Gets envelope_count
- getEnvelopeLevelErrorRollups() : array<string|int, EnvelopePublishTransactionErrorRollup>
- Gets envelope_level_error_rollups
- getEnvelopePublishTransactionId() : string|null
- Gets envelope_publish_transaction_id
- getErrorCount() : string|null
- Gets error_count
- getFileLevelErrors() : array<string|int, ?string>
- Gets file_level_errors
- getModelName() : string
- The original name of the model.
- getNoActionRequiredEnvelopeCount() : string|null
- Gets no_action_required_envelope_count
- getProcessedEnvelopeCount() : string|null
- Gets processed_envelope_count
- getProcessingStatus() : string|null
- Gets processing_status
- getResultsUri() : string|null
- Gets results_uri
- getSubmissionDate() : string|null
- Gets submission_date
- getSubmittedByUserInfo() : UserInfo
- Gets submitted_by_user_info
- getSubmittedForPublishingEnvelopeCount() : string|null
- Gets submitted_for_publishing_envelope_count
- 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.
- setApplyConnectSettings() : $this
- Sets apply_connect_settings
- setEnvelopeCount() : $this
- Sets envelope_count
- setEnvelopeLevelErrorRollups() : $this
- Sets envelope_level_error_rollups
- setEnvelopePublishTransactionId() : $this
- Sets envelope_publish_transaction_id
- setErrorCount() : $this
- Sets error_count
- setFileLevelErrors() : $this
- Sets file_level_errors
- setNoActionRequiredEnvelopeCount() : $this
- Sets no_action_required_envelope_count
- setProcessedEnvelopeCount() : $this
- Sets processed_envelope_count
- setProcessingStatus() : $this
- Sets processing_status
- setResultsUri() : $this
- Sets results_uri
- setSubmissionDate() : $this
- Sets submission_date
- setSubmittedByUserInfo() : $this
- Sets submitted_by_user_info
- setSubmittedForPublishingEnvelopeCount() : $this
- Sets submitted_for_publishing_envelope_count
- 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
= ['apply_connect_settings' => 'applyConnectSettings', 'envelope_count' => 'envelopeCount', 'envelope_level_error_rollups' => 'envelopeLevelErrorRollups', 'envelope_publish_transaction_id' => 'envelopePublishTransactionId', 'error_count' => 'errorCount', 'file_level_errors' => 'fileLevelErrors', 'no_action_required_envelope_count' => 'noActionRequiredEnvelopeCount', 'processed_envelope_count' => 'processedEnvelopeCount', 'processing_status' => 'processingStatus', 'results_uri' => 'resultsUri', 'submission_date' => 'submissionDate', 'submitted_by_user_info' => 'submittedByUserInfo', 'submitted_for_publishing_envelope_count' => 'submittedForPublishingEnvelopeCount']
$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
= ['apply_connect_settings' => 'getApplyConnectSettings', 'envelope_count' => 'getEnvelopeCount', 'envelope_level_error_rollups' => 'getEnvelopeLevelErrorRollups', 'envelope_publish_transaction_id' => 'getEnvelopePublishTransactionId', 'error_count' => 'getErrorCount', 'file_level_errors' => 'getFileLevelErrors', 'no_action_required_envelope_count' => 'getNoActionRequiredEnvelopeCount', 'processed_envelope_count' => 'getProcessedEnvelopeCount', 'processing_status' => 'getProcessingStatus', 'results_uri' => 'getResultsUri', 'submission_date' => 'getSubmissionDate', 'submitted_by_user_info' => 'getSubmittedByUserInfo', 'submitted_for_publishing_envelope_count' => 'getSubmittedForPublishingEnvelopeCount']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['apply_connect_settings' => 'setApplyConnectSettings', 'envelope_count' => 'setEnvelopeCount', 'envelope_level_error_rollups' => 'setEnvelopeLevelErrorRollups', 'envelope_publish_transaction_id' => 'setEnvelopePublishTransactionId', 'error_count' => 'setErrorCount', 'file_level_errors' => 'setFileLevelErrors', 'no_action_required_envelope_count' => 'setNoActionRequiredEnvelopeCount', 'processed_envelope_count' => 'setProcessedEnvelopeCount', 'processing_status' => 'setProcessingStatus', 'results_uri' => 'setResultsUri', 'submission_date' => 'setSubmissionDate', 'submitted_by_user_info' => 'setSubmittedByUserInfo', 'submitted_for_publishing_envelope_count' => 'setSubmittedForPublishingEnvelopeCount']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['apply_connect_settings' => null, 'envelope_count' => null, 'envelope_level_error_rollups' => null, 'envelope_publish_transaction_id' => null, 'error_count' => null, 'file_level_errors' => null, 'no_action_required_envelope_count' => null, 'processed_envelope_count' => null, 'processing_status' => null, 'results_uri' => null, 'submission_date' => null, 'submitted_by_user_info' => null, 'submitted_for_publishing_envelope_count' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'envelopePublishTransaction'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['apply_connect_settings' => '?string', 'envelope_count' => '?string', 'envelope_level_error_rollups' => '\\DocuSign\\eSign\\Model\\EnvelopePublishTransactionErrorRollup[]', 'envelope_publish_transaction_id' => '?string', 'error_count' => '?string', 'file_level_errors' => '?string[]', 'no_action_required_envelope_count' => '?string', 'processed_envelope_count' => '?string', 'processing_status' => '?string', 'results_uri' => '?string', 'submission_date' => '?string', 'submitted_by_user_info' => '\\DocuSign\\eSign\\Model\\UserInfo', 'submitted_for_publishing_envelope_count' => '?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> —getApplyConnectSettings()
Gets apply_connect_settings
public
getApplyConnectSettings() : string|null
Return values
string|null —getEnvelopeCount()
Gets envelope_count
public
getEnvelopeCount() : string|null
Return values
string|null —getEnvelopeLevelErrorRollups()
Gets envelope_level_error_rollups
public
getEnvelopeLevelErrorRollups() : array<string|int, EnvelopePublishTransactionErrorRollup>
Return values
array<string|int, EnvelopePublishTransactionErrorRollup> —getEnvelopePublishTransactionId()
Gets envelope_publish_transaction_id
public
getEnvelopePublishTransactionId() : string|null
Return values
string|null —getErrorCount()
Gets error_count
public
getErrorCount() : string|null
Return values
string|null —getFileLevelErrors()
Gets file_level_errors
public
getFileLevelErrors() : array<string|int, ?string>
Return values
array<string|int, ?string> —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getNoActionRequiredEnvelopeCount()
Gets no_action_required_envelope_count
public
getNoActionRequiredEnvelopeCount() : string|null
Return values
string|null —getProcessedEnvelopeCount()
Gets processed_envelope_count
public
getProcessedEnvelopeCount() : string|null
Return values
string|null —getProcessingStatus()
Gets processing_status
public
getProcessingStatus() : string|null
Return values
string|null —getResultsUri()
Gets results_uri
public
getResultsUri() : string|null
Return values
string|null —getSubmissionDate()
Gets submission_date
public
getSubmissionDate() : string|null
Return values
string|null —getSubmittedByUserInfo()
Gets submitted_by_user_info
public
getSubmittedByUserInfo() : UserInfo
Return values
UserInfo —getSubmittedForPublishingEnvelopeCount()
Gets submitted_for_publishing_envelope_count
public
getSubmittedForPublishingEnvelopeCount() : 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 —setApplyConnectSettings()
Sets apply_connect_settings
public
setApplyConnectSettings(string|null $apply_connect_settings) : $this
Parameters
- $apply_connect_settings : string|null
Return values
$this —setEnvelopeCount()
Sets envelope_count
public
setEnvelopeCount(string|null $envelope_count) : $this
Parameters
- $envelope_count : string|null
Return values
$this —setEnvelopeLevelErrorRollups()
Sets envelope_level_error_rollups
public
setEnvelopeLevelErrorRollups(array<string|int, EnvelopePublishTransactionErrorRollup> $envelope_level_error_rollups) : $this
Parameters
- $envelope_level_error_rollups : array<string|int, EnvelopePublishTransactionErrorRollup>
Return values
$this —setEnvelopePublishTransactionId()
Sets envelope_publish_transaction_id
public
setEnvelopePublishTransactionId(string|null $envelope_publish_transaction_id) : $this
Parameters
- $envelope_publish_transaction_id : string|null
Return values
$this —setErrorCount()
Sets error_count
public
setErrorCount(string|null $error_count) : $this
Parameters
- $error_count : string|null
Return values
$this —setFileLevelErrors()
Sets file_level_errors
public
setFileLevelErrors(array<string|int, ?string> $file_level_errors) : $this
Parameters
- $file_level_errors : array<string|int, ?string>
Return values
$this —setNoActionRequiredEnvelopeCount()
Sets no_action_required_envelope_count
public
setNoActionRequiredEnvelopeCount(string|null $no_action_required_envelope_count) : $this
Parameters
- $no_action_required_envelope_count : string|null
Return values
$this —setProcessedEnvelopeCount()
Sets processed_envelope_count
public
setProcessedEnvelopeCount(string|null $processed_envelope_count) : $this
Parameters
- $processed_envelope_count : string|null
Return values
$this —setProcessingStatus()
Sets processing_status
public
setProcessingStatus(string|null $processing_status) : $this
Parameters
- $processing_status : string|null
Return values
$this —setResultsUri()
Sets results_uri
public
setResultsUri(string|null $results_uri) : $this
Parameters
- $results_uri : string|null
Return values
$this —setSubmissionDate()
Sets submission_date
public
setSubmissionDate(string|null $submission_date) : $this
Parameters
- $submission_date : string|null
Return values
$this —setSubmittedByUserInfo()
Sets submitted_by_user_info
public
setSubmittedByUserInfo(UserInfo $submitted_by_user_info) : $this
Parameters
- $submitted_by_user_info : UserInfo
Return values
$this —setSubmittedForPublishingEnvelopeCount()
Sets submitted_for_publishing_envelope_count
public
setSubmittedForPublishingEnvelopeCount(string|null $submitted_for_publishing_envelope_count) : $this
Parameters
- $submitted_for_publishing_envelope_count : 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