Documentation

BillingPlanPreview
in package
implements ModelInterface, ArrayAccess

BillingPlanPreview Class Doc Comment

Tags
category

Class

description

Contains information about a preview billing plan.

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
getCurrencyCode()  : string|null
Gets currency_code
getInvoice()  : BillingInvoice
Gets invoice
getIsProrated()  : string|null
Gets is_prorated
getModelName()  : string
The original name of the model.
getSubtotalAmount()  : string|null
Gets subtotal_amount
getTaxAmount()  : string|null
Gets tax_amount
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTotalAmount()  : string|null
Gets total_amount
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.
setCurrencyCode()  : $this
Sets currency_code
setInvoice()  : $this
Sets invoice
setIsProrated()  : $this
Sets is_prorated
setSubtotalAmount()  : $this
Sets subtotal_amount
setTaxAmount()  : $this
Sets tax_amount
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTotalAmount()  : $this
Sets total_amount
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 = ['currency_code' => 'currencyCode', 'invoice' => 'invoice', 'is_prorated' => 'isProrated', 'subtotal_amount' => 'subtotalAmount', 'tax_amount' => 'taxAmount', 'total_amount' => 'totalAmount']

$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 = ['currency_code' => 'getCurrencyCode', 'invoice' => 'getInvoice', 'is_prorated' => 'getIsProrated', 'subtotal_amount' => 'getSubtotalAmount', 'tax_amount' => 'getTaxAmount', 'total_amount' => 'getTotalAmount']

$setters

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

protected static array<string|int, string> $setters = ['currency_code' => 'setCurrencyCode', 'invoice' => 'setInvoice', 'is_prorated' => 'setIsProrated', 'subtotal_amount' => 'setSubtotalAmount', 'tax_amount' => 'setTaxAmount', 'total_amount' => 'setTotalAmount']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['currency_code' => null, 'invoice' => null, 'is_prorated' => null, 'subtotal_amount' => null, 'tax_amount' => null, 'total_amount' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'billingPlanPreview'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['currency_code' => '?string', 'invoice' => '\\DocuSign\\eSign\\Model\\BillingInvoice', 'is_prorated' => '?string', 'subtotal_amount' => '?string', 'tax_amount' => '?string', 'total_amount' => '?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>

getCurrencyCode()

Gets currency_code

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

getIsProrated()

Gets is_prorated

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getSubtotalAmount()

Gets subtotal_amount

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

getTaxAmount()

Gets tax_amount

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

getTotalAmount()

Gets total_amount

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

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

setIsProrated()

Sets is_prorated

public setIsProrated(string|null $is_prorated) : $this
Parameters
$is_prorated : string|null
Return values
$this

setSubtotalAmount()

Sets subtotal_amount

public setSubtotalAmount(string|null $subtotal_amount) : $this
Parameters
$subtotal_amount : string|null
Return values
$this

setTaxAmount()

Sets tax_amount

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

setTotalAmount()

Sets total_amount

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

Search results