BillingPlan
in package
implements
ModelInterface, ArrayAccess
BillingPlan 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
- getAppStoreProducts() : array<string|int, AppStoreProduct>
- Gets app_store_products
- getCurrencyPlanPrices() : array<string|int, CurrencyPlanPrice>
- Gets currency_plan_prices
- getEnableSupport() : string|null
- Gets enable_support
- getIncludedSeats() : string|null
- Gets included_seats
- getModelName() : string
- The original name of the model.
- getOtherDiscountPercent() : string|null
- Gets other_discount_percent
- getPaymentCycle() : string|null
- Gets payment_cycle
- getPaymentMethod() : string|null
- Gets payment_method
- getPerSeatPrice() : string|null
- Gets per_seat_price
- getPlanClassification() : string|null
- Gets plan_classification
- getPlanFeatureSets() : array<string|int, FeatureSet>
- Gets plan_feature_sets
- getPlanId() : string|null
- Gets plan_id
- getPlanName() : string|null
- Gets plan_name
- getSeatDiscounts() : array<string|int, SeatDiscount>
- Gets seat_discounts
- getSupportIncidentFee() : string|null
- Gets support_incident_fee
- getSupportPlanFee() : string|null
- Gets support_plan_fee
- 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.
- setAppStoreProducts() : $this
- Sets app_store_products
- setCurrencyPlanPrices() : $this
- Sets currency_plan_prices
- setEnableSupport() : $this
- Sets enable_support
- setIncludedSeats() : $this
- Sets included_seats
- setOtherDiscountPercent() : $this
- Sets other_discount_percent
- setPaymentCycle() : $this
- Sets payment_cycle
- setPaymentMethod() : $this
- Sets payment_method
- setPerSeatPrice() : $this
- Sets per_seat_price
- setPlanClassification() : $this
- Sets plan_classification
- setPlanFeatureSets() : $this
- Sets plan_feature_sets
- setPlanId() : $this
- Sets plan_id
- setPlanName() : $this
- Sets plan_name
- setSeatDiscounts() : $this
- Sets seat_discounts
- setSupportIncidentFee() : $this
- Sets support_incident_fee
- setSupportPlanFee() : $this
- Sets support_plan_fee
- 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
= ['app_store_products' => 'appStoreProducts', 'currency_plan_prices' => 'currencyPlanPrices', 'enable_support' => 'enableSupport', 'included_seats' => 'includedSeats', 'other_discount_percent' => 'otherDiscountPercent', 'payment_cycle' => 'paymentCycle', 'payment_method' => 'paymentMethod', 'per_seat_price' => 'perSeatPrice', 'plan_classification' => 'planClassification', 'plan_feature_sets' => 'planFeatureSets', 'plan_id' => 'planId', 'plan_name' => 'planName', 'seat_discounts' => 'seatDiscounts', 'support_incident_fee' => 'supportIncidentFee', 'support_plan_fee' => 'supportPlanFee']
$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
= ['app_store_products' => 'getAppStoreProducts', 'currency_plan_prices' => 'getCurrencyPlanPrices', 'enable_support' => 'getEnableSupport', 'included_seats' => 'getIncludedSeats', 'other_discount_percent' => 'getOtherDiscountPercent', 'payment_cycle' => 'getPaymentCycle', 'payment_method' => 'getPaymentMethod', 'per_seat_price' => 'getPerSeatPrice', 'plan_classification' => 'getPlanClassification', 'plan_feature_sets' => 'getPlanFeatureSets', 'plan_id' => 'getPlanId', 'plan_name' => 'getPlanName', 'seat_discounts' => 'getSeatDiscounts', 'support_incident_fee' => 'getSupportIncidentFee', 'support_plan_fee' => 'getSupportPlanFee']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['app_store_products' => 'setAppStoreProducts', 'currency_plan_prices' => 'setCurrencyPlanPrices', 'enable_support' => 'setEnableSupport', 'included_seats' => 'setIncludedSeats', 'other_discount_percent' => 'setOtherDiscountPercent', 'payment_cycle' => 'setPaymentCycle', 'payment_method' => 'setPaymentMethod', 'per_seat_price' => 'setPerSeatPrice', 'plan_classification' => 'setPlanClassification', 'plan_feature_sets' => 'setPlanFeatureSets', 'plan_id' => 'setPlanId', 'plan_name' => 'setPlanName', 'seat_discounts' => 'setSeatDiscounts', 'support_incident_fee' => 'setSupportIncidentFee', 'support_plan_fee' => 'setSupportPlanFee']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['app_store_products' => null, 'currency_plan_prices' => null, 'enable_support' => null, 'included_seats' => null, 'other_discount_percent' => null, 'payment_cycle' => null, 'payment_method' => null, 'per_seat_price' => null, 'plan_classification' => null, 'plan_feature_sets' => null, 'plan_id' => null, 'plan_name' => null, 'seat_discounts' => null, 'support_incident_fee' => null, 'support_plan_fee' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'billingPlan'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['app_store_products' => '\\DocuSign\\eSign\\Model\\AppStoreProduct[]', 'currency_plan_prices' => '\\DocuSign\\eSign\\Model\\CurrencyPlanPrice[]', 'enable_support' => '?string', 'included_seats' => '?string', 'other_discount_percent' => '?string', 'payment_cycle' => '?string', 'payment_method' => '?string', 'per_seat_price' => '?string', 'plan_classification' => '?string', 'plan_feature_sets' => '\\DocuSign\\eSign\\Model\\FeatureSet[]', 'plan_id' => '?string', 'plan_name' => '?string', 'seat_discounts' => '\\DocuSign\\eSign\\Model\\SeatDiscount[]', 'support_incident_fee' => '?string', 'support_plan_fee' => '?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> —getAppStoreProducts()
Gets app_store_products
public
getAppStoreProducts() : array<string|int, AppStoreProduct>
Return values
array<string|int, AppStoreProduct> —getCurrencyPlanPrices()
Gets currency_plan_prices
public
getCurrencyPlanPrices() : array<string|int, CurrencyPlanPrice>
Return values
array<string|int, CurrencyPlanPrice> —getEnableSupport()
Gets enable_support
public
getEnableSupport() : string|null
Return values
string|null —getIncludedSeats()
Gets included_seats
public
getIncludedSeats() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getOtherDiscountPercent()
Gets other_discount_percent
public
getOtherDiscountPercent() : string|null
Return values
string|null —getPaymentCycle()
Gets payment_cycle
public
getPaymentCycle() : string|null
Return values
string|null —getPaymentMethod()
Gets payment_method
public
getPaymentMethod() : string|null
Return values
string|null —getPerSeatPrice()
Gets per_seat_price
public
getPerSeatPrice() : string|null
Return values
string|null —getPlanClassification()
Gets plan_classification
public
getPlanClassification() : string|null
Return values
string|null —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 —getPlanName()
Gets plan_name
public
getPlanName() : string|null
Return values
string|null —getSeatDiscounts()
Gets seat_discounts
public
getSeatDiscounts() : array<string|int, SeatDiscount>
Return values
array<string|int, SeatDiscount> —getSupportIncidentFee()
Gets support_incident_fee
public
getSupportIncidentFee() : string|null
Return values
string|null —getSupportPlanFee()
Gets support_plan_fee
public
getSupportPlanFee() : 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 —setAppStoreProducts()
Sets app_store_products
public
setAppStoreProducts(array<string|int, AppStoreProduct> $app_store_products) : $this
Parameters
- $app_store_products : array<string|int, AppStoreProduct>
-
Reserved: TBD
Return values
$this —setCurrencyPlanPrices()
Sets currency_plan_prices
public
setCurrencyPlanPrices(array<string|int, CurrencyPlanPrice> $currency_plan_prices) : $this
Parameters
- $currency_plan_prices : array<string|int, CurrencyPlanPrice>
-
Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, and seatFee that are configured for this plan feature set.
Return values
$this —setEnableSupport()
Sets enable_support
public
setEnableSupport(string|null $enable_support) : $this
Parameters
- $enable_support : string|null
-
When set to true, then customer support is provided as part of the account plan.
Return values
$this —setIncludedSeats()
Sets included_seats
public
setIncludedSeats(string|null $included_seats) : $this
Parameters
- $included_seats : string|null
-
The number of seats (users) included.
Return values
$this —setOtherDiscountPercent()
Sets other_discount_percent
public
setOtherDiscountPercent(string|null $other_discount_percent) : $this
Parameters
- $other_discount_percent : string|null
Return values
$this —setPaymentCycle()
Sets payment_cycle
public
setPaymentCycle(string|null $payment_cycle) : $this
Parameters
- $payment_cycle : string|null
-
The payment cycle associated with the plan. The possible values are: Monthly or Annually.
Return values
$this —setPaymentMethod()
Sets payment_method
public
setPaymentMethod(string|null $payment_method) : $this
Parameters
- $payment_method : string|null
Return values
$this —setPerSeatPrice()
Sets per_seat_price
public
setPerSeatPrice(string|null $per_seat_price) : $this
Parameters
- $per_seat_price : string|null
-
The per seat price for the plan.
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 —setPlanFeatureSets()
Sets plan_feature_sets
public
setPlanFeatureSets(array<string|int, FeatureSet> $plan_feature_sets) : $this
Parameters
- $plan_feature_sets : array<string|int, FeatureSet>
Return values
$this —setPlanId()
Sets plan_id
public
setPlanId(string|null $plan_id) : $this
Parameters
- $plan_id : string|null
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 —setSeatDiscounts()
Sets seat_discounts
public
setSeatDiscounts(array<string|int, SeatDiscount> $seat_discounts) : $this
Parameters
- $seat_discounts : array<string|int, SeatDiscount>
Return values
$this —setSupportIncidentFee()
Sets support_incident_fee
public
setSupportIncidentFee(string|null $support_incident_fee) : $this
Parameters
- $support_incident_fee : string|null
-
The support incident fee charged for each support incident.
Return values
$this —setSupportPlanFee()
Sets support_plan_fee
public
setSupportPlanFee(string|null $support_plan_fee) : $this
Parameters
- $support_plan_fee : string|null
-
The support plan fee charged for this plan.
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