Documentation

NewAccountDefinition
in package
implements ModelInterface, ArrayAccess

NewAccountDefinition Class Doc Comment

Tags
category

Class

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
getAccountName()  : string|null
Gets account_name
getAccountSettings()  : AccountSettingsInformation
Gets account_settings
getAddressInformation()  : AccountAddress
Gets address_information
getCreditCardInformation()  : CreditCardInformation
Gets credit_card_information
getDirectDebitProcessorInformation()  : DirectDebitProcessorInformation
Gets direct_debit_processor_information
getDistributorCode()  : string|null
Gets distributor_code
getDistributorPassword()  : string|null
Gets distributor_password
getEnablePreAuth()  : string|null
Gets enable_pre_auth
getEnvelopePartitionId()  : string|null
Gets envelope_partition_id
getInitialUser()  : UserInformation
Gets initial_user
getModelName()  : string
The original name of the model.
getPaymentMethod()  : string|null
Gets payment_method
getPaymentProcessor()  : string|null
Gets payment_processor
getPaymentProcessorInformation()  : PaymentProcessorInformation
Gets payment_processor_information
getPlanInformation()  : PlanInformation
Gets plan_information
getProcessPayment()  : string|null
Gets process_payment
getReferralInformation()  : ReferralInformation
Gets referral_information
getSocialAccountInformation()  : SocialAccountInformation
Gets social_account_information
getTaxExemptId()  : string|null
Gets tax_exempt_id
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.
setAccountName()  : $this
Sets account_name
setAccountSettings()  : $this
Sets account_settings
setAddressInformation()  : $this
Sets address_information
setCreditCardInformation()  : $this
Sets credit_card_information
setDirectDebitProcessorInformation()  : $this
Sets direct_debit_processor_information
setDistributorCode()  : $this
Sets distributor_code
setDistributorPassword()  : $this
Sets distributor_password
setEnablePreAuth()  : $this
Sets enable_pre_auth
setEnvelopePartitionId()  : $this
Sets envelope_partition_id
setInitialUser()  : $this
Sets initial_user
setPaymentMethod()  : $this
Sets payment_method
setPaymentProcessor()  : $this
Sets payment_processor
setPaymentProcessorInformation()  : $this
Sets payment_processor_information
setPlanInformation()  : $this
Sets plan_information
setProcessPayment()  : $this
Sets process_payment
setReferralInformation()  : $this
Sets referral_information
setSocialAccountInformation()  : $this
Sets social_account_information
setTaxExemptId()  : $this
Sets tax_exempt_id
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 = ['account_name' => 'accountName', 'account_settings' => 'accountSettings', 'address_information' => 'addressInformation', 'credit_card_information' => 'creditCardInformation', 'direct_debit_processor_information' => 'directDebitProcessorInformation', 'distributor_code' => 'distributorCode', 'distributor_password' => 'distributorPassword', 'enable_pre_auth' => 'enablePreAuth', 'envelope_partition_id' => 'envelopePartitionId', 'initial_user' => 'initialUser', 'payment_method' => 'paymentMethod', 'payment_processor' => 'paymentProcessor', 'payment_processor_information' => 'paymentProcessorInformation', 'plan_information' => 'planInformation', 'process_payment' => 'processPayment', 'referral_information' => 'referralInformation', 'social_account_information' => 'socialAccountInformation', 'tax_exempt_id' => 'taxExemptId']

$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_name' => 'getAccountName', 'account_settings' => 'getAccountSettings', 'address_information' => 'getAddressInformation', 'credit_card_information' => 'getCreditCardInformation', 'direct_debit_processor_information' => 'getDirectDebitProcessorInformation', 'distributor_code' => 'getDistributorCode', 'distributor_password' => 'getDistributorPassword', 'enable_pre_auth' => 'getEnablePreAuth', 'envelope_partition_id' => 'getEnvelopePartitionId', 'initial_user' => 'getInitialUser', 'payment_method' => 'getPaymentMethod', 'payment_processor' => 'getPaymentProcessor', 'payment_processor_information' => 'getPaymentProcessorInformation', 'plan_information' => 'getPlanInformation', 'process_payment' => 'getProcessPayment', 'referral_information' => 'getReferralInformation', 'social_account_information' => 'getSocialAccountInformation', 'tax_exempt_id' => 'getTaxExemptId']

$setters

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

protected static array<string|int, string> $setters = ['account_name' => 'setAccountName', 'account_settings' => 'setAccountSettings', 'address_information' => 'setAddressInformation', 'credit_card_information' => 'setCreditCardInformation', 'direct_debit_processor_information' => 'setDirectDebitProcessorInformation', 'distributor_code' => 'setDistributorCode', 'distributor_password' => 'setDistributorPassword', 'enable_pre_auth' => 'setEnablePreAuth', 'envelope_partition_id' => 'setEnvelopePartitionId', 'initial_user' => 'setInitialUser', 'payment_method' => 'setPaymentMethod', 'payment_processor' => 'setPaymentProcessor', 'payment_processor_information' => 'setPaymentProcessorInformation', 'plan_information' => 'setPlanInformation', 'process_payment' => 'setProcessPayment', 'referral_information' => 'setReferralInformation', 'social_account_information' => 'setSocialAccountInformation', 'tax_exempt_id' => 'setTaxExemptId']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['account_name' => null, 'account_settings' => null, 'address_information' => null, 'credit_card_information' => null, 'direct_debit_processor_information' => null, 'distributor_code' => null, 'distributor_password' => null, 'enable_pre_auth' => null, 'envelope_partition_id' => null, 'initial_user' => null, 'payment_method' => null, 'payment_processor' => null, 'payment_processor_information' => null, 'plan_information' => null, 'process_payment' => null, 'referral_information' => null, 'social_account_information' => null, 'tax_exempt_id' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'newAccountDefinition'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['account_name' => '?string', 'account_settings' => '\\DocuSign\\eSign\\Model\\AccountSettingsInformation', 'address_information' => '\\DocuSign\\eSign\\Model\\AccountAddress', 'credit_card_information' => '\\DocuSign\\eSign\\Model\\CreditCardInformation', 'direct_debit_processor_information' => '\\DocuSign\\eSign\\Model\\DirectDebitProcessorInformation', 'distributor_code' => '?string', 'distributor_password' => '?string', 'enable_pre_auth' => '?string', 'envelope_partition_id' => '?string', 'initial_user' => '\\DocuSign\\eSign\\Model\\UserInformation', 'payment_method' => '?string', 'payment_processor' => '?string', 'payment_processor_information' => '\\DocuSign\\eSign\\Model\\PaymentProcessorInformation', 'plan_information' => '\\DocuSign\\eSign\\Model\\PlanInformation', 'process_payment' => '?string', 'referral_information' => '\\DocuSign\\eSign\\Model\\ReferralInformation', 'social_account_information' => '\\DocuSign\\eSign\\Model\\SocialAccountInformation', 'tax_exempt_id' => '?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> —

getAccountName()

Gets account_name

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

getDistributorCode()

Gets distributor_code

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

getDistributorPassword()

Gets distributor_password

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

getEnablePreAuth()

Gets enable_pre_auth

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

getEnvelopePartitionId()

Gets envelope_partition_id

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

getPaymentProcessor()

Gets payment_processor

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

getProcessPayment()

Gets process_payment

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

getTaxExemptId()

Gets tax_exempt_id

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

setAccountName()

Sets account_name

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

The account name for the new 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 —

setAddressInformation()

Sets address_information

public setAddressInformation(AccountAddress $address_information) : $this
Parameters
$address_information : AccountAddress

A complex type that contains the following information for the new account: Street1, Street2, City, State, Zip, Phone, and Fax.

Return values
$this —

setCreditCardInformation()

Sets credit_card_information

public setCreditCardInformation(CreditCardInformation $credit_card_information) : $this
Parameters
$credit_card_information : CreditCardInformation

A complex type that has information about the credit card used to pay for this account.

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 —

setDistributorPassword()

Sets distributor_password

public setDistributorPassword(string|null $distributor_password) : $this
Parameters
$distributor_password : string|null

The password for the distributorCode.

Return values
$this —

setEnablePreAuth()

Sets enable_pre_auth

public setEnablePreAuth(string|null $enable_pre_auth) : $this
Parameters
$enable_pre_auth : string|null
Return values
$this —

setEnvelopePartitionId()

Sets envelope_partition_id

public setEnvelopePartitionId(string|null $envelope_partition_id) : $this
Parameters
$envelope_partition_id : string|null
Return values
$this —

setInitialUser()

Sets initial_user

public setInitialUser(UserInformation $initial_user) : $this
Parameters
$initial_user : UserInformation

A complex type with the initial user information for the new account. Note that some user information is set internally based on the plan and cannot be overridden.

Return values
$this —

setPaymentMethod()

Sets payment_method

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

setPaymentProcessor()

Sets payment_processor

public setPaymentProcessor(string|null $payment_processor) : $this
Parameters
$payment_processor : string|null
Return values
$this —

setPlanInformation()

Sets plan_information

public setPlanInformation(PlanInformation $plan_information) : $this
Parameters
$plan_information : PlanInformation

An object used to identify the features and attributes of the account being created.

Return values
$this —

setProcessPayment()

Sets process_payment

public setProcessPayment(string|null $process_payment) : $this
Parameters
$process_payment : string|null
Return values
$this —

setReferralInformation()

Sets referral_information

public setReferralInformation(ReferralInformation $referral_information) : $this
Parameters
$referral_information : ReferralInformation

A complex type that contains properties for entering referral and discount information.

Return values
$this —

setSocialAccountInformation()

Sets social_account_information

public setSocialAccountInformation(SocialAccountInformation $social_account_information) : $this
Parameters
$social_account_information : SocialAccountInformation

Contains properties that map a DocuSign user to a social account (Facebook, Yahoo, etc.)

Return values
$this —

setTaxExemptId()

Sets tax_exempt_id

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