Documentation

ConnectLog
in package
implements ModelInterface, ArrayAccess

ConnectLog Class Doc Comment

Tags
category

Class

description

Contains information about a Connect log entry.

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
getAccountId()  : string|null
Gets account_id
getConfigUrl()  : string|null
Gets config_url
getConnectDebugLog()  : array<string|int, ConnectDebugLog>
Gets connect_debug_log
getConnectId()  : string|null
Gets connect_id
getCreated()  : string|null
Gets created
getEmail()  : string|null
Gets email
getEnvelopeId()  : string|null
Gets envelope_id
getError()  : string|null
Gets error
getFailureId()  : string|null
Gets failure_id
getFailureUri()  : string|null
Gets failure_uri
getLastTry()  : string|null
Gets last_try
getLogId()  : string|null
Gets log_id
getLogUri()  : string|null
Gets log_uri
getModelName()  : string
The original name of the model.
getRetryCount()  : string|null
Gets retry_count
getRetryUri()  : string|null
Gets retry_uri
getStatus()  : string|null
Gets status
getSubject()  : string|null
Gets subject
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUserName()  : string|null
Gets user_name
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.
setAccountId()  : $this
Sets account_id
setConfigUrl()  : $this
Sets config_url
setConnectDebugLog()  : $this
Sets connect_debug_log
setConnectId()  : $this
Sets connect_id
setCreated()  : $this
Sets created
setEmail()  : $this
Sets email
setEnvelopeId()  : $this
Sets envelope_id
setError()  : $this
Sets error
setFailureId()  : $this
Sets failure_id
setFailureUri()  : $this
Sets failure_uri
setLastTry()  : $this
Sets last_try
setLogId()  : $this
Sets log_id
setLogUri()  : $this
Sets log_uri
setRetryCount()  : $this
Sets retry_count
setRetryUri()  : $this
Sets retry_uri
setStatus()  : $this
Sets status
setSubject()  : $this
Sets subject
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUserName()  : $this
Sets user_name
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 = ['account_id' => 'accountId', 'config_url' => 'configUrl', 'connect_debug_log' => 'connectDebugLog', 'connect_id' => 'connectId', 'created' => 'created', 'email' => 'email', 'envelope_id' => 'envelopeId', 'error' => 'error', 'failure_id' => 'failureId', 'failure_uri' => 'failureUri', 'last_try' => 'lastTry', 'log_id' => 'logId', 'log_uri' => 'logUri', 'retry_count' => 'retryCount', 'retry_uri' => 'retryUri', 'status' => 'status', 'subject' => 'subject', 'user_name' => 'userName']

$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 = ['account_id' => 'getAccountId', 'config_url' => 'getConfigUrl', 'connect_debug_log' => 'getConnectDebugLog', 'connect_id' => 'getConnectId', 'created' => 'getCreated', 'email' => 'getEmail', 'envelope_id' => 'getEnvelopeId', 'error' => 'getError', 'failure_id' => 'getFailureId', 'failure_uri' => 'getFailureUri', 'last_try' => 'getLastTry', 'log_id' => 'getLogId', 'log_uri' => 'getLogUri', 'retry_count' => 'getRetryCount', 'retry_uri' => 'getRetryUri', 'status' => 'getStatus', 'subject' => 'getSubject', 'user_name' => 'getUserName']

$setters

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

protected static array<string|int, string> $setters = ['account_id' => 'setAccountId', 'config_url' => 'setConfigUrl', 'connect_debug_log' => 'setConnectDebugLog', 'connect_id' => 'setConnectId', 'created' => 'setCreated', 'email' => 'setEmail', 'envelope_id' => 'setEnvelopeId', 'error' => 'setError', 'failure_id' => 'setFailureId', 'failure_uri' => 'setFailureUri', 'last_try' => 'setLastTry', 'log_id' => 'setLogId', 'log_uri' => 'setLogUri', 'retry_count' => 'setRetryCount', 'retry_uri' => 'setRetryUri', 'status' => 'setStatus', 'subject' => 'setSubject', 'user_name' => 'setUserName']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['account_id' => null, 'config_url' => null, 'connect_debug_log' => null, 'connect_id' => null, 'created' => null, 'email' => null, 'envelope_id' => null, 'error' => null, 'failure_id' => null, 'failure_uri' => null, 'last_try' => null, 'log_id' => null, 'log_uri' => null, 'retry_count' => null, 'retry_uri' => null, 'status' => null, 'subject' => null, 'user_name' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'connectLog'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['account_id' => '?string', 'config_url' => '?string', 'connect_debug_log' => '\\DocuSign\\eSign\\Model\\ConnectDebugLog[]', 'connect_id' => '?string', 'created' => '?string', 'email' => '?string', 'envelope_id' => '?string', 'error' => '?string', 'failure_id' => '?string', 'failure_uri' => '?string', 'last_try' => '?string', 'log_id' => '?string', 'log_uri' => '?string', 'retry_count' => '?string', 'retry_uri' => '?string', 'status' => '?string', 'subject' => '?string', 'user_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> —

getAccountId()

Gets account_id

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

getConfigUrl()

Gets config_url

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

getConnectId()

Gets connect_id

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

getCreated()

Gets created

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

getEmail()

Gets email

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

getEnvelopeId()

Gets envelope_id

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

getError()

Gets error

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

getFailureId()

Gets failure_id

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

getFailureUri()

Gets failure_uri

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

getLastTry()

Gets last_try

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

getLogId()

Gets log_id

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

getLogUri()

Gets log_uri

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getRetryCount()

Gets retry_count

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

getRetryUri()

Gets retry_uri

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

getStatus()

Gets status

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

getSubject()

Gets subject

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

getUserName()

Gets user_name

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

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 —

setAccountId()

Sets account_id

public setAccountId(string|null $account_id) : $this
Parameters
$account_id : string|null

The account ID associated with the envelope.

Return values
$this —

setConfigUrl()

Sets config_url

public setConfigUrl(string|null $config_url) : $this
Parameters
$config_url : string|null

The web address of the listener or Retrieving Service end point for Connect.

Return values
$this —

setConnectDebugLog()

Sets connect_debug_log

public setConnectDebugLog(array<string|int, ConnectDebugLog> $connect_debug_log) : $this
Parameters
$connect_debug_log : array<string|int, ConnectDebugLog>

A complex element containing information about the Connect configuration, error details, date/time, description and payload. This is only included in the response if the query additional_info=true is used.

Return values
$this —

setConnectId()

Sets connect_id

public setConnectId(string|null $connect_id) : $this
Parameters
$connect_id : string|null

The identifier for the Connect configuration that failed. If an account has multiple Connect configurations, this value is used to look up the Connect configuration for the failed post.

Return values
$this —

setCreated()

Sets created

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

The date and time the entry was created.

Return values
$this —

setEmail()

Sets email

public setEmail(string|null $email) : $this
Parameters
$email : string|null

The email that sent the envelope.

Return values
$this —

setEnvelopeId()

Sets envelope_id

public setEnvelopeId(string|null $envelope_id) : $this
Parameters
$envelope_id : string|null

The envelope ID of the envelope status that failed to post.

Return values
$this —

setError()

Sets error

public setError(string|null $error) : $this
Parameters
$error : string|null

The error that caused the Connect post to fail.

Return values
$this —

setFailureId()

Sets failure_id

public setFailureId(string|null $failure_id) : $this
Parameters
$failure_id : string|null

The failure log ID for the failure.

Return values
$this —

setFailureUri()

Sets failure_uri

public setFailureUri(string|null $failure_uri) : $this
Parameters
$failure_uri : string|null

The URI for the failure.

Return values
$this —

setLastTry()

Sets last_try

public setLastTry(string|null $last_try) : $this
Parameters
$last_try : string|null

The date and time the last attempt to post.

Return values
$this —

setLogId()

Sets log_id

public setLogId(string|null $log_id) : $this
Parameters
$log_id : string|null

The Connect log ID for the entry.

Return values
$this —

setLogUri()

Sets log_uri

public setLogUri(string|null $log_uri) : $this
Parameters
$log_uri : string|null

The URI for the log item.

Return values
$this —

setRetryCount()

Sets retry_count

public setRetryCount(string|null $retry_count) : $this
Parameters
$retry_count : string|null

The number of times the Connect post has been retried.

Return values
$this —

setRetryUri()

Sets retry_uri

public setRetryUri(string|null $retry_uri) : $this
Parameters
$retry_uri : string|null

The UEI to retry to publish the Connect failure.

Return values
$this —

setStatus()

Sets status

public setStatus(string|null $status) : $this
Parameters
$status : string|null

The new envelope status for the failed Connect post. The possible values are: Any, Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut, Template, or Processing.

Return values
$this —

setSubject()

Sets subject

public setSubject(string|null $subject) : $this
Parameters
$subject : string|null

The envelope subject.

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

setUserName()

Sets user_name

public setUserName(string|null $user_name) : $this
Parameters
$user_name : string|null

The name of the envelope sender.

Return values
$this —

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