Documentation

ManagePBTRequest
in package
implements ModelInterface, ArrayAccess

Warning:

This class subject to change without prior notice, Please dont use this class directly.

Tags
category

Class

Interfaces, Classes and Traits

ModelInterface
Warning:
ArrayAccess

Table of Contents

DISCRIMINATOR  = null
ENROLLMENT_STATUS_ENROLLED  = 'enrolled'
ENROLLMENT_STATUS_UNENROLLED  = 'unenrolled'
PAYMENT_AMOUNT_TYPE_CURRENT_BALANCE  = 'current_balance'
PAYMENT_AMOUNT_TYPE_MINIMUM_PAYMENT_DUE  = 'minimum_payment_due'
PAYMENT_AMOUNT_TYPE_PAST_PAYMENT_DUE  = 'past_payment_due'
PAYMENT_AMOUNT_TYPE_STATEMENT_BALANCE  = 'statement_balance'
$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
getContact()  : PbtContact
Gets contact
getCustomer()  : CustomerMinimalRequest
Gets customer
getCustomerAccount()  : CustomerAccountMinimalRequest
Gets customer_account
getDaysBeforeDue()  : string
Gets days_before_due
getEnrollmentStatus()  : string
Gets enrollment_status
getEnrollmentStatusAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getFundingAccount()  : PBTFundingAccountMinimalRequest
Gets funding_account
getModelName()  : string
The original name of the model.
getPaymentAmountType()  : string
Gets payment_amount_type
getPaymentAmountTypeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setContact()  : $this
Sets contact
setCustomer()  : $this
Sets customer
setCustomerAccount()  : $this
Sets customer_account
setDaysBeforeDue()  : $this
Sets days_before_due
setEnrollmentStatus()  : $this
Sets enrollment_status
setFundingAccount()  : $this
Sets funding_account
setPaymentAmountType()  : $this
Sets payment_amount_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

Constants

ENROLLMENT_STATUS_ENROLLED

public mixed ENROLLMENT_STATUS_ENROLLED = 'enrolled'

ENROLLMENT_STATUS_UNENROLLED

public mixed ENROLLMENT_STATUS_UNENROLLED = 'unenrolled'

PAYMENT_AMOUNT_TYPE_CURRENT_BALANCE

public mixed PAYMENT_AMOUNT_TYPE_CURRENT_BALANCE = 'current_balance'

PAYMENT_AMOUNT_TYPE_MINIMUM_PAYMENT_DUE

public mixed PAYMENT_AMOUNT_TYPE_MINIMUM_PAYMENT_DUE = 'minimum_payment_due'

PAYMENT_AMOUNT_TYPE_PAST_PAYMENT_DUE

public mixed PAYMENT_AMOUNT_TYPE_PAST_PAYMENT_DUE = 'past_payment_due'

PAYMENT_AMOUNT_TYPE_STATEMENT_BALANCE

public mixed PAYMENT_AMOUNT_TYPE_STATEMENT_BALANCE = 'statement_balance'

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 = ['customer' => 'customer', 'contact' => 'contact', 'customer_account' => 'customer_account', 'funding_account' => 'funding_account', 'payment_amount_type' => 'payment_amount_type', 'days_before_due' => 'days_before_due', 'enrollment_status' => 'enrollment_status']

$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 = ['customer' => 'getCustomer', 'contact' => 'getContact', 'customer_account' => 'getCustomerAccount', 'funding_account' => 'getFundingAccount', 'payment_amount_type' => 'getPaymentAmountType', 'days_before_due' => 'getDaysBeforeDue', 'enrollment_status' => 'getEnrollmentStatus']

$setters

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

protected static array<string|int, string> $setters = ['customer' => 'setCustomer', 'contact' => 'setContact', 'customer_account' => 'setCustomerAccount', 'funding_account' => 'setFundingAccount', 'payment_amount_type' => 'setPaymentAmountType', 'days_before_due' => 'setDaysBeforeDue', 'enrollment_status' => 'setEnrollmentStatus']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['customer' => null, 'contact' => null, 'customer_account' => null, 'funding_account' => null, 'payment_amount_type' => null, 'days_before_due' => null, 'enrollment_status' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'ManagePBTRequest'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['customer' => '\Orbipay\PaymentsApi\Client\Model\CustomerMinimalRequest', 'contact' => '\Orbipay\PaymentsApi\Client\Model\PbtContact', 'customer_account' => '\Orbipay\PaymentsApi\Client\Model\CustomerAccountMinimalRequest', 'funding_account' => '\Orbipay\PaymentsApi\Client\Model\PBTFundingAccountMinimalRequest', 'payment_amount_type' => 'string', 'days_before_due' => 'string', 'enrollment_status' => '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> —

getDaysBeforeDue()

Gets days_before_due

public getDaysBeforeDue() : string
Return values
string —

getEnrollmentStatus()

Gets enrollment_status

public getEnrollmentStatus() : string
Return values
string —

getEnrollmentStatusAllowableValues()

Gets allowable values of the enum

public getEnrollmentStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getPaymentAmountType()

Gets payment_amount_type

public getPaymentAmountType() : string
Return values
string —

getPaymentAmountTypeAllowableValues()

Gets allowable values of the enum

public getPaymentAmountTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getters()

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

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

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 —

setDaysBeforeDue()

Sets days_before_due

public setDaysBeforeDue(string $days_before_due) : $this
Parameters
$days_before_due : string

The number of days before the payment due date on which the payment alert is to be sent to the enrolled customer to the contact phone provided here.

Return values
$this —

setEnrollmentStatus()

Sets enrollment_status

public setEnrollmentStatus(string $enrollment_status) : $this
Parameters
$enrollment_status : string

The status of the payment enrolment. Use “unenrolled” to cancel the existing enrolment.

Return values
$this —

setPaymentAmountType()

Sets payment_amount_type

public setPaymentAmountType(string $payment_amount_type) : $this
Parameters
$payment_amount_type : string

The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.

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

Search results