Documentation

AccountInformation
in package
implements ModelInterface, ArrayAccess

AccountInformation Class Doc Comment

Tags
category

Class

description

Contains account Information.

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
getAccountIdGuid()  : string|null
Gets account_id_guid
getAccountName()  : string|null
Gets account_name
getAccountSettings()  : AccountSettingsInformation
Gets account_settings
getAllowTransactionRooms()  : string|null
Gets allow_transaction_rooms
getBillingPeriodDaysRemaining()  : string|null
Gets billing_period_days_remaining
getBillingPeriodEndDate()  : string|null
Gets billing_period_end_date
getBillingPeriodEnvelopesAllowed()  : string|null
Gets billing_period_envelopes_allowed
getBillingPeriodEnvelopesSent()  : string|null
Gets billing_period_envelopes_sent
getBillingPeriodStartDate()  : string|null
Gets billing_period_start_date
getBillingProfile()  : string|null
Gets billing_profile
getBrands()  : BrandsResponse
Gets brands
getCanUpgrade()  : string|null
Gets can_upgrade
getConnectPermission()  : string|null
Gets connect_permission
getCreatedDate()  : string|null
Gets created_date
getCurrencyCode()  : string|null
Gets currency_code
getCurrentPlanId()  : string|null
Gets current_plan_id
getDisplayApplianceStartUrl()  : string|null
Gets display_appliance_start_url
getDisplayApplianceUrl()  : string|null
Gets display_appliance_url
getDistributorCode()  : string|null
Gets distributor_code
getDocuSignLandingUrl()  : string|null
Gets docu_sign_landing_url
getDssValues()  : mixed
Gets dss_values
getEnvelopeSendingBlocked()  : string|null
Gets envelope_sending_blocked
getEnvelopeUnitPrice()  : string|null
Gets envelope_unit_price
getExternalAccountId()  : string|null
Gets external_account_id
getForgottenPasswordQuestionsCount()  : string|null
Gets forgotten_password_questions_count
getFreeEnvelopeSendsRemainingForAdvancedDocGen()  : int|null
Gets free_envelope_sends_remaining_for_advanced_doc_gen
getIsDowngrade()  : string|null
Gets is_downgrade
getModelName()  : string
The original name of the model.
getPaymentMethod()  : string|null
Gets payment_method
getPlanClassification()  : string|null
Gets plan_classification
getPlanEndDate()  : string|null
Gets plan_end_date
getPlanName()  : string|null
Gets plan_name
getPlanStartDate()  : string|null
Gets plan_start_date
getRecipientDomains()  : array<string|int, RecipientDomain>
Gets recipient_domains
getSeatsAllowed()  : string|null
Gets seats_allowed
getSeatsInUse()  : string|null
Gets seats_in_use
getStatus21CfrPart11()  : string|null
Gets status21_cfr_part11
getSuspensionDate()  : string|null
Gets suspension_date
getSuspensionStatus()  : string|null
Gets suspension_status
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUseDisplayAppliance()  : bool|null
Gets use_display_appliance
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.
setAccountIdGuid()  : $this
Sets account_id_guid
setAccountName()  : $this
Sets account_name
setAccountSettings()  : $this
Sets account_settings
setAllowTransactionRooms()  : $this
Sets allow_transaction_rooms
setBillingPeriodDaysRemaining()  : $this
Sets billing_period_days_remaining
setBillingPeriodEndDate()  : $this
Sets billing_period_end_date
setBillingPeriodEnvelopesAllowed()  : $this
Sets billing_period_envelopes_allowed
setBillingPeriodEnvelopesSent()  : $this
Sets billing_period_envelopes_sent
setBillingPeriodStartDate()  : $this
Sets billing_period_start_date
setBillingProfile()  : $this
Sets billing_profile
setBrands()  : $this
Sets brands
setCanUpgrade()  : $this
Sets can_upgrade
setConnectPermission()  : $this
Sets connect_permission
setCreatedDate()  : $this
Sets created_date
setCurrencyCode()  : $this
Sets currency_code
setCurrentPlanId()  : $this
Sets current_plan_id
setDisplayApplianceStartUrl()  : $this
Sets display_appliance_start_url
setDisplayApplianceUrl()  : $this
Sets display_appliance_url
setDistributorCode()  : $this
Sets distributor_code
setDocuSignLandingUrl()  : $this
Sets docu_sign_landing_url
setDssValues()  : $this
Sets dss_values
setEnvelopeSendingBlocked()  : $this
Sets envelope_sending_blocked
setEnvelopeUnitPrice()  : $this
Sets envelope_unit_price
setExternalAccountId()  : $this
Sets external_account_id
setForgottenPasswordQuestionsCount()  : $this
Sets forgotten_password_questions_count
setFreeEnvelopeSendsRemainingForAdvancedDocGen()  : $this
Sets free_envelope_sends_remaining_for_advanced_doc_gen
setIsDowngrade()  : $this
Sets is_downgrade
setPaymentMethod()  : $this
Sets payment_method
setPlanClassification()  : $this
Sets plan_classification
setPlanEndDate()  : $this
Sets plan_end_date
setPlanName()  : $this
Sets plan_name
setPlanStartDate()  : $this
Sets plan_start_date
setRecipientDomains()  : $this
Sets recipient_domains
setSeatsAllowed()  : $this
Sets seats_allowed
setSeatsInUse()  : $this
Sets seats_in_use
setStatus21CfrPart11()  : $this
Sets status21_cfr_part11
setSuspensionDate()  : $this
Sets suspension_date
setSuspensionStatus()  : $this
Sets suspension_status
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUseDisplayAppliance()  : $this
Sets use_display_appliance
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_guid' => 'accountIdGuid', 'account_name' => 'accountName', 'account_settings' => 'accountSettings', 'allow_transaction_rooms' => 'allowTransactionRooms', 'billing_period_days_remaining' => 'billingPeriodDaysRemaining', 'billing_period_end_date' => 'billingPeriodEndDate', 'billing_period_envelopes_allowed' => 'billingPeriodEnvelopesAllowed', 'billing_period_envelopes_sent' => 'billingPeriodEnvelopesSent', 'billing_period_start_date' => 'billingPeriodStartDate', 'billing_profile' => 'billingProfile', 'brands' => 'brands', 'can_upgrade' => 'canUpgrade', 'connect_permission' => 'connectPermission', 'created_date' => 'createdDate', 'currency_code' => 'currencyCode', 'current_plan_id' => 'currentPlanId', 'display_appliance_start_url' => 'displayApplianceStartUrl', 'display_appliance_url' => 'displayApplianceUrl', 'distributor_code' => 'distributorCode', 'docu_sign_landing_url' => 'docuSignLandingUrl', 'dss_values' => 'dssValues', 'envelope_sending_blocked' => 'envelopeSendingBlocked', 'envelope_unit_price' => 'envelopeUnitPrice', 'external_account_id' => 'externalAccountId', 'forgotten_password_questions_count' => 'forgottenPasswordQuestionsCount', 'free_envelope_sends_remaining_for_advanced_doc_gen' => 'freeEnvelopeSendsRemainingForAdvancedDocGen', 'is_downgrade' => 'isDowngrade', 'payment_method' => 'paymentMethod', 'plan_classification' => 'planClassification', 'plan_end_date' => 'planEndDate', 'plan_name' => 'planName', 'plan_start_date' => 'planStartDate', 'recipient_domains' => 'recipientDomains', 'seats_allowed' => 'seatsAllowed', 'seats_in_use' => 'seatsInUse', 'status21_cfr_part11' => 'status21CFRPart11', 'suspension_date' => 'suspensionDate', 'suspension_status' => 'suspensionStatus', 'use_display_appliance' => 'useDisplayAppliance']

$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_guid' => 'getAccountIdGuid', 'account_name' => 'getAccountName', 'account_settings' => 'getAccountSettings', 'allow_transaction_rooms' => 'getAllowTransactionRooms', 'billing_period_days_remaining' => 'getBillingPeriodDaysRemaining', 'billing_period_end_date' => 'getBillingPeriodEndDate', 'billing_period_envelopes_allowed' => 'getBillingPeriodEnvelopesAllowed', 'billing_period_envelopes_sent' => 'getBillingPeriodEnvelopesSent', 'billing_period_start_date' => 'getBillingPeriodStartDate', 'billing_profile' => 'getBillingProfile', 'brands' => 'getBrands', 'can_upgrade' => 'getCanUpgrade', 'connect_permission' => 'getConnectPermission', 'created_date' => 'getCreatedDate', 'currency_code' => 'getCurrencyCode', 'current_plan_id' => 'getCurrentPlanId', 'display_appliance_start_url' => 'getDisplayApplianceStartUrl', 'display_appliance_url' => 'getDisplayApplianceUrl', 'distributor_code' => 'getDistributorCode', 'docu_sign_landing_url' => 'getDocuSignLandingUrl', 'dss_values' => 'getDssValues', 'envelope_sending_blocked' => 'getEnvelopeSendingBlocked', 'envelope_unit_price' => 'getEnvelopeUnitPrice', 'external_account_id' => 'getExternalAccountId', 'forgotten_password_questions_count' => 'getForgottenPasswordQuestionsCount', 'free_envelope_sends_remaining_for_advanced_doc_gen' => 'getFreeEnvelopeSendsRemainingForAdvancedDocGen', 'is_downgrade' => 'getIsDowngrade', 'payment_method' => 'getPaymentMethod', 'plan_classification' => 'getPlanClassification', 'plan_end_date' => 'getPlanEndDate', 'plan_name' => 'getPlanName', 'plan_start_date' => 'getPlanStartDate', 'recipient_domains' => 'getRecipientDomains', 'seats_allowed' => 'getSeatsAllowed', 'seats_in_use' => 'getSeatsInUse', 'status21_cfr_part11' => 'getStatus21CfrPart11', 'suspension_date' => 'getSuspensionDate', 'suspension_status' => 'getSuspensionStatus', 'use_display_appliance' => 'getUseDisplayAppliance']

$setters

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

protected static array<string|int, string> $setters = ['account_id_guid' => 'setAccountIdGuid', 'account_name' => 'setAccountName', 'account_settings' => 'setAccountSettings', 'allow_transaction_rooms' => 'setAllowTransactionRooms', 'billing_period_days_remaining' => 'setBillingPeriodDaysRemaining', 'billing_period_end_date' => 'setBillingPeriodEndDate', 'billing_period_envelopes_allowed' => 'setBillingPeriodEnvelopesAllowed', 'billing_period_envelopes_sent' => 'setBillingPeriodEnvelopesSent', 'billing_period_start_date' => 'setBillingPeriodStartDate', 'billing_profile' => 'setBillingProfile', 'brands' => 'setBrands', 'can_upgrade' => 'setCanUpgrade', 'connect_permission' => 'setConnectPermission', 'created_date' => 'setCreatedDate', 'currency_code' => 'setCurrencyCode', 'current_plan_id' => 'setCurrentPlanId', 'display_appliance_start_url' => 'setDisplayApplianceStartUrl', 'display_appliance_url' => 'setDisplayApplianceUrl', 'distributor_code' => 'setDistributorCode', 'docu_sign_landing_url' => 'setDocuSignLandingUrl', 'dss_values' => 'setDssValues', 'envelope_sending_blocked' => 'setEnvelopeSendingBlocked', 'envelope_unit_price' => 'setEnvelopeUnitPrice', 'external_account_id' => 'setExternalAccountId', 'forgotten_password_questions_count' => 'setForgottenPasswordQuestionsCount', 'free_envelope_sends_remaining_for_advanced_doc_gen' => 'setFreeEnvelopeSendsRemainingForAdvancedDocGen', 'is_downgrade' => 'setIsDowngrade', 'payment_method' => 'setPaymentMethod', 'plan_classification' => 'setPlanClassification', 'plan_end_date' => 'setPlanEndDate', 'plan_name' => 'setPlanName', 'plan_start_date' => 'setPlanStartDate', 'recipient_domains' => 'setRecipientDomains', 'seats_allowed' => 'setSeatsAllowed', 'seats_in_use' => 'setSeatsInUse', 'status21_cfr_part11' => 'setStatus21CfrPart11', 'suspension_date' => 'setSuspensionDate', 'suspension_status' => 'setSuspensionStatus', 'use_display_appliance' => 'setUseDisplayAppliance']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['account_id_guid' => null, 'account_name' => null, 'account_settings' => null, 'allow_transaction_rooms' => null, 'billing_period_days_remaining' => null, 'billing_period_end_date' => null, 'billing_period_envelopes_allowed' => null, 'billing_period_envelopes_sent' => null, 'billing_period_start_date' => null, 'billing_profile' => null, 'brands' => null, 'can_upgrade' => null, 'connect_permission' => null, 'created_date' => null, 'currency_code' => null, 'current_plan_id' => null, 'display_appliance_start_url' => null, 'display_appliance_url' => null, 'distributor_code' => null, 'docu_sign_landing_url' => null, 'dss_values' => null, 'envelope_sending_blocked' => null, 'envelope_unit_price' => null, 'external_account_id' => null, 'forgotten_password_questions_count' => null, 'free_envelope_sends_remaining_for_advanced_doc_gen' => 'int32', 'is_downgrade' => null, 'payment_method' => null, 'plan_classification' => null, 'plan_end_date' => null, 'plan_name' => null, 'plan_start_date' => null, 'recipient_domains' => null, 'seats_allowed' => null, 'seats_in_use' => null, 'status21_cfr_part11' => null, 'suspension_date' => null, 'suspension_status' => null, 'use_display_appliance' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'accountInformation'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['account_id_guid' => '?string', 'account_name' => '?string', 'account_settings' => '\\DocuSign\\eSign\\Model\\AccountSettingsInformation', 'allow_transaction_rooms' => '?string', 'billing_period_days_remaining' => '?string', 'billing_period_end_date' => '?string', 'billing_period_envelopes_allowed' => '?string', 'billing_period_envelopes_sent' => '?string', 'billing_period_start_date' => '?string', 'billing_profile' => '?string', 'brands' => '\\DocuSign\\eSign\\Model\\BrandsResponse', 'can_upgrade' => '?string', 'connect_permission' => '?string', 'created_date' => '?string', 'currency_code' => '?string', 'current_plan_id' => '?string', 'display_appliance_start_url' => '?string', 'display_appliance_url' => '?string', 'distributor_code' => '?string', 'docu_sign_landing_url' => '?string', 'dss_values' => 'map[string,?string]', 'envelope_sending_blocked' => '?string', 'envelope_unit_price' => '?string', 'external_account_id' => '?string', 'forgotten_password_questions_count' => '?string', 'free_envelope_sends_remaining_for_advanced_doc_gen' => '?int', 'is_downgrade' => '?string', 'payment_method' => '?string', 'plan_classification' => '?string', 'plan_end_date' => '?string', 'plan_name' => '?string', 'plan_start_date' => '?string', 'recipient_domains' => '\\DocuSign\\eSign\\Model\\RecipientDomain[]', 'seats_allowed' => '?string', 'seats_in_use' => '?string', 'status21_cfr_part11' => '?string', 'suspension_date' => '?string', 'suspension_status' => '?string', 'use_display_appliance' => '?bool']

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>

getAccountIdGuid()

Gets account_id_guid

public getAccountIdGuid() : string|null
Return values
string|null

getAccountName()

Gets account_name

public getAccountName() : string|null
Return values
string|null

getAllowTransactionRooms()

Gets allow_transaction_rooms

public getAllowTransactionRooms() : string|null
Return values
string|null

getBillingPeriodDaysRemaining()

Gets billing_period_days_remaining

public getBillingPeriodDaysRemaining() : string|null
Return values
string|null

getBillingPeriodEndDate()

Gets billing_period_end_date

public getBillingPeriodEndDate() : string|null
Return values
string|null

getBillingPeriodEnvelopesAllowed()

Gets billing_period_envelopes_allowed

public getBillingPeriodEnvelopesAllowed() : string|null
Return values
string|null

getBillingPeriodEnvelopesSent()

Gets billing_period_envelopes_sent

public getBillingPeriodEnvelopesSent() : string|null
Return values
string|null

getBillingPeriodStartDate()

Gets billing_period_start_date

public getBillingPeriodStartDate() : string|null
Return values
string|null

getBillingProfile()

Gets billing_profile

public getBillingProfile() : string|null
Return values
string|null

getCanUpgrade()

Gets can_upgrade

public getCanUpgrade() : string|null
Return values
string|null

getConnectPermission()

Gets connect_permission

public getConnectPermission() : string|null
Return values
string|null

getCreatedDate()

Gets created_date

public getCreatedDate() : string|null
Return values
string|null

getCurrencyCode()

Gets currency_code

public getCurrencyCode() : string|null
Return values
string|null

getCurrentPlanId()

Gets current_plan_id

public getCurrentPlanId() : string|null
Return values
string|null

getDisplayApplianceStartUrl()

Gets display_appliance_start_url

public getDisplayApplianceStartUrl() : string|null
Return values
string|null

getDisplayApplianceUrl()

Gets display_appliance_url

public getDisplayApplianceUrl() : string|null
Return values
string|null

getDistributorCode()

Gets distributor_code

public getDistributorCode() : string|null
Return values
string|null

getDocuSignLandingUrl()

Gets docu_sign_landing_url

public getDocuSignLandingUrl() : string|null
Return values
string|null

getDssValues()

Gets dss_values

public getDssValues() : mixed
Return values
mixed

getEnvelopeSendingBlocked()

Gets envelope_sending_blocked

public getEnvelopeSendingBlocked() : string|null
Return values
string|null

getEnvelopeUnitPrice()

Gets envelope_unit_price

public getEnvelopeUnitPrice() : string|null
Return values
string|null

getExternalAccountId()

Gets external_account_id

public getExternalAccountId() : string|null
Return values
string|null

getForgottenPasswordQuestionsCount()

Gets forgotten_password_questions_count

public getForgottenPasswordQuestionsCount() : string|null
Return values
string|null

getFreeEnvelopeSendsRemainingForAdvancedDocGen()

Gets free_envelope_sends_remaining_for_advanced_doc_gen

public getFreeEnvelopeSendsRemainingForAdvancedDocGen() : int|null
Return values
int|null

getIsDowngrade()

Gets is_downgrade

public getIsDowngrade() : string|null
Return values
string|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getPaymentMethod()

Gets payment_method

public getPaymentMethod() : string|null
Return values
string|null

getPlanClassification()

Gets plan_classification

public getPlanClassification() : string|null
Return values
string|null

getPlanEndDate()

Gets plan_end_date

public getPlanEndDate() : string|null
Return values
string|null

getPlanName()

Gets plan_name

public getPlanName() : string|null
Return values
string|null

getPlanStartDate()

Gets plan_start_date

public getPlanStartDate() : string|null
Return values
string|null

getSeatsAllowed()

Gets seats_allowed

public getSeatsAllowed() : string|null
Return values
string|null

getSeatsInUse()

Gets seats_in_use

public getSeatsInUse() : string|null
Return values
string|null

getStatus21CfrPart11()

Gets status21_cfr_part11

public getStatus21CfrPart11() : string|null
Return values
string|null

getSuspensionDate()

Gets suspension_date

public getSuspensionDate() : string|null
Return values
string|null

getSuspensionStatus()

Gets suspension_status

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

getUseDisplayAppliance()

Gets use_display_appliance

public getUseDisplayAppliance() : bool|null
Return values
bool|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

setAccountIdGuid()

Sets account_id_guid

public setAccountIdGuid(string|null $account_id_guid) : $this
Parameters
$account_id_guid : string|null

The GUID associated with the account ID.

Return values
$this

setAccountName()

Sets account_name

public setAccountName(string|null $account_name) : $this
Parameters
$account_name : string|null

The name of the current account.

Return values
$this

setAccountSettings()

Sets account_settings

public setAccountSettings(AccountSettingsInformation $account_settings) : $this
Parameters
$account_settings : AccountSettingsInformation

The list of account settings. These determine the features available for the account. Note that some features are determined by the plan used to create the account, and cannot be overridden.

Return values
$this

setAllowTransactionRooms()

Sets allow_transaction_rooms

public setAllowTransactionRooms(string|null $allow_transaction_rooms) : $this
Parameters
$allow_transaction_rooms : string|null

When set to true, the transaction rooms feature exposed through the Workspaces API is enabled.

Return values
$this

setBillingPeriodDaysRemaining()

Sets billing_period_days_remaining

public setBillingPeriodDaysRemaining(string|null $billing_period_days_remaining) : $this
Parameters
$billing_period_days_remaining : string|null

Reserved: TBD

Return values
$this

setBillingPeriodEndDate()

Sets billing_period_end_date

public setBillingPeriodEndDate(string|null $billing_period_end_date) : $this
Parameters
$billing_period_end_date : string|null

Reserved: TBD

Return values
$this

setBillingPeriodEnvelopesAllowed()

Sets billing_period_envelopes_allowed

public setBillingPeriodEnvelopesAllowed(string|null $billing_period_envelopes_allowed) : $this
Parameters
$billing_period_envelopes_allowed : string|null

Reserved: TBD

Return values
$this

setBillingPeriodEnvelopesSent()

Sets billing_period_envelopes_sent

public setBillingPeriodEnvelopesSent(string|null $billing_period_envelopes_sent) : $this
Parameters
$billing_period_envelopes_sent : string|null

Reserved: TBD

Return values
$this

setBillingPeriodStartDate()

Sets billing_period_start_date

public setBillingPeriodStartDate(string|null $billing_period_start_date) : $this
Parameters
$billing_period_start_date : string|null

Reserved: TBD

Return values
$this

setBillingProfile()

Sets billing_profile

public setBillingProfile(string|null $billing_profile) : $this
Parameters
$billing_profile : string|null

Reserved: TBD

Return values
$this

setCanUpgrade()

Sets can_upgrade

public setCanUpgrade(string|null $can_upgrade) : $this
Parameters
$can_upgrade : string|null

When set to true, specifies that you can upgrade the account through the API.

Return values
$this

setConnectPermission()

Sets connect_permission

public setConnectPermission(string|null $connect_permission) : $this
Parameters
$connect_permission : string|null
Return values
$this

setCreatedDate()

Sets created_date

public setCreatedDate(string|null $created_date) : $this
Parameters
$created_date : string|null
Return values
$this

setCurrencyCode()

Sets currency_code

public setCurrencyCode(string|null $currency_code) : $this
Parameters
$currency_code : string|null

Specifies the ISO currency code for the account.

Return values
$this

setCurrentPlanId()

Sets current_plan_id

public setCurrentPlanId(string|null $current_plan_id) : $this
Parameters
$current_plan_id : string|null

Identifies the plan that was used create this account.

Return values
$this

setDisplayApplianceStartUrl()

Sets display_appliance_start_url

public setDisplayApplianceStartUrl(string|null $display_appliance_start_url) : $this
Parameters
$display_appliance_start_url : string|null
Return values
$this

setDisplayApplianceUrl()

Sets display_appliance_url

public setDisplayApplianceUrl(string|null $display_appliance_url) : $this
Parameters
$display_appliance_url : string|null
Return values
$this

setDistributorCode()

Sets distributor_code

public setDistributorCode(string|null $distributor_code) : $this
Parameters
$distributor_code : string|null

The code that identifies the billing plan groups and plans for the new account.

Return values
$this

setDocuSignLandingUrl()

Sets docu_sign_landing_url

public setDocuSignLandingUrl(string|null $docu_sign_landing_url) : $this
Parameters
$docu_sign_landing_url : string|null
Return values
$this

setDssValues()

Sets dss_values

public setDssValues(mixed $dss_values) : $this
Parameters
$dss_values : mixed
Return values
$this

setEnvelopeSendingBlocked()

Sets envelope_sending_blocked

public setEnvelopeSendingBlocked(string|null $envelope_sending_blocked) : $this
Parameters
$envelope_sending_blocked : string|null
Return values
$this

setEnvelopeUnitPrice()

Sets envelope_unit_price

public setEnvelopeUnitPrice(string|null $envelope_unit_price) : $this
Parameters
$envelope_unit_price : string|null
Return values
$this

setExternalAccountId()

Sets external_account_id

public setExternalAccountId(string|null $external_account_id) : $this
Parameters
$external_account_id : string|null
Return values
$this

setForgottenPasswordQuestionsCount()

Sets forgotten_password_questions_count

public setForgottenPasswordQuestionsCount(string|null $forgotten_password_questions_count) : $this
Parameters
$forgotten_password_questions_count : string|null

A complex element that contains up to four Question/Answer pairs for forgotten password information for a user.

Return values
$this

setFreeEnvelopeSendsRemainingForAdvancedDocGen()

Sets free_envelope_sends_remaining_for_advanced_doc_gen

public setFreeEnvelopeSendsRemainingForAdvancedDocGen(int|null $free_envelope_sends_remaining_for_advanced_doc_gen) : $this
Parameters
$free_envelope_sends_remaining_for_advanced_doc_gen : int|null
Return values
$this

setIsDowngrade()

Sets is_downgrade

public setIsDowngrade(string|null $is_downgrade) : $this
Parameters
$is_downgrade : string|null
Return values
$this

setPaymentMethod()

Sets payment_method

public setPaymentMethod(string|null $payment_method) : $this
Parameters
$payment_method : string|null
Return values
$this

setPlanClassification()

Sets plan_classification

public setPlanClassification(string|null $plan_classification) : $this
Parameters
$plan_classification : string|null

Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free.

Return values
$this

setPlanEndDate()

Sets plan_end_date

public setPlanEndDate(string|null $plan_end_date) : $this
Parameters
$plan_end_date : string|null

The date that the current plan will end.

Return values
$this

setPlanName()

Sets plan_name

public setPlanName(string|null $plan_name) : $this
Parameters
$plan_name : string|null

The name of the Billing Plan.

Return values
$this

setPlanStartDate()

Sets plan_start_date

public setPlanStartDate(string|null $plan_start_date) : $this
Parameters
$plan_start_date : string|null

The date that the Account started using the current plan.

Return values
$this

setSeatsAllowed()

Sets seats_allowed

public setSeatsAllowed(string|null $seats_allowed) : $this
Parameters
$seats_allowed : string|null
Return values
$this

setSeatsInUse()

Sets seats_in_use

public setSeatsInUse(string|null $seats_in_use) : $this
Parameters
$seats_in_use : string|null
Return values
$this

setStatus21CfrPart11()

Sets status21_cfr_part11

public setStatus21CfrPart11(string|null $status21_cfr_part11) : $this
Parameters
$status21_cfr_part11 : string|null
Return values
$this

setSuspensionDate()

Sets suspension_date

public setSuspensionDate(string|null $suspension_date) : $this
Parameters
$suspension_date : string|null
Return values
$this

setSuspensionStatus()

Sets suspension_status

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

setUseDisplayAppliance()

Sets use_display_appliance

public setUseDisplayAppliance(bool|null $use_display_appliance) : $this
Parameters
$use_display_appliance : bool|null
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