PaymentMethodConfiguration.php — Booking for Appointments and Events Calendar – Amelia 2.4.4

ameliabooking / vendor / stripe / stripe-php / lib / PaymentMethodConfiguration.php

ameliabooking / vendor / stripe / stripe-php / lib Last commit date

PaymentMethodConfiguration.php

152 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4	namespace AmeliaVendor\Stripe;
5
6	/**
7	* PaymentMethodConfigurations control which payment methods are displayed to your customers when you don't explicitly specify payment method types. You can have multiple configurations with different sets of payment methods for different scenarios.
8	*
9	* There are two types of PaymentMethodConfigurations. Which is used depends on the <a href="https://stripe.com/docs/connect/charges">charge type</a>:
10	*
11	* <strong>Direct</strong> configurations apply to payments created on your account, including Connect destination charges, Connect separate charges and transfers, and payments not involving Connect.
12	*
13	* <strong>Child</strong> configurations apply to payments created on your connected accounts using direct charges, and charges with the on_behalf_of parameter.
14	*
15	* Child configurations have a <code>parent</code> that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected account’s associated child configuration. Parent configurations are <a href="https://dashboard.stripe.com/settings/payment_methods/connected_accounts">managed in the dashboard</a> and are not available in this API.
16	*
17	* Related guides:
18	* - <a href="https://stripe.com/docs/connect/payment-method-configurations">Payment Method Configurations API</a>
19	* - <a href="https://stripe.com/docs/payments/multiple-payment-method-configs">Multiple configurations on dynamic payment methods</a>
20	* - <a href="https://stripe.com/docs/connect/multiple-payment-method-configurations">Multiple configurations for your Connect accounts</a>
21	*
22	* @property string $id Unique identifier for the object.
23	* @property string $object String representing the object's type. Objects of the same type share the same value.
24	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $acss_debit
25	* @property bool $active Whether the configuration can be used for new payments.
26	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $affirm
27	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $afterpay_clearpay
28	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $alipay
29	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $alma
30	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $amazon_pay
31	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $apple_pay
32	* @property null\|string $application For child configs, the Connect application associated with the configuration.
33	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $au_becs_debit
34	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $bacs_debit
35	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $bancontact
36	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $billie
37	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $blik
38	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $boleto
39	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $card
40	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $cartes_bancaires
41	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $cashapp
42	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $customer_balance
43	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $eps
44	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $fpx
45	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $giropay
46	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $google_pay
47	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $grabpay
48	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $ideal
49	* @property bool $is_default The default configuration is used whenever a payment method configuration is not specified.
50	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $jcb
51	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $klarna
52	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $konbini
53	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $link
54	* @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
55	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $mobilepay
56	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $multibanco
57	* @property string $name The configuration's name.
58	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $nz_bank_account
59	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $oxxo
60	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $p24
61	* @property null\|string $parent For child configs, the configuration's parent configuration.
62	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $pay_by_bank
63	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $paynow
64	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $paypal
65	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $pix
66	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $promptpay
67	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $revolut_pay
68	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $satispay
69	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $sepa_debit
70	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $sofort
71	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $swish
72	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $twint
73	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $us_bank_account
74	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $wechat_pay
75	* @property null\|(object{available: bool, display_preference: (object{overridable: null\|bool, preference: string, value: string}&StripeObject)}&StripeObject) $zip
76	*/
77	class PaymentMethodConfiguration extends ApiResource
78	{
79	const OBJECT_NAME = 'payment_method_configuration';
80	use \AmeliaVendor\Stripe\ApiOperations\Update;
81	/**
82	* Creates a payment method configuration.
83	*
84	* @param null\|array{acss_debit?: array{display_preference?: array{preference?: string}}, affirm?: array{display_preference?: array{preference?: string}}, afterpay_clearpay?: array{display_preference?: array{preference?: string}}, alipay?: array{display_preference?: array{preference?: string}}, alma?: array{display_preference?: array{preference?: string}}, amazon_pay?: array{display_preference?: array{preference?: string}}, apple_pay?: array{display_preference?: array{preference?: string}}, apple_pay_later?: array{display_preference?: array{preference?: string}}, au_becs_debit?: array{display_preference?: array{preference?: string}}, bacs_debit?: array{display_preference?: array{preference?: string}}, bancontact?: array{display_preference?: array{preference?: string}}, billie?: array{display_preference?: array{preference?: string}}, blik?: array{display_preference?: array{preference?: string}}, boleto?: array{display_preference?: array{preference?: string}}, card?: array{display_preference?: array{preference?: string}}, cartes_bancaires?: array{display_preference?: array{preference?: string}}, cashapp?: array{display_preference?: array{preference?: string}}, customer_balance?: array{display_preference?: array{preference?: string}}, eps?: array{display_preference?: array{preference?: string}}, expand?: string[], fpx?: array{display_preference?: array{preference?: string}}, giropay?: array{display_preference?: array{preference?: string}}, google_pay?: array{display_preference?: array{preference?: string}}, grabpay?: array{display_preference?: array{preference?: string}}, ideal?: array{display_preference?: array{preference?: string}}, jcb?: array{display_preference?: array{preference?: string}}, klarna?: array{display_preference?: array{preference?: string}}, konbini?: array{display_preference?: array{preference?: string}}, link?: array{display_preference?: array{preference?: string}}, mobilepay?: array{display_preference?: array{preference?: string}}, multibanco?: array{display_preference?: array{preference?: string}}, name?: string, nz_bank_account?: array{display_preference?: array{preference?: string}}, oxxo?: array{display_preference?: array{preference?: string}}, p24?: array{display_preference?: array{preference?: string}}, parent?: string, pay_by_bank?: array{display_preference?: array{preference?: string}}, paynow?: array{display_preference?: array{preference?: string}}, paypal?: array{display_preference?: array{preference?: string}}, pix?: array{display_preference?: array{preference?: string}}, promptpay?: array{display_preference?: array{preference?: string}}, revolut_pay?: array{display_preference?: array{preference?: string}}, satispay?: array{display_preference?: array{preference?: string}}, sepa_debit?: array{display_preference?: array{preference?: string}}, sofort?: array{display_preference?: array{preference?: string}}, swish?: array{display_preference?: array{preference?: string}}, twint?: array{display_preference?: array{preference?: string}}, us_bank_account?: array{display_preference?: array{preference?: string}}, wechat_pay?: array{display_preference?: array{preference?: string}}, zip?: array{display_preference?: array{preference?: string}}} $params
85	* @param null\|array\|string $options
86	*
87	* @return PaymentMethodConfiguration the created resource
88	*
89	* @throws Exception\ApiErrorException if the request fails
90	*/
91	public static function create($params = null, $options = null)
92	{
93	self::_validateParams($params);
94	$url = static::classUrl();
95	list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
96	$obj = \AmeliaVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts);
97	$obj->setLastResponse($response);
98	return $obj;
99	}
100	/**
101	* List payment method configurations.
102	*
103	* @param null\|array{application?: null\|string, ending_before?: string, expand?: string[], limit?: int, starting_after?: string} $params
104	* @param null\|array\|string $opts
105	*
106	* @return Collection<PaymentMethodConfiguration> of ApiResources
107	*
108	* @throws Exception\ApiErrorException if the request fails
109	*/
110	public static function all($params = null, $opts = null)
111	{
112	$url = static::classUrl();
113	return static::_requestPage($url, Collection::class, $params, $opts);
114	}
115	/**
116	* Retrieve payment method configuration.
117	*
118	* @param array\|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
119	* @param null\|array\|string $opts
120	*
121	* @return PaymentMethodConfiguration
122	*
123	* @throws Exception\ApiErrorException if the request fails
124	*/
125	public static function retrieve($id, $opts = null)
126	{
127	$opts = \AmeliaVendor\Stripe\Util\RequestOptions::parse($opts);
128	$instance = new static($id, $opts);
129	$instance->refresh();
130	return $instance;
131	}
132	/**
133	* Update payment method configuration.
134	*
135	* @param string $id the ID of the resource to update
136	* @param null\|array{acss_debit?: array{display_preference?: array{preference?: string}}, active?: bool, affirm?: array{display_preference?: array{preference?: string}}, afterpay_clearpay?: array{display_preference?: array{preference?: string}}, alipay?: array{display_preference?: array{preference?: string}}, alma?: array{display_preference?: array{preference?: string}}, amazon_pay?: array{display_preference?: array{preference?: string}}, apple_pay?: array{display_preference?: array{preference?: string}}, apple_pay_later?: array{display_preference?: array{preference?: string}}, au_becs_debit?: array{display_preference?: array{preference?: string}}, bacs_debit?: array{display_preference?: array{preference?: string}}, bancontact?: array{display_preference?: array{preference?: string}}, billie?: array{display_preference?: array{preference?: string}}, blik?: array{display_preference?: array{preference?: string}}, boleto?: array{display_preference?: array{preference?: string}}, card?: array{display_preference?: array{preference?: string}}, cartes_bancaires?: array{display_preference?: array{preference?: string}}, cashapp?: array{display_preference?: array{preference?: string}}, customer_balance?: array{display_preference?: array{preference?: string}}, eps?: array{display_preference?: array{preference?: string}}, expand?: string[], fpx?: array{display_preference?: array{preference?: string}}, giropay?: array{display_preference?: array{preference?: string}}, google_pay?: array{display_preference?: array{preference?: string}}, grabpay?: array{display_preference?: array{preference?: string}}, ideal?: array{display_preference?: array{preference?: string}}, jcb?: array{display_preference?: array{preference?: string}}, klarna?: array{display_preference?: array{preference?: string}}, konbini?: array{display_preference?: array{preference?: string}}, link?: array{display_preference?: array{preference?: string}}, mobilepay?: array{display_preference?: array{preference?: string}}, multibanco?: array{display_preference?: array{preference?: string}}, name?: string, nz_bank_account?: array{display_preference?: array{preference?: string}}, oxxo?: array{display_preference?: array{preference?: string}}, p24?: array{display_preference?: array{preference?: string}}, pay_by_bank?: array{display_preference?: array{preference?: string}}, paynow?: array{display_preference?: array{preference?: string}}, paypal?: array{display_preference?: array{preference?: string}}, pix?: array{display_preference?: array{preference?: string}}, promptpay?: array{display_preference?: array{preference?: string}}, revolut_pay?: array{display_preference?: array{preference?: string}}, satispay?: array{display_preference?: array{preference?: string}}, sepa_debit?: array{display_preference?: array{preference?: string}}, sofort?: array{display_preference?: array{preference?: string}}, swish?: array{display_preference?: array{preference?: string}}, twint?: array{display_preference?: array{preference?: string}}, us_bank_account?: array{display_preference?: array{preference?: string}}, wechat_pay?: array{display_preference?: array{preference?: string}}, zip?: array{display_preference?: array{preference?: string}}} $params
137	* @param null\|array\|string $opts
138	*
139	* @return PaymentMethodConfiguration the updated resource
140	*
141	* @throws Exception\ApiErrorException if the request fails
142	*/
143	public static function update($id, $params = null, $opts = null)
144	{
145	self::_validateParams($params);
146	$url = static::resourceUrl($id);
147	list($response, $opts) = static::_staticRequest('post', $url, $params, $opts);
148	$obj = \AmeliaVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts);
149	$obj->setLastResponse($response);
150	return $obj;
151	}
152	}