PlanInformation
in package
implements
ModelInterface, ArrayAccess
PlanInformation 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
- getAddOns() : array<string|int, AddOn>
- Gets add_ons
- getCurrencyCode() : string|null
- Gets currency_code
- getFreeTrialDaysOverride() : string|null
- Gets free_trial_days_override
- getModelName() : string
- The original name of the model.
- getPlanFeatureSets() : array<string|int, FeatureSet>
- Gets plan_feature_sets
- getPlanId() : string|null
- Gets plan_id
- getRecipientDomains() : array<string|int, RecipientDomain>
- Gets recipient_domains
- 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.
- setAddOns() : $this
- Sets add_ons
- setCurrencyCode() : $this
- Sets currency_code
- setFreeTrialDaysOverride() : $this
- Sets free_trial_days_override
- setPlanFeatureSets() : $this
- Sets plan_feature_sets
- setPlanId() : $this
- Sets plan_id
- setRecipientDomains() : $this
- Sets recipient_domains
- 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
= ['add_ons' => 'addOns', 'currency_code' => 'currencyCode', 'free_trial_days_override' => 'freeTrialDaysOverride', 'plan_feature_sets' => 'planFeatureSets', 'plan_id' => 'planId', 'recipient_domains' => 'recipientDomains']
$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
= ['add_ons' => 'getAddOns', 'currency_code' => 'getCurrencyCode', 'free_trial_days_override' => 'getFreeTrialDaysOverride', 'plan_feature_sets' => 'getPlanFeatureSets', 'plan_id' => 'getPlanId', 'recipient_domains' => 'getRecipientDomains']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['add_ons' => 'setAddOns', 'currency_code' => 'setCurrencyCode', 'free_trial_days_override' => 'setFreeTrialDaysOverride', 'plan_feature_sets' => 'setPlanFeatureSets', 'plan_id' => 'setPlanId', 'recipient_domains' => 'setRecipientDomains']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['add_ons' => null, 'currency_code' => null, 'free_trial_days_override' => null, 'plan_feature_sets' => null, 'plan_id' => null, 'recipient_domains' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'planInformation'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['add_ons' => '\\DocuSign\\eSign\\Model\\AddOn[]', 'currency_code' => '?string', 'free_trial_days_override' => '?string', 'plan_feature_sets' => '\\DocuSign\\eSign\\Model\\FeatureSet[]', 'plan_id' => '?string', 'recipient_domains' => '\\DocuSign\\eSign\\Model\\RecipientDomain[]']
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> —getAddOns()
Gets add_ons
public
getAddOns() : array<string|int, AddOn>
Return values
array<string|int, AddOn> —getCurrencyCode()
Gets currency_code
public
getCurrencyCode() : string|null
Return values
string|null —getFreeTrialDaysOverride()
Gets free_trial_days_override
public
getFreeTrialDaysOverride() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPlanFeatureSets()
Gets plan_feature_sets
public
getPlanFeatureSets() : array<string|int, FeatureSet>
Return values
array<string|int, FeatureSet> —getPlanId()
Gets plan_id
public
getPlanId() : string|null
Return values
string|null —getRecipientDomains()
Gets recipient_domains
public
getRecipientDomains() : array<string|int, RecipientDomain>
Return values
array<string|int, RecipientDomain> —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 —setAddOns()
Sets add_ons
public
setAddOns(array<string|int, AddOn> $add_ons) : $this
Parameters
- $add_ons : array<string|int, AddOn>
-
Reserved:
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 —setFreeTrialDaysOverride()
Sets free_trial_days_override
public
setFreeTrialDaysOverride(string|null $free_trial_days_override) : $this
Parameters
- $free_trial_days_override : string|null
-
Reserved for DocuSign use only.
Return values
$this —setPlanFeatureSets()
Sets plan_feature_sets
public
setPlanFeatureSets(array<string|int, FeatureSet> $plan_feature_sets) : $this
Parameters
- $plan_feature_sets : array<string|int, FeatureSet>
-
A complex type that sets the feature sets for the account.
Return values
$this —setPlanId()
Sets plan_id
public
setPlanId(string|null $plan_id) : $this
Parameters
- $plan_id : string|null
-
The DocuSign Plan ID for the account.
Return values
$this —setRecipientDomains()
Sets recipient_domains
public
setRecipientDomains(array<string|int, RecipientDomain> $recipient_domains) : $this
Parameters
- $recipient_domains : array<string|int, RecipientDomain>
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