Documentation

CreditCardInformation
in package
implements ModelInterface, ArrayAccess

CreditCardInformation Class Doc Comment

Tags
category

Class

description

This object contains information about a credit card that is associated with an account.

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
getAddress()  : AddressInformation
Gets address
getCardLastDigits()  : string|null
Gets card_last_digits
getCardNumber()  : string|null
Gets card_number
getCardType()  : string|null
Gets card_type
getCvNumber()  : string|null
Gets cv_number
getExpirationMonth()  : string|null
Gets expiration_month
getExpirationYear()  : string|null
Gets expiration_year
getModelName()  : string
The original name of the model.
getNameOnCard()  : string|null
Gets name_on_card
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTokenizedCard()  : string|null
Gets tokenized_card
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.
setAddress()  : $this
Sets address
setCardLastDigits()  : $this
Sets card_last_digits
setCardNumber()  : $this
Sets card_number
setCardType()  : $this
Sets card_type
setCvNumber()  : $this
Sets cv_number
setExpirationMonth()  : $this
Sets expiration_month
setExpirationYear()  : $this
Sets expiration_year
setNameOnCard()  : $this
Sets name_on_card
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTokenizedCard()  : $this
Sets tokenized_card
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 = ['address' => 'address', 'card_last_digits' => 'cardLastDigits', 'card_number' => 'cardNumber', 'card_type' => 'cardType', 'cv_number' => 'cvNumber', 'expiration_month' => 'expirationMonth', 'expiration_year' => 'expirationYear', 'name_on_card' => 'nameOnCard', 'tokenized_card' => 'tokenizedCard']

$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 = ['address' => 'getAddress', 'card_last_digits' => 'getCardLastDigits', 'card_number' => 'getCardNumber', 'card_type' => 'getCardType', 'cv_number' => 'getCvNumber', 'expiration_month' => 'getExpirationMonth', 'expiration_year' => 'getExpirationYear', 'name_on_card' => 'getNameOnCard', 'tokenized_card' => 'getTokenizedCard']

$setters

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

protected static array<string|int, string> $setters = ['address' => 'setAddress', 'card_last_digits' => 'setCardLastDigits', 'card_number' => 'setCardNumber', 'card_type' => 'setCardType', 'cv_number' => 'setCvNumber', 'expiration_month' => 'setExpirationMonth', 'expiration_year' => 'setExpirationYear', 'name_on_card' => 'setNameOnCard', 'tokenized_card' => 'setTokenizedCard']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['address' => null, 'card_last_digits' => null, 'card_number' => null, 'card_type' => null, 'cv_number' => null, 'expiration_month' => null, 'expiration_year' => null, 'name_on_card' => null, 'tokenized_card' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'creditCardInformation'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['address' => '\\DocuSign\\eSign\\Model\\AddressInformation', 'card_last_digits' => '?string', 'card_number' => '?string', 'card_type' => '?string', 'cv_number' => '?string', 'expiration_month' => '?string', 'expiration_year' => '?string', 'name_on_card' => '?string', 'tokenized_card' => '?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>

getCardLastDigits()

Gets card_last_digits

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

getCardNumber()

Gets card_number

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

getCardType()

Gets card_type

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

getCvNumber()

Gets cv_number

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

getExpirationMonth()

Gets expiration_month

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

getExpirationYear()

Gets expiration_year

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getNameOnCard()

Gets name_on_card

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

getTokenizedCard()

Gets tokenized_card

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

setCardLastDigits()

Sets card_last_digits

public setCardLastDigits(string|null $card_last_digits) : $this
Parameters
$card_last_digits : string|null
Return values
$this

setCardNumber()

Sets card_number

public setCardNumber(string|null $card_number) : $this
Parameters
$card_number : string|null

The number on the credit card.

Return values
$this

setCardType()

Sets card_type

public setCardType(string|null $card_type) : $this
Parameters
$card_type : string|null

The credit card type. Valid values are: visa, mastercard, or amex.

Return values
$this

setCvNumber()

Sets cv_number

public setCvNumber(string|null $cv_number) : $this
Parameters
$cv_number : string|null
Return values
$this

setExpirationMonth()

Sets expiration_month

public setExpirationMonth(string|null $expiration_month) : $this
Parameters
$expiration_month : string|null

The month that the credit card expires (1-12).

Return values
$this

setExpirationYear()

Sets expiration_year

public setExpirationYear(string|null $expiration_year) : $this
Parameters
$expiration_year : string|null

The year 4 digit year in which the credit card expires.

Return values
$this

setNameOnCard()

Sets name_on_card

public setNameOnCard(string|null $name_on_card) : $this
Parameters
$name_on_card : string|null

The exact name printed on the credit card.

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>

setTokenizedCard()

Sets tokenized_card

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