Documentation

PurchasedEnvelopesInformation
in package
implements ModelInterface, ArrayAccess

PurchasedEnvelopesInformation 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
getAmount()  : string|null
Gets amount
getAppName()  : string|null
Gets app_name
getCurrencyCode()  : string|null
Gets currency_code
getModelName()  : string
The original name of the model.
getPlatform()  : string|null
Gets platform
getProductId()  : string|null
Gets product_id
getQuantity()  : string|null
Gets quantity
getReceiptData()  : string|null
Gets receipt_data
getStoreName()  : string|null
Gets store_name
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTransactionId()  : string|null
Gets transaction_id
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.
setAmount()  : $this
Sets amount
setAppName()  : $this
Sets app_name
setCurrencyCode()  : $this
Sets currency_code
setPlatform()  : $this
Sets platform
setProductId()  : $this
Sets product_id
setQuantity()  : $this
Sets quantity
setReceiptData()  : $this
Sets receipt_data
setStoreName()  : $this
Sets store_name
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTransactionId()  : $this
Sets transaction_id
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 = ['amount' => 'amount', 'app_name' => 'appName', 'currency_code' => 'currencyCode', 'platform' => 'platform', 'product_id' => 'productId', 'quantity' => 'quantity', 'receipt_data' => 'receiptData', 'store_name' => 'storeName', 'transaction_id' => 'transactionId']

$getters

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

protected static array<string|int, string> $getters = ['amount' => 'getAmount', 'app_name' => 'getAppName', 'currency_code' => 'getCurrencyCode', 'platform' => 'getPlatform', 'product_id' => 'getProductId', 'quantity' => 'getQuantity', 'receipt_data' => 'getReceiptData', 'store_name' => 'getStoreName', 'transaction_id' => 'getTransactionId']

$setters

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

protected static array<string|int, string> $setters = ['amount' => 'setAmount', 'app_name' => 'setAppName', 'currency_code' => 'setCurrencyCode', 'platform' => 'setPlatform', 'product_id' => 'setProductId', 'quantity' => 'setQuantity', 'receipt_data' => 'setReceiptData', 'store_name' => 'setStoreName', 'transaction_id' => 'setTransactionId']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['amount' => null, 'app_name' => null, 'currency_code' => null, 'platform' => null, 'product_id' => null, 'quantity' => null, 'receipt_data' => null, 'store_name' => null, 'transaction_id' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'purchasedEnvelopesInformation'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['amount' => '?string', 'app_name' => '?string', 'currency_code' => '?string', 'platform' => '?string', 'product_id' => '?string', 'quantity' => '?string', 'receipt_data' => '?string', 'store_name' => '?string', 'transaction_id' => '?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> —

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 —

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 —

setAmount()

Sets amount

public setAmount(string|null $amount) : $this
Parameters
$amount : string|null

The total amount of the purchase.

Return values
$this —

setAppName()

Sets app_name

public setAppName(string|null $app_name) : $this
Parameters
$app_name : string|null

The AppName of the client application.

Return values
$this —

setCurrencyCode()

Sets currency_code

public setCurrencyCode(string|null $currency_code) : $this
Parameters
$currency_code : string|null

Specifies the ISO currency code of the purchase. This is based on the ISO 4217 currency code information.

Return values
$this —

setPlatform()

Sets platform

public setPlatform(string|null $platform) : $this
Parameters
$platform : string|null

The Platform of the client application

Return values
$this —

setProductId()

Sets product_id

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

The Product ID from the AppStore.

Return values
$this —

setQuantity()

Sets quantity

public setQuantity(string|null $quantity) : $this
Parameters
$quantity : string|null

The quantity of envelopes to add to the account.

Return values
$this —

setReceiptData()

Sets receipt_data

public setReceiptData(string|null $receipt_data) : $this
Parameters
$receipt_data : string|null

The encrypted Base64 encoded receipt data.

Return values
$this —

setStoreName()

Sets store_name

public setStoreName(string|null $store_name) : $this
Parameters
$store_name : string|null

The name of the AppStore.

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> —

setTransactionId()

Sets transaction_id

public setTransactionId(string|null $transaction_id) : $this
Parameters
$transaction_id : string|null

Specifies the Transaction ID from the AppStore.

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