Documentation

BillingPlanUpdateResponse
in package
implements ModelInterface, ArrayAccess

BillingPlanUpdateResponse Class Doc Comment

Tags
category

Class

description

Defines a billing plan update response object.

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
getAccountPaymentMethod()  : string|null
Gets account_payment_method
getBillingPlanPreview()  : BillingPlanPreview
Gets billing_plan_preview
getCurrencyCode()  : string|null
Gets currency_code
getIncludedSeats()  : string|null
Gets included_seats
getModelName()  : string
The original name of the model.
getPaymentCycle()  : string|null
Gets payment_cycle
getPaymentMethod()  : string|null
Gets payment_method
getPlanId()  : string|null
Gets plan_id
getPlanName()  : string|null
Gets plan_name
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.
setAccountPaymentMethod()  : $this
Sets account_payment_method
setBillingPlanPreview()  : $this
Sets billing_plan_preview
setCurrencyCode()  : $this
Sets currency_code
setIncludedSeats()  : $this
Sets included_seats
setPaymentCycle()  : $this
Sets payment_cycle
setPaymentMethod()  : $this
Sets payment_method
setPlanId()  : $this
Sets plan_id
setPlanName()  : $this
Sets plan_name
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_payment_method' => 'accountPaymentMethod', 'billing_plan_preview' => 'billingPlanPreview', 'currency_code' => 'currencyCode', 'included_seats' => 'includedSeats', 'payment_cycle' => 'paymentCycle', 'payment_method' => 'paymentMethod', 'plan_id' => 'planId', 'plan_name' => 'planName']

$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_payment_method' => 'getAccountPaymentMethod', 'billing_plan_preview' => 'getBillingPlanPreview', 'currency_code' => 'getCurrencyCode', 'included_seats' => 'getIncludedSeats', 'payment_cycle' => 'getPaymentCycle', 'payment_method' => 'getPaymentMethod', 'plan_id' => 'getPlanId', 'plan_name' => 'getPlanName']

$setters

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

protected static array<string|int, string> $setters = ['account_payment_method' => 'setAccountPaymentMethod', 'billing_plan_preview' => 'setBillingPlanPreview', 'currency_code' => 'setCurrencyCode', 'included_seats' => 'setIncludedSeats', 'payment_cycle' => 'setPaymentCycle', 'payment_method' => 'setPaymentMethod', 'plan_id' => 'setPlanId', 'plan_name' => 'setPlanName']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['account_payment_method' => null, 'billing_plan_preview' => null, 'currency_code' => null, 'included_seats' => null, 'payment_cycle' => null, 'payment_method' => null, 'plan_id' => null, 'plan_name' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'billingPlanUpdateResponse'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['account_payment_method' => '?string', 'billing_plan_preview' => '\\DocuSign\\eSign\\Model\\BillingPlanPreview', 'currency_code' => '?string', 'included_seats' => '?string', 'payment_cycle' => '?string', 'payment_method' => '?string', 'plan_id' => '?string', 'plan_name' => '?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>

getAccountPaymentMethod()

Gets account_payment_method

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

getIncludedSeats()

Gets included_seats

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

getPaymentMethod()

Gets payment_method

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

setAccountPaymentMethod()

Sets account_payment_method

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

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

setPaymentCycle()

Sets payment_cycle

public setPaymentCycle(string|null $payment_cycle) : $this
Parameters
$payment_cycle : string|null
Return values
$this

setPaymentMethod()

Sets payment_method

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