PaymentGatewayAccount
in package
implements
ModelInterface, ArrayAccess
PaymentGatewayAccount Class Doc Comment
Tags
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
- getAllowCustomMetadata() : bool|null
- Gets allow_custom_metadata
- getConfig() : PaymentGatewayAccountSetting
- Gets config
- getDisplayName() : string|null
- Gets display_name
- getIsEnabled() : string|null
- Gets is_enabled
- getIsLegacy() : string|null
- Gets is_legacy
- getLastModified() : string|null
- Gets last_modified
- getModelName() : string
- The original name of the model.
- getPaymentGateway() : string|null
- Gets payment_gateway
- getPaymentGatewayAccountId() : string|null
- Gets payment_gateway_account_id
- getPaymentGatewayDisplayName() : string|null
- Gets payment_gateway_display_name
- getPayPalLegacySettings() : PayPalLegacySettings
- Gets pay_pal_legacy_settings
- getSupportedCurrencies() : array<string|int, ?string>
- Gets supported_currencies
- getSupportedPaymentMethods() : array<string|int, ?string>
- Gets supported_payment_methods
- getSupportedPaymentMethodsWithOptions() : array<string|int, PaymentMethodWithOptions>
- Gets supported_payment_methods_with_options
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getZeroDecimalCurrencies() : array<string|int, ?string>
- Gets zero_decimal_currencies
- 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.
- setAllowCustomMetadata() : $this
- Sets allow_custom_metadata
- setConfig() : $this
- Sets config
- setDisplayName() : $this
- Sets display_name
- setIsEnabled() : $this
- Sets is_enabled
- setIsLegacy() : $this
- Sets is_legacy
- setLastModified() : $this
- Sets last_modified
- setPaymentGateway() : $this
- Sets payment_gateway
- setPaymentGatewayAccountId() : $this
- Sets payment_gateway_account_id
- setPaymentGatewayDisplayName() : $this
- Sets payment_gateway_display_name
- setPayPalLegacySettings() : $this
- Sets pay_pal_legacy_settings
- setSupportedCurrencies() : $this
- Sets supported_currencies
- setSupportedPaymentMethods() : $this
- Sets supported_payment_methods
- setSupportedPaymentMethodsWithOptions() : $this
- Sets supported_payment_methods_with_options
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setZeroDecimalCurrencies() : $this
- Sets zero_decimal_currencies
- 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
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
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
= ['allow_custom_metadata' => 'allowCustomMetadata', 'config' => 'config', 'display_name' => 'displayName', 'is_enabled' => 'isEnabled', 'is_legacy' => 'isLegacy', 'last_modified' => 'lastModified', 'payment_gateway' => 'paymentGateway', 'payment_gateway_account_id' => 'paymentGatewayAccountId', 'payment_gateway_display_name' => 'paymentGatewayDisplayName', 'pay_pal_legacy_settings' => 'payPalLegacySettings', 'supported_currencies' => 'supportedCurrencies', 'supported_payment_methods' => 'supportedPaymentMethods', 'supported_payment_methods_with_options' => 'supportedPaymentMethodsWithOptions', 'zero_decimal_currencies' => 'zeroDecimalCurrencies']
$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
= ['allow_custom_metadata' => 'getAllowCustomMetadata', 'config' => 'getConfig', 'display_name' => 'getDisplayName', 'is_enabled' => 'getIsEnabled', 'is_legacy' => 'getIsLegacy', 'last_modified' => 'getLastModified', 'payment_gateway' => 'getPaymentGateway', 'payment_gateway_account_id' => 'getPaymentGatewayAccountId', 'payment_gateway_display_name' => 'getPaymentGatewayDisplayName', 'pay_pal_legacy_settings' => 'getPayPalLegacySettings', 'supported_currencies' => 'getSupportedCurrencies', 'supported_payment_methods' => 'getSupportedPaymentMethods', 'supported_payment_methods_with_options' => 'getSupportedPaymentMethodsWithOptions', 'zero_decimal_currencies' => 'getZeroDecimalCurrencies']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['allow_custom_metadata' => 'setAllowCustomMetadata', 'config' => 'setConfig', 'display_name' => 'setDisplayName', 'is_enabled' => 'setIsEnabled', 'is_legacy' => 'setIsLegacy', 'last_modified' => 'setLastModified', 'payment_gateway' => 'setPaymentGateway', 'payment_gateway_account_id' => 'setPaymentGatewayAccountId', 'payment_gateway_display_name' => 'setPaymentGatewayDisplayName', 'pay_pal_legacy_settings' => 'setPayPalLegacySettings', 'supported_currencies' => 'setSupportedCurrencies', 'supported_payment_methods' => 'setSupportedPaymentMethods', 'supported_payment_methods_with_options' => 'setSupportedPaymentMethodsWithOptions', 'zero_decimal_currencies' => 'setZeroDecimalCurrencies']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['allow_custom_metadata' => null, 'config' => null, 'display_name' => null, 'is_enabled' => null, 'is_legacy' => null, 'last_modified' => null, 'payment_gateway' => null, 'payment_gateway_account_id' => null, 'payment_gateway_display_name' => null, 'pay_pal_legacy_settings' => null, 'supported_currencies' => null, 'supported_payment_methods' => null, 'supported_payment_methods_with_options' => null, 'zero_decimal_currencies' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'paymentGatewayAccount'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['allow_custom_metadata' => '?bool', 'config' => '\\DocuSign\\eSign\\Model\\PaymentGatewayAccountSetting', 'display_name' => '?string', 'is_enabled' => '?string', 'is_legacy' => '?string', 'last_modified' => '?string', 'payment_gateway' => '?string', 'payment_gateway_account_id' => '?string', 'payment_gateway_display_name' => '?string', 'pay_pal_legacy_settings' => '\\DocuSign\\eSign\\Model\\PayPalLegacySettings', 'supported_currencies' => '?string[]', 'supported_payment_methods' => '?string[]', 'supported_payment_methods_with_options' => '\\DocuSign\\eSign\\Model\\PaymentMethodWithOptions[]', 'zero_decimal_currencies' => '?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> —getAllowCustomMetadata()
Gets allow_custom_metadata
public
getAllowCustomMetadata() : bool|null
Return values
bool|null —getConfig()
Gets config
public
getConfig() : PaymentGatewayAccountSetting
Return values
PaymentGatewayAccountSetting —getDisplayName()
Gets display_name
public
getDisplayName() : string|null
Return values
string|null —getIsEnabled()
Gets is_enabled
public
getIsEnabled() : string|null
Return values
string|null —getIsLegacy()
Gets is_legacy
public
getIsLegacy() : string|null
Return values
string|null —getLastModified()
Gets last_modified
public
getLastModified() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPaymentGateway()
Gets payment_gateway
public
getPaymentGateway() : string|null
Return values
string|null —getPaymentGatewayAccountId()
Gets payment_gateway_account_id
public
getPaymentGatewayAccountId() : string|null
Return values
string|null —getPaymentGatewayDisplayName()
Gets payment_gateway_display_name
public
getPaymentGatewayDisplayName() : string|null
Return values
string|null —getPayPalLegacySettings()
Gets pay_pal_legacy_settings
public
getPayPalLegacySettings() : PayPalLegacySettings
Return values
PayPalLegacySettings —getSupportedCurrencies()
Gets supported_currencies
public
getSupportedCurrencies() : array<string|int, ?string>
Return values
array<string|int, ?string> —getSupportedPaymentMethods()
Gets supported_payment_methods
public
getSupportedPaymentMethods() : array<string|int, ?string>
Return values
array<string|int, ?string> —getSupportedPaymentMethodsWithOptions()
Gets supported_payment_methods_with_options
public
getSupportedPaymentMethodsWithOptions() : array<string|int, PaymentMethodWithOptions>
Return values
array<string|int, PaymentMethodWithOptions> —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getZeroDecimalCurrencies()
Gets zero_decimal_currencies
public
getZeroDecimalCurrencies() : array<string|int, ?string>
Return values
array<string|int, ?string> —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 —setAllowCustomMetadata()
Sets allow_custom_metadata
public
setAllowCustomMetadata(bool|null $allow_custom_metadata) : $this
Parameters
- $allow_custom_metadata : bool|null
Return values
$this —setConfig()
Sets config
public
setConfig(PaymentGatewayAccountSetting $config) : $this
Parameters
- $config : PaymentGatewayAccountSetting
-
This property contains metadata about the payment gateway account's configuration such as the API key,
userId, andmerchantIddetails.
Return values
$this —setDisplayName()
Sets display_name
public
setDisplayName(string|null $display_name) : $this
Parameters
- $display_name : string|null
Return values
$this —setIsEnabled()
Sets is_enabled
public
setIsEnabled(string|null $is_enabled) : $this
Parameters
- $is_enabled : string|null
Return values
$this —setIsLegacy()
Sets is_legacy
public
setIsLegacy(string|null $is_legacy) : $this
Parameters
- $is_legacy : string|null
Return values
$this —setLastModified()
Sets last_modified
public
setLastModified(string|null $last_modified) : $this
Parameters
- $last_modified : string|null
Return values
$this —setPaymentGateway()
Sets payment_gateway
public
setPaymentGateway(string|null $payment_gateway) : $this
Parameters
- $payment_gateway : string|null
Return values
$this —setPaymentGatewayAccountId()
Sets payment_gateway_account_id
public
setPaymentGatewayAccountId(string|null $payment_gateway_account_id) : $this
Parameters
- $payment_gateway_account_id : string|null
Return values
$this —setPaymentGatewayDisplayName()
Sets payment_gateway_display_name
public
setPaymentGatewayDisplayName(string|null $payment_gateway_display_name) : $this
Parameters
- $payment_gateway_display_name : string|null
Return values
$this —setPayPalLegacySettings()
Sets pay_pal_legacy_settings
public
setPayPalLegacySettings(PayPalLegacySettings $pay_pal_legacy_settings) : $this
Parameters
- $pay_pal_legacy_settings : PayPalLegacySettings
-
Reserved for DocuSign.
Return values
$this —setSupportedCurrencies()
Sets supported_currencies
public
setSupportedCurrencies(array<string|int, ?string> $supported_currencies) : $this
Parameters
- $supported_currencies : array<string|int, ?string>
Return values
$this —setSupportedPaymentMethods()
Sets supported_payment_methods
public
setSupportedPaymentMethods(array<string|int, ?string> $supported_payment_methods) : $this
Parameters
- $supported_payment_methods : array<string|int, ?string>
Return values
$this —setSupportedPaymentMethodsWithOptions()
Sets supported_payment_methods_with_options
public
setSupportedPaymentMethodsWithOptions(array<string|int, PaymentMethodWithOptions> $supported_payment_methods_with_options) : $this
Parameters
- $supported_payment_methods_with_options : array<string|int, PaymentMethodWithOptions>
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> —setZeroDecimalCurrencies()
Sets zero_decimal_currencies
public
setZeroDecimalCurrencies(array<string|int, ?string> $zero_decimal_currencies) : $this
Parameters
- $zero_decimal_currencies : array<string|int, ?string>
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