Documentation

EnvelopePurgeConfiguration
in package
implements ModelInterface, ArrayAccess

EnvelopePurgeConfiguration Class Doc Comment

Tags
category

Class

description

Contains information about the current envelope purge configuration for an account, which enables account administrators to purge documents from completed and voided envelopes after a set number of days (`retentionDays`).

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
getModelName()  : string
The original name of the model.
getPurgeEnvelopes()  : string|null
Gets purge_envelopes
getRedactPii()  : string|null
Gets redact_pii
getRemoveTabsAndEnvelopeAttachments()  : string|null
Gets remove_tabs_and_envelope_attachments
getRetentionDays()  : string|null
Gets retention_days
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.
setPurgeEnvelopes()  : $this
Sets purge_envelopes
setRedactPii()  : $this
Sets redact_pii
setRemoveTabsAndEnvelopeAttachments()  : $this
Sets remove_tabs_and_envelope_attachments
setRetentionDays()  : $this
Sets retention_days
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

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 = ['purge_envelopes' => 'purgeEnvelopes', 'redact_pii' => 'redactPII', 'remove_tabs_and_envelope_attachments' => 'removeTabsAndEnvelopeAttachments', 'retention_days' => 'retentionDays']

$getters

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

protected static array<string|int, string> $getters = ['purge_envelopes' => 'getPurgeEnvelopes', 'redact_pii' => 'getRedactPii', 'remove_tabs_and_envelope_attachments' => 'getRemoveTabsAndEnvelopeAttachments', 'retention_days' => 'getRetentionDays']

$setters

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

protected static array<string|int, string> $setters = ['purge_envelopes' => 'setPurgeEnvelopes', 'redact_pii' => 'setRedactPii', 'remove_tabs_and_envelope_attachments' => 'setRemoveTabsAndEnvelopeAttachments', 'retention_days' => 'setRetentionDays']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['purge_envelopes' => null, 'redact_pii' => null, 'remove_tabs_and_envelope_attachments' => null, 'retention_days' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'envelopePurgeConfiguration'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['purge_envelopes' => '?string', 'redact_pii' => '?string', 'remove_tabs_and_envelope_attachments' => '?string', 'retention_days' => '?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 —

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

getPurgeEnvelopes()

Gets purge_envelopes

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

getRemoveTabsAndEnvelopeAttachments()

Gets remove_tabs_and_envelope_attachments

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

setPurgeEnvelopes()

Sets purge_envelopes

public setPurgeEnvelopes(string|null $purge_envelopes) : $this
Parameters
$purge_envelopes : string|null
Return values
$this —

setRedactPii()

Sets redact_pii

public setRedactPii(string|null $redact_pii) : $this
Parameters
$redact_pii : string|null
Return values
$this —

setRemoveTabsAndEnvelopeAttachments()

Sets remove_tabs_and_envelope_attachments

public setRemoveTabsAndEnvelopeAttachments(string|null $remove_tabs_and_envelope_attachments) : $this
Parameters
$remove_tabs_and_envelope_attachments : string|null
Return values
$this —

setRetentionDays()

Sets retention_days

public setRetentionDays(string|null $retention_days) : $this
Parameters
$retention_days : 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

Search results