BillingCharge
in package
implements
ModelInterface, ArrayAccess
BillingCharge 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
- getAllowedQuantity() : string|null
- Gets allowed_quantity
- getBlocked() : string|null
- Gets blocked
- getChargeName() : string|null
- Gets charge_name
- getChargeType() : string|null
- Gets charge_type
- getChargeUnitOfMeasure() : string|null
- Gets charge_unit_of_measure
- getDiscounts() : array<string|int, BillingDiscount>
- Gets discounts
- getFirstEffectiveDate() : string|null
- Gets first_effective_date
- getIncludedQuantity() : string|null
- Gets included_quantity
- getIncrementalQuantity() : string|null
- Gets incremental_quantity
- getLastEffectiveDate() : string|null
- Gets last_effective_date
- getModelName() : string
- The original name of the model.
- getPrices() : array<string|int, BillingPrice>
- Gets prices
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUnitPrice() : string|null
- Gets unit_price
- getUsedQuantity() : string|null
- Gets used_quantity
- 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.
- setAllowedQuantity() : $this
- Sets allowed_quantity
- setBlocked() : $this
- Sets blocked
- setChargeName() : $this
- Sets charge_name
- setChargeType() : $this
- Sets charge_type
- setChargeUnitOfMeasure() : $this
- Sets charge_unit_of_measure
- setDiscounts() : $this
- Sets discounts
- setFirstEffectiveDate() : $this
- Sets first_effective_date
- setIncludedQuantity() : $this
- Sets included_quantity
- setIncrementalQuantity() : $this
- Sets incremental_quantity
- setLastEffectiveDate() : $this
- Sets last_effective_date
- setPrices() : $this
- Sets prices
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUnitPrice() : $this
- Sets unit_price
- setUsedQuantity() : $this
- Sets used_quantity
- 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
= ['allowed_quantity' => 'allowedQuantity', 'blocked' => 'blocked', 'charge_name' => 'chargeName', 'charge_type' => 'chargeType', 'charge_unit_of_measure' => 'chargeUnitOfMeasure', 'discounts' => 'discounts', 'first_effective_date' => 'firstEffectiveDate', 'included_quantity' => 'includedQuantity', 'incremental_quantity' => 'incrementalQuantity', 'last_effective_date' => 'lastEffectiveDate', 'prices' => 'prices', 'unit_price' => 'unitPrice', 'used_quantity' => 'usedQuantity']
$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
= ['allowed_quantity' => 'getAllowedQuantity', 'blocked' => 'getBlocked', 'charge_name' => 'getChargeName', 'charge_type' => 'getChargeType', 'charge_unit_of_measure' => 'getChargeUnitOfMeasure', 'discounts' => 'getDiscounts', 'first_effective_date' => 'getFirstEffectiveDate', 'included_quantity' => 'getIncludedQuantity', 'incremental_quantity' => 'getIncrementalQuantity', 'last_effective_date' => 'getLastEffectiveDate', 'prices' => 'getPrices', 'unit_price' => 'getUnitPrice', 'used_quantity' => 'getUsedQuantity']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['allowed_quantity' => 'setAllowedQuantity', 'blocked' => 'setBlocked', 'charge_name' => 'setChargeName', 'charge_type' => 'setChargeType', 'charge_unit_of_measure' => 'setChargeUnitOfMeasure', 'discounts' => 'setDiscounts', 'first_effective_date' => 'setFirstEffectiveDate', 'included_quantity' => 'setIncludedQuantity', 'incremental_quantity' => 'setIncrementalQuantity', 'last_effective_date' => 'setLastEffectiveDate', 'prices' => 'setPrices', 'unit_price' => 'setUnitPrice', 'used_quantity' => 'setUsedQuantity']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['allowed_quantity' => null, 'blocked' => null, 'charge_name' => null, 'charge_type' => null, 'charge_unit_of_measure' => null, 'discounts' => null, 'first_effective_date' => null, 'included_quantity' => null, 'incremental_quantity' => null, 'last_effective_date' => null, 'prices' => null, 'unit_price' => null, 'used_quantity' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'billingCharge'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['allowed_quantity' => '?string', 'blocked' => '?string', 'charge_name' => '?string', 'charge_type' => '?string', 'charge_unit_of_measure' => '?string', 'discounts' => '\\DocuSign\\eSign\\Model\\BillingDiscount[]', 'first_effective_date' => '?string', 'included_quantity' => '?string', 'incremental_quantity' => '?string', 'last_effective_date' => '?string', 'prices' => '\\DocuSign\\eSign\\Model\\BillingPrice[]', 'unit_price' => '?string', 'used_quantity' => '?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> —getAllowedQuantity()
Gets allowed_quantity
public
getAllowedQuantity() : string|null
Return values
string|null —getBlocked()
Gets blocked
public
getBlocked() : string|null
Return values
string|null —getChargeName()
Gets charge_name
public
getChargeName() : string|null
Return values
string|null —getChargeType()
Gets charge_type
public
getChargeType() : string|null
Return values
string|null —getChargeUnitOfMeasure()
Gets charge_unit_of_measure
public
getChargeUnitOfMeasure() : string|null
Return values
string|null —getDiscounts()
Gets discounts
public
getDiscounts() : array<string|int, BillingDiscount>
Return values
array<string|int, BillingDiscount> —getFirstEffectiveDate()
Gets first_effective_date
public
getFirstEffectiveDate() : string|null
Return values
string|null —getIncludedQuantity()
Gets included_quantity
public
getIncludedQuantity() : string|null
Return values
string|null —getIncrementalQuantity()
Gets incremental_quantity
public
getIncrementalQuantity() : string|null
Return values
string|null —getLastEffectiveDate()
Gets last_effective_date
public
getLastEffectiveDate() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPrices()
Gets prices
public
getPrices() : array<string|int, BillingPrice>
Return values
array<string|int, BillingPrice> —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUnitPrice()
Gets unit_price
public
getUnitPrice() : string|null
Return values
string|null —getUsedQuantity()
Gets used_quantity
public
getUsedQuantity() : string|null
Return values
string|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 —setAllowedQuantity()
Sets allowed_quantity
public
setAllowedQuantity(string|null $allowed_quantity) : $this
Parameters
- $allowed_quantity : string|null
-
Reserved: TBD
Return values
$this —setBlocked()
Sets blocked
public
setBlocked(string|null $blocked) : $this
Parameters
- $blocked : string|null
-
Reserved: TBD
Return values
$this —setChargeName()
Sets charge_name
public
setChargeName(string|null $charge_name) : $this
Parameters
- $charge_name : string|null
-
Provides information on what services the charge item is for. The following table provides a description of the different chargeName values available at this time. | chargeName | Description | | --- | --- | | id_check | IDÂ Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge |
Return values
$this —setChargeType()
Sets charge_type
public
setChargeType(string|null $charge_type) : $this
Parameters
- $charge_type : string|null
-
Reserved: TBD
Return values
$this —setChargeUnitOfMeasure()
Sets charge_unit_of_measure
public
setChargeUnitOfMeasure(string|null $charge_unit_of_measure) : $this
Parameters
- $charge_unit_of_measure : string|null
-
Reserved: TBD
Return values
$this —setDiscounts()
Sets discounts
public
setDiscounts(array<string|int, BillingDiscount> $discounts) : $this
Parameters
- $discounts : array<string|int, BillingDiscount>
Return values
$this —setFirstEffectiveDate()
Sets first_effective_date
public
setFirstEffectiveDate(string|null $first_effective_date) : $this
Parameters
- $first_effective_date : string|null
Return values
$this —setIncludedQuantity()
Sets included_quantity
public
setIncludedQuantity(string|null $included_quantity) : $this
Parameters
- $included_quantity : string|null
Return values
$this —setIncrementalQuantity()
Sets incremental_quantity
public
setIncrementalQuantity(string|null $incremental_quantity) : $this
Parameters
- $incremental_quantity : string|null
-
Reserved: TBD
Return values
$this —setLastEffectiveDate()
Sets last_effective_date
public
setLastEffectiveDate(string|null $last_effective_date) : $this
Parameters
- $last_effective_date : string|null
Return values
$this —setPrices()
Sets prices
public
setPrices(array<string|int, BillingPrice> $prices) : $this
Parameters
- $prices : array<string|int, BillingPrice>
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> —setUnitPrice()
Sets unit_price
public
setUnitPrice(string|null $unit_price) : $this
Parameters
- $unit_price : string|null
-
Reserved: TBD
Return values
$this —setUsedQuantity()
Sets used_quantity
public
setUsedQuantity(string|null $used_quantity) : $this
Parameters
- $used_quantity : string|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