Documentation

DowngradePlanUpdateResponse
in package
implements ModelInterface, ArrayAccess

DowngradePlanUpdateResponse Class Doc Comment

Tags
category

Class

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
getDiscountApplied()  : string|null
Gets discount_applied
getDowngradeEffectiveDate()  : string|null
Gets downgrade_effective_date
getDowngradePaymentCycle()  : string|null
Gets downgrade_payment_cycle
getDowngradePlanId()  : string|null
Gets downgrade_plan_id
getDowngradePlanName()  : string|null
Gets downgrade_plan_name
getDowngradeRequestStatus()  : string|null
Gets downgrade_request_status
getMessage()  : string|null
Gets message
getModelName()  : string
The original name of the model.
getProductId()  : string|null
Gets product_id
getPromoCode()  : string|null
Gets promo_code
getSaleDiscount()  : string|null
Gets sale_discount
getSaleDiscountPeriods()  : string|null
Gets sale_discount_periods
getSaleDiscountType()  : string|null
Gets sale_discount_type
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
setDiscountApplied()  : $this
Sets discount_applied
setDowngradeEffectiveDate()  : $this
Sets downgrade_effective_date
setDowngradePaymentCycle()  : $this
Sets downgrade_payment_cycle
setDowngradePlanId()  : $this
Sets downgrade_plan_id
setDowngradePlanName()  : $this
Sets downgrade_plan_name
setDowngradeRequestStatus()  : $this
Sets downgrade_request_status
setMessage()  : $this
Sets message
setProductId()  : $this
Sets product_id
setPromoCode()  : $this
Sets promo_code
setSaleDiscount()  : $this
Sets sale_discount
setSaleDiscountPeriods()  : $this
Sets sale_discount_periods
setSaleDiscountType()  : $this
Sets sale_discount_type
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', 'discount_applied' => 'discountApplied', 'downgrade_effective_date' => 'downgradeEffectiveDate', 'downgrade_payment_cycle' => 'downgradePaymentCycle', 'downgrade_plan_id' => 'downgradePlanId', 'downgrade_plan_name' => 'downgradePlanName', 'downgrade_request_status' => 'downgradeRequestStatus', 'message' => 'message', 'product_id' => 'productId', 'promo_code' => 'promoCode', 'sale_discount' => 'saleDiscount', 'sale_discount_periods' => 'saleDiscountPeriods', 'sale_discount_type' => 'saleDiscountType']

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['account_payment_method' => 'getAccountPaymentMethod', 'discount_applied' => 'getDiscountApplied', 'downgrade_effective_date' => 'getDowngradeEffectiveDate', 'downgrade_payment_cycle' => 'getDowngradePaymentCycle', 'downgrade_plan_id' => 'getDowngradePlanId', 'downgrade_plan_name' => 'getDowngradePlanName', 'downgrade_request_status' => 'getDowngradeRequestStatus', 'message' => 'getMessage', 'product_id' => 'getProductId', 'promo_code' => 'getPromoCode', 'sale_discount' => 'getSaleDiscount', 'sale_discount_periods' => 'getSaleDiscountPeriods', 'sale_discount_type' => 'getSaleDiscountType']

$setters

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

protected static array<string|int, string> $setters = ['account_payment_method' => 'setAccountPaymentMethod', 'discount_applied' => 'setDiscountApplied', 'downgrade_effective_date' => 'setDowngradeEffectiveDate', 'downgrade_payment_cycle' => 'setDowngradePaymentCycle', 'downgrade_plan_id' => 'setDowngradePlanId', 'downgrade_plan_name' => 'setDowngradePlanName', 'downgrade_request_status' => 'setDowngradeRequestStatus', 'message' => 'setMessage', 'product_id' => 'setProductId', 'promo_code' => 'setPromoCode', 'sale_discount' => 'setSaleDiscount', 'sale_discount_periods' => 'setSaleDiscountPeriods', 'sale_discount_type' => 'setSaleDiscountType']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['account_payment_method' => null, 'discount_applied' => null, 'downgrade_effective_date' => null, 'downgrade_payment_cycle' => null, 'downgrade_plan_id' => null, 'downgrade_plan_name' => null, 'downgrade_request_status' => null, 'message' => null, 'product_id' => null, 'promo_code' => null, 'sale_discount' => null, 'sale_discount_periods' => null, 'sale_discount_type' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'downgradePlanUpdateResponse'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['account_payment_method' => '?string', 'discount_applied' => '?string', 'downgrade_effective_date' => '?string', 'downgrade_payment_cycle' => '?string', 'downgrade_plan_id' => '?string', 'downgrade_plan_name' => '?string', 'downgrade_request_status' => '?string', 'message' => '?string', 'product_id' => '?string', 'promo_code' => '?string', 'sale_discount' => '?string', 'sale_discount_periods' => '?string', 'sale_discount_type' => '?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

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

getDowngradeEffectiveDate()

Gets downgrade_effective_date

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

getDowngradePaymentCycle()

Gets downgrade_payment_cycle

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

getDowngradePlanId()

Gets downgrade_plan_id

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

getDowngradePlanName()

Gets downgrade_plan_name

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

getDowngradeRequestStatus()

Gets downgrade_request_status

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

getSaleDiscountPeriods()

Gets sale_discount_periods

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

getSaleDiscountType()

Gets sale_discount_type

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

setDiscountApplied()

Sets discount_applied

public setDiscountApplied(string|null $discount_applied) : $this
Parameters
$discount_applied : string|null
Return values
$this

setDowngradeEffectiveDate()

Sets downgrade_effective_date

public setDowngradeEffectiveDate(string|null $downgrade_effective_date) : $this
Parameters
$downgrade_effective_date : string|null
Return values
$this

setDowngradePaymentCycle()

Sets downgrade_payment_cycle

public setDowngradePaymentCycle(string|null $downgrade_payment_cycle) : $this
Parameters
$downgrade_payment_cycle : string|null
Return values
$this

setDowngradePlanId()

Sets downgrade_plan_id

public setDowngradePlanId(string|null $downgrade_plan_id) : $this
Parameters
$downgrade_plan_id : string|null
Return values
$this

setDowngradePlanName()

Sets downgrade_plan_name

public setDowngradePlanName(string|null $downgrade_plan_name) : $this
Parameters
$downgrade_plan_name : string|null
Return values
$this

setDowngradeRequestStatus()

Sets downgrade_request_status

public setDowngradeRequestStatus(string|null $downgrade_request_status) : $this
Parameters
$downgrade_request_status : string|null
Return values
$this

setMessage()

Sets message

public setMessage(string|null $message) : $this
Parameters
$message : string|null
Return values
$this

setProductId()

Sets product_id

public setProductId(string|null $product_id) : $this
Parameters
$product_id : string|null
Return values
$this

setPromoCode()

Sets promo_code

public setPromoCode(string|null $promo_code) : $this
Parameters
$promo_code : string|null
Return values
$this

setSaleDiscount()

Sets sale_discount

public setSaleDiscount(string|null $sale_discount) : $this
Parameters
$sale_discount : string|null
Return values
$this

setSaleDiscountPeriods()

Sets sale_discount_periods

public setSaleDiscountPeriods(string|null $sale_discount_periods) : $this
Parameters
$sale_discount_periods : string|null
Return values
$this

setSaleDiscountType()

Sets sale_discount_type

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