Note: For error handling and troubleshooting, see Orders v2 errors.+Creates an order. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout. Note: For error handling and troubleshooting, see Orders v2 errors. ```php -function ordersCreate(array $options): ApiResponse +function createOrder(array $options): ApiResponse ``` ## Parameters @@ -35,15 +35,16 @@ function ordersCreate(array $options): ApiResponse | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `body` | [`OrderRequest`](../../doc/models/order-request.md) | Body, Required | - | +| `paypalMockResponse` | `?string` | Header, Optional | PayPal's REST API uses a request header to invoke negative testing in the sandbox. This header configures the sandbox into a negative testing state for transactions that include the merchant. | | `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. It is mandatory for all single-step create order calls (E.g. Create Order Request with payment source information like Card, PayPal.vault_id, PayPal.billing_agreement_id, etc).
return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.return=representation. The server returns a complete resource representation, including the current state of the resource.Note: For error handling and troubleshooting, see Orders v2 errors.+Shows details for an order, by ID. Note: For error handling and troubleshooting, see Orders v2 errors. ```php -function ordersGet(array $options): ApiResponse +function getOrder(array $options): ApiResponse ``` ## Parameters @@ -89,12 +90,13 @@ function ordersGet(array $options): ApiResponse | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `id` | `string` | Template, Required | The ID of the order for which to show details.
\"/purchase_units/@reference_id=='default'/{attribute-or-object}\". Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout.Note: For error handling and troubleshooting, see Orders v2 errors.Patchable attributes or objects:
| Attribute | Op | Notes |
|---|---|---|
intent | replace | |
payer | replace, add | Using replace op for payer will replace the whole payer object with the value sent in request. |
purchase_units | replace, add | |
purchase_units[].custom_id | replace, add, remove | |
purchase_units[].description | replace, add, remove | |
purchase_units[].payee.email | replace | |
purchase_units[].shipping.name | replace, add | |
purchase_units[].shipping.email_address | replace, add | |
purchase_units[].shipping.phone_number | replace, add | |
purchase_units[].shipping.options | replace, add | |
purchase_units[].shipping.address | replace, add | |
purchase_units[].shipping.type | replace, add | |
purchase_units[].soft_descriptor | replace, remove | |
purchase_units[].amount | replace | |
purchase_units[].items | replace, add, remove | |
purchase_units[].invoice_id | replace, add, remove | |
purchase_units[].payment_instruction | replace | |
purchase_units[].payment_instruction.disbursement_mode | replace | By default, disbursement_mode is INSTANT. |
purchase_units[].payment_instruction.payee_receivable_fx_rate_id | replace, add, remove | |
purchase_units[].payment_instruction.platform_fees | replace, add, remove | |
purchase_units[].supplementary_data.airline | replace, add, remove | |
purchase_units[].supplementary_data.card | replace, add, remove | |
application_context.client_configuration | replace, add |
return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.return=representation. The server returns a complete resource representation, including the current state of the resource.Note: For error handling and troubleshooting, see Orders v2 errors.+Authorizes payment for an order. To successfully authorize payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response. Note: For error handling and troubleshooting, see Orders v2 errors. ```php -function ordersAuthorize(array $options): ApiResponse +function authorizeOrder(array $options): ApiResponse ``` ## Parameters @@ -218,15 +221,16 @@ function ordersAuthorize(array $options): ApiResponse | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `id` | `string` | Template, Required | The ID of the order for which to authorize.
return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.return=representation. The server returns a complete resource representation, including the current state of the resource.Note: For error handling and troubleshooting, see Orders v2 errors.+Captures payment for an order. To successfully capture payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response. Note: For error handling and troubleshooting, see Orders v2 errors. ```php -function ordersCapture(array $options): ApiResponse +function captureOrder(array $options): ApiResponse ``` ## Parameters @@ -265,15 +269,16 @@ function ordersCapture(array $options): ApiResponse | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `id` | `string` | Template, Required | The ID of the order for which to capture a payment.
return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.return=representation. The server returns a complete resource representation, including the current state of the resource.| Attribute | Op | Notes |
|---|---|---|
items | replace | Using replace op for items will replace the entire items object with the value sent in request. |
notify_payer | replace, add | |
status | replace | Only patching status to CANCELLED is currently supported. |
Note:For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.| +| `paypalMockResponse` | `?string` | Header, Optional | PayPal's REST API uses a request header to invoke negative testing in the sandbox. This header configures the sandbox into a negative testing state for transactions that include the merchant. | +| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see [PayPal-Auth-Assertion](/docs/api/reference/api-requests/#paypal-auth-assertion). Note:For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject. | ## Response Type -This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentAuthorization`](../../doc/models/payment-authorization.md). +This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentAuthorization`](../../doc/models/payment-authorization.md). ## Example Usage @@ -47,7 +48,7 @@ $collect = [ 'authorizationId' => 'authorization_id8' ]; -$apiResponse = $paymentsController->authorizationsGet($collect); +$apiResponse = $paymentsController->getAuthorizedPayment($collect); ``` ## Errors @@ -60,12 +61,12 @@ $apiResponse = $paymentsController->authorizationsGet($collect); | Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) | -# Authorizations Capture +# Capture Authorized Payment Captures an authorized payment, by ID. ```php -function authorizationsCapture(array $options): ApiResponse +function captureAuthorizedPayment(array $options): ApiResponse ``` ## Parameters @@ -73,14 +74,15 @@ function authorizationsCapture(array $options): ApiResponse | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to capture. | +| `paypalMockResponse` | `?string` | Header, Optional | PayPal's REST API uses a request header to invoke negative testing in the sandbox. This header configures the sandbox into a negative testing state for transactions that include the merchant. | | `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. | -| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:
return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.return=representation. The server returns a complete resource representation, including the current state of the resource.Note:For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.| +| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is: return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links. return=representation. The server returns a complete resource representation, including the current state of the resource.
Note: This request is currently not supported for Partner use cases.+Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available, reauthorize a payment after its initial three-day honor period expires. Within the 29-day authorization period, you can issue multiple re-authorizations after the honor period expires. If 30 days have transpired since the date of the original authorization, you must create an authorized payment instead of reauthorizing the original authorized payment. A reauthorized payment itself has a new honor period of three days. You can reauthorize an authorized payment from 4 to 29 days after the 3-day honor period. The allowed amount depends on context and geography, for example in US it is up to 115% of the original authorized amount, not to exceed an increase of $75 USD. Supports only the `amount` request parameter. Note: This request is currently not supported for Partner use cases. ```php -function authorizationsReauthorize(array $options): ApiResponse +function reauthorizePayment(array $options): ApiResponse ``` ## Parameters @@ -124,13 +126,13 @@ function authorizationsReauthorize(array $options): ApiResponse | --- | --- | --- | --- | | `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to reauthorize. | | `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. | -| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:
return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.return=representation. The server returns a complete resource representation, including the current state of the resource.Note:For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.| +| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is: return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links. return=representation. The server returns a complete resource representation, including the current state of the resource.
Note:For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.| +| `paypalMockResponse` | `?string` | Header, Optional | PayPal's REST API uses a request header to invoke negative testing in the sandbox. This header configures the sandbox into a negative testing state for transactions that include the merchant. | +| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see [PayPal-Auth-Assertion](/docs/api/reference/api-requests/#paypal-auth-assertion). Note:For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject. | | `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. | -| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:
return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.return=representation. The server returns a complete resource representation, including the current state of the resource.amount object in the JSON request body.
+Refunds a captured payment, by ID. For a full refund, include an empty payload in the JSON request body. For a partial refund, include an amount object in the JSON request body.
```php
-function capturesRefund(array $options): ApiResponse
+function refundCapturedPayment(array $options): ApiResponse
```
## Parameters
@@ -250,14 +256,15 @@ function capturesRefund(array $options): ApiResponse
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `captureId` | `string` | Template, Required | The PayPal-generated ID for the captured payment to refund. |
+| `paypalMockResponse` | `?string` | Header, Optional | PayPal's REST API uses a request header to invoke negative testing in the sandbox. This header configures the sandbox into a negative testing state for transactions that include the merchant. |
| `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. |
-| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.return=representation. The server returns a complete resource representation, including the current state of the resource.Note:For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.| +| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is: return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links. return=representation. The server returns a complete resource representation, including the current state of the resource.
Note:For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.| +| `paypalMockResponse` | `?string` | Header, Optional | PayPal's REST API uses a request header to invoke negative testing in the sandbox. This header configures the sandbox into a negative testing state for transactions that include the merchant. | +| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see [PayPal-Auth-Assertion](/docs/api/reference/api-requests/#paypal-auth-assertion). Note:For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject. | ## Response Type -This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Refund`](../../doc/models/refund.md). +This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `getResult()` method on this instance returns the response data which is of type [`Refund`](../../doc/models/refund.md). ## Example Usage @@ -310,7 +318,7 @@ $collect = [ 'refundId' => 'refund_id4' ]; -$apiResponse = $paymentsController->refundsGet($collect); +$apiResponse = $paymentsController->getRefund($collect); ``` ## Errors diff --git a/doc/controllers/vault.md b/doc/controllers/vault.md index feb2743..e965dbf 100644 --- a/doc/controllers/vault.md +++ b/doc/controllers/vault.md @@ -12,44 +12,43 @@ $vaultController = $client->getVaultController(); ## Methods -* [Payment-Tokens Create](../../doc/controllers/vault.md#payment-tokens-create) -* [Customer Payment-Tokens Get](../../doc/controllers/vault.md#customer-payment-tokens-get) -* [Payment-Tokens Get](../../doc/controllers/vault.md#payment-tokens-get) -* [Payment-Tokens Delete](../../doc/controllers/vault.md#payment-tokens-delete) -* [Setup-Tokens Create](../../doc/controllers/vault.md#setup-tokens-create) -* [Setup-Tokens Get](../../doc/controllers/vault.md#setup-tokens-get) +* [Create Payment Token](../../doc/controllers/vault.md#create-payment-token) +* [List Customer Payment Tokens](../../doc/controllers/vault.md#list-customer-payment-tokens) +* [Get Payment Token](../../doc/controllers/vault.md#get-payment-token) +* [Delete Payment Token](../../doc/controllers/vault.md#delete-payment-token) +* [Create Setup Token](../../doc/controllers/vault.md#create-setup-token) +* [Get Setup Token](../../doc/controllers/vault.md#get-setup-token) -# Payment-Tokens Create +# Create Payment Token Creates a Payment Token from the given payment source and adds it to the Vault of the associated customer. ```php -function paymentTokensCreate(array $options): ApiResponse +function createPaymentToken(array $options): ApiResponse ``` ## Parameters | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `paypalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. | | `body` | [`PaymentTokenRequest`](../../doc/models/payment-token-request.md) | Body, Required | Payment Token creation with a financial instrument and an optional customer_id. | +| `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 3 hours.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance.+The payment card to use to fund a payment. Can be a credit or debit card. Note: Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance. *PayPal offers a mechanism by which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this Integration Guide*. ## Structure @@ -19,7 +19,7 @@ The payment card to use to fund a payment. Can be a credit or debit card.
*PayPal offers a mechanism by which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this Integration Guide*.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: Partners and Marketplaces might configure+Customizes the payer experience during the approval process for the payment with PayPal. Note: Partners and Marketplaces might configure brand_name and shipping_preference during partner account setup, which overrides the request values. ## Structure @@ -14,12 +14,12 @@ Customizes the payer experience during the approval process for the payment with | `brandName` | `?string` | Optional | DEPRECATED. The label that overrides the business name in the PayPal account on the PayPal site. The fields in `application_context` are now available in the `experience_context` object under the `payment_source` which supports them (eg. `payment_source.paypal.experience_context.brand_name`). Please specify this field in the `experience_context` object instead of the `application_context` object.brand_nameandshipping_preferenceduring partner account setup, which overrides the request values.
Note: Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance.| getCard(): ?CardRequest | setCard(?CardRequest card): void | +| `card` | [`?CardRequest`](../../doc/models/card-request.md) | Optional | The payment card to use to fund a payment. Can be a credit or debit card. Note: Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance. *PayPal offers a mechanism by which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this Integration Guide*. | getCard(): ?CardRequest | setCard(?CardRequest card): void | | `token` | [`?Token`](../../doc/models/token.md) | Optional | The tokenized payment source to fund a payment. | getToken(): ?Token | setToken(?Token token): void | | `paypal` | [`?PaypalWallet`](../../doc/models/paypal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PaypalWallet | setPaypal(?PaypalWallet paypal): void | | `applePay` | [`?ApplePayRequest`](../../doc/models/apple-pay-request.md) | Optional | Information needed to pay using ApplePay. | getApplePay(): ?ApplePayRequest | setApplePay(?ApplePayRequest applePay): void | diff --git a/doc/models/order-authorize-response.md b/doc/models/order-authorize-response.md index 603da86..332360c 100644 --- a/doc/models/order-authorize-response.md +++ b/doc/models/order-authorize-response.md @@ -9,12 +9,11 @@ | Name | Type | Tags | Description | Getter | Setter | | --- | --- | --- | --- | --- | --- | -| `createTime` | `?string` | Optional | The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.
*PayPal offers a mechanism by which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this Integration Guide*.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance.| getCard(): ?CardRequest | setCard(?CardRequest card): void | +| `card` | [`?CardRequest`](../../doc/models/card-request.md) | Optional | The payment card to use to fund a payment. Can be a credit or debit card. Note: Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance. *PayPal offers a mechanism by which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this Integration Guide*. | getCard(): ?CardRequest | setCard(?CardRequest card): void | | `token` | [`?Token`](../../doc/models/token.md) | Optional | The tokenized payment source to fund a payment. | getToken(): ?Token | setToken(?Token token): void | | `paypal` | [`?PaypalWallet`](../../doc/models/paypal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PaypalWallet | setPaypal(?PaypalWallet paypal): void | | `applePay` | [`?ApplePayRequest`](../../doc/models/apple-pay-request.md) | Optional | Information needed to pay using ApplePay. | getApplePay(): ?ApplePayRequest | setApplePay(?ApplePayRequest applePay): void | diff --git a/doc/models/order-confirm-application-context.md b/doc/models/order-confirm-application-context.md index 4f05a84..c77bea2 100644 --- a/doc/models/order-confirm-application-context.md +++ b/doc/models/order-confirm-application-context.md @@ -15,7 +15,7 @@ Customizes the payer confirmation experience. | `locale` | `?string` | Optional | The [language tag](https://tools.ietf.org/html/bcp47#section-2) for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the [ISO 639-2 language code](https://www.loc.gov/standards/iso639-2/php/code_list.php), the optional [ISO-15924 script tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166 alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region code](https://unstats.un.org/unsd/methodology/m49/).
*PayPal offers a mechanism by which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this Integration Guide*.
Note: Partners and Marketplaces might configure| getApplicationContext(): ?OrderApplicationContext | setApplicationContext(?OrderApplicationContext applicationContext): void | +| `applicationContext` | [`?OrderApplicationContext`](../../doc/models/order-application-context.md) | Optional | Customizes the payer experience during the approval process for the payment with PayPal. Note: Partners and Marketplaces might configure brand_name and shipping_preference during partner account setup, which overrides the request values. | getApplicationContext(): ?OrderApplicationContext | setApplicationContext(?OrderApplicationContext applicationContext): void | ## Example (as JSON) diff --git a/doc/models/order-status.md b/doc/models/order-status.md index 64f7c6f..8492746 100644 --- a/doc/models/order-status.md +++ b/doc/models/order-status.md @@ -9,12 +9,12 @@ The order status. ## Fields -| Name | -| --- | -| `CREATED` | -| `SAVED` | -| `APPROVED` | -| `VOIDED` | -| `COMPLETED` | -| `PAYER_ACTION_REQUIRED` | +| Name | Description | +| --- | --- | +| `CREATED` | The order was created with the specified context. | +| `SAVED` | The order was saved and persisted. The order status continues to be in progress until a capture is made with final_capture = true for all purchase units within the order. | +| `APPROVED` | The customer approved the payment through the PayPal wallet or another form of guest or unbranded payment. For example, a card, bank account, or so on. | +| `VOIDED` | All purchase units in the order are voided. | +| `COMPLETED` | The intent of the Order was completed and a `payments` resource was created. A completed Order may have authorized a payment, captured an authorized payment, or in some cases, the payment may have been declined. Please verify the payment status under purchase_unitsArray.payments before proceeding with Order fulfillment. | +| `PAYER_ACTION_REQUIRED` | The order requires an action from the payer (e.g. 3DS authentication). Redirect the payer to the "rel":"payer-action" HATEOAS link returned as part of the response prior to authorizing or capturing the order. Some payment sources may not return a payer-action HATEOAS link (eg. MB WAY). For these payment sources the payer-action is managed by the scheme itself (eg. through SMS, email, in-app notification, etc). | diff --git a/doc/models/order-tracker-request.md b/doc/models/order-tracker-request.md index 5654811..4d6e5b3 100644 --- a/doc/models/order-tracker-request.md +++ b/doc/models/order-tracker-request.md @@ -12,10 +12,10 @@ The tracking details of an order. | Name | Type | Tags | Description | Getter | Setter | | --- | --- | --- | --- | --- | --- | | `trackingNumber` | `?string` | Optional | The tracking number for the shipment. This property supports Unicode.brand_nameandshipping_preferenceduring partner account setup, which overrides the request values.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
remove, copy, and move operations do not require a value. Since JSON Patch allows any type for value, the type property is not specified. | getValue(): | setValue( value): void |
-| `from` | `?string` | Optional | The JSON Pointer to the target document location from which to move the value. Required for the move operation. | getFrom(): ?string | setFrom(?string from): void |
+| `path` | `?string` | Optional | The JSON Pointer to the target document location at which to complete the operation. | getPath(): ?string | setPath(?string path): void |
+| `value` | `mixed` | Optional | The value to apply. The remove, copy, and move operations do not require a value. Since JSON Patch allows any type for value, the type property is not specified. | getValue(): | setValue( value): void |
+| `from` | `?string` | Optional | The JSON Pointer to the target document location from which to move the value. Required for the move operation. | getFrom(): ?string | setFrom(?string from): void |
## Example (as JSON)
diff --git a/doc/models/payee-base.md b/doc/models/payee-base.md
index 229226b..cf33fb7 100644
--- a/doc/models/payee-base.md
+++ b/doc/models/payee-base.md
@@ -11,7 +11,7 @@ The details for the merchant who receives the funds and fulfills the order. The
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
-| `emailAddress` | `?string` | Optional | The internationalized email address.Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance.| getCard(): ?CardRequest | setCard(?CardRequest card): void | +| `card` | [`?CardRequest`](../../doc/models/card-request.md) | Optional | The payment card to use to fund a payment. Can be a credit or debit card. Note: Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance. *PayPal offers a mechanism by which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this Integration Guide*. | getCard(): ?CardRequest | setCard(?CardRequest card): void | | `token` | [`?Token`](../../doc/models/token.md) | Optional | The tokenized payment source to fund a payment. | getToken(): ?Token | setToken(?Token token): void | | `paypal` | [`?PaypalWallet`](../../doc/models/paypal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PaypalWallet | setPaypal(?PaypalWallet paypal): void | | `bancontact` | [`?BancontactPaymentRequest`](../../doc/models/bancontact-payment-request.md) | Optional | Information needed to pay using Bancontact. | getBancontact(): ?BancontactPaymentRequest | setBancontact(?BancontactPaymentRequest bancontact): void | diff --git a/doc/models/payment-token-request-card.md b/doc/models/payment-token-request-card.md index a357d2a..566edcc 100644 --- a/doc/models/payment-token-request-card.md +++ b/doc/models/payment-token-request-card.md @@ -17,7 +17,6 @@ A Resource representing a request to vault a Card. | `securityCode` | `?string` | Optional | The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID. This parameter cannot be present in the request when `payment_initiator=MERCHANT`.
*PayPal offers a mechanism by which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this Integration Guide*.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: Partners and Marketplaces might configure+Customizes the payer experience during the approval process for payment with PayPal. Note: Partners and Marketplaces might configure brand_name and shipping_preference during partner account setup, which overrides the request values. ## Structure @@ -13,12 +13,13 @@ Customizes the payer experience during the approval process for payment with Pay | --- | --- | --- | --- | --- | --- | | `brandName` | `?string` | Optional | The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode.brand_nameandshipping_preferenceduring partner account setup, which overrides the request values.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: Partners and Marketplaces might configure| getExperienceContext(): ?PaypalWalletExperienceContext | setExperienceContext(?PaypalWalletExperienceContext experienceContext): void | +| `experienceContext` | [`?PaypalWalletExperienceContext`](../../doc/models/paypal-wallet-experience-context.md) | Optional | Customizes the payer experience during the approval process for payment with PayPal. Note: Partners and Marketplaces might configure brand_name and shipping_preference during partner account setup, which overrides the request values. | getExperienceContext(): ?PaypalWalletExperienceContext | setExperienceContext(?PaypalWalletExperienceContext experienceContext): void | | `billingAgreementId` | `?string` | Optional | The PayPal billing agreement ID. References an approved recurring payment for goods or services.brand_nameandshipping_preferenceduring partner account setup, which overrides the request values.
PAYPAL_prefix+(space)+merchant_descriptor+(space)+ soft_descriptorNote: The merchant descriptor is the descriptor of the merchant’s payment receiving preferences which can be seen by logging into the merchant account https://www.sandbox.paypal.com/businessprofile/settings/info/editThe
PAYPAL prefix uses 8 characters. Only the first 22 characters will be displayed in the statement. PAYPAL *.Janes Gift.800-123-1234.PAYPAL * Janes Gift 80.Note: If there are multiple purchase units, reference_id is required for each purchase unit.v2/checkout/orders/id/save.22 - len(PAYPAL * (8)) - len(Descriptor in Payment Receiving Preferences of Merchant account + 1)The PAYPAL prefix uses 8 characters.Note: This request is currently not supported for Partner use cases.+Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available, reauthorize a payment after its initial three-day honor period expires. You can reauthorize a payment only once from days four to 29. If 30 days have transpired since the date of the original authorization, you must create an authorized payment instead of reauthorizing the original authorized payment. A reauthorized payment itself has a new honor period of three days. You can reauthorize an authorized payment once. The allowed amount depends on context and geography, for example in US it is up to 115% of the original authorized amount, not to exceed an increase of $75 USD. Supports only the `amount` request parameter. Note: This request is currently not supported for Partner use cases. ## Structure diff --git a/doc/models/refund-incomplete-reason.md b/doc/models/refund-incomplete-reason.md index f1fb1a8..16791cd 100644 --- a/doc/models/refund-incomplete-reason.md +++ b/doc/models/refund-incomplete-reason.md @@ -9,7 +9,7 @@ The reason why the refund has the `PENDING` or `FAILED` status. ## Fields -| Name | -| --- | -| `ECHECK` | +| Name | Description | +| --- | --- | +| `ECHECK` | The customer's account is funded through an eCheck, which has not yet cleared. | diff --git a/doc/models/refund-request.md b/doc/models/refund-request.md index e463bab..89a23ea 100644 --- a/doc/models/refund-request.md +++ b/doc/models/refund-request.md @@ -1,7 +1,7 @@ # Refund Request -Refunds a captured payment, by ID. For a full refund, include an empty request body. For a partial refund, include an
amount object in the request body.
+Refunds a captured payment, by ID. For a full refund, include an empty request body. For a partial refund, include an amount object in the request body.
## Structure
diff --git a/doc/models/refund-status.md b/doc/models/refund-status.md
index 3a9da87..591842d 100644
--- a/doc/models/refund-status.md
+++ b/doc/models/refund-status.md
@@ -9,10 +9,10 @@ The status of the refund.
## Fields
-| Name |
-| --- |
-| `CANCELLED` |
-| `FAILED` |
-| `PENDING` |
-| `COMPLETED` |
+| Name | Description |
+| --- | --- |
+| `CANCELLED` | The refund was cancelled. |
+| `FAILED` | The refund could not be processed. |
+| `PENDING` | The refund is pending. For more information, see status_details.reason. |
+| `COMPLETED` | The funds for this transaction were debited to the customer's account. |
diff --git a/doc/models/refund.md b/doc/models/refund.md
index 9d24d11..8f0a287 100644
--- a/doc/models/refund.md
+++ b/doc/models/refund.md
@@ -22,8 +22,8 @@ The refund information.
| `sellerPayableBreakdown` | [`?SellerPayableBreakdown`](../../doc/models/seller-payable-breakdown.md) | Optional | The breakdown of the refund. | getSellerPayableBreakdown(): ?SellerPayableBreakdown | setSellerPayableBreakdown(?SellerPayableBreakdown sellerPayableBreakdown): void |
| `payer` | [`?PayeeBase`](../../doc/models/payee-base.md) | Optional | The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee. | getPayer(): ?PayeeBase | setPayer(?PayeeBase payer): void |
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links). | getLinks(): ?array | setLinks(?array links): void |
-| `createTime` | `?string` | Optional | The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.Note: The regular expression provides guidance but does not reject all invalid dates.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: Partners and Marketplaces might configure shipping_preference during partner account setup, which overrides the request values.
+Customizes the buyer experience during the approval process for payment with Venmo. Note: Partners and Marketplaces might configure shipping_preference during partner account setup, which overrides the request values.
## Structure
@@ -13,13 +13,22 @@ Customizes the buyer experience during the approval process for payment with Ven
| --- | --- | --- | --- | --- | --- |
| `brandName` | `?string` | Optional | The business name of the merchant. The pattern is defined by an external party and supports Unicode.Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: Partners and Marketplaces might configure shipping_preference during partner account setup, which overrides the request values. | getExperienceContext(): ?VenmoWalletExperienceContext | setExperienceContext(?VenmoWalletExperienceContext experienceContext): void |
+| `emailAddress` | `?string` | Optional | The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: For error handling and troubleshooting, see Orders v2 errors. - *+ * payment processing costs. For more information about processing payments, see checkout or multiparty + * checkout. Note: For error handling and troubleshooting, see Orders v2 errors. * * @param array $options Array with all options for search * * @return ApiResponse Response from the API call */ - public function ordersCreate(array $options): ApiResponse + public function createOrder(array $options): ApiResponse { $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/checkout/orders') ->auth('Oauth2') ->parameters( HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($options)->extract('body'), + HeaderParam::init('PayPal-Mock-Response', $options)->extract('paypalMockResponse'), HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'), HeaderParam::init('PayPal-Partner-Attribution-Id', $options)->extract('paypalPartnerAttributionId'), HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'), @@ -82,20 +79,20 @@ class OrdersController extends BaseController } /** - * Shows details for an order, by ID.
Note: For error handling and - * troubleshooting, see Orders v2 errors.+ * Shows details for an order, by ID. Note: For error handling and troubleshooting, see Orders v2 + * errors. * * @param array $options Array with all options for search * * @return ApiResponse Response from the API call */ - public function ordersGet(array $options): ApiResponse + public function getOrder(array $options): ApiResponse { $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/checkout/orders/{id}') ->auth('Oauth2') ->parameters( TemplateParam::init('id', $options)->extract('id'), + HeaderParam::init('PayPal-Mock-Response', $options)->extract('paypalMockResponse'), HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'), QueryParam::init('fields', $options)->extract('fields') ); @@ -119,56 +116,39 @@ class OrdersController extends BaseController /** * Updates an order with a `CREATED` or `APPROVED` status. You cannot update an order with the - * `COMPLETED` status.
\"/purchase_units/@reference_id=='default'/{attribute-or-
- * object}\". Merchants and partners can add Level 2 and 3 data to payments to reduce risk and
- * payment processing costs. For more information about processing payments, see checkout or multiparty checkout.
- * Note: For error handling and troubleshooting, see Orders v2 errors. - *Patchable attributes or objects: - *
| Attribute | Op | Notes |
|---|---|---|
inte
- * nt | replace | |
payer | replace, - * add | Using replace op for payer will replace the whole payer object
- * with the value sent in request. |
purchase_units | replace, - * add | |
purchase_units[].custom_id | replace, add, - * remove | |
purchase_units[].description | replace, add, - * remove | |
purchase_units[].payee.
- * email | replace | |
purchase_units[].shipping.
- * name | replace, add | |
purchase_units[].shipping.
- * email_address | replace, add | |
purchase_units[].shipping.
- * phone_number | replace, add | |
purchase_units[].shipping.
- * options | replace, add | |
purchase_units[].shipping.
- * address | replace, add | |
purchase_units[].shipping.
- * type | replace, add | |
purchase_units[].
- * soft_descriptor | replace, remove | |
purchase_units[].
- * amount | replace | |
purchase_units[].
- * items | replace, add, remove | |
purchase_units[].
- * invoice_id | replace, add, remove | |
purchase_units[].
- * payment_instruction | replace | |
purchase_units[].
- * payment_instruction.disbursement_mode | replace | By default,
- * disbursement_mode is INSTANT. |
purchase_units[].
- * payment_instruction.payee_receivable_fx_rate_id | replace, add, - * remove | |
purchase_units[].payment_instruction.
- * platform_fees | replace, add, remove | |
purchase_units[].
- * supplementary_data.airline | replace, add, - * remove | |
purchase_units[].supplementary_data.
- * card | replace, add, remove | |
application_context.
- * client_configuration | replace, add |
Note: For error handling and - * troubleshooting, see Orders v2 errors.+ * links in the create order response. Note: For error handling and troubleshooting, see Orders v2 + * errors. * * @param array $options Array with all options for search * * @return ApiResponse Response from the API call */ - public function ordersAuthorize(array $options): ApiResponse + public function authorizeOrder(array $options): ApiResponse { $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/checkout/orders/{id}/authorize') ->auth('Oauth2') ->parameters( TemplateParam::init('id', $options)->extract('id'), HeaderParam::init('Content-Type', 'application/json'), + HeaderParam::init('PayPal-Mock-Response', $options)->extract('paypalMockResponse'), HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'), HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'), HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'), @@ -325,21 +305,20 @@ class OrdersController extends BaseController * Captures payment for an order. To successfully capture payment for an order, the buyer must first * approve the order or a valid payment_source must be provided in the request. A buyer can approve the * order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the - * create order response.
Note: For error handling and troubleshooting, see - * Orders v2 - * errors.+ * create order response. Note: For error handling and troubleshooting, see Orders v2 errors. * * @param array $options Array with all options for search * * @return ApiResponse Response from the API call */ - public function ordersCapture(array $options): ApiResponse + public function captureOrder(array $options): ApiResponse { $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/checkout/orders/{id}/capture') ->auth('Oauth2') ->parameters( TemplateParam::init('id', $options)->extract('id'), HeaderParam::init('Content-Type', 'application/json'), + HeaderParam::init('PayPal-Mock-Response', $options)->extract('paypalMockResponse'), HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'), HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'), HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'), @@ -394,7 +373,7 @@ class OrdersController extends BaseController * * @return ApiResponse Response from the API call */ - public function ordersTrackCreate(array $options): ApiResponse + public function createOrderTracking(array $options): ApiResponse { $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/checkout/orders/{id}/track') ->auth('Oauth2') @@ -436,19 +415,15 @@ class OrdersController extends BaseController /** * Updates or cancels the tracking information for a PayPal order, by ID. Updatable attributes or - * objects: - *
| Attribute | Op | Notes |
|---|---|---|
items | replace | Using replace op for items will replace the
- * entire items object with the value sent in request.
- * |
notify_payer | replace, - * add | |
status | replace | Only patching status to - * CANCELLED is currently supported. |
Note: This request is currently not supported for Partner use cases. - *+ * authorization period, you can issue multiple re-authorizations after the honor period expires. If 30 + * days have transpired since the date of the original authorization, you must create an authorized + * payment instead of reauthorizing the original authorized payment. A reauthorized payment itself has + * a new honor period of three days. You can reauthorize an authorized payment from 4 to 29 days after + * the 3-day honor period. The allowed amount depends on context and geography, for example in US it is + * up to 115% of the original authorized amount, not to exceed an increase of $75 USD. Supports only + * the `amount` request parameter. Note: This request is currently not supported for Partner use cases. * * @param array $options Array with all options for search * * @return ApiResponse Response from the API call */ - public function authorizationsReauthorize(array $options): ApiResponse + public function reauthorizePayment(array $options): ApiResponse { $_reqBuilder = $this->requestBuilder( RequestMethod::POST, @@ -211,7 +211,7 @@ class PaymentsController extends BaseController * * @return ApiResponse Response from the API call */ - public function authorizationsVoid(array $options): ApiResponse + public function voidPayment(array $options): ApiResponse { $_reqBuilder = $this->requestBuilder( RequestMethod::POST, @@ -220,6 +220,7 @@ class PaymentsController extends BaseController ->auth('Oauth2') ->parameters( TemplateParam::init('authorization_id', $options)->extract('authorizationId'), + HeaderParam::init('PayPal-Mock-Response', $options)->extract('paypalMockResponse'), HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'), HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'), HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal') @@ -272,16 +273,18 @@ class PaymentsController extends BaseController /** * Shows details for a captured payment, by ID. * - * @param string $captureId The PayPal-generated ID for the captured payment for which to show - * details. + * @param array $options Array with all options for search * * @return ApiResponse Response from the API call */ - public function capturesGet(string $captureId): ApiResponse + public function getCapturedPayment(array $options): ApiResponse { $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/payments/captures/{capture_id}') ->auth('Oauth2') - ->parameters(TemplateParam::init('capture_id', $captureId)); + ->parameters( + TemplateParam::init('capture_id', $options)->extract('captureId'), + HeaderParam::init('PayPal-Mock-Response', $options)->extract('paypalMockResponse') + ); $_resHandler = $this->responseHandler() ->throwErrorOn( @@ -313,19 +316,20 @@ class PaymentsController extends BaseController /** * Refunds a captured payment, by ID. For a full refund, include an empty payload in the JSON request - * body. For a partial refund, include an
amount object in the JSON request body.
+ * body. For a partial refund, include an amount object in the JSON request body.
*
* @param array $options Array with all options for search
*
* @return ApiResponse Response from the API call
*/
- public function capturesRefund(array $options): ApiResponse
+ public function refundCapturedPayment(array $options): ApiResponse
{
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/payments/captures/{capture_id}/refund')
->auth('Oauth2')
->parameters(
TemplateParam::init('capture_id', $options)->extract('captureId'),
HeaderParam::init('Content-Type', 'application/json'),
+ HeaderParam::init('PayPal-Mock-Response', $options)->extract('paypalMockResponse'),
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
@@ -390,12 +394,13 @@ class PaymentsController extends BaseController
*
* @return ApiResponse Response from the API call
*/
- public function refundsGet(array $options): ApiResponse
+ public function getRefund(array $options): ApiResponse
{
$_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/payments/refunds/{refund_id}')
->auth('Oauth2')
->parameters(
TemplateParam::init('refund_id', $options)->extract('refundId'),
+ HeaderParam::init('PayPal-Mock-Response', $options)->extract('paypalMockResponse'),
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion')
);
diff --git a/src/Controllers/VaultController.php b/src/Controllers/VaultController.php
index 738c23a..b554c9f 100644
--- a/src/Controllers/VaultController.php
+++ b/src/Controllers/VaultController.php
@@ -32,14 +32,14 @@ class VaultController extends BaseController
*
* @return ApiResponse Response from the API call
*/
- public function paymentTokensCreate(array $options): ApiResponse
+ public function createPaymentToken(array $options): ApiResponse
{
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v3/vault/payment-tokens')
->auth('Oauth2')
->parameters(
- HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($options)->extract('body')
+ BodyParam::init($options)->extract('body'),
+ HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId')
);
$_resHandler = $this->responseHandler()
@@ -83,7 +83,7 @@ class VaultController extends BaseController
*
* @return ApiResponse Response from the API call
*/
- public function customerPaymentTokensGet(array $options): ApiResponse
+ public function listCustomerPaymentTokens(array $options): ApiResponse
{
$_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v3/vault/payment-tokens')
->auth('Oauth2')
@@ -120,7 +120,7 @@ class VaultController extends BaseController
*
* @return ApiResponse Response from the API call
*/
- public function paymentTokensGet(string $id): ApiResponse
+ public function getPaymentToken(string $id): ApiResponse
{
$_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v3/vault/payment-tokens/{id}')
->auth('Oauth2')
@@ -154,7 +154,7 @@ class VaultController extends BaseController
*
* @return ApiResponse Response from the API call
*/
- public function paymentTokensDelete(string $id): ApiResponse
+ public function deletePaymentToken(string $id): ApiResponse
{
$_reqBuilder = $this->requestBuilder(RequestMethod::DELETE, '/v3/vault/payment-tokens/{id}')
->auth('Oauth2')
@@ -186,14 +186,14 @@ class VaultController extends BaseController
*
* @return ApiResponse Response from the API call
*/
- public function setupTokensCreate(array $options): ApiResponse
+ public function createSetupToken(array $options): ApiResponse
{
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v3/vault/setup-tokens')
->auth('Oauth2')
->parameters(
- HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($options)->extract('body')
+ BodyParam::init($options)->extract('body'),
+ HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId')
);
$_resHandler = $this->responseHandler()
@@ -231,7 +231,7 @@ class VaultController extends BaseController
*
* @return ApiResponse Response from the API call
*/
- public function setupTokensGet(string $id): ApiResponse
+ public function getSetupToken(string $id): ApiResponse
{
$_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v3/vault/setup-tokens/{id}')
->auth('Oauth2')
diff --git a/src/Exceptions/ApiException.php b/src/Exceptions/ApiException.php
index f64896b..1e7062a 100644
--- a/src/Exceptions/ApiException.php
+++ b/src/Exceptions/ApiException.php
@@ -11,6 +11,7 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Exceptions;
use CoreInterfaces\Sdk\ExceptionInterface;
+use PaypalServerSdkLib\ApiHelper;
use PaypalServerSdkLib\Http\HttpResponse;
use PaypalServerSdkLib\Http\HttpRequest;
@@ -68,4 +69,20 @@ class ApiException extends \Exception implements ExceptionInterface
{
return !\is_null($this->response);
}
+
+ /**
+ * Converts the ApiException object to a human-readable string representation.
+ *
+ * @return string The string representation of the ApiException object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify(
+ 'ApiException',
+ [
+ 'statusCode' => $this->getCode(),
+ 'message' => $this->getMessage()
+ ]
+ );
+ }
}
diff --git a/src/Exceptions/ErrorException.php b/src/Exceptions/ErrorException.php
index 3559f28..f5fc96e 100644
--- a/src/Exceptions/ErrorException.php
+++ b/src/Exceptions/ErrorException.php
@@ -10,6 +10,8 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Exceptions;
+use PaypalServerSdkLib\ApiHelper;
+
/**
* The error details.
*/
@@ -172,4 +174,24 @@ class ErrorException extends ApiException
{
$this->links = $links;
}
+
+ /**
+ * Converts the ErrorException object to a human-readable string representation.
+ *
+ * @return string The string representation of the ErrorException object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify(
+ 'ErrorException',
+ [
+ 'name' => $this->name,
+ 'messageProperty' => $this->messageProperty,
+ 'debugId' => $this->debugId,
+ 'details' => $this->details,
+ 'links' => $this->links
+ ],
+ parent::__toString()
+ );
+ }
}
diff --git a/src/Exceptions/OAuthProviderException.php b/src/Exceptions/OAuthProviderException.php
index b689db4..3b474bb 100644
--- a/src/Exceptions/OAuthProviderException.php
+++ b/src/Exceptions/OAuthProviderException.php
@@ -10,6 +10,8 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Exceptions;
+use PaypalServerSdkLib\ApiHelper;
+
/**
* OAuth 2 Authorization endpoint exception.
*/
@@ -111,4 +113,18 @@ class OAuthProviderException extends ApiException
{
$this->errorUri = $errorUri;
}
+
+ /**
+ * Converts the OAuthProviderException object to a human-readable string representation.
+ *
+ * @return string The string representation of the OAuthProviderException object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify(
+ 'OAuthProviderException',
+ ['error' => $this->error, 'errorDescription' => $this->errorDescription, 'errorUri' => $this->errorUri],
+ parent::__toString()
+ );
+ }
}
diff --git a/src/Models/ActivityTimestamps.php b/src/Models/ActivityTimestamps.php
index 46bb7e1..9cf3692 100644
--- a/src/Models/ActivityTimestamps.php
+++ b/src/Models/ActivityTimestamps.php
@@ -10,6 +10,7 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
+use PaypalServerSdkLib\ApiHelper;
use stdClass;
/**
@@ -31,8 +32,8 @@ class ActivityTimestamps implements \JsonSerializable
/**
* Returns Create Time.
* The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.
- * 6). Seconds are required while fractional seconds are optional.Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getCreateTime(): ?string { @@ -42,8 +43,8 @@ class ActivityTimestamps implements \JsonSerializable /** * Sets Create Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps create_time */ @@ -55,8 +56,8 @@ class ActivityTimestamps implements \JsonSerializable /** * Returns Update Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getUpdateTime(): ?string { @@ -66,8 +67,8 @@ class ActivityTimestamps implements \JsonSerializable /** * Sets Update Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps update_time */ @@ -76,6 +77,19 @@ class ActivityTimestamps implements \JsonSerializable $this->updateTime = $updateTime; } + /** + * Converts the ActivityTimestamps object to a human-readable string representation. + * + * @return string The string representation of the ActivityTimestamps object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'ActivityTimestamps', + ['createTime' => $this->createTime, 'updateTime' => $this->updateTime] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/Address.php b/src/Models/Address.php index fde39c8..fd745f0 100644 --- a/src/Models/Address.php +++ b/src/Models/Address.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -124,8 +125,8 @@ class Address implements \JsonSerializable * Returns Admin Area 1. * The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 * subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. - * Value, by country, is:
Note: The country code for Great Britain is+ * region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. */ public function getCountryCode(): string { @@ -184,10 +184,9 @@ class Address implements \JsonSerializable /** * Sets Country Code. * The [2-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or - * region.GBand - * notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. * * @required * @maps country_code @@ -197,6 +196,26 @@ class Address implements \JsonSerializable $this->countryCode = $countryCode; } + /** + * Converts the Address object to a human-readable string representation. + * + * @return string The string representation of the Address object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'Address', + [ + 'addressLine1' => $this->addressLine1, + 'addressLine2' => $this->addressLine2, + 'adminArea2' => $this->adminArea2, + 'adminArea1' => $this->adminArea1, + 'postalCode' => $this->postalCode, + 'countryCode' => $this->countryCode + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/AddressDetails.php b/src/Models/AddressDetails.php deleted file mode 100644 index 483c886..0000000 --- a/src/Models/AddressDetails.php +++ /dev/null @@ -1,372 +0,0 @@ -countryCode = $countryCode; - } - - /** - * Returns Address Line 1. - * The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for - * data entry, and Compliance and Risk checks. This field needs to pass the full address. - */ - public function getAddressLine1(): ?string - { - return $this->addressLine1; - } - - /** - * Sets Address Line 1. - * The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for - * data entry, and Compliance and Risk checks. This field needs to pass the full address. - * - * @maps address_line_1 - */ - public function setAddressLine1(?string $addressLine1): void - { - $this->addressLine1 = $addressLine1; - } - - /** - * Returns Address Line 2. - * The second line of the address, for example, a suite or apartment number. - */ - public function getAddressLine2(): ?string - { - return $this->addressLine2; - } - - /** - * Sets Address Line 2. - * The second line of the address, for example, a suite or apartment number. - * - * @maps address_line_2 - */ - public function setAddressLine2(?string $addressLine2): void - { - $this->addressLine2 = $addressLine2; - } - - /** - * Returns Admin Area 2. - * A city, town, or village. Smaller than `admin_area_level_1`. - */ - public function getAdminArea2(): ?string - { - return $this->adminArea2; - } - - /** - * Sets Admin Area 2. - * A city, town, or village. Smaller than `admin_area_level_1`. - * - * @maps admin_area_2 - */ - public function setAdminArea2(?string $adminArea2): void - { - $this->adminArea2 = $adminArea2; - } - - /** - * Returns Admin Area 1. - * The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 - * subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. - * Value, by country, is:GBand - * notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is- */ - public function getCountryCode(): string - { - return $this->countryCode; - } - - /** - * Sets Country Code. - * The [2-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or - * region.GBand - * notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is- * - * @required - * @maps country_code - */ - public function setCountryCode(string $countryCode): void - { - $this->countryCode = $countryCode; - } - - /** - * Returns Name. - * The name of the party. - */ - public function getName(): ?Name - { - return $this->name; - } - - /** - * Sets Name. - * The name of the party. - * - * @maps name - */ - public function setName(?Name $name): void - { - $this->name = $name; - } - - /** - * Returns Id. - * The resource ID of the address. - */ - public function getId(): ?string - { - return $this->id; - } - - /** - * Sets Id. - * The resource ID of the address. - * - * @maps id - */ - public function setId(?string $id): void - { - $this->id = $id; - } - - /** - * Returns Company. - * The name of the company or business associated to the address. - */ - public function getCompany(): ?string - { - return $this->company; - } - - /** - * Sets Company. - * The name of the company or business associated to the address. - * - * @maps company - */ - public function setCompany(?string $company): void - { - $this->company = $company; - } - - /** - * Returns Phone. - * The phone number that can go on the mailing label with the address to track the shipping. Phone - * number is in E.164 format. - */ - public function getPhone(): ?string - { - return $this->phone; - } - - /** - * Sets Phone. - * The phone number that can go on the mailing label with the address to track the shipping. Phone - * number is in E.164 format. - * - * @maps phone - */ - public function setPhone(?string $phone): void - { - $this->phone = $phone; - } - - /** - * Returns Phone Number. - * The phone number, in its canonical international [E.164 numbering plan format](https://www.itu. - * int/rec/T-REC-E.164/en). - */ - public function getPhoneNumber(): ?Phone - { - return $this->phoneNumber; - } - - /** - * Sets Phone Number. - * The phone number, in its canonical international [E.164 numbering plan format](https://www.itu. - * int/rec/T-REC-E.164/en). - * - * @maps phone_number - */ - public function setPhoneNumber(?Phone $phoneNumber): void - { - $this->phoneNumber = $phoneNumber; - } - - /** - * Encode this object to JSON - * - * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields - * are set. (default: false) - * - * @return array|stdClass - */ - #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) - public function jsonSerialize(bool $asArrayWhenEmpty = false) - { - $json = []; - if (isset($this->addressLine1)) { - $json['address_line_1'] = $this->addressLine1; - } - if (isset($this->addressLine2)) { - $json['address_line_2'] = $this->addressLine2; - } - if (isset($this->adminArea2)) { - $json['admin_area_2'] = $this->adminArea2; - } - if (isset($this->adminArea1)) { - $json['admin_area_1'] = $this->adminArea1; - } - if (isset($this->postalCode)) { - $json['postal_code'] = $this->postalCode; - } - $json['country_code'] = $this->countryCode; - if (isset($this->name)) { - $json['name'] = $this->name; - } - if (isset($this->id)) { - $json['id'] = $this->id; - } - if (isset($this->company)) { - $json['company'] = $this->company; - } - if (isset($this->phone)) { - $json['phone'] = $this->phone; - } - if (isset($this->phoneNumber)) { - $json['phone_number'] = $this->phoneNumber; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/AmountBreakdown.php b/src/Models/AmountBreakdown.php index aabcf00..8a0a2ca 100644 --- a/src/Models/AmountBreakdown.php +++ b/src/Models/AmountBreakdown.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -193,6 +194,27 @@ class AmountBreakdown implements \JsonSerializable $this->discount = $discount; } + /** + * Converts the AmountBreakdown object to a human-readable string representation. + * + * @return string The string representation of the AmountBreakdown object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'AmountBreakdown', + [ + 'itemTotal' => $this->itemTotal, + 'shipping' => $this->shipping, + 'handling' => $this->handling, + 'taxTotal' => $this->taxTotal, + 'insurance' => $this->insurance, + 'shippingDiscount' => $this->shippingDiscount, + 'discount' => $this->discount + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/AmountWithBreakdown.php b/src/Models/AmountWithBreakdown.php index dbed4a4..60da17b 100644 --- a/src/Models/AmountWithBreakdown.php +++ b/src/Models/AmountWithBreakdown.php @@ -10,15 +10,15 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** * The total order amount with an optional breakdown that provides details, such as the total item - * amount, total tax amount, shipping, handling, insurance, and discounts, if any.GBand - * notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. */ public function getCountryCode(): ?string { @@ -325,10 +362,9 @@ class ApplePayCardResponse implements \JsonSerializable /** * Sets Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. * * @maps country_code */ @@ -337,6 +373,33 @@ class ApplePayCardResponse implements \JsonSerializable $this->countryCode = $countryCode; } + /** + * Converts the ApplePayCardResponse object to a human-readable string representation. + * + * @return string The string representation of the ApplePayCardResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'ApplePayCardResponse', + [ + 'name' => $this->name, + 'lastDigits' => $this->lastDigits, + 'brand' => $this->brand, + 'availableNetworks' => $this->availableNetworks, + 'type' => $this->type, + 'authenticationResult' => $this->authenticationResult, + 'attributes' => $this->attributes, + 'fromRequest' => $this->fromRequest, + 'expiry' => $this->expiry, + 'binDetails' => $this->binDetails, + 'storedCredential' => $this->storedCredential, + 'billingAddress' => $this->billingAddress, + 'countryCode' => $this->countryCode + ] + ); + } + /** * Encode this object to JSON * @@ -356,13 +419,13 @@ class ApplePayCardResponse implements \JsonSerializable $json['last_digits'] = $this->lastDigits; } if (isset($this->brand)) { - $json['brand'] = CardBrand::checkValue($this->brand); + $json['brand'] = $this->brand; } if (isset($this->availableNetworks)) { - $json['available_networks'] = CardBrand::checkValue($this->availableNetworks); + $json['available_networks'] = $this->availableNetworks; } if (isset($this->type)) { - $json['type'] = CardType::checkValue($this->type); + $json['type'] = $this->type; } if (isset($this->authenticationResult)) { $json['authentication_result'] = $this->authenticationResult; @@ -379,6 +442,9 @@ class ApplePayCardResponse implements \JsonSerializable if (isset($this->binDetails)) { $json['bin_details'] = $this->binDetails; } + if (isset($this->storedCredential)) { + $json['stored_credential'] = $this->storedCredential; + } if (isset($this->billingAddress)) { $json['billing_address'] = $this->billingAddress; } diff --git a/src/Models/ApplePayDecryptedTokenData.php b/src/Models/ApplePayDecryptedTokenData.php index 90b7cc6..5565f8d 100644 --- a/src/Models/ApplePayDecryptedTokenData.php +++ b/src/Models/ApplePayDecryptedTokenData.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -155,6 +156,25 @@ class ApplePayDecryptedTokenData implements \JsonSerializable $this->paymentData = $paymentData; } + /** + * Converts the ApplePayDecryptedTokenData object to a human-readable string representation. + * + * @return string The string representation of the ApplePayDecryptedTokenData object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'ApplePayDecryptedTokenData', + [ + 'transactionAmount' => $this->transactionAmount, + 'tokenizedCard' => $this->tokenizedCard, + 'deviceManufacturerId' => $this->deviceManufacturerId, + 'paymentDataType' => $this->paymentDataType, + 'paymentData' => $this->paymentData + ] + ); + } + /** * Encode this object to JSON * @@ -175,7 +195,7 @@ class ApplePayDecryptedTokenData implements \JsonSerializable $json['device_manufacturer_id'] = $this->deviceManufacturerId; } if (isset($this->paymentDataType)) { - $json['payment_data_type'] = ApplePayPaymentDataType::checkValue($this->paymentDataType); + $json['payment_data_type'] = $this->paymentDataType; } if (isset($this->paymentData)) { $json['payment_data'] = $this->paymentData; diff --git a/src/Models/ApplePayPaymentData.php b/src/Models/ApplePayPaymentData.php index 35d95bd..61e0869 100644 --- a/src/Models/ApplePayPaymentData.php +++ b/src/Models/ApplePayPaymentData.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -123,6 +124,24 @@ class ApplePayPaymentData implements \JsonSerializable $this->pin = $pin; } + /** + * Converts the ApplePayPaymentData object to a human-readable string representation. + * + * @return string The string representation of the ApplePayPaymentData object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'ApplePayPaymentData', + [ + 'cryptogram' => $this->cryptogram, + 'eciIndicator' => $this->eciIndicator, + 'emvData' => $this->emvData, + 'pin' => $this->pin + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/ApplePayPaymentDataType.php b/src/Models/ApplePayPaymentDataType.php index 08dabae..f638296 100644 --- a/src/Models/ApplePayPaymentDataType.php +++ b/src/Models/ApplePayPaymentDataType.php @@ -10,37 +10,21 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * Indicates the type of payment data passed, in case of Non China the payment data is 3DSECURE and for * China it is EMV. */ class ApplePayPaymentDataType { + /** + * The card was authenticated using 3D Secure (3DS) authentication scheme. While using this value make + * sure to populate cryptogram and eci_indicator as part of payment data.. + */ public const ENUM_3DSECURE = '3DSECURE'; - public const EMV = 'EMV'; - - private const _ALL_VALUES = [self::ENUM_3DSECURE, self::EMV]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * The card was authenticated using EMV method, which is applicable for China. While using this value + * make sure to pass emv_data and pin as part of payment data. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for ApplePayPaymentDataType."); - } + public const EMV = 'EMV'; } diff --git a/src/Models/ApplePayPaymentObject.php b/src/Models/ApplePayPaymentObject.php index eeab2bf..1e59481 100644 --- a/src/Models/ApplePayPaymentObject.php +++ b/src/Models/ApplePayPaymentObject.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -52,6 +53,11 @@ class ApplePayPaymentObject implements \JsonSerializable */ private $attributes; + /** + * @var CardStoredCredential|null + */ + private $storedCredential; + /** * Returns Id. * ApplePay transaction identifier, this will be the unique identifier for this transaction provided by @@ -118,10 +124,9 @@ class ApplePayPaymentObject implements \JsonSerializable /** * Returns Email Address. - * The internationalized email address.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. */ public function getEmailAddress(): ?string { @@ -130,10 +135,9 @@ class ApplePayPaymentObject implements \JsonSerializable /** * Sets Email Address. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. * * @maps email_address */ @@ -204,6 +208,60 @@ class ApplePayPaymentObject implements \JsonSerializable $this->attributes = $attributes; } + /** + * Returns Stored Credential. + * Provides additional details to process a payment using a `card` that has been stored or is intended + * to be stored (also referred to as stored_credential or card-on-file). Parameter compatibility: + * `payment_type=ONE_TIME` is compatible only with `payment_initiator=CUSTOMER`. `usage=FIRST` is + * compatible only with `payment_initiator=CUSTOMER`. `previous_transaction_reference` or + * `previous_network_transaction_reference` is compatible only with `payment_initiator=MERCHANT`. Only + * one of the parameters - `previous_transaction_reference` and + * `previous_network_transaction_reference` - can be present in the request. + */ + public function getStoredCredential(): ?CardStoredCredential + { + return $this->storedCredential; + } + + /** + * Sets Stored Credential. + * Provides additional details to process a payment using a `card` that has been stored or is intended + * to be stored (also referred to as stored_credential or card-on-file). Parameter compatibility: + * `payment_type=ONE_TIME` is compatible only with `payment_initiator=CUSTOMER`. `usage=FIRST` is + * compatible only with `payment_initiator=CUSTOMER`. `previous_transaction_reference` or + * `previous_network_transaction_reference` is compatible only with `payment_initiator=MERCHANT`. Only + * one of the parameters - `previous_transaction_reference` and + * `previous_network_transaction_reference` - can be present in the request. + * + * @maps stored_credential + */ + public function setStoredCredential(?CardStoredCredential $storedCredential): void + { + $this->storedCredential = $storedCredential; + } + + /** + * Converts the ApplePayPaymentObject object to a human-readable string representation. + * + * @return string The string representation of the ApplePayPaymentObject object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'ApplePayPaymentObject', + [ + 'id' => $this->id, + 'token' => $this->token, + 'name' => $this->name, + 'emailAddress' => $this->emailAddress, + 'phoneNumber' => $this->phoneNumber, + 'card' => $this->card, + 'attributes' => $this->attributes, + 'storedCredential' => $this->storedCredential + ] + ); + } + /** * Encode this object to JSON * @@ -217,25 +275,28 @@ class ApplePayPaymentObject implements \JsonSerializable { $json = []; if (isset($this->id)) { - $json['id'] = $this->id; + $json['id'] = $this->id; } if (isset($this->token)) { - $json['token'] = $this->token; + $json['token'] = $this->token; } if (isset($this->name)) { - $json['name'] = $this->name; + $json['name'] = $this->name; } if (isset($this->emailAddress)) { - $json['email_address'] = $this->emailAddress; + $json['email_address'] = $this->emailAddress; } if (isset($this->phoneNumber)) { - $json['phone_number'] = $this->phoneNumber; + $json['phone_number'] = $this->phoneNumber; } if (isset($this->card)) { - $json['card'] = $this->card; + $json['card'] = $this->card; } if (isset($this->attributes)) { - $json['attributes'] = $this->attributes; + $json['attributes'] = $this->attributes; + } + if (isset($this->storedCredential)) { + $json['stored_credential'] = $this->storedCredential; } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; diff --git a/src/Models/ApplePayPaymentToken.php b/src/Models/ApplePayPaymentToken.php index 53e330b..0b5b7d9 100644 --- a/src/Models/ApplePayPaymentToken.php +++ b/src/Models/ApplePayPaymentToken.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -42,6 +43,16 @@ class ApplePayPaymentToken implements \JsonSerializable $this->card = $card; } + /** + * Converts the ApplePayPaymentToken object to a human-readable string representation. + * + * @return string The string representation of the ApplePayPaymentToken object. + */ + public function __toString(): string + { + return ApiHelper::stringify('ApplePayPaymentToken', ['card' => $this->card]); + } + /** * Encode this object to JSON * diff --git a/src/Models/ApplePayRequest.php b/src/Models/ApplePayRequest.php index 1645509..80a4f48 100644 --- a/src/Models/ApplePayRequest.php +++ b/src/Models/ApplePayRequest.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -101,10 +102,9 @@ class ApplePayRequest implements \JsonSerializable /** * Returns Email Address. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. */ public function getEmailAddress(): ?string { @@ -113,10 +113,9 @@ class ApplePayRequest implements \JsonSerializable /** * Sets Email Address. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. * * @maps email_address */ @@ -170,13 +169,12 @@ class ApplePayRequest implements \JsonSerializable /** * Returns Stored Credential. * Provides additional details to process a payment using a `card` that has been stored or is intended - * to be stored (also referred to as stored_credential or card-on-file).@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getExpirationTime(): ?string { @@ -257,8 +258,8 @@ class Authorization implements \JsonSerializable /** * Sets Expiration Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps expiration_time */ @@ -294,8 +295,8 @@ class Authorization implements \JsonSerializable /** * Returns Create Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getCreateTime(): ?string { @@ -305,8 +306,8 @@ class Authorization implements \JsonSerializable /** * Sets Create Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps create_time */ @@ -318,8 +319,8 @@ class Authorization implements \JsonSerializable /** * Returns Update Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getUpdateTime(): ?string { @@ -329,8 +330,8 @@ class Authorization implements \JsonSerializable /** * Sets Update Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps update_time */ @@ -339,6 +340,32 @@ class Authorization implements \JsonSerializable $this->updateTime = $updateTime; } + /** + * Converts the Authorization object to a human-readable string representation. + * + * @return string The string representation of the Authorization object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'Authorization', + [ + 'status' => $this->status, + 'statusDetails' => $this->statusDetails, + 'id' => $this->id, + 'amount' => $this->amount, + 'invoiceId' => $this->invoiceId, + 'customId' => $this->customId, + 'networkTransactionReference' => $this->networkTransactionReference, + 'sellerProtection' => $this->sellerProtection, + 'expirationTime' => $this->expirationTime, + 'links' => $this->links, + 'createTime' => $this->createTime, + 'updateTime' => $this->updateTime + ] + ); + } + /** * Encode this object to JSON * @@ -352,7 +379,7 @@ class Authorization implements \JsonSerializable { $json = []; if (isset($this->status)) { - $json['status'] = AuthorizationStatus::checkValue($this->status); + $json['status'] = $this->status; } if (isset($this->statusDetails)) { $json['status_details'] = $this->statusDetails; diff --git a/src/Models/AuthorizationIncompleteReason.php b/src/Models/AuthorizationIncompleteReason.php index fbee5dc..b264d0c 100644 --- a/src/Models/AuthorizationIncompleteReason.php +++ b/src/Models/AuthorizationIncompleteReason.php @@ -10,36 +10,18 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The reason why the authorized status is `PENDING`. */ class AuthorizationIncompleteReason { + /** + * Authorization is pending manual review. + */ public const PENDING_REVIEW = 'PENDING_REVIEW'; - public const DECLINED_BY_RISK_FRAUD_FILTERS = 'DECLINED_BY_RISK_FRAUD_FILTERS'; - - private const _ALL_VALUES = [self::PENDING_REVIEW, self::DECLINED_BY_RISK_FRAUD_FILTERS]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * Risk Filter set by the payee failed for the transaction. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for AuthorizationIncompleteReason."); - } + public const DECLINED_BY_RISK_FRAUD_FILTERS = 'DECLINED_BY_RISK_FRAUD_FILTERS'; } diff --git a/src/Models/AuthorizationStatus.php b/src/Models/AuthorizationStatus.php index 160a2c5..ab71bd9 100644 --- a/src/Models/AuthorizationStatus.php +++ b/src/Models/AuthorizationStatus.php @@ -10,45 +10,41 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The status for the authorized payment. */ class AuthorizationStatus { + /** + * The authorized payment is created. No captured payments have been made for this authorized payment. + */ public const CREATED = 'CREATED'; + /** + * The authorized payment has one or more captures against it. The sum of these captured payments is + * greater than the amount of the original authorized payment. + */ public const CAPTURED = 'CAPTURED'; + /** + * PayPal cannot authorize funds for this authorized payment. + */ public const DENIED = 'DENIED'; + /** + * A captured payment was made for the authorized payment for an amount that is less than the amount of + * the original authorized payment. + */ public const PARTIALLY_CAPTURED = 'PARTIALLY_CAPTURED'; + /** + * The authorized payment was voided. No more captured payments can be made against this authorized + * payment. + */ public const VOIDED = 'VOIDED'; - public const PENDING = 'PENDING'; - - private const _ALL_VALUES = - [self::CREATED, self::CAPTURED, self::DENIED, self::PARTIALLY_CAPTURED, self::VOIDED, self::PENDING]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * The created authorization is in pending state. For more information, see status.details. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for AuthorizationStatus."); - } + public const PENDING = 'PENDING'; } diff --git a/src/Models/AuthorizationStatusDetails.php b/src/Models/AuthorizationStatusDetails.php index b47f36a..92303b6 100644 --- a/src/Models/AuthorizationStatusDetails.php +++ b/src/Models/AuthorizationStatusDetails.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -42,6 +43,16 @@ class AuthorizationStatusDetails implements \JsonSerializable $this->reason = $reason; } + /** + * Converts the AuthorizationStatusDetails object to a human-readable string representation. + * + * @return string The string representation of the AuthorizationStatusDetails object. + */ + public function __toString(): string + { + return ApiHelper::stringify('AuthorizationStatusDetails', ['reason' => $this->reason]); + } + /** * Encode this object to JSON * @@ -55,7 +66,7 @@ class AuthorizationStatusDetails implements \JsonSerializable { $json = []; if (isset($this->reason)) { - $json['reason'] = AuthorizationIncompleteReason::checkValue($this->reason); + $json['reason'] = $this->reason; } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; diff --git a/src/Models/AuthorizationStatusWithDetails.php b/src/Models/AuthorizationStatusWithDetails.php index 5497244..4a0fc09 100644 --- a/src/Models/AuthorizationStatusWithDetails.php +++ b/src/Models/AuthorizationStatusWithDetails.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -67,6 +68,19 @@ class AuthorizationStatusWithDetails implements \JsonSerializable $this->statusDetails = $statusDetails; } + /** + * Converts the AuthorizationStatusWithDetails object to a human-readable string representation. + * + * @return string The string representation of the AuthorizationStatusWithDetails object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'AuthorizationStatusWithDetails', + ['status' => $this->status, 'statusDetails' => $this->statusDetails] + ); + } + /** * Encode this object to JSON * @@ -80,7 +94,7 @@ class AuthorizationStatusWithDetails implements \JsonSerializable { $json = []; if (isset($this->status)) { - $json['status'] = AuthorizationStatus::checkValue($this->status); + $json['status'] = $this->status; } if (isset($this->statusDetails)) { $json['status_details'] = $this->statusDetails; diff --git a/src/Models/AuthorizationWithAdditionalData.php b/src/Models/AuthorizationWithAdditionalData.php index 120d7e8..d9a619b 100644 --- a/src/Models/AuthorizationWithAdditionalData.php +++ b/src/Models/AuthorizationWithAdditionalData.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -252,8 +253,8 @@ class AuthorizationWithAdditionalData implements \JsonSerializable /** * Returns Expiration Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getExpirationTime(): ?string { @@ -263,8 +264,8 @@ class AuthorizationWithAdditionalData implements \JsonSerializable /** * Sets Expiration Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps expiration_time */ @@ -300,8 +301,8 @@ class AuthorizationWithAdditionalData implements \JsonSerializable /** * Returns Create Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getCreateTime(): ?string { @@ -311,8 +312,8 @@ class AuthorizationWithAdditionalData implements \JsonSerializable /** * Sets Create Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps create_time */ @@ -324,8 +325,8 @@ class AuthorizationWithAdditionalData implements \JsonSerializable /** * Returns Update Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getUpdateTime(): ?string { @@ -335,8 +336,8 @@ class AuthorizationWithAdditionalData implements \JsonSerializable /** * Sets Update Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps update_time */ @@ -365,6 +366,33 @@ class AuthorizationWithAdditionalData implements \JsonSerializable $this->processorResponse = $processorResponse; } + /** + * Converts the AuthorizationWithAdditionalData object to a human-readable string representation. + * + * @return string The string representation of the AuthorizationWithAdditionalData object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'AuthorizationWithAdditionalData', + [ + 'status' => $this->status, + 'statusDetails' => $this->statusDetails, + 'id' => $this->id, + 'amount' => $this->amount, + 'invoiceId' => $this->invoiceId, + 'customId' => $this->customId, + 'networkTransactionReference' => $this->networkTransactionReference, + 'sellerProtection' => $this->sellerProtection, + 'expirationTime' => $this->expirationTime, + 'links' => $this->links, + 'createTime' => $this->createTime, + 'updateTime' => $this->updateTime, + 'processorResponse' => $this->processorResponse + ] + ); + } + /** * Encode this object to JSON * @@ -378,7 +406,7 @@ class AuthorizationWithAdditionalData implements \JsonSerializable { $json = []; if (isset($this->status)) { - $json['status'] = AuthorizationStatus::checkValue($this->status); + $json['status'] = $this->status; } if (isset($this->statusDetails)) { $json['status_details'] = $this->statusDetails; diff --git a/src/Models/AvsCode.php b/src/Models/AvsCode.php index 9344573..00ecabf 100644 --- a/src/Models/AvsCode.php +++ b/src/Models/AvsCode.php @@ -10,105 +10,141 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The address verification code for Visa, Discover, Mastercard, or American Express transactions. */ class AvsCode { - public const A = 'A'; - - public const B = 'B'; - - public const C = 'C'; - - public const D = 'D'; - - public const E = 'E'; - - public const F = 'F'; - - public const G = 'G'; - - public const I = 'I'; - - public const M = 'M'; - - public const N = 'N'; - - public const P = 'P'; - - public const R = 'R'; - - public const S = 'S'; - - public const U = 'U'; - - public const W = 'W'; - - public const X = 'X'; - - public const Y = 'Y'; - - public const Z = 'Z'; - - public const NULL = 'Null'; - - public const ENUM_0 = '0'; - - public const ENUM_1 = '1'; - - public const ENUM_2 = '2'; - - public const ENUM_3 = '3'; - - public const ENUM_4 = '4'; - - private const _ALL_VALUES = [ - self::A, - self::B, - self::C, - self::D, - self::E, - self::F, - self::G, - self::I, - self::M, - self::N, - self::P, - self::R, - self::S, - self::U, - self::W, - self::X, - self::Y, - self::Z, - self::NULL, - self::ENUM_0, - self::ENUM_1, - self::ENUM_2, - self::ENUM_3, - self::ENUM_4 - ]; + /** + * For Visa, Mastercard, or Discover transactions, the address matches but the zip code does not match. + * For American Express transactions, the card holder address is correct. + */ + public const AVS_A = 'A'; /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * For Visa, Mastercard, or Discover transactions, the address matches. International A. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for AvsCode."); - } + public const AVS_B = 'B'; + + /** + * For Visa, Mastercard, or Discover transactions, no values match. International N. + */ + public const AVS_C = 'C'; + + /** + * For Visa, Mastercard, or Discover transactions, the address and postal code match. International X. + */ + public const AVS_D = 'D'; + + /** + * For Visa, Mastercard, or Discover transactions, not allowed for Internet or phone transactions. For + * American Express card holder, the name is incorrect but the address and postal code match. + */ + public const AVS_E = 'E'; + + /** + * For Visa, Mastercard, or Discover transactions, the address and postal code match. UK-specific X. + * For American Express card holder, the name is incorrect but the address matches. + */ + public const AVS_F = 'F'; + + /** + * For Visa, Mastercard, or Discover transactions, global is unavailable. Nothing matches. + */ + public const AVS_G = 'G'; + + /** + * For Visa, Mastercard, or Discover transactions, international is unavailable. Not applicable. + */ + public const AVS_I = 'I'; + + /** + * For Visa, Mastercard, or Discover transactions, the address and postal code match. For American + * Express card holder, the name, address, and postal code match. + */ + public const AVS_M = 'M'; + + /** + * For Visa, Mastercard, or Discover transactions, nothing matches. For American Express card holder, + * the address and postal code are both incorrect. + */ + public const AVS_N = 'N'; + + /** + * For Visa, Mastercard, or Discover transactions, postal international Z. Postal code only. + */ + public const AVS_P = 'P'; + + /** + * For Visa, Mastercard, or Discover transactions, re-try the request. For American Express, the system + * is unavailable. + */ + public const AVS_R = 'R'; + + /** + * For Visa, Mastercard, Discover, or American Express, the service is not supported. + */ + public const AVS_S = 'S'; + + /** + * For Visa, Mastercard, or Discover transactions, the service is unavailable. For American Express, + * information is not available. For Maestro, the address is not checked or the acquirer had no + * response. The service is not available. + */ + public const AVS_U = 'U'; + + /** + * For Visa, Mastercard, or Discover transactions, whole ZIP code. For American Express, the card + * holder name, address, and postal code are all incorrect. + */ + public const AVS_W = 'W'; + + /** + * For Visa, Mastercard, or Discover transactions, exact match of the address and the nine-digit ZIP + * code. For American Express, the card holder name, address, and postal code are all incorrect. + */ + public const AVS_X = 'X'; + + /** + * For Visa, Mastercard, or Discover transactions, the address and five-digit ZIP code match. For + * American Express, the card holder address and postal code are both correct. + */ + public const AVS_Y = 'Y'; + + /** + * For Visa, Mastercard, or Discover transactions, the five-digit ZIP code matches but no address. For + * American Express, only the card holder postal code is correct. + */ + public const AVS_Z = 'Z'; + + /** + * For Maestro, no AVS response was obtained. + */ + public const AVS_NULL = 'Null'; + + /** + * For Maestro, all address information matches. + */ + public const AVS_0 = '0'; + + /** + * For Maestro, none of the address information matches. + */ + public const AVS_1 = '1'; + + /** + * For Maestro, part of the address information matches. + */ + public const AVS_2 = '2'; + + /** + * For Maestro, the merchant did not provide AVS information. It was not processed. + */ + public const AVS_3 = '3'; + + /** + * For Maestro, the address was not checked or the acquirer had no response. The service is not + * available. + */ + public const AVS_4 = '4'; } diff --git a/src/Models/BancontactPaymentObject.php b/src/Models/BancontactPaymentObject.php index f3947e5..0ec5f87 100644 --- a/src/Models/BancontactPaymentObject.php +++ b/src/Models/BancontactPaymentObject.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -65,10 +66,9 @@ class BancontactPaymentObject implements \JsonSerializable /** * Returns Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. */ public function getCountryCode(): ?string { @@ -78,10 +78,9 @@ class BancontactPaymentObject implements \JsonSerializable /** * Sets Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. * * @maps country_code */ @@ -152,6 +151,25 @@ class BancontactPaymentObject implements \JsonSerializable $this->cardLastDigits = $cardLastDigits; } + /** + * Converts the BancontactPaymentObject object to a human-readable string representation. + * + * @return string The string representation of the BancontactPaymentObject object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'BancontactPaymentObject', + [ + 'name' => $this->name, + 'countryCode' => $this->countryCode, + 'bic' => $this->bic, + 'ibanLastChars' => $this->ibanLastChars, + 'cardLastDigits' => $this->cardLastDigits + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/BancontactPaymentRequest.php b/src/Models/BancontactPaymentRequest.php index 5f54a42..0704187 100644 --- a/src/Models/BancontactPaymentRequest.php +++ b/src/Models/BancontactPaymentRequest.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -66,10 +67,9 @@ class BancontactPaymentRequest implements \JsonSerializable /** * Returns Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. */ public function getCountryCode(): string { @@ -79,10 +79,9 @@ class BancontactPaymentRequest implements \JsonSerializable /** * Sets Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. * * @required * @maps country_code @@ -112,6 +111,23 @@ class BancontactPaymentRequest implements \JsonSerializable $this->experienceContext = $experienceContext; } + /** + * Converts the BancontactPaymentRequest object to a human-readable string representation. + * + * @return string The string representation of the BancontactPaymentRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'BancontactPaymentRequest', + [ + 'name' => $this->name, + 'countryCode' => $this->countryCode, + 'experienceContext' => $this->experienceContext + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/BillingCycle.php b/src/Models/BillingCycle.php new file mode 100644 index 0000000..50d893f --- /dev/null +++ b/src/Models/BillingCycle.php @@ -0,0 +1,258 @@ +tenureType = $tenureType; + } + + /** + * Returns Tenure Type. + * The tenure type of the billing cycle identifies if the billing cycle is a trial(free or discounted) + * or regular billing cycle. + */ + public function getTenureType(): string + { + return $this->tenureType; + } + + /** + * Sets Tenure Type. + * The tenure type of the billing cycle identifies if the billing cycle is a trial(free or discounted) + * or regular billing cycle. + * + * @required + * @maps tenure_type + */ + public function setTenureType(string $tenureType): void + { + $this->tenureType = $tenureType; + } + + /** + * Returns Pricing Scheme. + * The pricing scheme details. + */ + public function getPricingScheme(): ?PricingScheme + { + return $this->pricingScheme; + } + + /** + * Sets Pricing Scheme. + * The pricing scheme details. + * + * @maps pricing_scheme + */ + public function setPricingScheme(?PricingScheme $pricingScheme): void + { + $this->pricingScheme = $pricingScheme; + } + + /** + * Returns Frequency. + * The frequency details for this billing cycle. + * + * @return mixed + */ + public function getFrequency() + { + return $this->frequency; + } + + /** + * Sets Frequency. + * The frequency details for this billing cycle. + * + * @maps frequency + * + * @param mixed $frequency + */ + public function setFrequency($frequency): void + { + $this->frequency = $frequency; + } + + /** + * Returns Total Cycles. + * The number of times this billing cycle gets executed. Trial billing cycles can only be executed a + * finite number of times (value between 1 and 999 for total_cycles). Regular billing cycles can be + * executed infinite times (value of 0 for total_cycles) or a finite number of times (value between 1 + * and 999 for total_cycles). + */ + public function getTotalCycles(): ?int + { + return $this->totalCycles; + } + + /** + * Sets Total Cycles. + * The number of times this billing cycle gets executed. Trial billing cycles can only be executed a + * finite number of times (value between 1 and 999 for total_cycles). Regular billing cycles can be + * executed infinite times (value of 0 for total_cycles) or a finite number of times (value between 1 + * and 999 for total_cycles). + * + * @maps total_cycles + */ + public function setTotalCycles(?int $totalCycles): void + { + $this->totalCycles = $totalCycles; + } + + /** + * Returns Sequence. + * The order in which this cycle is to run among other billing cycles. For example, a trial billing + * cycle has a `sequence` of `1` while a regular billing cycle has a `sequence` of `2`, so that trial + * cycle runs before the regular cycle. + */ + public function getSequence(): ?int + { + return $this->sequence; + } + + /** + * Sets Sequence. + * The order in which this cycle is to run among other billing cycles. For example, a trial billing + * cycle has a `sequence` of `1` while a regular billing cycle has a `sequence` of `2`, so that trial + * cycle runs before the regular cycle. + * + * @maps sequence + */ + public function setSequence(?int $sequence): void + { + $this->sequence = $sequence; + } + + /** + * Returns Start Date. + * The stand-alone date, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section- + * 5.6). To represent special legal values, such as a date of birth, you should use dates with no + * associated time or time-zone data. Whenever possible, use the standard `date_time` type. This + * regular expression does not validate all dates. For example, February 31 is valid and nothing is + * known about leap years. + */ + public function getStartDate(): ?string + { + return $this->startDate; + } + + /** + * Sets Start Date. + * The stand-alone date, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section- + * 5.6). To represent special legal values, such as a date of birth, you should use dates with no + * associated time or time-zone data. Whenever possible, use the standard `date_time` type. This + * regular expression does not validate all dates. For example, February 31 is valid and nothing is + * known about leap years. + * + * @maps start_date + */ + public function setStartDate(?string $startDate): void + { + $this->startDate = $startDate; + } + + /** + * Converts the BillingCycle object to a human-readable string representation. + * + * @return string The string representation of the BillingCycle object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'BillingCycle', + [ + 'tenureType' => $this->tenureType, + 'pricingScheme' => $this->pricingScheme, + 'frequency' => $this->frequency, + 'totalCycles' => $this->totalCycles, + 'sequence' => $this->sequence, + 'startDate' => $this->startDate + ] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + $json['tenure_type'] = $this->tenureType; + if (isset($this->pricingScheme)) { + $json['pricing_scheme'] = $this->pricingScheme; + } + if (isset($this->frequency)) { + $json['frequency'] = $this->frequency; + } + if (isset($this->totalCycles)) { + $json['total_cycles'] = $this->totalCycles; + } + if (isset($this->sequence)) { + $json['sequence'] = $this->sequence; + } + if (isset($this->startDate)) { + $json['start_date'] = $this->startDate; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/BinDetails.php b/src/Models/BinDetails.php index 00cdeb4..e10afec 100644 --- a/src/Models/BinDetails.php +++ b/src/Models/BinDetails.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -82,10 +83,9 @@ class BinDetails implements \JsonSerializable /** * Returns Bin Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. */ public function getBinCountryCode(): ?string { @@ -95,10 +95,9 @@ class BinDetails implements \JsonSerializable /** * Sets Bin Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. * * @maps bin_country_code */ @@ -133,6 +132,24 @@ class BinDetails implements \JsonSerializable $this->products = $products; } + /** + * Converts the BinDetails object to a human-readable string representation. + * + * @return string The string representation of the BinDetails object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'BinDetails', + [ + 'bin' => $this->bin, + 'issuingBank' => $this->issuingBank, + 'binCountryCode' => $this->binCountryCode, + 'products' => $this->products + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/BlikExperienceContext.php b/src/Models/BlikExperienceContext.php index 3946845..948c560 100644 --- a/src/Models/BlikExperienceContext.php +++ b/src/Models/BlikExperienceContext.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -208,6 +209,27 @@ class BlikExperienceContext implements \JsonSerializable $this->consumerUserAgent = $consumerUserAgent; } + /** + * Converts the BlikExperienceContext object to a human-readable string representation. + * + * @return string The string representation of the BlikExperienceContext object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'BlikExperienceContext', + [ + 'brandName' => $this->brandName, + 'locale' => $this->locale, + 'shippingPreference' => $this->shippingPreference, + 'returnUrl' => $this->returnUrl, + 'cancelUrl' => $this->cancelUrl, + 'consumerIp' => $this->consumerIp, + 'consumerUserAgent' => $this->consumerUserAgent + ] + ); + } + /** * Encode this object to JSON * @@ -227,7 +249,7 @@ class BlikExperienceContext implements \JsonSerializable $json['locale'] = $this->locale; } if (isset($this->shippingPreference)) { - $json['shipping_preference'] = ShippingPreference::checkValue($this->shippingPreference); + $json['shipping_preference'] = $this->shippingPreference; } if (isset($this->returnUrl)) { $json['return_url'] = $this->returnUrl; diff --git a/src/Models/BlikLevel0PaymentObject.php b/src/Models/BlikLevel0PaymentObject.php index 65a4515..df5fce5 100644 --- a/src/Models/BlikLevel0PaymentObject.php +++ b/src/Models/BlikLevel0PaymentObject.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -51,6 +52,16 @@ class BlikLevel0PaymentObject implements \JsonSerializable $this->authCode = $authCode; } + /** + * Converts the BlikLevel0PaymentObject object to a human-readable string representation. + * + * @return string The string representation of the BlikLevel0PaymentObject object. + */ + public function __toString(): string + { + return ApiHelper::stringify('BlikLevel0PaymentObject', ['authCode' => $this->authCode]); + } + /** * Encode this object to JSON * diff --git a/src/Models/BlikOneClickPaymentObject.php b/src/Models/BlikOneClickPaymentObject.php index cc3ca97..dcf512a 100644 --- a/src/Models/BlikOneClickPaymentObject.php +++ b/src/Models/BlikOneClickPaymentObject.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -44,6 +45,16 @@ class BlikOneClickPaymentObject implements \JsonSerializable $this->consumerReference = $consumerReference; } + /** + * Converts the BlikOneClickPaymentObject object to a human-readable string representation. + * + * @return string The string representation of the BlikOneClickPaymentObject object. + */ + public function __toString(): string + { + return ApiHelper::stringify('BlikOneClickPaymentObject', ['consumerReference' => $this->consumerReference]); + } + /** * Encode this object to JSON * diff --git a/src/Models/BlikOneClickPaymentRequest.php b/src/Models/BlikOneClickPaymentRequest.php index 4bf0df0..9008282 100644 --- a/src/Models/BlikOneClickPaymentRequest.php +++ b/src/Models/BlikOneClickPaymentRequest.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -132,6 +133,24 @@ class BlikOneClickPaymentRequest implements \JsonSerializable $this->aliasKey = $aliasKey; } + /** + * Converts the BlikOneClickPaymentRequest object to a human-readable string representation. + * + * @return string The string representation of the BlikOneClickPaymentRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'BlikOneClickPaymentRequest', + [ + 'authCode' => $this->authCode, + 'consumerReference' => $this->consumerReference, + 'aliasLabel' => $this->aliasLabel, + 'aliasKey' => $this->aliasKey + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/BlikPaymentObject.php b/src/Models/BlikPaymentObject.php index e05f725..e65cec8 100644 --- a/src/Models/BlikPaymentObject.php +++ b/src/Models/BlikPaymentObject.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -60,10 +61,9 @@ class BlikPaymentObject implements \JsonSerializable /** * Returns Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. */ public function getCountryCode(): ?string { @@ -73,10 +73,9 @@ class BlikPaymentObject implements \JsonSerializable /** * Sets Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. * * @maps country_code */ @@ -87,10 +86,9 @@ class BlikPaymentObject implements \JsonSerializable /** * Returns Email. - * The internationalized email address.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. */ public function getEmail(): ?string { @@ -99,10 +97,9 @@ class BlikPaymentObject implements \JsonSerializable /** * Sets Email. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. * * @maps email */ @@ -131,6 +128,24 @@ class BlikPaymentObject implements \JsonSerializable $this->oneClick = $oneClick; } + /** + * Converts the BlikPaymentObject object to a human-readable string representation. + * + * @return string The string representation of the BlikPaymentObject object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'BlikPaymentObject', + [ + 'name' => $this->name, + 'countryCode' => $this->countryCode, + 'email' => $this->email, + 'oneClick' => $this->oneClick + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/BlikPaymentRequest.php b/src/Models/BlikPaymentRequest.php index 2525c09..5b68156 100644 --- a/src/Models/BlikPaymentRequest.php +++ b/src/Models/BlikPaymentRequest.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -81,10 +82,9 @@ class BlikPaymentRequest implements \JsonSerializable /** * Returns Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. */ public function getCountryCode(): string { @@ -94,10 +94,9 @@ class BlikPaymentRequest implements \JsonSerializable /** * Sets Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. * * @required * @maps country_code @@ -109,10 +108,9 @@ class BlikPaymentRequest implements \JsonSerializable /** * Returns Email. - * The internationalized email address.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. */ public function getEmail(): ?string { @@ -121,10 +119,9 @@ class BlikPaymentRequest implements \JsonSerializable /** * Sets Email. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. * * @maps email */ @@ -193,6 +190,26 @@ class BlikPaymentRequest implements \JsonSerializable $this->oneClick = $oneClick; } + /** + * Converts the BlikPaymentRequest object to a human-readable string representation. + * + * @return string The string representation of the BlikPaymentRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'BlikPaymentRequest', + [ + 'name' => $this->name, + 'countryCode' => $this->countryCode, + 'email' => $this->email, + 'experienceContext' => $this->experienceContext, + 'level0' => $this->level0, + 'oneClick' => $this->oneClick + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/Builders/ActivityTimestampsBuilder.php b/src/Models/Builders/ActivityTimestampsBuilder.php index 482aaa6..996a354 100644 --- a/src/Models/Builders/ActivityTimestampsBuilder.php +++ b/src/Models/Builders/ActivityTimestampsBuilder.php @@ -31,7 +31,7 @@ class ActivityTimestampsBuilder } /** - * Initializes a new activity timestamps Builder object. + * Initializes a new Activity Timestamps Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class ActivityTimestampsBuilder /** * Sets create time field. + * + * @param string|null $value */ public function createTime(?string $value): self { @@ -49,6 +51,8 @@ class ActivityTimestampsBuilder /** * Sets update time field. + * + * @param string|null $value */ public function updateTime(?string $value): self { @@ -57,7 +61,7 @@ class ActivityTimestampsBuilder } /** - * Initializes a new activity timestamps object. + * Initializes a new Activity Timestamps object. */ public function build(): ActivityTimestamps { diff --git a/src/Models/Builders/AddressBuilder.php b/src/Models/Builders/AddressBuilder.php index cd97ef2..0cb8b74 100644 --- a/src/Models/Builders/AddressBuilder.php +++ b/src/Models/Builders/AddressBuilder.php @@ -31,7 +31,9 @@ class AddressBuilder } /** - * Initializes a new address Builder object. + * Initializes a new Address Builder object. + * + * @param string $countryCode */ public static function init(string $countryCode): self { @@ -40,6 +42,8 @@ class AddressBuilder /** * Sets address line 1 field. + * + * @param string|null $value */ public function addressLine1(?string $value): self { @@ -49,6 +53,8 @@ class AddressBuilder /** * Sets address line 2 field. + * + * @param string|null $value */ public function addressLine2(?string $value): self { @@ -58,6 +64,8 @@ class AddressBuilder /** * Sets admin area 2 field. + * + * @param string|null $value */ public function adminArea2(?string $value): self { @@ -67,6 +75,8 @@ class AddressBuilder /** * Sets admin area 1 field. + * + * @param string|null $value */ public function adminArea1(?string $value): self { @@ -76,6 +86,8 @@ class AddressBuilder /** * Sets postal code field. + * + * @param string|null $value */ public function postalCode(?string $value): self { @@ -84,7 +96,7 @@ class AddressBuilder } /** - * Initializes a new address object. + * Initializes a new Address object. */ public function build(): Address { diff --git a/src/Models/Builders/AddressDetailsBuilder.php b/src/Models/Builders/AddressDetailsBuilder.php deleted file mode 100644 index 3cc7fb0..0000000 --- a/src/Models/Builders/AddressDetailsBuilder.php +++ /dev/null @@ -1,140 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new address details Builder object. - */ - public static function init(string $countryCode): self - { - return new self(new AddressDetails($countryCode)); - } - - /** - * Sets address line 1 field. - */ - public function addressLine1(?string $value): self - { - $this->instance->setAddressLine1($value); - return $this; - } - - /** - * Sets address line 2 field. - */ - public function addressLine2(?string $value): self - { - $this->instance->setAddressLine2($value); - return $this; - } - - /** - * Sets admin area 2 field. - */ - public function adminArea2(?string $value): self - { - $this->instance->setAdminArea2($value); - return $this; - } - - /** - * Sets admin area 1 field. - */ - public function adminArea1(?string $value): self - { - $this->instance->setAdminArea1($value); - return $this; - } - - /** - * Sets postal code field. - */ - public function postalCode(?string $value): self - { - $this->instance->setPostalCode($value); - return $this; - } - - /** - * Sets name field. - */ - public function name(?Name $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets id field. - */ - public function id(?string $value): self - { - $this->instance->setId($value); - return $this; - } - - /** - * Sets company field. - */ - public function company(?string $value): self - { - $this->instance->setCompany($value); - return $this; - } - - /** - * Sets phone field. - */ - public function phone(?string $value): self - { - $this->instance->setPhone($value); - return $this; - } - - /** - * Sets phone number field. - */ - public function phoneNumber(?Phone $value): self - { - $this->instance->setPhoneNumber($value); - return $this; - } - - /** - * Initializes a new address details object. - */ - public function build(): AddressDetails - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/AmountBreakdownBuilder.php b/src/Models/Builders/AmountBreakdownBuilder.php index e80eb57..16b63ee 100644 --- a/src/Models/Builders/AmountBreakdownBuilder.php +++ b/src/Models/Builders/AmountBreakdownBuilder.php @@ -32,7 +32,7 @@ class AmountBreakdownBuilder } /** - * Initializes a new amount breakdown Builder object. + * Initializes a new Amount Breakdown Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class AmountBreakdownBuilder /** * Sets item total field. + * + * @param Money|null $value */ public function itemTotal(?Money $value): self { @@ -50,6 +52,8 @@ class AmountBreakdownBuilder /** * Sets shipping field. + * + * @param Money|null $value */ public function shipping(?Money $value): self { @@ -59,6 +63,8 @@ class AmountBreakdownBuilder /** * Sets handling field. + * + * @param Money|null $value */ public function handling(?Money $value): self { @@ -68,6 +74,8 @@ class AmountBreakdownBuilder /** * Sets tax total field. + * + * @param Money|null $value */ public function taxTotal(?Money $value): self { @@ -77,6 +85,8 @@ class AmountBreakdownBuilder /** * Sets insurance field. + * + * @param Money|null $value */ public function insurance(?Money $value): self { @@ -86,6 +96,8 @@ class AmountBreakdownBuilder /** * Sets shipping discount field. + * + * @param Money|null $value */ public function shippingDiscount(?Money $value): self { @@ -95,6 +107,8 @@ class AmountBreakdownBuilder /** * Sets discount field. + * + * @param Money|null $value */ public function discount(?Money $value): self { @@ -103,7 +117,7 @@ class AmountBreakdownBuilder } /** - * Initializes a new amount breakdown object. + * Initializes a new Amount Breakdown object. */ public function build(): AmountBreakdown { diff --git a/src/Models/Builders/AmountWithBreakdownBuilder.php b/src/Models/Builders/AmountWithBreakdownBuilder.php index b3e57a4..593238f 100644 --- a/src/Models/Builders/AmountWithBreakdownBuilder.php +++ b/src/Models/Builders/AmountWithBreakdownBuilder.php @@ -32,7 +32,10 @@ class AmountWithBreakdownBuilder } /** - * Initializes a new amount with breakdown Builder object. + * Initializes a new Amount With Breakdown Builder object. + * + * @param string $currencyCode + * @param string $value */ public static function init(string $currencyCode, string $value): self { @@ -41,6 +44,8 @@ class AmountWithBreakdownBuilder /** * Sets breakdown field. + * + * @param AmountBreakdown|null $value */ public function breakdown(?AmountBreakdown $value): self { @@ -49,7 +54,7 @@ class AmountWithBreakdownBuilder } /** - * Initializes a new amount with breakdown object. + * Initializes a new Amount With Breakdown object. */ public function build(): AmountWithBreakdown { diff --git a/src/Models/Builders/ApplePayAttributesBuilder.php b/src/Models/Builders/ApplePayAttributesBuilder.php index d3fcb14..c9bef76 100644 --- a/src/Models/Builders/ApplePayAttributesBuilder.php +++ b/src/Models/Builders/ApplePayAttributesBuilder.php @@ -33,7 +33,7 @@ class ApplePayAttributesBuilder } /** - * Initializes a new apple pay attributes Builder object. + * Initializes a new Apple Pay Attributes Builder object. */ public static function init(): self { @@ -42,6 +42,8 @@ class ApplePayAttributesBuilder /** * Sets customer field. + * + * @param CustomerInformation|null $value */ public function customer(?CustomerInformation $value): self { @@ -51,6 +53,8 @@ class ApplePayAttributesBuilder /** * Sets vault field. + * + * @param VaultInstruction|null $value */ public function vault(?VaultInstruction $value): self { @@ -59,7 +63,7 @@ class ApplePayAttributesBuilder } /** - * Initializes a new apple pay attributes object. + * Initializes a new Apple Pay Attributes object. */ public function build(): ApplePayAttributes { diff --git a/src/Models/Builders/ApplePayAttributesResponseBuilder.php b/src/Models/Builders/ApplePayAttributesResponseBuilder.php index e6a1269..730d0f0 100644 --- a/src/Models/Builders/ApplePayAttributesResponseBuilder.php +++ b/src/Models/Builders/ApplePayAttributesResponseBuilder.php @@ -32,7 +32,7 @@ class ApplePayAttributesResponseBuilder } /** - * Initializes a new apple pay attributes response Builder object. + * Initializes a new Apple Pay Attributes Response Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class ApplePayAttributesResponseBuilder /** * Sets vault field. + * + * @param VaultResponse|null $value */ public function vault(?VaultResponse $value): self { @@ -49,7 +51,7 @@ class ApplePayAttributesResponseBuilder } /** - * Initializes a new apple pay attributes response object. + * Initializes a new Apple Pay Attributes Response object. */ public function build(): ApplePayAttributesResponse { diff --git a/src/Models/Builders/ApplePayCardBuilder.php b/src/Models/Builders/ApplePayCardBuilder.php index d95729d..e5f53a9 100644 --- a/src/Models/Builders/ApplePayCardBuilder.php +++ b/src/Models/Builders/ApplePayCardBuilder.php @@ -32,7 +32,7 @@ class ApplePayCardBuilder } /** - * Initializes a new apple pay card Builder object. + * Initializes a new Apple Pay Card Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class ApplePayCardBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -50,6 +52,8 @@ class ApplePayCardBuilder /** * Sets last digits field. + * + * @param string|null $value */ public function lastDigits(?string $value): self { @@ -59,6 +63,8 @@ class ApplePayCardBuilder /** * Sets type field. + * + * @param string|null $value */ public function type(?string $value): self { @@ -68,6 +74,8 @@ class ApplePayCardBuilder /** * Sets brand field. + * + * @param string|null $value */ public function brand(?string $value): self { @@ -77,6 +85,8 @@ class ApplePayCardBuilder /** * Sets billing address field. + * + * @param Address|null $value */ public function billingAddress(?Address $value): self { @@ -85,7 +95,7 @@ class ApplePayCardBuilder } /** - * Initializes a new apple pay card object. + * Initializes a new Apple Pay Card object. */ public function build(): ApplePayCard { diff --git a/src/Models/Builders/ApplePayCardResponseBuilder.php b/src/Models/Builders/ApplePayCardResponseBuilder.php index e7faba1..c030ec5 100644 --- a/src/Models/Builders/ApplePayCardResponseBuilder.php +++ b/src/Models/Builders/ApplePayCardResponseBuilder.php @@ -17,6 +17,7 @@ use PaypalServerSdkLib\Models\AuthenticationResponse; use PaypalServerSdkLib\Models\BinDetails; use PaypalServerSdkLib\Models\CardAttributesResponse; use PaypalServerSdkLib\Models\CardFromRequest; +use PaypalServerSdkLib\Models\CardStoredCredential; /** * Builder for model ApplePayCardResponse @@ -36,7 +37,7 @@ class ApplePayCardResponseBuilder } /** - * Initializes a new apple pay card response Builder object. + * Initializes a new Apple Pay Card Response Builder object. */ public static function init(): self { @@ -45,6 +46,8 @@ class ApplePayCardResponseBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -54,6 +57,8 @@ class ApplePayCardResponseBuilder /** * Sets last digits field. + * + * @param string|null $value */ public function lastDigits(?string $value): self { @@ -63,6 +68,8 @@ class ApplePayCardResponseBuilder /** * Sets brand field. + * + * @param string|null $value */ public function brand(?string $value): self { @@ -72,6 +79,8 @@ class ApplePayCardResponseBuilder /** * Sets available networks field. + * + * @param string[]|null $value */ public function availableNetworks(?array $value): self { @@ -81,6 +90,8 @@ class ApplePayCardResponseBuilder /** * Sets type field. + * + * @param string|null $value */ public function type(?string $value): self { @@ -90,6 +101,8 @@ class ApplePayCardResponseBuilder /** * Sets authentication result field. + * + * @param AuthenticationResponse|null $value */ public function authenticationResult(?AuthenticationResponse $value): self { @@ -99,6 +112,8 @@ class ApplePayCardResponseBuilder /** * Sets attributes field. + * + * @param CardAttributesResponse|null $value */ public function attributes(?CardAttributesResponse $value): self { @@ -108,6 +123,8 @@ class ApplePayCardResponseBuilder /** * Sets from request field. + * + * @param CardFromRequest|null $value */ public function fromRequest(?CardFromRequest $value): self { @@ -117,6 +134,8 @@ class ApplePayCardResponseBuilder /** * Sets expiry field. + * + * @param string|null $value */ public function expiry(?string $value): self { @@ -126,6 +145,8 @@ class ApplePayCardResponseBuilder /** * Sets bin details field. + * + * @param BinDetails|null $value */ public function binDetails(?BinDetails $value): self { @@ -133,8 +154,21 @@ class ApplePayCardResponseBuilder return $this; } + /** + * Sets stored credential field. + * + * @param CardStoredCredential|null $value + */ + public function storedCredential(?CardStoredCredential $value): self + { + $this->instance->setStoredCredential($value); + return $this; + } + /** * Sets billing address field. + * + * @param Address|null $value */ public function billingAddress(?Address $value): self { @@ -144,6 +178,8 @@ class ApplePayCardResponseBuilder /** * Sets country code field. + * + * @param string|null $value */ public function countryCode(?string $value): self { @@ -152,7 +188,7 @@ class ApplePayCardResponseBuilder } /** - * Initializes a new apple pay card response object. + * Initializes a new Apple Pay Card Response object. */ public function build(): ApplePayCardResponse { diff --git a/src/Models/Builders/ApplePayDecryptedTokenDataBuilder.php b/src/Models/Builders/ApplePayDecryptedTokenDataBuilder.php index 1ce0647..a3861ed 100644 --- a/src/Models/Builders/ApplePayDecryptedTokenDataBuilder.php +++ b/src/Models/Builders/ApplePayDecryptedTokenDataBuilder.php @@ -34,7 +34,9 @@ class ApplePayDecryptedTokenDataBuilder } /** - * Initializes a new apple pay decrypted token data Builder object. + * Initializes a new Apple Pay Decrypted Token Data Builder object. + * + * @param ApplePayTokenizedCard $tokenizedCard */ public static function init(ApplePayTokenizedCard $tokenizedCard): self { @@ -43,6 +45,8 @@ class ApplePayDecryptedTokenDataBuilder /** * Sets transaction amount field. + * + * @param Money|null $value */ public function transactionAmount(?Money $value): self { @@ -52,6 +56,8 @@ class ApplePayDecryptedTokenDataBuilder /** * Sets device manufacturer id field. + * + * @param string|null $value */ public function deviceManufacturerId(?string $value): self { @@ -61,6 +67,8 @@ class ApplePayDecryptedTokenDataBuilder /** * Sets payment data type field. + * + * @param string|null $value */ public function paymentDataType(?string $value): self { @@ -70,6 +78,8 @@ class ApplePayDecryptedTokenDataBuilder /** * Sets payment data field. + * + * @param ApplePayPaymentData|null $value */ public function paymentData(?ApplePayPaymentData $value): self { @@ -78,7 +88,7 @@ class ApplePayDecryptedTokenDataBuilder } /** - * Initializes a new apple pay decrypted token data object. + * Initializes a new Apple Pay Decrypted Token Data object. */ public function build(): ApplePayDecryptedTokenData { diff --git a/src/Models/Builders/ApplePayPaymentDataBuilder.php b/src/Models/Builders/ApplePayPaymentDataBuilder.php index e27780f..b1cae25 100644 --- a/src/Models/Builders/ApplePayPaymentDataBuilder.php +++ b/src/Models/Builders/ApplePayPaymentDataBuilder.php @@ -31,7 +31,7 @@ class ApplePayPaymentDataBuilder } /** - * Initializes a new apple pay payment data Builder object. + * Initializes a new Apple Pay Payment Data Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class ApplePayPaymentDataBuilder /** * Sets cryptogram field. + * + * @param string|null $value */ public function cryptogram(?string $value): self { @@ -49,6 +51,8 @@ class ApplePayPaymentDataBuilder /** * Sets eci indicator field. + * + * @param string|null $value */ public function eciIndicator(?string $value): self { @@ -58,6 +62,8 @@ class ApplePayPaymentDataBuilder /** * Sets emv data field. + * + * @param string|null $value */ public function emvData(?string $value): self { @@ -67,6 +73,8 @@ class ApplePayPaymentDataBuilder /** * Sets pin field. + * + * @param string|null $value */ public function pin(?string $value): self { @@ -75,7 +83,7 @@ class ApplePayPaymentDataBuilder } /** - * Initializes a new apple pay payment data object. + * Initializes a new Apple Pay Payment Data object. */ public function build(): ApplePayPaymentData { diff --git a/src/Models/Builders/ApplePayPaymentObjectBuilder.php b/src/Models/Builders/ApplePayPaymentObjectBuilder.php index c097e53..50d8956 100644 --- a/src/Models/Builders/ApplePayPaymentObjectBuilder.php +++ b/src/Models/Builders/ApplePayPaymentObjectBuilder.php @@ -14,6 +14,7 @@ use Core\Utils\CoreHelper; use PaypalServerSdkLib\Models\ApplePayAttributesResponse; use PaypalServerSdkLib\Models\ApplePayCardResponse; use PaypalServerSdkLib\Models\ApplePayPaymentObject; +use PaypalServerSdkLib\Models\CardStoredCredential; use PaypalServerSdkLib\Models\PhoneNumber; /** @@ -34,7 +35,7 @@ class ApplePayPaymentObjectBuilder } /** - * Initializes a new apple pay payment object Builder object. + * Initializes a new Apple Pay Payment Object Builder object. */ public static function init(): self { @@ -43,6 +44,8 @@ class ApplePayPaymentObjectBuilder /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -52,6 +55,8 @@ class ApplePayPaymentObjectBuilder /** * Sets token field. + * + * @param string|null $value */ public function token(?string $value): self { @@ -61,6 +66,8 @@ class ApplePayPaymentObjectBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -70,6 +77,8 @@ class ApplePayPaymentObjectBuilder /** * Sets email address field. + * + * @param string|null $value */ public function emailAddress(?string $value): self { @@ -79,6 +88,8 @@ class ApplePayPaymentObjectBuilder /** * Sets phone number field. + * + * @param PhoneNumber|null $value */ public function phoneNumber(?PhoneNumber $value): self { @@ -88,6 +99,8 @@ class ApplePayPaymentObjectBuilder /** * Sets card field. + * + * @param ApplePayCardResponse|null $value */ public function card(?ApplePayCardResponse $value): self { @@ -97,6 +110,8 @@ class ApplePayPaymentObjectBuilder /** * Sets attributes field. + * + * @param ApplePayAttributesResponse|null $value */ public function attributes(?ApplePayAttributesResponse $value): self { @@ -105,7 +120,18 @@ class ApplePayPaymentObjectBuilder } /** - * Initializes a new apple pay payment object object. + * Sets stored credential field. + * + * @param CardStoredCredential|null $value + */ + public function storedCredential(?CardStoredCredential $value): self + { + $this->instance->setStoredCredential($value); + return $this; + } + + /** + * Initializes a new Apple Pay Payment Object object. */ public function build(): ApplePayPaymentObject { diff --git a/src/Models/Builders/ApplePayPaymentTokenBuilder.php b/src/Models/Builders/ApplePayPaymentTokenBuilder.php index 9ea398e..defab0b 100644 --- a/src/Models/Builders/ApplePayPaymentTokenBuilder.php +++ b/src/Models/Builders/ApplePayPaymentTokenBuilder.php @@ -32,7 +32,7 @@ class ApplePayPaymentTokenBuilder } /** - * Initializes a new apple pay payment token Builder object. + * Initializes a new Apple Pay Payment Token Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class ApplePayPaymentTokenBuilder /** * Sets card field. + * + * @param ApplePayCard|null $value */ public function card(?ApplePayCard $value): self { @@ -49,7 +51,7 @@ class ApplePayPaymentTokenBuilder } /** - * Initializes a new apple pay payment token object. + * Initializes a new Apple Pay Payment Token object. */ public function build(): ApplePayPaymentToken { diff --git a/src/Models/Builders/ApplePayRequestBuilder.php b/src/Models/Builders/ApplePayRequestBuilder.php index a3d3fc6..0797592 100644 --- a/src/Models/Builders/ApplePayRequestBuilder.php +++ b/src/Models/Builders/ApplePayRequestBuilder.php @@ -35,7 +35,7 @@ class ApplePayRequestBuilder } /** - * Initializes a new apple pay request Builder object. + * Initializes a new Apple Pay Request Builder object. */ public static function init(): self { @@ -44,6 +44,8 @@ class ApplePayRequestBuilder /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -53,6 +55,8 @@ class ApplePayRequestBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -62,6 +66,8 @@ class ApplePayRequestBuilder /** * Sets email address field. + * + * @param string|null $value */ public function emailAddress(?string $value): self { @@ -71,6 +77,8 @@ class ApplePayRequestBuilder /** * Sets phone number field. + * + * @param PhoneNumber|null $value */ public function phoneNumber(?PhoneNumber $value): self { @@ -80,6 +88,8 @@ class ApplePayRequestBuilder /** * Sets decrypted token field. + * + * @param ApplePayDecryptedTokenData|null $value */ public function decryptedToken(?ApplePayDecryptedTokenData $value): self { @@ -89,6 +99,8 @@ class ApplePayRequestBuilder /** * Sets stored credential field. + * + * @param CardStoredCredential|null $value */ public function storedCredential(?CardStoredCredential $value): self { @@ -98,6 +110,8 @@ class ApplePayRequestBuilder /** * Sets vault id field. + * + * @param string|null $value */ public function vaultId(?string $value): self { @@ -107,6 +121,8 @@ class ApplePayRequestBuilder /** * Sets attributes field. + * + * @param ApplePayAttributes|null $value */ public function attributes(?ApplePayAttributes $value): self { @@ -115,7 +131,7 @@ class ApplePayRequestBuilder } /** - * Initializes a new apple pay request object. + * Initializes a new Apple Pay Request object. */ public function build(): ApplePayRequest { diff --git a/src/Models/Builders/ApplePayTokenizedCardBuilder.php b/src/Models/Builders/ApplePayTokenizedCardBuilder.php index c32f1e9..0ad7c25 100644 --- a/src/Models/Builders/ApplePayTokenizedCardBuilder.php +++ b/src/Models/Builders/ApplePayTokenizedCardBuilder.php @@ -32,7 +32,7 @@ class ApplePayTokenizedCardBuilder } /** - * Initializes a new apple pay tokenized card Builder object. + * Initializes a new Apple Pay Tokenized Card Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class ApplePayTokenizedCardBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -50,6 +52,8 @@ class ApplePayTokenizedCardBuilder /** * Sets number field. + * + * @param string|null $value */ public function number(?string $value): self { @@ -59,6 +63,8 @@ class ApplePayTokenizedCardBuilder /** * Sets expiry field. + * + * @param string|null $value */ public function expiry(?string $value): self { @@ -68,6 +74,8 @@ class ApplePayTokenizedCardBuilder /** * Sets card type field. + * + * @param string|null $value */ public function cardType(?string $value): self { @@ -77,6 +85,8 @@ class ApplePayTokenizedCardBuilder /** * Sets type field. + * + * @param string|null $value */ public function type(?string $value): self { @@ -86,6 +96,8 @@ class ApplePayTokenizedCardBuilder /** * Sets brand field. + * + * @param string|null $value */ public function brand(?string $value): self { @@ -95,6 +107,8 @@ class ApplePayTokenizedCardBuilder /** * Sets billing address field. + * + * @param Address|null $value */ public function billingAddress(?Address $value): self { @@ -103,7 +117,7 @@ class ApplePayTokenizedCardBuilder } /** - * Initializes a new apple pay tokenized card object. + * Initializes a new Apple Pay Tokenized Card object. */ public function build(): ApplePayTokenizedCard { diff --git a/src/Models/Builders/AssuranceDetailsBuilder.php b/src/Models/Builders/AssuranceDetailsBuilder.php index 0b3399a..3f74894 100644 --- a/src/Models/Builders/AssuranceDetailsBuilder.php +++ b/src/Models/Builders/AssuranceDetailsBuilder.php @@ -31,7 +31,7 @@ class AssuranceDetailsBuilder } /** - * Initializes a new assurance details Builder object. + * Initializes a new Assurance Details Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class AssuranceDetailsBuilder /** * Sets account verified field. + * + * @param bool|null $value */ public function accountVerified(?bool $value): self { @@ -49,6 +51,8 @@ class AssuranceDetailsBuilder /** * Sets card holder authenticated field. + * + * @param bool|null $value */ public function cardHolderAuthenticated(?bool $value): self { @@ -57,7 +61,7 @@ class AssuranceDetailsBuilder } /** - * Initializes a new assurance details object. + * Initializes a new Assurance Details object. */ public function build(): AssuranceDetails { diff --git a/src/Models/Builders/AuthenticationResponseBuilder.php b/src/Models/Builders/AuthenticationResponseBuilder.php index aae83fe..3dc1185 100644 --- a/src/Models/Builders/AuthenticationResponseBuilder.php +++ b/src/Models/Builders/AuthenticationResponseBuilder.php @@ -32,7 +32,7 @@ class AuthenticationResponseBuilder } /** - * Initializes a new authentication response Builder object. + * Initializes a new Authentication Response Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class AuthenticationResponseBuilder /** * Sets liability shift field. + * + * @param string|null $value */ public function liabilityShift(?string $value): self { @@ -50,6 +52,8 @@ class AuthenticationResponseBuilder /** * Sets three d secure field. + * + * @param ThreeDSecureAuthenticationResponse|null $value */ public function threeDSecure(?ThreeDSecureAuthenticationResponse $value): self { @@ -58,7 +62,7 @@ class AuthenticationResponseBuilder } /** - * Initializes a new authentication response object. + * Initializes a new Authentication Response object. */ public function build(): AuthenticationResponse { diff --git a/src/Models/Builders/AuthorizationBuilder.php b/src/Models/Builders/AuthorizationBuilder.php index 8cce06a..284eebc 100644 --- a/src/Models/Builders/AuthorizationBuilder.php +++ b/src/Models/Builders/AuthorizationBuilder.php @@ -13,6 +13,7 @@ namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; use PaypalServerSdkLib\Models\Authorization; use PaypalServerSdkLib\Models\AuthorizationStatusDetails; +use PaypalServerSdkLib\Models\LinkDescription; use PaypalServerSdkLib\Models\Money; use PaypalServerSdkLib\Models\NetworkTransactionReference; use PaypalServerSdkLib\Models\SellerProtection; @@ -35,7 +36,7 @@ class AuthorizationBuilder } /** - * Initializes a new authorization Builder object. + * Initializes a new Authorization Builder object. */ public static function init(): self { @@ -44,6 +45,8 @@ class AuthorizationBuilder /** * Sets status field. + * + * @param string|null $value */ public function status(?string $value): self { @@ -53,6 +56,8 @@ class AuthorizationBuilder /** * Sets status details field. + * + * @param AuthorizationStatusDetails|null $value */ public function statusDetails(?AuthorizationStatusDetails $value): self { @@ -62,6 +67,8 @@ class AuthorizationBuilder /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -71,6 +78,8 @@ class AuthorizationBuilder /** * Sets amount field. + * + * @param Money|null $value */ public function amount(?Money $value): self { @@ -80,6 +89,8 @@ class AuthorizationBuilder /** * Sets invoice id field. + * + * @param string|null $value */ public function invoiceId(?string $value): self { @@ -89,6 +100,8 @@ class AuthorizationBuilder /** * Sets custom id field. + * + * @param string|null $value */ public function customId(?string $value): self { @@ -98,6 +111,8 @@ class AuthorizationBuilder /** * Sets network transaction reference field. + * + * @param NetworkTransactionReference|null $value */ public function networkTransactionReference(?NetworkTransactionReference $value): self { @@ -107,6 +122,8 @@ class AuthorizationBuilder /** * Sets seller protection field. + * + * @param SellerProtection|null $value */ public function sellerProtection(?SellerProtection $value): self { @@ -116,6 +133,8 @@ class AuthorizationBuilder /** * Sets expiration time field. + * + * @param string|null $value */ public function expirationTime(?string $value): self { @@ -125,6 +144,8 @@ class AuthorizationBuilder /** * Sets links field. + * + * @param LinkDescription[]|null $value */ public function links(?array $value): self { @@ -134,6 +155,8 @@ class AuthorizationBuilder /** * Sets create time field. + * + * @param string|null $value */ public function createTime(?string $value): self { @@ -143,6 +166,8 @@ class AuthorizationBuilder /** * Sets update time field. + * + * @param string|null $value */ public function updateTime(?string $value): self { @@ -151,7 +176,7 @@ class AuthorizationBuilder } /** - * Initializes a new authorization object. + * Initializes a new Authorization object. */ public function build(): Authorization { diff --git a/src/Models/Builders/AuthorizationStatusDetailsBuilder.php b/src/Models/Builders/AuthorizationStatusDetailsBuilder.php index e9d8651..11d0580 100644 --- a/src/Models/Builders/AuthorizationStatusDetailsBuilder.php +++ b/src/Models/Builders/AuthorizationStatusDetailsBuilder.php @@ -31,7 +31,7 @@ class AuthorizationStatusDetailsBuilder } /** - * Initializes a new authorization status details Builder object. + * Initializes a new Authorization Status Details Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class AuthorizationStatusDetailsBuilder /** * Sets reason field. + * + * @param string|null $value */ public function reason(?string $value): self { @@ -48,7 +50,7 @@ class AuthorizationStatusDetailsBuilder } /** - * Initializes a new authorization status details object. + * Initializes a new Authorization Status Details object. */ public function build(): AuthorizationStatusDetails { diff --git a/src/Models/Builders/AuthorizationStatusWithDetailsBuilder.php b/src/Models/Builders/AuthorizationStatusWithDetailsBuilder.php index f3e4550..9b0ed2d 100644 --- a/src/Models/Builders/AuthorizationStatusWithDetailsBuilder.php +++ b/src/Models/Builders/AuthorizationStatusWithDetailsBuilder.php @@ -32,7 +32,7 @@ class AuthorizationStatusWithDetailsBuilder } /** - * Initializes a new authorization status with details Builder object. + * Initializes a new Authorization Status With Details Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class AuthorizationStatusWithDetailsBuilder /** * Sets status field. + * + * @param string|null $value */ public function status(?string $value): self { @@ -50,6 +52,8 @@ class AuthorizationStatusWithDetailsBuilder /** * Sets status details field. + * + * @param AuthorizationStatusDetails|null $value */ public function statusDetails(?AuthorizationStatusDetails $value): self { @@ -58,7 +62,7 @@ class AuthorizationStatusWithDetailsBuilder } /** - * Initializes a new authorization status with details object. + * Initializes a new Authorization Status With Details object. */ public function build(): AuthorizationStatusWithDetails { diff --git a/src/Models/Builders/AuthorizationWithAdditionalDataBuilder.php b/src/Models/Builders/AuthorizationWithAdditionalDataBuilder.php index c40e30f..9facc68 100644 --- a/src/Models/Builders/AuthorizationWithAdditionalDataBuilder.php +++ b/src/Models/Builders/AuthorizationWithAdditionalDataBuilder.php @@ -13,6 +13,7 @@ namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; use PaypalServerSdkLib\Models\AuthorizationStatusDetails; use PaypalServerSdkLib\Models\AuthorizationWithAdditionalData; +use PaypalServerSdkLib\Models\LinkDescription; use PaypalServerSdkLib\Models\Money; use PaypalServerSdkLib\Models\NetworkTransactionReference; use PaypalServerSdkLib\Models\ProcessorResponse; @@ -36,7 +37,7 @@ class AuthorizationWithAdditionalDataBuilder } /** - * Initializes a new authorization with additional data Builder object. + * Initializes a new Authorization With Additional Data Builder object. */ public static function init(): self { @@ -45,6 +46,8 @@ class AuthorizationWithAdditionalDataBuilder /** * Sets status field. + * + * @param string|null $value */ public function status(?string $value): self { @@ -54,6 +57,8 @@ class AuthorizationWithAdditionalDataBuilder /** * Sets status details field. + * + * @param AuthorizationStatusDetails|null $value */ public function statusDetails(?AuthorizationStatusDetails $value): self { @@ -63,6 +68,8 @@ class AuthorizationWithAdditionalDataBuilder /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -72,6 +79,8 @@ class AuthorizationWithAdditionalDataBuilder /** * Sets amount field. + * + * @param Money|null $value */ public function amount(?Money $value): self { @@ -81,6 +90,8 @@ class AuthorizationWithAdditionalDataBuilder /** * Sets invoice id field. + * + * @param string|null $value */ public function invoiceId(?string $value): self { @@ -90,6 +101,8 @@ class AuthorizationWithAdditionalDataBuilder /** * Sets custom id field. + * + * @param string|null $value */ public function customId(?string $value): self { @@ -99,6 +112,8 @@ class AuthorizationWithAdditionalDataBuilder /** * Sets network transaction reference field. + * + * @param NetworkTransactionReference|null $value */ public function networkTransactionReference(?NetworkTransactionReference $value): self { @@ -108,6 +123,8 @@ class AuthorizationWithAdditionalDataBuilder /** * Sets seller protection field. + * + * @param SellerProtection|null $value */ public function sellerProtection(?SellerProtection $value): self { @@ -117,6 +134,8 @@ class AuthorizationWithAdditionalDataBuilder /** * Sets expiration time field. + * + * @param string|null $value */ public function expirationTime(?string $value): self { @@ -126,6 +145,8 @@ class AuthorizationWithAdditionalDataBuilder /** * Sets links field. + * + * @param LinkDescription[]|null $value */ public function links(?array $value): self { @@ -135,6 +156,8 @@ class AuthorizationWithAdditionalDataBuilder /** * Sets create time field. + * + * @param string|null $value */ public function createTime(?string $value): self { @@ -144,6 +167,8 @@ class AuthorizationWithAdditionalDataBuilder /** * Sets update time field. + * + * @param string|null $value */ public function updateTime(?string $value): self { @@ -153,6 +178,8 @@ class AuthorizationWithAdditionalDataBuilder /** * Sets processor response field. + * + * @param ProcessorResponse|null $value */ public function processorResponse(?ProcessorResponse $value): self { @@ -161,7 +188,7 @@ class AuthorizationWithAdditionalDataBuilder } /** - * Initializes a new authorization with additional data object. + * Initializes a new Authorization With Additional Data object. */ public function build(): AuthorizationWithAdditionalData { diff --git a/src/Models/Builders/BancontactPaymentObjectBuilder.php b/src/Models/Builders/BancontactPaymentObjectBuilder.php index 72e791d..353077b 100644 --- a/src/Models/Builders/BancontactPaymentObjectBuilder.php +++ b/src/Models/Builders/BancontactPaymentObjectBuilder.php @@ -31,7 +31,7 @@ class BancontactPaymentObjectBuilder } /** - * Initializes a new bancontact payment object Builder object. + * Initializes a new Bancontact Payment Object Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class BancontactPaymentObjectBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -49,6 +51,8 @@ class BancontactPaymentObjectBuilder /** * Sets country code field. + * + * @param string|null $value */ public function countryCode(?string $value): self { @@ -58,6 +62,8 @@ class BancontactPaymentObjectBuilder /** * Sets bic field. + * + * @param string|null $value */ public function bic(?string $value): self { @@ -67,6 +73,8 @@ class BancontactPaymentObjectBuilder /** * Sets iban last chars field. + * + * @param string|null $value */ public function ibanLastChars(?string $value): self { @@ -76,6 +84,8 @@ class BancontactPaymentObjectBuilder /** * Sets card last digits field. + * + * @param string|null $value */ public function cardLastDigits(?string $value): self { @@ -84,7 +94,7 @@ class BancontactPaymentObjectBuilder } /** - * Initializes a new bancontact payment object object. + * Initializes a new Bancontact Payment Object object. */ public function build(): BancontactPaymentObject { diff --git a/src/Models/Builders/BancontactPaymentRequestBuilder.php b/src/Models/Builders/BancontactPaymentRequestBuilder.php index 7ce0719..7791631 100644 --- a/src/Models/Builders/BancontactPaymentRequestBuilder.php +++ b/src/Models/Builders/BancontactPaymentRequestBuilder.php @@ -32,7 +32,10 @@ class BancontactPaymentRequestBuilder } /** - * Initializes a new bancontact payment request Builder object. + * Initializes a new Bancontact Payment Request Builder object. + * + * @param string $name + * @param string $countryCode */ public static function init(string $name, string $countryCode): self { @@ -41,6 +44,8 @@ class BancontactPaymentRequestBuilder /** * Sets experience context field. + * + * @param ExperienceContext|null $value */ public function experienceContext(?ExperienceContext $value): self { @@ -49,7 +54,7 @@ class BancontactPaymentRequestBuilder } /** - * Initializes a new bancontact payment request object. + * Initializes a new Bancontact Payment Request object. */ public function build(): BancontactPaymentRequest { diff --git a/src/Models/Builders/BillingCycleBuilder.php b/src/Models/Builders/BillingCycleBuilder.php new file mode 100644 index 0000000..5fe4216 --- /dev/null +++ b/src/Models/Builders/BillingCycleBuilder.php @@ -0,0 +1,106 @@ +instance = $instance; + } + + /** + * Initializes a new Billing Cycle Builder object. + * + * @param string $tenureType + */ + public static function init(string $tenureType): self + { + return new self(new BillingCycle($tenureType)); + } + + /** + * Sets pricing scheme field. + * + * @param PricingScheme|null $value + */ + public function pricingScheme(?PricingScheme $value): self + { + $this->instance->setPricingScheme($value); + return $this; + } + + /** + * Sets frequency field. + * + * @param mixed $value + */ + public function frequency($value): self + { + $this->instance->setFrequency($value); + return $this; + } + + /** + * Sets total cycles field. + * + * @param int|null $value + */ + public function totalCycles(?int $value): self + { + $this->instance->setTotalCycles($value); + return $this; + } + + /** + * Sets sequence field. + * + * @param int|null $value + */ + public function sequence(?int $value): self + { + $this->instance->setSequence($value); + return $this; + } + + /** + * Sets start date field. + * + * @param string|null $value + */ + public function startDate(?string $value): self + { + $this->instance->setStartDate($value); + return $this; + } + + /** + * Initializes a new Billing Cycle object. + */ + public function build(): BillingCycle + { + return CoreHelper::clone($this->instance); + } +} diff --git a/src/Models/Builders/BinDetailsBuilder.php b/src/Models/Builders/BinDetailsBuilder.php index 8f0aa78..e5dd7d5 100644 --- a/src/Models/Builders/BinDetailsBuilder.php +++ b/src/Models/Builders/BinDetailsBuilder.php @@ -31,7 +31,7 @@ class BinDetailsBuilder } /** - * Initializes a new bin details Builder object. + * Initializes a new Bin Details Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class BinDetailsBuilder /** * Sets bin field. + * + * @param string|null $value */ public function bin(?string $value): self { @@ -49,6 +51,8 @@ class BinDetailsBuilder /** * Sets issuing bank field. + * + * @param string|null $value */ public function issuingBank(?string $value): self { @@ -58,6 +62,8 @@ class BinDetailsBuilder /** * Sets bin country code field. + * + * @param string|null $value */ public function binCountryCode(?string $value): self { @@ -67,6 +73,8 @@ class BinDetailsBuilder /** * Sets products field. + * + * @param string[]|null $value */ public function products(?array $value): self { @@ -75,7 +83,7 @@ class BinDetailsBuilder } /** - * Initializes a new bin details object. + * Initializes a new Bin Details object. */ public function build(): BinDetails { diff --git a/src/Models/Builders/BlikExperienceContextBuilder.php b/src/Models/Builders/BlikExperienceContextBuilder.php index 9b33452..31c01fc 100644 --- a/src/Models/Builders/BlikExperienceContextBuilder.php +++ b/src/Models/Builders/BlikExperienceContextBuilder.php @@ -31,7 +31,7 @@ class BlikExperienceContextBuilder } /** - * Initializes a new blik experience context Builder object. + * Initializes a new Blik Experience Context Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class BlikExperienceContextBuilder /** * Sets brand name field. + * + * @param string|null $value */ public function brandName(?string $value): self { @@ -49,6 +51,8 @@ class BlikExperienceContextBuilder /** * Sets locale field. + * + * @param string|null $value */ public function locale(?string $value): self { @@ -58,6 +62,8 @@ class BlikExperienceContextBuilder /** * Sets shipping preference field. + * + * @param string|null $value */ public function shippingPreference(?string $value): self { @@ -67,6 +73,8 @@ class BlikExperienceContextBuilder /** * Sets return url field. + * + * @param string|null $value */ public function returnUrl(?string $value): self { @@ -76,6 +84,8 @@ class BlikExperienceContextBuilder /** * Sets cancel url field. + * + * @param string|null $value */ public function cancelUrl(?string $value): self { @@ -85,6 +95,8 @@ class BlikExperienceContextBuilder /** * Sets consumer ip field. + * + * @param string|null $value */ public function consumerIp(?string $value): self { @@ -94,6 +106,8 @@ class BlikExperienceContextBuilder /** * Sets consumer user agent field. + * + * @param string|null $value */ public function consumerUserAgent(?string $value): self { @@ -102,7 +116,7 @@ class BlikExperienceContextBuilder } /** - * Initializes a new blik experience context object. + * Initializes a new Blik Experience Context object. */ public function build(): BlikExperienceContext { diff --git a/src/Models/Builders/BlikLevel0PaymentObjectBuilder.php b/src/Models/Builders/BlikLevel0PaymentObjectBuilder.php index 156f716..9d6063c 100644 --- a/src/Models/Builders/BlikLevel0PaymentObjectBuilder.php +++ b/src/Models/Builders/BlikLevel0PaymentObjectBuilder.php @@ -31,7 +31,9 @@ class BlikLevel0PaymentObjectBuilder } /** - * Initializes a new blik level 0 payment object Builder object. + * Initializes a new Blik Level 0 Payment Object Builder object. + * + * @param string $authCode */ public static function init(string $authCode): self { @@ -39,7 +41,7 @@ class BlikLevel0PaymentObjectBuilder } /** - * Initializes a new blik level 0 payment object object. + * Initializes a new Blik Level 0 Payment Object object. */ public function build(): BlikLevel0PaymentObject { diff --git a/src/Models/Builders/BlikOneClickPaymentObjectBuilder.php b/src/Models/Builders/BlikOneClickPaymentObjectBuilder.php index accfe72..0a804f0 100644 --- a/src/Models/Builders/BlikOneClickPaymentObjectBuilder.php +++ b/src/Models/Builders/BlikOneClickPaymentObjectBuilder.php @@ -31,7 +31,7 @@ class BlikOneClickPaymentObjectBuilder } /** - * Initializes a new blik one click payment object Builder object. + * Initializes a new Blik One Click Payment Object Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class BlikOneClickPaymentObjectBuilder /** * Sets consumer reference field. + * + * @param string|null $value */ public function consumerReference(?string $value): self { @@ -48,7 +50,7 @@ class BlikOneClickPaymentObjectBuilder } /** - * Initializes a new blik one click payment object object. + * Initializes a new Blik One Click Payment Object object. */ public function build(): BlikOneClickPaymentObject { diff --git a/src/Models/Builders/BlikOneClickPaymentRequestBuilder.php b/src/Models/Builders/BlikOneClickPaymentRequestBuilder.php index 7c26a51..9e6ac89 100644 --- a/src/Models/Builders/BlikOneClickPaymentRequestBuilder.php +++ b/src/Models/Builders/BlikOneClickPaymentRequestBuilder.php @@ -31,7 +31,9 @@ class BlikOneClickPaymentRequestBuilder } /** - * Initializes a new blik one click payment request Builder object. + * Initializes a new Blik One Click Payment Request Builder object. + * + * @param string $consumerReference */ public static function init(string $consumerReference): self { @@ -40,6 +42,8 @@ class BlikOneClickPaymentRequestBuilder /** * Sets auth code field. + * + * @param string|null $value */ public function authCode(?string $value): self { @@ -49,6 +53,8 @@ class BlikOneClickPaymentRequestBuilder /** * Sets alias label field. + * + * @param string|null $value */ public function aliasLabel(?string $value): self { @@ -58,6 +64,8 @@ class BlikOneClickPaymentRequestBuilder /** * Sets alias key field. + * + * @param string|null $value */ public function aliasKey(?string $value): self { @@ -66,7 +74,7 @@ class BlikOneClickPaymentRequestBuilder } /** - * Initializes a new blik one click payment request object. + * Initializes a new Blik One Click Payment Request object. */ public function build(): BlikOneClickPaymentRequest { diff --git a/src/Models/Builders/BlikPaymentObjectBuilder.php b/src/Models/Builders/BlikPaymentObjectBuilder.php index a7d28d9..3628ab9 100644 --- a/src/Models/Builders/BlikPaymentObjectBuilder.php +++ b/src/Models/Builders/BlikPaymentObjectBuilder.php @@ -32,7 +32,7 @@ class BlikPaymentObjectBuilder } /** - * Initializes a new blik payment object Builder object. + * Initializes a new Blik Payment Object Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class BlikPaymentObjectBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -50,6 +52,8 @@ class BlikPaymentObjectBuilder /** * Sets country code field. + * + * @param string|null $value */ public function countryCode(?string $value): self { @@ -59,6 +63,8 @@ class BlikPaymentObjectBuilder /** * Sets email field. + * + * @param string|null $value */ public function email(?string $value): self { @@ -68,6 +74,8 @@ class BlikPaymentObjectBuilder /** * Sets one click field. + * + * @param BlikOneClickPaymentObject|null $value */ public function oneClick(?BlikOneClickPaymentObject $value): self { @@ -76,7 +84,7 @@ class BlikPaymentObjectBuilder } /** - * Initializes a new blik payment object object. + * Initializes a new Blik Payment Object object. */ public function build(): BlikPaymentObject { diff --git a/src/Models/Builders/BlikPaymentRequestBuilder.php b/src/Models/Builders/BlikPaymentRequestBuilder.php index 98c59f4..52f34fa 100644 --- a/src/Models/Builders/BlikPaymentRequestBuilder.php +++ b/src/Models/Builders/BlikPaymentRequestBuilder.php @@ -34,7 +34,10 @@ class BlikPaymentRequestBuilder } /** - * Initializes a new blik payment request Builder object. + * Initializes a new Blik Payment Request Builder object. + * + * @param string $name + * @param string $countryCode */ public static function init(string $name, string $countryCode): self { @@ -43,6 +46,8 @@ class BlikPaymentRequestBuilder /** * Sets email field. + * + * @param string|null $value */ public function email(?string $value): self { @@ -52,6 +57,8 @@ class BlikPaymentRequestBuilder /** * Sets experience context field. + * + * @param BlikExperienceContext|null $value */ public function experienceContext(?BlikExperienceContext $value): self { @@ -61,6 +68,8 @@ class BlikPaymentRequestBuilder /** * Sets level 0 field. + * + * @param BlikLevel0PaymentObject|null $value */ public function level0(?BlikLevel0PaymentObject $value): self { @@ -70,6 +79,8 @@ class BlikPaymentRequestBuilder /** * Sets one click field. + * + * @param BlikOneClickPaymentRequest|null $value */ public function oneClick(?BlikOneClickPaymentRequest $value): self { @@ -78,7 +89,7 @@ class BlikPaymentRequestBuilder } /** - * Initializes a new blik payment request object. + * Initializes a new Blik Payment Request object. */ public function build(): BlikPaymentRequest { diff --git a/src/Models/Builders/CallbackConfigurationBuilder.php b/src/Models/Builders/CallbackConfigurationBuilder.php new file mode 100644 index 0000000..75eb1bc --- /dev/null +++ b/src/Models/Builders/CallbackConfigurationBuilder.php @@ -0,0 +1,51 @@ +instance = $instance; + } + + /** + * Initializes a new Callback Configuration Builder object. + * + * @param string[] $callbackEvents + * @param string $callbackUrl + */ + public static function init(array $callbackEvents, string $callbackUrl): self + { + return new self(new CallbackConfiguration($callbackEvents, $callbackUrl)); + } + + /** + * Initializes a new Callback Configuration object. + */ + public function build(): CallbackConfiguration + { + return CoreHelper::clone($this->instance); + } +} diff --git a/src/Models/Builders/CapturePaymentInstructionBuilder.php b/src/Models/Builders/CapturePaymentInstructionBuilder.php index 46a0552..9b440a1 100644 --- a/src/Models/Builders/CapturePaymentInstructionBuilder.php +++ b/src/Models/Builders/CapturePaymentInstructionBuilder.php @@ -12,6 +12,7 @@ namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; use PaypalServerSdkLib\Models\CapturePaymentInstruction; +use PaypalServerSdkLib\Models\PlatformFee; /** * Builder for model CapturePaymentInstruction @@ -31,7 +32,7 @@ class CapturePaymentInstructionBuilder } /** - * Initializes a new capture payment instruction Builder object. + * Initializes a new Capture Payment Instruction Builder object. */ public static function init(): self { @@ -40,6 +41,8 @@ class CapturePaymentInstructionBuilder /** * Sets platform fees field. + * + * @param PlatformFee[]|null $value */ public function platformFees(?array $value): self { @@ -49,6 +52,8 @@ class CapturePaymentInstructionBuilder /** * Sets disbursement mode field. + * + * @param string|null $value */ public function disbursementMode(?string $value): self { @@ -58,6 +63,8 @@ class CapturePaymentInstructionBuilder /** * Sets payee receivable fx rate id field. + * + * @param string|null $value */ public function payeeReceivableFxRateId(?string $value): self { @@ -66,7 +73,7 @@ class CapturePaymentInstructionBuilder } /** - * Initializes a new capture payment instruction object. + * Initializes a new Capture Payment Instruction object. */ public function build(): CapturePaymentInstruction { diff --git a/src/Models/Builders/CaptureRequestBuilder.php b/src/Models/Builders/CaptureRequestBuilder.php index fcb67ba..1e0d5ff 100644 --- a/src/Models/Builders/CaptureRequestBuilder.php +++ b/src/Models/Builders/CaptureRequestBuilder.php @@ -33,7 +33,7 @@ class CaptureRequestBuilder } /** - * Initializes a new capture request Builder object. + * Initializes a new Capture Request Builder object. */ public static function init(): self { @@ -42,6 +42,8 @@ class CaptureRequestBuilder /** * Sets invoice id field. + * + * @param string|null $value */ public function invoiceId(?string $value): self { @@ -51,6 +53,8 @@ class CaptureRequestBuilder /** * Sets note to payer field. + * + * @param string|null $value */ public function noteToPayer(?string $value): self { @@ -60,6 +64,8 @@ class CaptureRequestBuilder /** * Sets amount field. + * + * @param Money|null $value */ public function amount(?Money $value): self { @@ -69,6 +75,8 @@ class CaptureRequestBuilder /** * Sets final capture field. + * + * @param bool|null $value */ public function finalCapture(?bool $value): self { @@ -78,6 +86,8 @@ class CaptureRequestBuilder /** * Sets payment instruction field. + * + * @param CapturePaymentInstruction|null $value */ public function paymentInstruction(?CapturePaymentInstruction $value): self { @@ -87,6 +97,8 @@ class CaptureRequestBuilder /** * Sets soft descriptor field. + * + * @param string|null $value */ public function softDescriptor(?string $value): self { @@ -95,7 +107,7 @@ class CaptureRequestBuilder } /** - * Initializes a new capture request object. + * Initializes a new Capture Request object. */ public function build(): CaptureRequest { diff --git a/src/Models/Builders/CaptureStatusDetailsBuilder.php b/src/Models/Builders/CaptureStatusDetailsBuilder.php index e155927..9ae268a 100644 --- a/src/Models/Builders/CaptureStatusDetailsBuilder.php +++ b/src/Models/Builders/CaptureStatusDetailsBuilder.php @@ -31,7 +31,7 @@ class CaptureStatusDetailsBuilder } /** - * Initializes a new capture status details Builder object. + * Initializes a new Capture Status Details Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class CaptureStatusDetailsBuilder /** * Sets reason field. + * + * @param string|null $value */ public function reason(?string $value): self { @@ -48,7 +50,7 @@ class CaptureStatusDetailsBuilder } /** - * Initializes a new capture status details object. + * Initializes a new Capture Status Details object. */ public function build(): CaptureStatusDetails { diff --git a/src/Models/Builders/CaptureStatusWithDetailsBuilder.php b/src/Models/Builders/CaptureStatusWithDetailsBuilder.php index 4777968..8450ef3 100644 --- a/src/Models/Builders/CaptureStatusWithDetailsBuilder.php +++ b/src/Models/Builders/CaptureStatusWithDetailsBuilder.php @@ -32,7 +32,7 @@ class CaptureStatusWithDetailsBuilder } /** - * Initializes a new capture status with details Builder object. + * Initializes a new Capture Status With Details Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class CaptureStatusWithDetailsBuilder /** * Sets status field. + * + * @param string|null $value */ public function status(?string $value): self { @@ -50,6 +52,8 @@ class CaptureStatusWithDetailsBuilder /** * Sets status details field. + * + * @param CaptureStatusDetails|null $value */ public function statusDetails(?CaptureStatusDetails $value): self { @@ -58,7 +62,7 @@ class CaptureStatusWithDetailsBuilder } /** - * Initializes a new capture status with details object. + * Initializes a new Capture Status With Details object. */ public function build(): CaptureStatusWithDetails { diff --git a/src/Models/Builders/CapturedPaymentBuilder.php b/src/Models/Builders/CapturedPaymentBuilder.php index 7f70c37..76ef28e 100644 --- a/src/Models/Builders/CapturedPaymentBuilder.php +++ b/src/Models/Builders/CapturedPaymentBuilder.php @@ -13,11 +13,12 @@ namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; use PaypalServerSdkLib\Models\CapturedPayment; use PaypalServerSdkLib\Models\CaptureStatusDetails; +use PaypalServerSdkLib\Models\LinkDescription; use PaypalServerSdkLib\Models\Money; use PaypalServerSdkLib\Models\NetworkTransactionReference; -use PaypalServerSdkLib\Models\Payee; +use PaypalServerSdkLib\Models\PayeeBase; +use PaypalServerSdkLib\Models\PaymentsProcessorResponse; use PaypalServerSdkLib\Models\PaymentSupplementaryData; -use PaypalServerSdkLib\Models\ProcessorResponse; use PaypalServerSdkLib\Models\SellerProtection; use PaypalServerSdkLib\Models\SellerReceivableBreakdown; @@ -39,7 +40,7 @@ class CapturedPaymentBuilder } /** - * Initializes a new captured payment Builder object. + * Initializes a new Captured Payment Builder object. */ public static function init(): self { @@ -48,6 +49,8 @@ class CapturedPaymentBuilder /** * Sets status field. + * + * @param string|null $value */ public function status(?string $value): self { @@ -57,6 +60,8 @@ class CapturedPaymentBuilder /** * Sets status details field. + * + * @param CaptureStatusDetails|null $value */ public function statusDetails(?CaptureStatusDetails $value): self { @@ -66,6 +71,8 @@ class CapturedPaymentBuilder /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -75,6 +82,8 @@ class CapturedPaymentBuilder /** * Sets amount field. + * + * @param Money|null $value */ public function amount(?Money $value): self { @@ -84,6 +93,8 @@ class CapturedPaymentBuilder /** * Sets invoice id field. + * + * @param string|null $value */ public function invoiceId(?string $value): self { @@ -93,6 +104,8 @@ class CapturedPaymentBuilder /** * Sets custom id field. + * + * @param string|null $value */ public function customId(?string $value): self { @@ -102,6 +115,8 @@ class CapturedPaymentBuilder /** * Sets network transaction reference field. + * + * @param NetworkTransactionReference|null $value */ public function networkTransactionReference(?NetworkTransactionReference $value): self { @@ -111,6 +126,8 @@ class CapturedPaymentBuilder /** * Sets seller protection field. + * + * @param SellerProtection|null $value */ public function sellerProtection(?SellerProtection $value): self { @@ -120,6 +137,8 @@ class CapturedPaymentBuilder /** * Sets final capture field. + * + * @param bool|null $value */ public function finalCapture(?bool $value): self { @@ -129,6 +148,8 @@ class CapturedPaymentBuilder /** * Sets seller receivable breakdown field. + * + * @param SellerReceivableBreakdown|null $value */ public function sellerReceivableBreakdown(?SellerReceivableBreakdown $value): self { @@ -138,6 +159,8 @@ class CapturedPaymentBuilder /** * Sets disbursement mode field. + * + * @param string|null $value */ public function disbursementMode(?string $value): self { @@ -147,6 +170,8 @@ class CapturedPaymentBuilder /** * Sets links field. + * + * @param LinkDescription[]|null $value */ public function links(?array $value): self { @@ -156,8 +181,10 @@ class CapturedPaymentBuilder /** * Sets processor response field. + * + * @param PaymentsProcessorResponse|null $value */ - public function processorResponse(?ProcessorResponse $value): self + public function processorResponse(?PaymentsProcessorResponse $value): self { $this->instance->setProcessorResponse($value); return $this; @@ -165,6 +192,8 @@ class CapturedPaymentBuilder /** * Sets create time field. + * + * @param string|null $value */ public function createTime(?string $value): self { @@ -174,6 +203,8 @@ class CapturedPaymentBuilder /** * Sets update time field. + * + * @param string|null $value */ public function updateTime(?string $value): self { @@ -183,6 +214,8 @@ class CapturedPaymentBuilder /** * Sets supplementary data field. + * + * @param PaymentSupplementaryData|null $value */ public function supplementaryData(?PaymentSupplementaryData $value): self { @@ -192,15 +225,17 @@ class CapturedPaymentBuilder /** * Sets payee field. + * + * @param PayeeBase|null $value */ - public function payee(?Payee $value): self + public function payee(?PayeeBase $value): self { $this->instance->setPayee($value); return $this; } /** - * Initializes a new captured payment object. + * Initializes a new Captured Payment object. */ public function build(): CapturedPayment { diff --git a/src/Models/Builders/CardAttributesBuilder.php b/src/Models/Builders/CardAttributesBuilder.php index cad06fe..646d63c 100644 --- a/src/Models/Builders/CardAttributesBuilder.php +++ b/src/Models/Builders/CardAttributesBuilder.php @@ -34,7 +34,7 @@ class CardAttributesBuilder } /** - * Initializes a new card attributes Builder object. + * Initializes a new Card Attributes Builder object. */ public static function init(): self { @@ -43,6 +43,8 @@ class CardAttributesBuilder /** * Sets customer field. + * + * @param CardCustomerInformation|null $value */ public function customer(?CardCustomerInformation $value): self { @@ -52,6 +54,8 @@ class CardAttributesBuilder /** * Sets vault field. + * + * @param VaultInstructionBase|null $value */ public function vault(?VaultInstructionBase $value): self { @@ -61,6 +65,8 @@ class CardAttributesBuilder /** * Sets verification field. + * + * @param CardVerification|null $value */ public function verification(?CardVerification $value): self { @@ -69,7 +75,7 @@ class CardAttributesBuilder } /** - * Initializes a new card attributes object. + * Initializes a new Card Attributes object. */ public function build(): CardAttributes { diff --git a/src/Models/Builders/CardAttributesResponseBuilder.php b/src/Models/Builders/CardAttributesResponseBuilder.php index 1b02067..779cb7c 100644 --- a/src/Models/Builders/CardAttributesResponseBuilder.php +++ b/src/Models/Builders/CardAttributesResponseBuilder.php @@ -32,7 +32,7 @@ class CardAttributesResponseBuilder } /** - * Initializes a new card attributes response Builder object. + * Initializes a new Card Attributes Response Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class CardAttributesResponseBuilder /** * Sets vault field. + * + * @param CardVaultResponse|null $value */ public function vault(?CardVaultResponse $value): self { @@ -49,7 +51,7 @@ class CardAttributesResponseBuilder } /** - * Initializes a new card attributes response object. + * Initializes a new Card Attributes Response object. */ public function build(): CardAttributesResponse { diff --git a/src/Models/Builders/CardAuthenticationResponseBuilder.php b/src/Models/Builders/CardAuthenticationResponseBuilder.php index 1ce45ad..5ecc65b 100644 --- a/src/Models/Builders/CardAuthenticationResponseBuilder.php +++ b/src/Models/Builders/CardAuthenticationResponseBuilder.php @@ -12,7 +12,7 @@ namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; use PaypalServerSdkLib\Models\CardAuthenticationResponse; -use PaypalServerSdkLib\Models\ThreeDSecureAuthenticationResponse; +use PaypalServerSdkLib\Models\ThreeDSecureCardAuthenticationResponse; /** * Builder for model CardAuthenticationResponse @@ -32,7 +32,7 @@ class CardAuthenticationResponseBuilder } /** - * Initializes a new card authentication response Builder object. + * Initializes a new Card Authentication Response Builder object. */ public static function init(): self { @@ -41,15 +41,17 @@ class CardAuthenticationResponseBuilder /** * Sets three d secure field. + * + * @param ThreeDSecureCardAuthenticationResponse|null $value */ - public function threeDSecure(?ThreeDSecureAuthenticationResponse $value): self + public function threeDSecure(?ThreeDSecureCardAuthenticationResponse $value): self { $this->instance->setThreeDSecure($value); return $this; } /** - * Initializes a new card authentication response object. + * Initializes a new Card Authentication Response object. */ public function build(): CardAuthenticationResponse { diff --git a/src/Models/Builders/CardCustomerInformationBuilder.php b/src/Models/Builders/CardCustomerInformationBuilder.php index 525105c..02242db 100644 --- a/src/Models/Builders/CardCustomerInformationBuilder.php +++ b/src/Models/Builders/CardCustomerInformationBuilder.php @@ -32,7 +32,7 @@ class CardCustomerInformationBuilder } /** - * Initializes a new card customer information Builder object. + * Initializes a new Card Customer Information Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class CardCustomerInformationBuilder /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -50,6 +52,8 @@ class CardCustomerInformationBuilder /** * Sets email address field. + * + * @param string|null $value */ public function emailAddress(?string $value): self { @@ -59,6 +63,8 @@ class CardCustomerInformationBuilder /** * Sets phone field. + * + * @param PhoneWithType|null $value */ public function phone(?PhoneWithType $value): self { @@ -68,6 +74,8 @@ class CardCustomerInformationBuilder /** * Sets merchant customer id field. + * + * @param string|null $value */ public function merchantCustomerId(?string $value): self { @@ -76,7 +84,7 @@ class CardCustomerInformationBuilder } /** - * Initializes a new card customer information object. + * Initializes a new Card Customer Information object. */ public function build(): CardCustomerInformation { diff --git a/src/Models/Builders/CardExperienceContextBuilder.php b/src/Models/Builders/CardExperienceContextBuilder.php index a206c25..6c6ffa4 100644 --- a/src/Models/Builders/CardExperienceContextBuilder.php +++ b/src/Models/Builders/CardExperienceContextBuilder.php @@ -31,7 +31,7 @@ class CardExperienceContextBuilder } /** - * Initializes a new card experience context Builder object. + * Initializes a new Card Experience Context Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class CardExperienceContextBuilder /** * Sets return url field. + * + * @param string|null $value */ public function returnUrl(?string $value): self { @@ -49,6 +51,8 @@ class CardExperienceContextBuilder /** * Sets cancel url field. + * + * @param string|null $value */ public function cancelUrl(?string $value): self { @@ -57,7 +61,7 @@ class CardExperienceContextBuilder } /** - * Initializes a new card experience context object. + * Initializes a new Card Experience Context object. */ public function build(): CardExperienceContext { diff --git a/src/Models/Builders/CardFromRequestBuilder.php b/src/Models/Builders/CardFromRequestBuilder.php index ab89cec..42ca3b2 100644 --- a/src/Models/Builders/CardFromRequestBuilder.php +++ b/src/Models/Builders/CardFromRequestBuilder.php @@ -31,7 +31,7 @@ class CardFromRequestBuilder } /** - * Initializes a new card from request Builder object. + * Initializes a new Card From Request Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class CardFromRequestBuilder /** * Sets expiry field. + * + * @param string|null $value */ public function expiry(?string $value): self { @@ -49,6 +51,8 @@ class CardFromRequestBuilder /** * Sets last digits field. + * + * @param string|null $value */ public function lastDigits(?string $value): self { @@ -57,7 +61,7 @@ class CardFromRequestBuilder } /** - * Initializes a new card from request object. + * Initializes a new Card From Request object. */ public function build(): CardFromRequest { diff --git a/src/Models/Builders/CardPaymentTokenBuilder.php b/src/Models/Builders/CardPaymentTokenBuilder.php deleted file mode 100644 index 200c10f..0000000 --- a/src/Models/Builders/CardPaymentTokenBuilder.php +++ /dev/null @@ -1,161 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new card payment token Builder object. - */ - public static function init(): self - { - return new self(new CardPaymentToken()); - } - - /** - * Sets name field. - */ - public function name(?string $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets last digits field. - */ - public function lastDigits(?string $value): self - { - $this->instance->setLastDigits($value); - return $this; - } - - /** - * Sets brand field. - */ - public function brand(?string $value): self - { - $this->instance->setBrand($value); - return $this; - } - - /** - * Sets expiry field. - */ - public function expiry(?string $value): self - { - $this->instance->setExpiry($value); - return $this; - } - - /** - * Sets billing address field. - */ - public function billingAddress(?AddressDetails $value): self - { - $this->instance->setBillingAddress($value); - return $this; - } - - /** - * Sets verification status field. - */ - public function verificationStatus(?string $value): self - { - $this->instance->setVerificationStatus($value); - return $this; - } - - /** - * Sets verification field. - */ - public function verification(?CardVerificationDetails $value): self - { - $this->instance->setVerification($value); - return $this; - } - - /** - * Sets network transaction reference field. - */ - public function networkTransactionReference(?NetworkTransactionReferenceEntity $value): self - { - $this->instance->setNetworkTransactionReference($value); - return $this; - } - - /** - * Sets authentication result field. - */ - public function authenticationResult(?CardAuthenticationResponse $value): self - { - $this->instance->setAuthenticationResult($value); - return $this; - } - - /** - * Sets bin details field. - */ - public function binDetails(?BinDetails $value): self - { - $this->instance->setBinDetails($value); - return $this; - } - - /** - * Sets type field. - */ - public function type(?string $value): self - { - $this->instance->setType($value); - return $this; - } - - /** - * Sets network token field. - */ - public function networkToken($value): self - { - $this->instance->setNetworkToken($value); - return $this; - } - - /** - * Initializes a new card payment token object. - */ - public function build(): CardPaymentToken - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/CardResponseEntityBuilder.php b/src/Models/Builders/CardPaymentTokenEntityBuilder.php similarity index 70% rename from src/Models/Builders/CardResponseEntityBuilder.php rename to src/Models/Builders/CardPaymentTokenEntityBuilder.php index a0e8120..c0a1126 100644 --- a/src/Models/Builders/CardResponseEntityBuilder.php +++ b/src/Models/Builders/CardPaymentTokenEntityBuilder.php @@ -11,40 +11,42 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; -use PaypalServerSdkLib\Models\AddressDetails; use PaypalServerSdkLib\Models\BinDetails; use PaypalServerSdkLib\Models\CardAuthenticationResponse; -use PaypalServerSdkLib\Models\CardResponseEntity; +use PaypalServerSdkLib\Models\CardPaymentTokenEntity; +use PaypalServerSdkLib\Models\CardResponseAddress; use PaypalServerSdkLib\Models\CardVerificationDetails; use PaypalServerSdkLib\Models\NetworkTransactionReferenceEntity; /** - * Builder for model CardResponseEntity + * Builder for model CardPaymentTokenEntity * - * @see CardResponseEntity + * @see CardPaymentTokenEntity */ -class CardResponseEntityBuilder +class CardPaymentTokenEntityBuilder { /** - * @var CardResponseEntity + * @var CardPaymentTokenEntity */ private $instance; - private function __construct(CardResponseEntity $instance) + private function __construct(CardPaymentTokenEntity $instance) { $this->instance = $instance; } /** - * Initializes a new card response entity Builder object. + * Initializes a new Card Payment Token Entity Builder object. */ public static function init(): self { - return new self(new CardResponseEntity()); + return new self(new CardPaymentTokenEntity()); } /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -54,6 +56,8 @@ class CardResponseEntityBuilder /** * Sets last digits field. + * + * @param string|null $value */ public function lastDigits(?string $value): self { @@ -63,6 +67,8 @@ class CardResponseEntityBuilder /** * Sets brand field. + * + * @param string|null $value */ public function brand(?string $value): self { @@ -72,6 +78,8 @@ class CardResponseEntityBuilder /** * Sets expiry field. + * + * @param string|null $value */ public function expiry(?string $value): self { @@ -81,8 +89,10 @@ class CardResponseEntityBuilder /** * Sets billing address field. + * + * @param CardResponseAddress|null $value */ - public function billingAddress(?AddressDetails $value): self + public function billingAddress(?CardResponseAddress $value): self { $this->instance->setBillingAddress($value); return $this; @@ -90,6 +100,8 @@ class CardResponseEntityBuilder /** * Sets verification status field. + * + * @param string|null $value */ public function verificationStatus(?string $value): self { @@ -99,6 +111,8 @@ class CardResponseEntityBuilder /** * Sets verification field. + * + * @param CardVerificationDetails|null $value */ public function verification(?CardVerificationDetails $value): self { @@ -108,6 +122,8 @@ class CardResponseEntityBuilder /** * Sets network transaction reference field. + * + * @param NetworkTransactionReferenceEntity|null $value */ public function networkTransactionReference(?NetworkTransactionReferenceEntity $value): self { @@ -117,6 +133,8 @@ class CardResponseEntityBuilder /** * Sets authentication result field. + * + * @param CardAuthenticationResponse|null $value */ public function authenticationResult(?CardAuthenticationResponse $value): self { @@ -126,6 +144,8 @@ class CardResponseEntityBuilder /** * Sets bin details field. + * + * @param BinDetails|null $value */ public function binDetails(?BinDetails $value): self { @@ -135,6 +155,8 @@ class CardResponseEntityBuilder /** * Sets type field. + * + * @param string|null $value */ public function type(?string $value): self { @@ -143,9 +165,9 @@ class CardResponseEntityBuilder } /** - * Initializes a new card response entity object. + * Initializes a new Card Payment Token Entity object. */ - public function build(): CardResponseEntity + public function build(): CardPaymentTokenEntity { return CoreHelper::clone($this->instance); } diff --git a/src/Models/Builders/CardRequestBuilder.php b/src/Models/Builders/CardRequestBuilder.php index 5790990..cf1e0b5 100644 --- a/src/Models/Builders/CardRequestBuilder.php +++ b/src/Models/Builders/CardRequestBuilder.php @@ -36,7 +36,7 @@ class CardRequestBuilder } /** - * Initializes a new card request Builder object. + * Initializes a new Card Request Builder object. */ public static function init(): self { @@ -45,6 +45,8 @@ class CardRequestBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -54,6 +56,8 @@ class CardRequestBuilder /** * Sets number field. + * + * @param string|null $value */ public function number(?string $value): self { @@ -63,6 +67,8 @@ class CardRequestBuilder /** * Sets expiry field. + * + * @param string|null $value */ public function expiry(?string $value): self { @@ -72,6 +78,8 @@ class CardRequestBuilder /** * Sets security code field. + * + * @param string|null $value */ public function securityCode(?string $value): self { @@ -81,6 +89,8 @@ class CardRequestBuilder /** * Sets billing address field. + * + * @param Address|null $value */ public function billingAddress(?Address $value): self { @@ -90,6 +100,8 @@ class CardRequestBuilder /** * Sets attributes field. + * + * @param CardAttributes|null $value */ public function attributes(?CardAttributes $value): self { @@ -99,6 +111,8 @@ class CardRequestBuilder /** * Sets vault id field. + * + * @param string|null $value */ public function vaultId(?string $value): self { @@ -108,6 +122,8 @@ class CardRequestBuilder /** * Sets single use token field. + * + * @param string|null $value */ public function singleUseToken(?string $value): self { @@ -117,6 +133,8 @@ class CardRequestBuilder /** * Sets stored credential field. + * + * @param CardStoredCredential|null $value */ public function storedCredential(?CardStoredCredential $value): self { @@ -126,6 +144,8 @@ class CardRequestBuilder /** * Sets network token field. + * + * @param NetworkToken|null $value */ public function networkToken(?NetworkToken $value): self { @@ -135,6 +155,8 @@ class CardRequestBuilder /** * Sets experience context field. + * + * @param CardExperienceContext|null $value */ public function experienceContext(?CardExperienceContext $value): self { @@ -143,7 +165,7 @@ class CardRequestBuilder } /** - * Initializes a new card request object. + * Initializes a new Card Request object. */ public function build(): CardRequest { diff --git a/src/Models/Builders/PortablePostalAddressMediumGrainedBuilder.php b/src/Models/Builders/CardResponseAddressBuilder.php similarity index 60% rename from src/Models/Builders/PortablePostalAddressMediumGrainedBuilder.php rename to src/Models/Builders/CardResponseAddressBuilder.php index cf5a606..b9d6053 100644 --- a/src/Models/Builders/PortablePostalAddressMediumGrainedBuilder.php +++ b/src/Models/Builders/CardResponseAddressBuilder.php @@ -11,35 +11,39 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; -use PaypalServerSdkLib\Models\PortablePostalAddressMediumGrained; +use PaypalServerSdkLib\Models\CardResponseAddress; /** - * Builder for model PortablePostalAddressMediumGrained + * Builder for model CardResponseAddress * - * @see PortablePostalAddressMediumGrained + * @see CardResponseAddress */ -class PortablePostalAddressMediumGrainedBuilder +class CardResponseAddressBuilder { /** - * @var PortablePostalAddressMediumGrained + * @var CardResponseAddress */ private $instance; - private function __construct(PortablePostalAddressMediumGrained $instance) + private function __construct(CardResponseAddress $instance) { $this->instance = $instance; } /** - * Initializes a new portable postal address medium grained Builder object. + * Initializes a new Card Response Address Builder object. + * + * @param string $countryCode */ public static function init(string $countryCode): self { - return new self(new PortablePostalAddressMediumGrained($countryCode)); + return new self(new CardResponseAddress($countryCode)); } /** * Sets address line 1 field. + * + * @param string|null $value */ public function addressLine1(?string $value): self { @@ -49,6 +53,8 @@ class PortablePostalAddressMediumGrainedBuilder /** * Sets address line 2 field. + * + * @param string|null $value */ public function addressLine2(?string $value): self { @@ -58,6 +64,8 @@ class PortablePostalAddressMediumGrainedBuilder /** * Sets admin area 2 field. + * + * @param string|null $value */ public function adminArea2(?string $value): self { @@ -67,6 +75,8 @@ class PortablePostalAddressMediumGrainedBuilder /** * Sets admin area 1 field. + * + * @param string|null $value */ public function adminArea1(?string $value): self { @@ -76,6 +86,8 @@ class PortablePostalAddressMediumGrainedBuilder /** * Sets postal code field. + * + * @param string|null $value */ public function postalCode(?string $value): self { @@ -84,9 +96,20 @@ class PortablePostalAddressMediumGrainedBuilder } /** - * Initializes a new portable postal address medium grained object. + * Sets id field. + * + * @param string|null $value */ - public function build(): PortablePostalAddressMediumGrained + public function id(?string $value): self + { + $this->instance->setId($value); + return $this; + } + + /** + * Initializes a new Card Response Address object. + */ + public function build(): CardResponseAddress { return CoreHelper::clone($this->instance); } diff --git a/src/Models/Builders/CardResponseBuilder.php b/src/Models/Builders/CardResponseBuilder.php index 28f5f0c..065bfe5 100644 --- a/src/Models/Builders/CardResponseBuilder.php +++ b/src/Models/Builders/CardResponseBuilder.php @@ -16,6 +16,7 @@ use PaypalServerSdkLib\Models\BinDetails; use PaypalServerSdkLib\Models\CardAttributesResponse; use PaypalServerSdkLib\Models\CardFromRequest; use PaypalServerSdkLib\Models\CardResponse; +use PaypalServerSdkLib\Models\CardStoredCredential; /** * Builder for model CardResponse @@ -35,7 +36,7 @@ class CardResponseBuilder } /** - * Initializes a new card response Builder object. + * Initializes a new Card Response Builder object. */ public static function init(): self { @@ -44,6 +45,8 @@ class CardResponseBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -53,6 +56,8 @@ class CardResponseBuilder /** * Sets last digits field. + * + * @param string|null $value */ public function lastDigits(?string $value): self { @@ -62,6 +67,8 @@ class CardResponseBuilder /** * Sets brand field. + * + * @param string|null $value */ public function brand(?string $value): self { @@ -71,6 +78,8 @@ class CardResponseBuilder /** * Sets available networks field. + * + * @param string[]|null $value */ public function availableNetworks(?array $value): self { @@ -80,6 +89,8 @@ class CardResponseBuilder /** * Sets type field. + * + * @param string|null $value */ public function type(?string $value): self { @@ -89,6 +100,8 @@ class CardResponseBuilder /** * Sets authentication result field. + * + * @param AuthenticationResponse|null $value */ public function authenticationResult(?AuthenticationResponse $value): self { @@ -98,6 +111,8 @@ class CardResponseBuilder /** * Sets attributes field. + * + * @param CardAttributesResponse|null $value */ public function attributes(?CardAttributesResponse $value): self { @@ -107,6 +122,8 @@ class CardResponseBuilder /** * Sets from request field. + * + * @param CardFromRequest|null $value */ public function fromRequest(?CardFromRequest $value): self { @@ -116,6 +133,8 @@ class CardResponseBuilder /** * Sets expiry field. + * + * @param string|null $value */ public function expiry(?string $value): self { @@ -125,6 +144,8 @@ class CardResponseBuilder /** * Sets bin details field. + * + * @param BinDetails|null $value */ public function binDetails(?BinDetails $value): self { @@ -133,7 +154,18 @@ class CardResponseBuilder } /** - * Initializes a new card response object. + * Sets stored credential field. + * + * @param CardStoredCredential|null $value + */ + public function storedCredential(?CardStoredCredential $value): self + { + $this->instance->setStoredCredential($value); + return $this; + } + + /** + * Initializes a new Card Response object. */ public function build(): CardResponse { diff --git a/src/Models/Builders/CardStoredCredentialBuilder.php b/src/Models/Builders/CardStoredCredentialBuilder.php index d4fab5e..77dc3d4 100644 --- a/src/Models/Builders/CardStoredCredentialBuilder.php +++ b/src/Models/Builders/CardStoredCredentialBuilder.php @@ -32,7 +32,10 @@ class CardStoredCredentialBuilder } /** - * Initializes a new card stored credential Builder object. + * Initializes a new Card Stored Credential Builder object. + * + * @param string $paymentInitiator + * @param string $paymentType */ public static function init(string $paymentInitiator, string $paymentType): self { @@ -41,6 +44,8 @@ class CardStoredCredentialBuilder /** * Sets usage field. + * + * @param string|null $value */ public function usage(?string $value): self { @@ -50,6 +55,8 @@ class CardStoredCredentialBuilder /** * Sets previous network transaction reference field. + * + * @param NetworkTransactionReference|null $value */ public function previousNetworkTransactionReference(?NetworkTransactionReference $value): self { @@ -58,7 +65,7 @@ class CardStoredCredentialBuilder } /** - * Initializes a new card stored credential object. + * Initializes a new Card Stored Credential object. */ public function build(): CardStoredCredential { diff --git a/src/Models/Builders/CardSupplementaryDataBuilder.php b/src/Models/Builders/CardSupplementaryDataBuilder.php index 87f63e5..2edf256 100644 --- a/src/Models/Builders/CardSupplementaryDataBuilder.php +++ b/src/Models/Builders/CardSupplementaryDataBuilder.php @@ -33,7 +33,7 @@ class CardSupplementaryDataBuilder } /** - * Initializes a new card supplementary data Builder object. + * Initializes a new Card Supplementary Data Builder object. */ public static function init(): self { @@ -42,6 +42,8 @@ class CardSupplementaryDataBuilder /** * Sets level 2 field. + * + * @param Level2CardProcessingData|null $value */ public function level2(?Level2CardProcessingData $value): self { @@ -51,6 +53,8 @@ class CardSupplementaryDataBuilder /** * Sets level 3 field. + * + * @param Level3CardProcessingData|null $value */ public function level3(?Level3CardProcessingData $value): self { @@ -59,7 +63,7 @@ class CardSupplementaryDataBuilder } /** - * Initializes a new card supplementary data object. + * Initializes a new Card Supplementary Data object. */ public function build(): CardSupplementaryData { diff --git a/src/Models/Builders/CardVaultResponseBuilder.php b/src/Models/Builders/CardVaultResponseBuilder.php index 7725e35..3798349 100644 --- a/src/Models/Builders/CardVaultResponseBuilder.php +++ b/src/Models/Builders/CardVaultResponseBuilder.php @@ -13,6 +13,7 @@ namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; use PaypalServerSdkLib\Models\CardCustomerInformation; use PaypalServerSdkLib\Models\CardVaultResponse; +use PaypalServerSdkLib\Models\LinkDescription; /** * Builder for model CardVaultResponse @@ -32,7 +33,7 @@ class CardVaultResponseBuilder } /** - * Initializes a new card vault response Builder object. + * Initializes a new Card Vault Response Builder object. */ public static function init(): self { @@ -41,6 +42,8 @@ class CardVaultResponseBuilder /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -50,6 +53,8 @@ class CardVaultResponseBuilder /** * Sets status field. + * + * @param string|null $value */ public function status(?string $value): self { @@ -59,6 +64,8 @@ class CardVaultResponseBuilder /** * Sets links field. + * + * @param LinkDescription[]|null $value */ public function links(?array $value): self { @@ -68,6 +75,8 @@ class CardVaultResponseBuilder /** * Sets customer field. + * + * @param CardCustomerInformation|null $value */ public function customer(?CardCustomerInformation $value): self { @@ -76,7 +85,7 @@ class CardVaultResponseBuilder } /** - * Initializes a new card vault response object. + * Initializes a new Card Vault Response object. */ public function build(): CardVaultResponse { diff --git a/src/Models/Builders/CardVerificationBuilder.php b/src/Models/Builders/CardVerificationBuilder.php index 77a973d..e799aa3 100644 --- a/src/Models/Builders/CardVerificationBuilder.php +++ b/src/Models/Builders/CardVerificationBuilder.php @@ -31,7 +31,7 @@ class CardVerificationBuilder } /** - * Initializes a new card verification Builder object. + * Initializes a new Card Verification Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class CardVerificationBuilder /** * Sets method field. + * + * @param string|null $value */ public function method(?string $value): self { @@ -48,7 +50,7 @@ class CardVerificationBuilder } /** - * Initializes a new card verification object. + * Initializes a new Card Verification object. */ public function build(): CardVerification { diff --git a/src/Models/Builders/CardVerificationDetailsBuilder.php b/src/Models/Builders/CardVerificationDetailsBuilder.php index 33e6f09..caeaee5 100644 --- a/src/Models/Builders/CardVerificationDetailsBuilder.php +++ b/src/Models/Builders/CardVerificationDetailsBuilder.php @@ -33,7 +33,7 @@ class CardVerificationDetailsBuilder } /** - * Initializes a new card verification details Builder object. + * Initializes a new Card Verification Details Builder object. */ public static function init(): self { @@ -42,6 +42,8 @@ class CardVerificationDetailsBuilder /** * Sets network transaction id field. + * + * @param string|null $value */ public function networkTransactionId(?string $value): self { @@ -51,6 +53,8 @@ class CardVerificationDetailsBuilder /** * Sets date field. + * + * @param string|null $value */ public function date(?string $value): self { @@ -60,6 +64,8 @@ class CardVerificationDetailsBuilder /** * Sets network field. + * + * @param string|null $value */ public function network(?string $value): self { @@ -69,6 +75,8 @@ class CardVerificationDetailsBuilder /** * Sets time field. + * + * @param string|null $value */ public function time(?string $value): self { @@ -78,6 +86,8 @@ class CardVerificationDetailsBuilder /** * Sets amount field. + * + * @param Money|null $value */ public function amount(?Money $value): self { @@ -87,6 +97,8 @@ class CardVerificationDetailsBuilder /** * Sets processor response field. + * + * @param CardVerificationProcessorResponse|null $value */ public function processorResponse(?CardVerificationProcessorResponse $value): self { @@ -96,6 +108,8 @@ class CardVerificationDetailsBuilder /** * Sets three d secure field. + * + * @param mixed $value */ public function threeDSecure($value): self { @@ -104,7 +118,7 @@ class CardVerificationDetailsBuilder } /** - * Initializes a new card verification details object. + * Initializes a new Card Verification Details object. */ public function build(): CardVerificationDetails { diff --git a/src/Models/Builders/CardVerificationProcessorResponseBuilder.php b/src/Models/Builders/CardVerificationProcessorResponseBuilder.php index c277341..a5d8b6b 100644 --- a/src/Models/Builders/CardVerificationProcessorResponseBuilder.php +++ b/src/Models/Builders/CardVerificationProcessorResponseBuilder.php @@ -31,7 +31,7 @@ class CardVerificationProcessorResponseBuilder } /** - * Initializes a new card verification processor response Builder object. + * Initializes a new Card Verification Processor Response Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class CardVerificationProcessorResponseBuilder /** * Sets avs code field. + * + * @param string|null $value */ public function avsCode(?string $value): self { @@ -49,6 +51,8 @@ class CardVerificationProcessorResponseBuilder /** * Sets cvv code field. + * + * @param string|null $value */ public function cvvCode(?string $value): self { @@ -57,7 +61,7 @@ class CardVerificationProcessorResponseBuilder } /** - * Initializes a new card verification processor response object. + * Initializes a new Card Verification Processor Response object. */ public function build(): CardVerificationProcessorResponse { diff --git a/src/Models/Builders/CobrandedCardBuilder.php b/src/Models/Builders/CobrandedCardBuilder.php index 15447eb..26d9fd0 100644 --- a/src/Models/Builders/CobrandedCardBuilder.php +++ b/src/Models/Builders/CobrandedCardBuilder.php @@ -33,7 +33,7 @@ class CobrandedCardBuilder } /** - * Initializes a new cobranded card Builder object. + * Initializes a new Cobranded Card Builder object. */ public static function init(): self { @@ -42,6 +42,8 @@ class CobrandedCardBuilder /** * Sets labels field. + * + * @param string[]|null $value */ public function labels(?array $value): self { @@ -51,6 +53,8 @@ class CobrandedCardBuilder /** * Sets payee field. + * + * @param PayeeBase|null $value */ public function payee(?PayeeBase $value): self { @@ -60,6 +64,8 @@ class CobrandedCardBuilder /** * Sets amount field. + * + * @param Money|null $value */ public function amount(?Money $value): self { @@ -68,7 +74,7 @@ class CobrandedCardBuilder } /** - * Initializes a new cobranded card object. + * Initializes a new Cobranded Card object. */ public function build(): CobrandedCard { diff --git a/src/Models/Builders/ConfirmOrderRequestBuilder.php b/src/Models/Builders/ConfirmOrderRequestBuilder.php index a58856f..b72eb8a 100644 --- a/src/Models/Builders/ConfirmOrderRequestBuilder.php +++ b/src/Models/Builders/ConfirmOrderRequestBuilder.php @@ -33,24 +33,19 @@ class ConfirmOrderRequestBuilder } /** - * Initializes a new confirm order request Builder object. + * Initializes a new Confirm Order Request Builder object. + * + * @param PaymentSource $paymentSource */ public static function init(PaymentSource $paymentSource): self { return new self(new ConfirmOrderRequest($paymentSource)); } - /** - * Sets processing instruction field. - */ - public function processingInstruction($value): self - { - $this->instance->setProcessingInstruction($value); - return $this; - } - /** * Sets application context field. + * + * @param OrderConfirmApplicationContext|null $value */ public function applicationContext(?OrderConfirmApplicationContext $value): self { @@ -59,7 +54,7 @@ class ConfirmOrderRequestBuilder } /** - * Initializes a new confirm order request object. + * Initializes a new Confirm Order Request object. */ public function build(): ConfirmOrderRequest { diff --git a/src/Models/Builders/CustomerRequestBuilder.php b/src/Models/Builders/CustomerBuilder.php similarity index 66% rename from src/Models/Builders/CustomerRequestBuilder.php rename to src/Models/Builders/CustomerBuilder.php index b57e18e..b07a761 100644 --- a/src/Models/Builders/CustomerRequestBuilder.php +++ b/src/Models/Builders/CustomerBuilder.php @@ -11,35 +11,37 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; -use PaypalServerSdkLib\Models\CustomerRequest; +use PaypalServerSdkLib\Models\Customer; /** - * Builder for model CustomerRequest + * Builder for model Customer * - * @see CustomerRequest + * @see Customer */ -class CustomerRequestBuilder +class CustomerBuilder { /** - * @var CustomerRequest + * @var Customer */ private $instance; - private function __construct(CustomerRequest $instance) + private function __construct(Customer $instance) { $this->instance = $instance; } /** - * Initializes a new customer request Builder object. + * Initializes a new Customer Builder object. */ public static function init(): self { - return new self(new CustomerRequest()); + return new self(new Customer()); } /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -49,6 +51,8 @@ class CustomerRequestBuilder /** * Sets merchant customer id field. + * + * @param string|null $value */ public function merchantCustomerId(?string $value): self { @@ -57,9 +61,9 @@ class CustomerRequestBuilder } /** - * Initializes a new customer request object. + * Initializes a new Customer object. */ - public function build(): CustomerRequest + public function build(): Customer { return CoreHelper::clone($this->instance); } diff --git a/src/Models/Builders/CustomerInformationBuilder.php b/src/Models/Builders/CustomerInformationBuilder.php index 6f097c9..c11e254 100644 --- a/src/Models/Builders/CustomerInformationBuilder.php +++ b/src/Models/Builders/CustomerInformationBuilder.php @@ -32,7 +32,7 @@ class CustomerInformationBuilder } /** - * Initializes a new customer information Builder object. + * Initializes a new Customer Information Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class CustomerInformationBuilder /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -50,6 +52,8 @@ class CustomerInformationBuilder /** * Sets email address field. + * + * @param string|null $value */ public function emailAddress(?string $value): self { @@ -59,6 +63,8 @@ class CustomerInformationBuilder /** * Sets phone field. + * + * @param PhoneWithType|null $value */ public function phone(?PhoneWithType $value): self { @@ -67,7 +73,7 @@ class CustomerInformationBuilder } /** - * Initializes a new customer information object. + * Initializes a new Customer Information object. */ public function build(): CustomerInformation { diff --git a/src/Models/Builders/CustomerResponseBuilder.php b/src/Models/Builders/CustomerResponseBuilder.php new file mode 100644 index 0000000..f4767fa --- /dev/null +++ b/src/Models/Builders/CustomerResponseBuilder.php @@ -0,0 +1,70 @@ +instance = $instance; + } + + /** + * Initializes a new Customer Response Builder object. + */ + public static function init(): self + { + return new self(new CustomerResponse()); + } + + /** + * Sets id field. + * + * @param string|null $value + */ + public function id(?string $value): self + { + $this->instance->setId($value); + return $this; + } + + /** + * Sets merchant customer id field. + * + * @param string|null $value + */ + public function merchantCustomerId(?string $value): self + { + $this->instance->setMerchantCustomerId($value); + return $this; + } + + /** + * Initializes a new Customer Response object. + */ + public function build(): CustomerResponse + { + return CoreHelper::clone($this->instance); + } +} diff --git a/src/Models/Builders/CustomerVaultPaymentTokensResponseBuilder.php b/src/Models/Builders/CustomerVaultPaymentTokensResponseBuilder.php index 3fadc75..094bad6 100644 --- a/src/Models/Builders/CustomerVaultPaymentTokensResponseBuilder.php +++ b/src/Models/Builders/CustomerVaultPaymentTokensResponseBuilder.php @@ -11,8 +11,10 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; -use PaypalServerSdkLib\Models\CustomerRequest; use PaypalServerSdkLib\Models\CustomerVaultPaymentTokensResponse; +use PaypalServerSdkLib\Models\LinkDescription; +use PaypalServerSdkLib\Models\PaymentTokenResponse; +use PaypalServerSdkLib\Models\VaultResponseCustomer; /** * Builder for model CustomerVaultPaymentTokensResponse @@ -32,7 +34,7 @@ class CustomerVaultPaymentTokensResponseBuilder } /** - * Initializes a new customer vault payment tokens response Builder object. + * Initializes a new Customer Vault Payment Tokens Response Builder object. */ public static function init(): self { @@ -41,6 +43,8 @@ class CustomerVaultPaymentTokensResponseBuilder /** * Sets total items field. + * + * @param int|null $value */ public function totalItems(?int $value): self { @@ -50,6 +54,8 @@ class CustomerVaultPaymentTokensResponseBuilder /** * Sets total pages field. + * + * @param int|null $value */ public function totalPages(?int $value): self { @@ -59,8 +65,10 @@ class CustomerVaultPaymentTokensResponseBuilder /** * Sets customer field. + * + * @param VaultResponseCustomer|null $value */ - public function customer(?CustomerRequest $value): self + public function customer(?VaultResponseCustomer $value): self { $this->instance->setCustomer($value); return $this; @@ -68,6 +76,8 @@ class CustomerVaultPaymentTokensResponseBuilder /** * Sets payment tokens field. + * + * @param PaymentTokenResponse[]|null $value */ public function paymentTokens(?array $value): self { @@ -77,6 +87,8 @@ class CustomerVaultPaymentTokensResponseBuilder /** * Sets links field. + * + * @param LinkDescription[]|null $value */ public function links(?array $value): self { @@ -85,7 +97,7 @@ class CustomerVaultPaymentTokensResponseBuilder } /** - * Initializes a new customer vault payment tokens response object. + * Initializes a new Customer Vault Payment Tokens Response object. */ public function build(): CustomerVaultPaymentTokensResponse { diff --git a/src/Models/Builders/EpsPaymentObjectBuilder.php b/src/Models/Builders/EpsPaymentObjectBuilder.php index 68b3886..331412b 100644 --- a/src/Models/Builders/EpsPaymentObjectBuilder.php +++ b/src/Models/Builders/EpsPaymentObjectBuilder.php @@ -31,7 +31,7 @@ class EpsPaymentObjectBuilder } /** - * Initializes a new eps payment object Builder object. + * Initializes a new Eps Payment Object Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class EpsPaymentObjectBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -49,6 +51,8 @@ class EpsPaymentObjectBuilder /** * Sets country code field. + * + * @param string|null $value */ public function countryCode(?string $value): self { @@ -58,6 +62,8 @@ class EpsPaymentObjectBuilder /** * Sets bic field. + * + * @param string|null $value */ public function bic(?string $value): self { @@ -66,7 +72,7 @@ class EpsPaymentObjectBuilder } /** - * Initializes a new eps payment object object. + * Initializes a new Eps Payment Object object. */ public function build(): EpsPaymentObject { diff --git a/src/Models/Builders/EpsPaymentRequestBuilder.php b/src/Models/Builders/EpsPaymentRequestBuilder.php index 1f49b81..0e9d54d 100644 --- a/src/Models/Builders/EpsPaymentRequestBuilder.php +++ b/src/Models/Builders/EpsPaymentRequestBuilder.php @@ -32,7 +32,10 @@ class EpsPaymentRequestBuilder } /** - * Initializes a new eps payment request Builder object. + * Initializes a new Eps Payment Request Builder object. + * + * @param string $name + * @param string $countryCode */ public static function init(string $name, string $countryCode): self { @@ -41,6 +44,8 @@ class EpsPaymentRequestBuilder /** * Sets experience context field. + * + * @param ExperienceContext|null $value */ public function experienceContext(?ExperienceContext $value): self { @@ -49,7 +54,7 @@ class EpsPaymentRequestBuilder } /** - * Initializes a new eps payment request object. + * Initializes a new Eps Payment Request object. */ public function build(): EpsPaymentRequest { diff --git a/src/Models/Builders/ErrorDetailsBuilder.php b/src/Models/Builders/ErrorDetailsBuilder.php index 762d6e5..03c452d 100644 --- a/src/Models/Builders/ErrorDetailsBuilder.php +++ b/src/Models/Builders/ErrorDetailsBuilder.php @@ -12,6 +12,7 @@ namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; use PaypalServerSdkLib\Models\ErrorDetails; +use PaypalServerSdkLib\Models\LinkDescription; /** * Builder for model ErrorDetails @@ -31,7 +32,9 @@ class ErrorDetailsBuilder } /** - * Initializes a new error details Builder object. + * Initializes a new Error Details Builder object. + * + * @param string $issue */ public static function init(string $issue): self { @@ -40,6 +43,8 @@ class ErrorDetailsBuilder /** * Sets field field. + * + * @param string|null $value */ public function field(?string $value): self { @@ -49,6 +54,8 @@ class ErrorDetailsBuilder /** * Sets value field. + * + * @param string|null $value */ public function value(?string $value): self { @@ -58,6 +65,8 @@ class ErrorDetailsBuilder /** * Sets location field. + * + * @param string|null $value */ public function location(?string $value): self { @@ -67,6 +76,8 @@ class ErrorDetailsBuilder /** * Sets links field. + * + * @param LinkDescription[]|null $value */ public function links(?array $value): self { @@ -76,6 +87,8 @@ class ErrorDetailsBuilder /** * Sets description field. + * + * @param string|null $value */ public function description(?string $value): self { @@ -84,7 +97,7 @@ class ErrorDetailsBuilder } /** - * Initializes a new error details object. + * Initializes a new Error Details object. */ public function build(): ErrorDetails { diff --git a/src/Models/Builders/ExchangeRateBuilder.php b/src/Models/Builders/ExchangeRateBuilder.php index 21d5c12..93cc539 100644 --- a/src/Models/Builders/ExchangeRateBuilder.php +++ b/src/Models/Builders/ExchangeRateBuilder.php @@ -31,7 +31,7 @@ class ExchangeRateBuilder } /** - * Initializes a new exchange rate Builder object. + * Initializes a new Exchange Rate Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class ExchangeRateBuilder /** * Sets source currency field. + * + * @param string|null $value */ public function sourceCurrency(?string $value): self { @@ -49,6 +51,8 @@ class ExchangeRateBuilder /** * Sets target currency field. + * + * @param string|null $value */ public function targetCurrency(?string $value): self { @@ -58,6 +62,8 @@ class ExchangeRateBuilder /** * Sets value field. + * + * @param string|null $value */ public function value(?string $value): self { @@ -66,7 +72,7 @@ class ExchangeRateBuilder } /** - * Initializes a new exchange rate object. + * Initializes a new Exchange Rate object. */ public function build(): ExchangeRate { diff --git a/src/Models/Builders/ExperienceContextBuilder.php b/src/Models/Builders/ExperienceContextBuilder.php index cc07447..9b2fc47 100644 --- a/src/Models/Builders/ExperienceContextBuilder.php +++ b/src/Models/Builders/ExperienceContextBuilder.php @@ -31,7 +31,7 @@ class ExperienceContextBuilder } /** - * Initializes a new experience context Builder object. + * Initializes a new Experience Context Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class ExperienceContextBuilder /** * Sets brand name field. + * + * @param string|null $value */ public function brandName(?string $value): self { @@ -49,6 +51,8 @@ class ExperienceContextBuilder /** * Sets locale field. + * + * @param string|null $value */ public function locale(?string $value): self { @@ -58,6 +62,8 @@ class ExperienceContextBuilder /** * Sets shipping preference field. + * + * @param string|null $value */ public function shippingPreference(?string $value): self { @@ -67,6 +73,8 @@ class ExperienceContextBuilder /** * Sets return url field. + * + * @param string|null $value */ public function returnUrl(?string $value): self { @@ -76,6 +84,8 @@ class ExperienceContextBuilder /** * Sets cancel url field. + * + * @param string|null $value */ public function cancelUrl(?string $value): self { @@ -84,7 +94,7 @@ class ExperienceContextBuilder } /** - * Initializes a new experience context object. + * Initializes a new Experience Context object. */ public function build(): ExperienceContext { diff --git a/src/Models/Builders/GiropayPaymentObjectBuilder.php b/src/Models/Builders/GiropayPaymentObjectBuilder.php index af31c35..be5eeed 100644 --- a/src/Models/Builders/GiropayPaymentObjectBuilder.php +++ b/src/Models/Builders/GiropayPaymentObjectBuilder.php @@ -31,7 +31,7 @@ class GiropayPaymentObjectBuilder } /** - * Initializes a new giropay payment object Builder object. + * Initializes a new Giropay Payment Object Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class GiropayPaymentObjectBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -49,6 +51,8 @@ class GiropayPaymentObjectBuilder /** * Sets country code field. + * + * @param string|null $value */ public function countryCode(?string $value): self { @@ -58,6 +62,8 @@ class GiropayPaymentObjectBuilder /** * Sets bic field. + * + * @param string|null $value */ public function bic(?string $value): self { @@ -66,7 +72,7 @@ class GiropayPaymentObjectBuilder } /** - * Initializes a new giropay payment object object. + * Initializes a new Giropay Payment Object object. */ public function build(): GiropayPaymentObject { diff --git a/src/Models/Builders/GiropayPaymentRequestBuilder.php b/src/Models/Builders/GiropayPaymentRequestBuilder.php index 596fcfa..b65509e 100644 --- a/src/Models/Builders/GiropayPaymentRequestBuilder.php +++ b/src/Models/Builders/GiropayPaymentRequestBuilder.php @@ -32,7 +32,10 @@ class GiropayPaymentRequestBuilder } /** - * Initializes a new giropay payment request Builder object. + * Initializes a new Giropay Payment Request Builder object. + * + * @param string $name + * @param string $countryCode */ public static function init(string $name, string $countryCode): self { @@ -41,6 +44,8 @@ class GiropayPaymentRequestBuilder /** * Sets experience context field. + * + * @param ExperienceContext|null $value */ public function experienceContext(?ExperienceContext $value): self { @@ -49,7 +54,7 @@ class GiropayPaymentRequestBuilder } /** - * Initializes a new giropay payment request object. + * Initializes a new Giropay Payment Request object. */ public function build(): GiropayPaymentRequest { diff --git a/src/Models/Builders/GooglePayCardAttributesBuilder.php b/src/Models/Builders/GooglePayCardAttributesBuilder.php deleted file mode 100644 index 71d6532..0000000 --- a/src/Models/Builders/GooglePayCardAttributesBuilder.php +++ /dev/null @@ -1,58 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new google pay card attributes Builder object. - */ - public static function init(): self - { - return new self(new GooglePayCardAttributes()); - } - - /** - * Sets verification field. - */ - public function verification(?CardVerification $value): self - { - $this->instance->setVerification($value); - return $this; - } - - /** - * Initializes a new google pay card attributes object. - */ - public function build(): GooglePayCardAttributes - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/GooglePayCardBuilder.php b/src/Models/Builders/GooglePayCardBuilder.php index 1413d56..598768c 100644 --- a/src/Models/Builders/GooglePayCardBuilder.php +++ b/src/Models/Builders/GooglePayCardBuilder.php @@ -11,8 +11,8 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; +use PaypalServerSdkLib\Models\Address; use PaypalServerSdkLib\Models\GooglePayCard; -use PaypalServerSdkLib\Models\PortablePostalAddressMediumGrained; /** * Builder for model GooglePayCard @@ -32,7 +32,7 @@ class GooglePayCardBuilder } /** - * Initializes a new google pay card Builder object. + * Initializes a new Google Pay Card Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class GooglePayCardBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -50,6 +52,8 @@ class GooglePayCardBuilder /** * Sets number field. + * + * @param string|null $value */ public function number(?string $value): self { @@ -59,6 +63,8 @@ class GooglePayCardBuilder /** * Sets expiry field. + * + * @param string|null $value */ public function expiry(?string $value): self { @@ -68,6 +74,8 @@ class GooglePayCardBuilder /** * Sets last digits field. + * + * @param string|null $value */ public function lastDigits(?string $value): self { @@ -77,6 +85,8 @@ class GooglePayCardBuilder /** * Sets type field. + * + * @param string|null $value */ public function type(?string $value): self { @@ -86,6 +96,8 @@ class GooglePayCardBuilder /** * Sets brand field. + * + * @param string|null $value */ public function brand(?string $value): self { @@ -95,15 +107,17 @@ class GooglePayCardBuilder /** * Sets billing address field. + * + * @param Address|null $value */ - public function billingAddress(?PortablePostalAddressMediumGrained $value): self + public function billingAddress(?Address $value): self { $this->instance->setBillingAddress($value); return $this; } /** - * Initializes a new google pay card object. + * Initializes a new Google Pay Card object. */ public function build(): GooglePayCard { diff --git a/src/Models/Builders/GooglePayCardResponseBuilder.php b/src/Models/Builders/GooglePayCardResponseBuilder.php index 7a730b1..acff6f6 100644 --- a/src/Models/Builders/GooglePayCardResponseBuilder.php +++ b/src/Models/Builders/GooglePayCardResponseBuilder.php @@ -33,7 +33,7 @@ class GooglePayCardResponseBuilder } /** - * Initializes a new google pay card response Builder object. + * Initializes a new Google Pay Card Response Builder object. */ public static function init(): self { @@ -42,6 +42,8 @@ class GooglePayCardResponseBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -51,6 +53,8 @@ class GooglePayCardResponseBuilder /** * Sets last digits field. + * + * @param string|null $value */ public function lastDigits(?string $value): self { @@ -60,6 +64,8 @@ class GooglePayCardResponseBuilder /** * Sets type field. + * + * @param string|null $value */ public function type(?string $value): self { @@ -69,6 +75,8 @@ class GooglePayCardResponseBuilder /** * Sets brand field. + * + * @param string|null $value */ public function brand(?string $value): self { @@ -78,6 +86,8 @@ class GooglePayCardResponseBuilder /** * Sets billing address field. + * + * @param Address|null $value */ public function billingAddress(?Address $value): self { @@ -87,6 +97,8 @@ class GooglePayCardResponseBuilder /** * Sets authentication result field. + * + * @param AuthenticationResponse|null $value */ public function authenticationResult(?AuthenticationResponse $value): self { @@ -95,7 +107,7 @@ class GooglePayCardResponseBuilder } /** - * Initializes a new google pay card response object. + * Initializes a new Google Pay Card Response object. */ public function build(): GooglePayCardResponse { diff --git a/src/Models/Builders/GooglePayDecryptedTokenDataBuilder.php b/src/Models/Builders/GooglePayDecryptedTokenDataBuilder.php index 4d46394..04f3432 100644 --- a/src/Models/Builders/GooglePayDecryptedTokenDataBuilder.php +++ b/src/Models/Builders/GooglePayDecryptedTokenDataBuilder.php @@ -32,7 +32,11 @@ class GooglePayDecryptedTokenDataBuilder } /** - * Initializes a new google pay decrypted token data Builder object. + * Initializes a new Google Pay Decrypted Token Data Builder object. + * + * @param string $paymentMethod + * @param GooglePayCard $card + * @param string $authenticationMethod */ public static function init(string $paymentMethod, GooglePayCard $card, string $authenticationMethod): self { @@ -41,6 +45,8 @@ class GooglePayDecryptedTokenDataBuilder /** * Sets message id field. + * + * @param string|null $value */ public function messageId(?string $value): self { @@ -50,6 +56,8 @@ class GooglePayDecryptedTokenDataBuilder /** * Sets message expiration field. + * + * @param string|null $value */ public function messageExpiration(?string $value): self { @@ -59,6 +67,8 @@ class GooglePayDecryptedTokenDataBuilder /** * Sets cryptogram field. + * + * @param string|null $value */ public function cryptogram(?string $value): self { @@ -68,6 +78,8 @@ class GooglePayDecryptedTokenDataBuilder /** * Sets eci indicator field. + * + * @param string|null $value */ public function eciIndicator(?string $value): self { @@ -76,7 +88,7 @@ class GooglePayDecryptedTokenDataBuilder } /** - * Initializes a new google pay decrypted token data object. + * Initializes a new Google Pay Decrypted Token Data object. */ public function build(): GooglePayDecryptedTokenData { diff --git a/src/Models/Builders/GooglePayRequestBuilder.php b/src/Models/Builders/GooglePayRequestBuilder.php index 01604de..728e4f9 100644 --- a/src/Models/Builders/GooglePayRequestBuilder.php +++ b/src/Models/Builders/GooglePayRequestBuilder.php @@ -12,7 +12,6 @@ namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; use PaypalServerSdkLib\Models\AssuranceDetails; -use PaypalServerSdkLib\Models\GooglePayCardAttributes; use PaypalServerSdkLib\Models\GooglePayDecryptedTokenData; use PaypalServerSdkLib\Models\GooglePayRequest; use PaypalServerSdkLib\Models\GooglePayRequestCard; @@ -36,7 +35,7 @@ class GooglePayRequestBuilder } /** - * Initializes a new google pay request Builder object. + * Initializes a new Google Pay Request Builder object. */ public static function init(): self { @@ -45,6 +44,8 @@ class GooglePayRequestBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -54,6 +55,8 @@ class GooglePayRequestBuilder /** * Sets email address field. + * + * @param string|null $value */ public function emailAddress(?string $value): self { @@ -63,6 +66,8 @@ class GooglePayRequestBuilder /** * Sets phone number field. + * + * @param PhoneNumberWithCountryCode|null $value */ public function phoneNumber(?PhoneNumberWithCountryCode $value): self { @@ -72,6 +77,8 @@ class GooglePayRequestBuilder /** * Sets card field. + * + * @param GooglePayRequestCard|null $value */ public function card(?GooglePayRequestCard $value): self { @@ -81,6 +88,8 @@ class GooglePayRequestBuilder /** * Sets decrypted token field. + * + * @param GooglePayDecryptedTokenData|null $value */ public function decryptedToken(?GooglePayDecryptedTokenData $value): self { @@ -90,6 +99,8 @@ class GooglePayRequestBuilder /** * Sets assurance details field. + * + * @param AssuranceDetails|null $value */ public function assuranceDetails(?AssuranceDetails $value): self { @@ -98,16 +109,7 @@ class GooglePayRequestBuilder } /** - * Sets attributes field. - */ - public function attributes(?GooglePayCardAttributes $value): self - { - $this->instance->setAttributes($value); - return $this; - } - - /** - * Initializes a new google pay request object. + * Initializes a new Google Pay Request object. */ public function build(): GooglePayRequest { diff --git a/src/Models/Builders/GooglePayRequestCardBuilder.php b/src/Models/Builders/GooglePayRequestCardBuilder.php index 2b3d155..d962c48 100644 --- a/src/Models/Builders/GooglePayRequestCardBuilder.php +++ b/src/Models/Builders/GooglePayRequestCardBuilder.php @@ -32,7 +32,7 @@ class GooglePayRequestCardBuilder } /** - * Initializes a new google pay request card Builder object. + * Initializes a new Google Pay Request Card Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class GooglePayRequestCardBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -50,6 +52,8 @@ class GooglePayRequestCardBuilder /** * Sets type field. + * + * @param string|null $value */ public function type(?string $value): self { @@ -59,6 +63,8 @@ class GooglePayRequestCardBuilder /** * Sets brand field. + * + * @param string|null $value */ public function brand(?string $value): self { @@ -68,6 +74,8 @@ class GooglePayRequestCardBuilder /** * Sets billing address field. + * + * @param Address|null $value */ public function billingAddress(?Address $value): self { @@ -76,7 +84,7 @@ class GooglePayRequestCardBuilder } /** - * Initializes a new google pay request card object. + * Initializes a new Google Pay Request Card object. */ public function build(): GooglePayRequestCard { diff --git a/src/Models/Builders/GooglePayWalletResponseBuilder.php b/src/Models/Builders/GooglePayWalletResponseBuilder.php index 506cdd6..232cfe1 100644 --- a/src/Models/Builders/GooglePayWalletResponseBuilder.php +++ b/src/Models/Builders/GooglePayWalletResponseBuilder.php @@ -33,7 +33,7 @@ class GooglePayWalletResponseBuilder } /** - * Initializes a new google pay wallet response Builder object. + * Initializes a new Google Pay Wallet Response Builder object. */ public static function init(): self { @@ -42,6 +42,8 @@ class GooglePayWalletResponseBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -51,6 +53,8 @@ class GooglePayWalletResponseBuilder /** * Sets email address field. + * + * @param string|null $value */ public function emailAddress(?string $value): self { @@ -60,6 +64,8 @@ class GooglePayWalletResponseBuilder /** * Sets phone number field. + * + * @param PhoneNumberWithCountryCode|null $value */ public function phoneNumber(?PhoneNumberWithCountryCode $value): self { @@ -69,6 +75,8 @@ class GooglePayWalletResponseBuilder /** * Sets card field. + * + * @param GooglePayCardResponse|null $value */ public function card(?GooglePayCardResponse $value): self { @@ -77,7 +85,7 @@ class GooglePayWalletResponseBuilder } /** - * Initializes a new google pay wallet response object. + * Initializes a new Google Pay Wallet Response object. */ public function build(): GooglePayWalletResponse { diff --git a/src/Models/Builders/IdealPaymentObjectBuilder.php b/src/Models/Builders/IdealPaymentObjectBuilder.php index 1e16a79..0532d7d 100644 --- a/src/Models/Builders/IdealPaymentObjectBuilder.php +++ b/src/Models/Builders/IdealPaymentObjectBuilder.php @@ -31,7 +31,7 @@ class IdealPaymentObjectBuilder } /** - * Initializes a new ideal payment object Builder object. + * Initializes a new Ideal Payment Object Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class IdealPaymentObjectBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -49,6 +51,8 @@ class IdealPaymentObjectBuilder /** * Sets country code field. + * + * @param string|null $value */ public function countryCode(?string $value): self { @@ -58,6 +62,8 @@ class IdealPaymentObjectBuilder /** * Sets bic field. + * + * @param string|null $value */ public function bic(?string $value): self { @@ -67,6 +73,8 @@ class IdealPaymentObjectBuilder /** * Sets iban last chars field. + * + * @param string|null $value */ public function ibanLastChars(?string $value): self { @@ -75,7 +83,7 @@ class IdealPaymentObjectBuilder } /** - * Initializes a new ideal payment object object. + * Initializes a new Ideal Payment Object object. */ public function build(): IdealPaymentObject { diff --git a/src/Models/Builders/IdealPaymentRequestBuilder.php b/src/Models/Builders/IdealPaymentRequestBuilder.php index e4b74ed..2089032 100644 --- a/src/Models/Builders/IdealPaymentRequestBuilder.php +++ b/src/Models/Builders/IdealPaymentRequestBuilder.php @@ -32,7 +32,10 @@ class IdealPaymentRequestBuilder } /** - * Initializes a new ideal payment request Builder object. + * Initializes a new Ideal Payment Request Builder object. + * + * @param string $name + * @param string $countryCode */ public static function init(string $name, string $countryCode): self { @@ -41,6 +44,8 @@ class IdealPaymentRequestBuilder /** * Sets bic field. + * + * @param string|null $value */ public function bic(?string $value): self { @@ -50,6 +55,8 @@ class IdealPaymentRequestBuilder /** * Sets experience context field. + * + * @param ExperienceContext|null $value */ public function experienceContext(?ExperienceContext $value): self { @@ -58,7 +65,7 @@ class IdealPaymentRequestBuilder } /** - * Initializes a new ideal payment request object. + * Initializes a new Ideal Payment Request object. */ public function build(): IdealPaymentRequest { diff --git a/src/Models/Builders/ItemBuilder.php b/src/Models/Builders/ItemBuilder.php index e1214ce..83986c8 100644 --- a/src/Models/Builders/ItemBuilder.php +++ b/src/Models/Builders/ItemBuilder.php @@ -33,7 +33,11 @@ class ItemBuilder } /** - * Initializes a new item Builder object. + * Initializes a new Item Builder object. + * + * @param string $name + * @param Money $unitAmount + * @param string $quantity */ public static function init(string $name, Money $unitAmount, string $quantity): self { @@ -42,6 +46,8 @@ class ItemBuilder /** * Sets tax field. + * + * @param Money|null $value */ public function tax(?Money $value): self { @@ -51,6 +57,8 @@ class ItemBuilder /** * Sets description field. + * + * @param string|null $value */ public function description(?string $value): self { @@ -60,6 +68,8 @@ class ItemBuilder /** * Sets sku field. + * + * @param string|null $value */ public function sku(?string $value): self { @@ -69,6 +79,8 @@ class ItemBuilder /** * Sets url field. + * + * @param string|null $value */ public function url(?string $value): self { @@ -78,6 +90,8 @@ class ItemBuilder /** * Sets category field. + * + * @param string|null $value */ public function category(?string $value): self { @@ -87,6 +101,8 @@ class ItemBuilder /** * Sets image url field. + * + * @param string|null $value */ public function imageUrl(?string $value): self { @@ -96,6 +112,8 @@ class ItemBuilder /** * Sets upc field. + * + * @param UniversalProductCode|null $value */ public function upc(?UniversalProductCode $value): self { @@ -104,7 +122,7 @@ class ItemBuilder } /** - * Initializes a new item object. + * Initializes a new Item object. */ public function build(): Item { diff --git a/src/Models/Builders/Level2CardProcessingDataBuilder.php b/src/Models/Builders/Level2CardProcessingDataBuilder.php index b10bc93..97704b5 100644 --- a/src/Models/Builders/Level2CardProcessingDataBuilder.php +++ b/src/Models/Builders/Level2CardProcessingDataBuilder.php @@ -32,7 +32,7 @@ class Level2CardProcessingDataBuilder } /** - * Initializes a new level 2 card processing data Builder object. + * Initializes a new Level 2 Card Processing Data Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class Level2CardProcessingDataBuilder /** * Sets invoice id field. + * + * @param string|null $value */ public function invoiceId(?string $value): self { @@ -50,6 +52,8 @@ class Level2CardProcessingDataBuilder /** * Sets tax total field. + * + * @param Money|null $value */ public function taxTotal(?Money $value): self { @@ -58,7 +62,7 @@ class Level2CardProcessingDataBuilder } /** - * Initializes a new level 2 card processing data object. + * Initializes a new Level 2 Card Processing Data object. */ public function build(): Level2CardProcessingData { diff --git a/src/Models/Builders/Level3CardProcessingDataBuilder.php b/src/Models/Builders/Level3CardProcessingDataBuilder.php index d36cd17..885123e 100644 --- a/src/Models/Builders/Level3CardProcessingDataBuilder.php +++ b/src/Models/Builders/Level3CardProcessingDataBuilder.php @@ -13,6 +13,7 @@ namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; use PaypalServerSdkLib\Models\Address; use PaypalServerSdkLib\Models\Level3CardProcessingData; +use PaypalServerSdkLib\Models\LineItem; use PaypalServerSdkLib\Models\Money; /** @@ -33,7 +34,7 @@ class Level3CardProcessingDataBuilder } /** - * Initializes a new level 3 card processing data Builder object. + * Initializes a new Level 3 Card Processing Data Builder object. */ public static function init(): self { @@ -42,6 +43,8 @@ class Level3CardProcessingDataBuilder /** * Sets shipping amount field. + * + * @param Money|null $value */ public function shippingAmount(?Money $value): self { @@ -51,6 +54,8 @@ class Level3CardProcessingDataBuilder /** * Sets duty amount field. + * + * @param Money|null $value */ public function dutyAmount(?Money $value): self { @@ -60,6 +65,8 @@ class Level3CardProcessingDataBuilder /** * Sets discount amount field. + * + * @param Money|null $value */ public function discountAmount(?Money $value): self { @@ -69,6 +76,8 @@ class Level3CardProcessingDataBuilder /** * Sets shipping address field. + * + * @param Address|null $value */ public function shippingAddress(?Address $value): self { @@ -78,6 +87,8 @@ class Level3CardProcessingDataBuilder /** * Sets ships from postal code field. + * + * @param string|null $value */ public function shipsFromPostalCode(?string $value): self { @@ -87,6 +98,8 @@ class Level3CardProcessingDataBuilder /** * Sets line items field. + * + * @param LineItem[]|null $value */ public function lineItems(?array $value): self { @@ -95,7 +108,7 @@ class Level3CardProcessingDataBuilder } /** - * Initializes a new level 3 card processing data object. + * Initializes a new Level 3 Card Processing Data object. */ public function build(): Level3CardProcessingData { diff --git a/src/Models/Builders/LineItemBuilder.php b/src/Models/Builders/LineItemBuilder.php index 6a4738e..2c8c438 100644 --- a/src/Models/Builders/LineItemBuilder.php +++ b/src/Models/Builders/LineItemBuilder.php @@ -33,7 +33,10 @@ class LineItemBuilder } /** - * Initializes a new line item Builder object. + * Initializes a new Line Item Builder object. + * + * @param string $name + * @param string $quantity */ public static function init(string $name, string $quantity): self { @@ -42,6 +45,8 @@ class LineItemBuilder /** * Sets description field. + * + * @param string|null $value */ public function description(?string $value): self { @@ -51,6 +56,8 @@ class LineItemBuilder /** * Sets sku field. + * + * @param string|null $value */ public function sku(?string $value): self { @@ -60,6 +67,8 @@ class LineItemBuilder /** * Sets url field. + * + * @param string|null $value */ public function url(?string $value): self { @@ -69,6 +78,8 @@ class LineItemBuilder /** * Sets image url field. + * + * @param string|null $value */ public function imageUrl(?string $value): self { @@ -78,6 +89,8 @@ class LineItemBuilder /** * Sets upc field. + * + * @param UniversalProductCode|null $value */ public function upc(?UniversalProductCode $value): self { @@ -87,6 +100,8 @@ class LineItemBuilder /** * Sets unit amount field. + * + * @param Money|null $value */ public function unitAmount(?Money $value): self { @@ -96,6 +111,8 @@ class LineItemBuilder /** * Sets tax field. + * + * @param Money|null $value */ public function tax(?Money $value): self { @@ -105,6 +122,8 @@ class LineItemBuilder /** * Sets commodity code field. + * + * @param string|null $value */ public function commodityCode(?string $value): self { @@ -114,6 +133,8 @@ class LineItemBuilder /** * Sets discount amount field. + * + * @param Money|null $value */ public function discountAmount(?Money $value): self { @@ -123,6 +144,8 @@ class LineItemBuilder /** * Sets total amount field. + * + * @param Money|null $value */ public function totalAmount(?Money $value): self { @@ -132,6 +155,8 @@ class LineItemBuilder /** * Sets unit of measure field. + * + * @param string|null $value */ public function unitOfMeasure(?string $value): self { @@ -140,7 +165,7 @@ class LineItemBuilder } /** - * Initializes a new line item object. + * Initializes a new Line Item object. */ public function build(): LineItem { diff --git a/src/Models/Builders/LinkDescriptionBuilder.php b/src/Models/Builders/LinkDescriptionBuilder.php index f93e230..67e7d68 100644 --- a/src/Models/Builders/LinkDescriptionBuilder.php +++ b/src/Models/Builders/LinkDescriptionBuilder.php @@ -31,7 +31,10 @@ class LinkDescriptionBuilder } /** - * Initializes a new link description Builder object. + * Initializes a new Link Description Builder object. + * + * @param string $href + * @param string $rel */ public static function init(string $href, string $rel): self { @@ -40,6 +43,8 @@ class LinkDescriptionBuilder /** * Sets method field. + * + * @param string|null $value */ public function method(?string $value): self { @@ -48,7 +53,7 @@ class LinkDescriptionBuilder } /** - * Initializes a new link description object. + * Initializes a new Link Description object. */ public function build(): LinkDescription { diff --git a/src/Models/Builders/MoneyBuilder.php b/src/Models/Builders/MoneyBuilder.php index 42e40c2..9df2e4c 100644 --- a/src/Models/Builders/MoneyBuilder.php +++ b/src/Models/Builders/MoneyBuilder.php @@ -31,7 +31,10 @@ class MoneyBuilder } /** - * Initializes a new money Builder object. + * Initializes a new Money Builder object. + * + * @param string $currencyCode + * @param string $value */ public static function init(string $currencyCode, string $value): self { @@ -39,7 +42,7 @@ class MoneyBuilder } /** - * Initializes a new money object. + * Initializes a new Money object. */ public function build(): Money { diff --git a/src/Models/Builders/MybankPaymentObjectBuilder.php b/src/Models/Builders/MybankPaymentObjectBuilder.php index 6e180a6..d8cb7e5 100644 --- a/src/Models/Builders/MybankPaymentObjectBuilder.php +++ b/src/Models/Builders/MybankPaymentObjectBuilder.php @@ -31,7 +31,7 @@ class MybankPaymentObjectBuilder } /** - * Initializes a new mybank payment object Builder object. + * Initializes a new Mybank Payment Object Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class MybankPaymentObjectBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -49,6 +51,8 @@ class MybankPaymentObjectBuilder /** * Sets country code field. + * + * @param string|null $value */ public function countryCode(?string $value): self { @@ -58,6 +62,8 @@ class MybankPaymentObjectBuilder /** * Sets bic field. + * + * @param string|null $value */ public function bic(?string $value): self { @@ -67,6 +73,8 @@ class MybankPaymentObjectBuilder /** * Sets iban last chars field. + * + * @param string|null $value */ public function ibanLastChars(?string $value): self { @@ -75,7 +83,7 @@ class MybankPaymentObjectBuilder } /** - * Initializes a new mybank payment object object. + * Initializes a new Mybank Payment Object object. */ public function build(): MybankPaymentObject { diff --git a/src/Models/Builders/MybankPaymentRequestBuilder.php b/src/Models/Builders/MybankPaymentRequestBuilder.php index 0602bc4..5f617d9 100644 --- a/src/Models/Builders/MybankPaymentRequestBuilder.php +++ b/src/Models/Builders/MybankPaymentRequestBuilder.php @@ -32,7 +32,10 @@ class MybankPaymentRequestBuilder } /** - * Initializes a new mybank payment request Builder object. + * Initializes a new Mybank Payment Request Builder object. + * + * @param string $name + * @param string $countryCode */ public static function init(string $name, string $countryCode): self { @@ -41,6 +44,8 @@ class MybankPaymentRequestBuilder /** * Sets experience context field. + * + * @param ExperienceContext|null $value */ public function experienceContext(?ExperienceContext $value): self { @@ -49,7 +54,7 @@ class MybankPaymentRequestBuilder } /** - * Initializes a new mybank payment request object. + * Initializes a new Mybank Payment Request object. */ public function build(): MybankPaymentRequest { diff --git a/src/Models/Builders/NameBuilder.php b/src/Models/Builders/NameBuilder.php index c10ed2b..f2a3e26 100644 --- a/src/Models/Builders/NameBuilder.php +++ b/src/Models/Builders/NameBuilder.php @@ -31,7 +31,7 @@ class NameBuilder } /** - * Initializes a new name Builder object. + * Initializes a new Name Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class NameBuilder /** * Sets given name field. + * + * @param string|null $value */ public function givenName(?string $value): self { @@ -49,6 +51,8 @@ class NameBuilder /** * Sets surname field. + * + * @param string|null $value */ public function surname(?string $value): self { @@ -57,7 +61,7 @@ class NameBuilder } /** - * Initializes a new name object. + * Initializes a new Name object. */ public function build(): Name { diff --git a/src/Models/Builders/NetAmountBreakdownItemBuilder.php b/src/Models/Builders/NetAmountBreakdownItemBuilder.php index 88b4be2..4c9c2af 100644 --- a/src/Models/Builders/NetAmountBreakdownItemBuilder.php +++ b/src/Models/Builders/NetAmountBreakdownItemBuilder.php @@ -33,7 +33,7 @@ class NetAmountBreakdownItemBuilder } /** - * Initializes a new net amount breakdown item Builder object. + * Initializes a new Net Amount Breakdown Item Builder object. */ public static function init(): self { @@ -42,6 +42,8 @@ class NetAmountBreakdownItemBuilder /** * Sets payable amount field. + * + * @param Money|null $value */ public function payableAmount(?Money $value): self { @@ -51,6 +53,8 @@ class NetAmountBreakdownItemBuilder /** * Sets converted amount field. + * + * @param Money|null $value */ public function convertedAmount(?Money $value): self { @@ -60,6 +64,8 @@ class NetAmountBreakdownItemBuilder /** * Sets exchange rate field. + * + * @param ExchangeRate|null $value */ public function exchangeRate(?ExchangeRate $value): self { @@ -68,7 +74,7 @@ class NetAmountBreakdownItemBuilder } /** - * Initializes a new net amount breakdown item object. + * Initializes a new Net Amount Breakdown Item object. */ public function build(): NetAmountBreakdownItem { diff --git a/src/Models/Builders/NetworkTokenBuilder.php b/src/Models/Builders/NetworkTokenBuilder.php index 813c091..bd73c0e 100644 --- a/src/Models/Builders/NetworkTokenBuilder.php +++ b/src/Models/Builders/NetworkTokenBuilder.php @@ -31,7 +31,10 @@ class NetworkTokenBuilder } /** - * Initializes a new network token Builder object. + * Initializes a new Network Token Builder object. + * + * @param string $number + * @param string $expiry */ public static function init(string $number, string $expiry): self { @@ -40,6 +43,8 @@ class NetworkTokenBuilder /** * Sets cryptogram field. + * + * @param string|null $value */ public function cryptogram(?string $value): self { @@ -49,6 +54,8 @@ class NetworkTokenBuilder /** * Sets eci flag field. + * + * @param string|null $value */ public function eciFlag(?string $value): self { @@ -58,6 +65,8 @@ class NetworkTokenBuilder /** * Sets token requestor id field. + * + * @param string|null $value */ public function tokenRequestorId(?string $value): self { @@ -66,7 +75,7 @@ class NetworkTokenBuilder } /** - * Initializes a new network token object. + * Initializes a new Network Token object. */ public function build(): NetworkToken { diff --git a/src/Models/Builders/NetworkTransactionReferenceBuilder.php b/src/Models/Builders/NetworkTransactionReferenceBuilder.php index 675542b..ab51d52 100644 --- a/src/Models/Builders/NetworkTransactionReferenceBuilder.php +++ b/src/Models/Builders/NetworkTransactionReferenceBuilder.php @@ -31,7 +31,9 @@ class NetworkTransactionReferenceBuilder } /** - * Initializes a new network transaction reference Builder object. + * Initializes a new Network Transaction Reference Builder object. + * + * @param string $id */ public static function init(string $id): self { @@ -40,6 +42,8 @@ class NetworkTransactionReferenceBuilder /** * Sets date field. + * + * @param string|null $value */ public function date(?string $value): self { @@ -49,6 +53,8 @@ class NetworkTransactionReferenceBuilder /** * Sets network field. + * + * @param string|null $value */ public function network(?string $value): self { @@ -58,6 +64,8 @@ class NetworkTransactionReferenceBuilder /** * Sets acquirer reference number field. + * + * @param string|null $value */ public function acquirerReferenceNumber(?string $value): self { @@ -66,7 +74,7 @@ class NetworkTransactionReferenceBuilder } /** - * Initializes a new network transaction reference object. + * Initializes a new Network Transaction Reference object. */ public function build(): NetworkTransactionReference { diff --git a/src/Models/Builders/NetworkTransactionReferenceEntityBuilder.php b/src/Models/Builders/NetworkTransactionReferenceEntityBuilder.php index d801976..6f86e3b 100644 --- a/src/Models/Builders/NetworkTransactionReferenceEntityBuilder.php +++ b/src/Models/Builders/NetworkTransactionReferenceEntityBuilder.php @@ -31,7 +31,9 @@ class NetworkTransactionReferenceEntityBuilder } /** - * Initializes a new network transaction reference entity Builder object. + * Initializes a new Network Transaction Reference Entity Builder object. + * + * @param string $id */ public static function init(string $id): self { @@ -40,6 +42,8 @@ class NetworkTransactionReferenceEntityBuilder /** * Sets date field. + * + * @param string|null $value */ public function date(?string $value): self { @@ -49,6 +53,8 @@ class NetworkTransactionReferenceEntityBuilder /** * Sets network field. + * + * @param string|null $value */ public function network(?string $value): self { @@ -58,6 +64,8 @@ class NetworkTransactionReferenceEntityBuilder /** * Sets time field. + * + * @param string|null $value */ public function time(?string $value): self { @@ -66,7 +74,7 @@ class NetworkTransactionReferenceEntityBuilder } /** - * Initializes a new network transaction reference entity object. + * Initializes a new Network Transaction Reference Entity object. */ public function build(): NetworkTransactionReferenceEntity { diff --git a/src/Models/Builders/OAuthTokenBuilder.php b/src/Models/Builders/OAuthTokenBuilder.php index e09070c..ac8227f 100644 --- a/src/Models/Builders/OAuthTokenBuilder.php +++ b/src/Models/Builders/OAuthTokenBuilder.php @@ -31,7 +31,10 @@ class OAuthTokenBuilder } /** - * Initializes a new oauth token Builder object. + * Initializes a new O Auth Token Builder object. + * + * @param string $accessToken + * @param string $tokenType */ public static function init(string $accessToken, string $tokenType): self { @@ -40,6 +43,8 @@ class OAuthTokenBuilder /** * Sets expires in field. + * + * @param int|null $value */ public function expiresIn(?int $value): self { @@ -49,6 +54,8 @@ class OAuthTokenBuilder /** * Sets scope field. + * + * @param string|null $value */ public function scope(?string $value): self { @@ -58,6 +65,8 @@ class OAuthTokenBuilder /** * Sets expiry field. + * + * @param int|null $value */ public function expiry(?int $value): self { @@ -67,6 +76,8 @@ class OAuthTokenBuilder /** * Sets refresh token field. + * + * @param string|null $value */ public function refreshToken(?string $value): self { @@ -76,6 +87,8 @@ class OAuthTokenBuilder /** * Sets id token field. + * + * @param string|null $value */ public function idToken(?string $value): self { @@ -84,7 +97,7 @@ class OAuthTokenBuilder } /** - * Initializes a new oauth token object. + * Initializes a new O Auth Token object. */ public function build(): OAuthToken { diff --git a/src/Models/Builders/OneTimeChargeBuilder.php b/src/Models/Builders/OneTimeChargeBuilder.php new file mode 100644 index 0000000..aad8b3b --- /dev/null +++ b/src/Models/Builders/OneTimeChargeBuilder.php @@ -0,0 +1,106 @@ +instance = $instance; + } + + /** + * Initializes a new One Time Charge Builder object. + * + * @param Money $totalAmount + */ + public static function init(Money $totalAmount): self + { + return new self(new OneTimeCharge($totalAmount)); + } + + /** + * Sets setup fee field. + * + * @param Money|null $value + */ + public function setupFee(?Money $value): self + { + $this->instance->setSetupFee($value); + return $this; + } + + /** + * Sets shipping amount field. + * + * @param Money|null $value + */ + public function shippingAmount(?Money $value): self + { + $this->instance->setShippingAmount($value); + return $this; + } + + /** + * Sets taxes field. + * + * @param Money|null $value + */ + public function taxes(?Money $value): self + { + $this->instance->setTaxes($value); + return $this; + } + + /** + * Sets product price field. + * + * @param Money|null $value + */ + public function productPrice(?Money $value): self + { + $this->instance->setProductPrice($value); + return $this; + } + + /** + * Sets subtotal field. + * + * @param Money|null $value + */ + public function subtotal(?Money $value): self + { + $this->instance->setSubtotal($value); + return $this; + } + + /** + * Initializes a new One Time Charge object. + */ + public function build(): OneTimeCharge + { + return CoreHelper::clone($this->instance); + } +} diff --git a/src/Models/Builders/OrderApplicationContextBuilder.php b/src/Models/Builders/OrderApplicationContextBuilder.php index 31e0181..d854ce8 100644 --- a/src/Models/Builders/OrderApplicationContextBuilder.php +++ b/src/Models/Builders/OrderApplicationContextBuilder.php @@ -33,7 +33,7 @@ class OrderApplicationContextBuilder } /** - * Initializes a new order application context Builder object. + * Initializes a new Order Application Context Builder object. */ public static function init(): self { @@ -42,6 +42,8 @@ class OrderApplicationContextBuilder /** * Sets brand name field. + * + * @param string|null $value */ public function brandName(?string $value): self { @@ -51,6 +53,8 @@ class OrderApplicationContextBuilder /** * Sets locale field. + * + * @param string|null $value */ public function locale(?string $value): self { @@ -60,6 +64,8 @@ class OrderApplicationContextBuilder /** * Sets landing page field. + * + * @param string|null $value */ public function landingPage(?string $value): self { @@ -69,6 +75,8 @@ class OrderApplicationContextBuilder /** * Sets shipping preference field. + * + * @param string|null $value */ public function shippingPreference(?string $value): self { @@ -78,6 +86,8 @@ class OrderApplicationContextBuilder /** * Sets user action field. + * + * @param string|null $value */ public function userAction(?string $value): self { @@ -87,6 +97,8 @@ class OrderApplicationContextBuilder /** * Sets payment method field. + * + * @param PaymentMethodPreference|null $value */ public function paymentMethod(?PaymentMethodPreference $value): self { @@ -96,6 +108,8 @@ class OrderApplicationContextBuilder /** * Sets return url field. + * + * @param string|null $value */ public function returnUrl(?string $value): self { @@ -105,6 +119,8 @@ class OrderApplicationContextBuilder /** * Sets cancel url field. + * + * @param string|null $value */ public function cancelUrl(?string $value): self { @@ -114,6 +130,8 @@ class OrderApplicationContextBuilder /** * Sets stored payment source field. + * + * @param StoredPaymentSource|null $value */ public function storedPaymentSource(?StoredPaymentSource $value): self { @@ -122,7 +140,7 @@ class OrderApplicationContextBuilder } /** - * Initializes a new order application context object. + * Initializes a new Order Application Context object. */ public function build(): OrderApplicationContext { diff --git a/src/Models/Builders/OrderAuthorizeRequestBuilder.php b/src/Models/Builders/OrderAuthorizeRequestBuilder.php index 38ad3b8..a419073 100644 --- a/src/Models/Builders/OrderAuthorizeRequestBuilder.php +++ b/src/Models/Builders/OrderAuthorizeRequestBuilder.php @@ -32,7 +32,7 @@ class OrderAuthorizeRequestBuilder } /** - * Initializes a new order authorize request Builder object. + * Initializes a new Order Authorize Request Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class OrderAuthorizeRequestBuilder /** * Sets payment source field. + * + * @param OrderAuthorizeRequestPaymentSource|null $value */ public function paymentSource(?OrderAuthorizeRequestPaymentSource $value): self { @@ -49,7 +51,7 @@ class OrderAuthorizeRequestBuilder } /** - * Initializes a new order authorize request object. + * Initializes a new Order Authorize Request object. */ public function build(): OrderAuthorizeRequest { diff --git a/src/Models/Builders/OrderAuthorizeRequestPaymentSourceBuilder.php b/src/Models/Builders/OrderAuthorizeRequestPaymentSourceBuilder.php index f79ec3d..570bc2c 100644 --- a/src/Models/Builders/OrderAuthorizeRequestPaymentSourceBuilder.php +++ b/src/Models/Builders/OrderAuthorizeRequestPaymentSourceBuilder.php @@ -37,7 +37,7 @@ class OrderAuthorizeRequestPaymentSourceBuilder } /** - * Initializes a new order authorize request payment source Builder object. + * Initializes a new Order Authorize Request Payment Source Builder object. */ public static function init(): self { @@ -46,6 +46,8 @@ class OrderAuthorizeRequestPaymentSourceBuilder /** * Sets card field. + * + * @param CardRequest|null $value */ public function card(?CardRequest $value): self { @@ -55,6 +57,8 @@ class OrderAuthorizeRequestPaymentSourceBuilder /** * Sets token field. + * + * @param Token|null $value */ public function token(?Token $value): self { @@ -64,6 +68,8 @@ class OrderAuthorizeRequestPaymentSourceBuilder /** * Sets paypal field. + * + * @param PaypalWallet|null $value */ public function paypal(?PaypalWallet $value): self { @@ -73,6 +79,8 @@ class OrderAuthorizeRequestPaymentSourceBuilder /** * Sets apple pay field. + * + * @param ApplePayRequest|null $value */ public function applePay(?ApplePayRequest $value): self { @@ -82,6 +90,8 @@ class OrderAuthorizeRequestPaymentSourceBuilder /** * Sets google pay field. + * + * @param GooglePayRequest|null $value */ public function googlePay(?GooglePayRequest $value): self { @@ -91,6 +101,8 @@ class OrderAuthorizeRequestPaymentSourceBuilder /** * Sets venmo field. + * + * @param VenmoWalletRequest|null $value */ public function venmo(?VenmoWalletRequest $value): self { @@ -99,7 +111,7 @@ class OrderAuthorizeRequestPaymentSourceBuilder } /** - * Initializes a new order authorize request payment source object. + * Initializes a new Order Authorize Request Payment Source object. */ public function build(): OrderAuthorizeRequestPaymentSource { diff --git a/src/Models/Builders/OrderAuthorizeResponseBuilder.php b/src/Models/Builders/OrderAuthorizeResponseBuilder.php index 7bd11a3..8fe65c3 100644 --- a/src/Models/Builders/OrderAuthorizeResponseBuilder.php +++ b/src/Models/Builders/OrderAuthorizeResponseBuilder.php @@ -11,9 +11,11 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; +use PaypalServerSdkLib\Models\LinkDescription; use PaypalServerSdkLib\Models\OrderAuthorizeResponse; use PaypalServerSdkLib\Models\OrderAuthorizeResponsePaymentSource; use PaypalServerSdkLib\Models\Payer; +use PaypalServerSdkLib\Models\PurchaseUnit; /** * Builder for model OrderAuthorizeResponse @@ -33,7 +35,7 @@ class OrderAuthorizeResponseBuilder } /** - * Initializes a new order authorize response Builder object. + * Initializes a new Order Authorize Response Builder object. */ public static function init(): self { @@ -42,6 +44,8 @@ class OrderAuthorizeResponseBuilder /** * Sets create time field. + * + * @param string|null $value */ public function createTime(?string $value): self { @@ -51,6 +55,8 @@ class OrderAuthorizeResponseBuilder /** * Sets update time field. + * + * @param string|null $value */ public function updateTime(?string $value): self { @@ -60,6 +66,8 @@ class OrderAuthorizeResponseBuilder /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -69,6 +77,8 @@ class OrderAuthorizeResponseBuilder /** * Sets payment source field. + * + * @param OrderAuthorizeResponsePaymentSource|null $value */ public function paymentSource(?OrderAuthorizeResponsePaymentSource $value): self { @@ -78,6 +88,8 @@ class OrderAuthorizeResponseBuilder /** * Sets intent field. + * + * @param string|null $value */ public function intent(?string $value): self { @@ -85,17 +97,10 @@ class OrderAuthorizeResponseBuilder return $this; } - /** - * Sets processing instruction field. - */ - public function processingInstruction($value): self - { - $this->instance->setProcessingInstruction($value); - return $this; - } - /** * Sets payer field. + * + * @param Payer|null $value */ public function payer(?Payer $value): self { @@ -105,6 +110,8 @@ class OrderAuthorizeResponseBuilder /** * Sets purchase units field. + * + * @param PurchaseUnit[]|null $value */ public function purchaseUnits(?array $value): self { @@ -114,6 +121,8 @@ class OrderAuthorizeResponseBuilder /** * Sets status field. + * + * @param string|null $value */ public function status(?string $value): self { @@ -123,6 +132,8 @@ class OrderAuthorizeResponseBuilder /** * Sets links field. + * + * @param LinkDescription[]|null $value */ public function links(?array $value): self { @@ -131,7 +142,7 @@ class OrderAuthorizeResponseBuilder } /** - * Initializes a new order authorize response object. + * Initializes a new Order Authorize Response object. */ public function build(): OrderAuthorizeResponse { diff --git a/src/Models/Builders/OrderAuthorizeResponsePaymentSourceBuilder.php b/src/Models/Builders/OrderAuthorizeResponsePaymentSourceBuilder.php index 46be382..ad8d3d0 100644 --- a/src/Models/Builders/OrderAuthorizeResponsePaymentSourceBuilder.php +++ b/src/Models/Builders/OrderAuthorizeResponsePaymentSourceBuilder.php @@ -36,7 +36,7 @@ class OrderAuthorizeResponsePaymentSourceBuilder } /** - * Initializes a new order authorize response payment source Builder object. + * Initializes a new Order Authorize Response Payment Source Builder object. */ public static function init(): self { @@ -45,6 +45,8 @@ class OrderAuthorizeResponsePaymentSourceBuilder /** * Sets card field. + * + * @param CardResponse|null $value */ public function card(?CardResponse $value): self { @@ -54,6 +56,8 @@ class OrderAuthorizeResponsePaymentSourceBuilder /** * Sets paypal field. + * + * @param PaypalWalletResponse|null $value */ public function paypal(?PaypalWalletResponse $value): self { @@ -63,6 +67,8 @@ class OrderAuthorizeResponsePaymentSourceBuilder /** * Sets apple pay field. + * + * @param ApplePayPaymentObject|null $value */ public function applePay(?ApplePayPaymentObject $value): self { @@ -72,6 +78,8 @@ class OrderAuthorizeResponsePaymentSourceBuilder /** * Sets google pay field. + * + * @param GooglePayWalletResponse|null $value */ public function googlePay(?GooglePayWalletResponse $value): self { @@ -81,6 +89,8 @@ class OrderAuthorizeResponsePaymentSourceBuilder /** * Sets venmo field. + * + * @param VenmoWalletResponse|null $value */ public function venmo(?VenmoWalletResponse $value): self { @@ -89,7 +99,7 @@ class OrderAuthorizeResponsePaymentSourceBuilder } /** - * Initializes a new order authorize response payment source object. + * Initializes a new Order Authorize Response Payment Source object. */ public function build(): OrderAuthorizeResponsePaymentSource { diff --git a/src/Models/Builders/OrderBuilder.php b/src/Models/Builders/OrderBuilder.php index 8a85b1b..ca2e9c5 100644 --- a/src/Models/Builders/OrderBuilder.php +++ b/src/Models/Builders/OrderBuilder.php @@ -11,9 +11,11 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; +use PaypalServerSdkLib\Models\LinkDescription; use PaypalServerSdkLib\Models\Order; use PaypalServerSdkLib\Models\Payer; use PaypalServerSdkLib\Models\PaymentSourceResponse; +use PaypalServerSdkLib\Models\PurchaseUnit; /** * Builder for model Order @@ -33,7 +35,7 @@ class OrderBuilder } /** - * Initializes a new order Builder object. + * Initializes a new Order Builder object. */ public static function init(): self { @@ -42,6 +44,8 @@ class OrderBuilder /** * Sets create time field. + * + * @param string|null $value */ public function createTime(?string $value): self { @@ -51,6 +55,8 @@ class OrderBuilder /** * Sets update time field. + * + * @param string|null $value */ public function updateTime(?string $value): self { @@ -60,6 +66,8 @@ class OrderBuilder /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -69,6 +77,8 @@ class OrderBuilder /** * Sets payment source field. + * + * @param PaymentSourceResponse|null $value */ public function paymentSource(?PaymentSourceResponse $value): self { @@ -78,6 +88,8 @@ class OrderBuilder /** * Sets intent field. + * + * @param string|null $value */ public function intent(?string $value): self { @@ -85,17 +97,10 @@ class OrderBuilder return $this; } - /** - * Sets processing instruction field. - */ - public function processingInstruction($value): self - { - $this->instance->setProcessingInstruction($value); - return $this; - } - /** * Sets payer field. + * + * @param Payer|null $value */ public function payer(?Payer $value): self { @@ -105,6 +110,8 @@ class OrderBuilder /** * Sets purchase units field. + * + * @param PurchaseUnit[]|null $value */ public function purchaseUnits(?array $value): self { @@ -114,6 +121,8 @@ class OrderBuilder /** * Sets status field. + * + * @param string|null $value */ public function status(?string $value): self { @@ -123,6 +132,8 @@ class OrderBuilder /** * Sets links field. + * + * @param LinkDescription[]|null $value */ public function links(?array $value): self { @@ -131,7 +142,7 @@ class OrderBuilder } /** - * Initializes a new order object. + * Initializes a new Order object. */ public function build(): Order { diff --git a/src/Models/Builders/OrderCaptureRequestBuilder.php b/src/Models/Builders/OrderCaptureRequestBuilder.php index 41175c9..4aa59d6 100644 --- a/src/Models/Builders/OrderCaptureRequestBuilder.php +++ b/src/Models/Builders/OrderCaptureRequestBuilder.php @@ -32,7 +32,7 @@ class OrderCaptureRequestBuilder } /** - * Initializes a new order capture request Builder object. + * Initializes a new Order Capture Request Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class OrderCaptureRequestBuilder /** * Sets payment source field. + * + * @param OrderCaptureRequestPaymentSource|null $value */ public function paymentSource(?OrderCaptureRequestPaymentSource $value): self { @@ -49,7 +51,7 @@ class OrderCaptureRequestBuilder } /** - * Initializes a new order capture request object. + * Initializes a new Order Capture Request object. */ public function build(): OrderCaptureRequest { diff --git a/src/Models/Builders/OrderCaptureRequestPaymentSourceBuilder.php b/src/Models/Builders/OrderCaptureRequestPaymentSourceBuilder.php index 538a12c..79666a5 100644 --- a/src/Models/Builders/OrderCaptureRequestPaymentSourceBuilder.php +++ b/src/Models/Builders/OrderCaptureRequestPaymentSourceBuilder.php @@ -37,7 +37,7 @@ class OrderCaptureRequestPaymentSourceBuilder } /** - * Initializes a new order capture request payment source Builder object. + * Initializes a new Order Capture Request Payment Source Builder object. */ public static function init(): self { @@ -46,6 +46,8 @@ class OrderCaptureRequestPaymentSourceBuilder /** * Sets card field. + * + * @param CardRequest|null $value */ public function card(?CardRequest $value): self { @@ -55,6 +57,8 @@ class OrderCaptureRequestPaymentSourceBuilder /** * Sets token field. + * + * @param Token|null $value */ public function token(?Token $value): self { @@ -64,6 +68,8 @@ class OrderCaptureRequestPaymentSourceBuilder /** * Sets paypal field. + * + * @param PaypalWallet|null $value */ public function paypal(?PaypalWallet $value): self { @@ -73,6 +79,8 @@ class OrderCaptureRequestPaymentSourceBuilder /** * Sets apple pay field. + * + * @param ApplePayRequest|null $value */ public function applePay(?ApplePayRequest $value): self { @@ -82,6 +90,8 @@ class OrderCaptureRequestPaymentSourceBuilder /** * Sets google pay field. + * + * @param GooglePayRequest|null $value */ public function googlePay(?GooglePayRequest $value): self { @@ -91,6 +101,8 @@ class OrderCaptureRequestPaymentSourceBuilder /** * Sets venmo field. + * + * @param VenmoWalletRequest|null $value */ public function venmo(?VenmoWalletRequest $value): self { @@ -99,7 +111,7 @@ class OrderCaptureRequestPaymentSourceBuilder } /** - * Initializes a new order capture request payment source object. + * Initializes a new Order Capture Request Payment Source object. */ public function build(): OrderCaptureRequestPaymentSource { diff --git a/src/Models/Builders/OrderConfirmApplicationContextBuilder.php b/src/Models/Builders/OrderConfirmApplicationContextBuilder.php index d8cb228..3b66919 100644 --- a/src/Models/Builders/OrderConfirmApplicationContextBuilder.php +++ b/src/Models/Builders/OrderConfirmApplicationContextBuilder.php @@ -32,7 +32,7 @@ class OrderConfirmApplicationContextBuilder } /** - * Initializes a new order confirm application context Builder object. + * Initializes a new Order Confirm Application Context Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class OrderConfirmApplicationContextBuilder /** * Sets brand name field. + * + * @param string|null $value */ public function brandName(?string $value): self { @@ -50,6 +52,8 @@ class OrderConfirmApplicationContextBuilder /** * Sets locale field. + * + * @param string|null $value */ public function locale(?string $value): self { @@ -59,6 +63,8 @@ class OrderConfirmApplicationContextBuilder /** * Sets return url field. + * + * @param string|null $value */ public function returnUrl(?string $value): self { @@ -68,6 +74,8 @@ class OrderConfirmApplicationContextBuilder /** * Sets cancel url field. + * + * @param string|null $value */ public function cancelUrl(?string $value): self { @@ -77,6 +85,8 @@ class OrderConfirmApplicationContextBuilder /** * Sets stored payment source field. + * + * @param StoredPaymentSource|null $value */ public function storedPaymentSource(?StoredPaymentSource $value): self { @@ -85,7 +95,7 @@ class OrderConfirmApplicationContextBuilder } /** - * Initializes a new order confirm application context object. + * Initializes a new Order Confirm Application Context object. */ public function build(): OrderConfirmApplicationContext { diff --git a/src/Models/Builders/OrderRequestBuilder.php b/src/Models/Builders/OrderRequestBuilder.php index a3a4b5a..8e9d41c 100644 --- a/src/Models/Builders/OrderRequestBuilder.php +++ b/src/Models/Builders/OrderRequestBuilder.php @@ -15,6 +15,7 @@ use PaypalServerSdkLib\Models\OrderApplicationContext; use PaypalServerSdkLib\Models\OrderRequest; use PaypalServerSdkLib\Models\Payer; use PaypalServerSdkLib\Models\PaymentSource; +use PaypalServerSdkLib\Models\PurchaseUnitRequest; /** * Builder for model OrderRequest @@ -34,7 +35,10 @@ class OrderRequestBuilder } /** - * Initializes a new order request Builder object. + * Initializes a new Order Request Builder object. + * + * @param string $intent + * @param PurchaseUnitRequest[] $purchaseUnits */ public static function init(string $intent, array $purchaseUnits): self { @@ -43,6 +47,8 @@ class OrderRequestBuilder /** * Sets payer field. + * + * @param Payer|null $value */ public function payer(?Payer $value): self { @@ -52,6 +58,8 @@ class OrderRequestBuilder /** * Sets payment source field. + * + * @param PaymentSource|null $value */ public function paymentSource(?PaymentSource $value): self { @@ -61,6 +69,8 @@ class OrderRequestBuilder /** * Sets application context field. + * + * @param OrderApplicationContext|null $value */ public function applicationContext(?OrderApplicationContext $value): self { @@ -69,7 +79,7 @@ class OrderRequestBuilder } /** - * Initializes a new order request object. + * Initializes a new Order Request object. */ public function build(): OrderRequest { diff --git a/src/Models/Builders/OrderTrackerItemBuilder.php b/src/Models/Builders/OrderTrackerItemBuilder.php index b54c801..43da886 100644 --- a/src/Models/Builders/OrderTrackerItemBuilder.php +++ b/src/Models/Builders/OrderTrackerItemBuilder.php @@ -32,7 +32,7 @@ class OrderTrackerItemBuilder } /** - * Initializes a new order tracker item Builder object. + * Initializes a new Order Tracker Item Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class OrderTrackerItemBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -50,6 +52,8 @@ class OrderTrackerItemBuilder /** * Sets quantity field. + * + * @param string|null $value */ public function quantity(?string $value): self { @@ -59,6 +63,8 @@ class OrderTrackerItemBuilder /** * Sets sku field. + * + * @param string|null $value */ public function sku(?string $value): self { @@ -68,6 +74,8 @@ class OrderTrackerItemBuilder /** * Sets url field. + * + * @param string|null $value */ public function url(?string $value): self { @@ -77,6 +85,8 @@ class OrderTrackerItemBuilder /** * Sets image url field. + * + * @param string|null $value */ public function imageUrl(?string $value): self { @@ -86,6 +96,8 @@ class OrderTrackerItemBuilder /** * Sets upc field. + * + * @param UniversalProductCode|null $value */ public function upc(?UniversalProductCode $value): self { @@ -94,7 +106,7 @@ class OrderTrackerItemBuilder } /** - * Initializes a new order tracker item object. + * Initializes a new Order Tracker Item object. */ public function build(): OrderTrackerItem { diff --git a/src/Models/Builders/OrderTrackerRequestBuilder.php b/src/Models/Builders/OrderTrackerRequestBuilder.php index ff6e6b3..9db87a8 100644 --- a/src/Models/Builders/OrderTrackerRequestBuilder.php +++ b/src/Models/Builders/OrderTrackerRequestBuilder.php @@ -11,6 +11,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; +use PaypalServerSdkLib\Models\OrderTrackerItem; use PaypalServerSdkLib\Models\OrderTrackerRequest; /** @@ -31,7 +32,9 @@ class OrderTrackerRequestBuilder } /** - * Initializes a new order tracker request Builder object. + * Initializes a new Order Tracker Request Builder object. + * + * @param string $captureId */ public static function init(string $captureId): self { @@ -40,6 +43,8 @@ class OrderTrackerRequestBuilder /** * Sets tracking number field. + * + * @param string|null $value */ public function trackingNumber(?string $value): self { @@ -49,6 +54,8 @@ class OrderTrackerRequestBuilder /** * Sets carrier field. + * + * @param string|null $value */ public function carrier(?string $value): self { @@ -58,6 +65,8 @@ class OrderTrackerRequestBuilder /** * Sets carrier name other field. + * + * @param string|null $value */ public function carrierNameOther(?string $value): self { @@ -67,6 +76,8 @@ class OrderTrackerRequestBuilder /** * Sets notify payer field. + * + * @param bool|null $value */ public function notifyPayer(?bool $value): self { @@ -76,6 +87,8 @@ class OrderTrackerRequestBuilder /** * Sets items field. + * + * @param OrderTrackerItem[]|null $value */ public function items(?array $value): self { @@ -84,7 +97,7 @@ class OrderTrackerRequestBuilder } /** - * Initializes a new order tracker request object. + * Initializes a new Order Tracker Request object. */ public function build(): OrderTrackerRequest { diff --git a/src/Models/Builders/OrderTrackerResponseBuilder.php b/src/Models/Builders/OrderTrackerResponseBuilder.php index dffa18c..567dff4 100644 --- a/src/Models/Builders/OrderTrackerResponseBuilder.php +++ b/src/Models/Builders/OrderTrackerResponseBuilder.php @@ -11,6 +11,8 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; +use PaypalServerSdkLib\Models\LinkDescription; +use PaypalServerSdkLib\Models\OrderTrackerItem; use PaypalServerSdkLib\Models\OrderTrackerResponse; /** @@ -31,7 +33,7 @@ class OrderTrackerResponseBuilder } /** - * Initializes a new order tracker response Builder object. + * Initializes a new Order Tracker Response Builder object. */ public static function init(): self { @@ -40,6 +42,8 @@ class OrderTrackerResponseBuilder /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -49,6 +53,8 @@ class OrderTrackerResponseBuilder /** * Sets status field. + * + * @param string|null $value */ public function status(?string $value): self { @@ -58,6 +64,8 @@ class OrderTrackerResponseBuilder /** * Sets items field. + * + * @param OrderTrackerItem[]|null $value */ public function items(?array $value): self { @@ -67,6 +75,8 @@ class OrderTrackerResponseBuilder /** * Sets links field. + * + * @param LinkDescription[]|null $value */ public function links(?array $value): self { @@ -76,6 +86,8 @@ class OrderTrackerResponseBuilder /** * Sets create time field. + * + * @param string|null $value */ public function createTime(?string $value): self { @@ -85,6 +97,8 @@ class OrderTrackerResponseBuilder /** * Sets update time field. + * + * @param string|null $value */ public function updateTime(?string $value): self { @@ -93,7 +107,7 @@ class OrderTrackerResponseBuilder } /** - * Initializes a new order tracker response object. + * Initializes a new Order Tracker Response object. */ public function build(): OrderTrackerResponse { diff --git a/src/Models/Builders/OrderUpdateCallbackErrorResponseBuilder.php b/src/Models/Builders/OrderUpdateCallbackErrorResponseBuilder.php new file mode 100644 index 0000000..4b15b76 --- /dev/null +++ b/src/Models/Builders/OrderUpdateCallbackErrorResponseBuilder.php @@ -0,0 +1,73 @@ +instance = $instance; + } + + /** + * Initializes a new Order Update Callback Error Response Builder object. + * + * @param string $name + */ + public static function init(string $name): self + { + return new self(new OrderUpdateCallbackErrorResponse($name)); + } + + /** + * Sets message field. + * + * @param string|null $value + */ + public function message(?string $value): self + { + $this->instance->setMessage($value); + return $this; + } + + /** + * Sets details field. + * + * @param OrderUpdateCallbackErrorResponseDetails[]|null $value + */ + public function details(?array $value): self + { + $this->instance->setDetails($value); + return $this; + } + + /** + * Initializes a new Order Update Callback Error Response object. + */ + public function build(): OrderUpdateCallbackErrorResponse + { + return CoreHelper::clone($this->instance); + } +} diff --git a/src/Models/Builders/OrderUpdateCallbackErrorResponseDetailsBuilder.php b/src/Models/Builders/OrderUpdateCallbackErrorResponseDetailsBuilder.php new file mode 100644 index 0000000..f6ec918 --- /dev/null +++ b/src/Models/Builders/OrderUpdateCallbackErrorResponseDetailsBuilder.php @@ -0,0 +1,72 @@ +instance = $instance; + } + + /** + * Initializes a new Order Update Callback Error Response Details Builder object. + * + * @param string $issue + */ + public static function init(string $issue): self + { + return new self(new OrderUpdateCallbackErrorResponseDetails($issue)); + } + + /** + * Sets field field. + * + * @param string|null $value + */ + public function field(?string $value): self + { + $this->instance->setField($value); + return $this; + } + + /** + * Sets value field. + * + * @param string|null $value + */ + public function value(?string $value): self + { + $this->instance->setValue($value); + return $this; + } + + /** + * Initializes a new Order Update Callback Error Response Details object. + */ + public function build(): OrderUpdateCallbackErrorResponseDetails + { + return CoreHelper::clone($this->instance); + } +} diff --git a/src/Models/Builders/OrderUpdateCallbackRequestBuilder.php b/src/Models/Builders/OrderUpdateCallbackRequestBuilder.php new file mode 100644 index 0000000..bdba7e5 --- /dev/null +++ b/src/Models/Builders/OrderUpdateCallbackRequestBuilder.php @@ -0,0 +1,76 @@ +instance = $instance; + } + + /** + * Initializes a new Order Update Callback Request Builder object. + * + * @param OrderUpdateCallbackShippingAddress $shippingAddress + * @param PurchaseUnitRequest[] $purchaseUnits + */ + public static function init(OrderUpdateCallbackShippingAddress $shippingAddress, array $purchaseUnits): self + { + return new self(new OrderUpdateCallbackRequest($shippingAddress, $purchaseUnits)); + } + + /** + * Sets id field. + * + * @param string|null $value + */ + public function id(?string $value): self + { + $this->instance->setId($value); + return $this; + } + + /** + * Sets shipping option field. + * + * @param OrderUpdateCallbackShippingOption|null $value + */ + public function shippingOption(?OrderUpdateCallbackShippingOption $value): self + { + $this->instance->setShippingOption($value); + return $this; + } + + /** + * Initializes a new Order Update Callback Request object. + */ + public function build(): OrderUpdateCallbackRequest + { + return CoreHelper::clone($this->instance); + } +} diff --git a/src/Models/Builders/OrderUpdateCallbackResponseBuilder.php b/src/Models/Builders/OrderUpdateCallbackResponseBuilder.php new file mode 100644 index 0000000..24b7149 --- /dev/null +++ b/src/Models/Builders/OrderUpdateCallbackResponseBuilder.php @@ -0,0 +1,71 @@ +instance = $instance; + } + + /** + * Initializes a new Order Update Callback Response Builder object. + */ + public static function init(): self + { + return new self(new OrderUpdateCallbackResponse()); + } + + /** + * Sets id field. + * + * @param string|null $value + */ + public function id(?string $value): self + { + $this->instance->setId($value); + return $this; + } + + /** + * Sets purchase units field. + * + * @param ShippingOptionsPurchaseUnit|null $value + */ + public function purchaseUnits(?ShippingOptionsPurchaseUnit $value): self + { + $this->instance->setPurchaseUnits($value); + return $this; + } + + /** + * Initializes a new Order Update Callback Response object. + */ + public function build(): OrderUpdateCallbackResponse + { + return CoreHelper::clone($this->instance); + } +} diff --git a/src/Models/Builders/OrderUpdateCallbackShippingAddressBuilder.php b/src/Models/Builders/OrderUpdateCallbackShippingAddressBuilder.php new file mode 100644 index 0000000..c13a111 --- /dev/null +++ b/src/Models/Builders/OrderUpdateCallbackShippingAddressBuilder.php @@ -0,0 +1,83 @@ +instance = $instance; + } + + /** + * Initializes a new Order Update Callback Shipping Address Builder object. + * + * @param string $countryCode + */ + public static function init(string $countryCode): self + { + return new self(new OrderUpdateCallbackShippingAddress($countryCode)); + } + + /** + * Sets admin area 2 field. + * + * @param string|null $value + */ + public function adminArea2(?string $value): self + { + $this->instance->setAdminArea2($value); + return $this; + } + + /** + * Sets admin area 1 field. + * + * @param string|null $value + */ + public function adminArea1(?string $value): self + { + $this->instance->setAdminArea1($value); + return $this; + } + + /** + * Sets postal code field. + * + * @param string|null $value + */ + public function postalCode(?string $value): self + { + $this->instance->setPostalCode($value); + return $this; + } + + /** + * Initializes a new Order Update Callback Shipping Address object. + */ + public function build(): OrderUpdateCallbackShippingAddress + { + return CoreHelper::clone($this->instance); + } +} diff --git a/src/Models/Builders/OrderUpdateCallbackShippingOptionBuilder.php b/src/Models/Builders/OrderUpdateCallbackShippingOptionBuilder.php new file mode 100644 index 0000000..9a8839d --- /dev/null +++ b/src/Models/Builders/OrderUpdateCallbackShippingOptionBuilder.php @@ -0,0 +1,74 @@ +instance = $instance; + } + + /** + * Initializes a new Order Update Callback Shipping Option Builder object. + * + * @param string $id + * @param string $label + */ + public static function init(string $id, string $label): self + { + return new self(new OrderUpdateCallbackShippingOption($id, $label)); + } + + /** + * Sets type field. + * + * @param string|null $value + */ + public function type(?string $value): self + { + $this->instance->setType($value); + return $this; + } + + /** + * Sets amount field. + * + * @param Money|null $value + */ + public function amount(?Money $value): self + { + $this->instance->setAmount($value); + return $this; + } + + /** + * Initializes a new Order Update Callback Shipping Option object. + */ + public function build(): OrderUpdateCallbackShippingOption + { + return CoreHelper::clone($this->instance); + } +} diff --git a/src/Models/Builders/CaptureBuilder.php b/src/Models/Builders/OrdersCaptureBuilder.php similarity index 76% rename from src/Models/Builders/CaptureBuilder.php rename to src/Models/Builders/OrdersCaptureBuilder.php index 0d638bc..c0ea159 100644 --- a/src/Models/Builders/CaptureBuilder.php +++ b/src/Models/Builders/OrdersCaptureBuilder.php @@ -11,41 +11,44 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; -use PaypalServerSdkLib\Models\Capture; use PaypalServerSdkLib\Models\CaptureStatusDetails; +use PaypalServerSdkLib\Models\LinkDescription; use PaypalServerSdkLib\Models\Money; use PaypalServerSdkLib\Models\NetworkTransactionReference; +use PaypalServerSdkLib\Models\OrdersCapture; use PaypalServerSdkLib\Models\ProcessorResponse; use PaypalServerSdkLib\Models\SellerProtection; use PaypalServerSdkLib\Models\SellerReceivableBreakdown; /** - * Builder for model Capture + * Builder for model OrdersCapture * - * @see Capture + * @see OrdersCapture */ -class CaptureBuilder +class OrdersCaptureBuilder { /** - * @var Capture + * @var OrdersCapture */ private $instance; - private function __construct(Capture $instance) + private function __construct(OrdersCapture $instance) { $this->instance = $instance; } /** - * Initializes a new capture Builder object. + * Initializes a new Orders Capture Builder object. */ public static function init(): self { - return new self(new Capture()); + return new self(new OrdersCapture()); } /** * Sets status field. + * + * @param string|null $value */ public function status(?string $value): self { @@ -55,6 +58,8 @@ class CaptureBuilder /** * Sets status details field. + * + * @param CaptureStatusDetails|null $value */ public function statusDetails(?CaptureStatusDetails $value): self { @@ -64,6 +69,8 @@ class CaptureBuilder /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -73,6 +80,8 @@ class CaptureBuilder /** * Sets amount field. + * + * @param Money|null $value */ public function amount(?Money $value): self { @@ -82,6 +91,8 @@ class CaptureBuilder /** * Sets invoice id field. + * + * @param string|null $value */ public function invoiceId(?string $value): self { @@ -91,6 +102,8 @@ class CaptureBuilder /** * Sets custom id field. + * + * @param string|null $value */ public function customId(?string $value): self { @@ -100,6 +113,8 @@ class CaptureBuilder /** * Sets network transaction reference field. + * + * @param NetworkTransactionReference|null $value */ public function networkTransactionReference(?NetworkTransactionReference $value): self { @@ -109,6 +124,8 @@ class CaptureBuilder /** * Sets seller protection field. + * + * @param SellerProtection|null $value */ public function sellerProtection(?SellerProtection $value): self { @@ -118,6 +135,8 @@ class CaptureBuilder /** * Sets final capture field. + * + * @param bool|null $value */ public function finalCapture(?bool $value): self { @@ -127,6 +146,8 @@ class CaptureBuilder /** * Sets seller receivable breakdown field. + * + * @param SellerReceivableBreakdown|null $value */ public function sellerReceivableBreakdown(?SellerReceivableBreakdown $value): self { @@ -136,6 +157,8 @@ class CaptureBuilder /** * Sets disbursement mode field. + * + * @param string|null $value */ public function disbursementMode(?string $value): self { @@ -145,6 +168,8 @@ class CaptureBuilder /** * Sets links field. + * + * @param LinkDescription[]|null $value */ public function links(?array $value): self { @@ -154,6 +179,8 @@ class CaptureBuilder /** * Sets processor response field. + * + * @param ProcessorResponse|null $value */ public function processorResponse(?ProcessorResponse $value): self { @@ -163,6 +190,8 @@ class CaptureBuilder /** * Sets create time field. + * + * @param string|null $value */ public function createTime(?string $value): self { @@ -172,6 +201,8 @@ class CaptureBuilder /** * Sets update time field. + * + * @param string|null $value */ public function updateTime(?string $value): self { @@ -180,9 +211,9 @@ class CaptureBuilder } /** - * Initializes a new capture object. + * Initializes a new Orders Capture object. */ - public function build(): Capture + public function build(): OrdersCapture { return CoreHelper::clone($this->instance); } diff --git a/src/Models/Builders/P24PaymentObjectBuilder.php b/src/Models/Builders/P24PaymentObjectBuilder.php index eed53ab..e3185a0 100644 --- a/src/Models/Builders/P24PaymentObjectBuilder.php +++ b/src/Models/Builders/P24PaymentObjectBuilder.php @@ -31,7 +31,7 @@ class P24PaymentObjectBuilder } /** - * Initializes a new p24 payment object Builder object. + * Initializes a new P24 Payment Object Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class P24PaymentObjectBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -49,6 +51,8 @@ class P24PaymentObjectBuilder /** * Sets email field. + * + * @param string|null $value */ public function email(?string $value): self { @@ -58,6 +62,8 @@ class P24PaymentObjectBuilder /** * Sets country code field. + * + * @param string|null $value */ public function countryCode(?string $value): self { @@ -67,6 +73,8 @@ class P24PaymentObjectBuilder /** * Sets payment descriptor field. + * + * @param string|null $value */ public function paymentDescriptor(?string $value): self { @@ -76,6 +84,8 @@ class P24PaymentObjectBuilder /** * Sets method id field. + * + * @param string|null $value */ public function methodId(?string $value): self { @@ -85,6 +95,8 @@ class P24PaymentObjectBuilder /** * Sets method description field. + * + * @param string|null $value */ public function methodDescription(?string $value): self { @@ -93,7 +105,7 @@ class P24PaymentObjectBuilder } /** - * Initializes a new p24 payment object object. + * Initializes a new P24 Payment Object object. */ public function build(): P24PaymentObject { diff --git a/src/Models/Builders/P24PaymentRequestBuilder.php b/src/Models/Builders/P24PaymentRequestBuilder.php index 5450679..904a0b8 100644 --- a/src/Models/Builders/P24PaymentRequestBuilder.php +++ b/src/Models/Builders/P24PaymentRequestBuilder.php @@ -32,7 +32,11 @@ class P24PaymentRequestBuilder } /** - * Initializes a new p24 payment request Builder object. + * Initializes a new P24 Payment Request Builder object. + * + * @param string $name + * @param string $email + * @param string $countryCode */ public static function init(string $name, string $email, string $countryCode): self { @@ -41,6 +45,8 @@ class P24PaymentRequestBuilder /** * Sets experience context field. + * + * @param ExperienceContext|null $value */ public function experienceContext(?ExperienceContext $value): self { @@ -49,7 +55,7 @@ class P24PaymentRequestBuilder } /** - * Initializes a new p24 payment request object. + * Initializes a new P24 Payment Request object. */ public function build(): P24PaymentRequest { diff --git a/src/Models/Builders/ParticipantMetadataBuilder.php b/src/Models/Builders/ParticipantMetadataBuilder.php new file mode 100644 index 0000000..e059117 --- /dev/null +++ b/src/Models/Builders/ParticipantMetadataBuilder.php @@ -0,0 +1,59 @@ +instance = $instance; + } + + /** + * Initializes a new Participant Metadata Builder object. + */ + public static function init(): self + { + return new self(new ParticipantMetadata()); + } + + /** + * Sets ip address field. + * + * @param string|null $value + */ + public function ipAddress(?string $value): self + { + $this->instance->setIpAddress($value); + return $this; + } + + /** + * Initializes a new Participant Metadata object. + */ + public function build(): ParticipantMetadata + { + return CoreHelper::clone($this->instance); + } +} diff --git a/src/Models/Builders/PatchBuilder.php b/src/Models/Builders/PatchBuilder.php index cbcec85..1da7fcd 100644 --- a/src/Models/Builders/PatchBuilder.php +++ b/src/Models/Builders/PatchBuilder.php @@ -31,7 +31,9 @@ class PatchBuilder } /** - * Initializes a new patch Builder object. + * Initializes a new Patch Builder object. + * + * @param string $op */ public static function init(string $op): self { @@ -40,6 +42,8 @@ class PatchBuilder /** * Sets path field. + * + * @param string|null $value */ public function path(?string $value): self { @@ -49,6 +53,8 @@ class PatchBuilder /** * Sets value field. + * + * @param mixed $value */ public function value($value): self { @@ -58,6 +64,8 @@ class PatchBuilder /** * Sets from field. + * + * @param string|null $value */ public function from(?string $value): self { @@ -66,7 +74,7 @@ class PatchBuilder } /** - * Initializes a new patch object. + * Initializes a new Patch object. */ public function build(): Patch { diff --git a/src/Models/Builders/PayeeBaseBuilder.php b/src/Models/Builders/PayeeBaseBuilder.php index 1342994..691ac4e 100644 --- a/src/Models/Builders/PayeeBaseBuilder.php +++ b/src/Models/Builders/PayeeBaseBuilder.php @@ -31,7 +31,7 @@ class PayeeBaseBuilder } /** - * Initializes a new payee base Builder object. + * Initializes a new Payee Base Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class PayeeBaseBuilder /** * Sets email address field. + * + * @param string|null $value */ public function emailAddress(?string $value): self { @@ -49,6 +51,8 @@ class PayeeBaseBuilder /** * Sets merchant id field. + * + * @param string|null $value */ public function merchantId(?string $value): self { @@ -57,7 +61,7 @@ class PayeeBaseBuilder } /** - * Initializes a new payee base object. + * Initializes a new Payee Base object. */ public function build(): PayeeBase { diff --git a/src/Models/Builders/PayeeBuilder.php b/src/Models/Builders/PayeeBuilder.php deleted file mode 100644 index 1426bd7..0000000 --- a/src/Models/Builders/PayeeBuilder.php +++ /dev/null @@ -1,66 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new payee Builder object. - */ - public static function init(): self - { - return new self(new Payee()); - } - - /** - * Sets email address field. - */ - public function emailAddress(?string $value): self - { - $this->instance->setEmailAddress($value); - return $this; - } - - /** - * Sets merchant id field. - */ - public function merchantId(?string $value): self - { - $this->instance->setMerchantId($value); - return $this; - } - - /** - * Initializes a new payee object. - */ - public function build(): Payee - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PayerBaseBuilder.php b/src/Models/Builders/PayerBaseBuilder.php index 1a84919..46576fe 100644 --- a/src/Models/Builders/PayerBaseBuilder.php +++ b/src/Models/Builders/PayerBaseBuilder.php @@ -31,7 +31,7 @@ class PayerBaseBuilder } /** - * Initializes a new payer base Builder object. + * Initializes a new Payer Base Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class PayerBaseBuilder /** * Sets email address field. + * + * @param string|null $value */ public function emailAddress(?string $value): self { @@ -49,6 +51,8 @@ class PayerBaseBuilder /** * Sets payer id field. + * + * @param string|null $value */ public function payerId(?string $value): self { @@ -57,7 +61,7 @@ class PayerBaseBuilder } /** - * Initializes a new payer base object. + * Initializes a new Payer Base object. */ public function build(): PayerBase { diff --git a/src/Models/Builders/PayerBuilder.php b/src/Models/Builders/PayerBuilder.php index 019e808..1d8197f 100644 --- a/src/Models/Builders/PayerBuilder.php +++ b/src/Models/Builders/PayerBuilder.php @@ -35,7 +35,7 @@ class PayerBuilder } /** - * Initializes a new payer Builder object. + * Initializes a new Payer Builder object. */ public static function init(): self { @@ -44,6 +44,8 @@ class PayerBuilder /** * Sets email address field. + * + * @param string|null $value */ public function emailAddress(?string $value): self { @@ -53,6 +55,8 @@ class PayerBuilder /** * Sets payer id field. + * + * @param string|null $value */ public function payerId(?string $value): self { @@ -62,6 +66,8 @@ class PayerBuilder /** * Sets name field. + * + * @param Name|null $value */ public function name(?Name $value): self { @@ -71,6 +77,8 @@ class PayerBuilder /** * Sets phone field. + * + * @param PhoneWithType|null $value */ public function phone(?PhoneWithType $value): self { @@ -80,6 +88,8 @@ class PayerBuilder /** * Sets birth date field. + * + * @param string|null $value */ public function birthDate(?string $value): self { @@ -89,6 +99,8 @@ class PayerBuilder /** * Sets tax info field. + * + * @param TaxInfo|null $value */ public function taxInfo(?TaxInfo $value): self { @@ -98,6 +110,8 @@ class PayerBuilder /** * Sets address field. + * + * @param Address|null $value */ public function address(?Address $value): self { @@ -106,7 +120,7 @@ class PayerBuilder } /** - * Initializes a new payer object. + * Initializes a new Payer object. */ public function build(): Payer { diff --git a/src/Models/Builders/PaymentAuthorizationBuilder.php b/src/Models/Builders/PaymentAuthorizationBuilder.php index 7140a2b..0addd45 100644 --- a/src/Models/Builders/PaymentAuthorizationBuilder.php +++ b/src/Models/Builders/PaymentAuthorizationBuilder.php @@ -12,9 +12,10 @@ namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; use PaypalServerSdkLib\Models\AuthorizationStatusDetails; +use PaypalServerSdkLib\Models\LinkDescription; use PaypalServerSdkLib\Models\Money; use PaypalServerSdkLib\Models\NetworkTransactionReference; -use PaypalServerSdkLib\Models\Payee; +use PaypalServerSdkLib\Models\PayeeBase; use PaypalServerSdkLib\Models\PaymentAuthorization; use PaypalServerSdkLib\Models\PaymentSupplementaryData; use PaypalServerSdkLib\Models\SellerProtection; @@ -37,7 +38,7 @@ class PaymentAuthorizationBuilder } /** - * Initializes a new payment authorization Builder object. + * Initializes a new Payment Authorization Builder object. */ public static function init(): self { @@ -46,6 +47,8 @@ class PaymentAuthorizationBuilder /** * Sets status field. + * + * @param string|null $value */ public function status(?string $value): self { @@ -55,6 +58,8 @@ class PaymentAuthorizationBuilder /** * Sets status details field. + * + * @param AuthorizationStatusDetails|null $value */ public function statusDetails(?AuthorizationStatusDetails $value): self { @@ -64,6 +69,8 @@ class PaymentAuthorizationBuilder /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -73,6 +80,8 @@ class PaymentAuthorizationBuilder /** * Sets amount field. + * + * @param Money|null $value */ public function amount(?Money $value): self { @@ -82,6 +91,8 @@ class PaymentAuthorizationBuilder /** * Sets invoice id field. + * + * @param string|null $value */ public function invoiceId(?string $value): self { @@ -91,6 +102,8 @@ class PaymentAuthorizationBuilder /** * Sets custom id field. + * + * @param string|null $value */ public function customId(?string $value): self { @@ -100,6 +113,8 @@ class PaymentAuthorizationBuilder /** * Sets network transaction reference field. + * + * @param NetworkTransactionReference|null $value */ public function networkTransactionReference(?NetworkTransactionReference $value): self { @@ -109,6 +124,8 @@ class PaymentAuthorizationBuilder /** * Sets seller protection field. + * + * @param SellerProtection|null $value */ public function sellerProtection(?SellerProtection $value): self { @@ -118,6 +135,8 @@ class PaymentAuthorizationBuilder /** * Sets expiration time field. + * + * @param string|null $value */ public function expirationTime(?string $value): self { @@ -127,6 +146,8 @@ class PaymentAuthorizationBuilder /** * Sets links field. + * + * @param LinkDescription[]|null $value */ public function links(?array $value): self { @@ -136,6 +157,8 @@ class PaymentAuthorizationBuilder /** * Sets create time field. + * + * @param string|null $value */ public function createTime(?string $value): self { @@ -145,6 +168,8 @@ class PaymentAuthorizationBuilder /** * Sets update time field. + * + * @param string|null $value */ public function updateTime(?string $value): self { @@ -154,6 +179,8 @@ class PaymentAuthorizationBuilder /** * Sets supplementary data field. + * + * @param PaymentSupplementaryData|null $value */ public function supplementaryData(?PaymentSupplementaryData $value): self { @@ -163,15 +190,17 @@ class PaymentAuthorizationBuilder /** * Sets payee field. + * + * @param PayeeBase|null $value */ - public function payee(?Payee $value): self + public function payee(?PayeeBase $value): self { $this->instance->setPayee($value); return $this; } /** - * Initializes a new payment authorization object. + * Initializes a new Payment Authorization object. */ public function build(): PaymentAuthorization { diff --git a/src/Models/Builders/PaymentCollectionBuilder.php b/src/Models/Builders/PaymentCollectionBuilder.php index 8252af0..08ab9cc 100644 --- a/src/Models/Builders/PaymentCollectionBuilder.php +++ b/src/Models/Builders/PaymentCollectionBuilder.php @@ -11,7 +11,10 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; +use PaypalServerSdkLib\Models\AuthorizationWithAdditionalData; +use PaypalServerSdkLib\Models\OrdersCapture; use PaypalServerSdkLib\Models\PaymentCollection; +use PaypalServerSdkLib\Models\Refund; /** * Builder for model PaymentCollection @@ -31,7 +34,7 @@ class PaymentCollectionBuilder } /** - * Initializes a new payment collection Builder object. + * Initializes a new Payment Collection Builder object. */ public static function init(): self { @@ -40,6 +43,8 @@ class PaymentCollectionBuilder /** * Sets authorizations field. + * + * @param AuthorizationWithAdditionalData[]|null $value */ public function authorizations(?array $value): self { @@ -49,6 +54,8 @@ class PaymentCollectionBuilder /** * Sets captures field. + * + * @param OrdersCapture[]|null $value */ public function captures(?array $value): self { @@ -58,6 +65,8 @@ class PaymentCollectionBuilder /** * Sets refunds field. + * + * @param Refund[]|null $value */ public function refunds(?array $value): self { @@ -66,7 +75,7 @@ class PaymentCollectionBuilder } /** - * Initializes a new payment collection object. + * Initializes a new Payment Collection object. */ public function build(): PaymentCollection { diff --git a/src/Models/Builders/PaymentInstructionBuilder.php b/src/Models/Builders/PaymentInstructionBuilder.php index c2e8a7a..1c4919c 100644 --- a/src/Models/Builders/PaymentInstructionBuilder.php +++ b/src/Models/Builders/PaymentInstructionBuilder.php @@ -12,6 +12,7 @@ namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; use PaypalServerSdkLib\Models\PaymentInstruction; +use PaypalServerSdkLib\Models\PlatformFee; /** * Builder for model PaymentInstruction @@ -31,7 +32,7 @@ class PaymentInstructionBuilder } /** - * Initializes a new payment instruction Builder object. + * Initializes a new Payment Instruction Builder object. */ public static function init(): self { @@ -40,6 +41,8 @@ class PaymentInstructionBuilder /** * Sets platform fees field. + * + * @param PlatformFee[]|null $value */ public function platformFees(?array $value): self { @@ -49,6 +52,8 @@ class PaymentInstructionBuilder /** * Sets disbursement mode field. + * + * @param string|null $value */ public function disbursementMode(?string $value): self { @@ -58,6 +63,8 @@ class PaymentInstructionBuilder /** * Sets payee pricing tier id field. + * + * @param string|null $value */ public function payeePricingTierId(?string $value): self { @@ -67,6 +74,8 @@ class PaymentInstructionBuilder /** * Sets payee receivable fx rate id field. + * + * @param string|null $value */ public function payeeReceivableFxRateId(?string $value): self { @@ -75,7 +84,7 @@ class PaymentInstructionBuilder } /** - * Initializes a new payment instruction object. + * Initializes a new Payment Instruction object. */ public function build(): PaymentInstruction { diff --git a/src/Models/Builders/PaymentMethodPreferenceBuilder.php b/src/Models/Builders/PaymentMethodPreferenceBuilder.php index 3ebade6..68ab02e 100644 --- a/src/Models/Builders/PaymentMethodPreferenceBuilder.php +++ b/src/Models/Builders/PaymentMethodPreferenceBuilder.php @@ -31,7 +31,7 @@ class PaymentMethodPreferenceBuilder } /** - * Initializes a new payment method preference Builder object. + * Initializes a new Payment Method Preference Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class PaymentMethodPreferenceBuilder /** * Sets payee preferred field. + * + * @param string|null $value */ public function payeePreferred(?string $value): self { @@ -49,6 +51,8 @@ class PaymentMethodPreferenceBuilder /** * Sets standard entry class code field. + * + * @param string|null $value */ public function standardEntryClassCode(?string $value): self { @@ -57,7 +61,7 @@ class PaymentMethodPreferenceBuilder } /** - * Initializes a new payment method preference object. + * Initializes a new Payment Method Preference object. */ public function build(): PaymentMethodPreference { diff --git a/src/Models/Builders/PaymentSourceBuilder.php b/src/Models/Builders/PaymentSourceBuilder.php index 38b9b02..0e1e87e 100644 --- a/src/Models/Builders/PaymentSourceBuilder.php +++ b/src/Models/Builders/PaymentSourceBuilder.php @@ -46,7 +46,7 @@ class PaymentSourceBuilder } /** - * Initializes a new payment source Builder object. + * Initializes a new Payment Source Builder object. */ public static function init(): self { @@ -55,6 +55,8 @@ class PaymentSourceBuilder /** * Sets card field. + * + * @param CardRequest|null $value */ public function card(?CardRequest $value): self { @@ -64,6 +66,8 @@ class PaymentSourceBuilder /** * Sets token field. + * + * @param Token|null $value */ public function token(?Token $value): self { @@ -73,6 +77,8 @@ class PaymentSourceBuilder /** * Sets paypal field. + * + * @param PaypalWallet|null $value */ public function paypal(?PaypalWallet $value): self { @@ -82,6 +88,8 @@ class PaymentSourceBuilder /** * Sets bancontact field. + * + * @param BancontactPaymentRequest|null $value */ public function bancontact(?BancontactPaymentRequest $value): self { @@ -91,6 +99,8 @@ class PaymentSourceBuilder /** * Sets blik field. + * + * @param BlikPaymentRequest|null $value */ public function blik(?BlikPaymentRequest $value): self { @@ -100,6 +110,8 @@ class PaymentSourceBuilder /** * Sets eps field. + * + * @param EpsPaymentRequest|null $value */ public function eps(?EpsPaymentRequest $value): self { @@ -109,6 +121,8 @@ class PaymentSourceBuilder /** * Sets giropay field. + * + * @param GiropayPaymentRequest|null $value */ public function giropay(?GiropayPaymentRequest $value): self { @@ -118,6 +132,8 @@ class PaymentSourceBuilder /** * Sets ideal field. + * + * @param IdealPaymentRequest|null $value */ public function ideal(?IdealPaymentRequest $value): self { @@ -127,6 +143,8 @@ class PaymentSourceBuilder /** * Sets mybank field. + * + * @param MybankPaymentRequest|null $value */ public function mybank(?MybankPaymentRequest $value): self { @@ -136,6 +154,8 @@ class PaymentSourceBuilder /** * Sets p 24 field. + * + * @param P24PaymentRequest|null $value */ public function p24(?P24PaymentRequest $value): self { @@ -145,6 +165,8 @@ class PaymentSourceBuilder /** * Sets sofort field. + * + * @param SofortPaymentRequest|null $value */ public function sofort(?SofortPaymentRequest $value): self { @@ -154,6 +176,8 @@ class PaymentSourceBuilder /** * Sets trustly field. + * + * @param TrustlyPaymentRequest|null $value */ public function trustly(?TrustlyPaymentRequest $value): self { @@ -163,6 +187,8 @@ class PaymentSourceBuilder /** * Sets apple pay field. + * + * @param ApplePayRequest|null $value */ public function applePay(?ApplePayRequest $value): self { @@ -172,6 +198,8 @@ class PaymentSourceBuilder /** * Sets google pay field. + * + * @param GooglePayRequest|null $value */ public function googlePay(?GooglePayRequest $value): self { @@ -181,6 +209,8 @@ class PaymentSourceBuilder /** * Sets venmo field. + * + * @param VenmoWalletRequest|null $value */ public function venmo(?VenmoWalletRequest $value): self { @@ -189,7 +219,7 @@ class PaymentSourceBuilder } /** - * Initializes a new payment source object. + * Initializes a new Payment Source object. */ public function build(): PaymentSource { diff --git a/src/Models/Builders/PaymentSourceResponseBuilder.php b/src/Models/Builders/PaymentSourceResponseBuilder.php index fc0e8c2..8bf9bd0 100644 --- a/src/Models/Builders/PaymentSourceResponseBuilder.php +++ b/src/Models/Builders/PaymentSourceResponseBuilder.php @@ -45,7 +45,7 @@ class PaymentSourceResponseBuilder } /** - * Initializes a new payment source response Builder object. + * Initializes a new Payment Source Response Builder object. */ public static function init(): self { @@ -54,6 +54,8 @@ class PaymentSourceResponseBuilder /** * Sets card field. + * + * @param CardResponse|null $value */ public function card(?CardResponse $value): self { @@ -63,6 +65,8 @@ class PaymentSourceResponseBuilder /** * Sets paypal field. + * + * @param PaypalWalletResponse|null $value */ public function paypal(?PaypalWalletResponse $value): self { @@ -72,6 +76,8 @@ class PaymentSourceResponseBuilder /** * Sets bancontact field. + * + * @param BancontactPaymentObject|null $value */ public function bancontact(?BancontactPaymentObject $value): self { @@ -81,6 +87,8 @@ class PaymentSourceResponseBuilder /** * Sets blik field. + * + * @param BlikPaymentObject|null $value */ public function blik(?BlikPaymentObject $value): self { @@ -90,6 +98,8 @@ class PaymentSourceResponseBuilder /** * Sets eps field. + * + * @param EpsPaymentObject|null $value */ public function eps(?EpsPaymentObject $value): self { @@ -99,6 +109,8 @@ class PaymentSourceResponseBuilder /** * Sets giropay field. + * + * @param GiropayPaymentObject|null $value */ public function giropay(?GiropayPaymentObject $value): self { @@ -108,6 +120,8 @@ class PaymentSourceResponseBuilder /** * Sets ideal field. + * + * @param IdealPaymentObject|null $value */ public function ideal(?IdealPaymentObject $value): self { @@ -117,6 +131,8 @@ class PaymentSourceResponseBuilder /** * Sets mybank field. + * + * @param MybankPaymentObject|null $value */ public function mybank(?MybankPaymentObject $value): self { @@ -126,6 +142,8 @@ class PaymentSourceResponseBuilder /** * Sets p 24 field. + * + * @param P24PaymentObject|null $value */ public function p24(?P24PaymentObject $value): self { @@ -135,6 +153,8 @@ class PaymentSourceResponseBuilder /** * Sets sofort field. + * + * @param SofortPaymentObject|null $value */ public function sofort(?SofortPaymentObject $value): self { @@ -144,6 +164,8 @@ class PaymentSourceResponseBuilder /** * Sets trustly field. + * + * @param TrustlyPaymentObject|null $value */ public function trustly(?TrustlyPaymentObject $value): self { @@ -153,6 +175,8 @@ class PaymentSourceResponseBuilder /** * Sets apple pay field. + * + * @param ApplePayPaymentObject|null $value */ public function applePay(?ApplePayPaymentObject $value): self { @@ -162,6 +186,8 @@ class PaymentSourceResponseBuilder /** * Sets google pay field. + * + * @param GooglePayWalletResponse|null $value */ public function googlePay(?GooglePayWalletResponse $value): self { @@ -171,6 +197,8 @@ class PaymentSourceResponseBuilder /** * Sets venmo field. + * + * @param VenmoWalletResponse|null $value */ public function venmo(?VenmoWalletResponse $value): self { @@ -179,7 +207,7 @@ class PaymentSourceResponseBuilder } /** - * Initializes a new payment source response object. + * Initializes a new Payment Source Response object. */ public function build(): PaymentSourceResponse { diff --git a/src/Models/Builders/PaymentSupplementaryDataBuilder.php b/src/Models/Builders/PaymentSupplementaryDataBuilder.php index 9097254..7dde90b 100644 --- a/src/Models/Builders/PaymentSupplementaryDataBuilder.php +++ b/src/Models/Builders/PaymentSupplementaryDataBuilder.php @@ -32,7 +32,7 @@ class PaymentSupplementaryDataBuilder } /** - * Initializes a new payment supplementary data Builder object. + * Initializes a new Payment Supplementary Data Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class PaymentSupplementaryDataBuilder /** * Sets related ids field. + * + * @param RelatedIdentifiers|null $value */ public function relatedIds(?RelatedIdentifiers $value): self { @@ -49,7 +51,7 @@ class PaymentSupplementaryDataBuilder } /** - * Initializes a new payment supplementary data object. + * Initializes a new Payment Supplementary Data object. */ public function build(): PaymentSupplementaryData { diff --git a/src/Models/Builders/PaymentTokenRequestBuilder.php b/src/Models/Builders/PaymentTokenRequestBuilder.php index eb04bf7..98957cb 100644 --- a/src/Models/Builders/PaymentTokenRequestBuilder.php +++ b/src/Models/Builders/PaymentTokenRequestBuilder.php @@ -11,7 +11,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; -use PaypalServerSdkLib\Models\CustomerRequest; +use PaypalServerSdkLib\Models\Customer; use PaypalServerSdkLib\Models\PaymentTokenRequest; use PaypalServerSdkLib\Models\PaymentTokenRequestPaymentSource; @@ -33,7 +33,9 @@ class PaymentTokenRequestBuilder } /** - * Initializes a new payment token request Builder object. + * Initializes a new Payment Token Request Builder object. + * + * @param PaymentTokenRequestPaymentSource $paymentSource */ public static function init(PaymentTokenRequestPaymentSource $paymentSource): self { @@ -42,15 +44,17 @@ class PaymentTokenRequestBuilder /** * Sets customer field. + * + * @param Customer|null $value */ - public function customer(?CustomerRequest $value): self + public function customer(?Customer $value): self { $this->instance->setCustomer($value); return $this; } /** - * Initializes a new payment token request object. + * Initializes a new Payment Token Request object. */ public function build(): PaymentTokenRequest { diff --git a/src/Models/Builders/PaymentTokenRequestCardBuilder.php b/src/Models/Builders/PaymentTokenRequestCardBuilder.php index 071938e..e8d9db5 100644 --- a/src/Models/Builders/PaymentTokenRequestCardBuilder.php +++ b/src/Models/Builders/PaymentTokenRequestCardBuilder.php @@ -32,7 +32,7 @@ class PaymentTokenRequestCardBuilder } /** - * Initializes a new payment token request card Builder object. + * Initializes a new Payment Token Request Card Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class PaymentTokenRequestCardBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -50,6 +52,8 @@ class PaymentTokenRequestCardBuilder /** * Sets number field. + * + * @param string|null $value */ public function number(?string $value): self { @@ -59,6 +63,8 @@ class PaymentTokenRequestCardBuilder /** * Sets expiry field. + * + * @param string|null $value */ public function expiry(?string $value): self { @@ -68,6 +74,8 @@ class PaymentTokenRequestCardBuilder /** * Sets security code field. + * + * @param string|null $value */ public function securityCode(?string $value): self { @@ -77,6 +85,8 @@ class PaymentTokenRequestCardBuilder /** * Sets brand field. + * + * @param string|null $value */ public function brand(?string $value): self { @@ -86,6 +96,8 @@ class PaymentTokenRequestCardBuilder /** * Sets billing address field. + * + * @param Address|null $value */ public function billingAddress(?Address $value): self { @@ -94,16 +106,7 @@ class PaymentTokenRequestCardBuilder } /** - * Sets network transaction reference field. - */ - public function networkTransactionReference($value): self - { - $this->instance->setNetworkTransactionReference($value); - return $this; - } - - /** - * Initializes a new payment token request card object. + * Initializes a new Payment Token Request Card object. */ public function build(): PaymentTokenRequestCard { diff --git a/src/Models/Builders/PaymentTokenRequestPaymentSourceBuilder.php b/src/Models/Builders/PaymentTokenRequestPaymentSourceBuilder.php index 9f79940..9b53cc7 100644 --- a/src/Models/Builders/PaymentTokenRequestPaymentSourceBuilder.php +++ b/src/Models/Builders/PaymentTokenRequestPaymentSourceBuilder.php @@ -33,7 +33,7 @@ class PaymentTokenRequestPaymentSourceBuilder } /** - * Initializes a new payment token request payment source Builder object. + * Initializes a new Payment Token Request Payment Source Builder object. */ public static function init(): self { @@ -42,6 +42,8 @@ class PaymentTokenRequestPaymentSourceBuilder /** * Sets card field. + * + * @param PaymentTokenRequestCard|null $value */ public function card(?PaymentTokenRequestCard $value): self { @@ -51,6 +53,8 @@ class PaymentTokenRequestPaymentSourceBuilder /** * Sets token field. + * + * @param VaultTokenRequest|null $value */ public function token(?VaultTokenRequest $value): self { @@ -59,7 +63,7 @@ class PaymentTokenRequestPaymentSourceBuilder } /** - * Initializes a new payment token request payment source object. + * Initializes a new Payment Token Request Payment Source object. */ public function build(): PaymentTokenRequestPaymentSource { diff --git a/src/Models/Builders/PaymentTokenResponseBuilder.php b/src/Models/Builders/PaymentTokenResponseBuilder.php index b49cca4..e6856e3 100644 --- a/src/Models/Builders/PaymentTokenResponseBuilder.php +++ b/src/Models/Builders/PaymentTokenResponseBuilder.php @@ -11,7 +11,8 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; -use PaypalServerSdkLib\Models\CustomerRequest; +use PaypalServerSdkLib\Models\CustomerResponse; +use PaypalServerSdkLib\Models\LinkDescription; use PaypalServerSdkLib\Models\PaymentTokenResponse; use PaypalServerSdkLib\Models\PaymentTokenResponsePaymentSource; @@ -33,7 +34,7 @@ class PaymentTokenResponseBuilder } /** - * Initializes a new payment token response Builder object. + * Initializes a new Payment Token Response Builder object. */ public static function init(): self { @@ -42,6 +43,8 @@ class PaymentTokenResponseBuilder /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -51,8 +54,10 @@ class PaymentTokenResponseBuilder /** * Sets customer field. + * + * @param CustomerResponse|null $value */ - public function customer(?CustomerRequest $value): self + public function customer(?CustomerResponse $value): self { $this->instance->setCustomer($value); return $this; @@ -60,6 +65,8 @@ class PaymentTokenResponseBuilder /** * Sets payment source field. + * + * @param PaymentTokenResponsePaymentSource|null $value */ public function paymentSource(?PaymentTokenResponsePaymentSource $value): self { @@ -69,6 +76,8 @@ class PaymentTokenResponseBuilder /** * Sets links field. + * + * @param LinkDescription[]|null $value */ public function links(?array $value): self { @@ -77,7 +86,7 @@ class PaymentTokenResponseBuilder } /** - * Initializes a new payment token response object. + * Initializes a new Payment Token Response object. */ public function build(): PaymentTokenResponse { diff --git a/src/Models/Builders/PaymentTokenResponsePaymentSourceBuilder.php b/src/Models/Builders/PaymentTokenResponsePaymentSourceBuilder.php index 8900a77..cd7a571 100644 --- a/src/Models/Builders/PaymentTokenResponsePaymentSourceBuilder.php +++ b/src/Models/Builders/PaymentTokenResponsePaymentSourceBuilder.php @@ -12,7 +12,7 @@ namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; use PaypalServerSdkLib\Models\ApplePayPaymentToken; -use PaypalServerSdkLib\Models\CardPaymentToken; +use PaypalServerSdkLib\Models\CardPaymentTokenEntity; use PaypalServerSdkLib\Models\PaymentTokenResponsePaymentSource; use PaypalServerSdkLib\Models\PaypalPaymentToken; use PaypalServerSdkLib\Models\VenmoPaymentToken; @@ -35,7 +35,7 @@ class PaymentTokenResponsePaymentSourceBuilder } /** - * Initializes a new payment token response payment source Builder object. + * Initializes a new Payment Token Response Payment Source Builder object. */ public static function init(): self { @@ -44,8 +44,10 @@ class PaymentTokenResponsePaymentSourceBuilder /** * Sets card field. + * + * @param CardPaymentTokenEntity|null $value */ - public function card(?CardPaymentToken $value): self + public function card(?CardPaymentTokenEntity $value): self { $this->instance->setCard($value); return $this; @@ -53,6 +55,8 @@ class PaymentTokenResponsePaymentSourceBuilder /** * Sets paypal field. + * + * @param PaypalPaymentToken|null $value */ public function paypal(?PaypalPaymentToken $value): self { @@ -62,6 +66,8 @@ class PaymentTokenResponsePaymentSourceBuilder /** * Sets venmo field. + * + * @param VenmoPaymentToken|null $value */ public function venmo(?VenmoPaymentToken $value): self { @@ -71,6 +77,8 @@ class PaymentTokenResponsePaymentSourceBuilder /** * Sets apple pay field. + * + * @param ApplePayPaymentToken|null $value */ public function applePay(?ApplePayPaymentToken $value): self { @@ -79,16 +87,7 @@ class PaymentTokenResponsePaymentSourceBuilder } /** - * Sets bank field. - */ - public function bank($value): self - { - $this->instance->setBank($value); - return $this; - } - - /** - * Initializes a new payment token response payment source object. + * Initializes a new Payment Token Response Payment Source object. */ public function build(): PaymentTokenResponsePaymentSource { diff --git a/src/Models/Builders/PaymentsCaptureBuilder.php b/src/Models/Builders/PaymentsCaptureBuilder.php new file mode 100644 index 0000000..57f7f22 --- /dev/null +++ b/src/Models/Builders/PaymentsCaptureBuilder.php @@ -0,0 +1,220 @@ +instance = $instance; + } + + /** + * Initializes a new Payments Capture Builder object. + */ + public static function init(): self + { + return new self(new PaymentsCapture()); + } + + /** + * Sets status field. + * + * @param string|null $value + */ + public function status(?string $value): self + { + $this->instance->setStatus($value); + return $this; + } + + /** + * Sets status details field. + * + * @param CaptureStatusDetails|null $value + */ + public function statusDetails(?CaptureStatusDetails $value): self + { + $this->instance->setStatusDetails($value); + return $this; + } + + /** + * Sets id field. + * + * @param string|null $value + */ + public function id(?string $value): self + { + $this->instance->setId($value); + return $this; + } + + /** + * Sets amount field. + * + * @param Money|null $value + */ + public function amount(?Money $value): self + { + $this->instance->setAmount($value); + return $this; + } + + /** + * Sets invoice id field. + * + * @param string|null $value + */ + public function invoiceId(?string $value): self + { + $this->instance->setInvoiceId($value); + return $this; + } + + /** + * Sets custom id field. + * + * @param string|null $value + */ + public function customId(?string $value): self + { + $this->instance->setCustomId($value); + return $this; + } + + /** + * Sets network transaction reference field. + * + * @param NetworkTransactionReference|null $value + */ + public function networkTransactionReference(?NetworkTransactionReference $value): self + { + $this->instance->setNetworkTransactionReference($value); + return $this; + } + + /** + * Sets seller protection field. + * + * @param SellerProtection|null $value + */ + public function sellerProtection(?SellerProtection $value): self + { + $this->instance->setSellerProtection($value); + return $this; + } + + /** + * Sets final capture field. + * + * @param bool|null $value + */ + public function finalCapture(?bool $value): self + { + $this->instance->setFinalCapture($value); + return $this; + } + + /** + * Sets seller receivable breakdown field. + * + * @param SellerReceivableBreakdown|null $value + */ + public function sellerReceivableBreakdown(?SellerReceivableBreakdown $value): self + { + $this->instance->setSellerReceivableBreakdown($value); + return $this; + } + + /** + * Sets disbursement mode field. + * + * @param string|null $value + */ + public function disbursementMode(?string $value): self + { + $this->instance->setDisbursementMode($value); + return $this; + } + + /** + * Sets links field. + * + * @param LinkDescription[]|null $value + */ + public function links(?array $value): self + { + $this->instance->setLinks($value); + return $this; + } + + /** + * Sets processor response field. + * + * @param PaymentsProcessorResponse|null $value + */ + public function processorResponse(?PaymentsProcessorResponse $value): self + { + $this->instance->setProcessorResponse($value); + return $this; + } + + /** + * Sets create time field. + * + * @param string|null $value + */ + public function createTime(?string $value): self + { + $this->instance->setCreateTime($value); + return $this; + } + + /** + * Sets update time field. + * + * @param string|null $value + */ + public function updateTime(?string $value): self + { + $this->instance->setUpdateTime($value); + return $this; + } + + /** + * Initializes a new Payments Capture object. + */ + public function build(): PaymentsCapture + { + return CoreHelper::clone($this->instance); + } +} diff --git a/src/Models/Builders/PaymentsProcessorResponseBuilder.php b/src/Models/Builders/PaymentsProcessorResponseBuilder.php new file mode 100644 index 0000000..38a249e --- /dev/null +++ b/src/Models/Builders/PaymentsProcessorResponseBuilder.php @@ -0,0 +1,92 @@ +instance = $instance; + } + + /** + * Initializes a new Payments Processor Response Builder object. + */ + public static function init(): self + { + return new self(new PaymentsProcessorResponse()); + } + + /** + * Sets avs code field. + * + * @param string|null $value + */ + public function avsCode(?string $value): self + { + $this->instance->setAvsCode($value); + return $this; + } + + /** + * Sets cvv code field. + * + * @param string|null $value + */ + public function cvvCode(?string $value): self + { + $this->instance->setCvvCode($value); + return $this; + } + + /** + * Sets response code field. + * + * @param string|null $value + */ + public function responseCode(?string $value): self + { + $this->instance->setResponseCode($value); + return $this; + } + + /** + * Sets payment advice code field. + * + * @param string|null $value + */ + public function paymentAdviceCode(?string $value): self + { + $this->instance->setPaymentAdviceCode($value); + return $this; + } + + /** + * Initializes a new Payments Processor Response object. + */ + public function build(): PaymentsProcessorResponse + { + return CoreHelper::clone($this->instance); + } +} diff --git a/src/Models/Builders/PaypalPaymentTokenBuilder.php b/src/Models/Builders/PaypalPaymentTokenBuilder.php index 1fff622..28ddd91 100644 --- a/src/Models/Builders/PaypalPaymentTokenBuilder.php +++ b/src/Models/Builders/PaypalPaymentTokenBuilder.php @@ -36,7 +36,7 @@ class PaypalPaymentTokenBuilder } /** - * Initializes a new paypal payment token Builder object. + * Initializes a new Paypal Payment Token Builder object. */ public static function init(): self { @@ -45,6 +45,8 @@ class PaypalPaymentTokenBuilder /** * Sets description field. + * + * @param string|null $value */ public function description(?string $value): self { @@ -52,8 +54,21 @@ class PaypalPaymentTokenBuilder return $this; } + /** + * Sets usage pattern field. + * + * @param string|null $value + */ + public function usagePattern(?string $value): self + { + $this->instance->setUsagePattern($value); + return $this; + } + /** * Sets shipping field. + * + * @param VaultedDigitalWalletShippingDetails|null $value */ public function shipping(?VaultedDigitalWalletShippingDetails $value): self { @@ -63,6 +78,8 @@ class PaypalPaymentTokenBuilder /** * Sets permit multiple payment tokens field. + * + * @param bool|null $value */ public function permitMultiplePaymentTokens(?bool $value): self { @@ -72,6 +89,8 @@ class PaypalPaymentTokenBuilder /** * Sets usage type field. + * + * @param string|null $value */ public function usageType(?string $value): self { @@ -81,6 +100,8 @@ class PaypalPaymentTokenBuilder /** * Sets customer type field. + * + * @param string|null $value */ public function customerType(?string $value): self { @@ -90,6 +111,8 @@ class PaypalPaymentTokenBuilder /** * Sets email address field. + * + * @param string|null $value */ public function emailAddress(?string $value): self { @@ -99,6 +122,8 @@ class PaypalPaymentTokenBuilder /** * Sets payer id field. + * + * @param string|null $value */ public function payerId(?string $value): self { @@ -108,6 +133,8 @@ class PaypalPaymentTokenBuilder /** * Sets name field. + * + * @param Name|null $value */ public function name(?Name $value): self { @@ -117,6 +144,8 @@ class PaypalPaymentTokenBuilder /** * Sets phone field. + * + * @param PhoneWithType|null $value */ public function phone(?PhoneWithType $value): self { @@ -126,6 +155,8 @@ class PaypalPaymentTokenBuilder /** * Sets address field. + * + * @param Address|null $value */ public function address(?Address $value): self { @@ -135,6 +166,8 @@ class PaypalPaymentTokenBuilder /** * Sets account id field. + * + * @param string|null $value */ public function accountId(?string $value): self { @@ -144,6 +177,8 @@ class PaypalPaymentTokenBuilder /** * Sets phone number field. + * + * @param Phone|null $value */ public function phoneNumber(?Phone $value): self { @@ -152,7 +187,7 @@ class PaypalPaymentTokenBuilder } /** - * Initializes a new paypal payment token object. + * Initializes a new Paypal Payment Token object. */ public function build(): PaypalPaymentToken { diff --git a/src/Models/Builders/PaypalWalletAttributesBuilder.php b/src/Models/Builders/PaypalWalletAttributesBuilder.php index 16e3dab..015f9a8 100644 --- a/src/Models/Builders/PaypalWalletAttributesBuilder.php +++ b/src/Models/Builders/PaypalWalletAttributesBuilder.php @@ -33,7 +33,7 @@ class PaypalWalletAttributesBuilder } /** - * Initializes a new paypal wallet attributes Builder object. + * Initializes a new Paypal Wallet Attributes Builder object. */ public static function init(): self { @@ -42,6 +42,8 @@ class PaypalWalletAttributesBuilder /** * Sets customer field. + * + * @param PaypalWalletCustomerRequest|null $value */ public function customer(?PaypalWalletCustomerRequest $value): self { @@ -51,6 +53,8 @@ class PaypalWalletAttributesBuilder /** * Sets vault field. + * + * @param PaypalWalletVaultInstruction|null $value */ public function vault(?PaypalWalletVaultInstruction $value): self { @@ -59,7 +63,7 @@ class PaypalWalletAttributesBuilder } /** - * Initializes a new paypal wallet attributes object. + * Initializes a new Paypal Wallet Attributes object. */ public function build(): PaypalWalletAttributes { diff --git a/src/Models/Builders/PaypalWalletAttributesResponseBuilder.php b/src/Models/Builders/PaypalWalletAttributesResponseBuilder.php index 9e7058d..74bab7f 100644 --- a/src/Models/Builders/PaypalWalletAttributesResponseBuilder.php +++ b/src/Models/Builders/PaypalWalletAttributesResponseBuilder.php @@ -11,6 +11,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; +use PaypalServerSdkLib\Models\CobrandedCard; use PaypalServerSdkLib\Models\PaypalWalletAttributesResponse; use PaypalServerSdkLib\Models\PaypalWalletVaultResponse; @@ -32,7 +33,7 @@ class PaypalWalletAttributesResponseBuilder } /** - * Initializes a new paypal wallet attributes response Builder object. + * Initializes a new Paypal Wallet Attributes Response Builder object. */ public static function init(): self { @@ -41,6 +42,8 @@ class PaypalWalletAttributesResponseBuilder /** * Sets vault field. + * + * @param PaypalWalletVaultResponse|null $value */ public function vault(?PaypalWalletVaultResponse $value): self { @@ -50,6 +53,8 @@ class PaypalWalletAttributesResponseBuilder /** * Sets cobranded cards field. + * + * @param CobrandedCard[]|null $value */ public function cobrandedCards(?array $value): self { @@ -58,7 +63,7 @@ class PaypalWalletAttributesResponseBuilder } /** - * Initializes a new paypal wallet attributes response object. + * Initializes a new Paypal Wallet Attributes Response object. */ public function build(): PaypalWalletAttributesResponse { diff --git a/src/Models/Builders/PaypalWalletBuilder.php b/src/Models/Builders/PaypalWalletBuilder.php index 4e96f1b..9fc0981 100644 --- a/src/Models/Builders/PaypalWalletBuilder.php +++ b/src/Models/Builders/PaypalWalletBuilder.php @@ -16,6 +16,7 @@ use PaypalServerSdkLib\Models\Name; use PaypalServerSdkLib\Models\PaypalWallet; use PaypalServerSdkLib\Models\PaypalWalletAttributes; use PaypalServerSdkLib\Models\PaypalWalletExperienceContext; +use PaypalServerSdkLib\Models\PaypalWalletStoredCredential; use PaypalServerSdkLib\Models\PhoneWithType; use PaypalServerSdkLib\Models\TaxInfo; @@ -37,7 +38,7 @@ class PaypalWalletBuilder } /** - * Initializes a new paypal wallet Builder object. + * Initializes a new Paypal Wallet Builder object. */ public static function init(): self { @@ -46,6 +47,8 @@ class PaypalWalletBuilder /** * Sets vault id field. + * + * @param string|null $value */ public function vaultId(?string $value): self { @@ -55,6 +58,8 @@ class PaypalWalletBuilder /** * Sets email address field. + * + * @param string|null $value */ public function emailAddress(?string $value): self { @@ -64,6 +69,8 @@ class PaypalWalletBuilder /** * Sets name field. + * + * @param Name|null $value */ public function name(?Name $value): self { @@ -73,6 +80,8 @@ class PaypalWalletBuilder /** * Sets phone field. + * + * @param PhoneWithType|null $value */ public function phone(?PhoneWithType $value): self { @@ -82,6 +91,8 @@ class PaypalWalletBuilder /** * Sets birth date field. + * + * @param string|null $value */ public function birthDate(?string $value): self { @@ -91,6 +102,8 @@ class PaypalWalletBuilder /** * Sets tax info field. + * + * @param TaxInfo|null $value */ public function taxInfo(?TaxInfo $value): self { @@ -100,6 +113,8 @@ class PaypalWalletBuilder /** * Sets address field. + * + * @param Address|null $value */ public function address(?Address $value): self { @@ -109,6 +124,8 @@ class PaypalWalletBuilder /** * Sets attributes field. + * + * @param PaypalWalletAttributes|null $value */ public function attributes(?PaypalWalletAttributes $value): self { @@ -118,6 +135,8 @@ class PaypalWalletBuilder /** * Sets experience context field. + * + * @param PaypalWalletExperienceContext|null $value */ public function experienceContext(?PaypalWalletExperienceContext $value): self { @@ -127,6 +146,8 @@ class PaypalWalletBuilder /** * Sets billing agreement id field. + * + * @param string|null $value */ public function billingAgreementId(?string $value): self { @@ -135,7 +156,18 @@ class PaypalWalletBuilder } /** - * Initializes a new paypal wallet object. + * Sets stored credential field. + * + * @param PaypalWalletStoredCredential|null $value + */ + public function storedCredential(?PaypalWalletStoredCredential $value): self + { + $this->instance->setStoredCredential($value); + return $this; + } + + /** + * Initializes a new Paypal Wallet object. */ public function build(): PaypalWallet { diff --git a/src/Models/Builders/PaypalWalletCustomerBuilder.php b/src/Models/Builders/PaypalWalletCustomerBuilder.php index c70e091..a16ed2e 100644 --- a/src/Models/Builders/PaypalWalletCustomerBuilder.php +++ b/src/Models/Builders/PaypalWalletCustomerBuilder.php @@ -32,7 +32,7 @@ class PaypalWalletCustomerBuilder } /** - * Initializes a new paypal wallet customer Builder object. + * Initializes a new Paypal Wallet Customer Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class PaypalWalletCustomerBuilder /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -50,6 +52,8 @@ class PaypalWalletCustomerBuilder /** * Sets email address field. + * + * @param string|null $value */ public function emailAddress(?string $value): self { @@ -59,6 +63,8 @@ class PaypalWalletCustomerBuilder /** * Sets phone field. + * + * @param PhoneWithType|null $value */ public function phone(?PhoneWithType $value): self { @@ -68,6 +74,8 @@ class PaypalWalletCustomerBuilder /** * Sets merchant customer id field. + * + * @param string|null $value */ public function merchantCustomerId(?string $value): self { @@ -76,7 +84,7 @@ class PaypalWalletCustomerBuilder } /** - * Initializes a new paypal wallet customer object. + * Initializes a new Paypal Wallet Customer object. */ public function build(): PaypalWalletCustomer { diff --git a/src/Models/Builders/PaypalWalletCustomerRequestBuilder.php b/src/Models/Builders/PaypalWalletCustomerRequestBuilder.php index 890943f..212fb8a 100644 --- a/src/Models/Builders/PaypalWalletCustomerRequestBuilder.php +++ b/src/Models/Builders/PaypalWalletCustomerRequestBuilder.php @@ -32,7 +32,7 @@ class PaypalWalletCustomerRequestBuilder } /** - * Initializes a new paypal wallet customer request Builder object. + * Initializes a new Paypal Wallet Customer Request Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class PaypalWalletCustomerRequestBuilder /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -50,6 +52,8 @@ class PaypalWalletCustomerRequestBuilder /** * Sets email address field. + * + * @param string|null $value */ public function emailAddress(?string $value): self { @@ -59,6 +63,8 @@ class PaypalWalletCustomerRequestBuilder /** * Sets phone field. + * + * @param PhoneWithType|null $value */ public function phone(?PhoneWithType $value): self { @@ -68,6 +74,8 @@ class PaypalWalletCustomerRequestBuilder /** * Sets merchant customer id field. + * + * @param string|null $value */ public function merchantCustomerId(?string $value): self { @@ -76,7 +84,7 @@ class PaypalWalletCustomerRequestBuilder } /** - * Initializes a new paypal wallet customer request object. + * Initializes a new Paypal Wallet Customer Request object. */ public function build(): PaypalWalletCustomerRequest { diff --git a/src/Models/Builders/PaypalWalletExperienceContextBuilder.php b/src/Models/Builders/PaypalWalletExperienceContextBuilder.php index 97dc486..74e2423 100644 --- a/src/Models/Builders/PaypalWalletExperienceContextBuilder.php +++ b/src/Models/Builders/PaypalWalletExperienceContextBuilder.php @@ -11,6 +11,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; +use PaypalServerSdkLib\Models\CallbackConfiguration; use PaypalServerSdkLib\Models\PaypalWalletExperienceContext; /** @@ -31,7 +32,7 @@ class PaypalWalletExperienceContextBuilder } /** - * Initializes a new paypal wallet experience context Builder object. + * Initializes a new Paypal Wallet Experience Context Builder object. */ public static function init(): self { @@ -40,6 +41,8 @@ class PaypalWalletExperienceContextBuilder /** * Sets brand name field. + * + * @param string|null $value */ public function brandName(?string $value): self { @@ -49,6 +52,8 @@ class PaypalWalletExperienceContextBuilder /** * Sets locale field. + * + * @param string|null $value */ public function locale(?string $value): self { @@ -58,6 +63,8 @@ class PaypalWalletExperienceContextBuilder /** * Sets shipping preference field. + * + * @param string|null $value */ public function shippingPreference(?string $value): self { @@ -67,6 +74,8 @@ class PaypalWalletExperienceContextBuilder /** * Sets return url field. + * + * @param string|null $value */ public function returnUrl(?string $value): self { @@ -76,6 +85,8 @@ class PaypalWalletExperienceContextBuilder /** * Sets cancel url field. + * + * @param string|null $value */ public function cancelUrl(?string $value): self { @@ -85,6 +96,8 @@ class PaypalWalletExperienceContextBuilder /** * Sets landing page field. + * + * @param string|null $value */ public function landingPage(?string $value): self { @@ -94,6 +107,8 @@ class PaypalWalletExperienceContextBuilder /** * Sets user action field. + * + * @param string|null $value */ public function userAction(?string $value): self { @@ -103,6 +118,8 @@ class PaypalWalletExperienceContextBuilder /** * Sets payment method preference field. + * + * @param string|null $value */ public function paymentMethodPreference(?string $value): self { @@ -111,7 +128,18 @@ class PaypalWalletExperienceContextBuilder } /** - * Initializes a new paypal wallet experience context object. + * Sets order update callback config field. + * + * @param CallbackConfiguration|null $value + */ + public function orderUpdateCallbackConfig(?CallbackConfiguration $value): self + { + $this->instance->setOrderUpdateCallbackConfig($value); + return $this; + } + + /** + * Initializes a new Paypal Wallet Experience Context object. */ public function build(): PaypalWalletExperienceContext { diff --git a/src/Models/Builders/PaypalWalletResponseBuilder.php b/src/Models/Builders/PaypalWalletResponseBuilder.php index 150c45e..aa60fcc 100644 --- a/src/Models/Builders/PaypalWalletResponseBuilder.php +++ b/src/Models/Builders/PaypalWalletResponseBuilder.php @@ -15,6 +15,7 @@ use PaypalServerSdkLib\Models\Address; use PaypalServerSdkLib\Models\Name; use PaypalServerSdkLib\Models\PaypalWalletAttributesResponse; use PaypalServerSdkLib\Models\PaypalWalletResponse; +use PaypalServerSdkLib\Models\PaypalWalletStoredCredential; use PaypalServerSdkLib\Models\PhoneNumber; use PaypalServerSdkLib\Models\TaxInfo; @@ -36,7 +37,7 @@ class PaypalWalletResponseBuilder } /** - * Initializes a new paypal wallet response Builder object. + * Initializes a new Paypal Wallet Response Builder object. */ public static function init(): self { @@ -45,6 +46,8 @@ class PaypalWalletResponseBuilder /** * Sets email address field. + * + * @param string|null $value */ public function emailAddress(?string $value): self { @@ -54,6 +57,8 @@ class PaypalWalletResponseBuilder /** * Sets account id field. + * + * @param string|null $value */ public function accountId(?string $value): self { @@ -63,6 +68,8 @@ class PaypalWalletResponseBuilder /** * Sets account status field. + * + * @param string|null $value */ public function accountStatus(?string $value): self { @@ -72,6 +79,8 @@ class PaypalWalletResponseBuilder /** * Sets name field. + * + * @param Name|null $value */ public function name(?Name $value): self { @@ -81,6 +90,8 @@ class PaypalWalletResponseBuilder /** * Sets phone type field. + * + * @param string|null $value */ public function phoneType(?string $value): self { @@ -90,6 +101,8 @@ class PaypalWalletResponseBuilder /** * Sets phone number field. + * + * @param PhoneNumber|null $value */ public function phoneNumber(?PhoneNumber $value): self { @@ -99,6 +112,8 @@ class PaypalWalletResponseBuilder /** * Sets birth date field. + * + * @param string|null $value */ public function birthDate(?string $value): self { @@ -108,6 +123,8 @@ class PaypalWalletResponseBuilder /** * Sets business name field. + * + * @param string|null $value */ public function businessName(?string $value): self { @@ -117,6 +134,8 @@ class PaypalWalletResponseBuilder /** * Sets tax info field. + * + * @param TaxInfo|null $value */ public function taxInfo(?TaxInfo $value): self { @@ -126,6 +145,8 @@ class PaypalWalletResponseBuilder /** * Sets address field. + * + * @param Address|null $value */ public function address(?Address $value): self { @@ -135,6 +156,8 @@ class PaypalWalletResponseBuilder /** * Sets attributes field. + * + * @param PaypalWalletAttributesResponse|null $value */ public function attributes(?PaypalWalletAttributesResponse $value): self { @@ -143,7 +166,18 @@ class PaypalWalletResponseBuilder } /** - * Initializes a new paypal wallet response object. + * Sets stored credential field. + * + * @param PaypalWalletStoredCredential|null $value + */ + public function storedCredential(?PaypalWalletStoredCredential $value): self + { + $this->instance->setStoredCredential($value); + return $this; + } + + /** + * Initializes a new Paypal Wallet Response object. */ public function build(): PaypalWalletResponse { diff --git a/src/Models/Builders/PaypalWalletStoredCredentialBuilder.php b/src/Models/Builders/PaypalWalletStoredCredentialBuilder.php new file mode 100644 index 0000000..1296085 --- /dev/null +++ b/src/Models/Builders/PaypalWalletStoredCredentialBuilder.php @@ -0,0 +1,83 @@ +instance = $instance; + } + + /** + * Initializes a new Paypal Wallet Stored Credential Builder object. + * + * @param string $paymentInitiator + */ + public static function init(string $paymentInitiator): self + { + return new self(new PaypalWalletStoredCredential($paymentInitiator)); + } + + /** + * Sets charge pattern field. + * + * @param string|null $value + */ + public function chargePattern(?string $value): self + { + $this->instance->setChargePattern($value); + return $this; + } + + /** + * Sets usage pattern field. + * + * @param string|null $value + */ + public function usagePattern(?string $value): self + { + $this->instance->setUsagePattern($value); + return $this; + } + + /** + * Sets usage field. + * + * @param string|null $value + */ + public function usage(?string $value): self + { + $this->instance->setUsage($value); + return $this; + } + + /** + * Initializes a new Paypal Wallet Stored Credential object. + */ + public function build(): PaypalWalletStoredCredential + { + return CoreHelper::clone($this->instance); + } +} diff --git a/src/Models/Builders/PaypalWalletVaultInstructionBuilder.php b/src/Models/Builders/PaypalWalletVaultInstructionBuilder.php index aef0553..0e95e17 100644 --- a/src/Models/Builders/PaypalWalletVaultInstructionBuilder.php +++ b/src/Models/Builders/PaypalWalletVaultInstructionBuilder.php @@ -31,7 +31,9 @@ class PaypalWalletVaultInstructionBuilder } /** - * Initializes a new paypal wallet vault instruction Builder object. + * Initializes a new Paypal Wallet Vault Instruction Builder object. + * + * @param string $usageType */ public static function init(string $usageType): self { @@ -40,6 +42,8 @@ class PaypalWalletVaultInstructionBuilder /** * Sets store in vault field. + * + * @param string|null $value */ public function storeInVault(?string $value): self { @@ -49,6 +53,8 @@ class PaypalWalletVaultInstructionBuilder /** * Sets description field. + * + * @param string|null $value */ public function description(?string $value): self { @@ -58,6 +64,8 @@ class PaypalWalletVaultInstructionBuilder /** * Sets usage pattern field. + * + * @param string|null $value */ public function usagePattern(?string $value): self { @@ -67,6 +75,8 @@ class PaypalWalletVaultInstructionBuilder /** * Sets customer type field. + * + * @param string|null $value */ public function customerType(?string $value): self { @@ -76,6 +86,8 @@ class PaypalWalletVaultInstructionBuilder /** * Sets permit multiple payment tokens field. + * + * @param bool|null $value */ public function permitMultiplePaymentTokens(?bool $value): self { @@ -84,7 +96,7 @@ class PaypalWalletVaultInstructionBuilder } /** - * Initializes a new paypal wallet vault instruction object. + * Initializes a new Paypal Wallet Vault Instruction object. */ public function build(): PaypalWalletVaultInstruction { diff --git a/src/Models/Builders/PaypalWalletVaultResponseBuilder.php b/src/Models/Builders/PaypalWalletVaultResponseBuilder.php index ae1f575..1f3f1b0 100644 --- a/src/Models/Builders/PaypalWalletVaultResponseBuilder.php +++ b/src/Models/Builders/PaypalWalletVaultResponseBuilder.php @@ -11,6 +11,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; +use PaypalServerSdkLib\Models\LinkDescription; use PaypalServerSdkLib\Models\PaypalWalletCustomer; use PaypalServerSdkLib\Models\PaypalWalletVaultResponse; @@ -32,7 +33,7 @@ class PaypalWalletVaultResponseBuilder } /** - * Initializes a new paypal wallet vault response Builder object. + * Initializes a new Paypal Wallet Vault Response Builder object. */ public static function init(): self { @@ -41,6 +42,8 @@ class PaypalWalletVaultResponseBuilder /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -50,6 +53,8 @@ class PaypalWalletVaultResponseBuilder /** * Sets status field. + * + * @param string|null $value */ public function status(?string $value): self { @@ -59,6 +64,8 @@ class PaypalWalletVaultResponseBuilder /** * Sets links field. + * + * @param LinkDescription[]|null $value */ public function links(?array $value): self { @@ -68,6 +75,8 @@ class PaypalWalletVaultResponseBuilder /** * Sets customer field. + * + * @param PaypalWalletCustomer|null $value */ public function customer(?PaypalWalletCustomer $value): self { @@ -76,7 +85,7 @@ class PaypalWalletVaultResponseBuilder } /** - * Initializes a new paypal wallet vault response object. + * Initializes a new Paypal Wallet Vault Response object. */ public function build(): PaypalWalletVaultResponse { diff --git a/src/Models/Builders/PhoneBuilder.php b/src/Models/Builders/PhoneBuilder.php index 47cd943..1a005a3 100644 --- a/src/Models/Builders/PhoneBuilder.php +++ b/src/Models/Builders/PhoneBuilder.php @@ -31,7 +31,10 @@ class PhoneBuilder } /** - * Initializes a new phone Builder object. + * Initializes a new Phone Builder object. + * + * @param string $countryCode + * @param string $nationalNumber */ public static function init(string $countryCode, string $nationalNumber): self { @@ -40,6 +43,8 @@ class PhoneBuilder /** * Sets extension number field. + * + * @param string|null $value */ public function extensionNumber(?string $value): self { @@ -48,7 +53,7 @@ class PhoneBuilder } /** - * Initializes a new phone object. + * Initializes a new Phone object. */ public function build(): Phone { diff --git a/src/Models/Builders/PhoneNumberBuilder.php b/src/Models/Builders/PhoneNumberBuilder.php index 7ad3361..746c907 100644 --- a/src/Models/Builders/PhoneNumberBuilder.php +++ b/src/Models/Builders/PhoneNumberBuilder.php @@ -31,7 +31,9 @@ class PhoneNumberBuilder } /** - * Initializes a new phone number Builder object. + * Initializes a new Phone Number Builder object. + * + * @param string $nationalNumber */ public static function init(string $nationalNumber): self { @@ -39,7 +41,7 @@ class PhoneNumberBuilder } /** - * Initializes a new phone number object. + * Initializes a new Phone Number object. */ public function build(): PhoneNumber { diff --git a/src/Models/Builders/PhoneNumberWithCountryCodeBuilder.php b/src/Models/Builders/PhoneNumberWithCountryCodeBuilder.php index bce68df..758af07 100644 --- a/src/Models/Builders/PhoneNumberWithCountryCodeBuilder.php +++ b/src/Models/Builders/PhoneNumberWithCountryCodeBuilder.php @@ -31,7 +31,10 @@ class PhoneNumberWithCountryCodeBuilder } /** - * Initializes a new phone number with country code Builder object. + * Initializes a new Phone Number With Country Code Builder object. + * + * @param string $countryCode + * @param string $nationalNumber */ public static function init(string $countryCode, string $nationalNumber): self { @@ -39,7 +42,7 @@ class PhoneNumberWithCountryCodeBuilder } /** - * Initializes a new phone number with country code object. + * Initializes a new Phone Number With Country Code object. */ public function build(): PhoneNumberWithCountryCode { diff --git a/src/Models/Builders/PhoneWithTypeBuilder.php b/src/Models/Builders/PhoneWithTypeBuilder.php index 58bbbe6..5bf6567 100644 --- a/src/Models/Builders/PhoneWithTypeBuilder.php +++ b/src/Models/Builders/PhoneWithTypeBuilder.php @@ -32,7 +32,9 @@ class PhoneWithTypeBuilder } /** - * Initializes a new phone with type Builder object. + * Initializes a new Phone With Type Builder object. + * + * @param PhoneNumber $phoneNumber */ public static function init(PhoneNumber $phoneNumber): self { @@ -41,6 +43,8 @@ class PhoneWithTypeBuilder /** * Sets phone type field. + * + * @param string|null $value */ public function phoneType(?string $value): self { @@ -49,7 +53,7 @@ class PhoneWithTypeBuilder } /** - * Initializes a new phone with type object. + * Initializes a new Phone With Type object. */ public function build(): PhoneWithType { diff --git a/src/Models/Builders/PlanBuilder.php b/src/Models/Builders/PlanBuilder.php new file mode 100644 index 0000000..606ac78 --- /dev/null +++ b/src/Models/Builders/PlanBuilder.php @@ -0,0 +1,75 @@ +instance = $instance; + } + + /** + * Initializes a new Plan Builder object. + * + * @param BillingCycle[] $billingCycles + * @param OneTimeCharge $oneTimeCharges + */ + public static function init(array $billingCycles, OneTimeCharge $oneTimeCharges): self + { + return new self(new Plan($billingCycles, $oneTimeCharges)); + } + + /** + * Sets product field. + * + * @param mixed $value + */ + public function product($value): self + { + $this->instance->setProduct($value); + return $this; + } + + /** + * Sets name field. + * + * @param string|null $value + */ + public function name(?string $value): self + { + $this->instance->setName($value); + return $this; + } + + /** + * Initializes a new Plan object. + */ + public function build(): Plan + { + return CoreHelper::clone($this->instance); + } +} diff --git a/src/Models/Builders/PlatformFeeBuilder.php b/src/Models/Builders/PlatformFeeBuilder.php index 0871a36..9f14834 100644 --- a/src/Models/Builders/PlatformFeeBuilder.php +++ b/src/Models/Builders/PlatformFeeBuilder.php @@ -33,7 +33,9 @@ class PlatformFeeBuilder } /** - * Initializes a new platform fee Builder object. + * Initializes a new Platform Fee Builder object. + * + * @param Money $amount */ public static function init(Money $amount): self { @@ -42,6 +44,8 @@ class PlatformFeeBuilder /** * Sets payee field. + * + * @param PayeeBase|null $value */ public function payee(?PayeeBase $value): self { @@ -50,7 +54,7 @@ class PlatformFeeBuilder } /** - * Initializes a new platform fee object. + * Initializes a new Platform Fee object. */ public function build(): PlatformFee { diff --git a/src/Models/Builders/PricingSchemeBuilder.php b/src/Models/Builders/PricingSchemeBuilder.php new file mode 100644 index 0000000..318365c --- /dev/null +++ b/src/Models/Builders/PricingSchemeBuilder.php @@ -0,0 +1,73 @@ +instance = $instance; + } + + /** + * Initializes a new Pricing Scheme Builder object. + * + * @param string $pricingModel + */ + public static function init(string $pricingModel): self + { + return new self(new PricingScheme($pricingModel)); + } + + /** + * Sets price field. + * + * @param Money|null $value + */ + public function price(?Money $value): self + { + $this->instance->setPrice($value); + return $this; + } + + /** + * Sets reload threshold amount field. + * + * @param Money|null $value + */ + public function reloadThresholdAmount(?Money $value): self + { + $this->instance->setReloadThresholdAmount($value); + return $this; + } + + /** + * Initializes a new Pricing Scheme object. + */ + public function build(): PricingScheme + { + return CoreHelper::clone($this->instance); + } +} diff --git a/src/Models/Builders/ProcessorResponseBuilder.php b/src/Models/Builders/ProcessorResponseBuilder.php index 2da5ca8..c708a85 100644 --- a/src/Models/Builders/ProcessorResponseBuilder.php +++ b/src/Models/Builders/ProcessorResponseBuilder.php @@ -31,7 +31,7 @@ class ProcessorResponseBuilder } /** - * Initializes a new processor response Builder object. + * Initializes a new Processor Response Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class ProcessorResponseBuilder /** * Sets avs code field. + * + * @param string|null $value */ public function avsCode(?string $value): self { @@ -49,6 +51,8 @@ class ProcessorResponseBuilder /** * Sets cvv code field. + * + * @param string|null $value */ public function cvvCode(?string $value): self { @@ -58,6 +62,8 @@ class ProcessorResponseBuilder /** * Sets response code field. + * + * @param string|null $value */ public function responseCode(?string $value): self { @@ -67,6 +73,8 @@ class ProcessorResponseBuilder /** * Sets payment advice code field. + * + * @param string|null $value */ public function paymentAdviceCode(?string $value): self { @@ -75,7 +83,7 @@ class ProcessorResponseBuilder } /** - * Initializes a new processor response object. + * Initializes a new Processor Response object. */ public function build(): ProcessorResponse { diff --git a/src/Models/Builders/PurchaseUnitBuilder.php b/src/Models/Builders/PurchaseUnitBuilder.php index 6e06024..4f24a96 100644 --- a/src/Models/Builders/PurchaseUnitBuilder.php +++ b/src/Models/Builders/PurchaseUnitBuilder.php @@ -12,7 +12,8 @@ namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; use PaypalServerSdkLib\Models\AmountWithBreakdown; -use PaypalServerSdkLib\Models\Payee; +use PaypalServerSdkLib\Models\Item; +use PaypalServerSdkLib\Models\PayeeBase; use PaypalServerSdkLib\Models\PaymentCollection; use PaypalServerSdkLib\Models\PaymentInstruction; use PaypalServerSdkLib\Models\PurchaseUnit; @@ -37,7 +38,7 @@ class PurchaseUnitBuilder } /** - * Initializes a new purchase unit Builder object. + * Initializes a new Purchase Unit Builder object. */ public static function init(): self { @@ -46,6 +47,8 @@ class PurchaseUnitBuilder /** * Sets reference id field. + * + * @param string|null $value */ public function referenceId(?string $value): self { @@ -55,6 +58,8 @@ class PurchaseUnitBuilder /** * Sets amount field. + * + * @param AmountWithBreakdown|null $value */ public function amount(?AmountWithBreakdown $value): self { @@ -64,8 +69,10 @@ class PurchaseUnitBuilder /** * Sets payee field. + * + * @param PayeeBase|null $value */ - public function payee(?Payee $value): self + public function payee(?PayeeBase $value): self { $this->instance->setPayee($value); return $this; @@ -73,6 +80,8 @@ class PurchaseUnitBuilder /** * Sets payment instruction field. + * + * @param PaymentInstruction|null $value */ public function paymentInstruction(?PaymentInstruction $value): self { @@ -82,6 +91,8 @@ class PurchaseUnitBuilder /** * Sets description field. + * + * @param string|null $value */ public function description(?string $value): self { @@ -91,6 +102,8 @@ class PurchaseUnitBuilder /** * Sets custom id field. + * + * @param string|null $value */ public function customId(?string $value): self { @@ -100,6 +113,8 @@ class PurchaseUnitBuilder /** * Sets invoice id field. + * + * @param string|null $value */ public function invoiceId(?string $value): self { @@ -109,6 +124,8 @@ class PurchaseUnitBuilder /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -118,6 +135,8 @@ class PurchaseUnitBuilder /** * Sets soft descriptor field. + * + * @param string|null $value */ public function softDescriptor(?string $value): self { @@ -127,6 +146,8 @@ class PurchaseUnitBuilder /** * Sets items field. + * + * @param Item[]|null $value */ public function items(?array $value): self { @@ -136,6 +157,8 @@ class PurchaseUnitBuilder /** * Sets shipping field. + * + * @param ShippingWithTrackingDetails|null $value */ public function shipping(?ShippingWithTrackingDetails $value): self { @@ -145,6 +168,8 @@ class PurchaseUnitBuilder /** * Sets supplementary data field. + * + * @param SupplementaryData|null $value */ public function supplementaryData(?SupplementaryData $value): self { @@ -154,6 +179,8 @@ class PurchaseUnitBuilder /** * Sets payments field. + * + * @param PaymentCollection|null $value */ public function payments(?PaymentCollection $value): self { @@ -163,6 +190,8 @@ class PurchaseUnitBuilder /** * Sets most recent errors field. + * + * @param array $value */ public function mostRecentErrors(array $value): self { @@ -171,7 +200,7 @@ class PurchaseUnitBuilder } /** - * Initializes a new purchase unit object. + * Initializes a new Purchase Unit object. */ public function build(): PurchaseUnit { diff --git a/src/Models/Builders/PurchaseUnitRequestBuilder.php b/src/Models/Builders/PurchaseUnitRequestBuilder.php index f20bcb1..12387de 100644 --- a/src/Models/Builders/PurchaseUnitRequestBuilder.php +++ b/src/Models/Builders/PurchaseUnitRequestBuilder.php @@ -12,7 +12,8 @@ namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; use PaypalServerSdkLib\Models\AmountWithBreakdown; -use PaypalServerSdkLib\Models\Payee; +use PaypalServerSdkLib\Models\Item; +use PaypalServerSdkLib\Models\PayeeBase; use PaypalServerSdkLib\Models\PaymentInstruction; use PaypalServerSdkLib\Models\PurchaseUnitRequest; use PaypalServerSdkLib\Models\ShippingDetails; @@ -36,7 +37,9 @@ class PurchaseUnitRequestBuilder } /** - * Initializes a new purchase unit request Builder object. + * Initializes a new Purchase Unit Request Builder object. + * + * @param AmountWithBreakdown $amount */ public static function init(AmountWithBreakdown $amount): self { @@ -45,6 +48,8 @@ class PurchaseUnitRequestBuilder /** * Sets reference id field. + * + * @param string|null $value */ public function referenceId(?string $value): self { @@ -54,8 +59,10 @@ class PurchaseUnitRequestBuilder /** * Sets payee field. + * + * @param PayeeBase|null $value */ - public function payee(?Payee $value): self + public function payee(?PayeeBase $value): self { $this->instance->setPayee($value); return $this; @@ -63,6 +70,8 @@ class PurchaseUnitRequestBuilder /** * Sets payment instruction field. + * + * @param PaymentInstruction|null $value */ public function paymentInstruction(?PaymentInstruction $value): self { @@ -72,6 +81,8 @@ class PurchaseUnitRequestBuilder /** * Sets description field. + * + * @param string|null $value */ public function description(?string $value): self { @@ -81,6 +92,8 @@ class PurchaseUnitRequestBuilder /** * Sets custom id field. + * + * @param string|null $value */ public function customId(?string $value): self { @@ -90,6 +103,8 @@ class PurchaseUnitRequestBuilder /** * Sets invoice id field. + * + * @param string|null $value */ public function invoiceId(?string $value): self { @@ -99,6 +114,8 @@ class PurchaseUnitRequestBuilder /** * Sets soft descriptor field. + * + * @param string|null $value */ public function softDescriptor(?string $value): self { @@ -108,6 +125,8 @@ class PurchaseUnitRequestBuilder /** * Sets items field. + * + * @param Item[]|null $value */ public function items(?array $value): self { @@ -117,6 +136,8 @@ class PurchaseUnitRequestBuilder /** * Sets shipping field. + * + * @param ShippingDetails|null $value */ public function shipping(?ShippingDetails $value): self { @@ -126,6 +147,8 @@ class PurchaseUnitRequestBuilder /** * Sets supplementary data field. + * + * @param SupplementaryData|null $value */ public function supplementaryData(?SupplementaryData $value): self { @@ -134,7 +157,7 @@ class PurchaseUnitRequestBuilder } /** - * Initializes a new purchase unit request object. + * Initializes a new Purchase Unit Request object. */ public function build(): PurchaseUnitRequest { diff --git a/src/Models/Builders/ReauthorizeRequestBuilder.php b/src/Models/Builders/ReauthorizeRequestBuilder.php index 09e30d9..2faf855 100644 --- a/src/Models/Builders/ReauthorizeRequestBuilder.php +++ b/src/Models/Builders/ReauthorizeRequestBuilder.php @@ -32,7 +32,7 @@ class ReauthorizeRequestBuilder } /** - * Initializes a new reauthorize request Builder object. + * Initializes a new Reauthorize Request Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class ReauthorizeRequestBuilder /** * Sets amount field. + * + * @param Money|null $value */ public function amount(?Money $value): self { @@ -49,7 +51,7 @@ class ReauthorizeRequestBuilder } /** - * Initializes a new reauthorize request object. + * Initializes a new Reauthorize Request object. */ public function build(): ReauthorizeRequest { diff --git a/src/Models/Builders/RefundBuilder.php b/src/Models/Builders/RefundBuilder.php index d9db524..9b9a208 100644 --- a/src/Models/Builders/RefundBuilder.php +++ b/src/Models/Builders/RefundBuilder.php @@ -11,6 +11,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; +use PaypalServerSdkLib\Models\LinkDescription; use PaypalServerSdkLib\Models\Money; use PaypalServerSdkLib\Models\PayeeBase; use PaypalServerSdkLib\Models\Refund; @@ -35,7 +36,7 @@ class RefundBuilder } /** - * Initializes a new refund Builder object. + * Initializes a new Refund Builder object. */ public static function init(): self { @@ -44,6 +45,8 @@ class RefundBuilder /** * Sets status field. + * + * @param string|null $value */ public function status(?string $value): self { @@ -53,6 +56,8 @@ class RefundBuilder /** * Sets status details field. + * + * @param RefundStatusDetails|null $value */ public function statusDetails(?RefundStatusDetails $value): self { @@ -62,6 +67,8 @@ class RefundBuilder /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -71,6 +78,8 @@ class RefundBuilder /** * Sets amount field. + * + * @param Money|null $value */ public function amount(?Money $value): self { @@ -80,6 +89,8 @@ class RefundBuilder /** * Sets invoice id field. + * + * @param string|null $value */ public function invoiceId(?string $value): self { @@ -89,6 +100,8 @@ class RefundBuilder /** * Sets custom id field. + * + * @param string|null $value */ public function customId(?string $value): self { @@ -98,6 +111,8 @@ class RefundBuilder /** * Sets acquirer reference number field. + * + * @param string|null $value */ public function acquirerReferenceNumber(?string $value): self { @@ -107,6 +122,8 @@ class RefundBuilder /** * Sets note to payer field. + * + * @param string|null $value */ public function noteToPayer(?string $value): self { @@ -116,6 +133,8 @@ class RefundBuilder /** * Sets seller payable breakdown field. + * + * @param SellerPayableBreakdown|null $value */ public function sellerPayableBreakdown(?SellerPayableBreakdown $value): self { @@ -125,6 +144,8 @@ class RefundBuilder /** * Sets payer field. + * + * @param PayeeBase|null $value */ public function payer(?PayeeBase $value): self { @@ -134,6 +155,8 @@ class RefundBuilder /** * Sets links field. + * + * @param LinkDescription[]|null $value */ public function links(?array $value): self { @@ -143,6 +166,8 @@ class RefundBuilder /** * Sets create time field. + * + * @param string|null $value */ public function createTime(?string $value): self { @@ -152,6 +177,8 @@ class RefundBuilder /** * Sets update time field. + * + * @param string|null $value */ public function updateTime(?string $value): self { @@ -160,7 +187,7 @@ class RefundBuilder } /** - * Initializes a new refund object. + * Initializes a new Refund object. */ public function build(): Refund { diff --git a/src/Models/Builders/RefundPaymentInstructionBuilder.php b/src/Models/Builders/RefundPaymentInstructionBuilder.php index c9b9312..b678d83 100644 --- a/src/Models/Builders/RefundPaymentInstructionBuilder.php +++ b/src/Models/Builders/RefundPaymentInstructionBuilder.php @@ -12,6 +12,7 @@ namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; use PaypalServerSdkLib\Models\RefundPaymentInstruction; +use PaypalServerSdkLib\Models\RefundPlatformFee; /** * Builder for model RefundPaymentInstruction @@ -31,7 +32,7 @@ class RefundPaymentInstructionBuilder } /** - * Initializes a new refund payment instruction Builder object. + * Initializes a new Refund Payment Instruction Builder object. */ public static function init(): self { @@ -40,6 +41,8 @@ class RefundPaymentInstructionBuilder /** * Sets platform fees field. + * + * @param RefundPlatformFee[]|null $value */ public function platformFees(?array $value): self { @@ -48,7 +51,7 @@ class RefundPaymentInstructionBuilder } /** - * Initializes a new refund payment instruction object. + * Initializes a new Refund Payment Instruction object. */ public function build(): RefundPaymentInstruction { diff --git a/src/Models/Builders/RefundPlatformFeeBuilder.php b/src/Models/Builders/RefundPlatformFeeBuilder.php index 5ae05c7..57272fc 100644 --- a/src/Models/Builders/RefundPlatformFeeBuilder.php +++ b/src/Models/Builders/RefundPlatformFeeBuilder.php @@ -32,7 +32,9 @@ class RefundPlatformFeeBuilder } /** - * Initializes a new refund platform fee Builder object. + * Initializes a new Refund Platform Fee Builder object. + * + * @param Money $amount */ public static function init(Money $amount): self { @@ -40,7 +42,7 @@ class RefundPlatformFeeBuilder } /** - * Initializes a new refund platform fee object. + * Initializes a new Refund Platform Fee object. */ public function build(): RefundPlatformFee { diff --git a/src/Models/Builders/RefundRequestBuilder.php b/src/Models/Builders/RefundRequestBuilder.php index 1a127b7..9f4fbb5 100644 --- a/src/Models/Builders/RefundRequestBuilder.php +++ b/src/Models/Builders/RefundRequestBuilder.php @@ -33,7 +33,7 @@ class RefundRequestBuilder } /** - * Initializes a new refund request Builder object. + * Initializes a new Refund Request Builder object. */ public static function init(): self { @@ -42,6 +42,8 @@ class RefundRequestBuilder /** * Sets amount field. + * + * @param Money|null $value */ public function amount(?Money $value): self { @@ -51,6 +53,8 @@ class RefundRequestBuilder /** * Sets custom id field. + * + * @param string|null $value */ public function customId(?string $value): self { @@ -60,6 +64,8 @@ class RefundRequestBuilder /** * Sets invoice id field. + * + * @param string|null $value */ public function invoiceId(?string $value): self { @@ -69,6 +75,8 @@ class RefundRequestBuilder /** * Sets note to payer field. + * + * @param string|null $value */ public function noteToPayer(?string $value): self { @@ -78,6 +86,8 @@ class RefundRequestBuilder /** * Sets payment instruction field. + * + * @param RefundPaymentInstruction|null $value */ public function paymentInstruction(?RefundPaymentInstruction $value): self { @@ -86,7 +96,7 @@ class RefundRequestBuilder } /** - * Initializes a new refund request object. + * Initializes a new Refund Request object. */ public function build(): RefundRequest { diff --git a/src/Models/Builders/RefundStatusDetailsBuilder.php b/src/Models/Builders/RefundStatusDetailsBuilder.php index 93daebb..6f2878a 100644 --- a/src/Models/Builders/RefundStatusDetailsBuilder.php +++ b/src/Models/Builders/RefundStatusDetailsBuilder.php @@ -31,7 +31,7 @@ class RefundStatusDetailsBuilder } /** - * Initializes a new refund status details Builder object. + * Initializes a new Refund Status Details Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class RefundStatusDetailsBuilder /** * Sets reason field. + * + * @param string|null $value */ public function reason(?string $value): self { @@ -48,7 +50,7 @@ class RefundStatusDetailsBuilder } /** - * Initializes a new refund status details object. + * Initializes a new Refund Status Details object. */ public function build(): RefundStatusDetails { diff --git a/src/Models/Builders/RefundStatusWithDetailsBuilder.php b/src/Models/Builders/RefundStatusWithDetailsBuilder.php index 6c81e9a..83cf038 100644 --- a/src/Models/Builders/RefundStatusWithDetailsBuilder.php +++ b/src/Models/Builders/RefundStatusWithDetailsBuilder.php @@ -32,7 +32,7 @@ class RefundStatusWithDetailsBuilder } /** - * Initializes a new refund status with details Builder object. + * Initializes a new Refund Status With Details Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class RefundStatusWithDetailsBuilder /** * Sets status field. + * + * @param string|null $value */ public function status(?string $value): self { @@ -50,6 +52,8 @@ class RefundStatusWithDetailsBuilder /** * Sets status details field. + * + * @param RefundStatusDetails|null $value */ public function statusDetails(?RefundStatusDetails $value): self { @@ -58,7 +62,7 @@ class RefundStatusWithDetailsBuilder } /** - * Initializes a new refund status with details object. + * Initializes a new Refund Status With Details object. */ public function build(): RefundStatusWithDetails { diff --git a/src/Models/Builders/RelatedIdentifiersBuilder.php b/src/Models/Builders/RelatedIdentifiersBuilder.php index ce733e0..9373566 100644 --- a/src/Models/Builders/RelatedIdentifiersBuilder.php +++ b/src/Models/Builders/RelatedIdentifiersBuilder.php @@ -31,7 +31,7 @@ class RelatedIdentifiersBuilder } /** - * Initializes a new related identifiers Builder object. + * Initializes a new Related Identifiers Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class RelatedIdentifiersBuilder /** * Sets order id field. + * + * @param string|null $value */ public function orderId(?string $value): self { @@ -49,6 +51,8 @@ class RelatedIdentifiersBuilder /** * Sets authorization id field. + * + * @param string|null $value */ public function authorizationId(?string $value): self { @@ -58,6 +62,8 @@ class RelatedIdentifiersBuilder /** * Sets capture id field. + * + * @param string|null $value */ public function captureId(?string $value): self { @@ -66,7 +72,7 @@ class RelatedIdentifiersBuilder } /** - * Initializes a new related identifiers object. + * Initializes a new Related Identifiers object. */ public function build(): RelatedIdentifiers { diff --git a/src/Models/Builders/RiskSupplementaryDataBuilder.php b/src/Models/Builders/RiskSupplementaryDataBuilder.php new file mode 100644 index 0000000..9317c6c --- /dev/null +++ b/src/Models/Builders/RiskSupplementaryDataBuilder.php @@ -0,0 +1,60 @@ +instance = $instance; + } + + /** + * Initializes a new Risk Supplementary Data Builder object. + */ + public static function init(): self + { + return new self(new RiskSupplementaryData()); + } + + /** + * Sets customer field. + * + * @param ParticipantMetadata|null $value + */ + public function customer(?ParticipantMetadata $value): self + { + $this->instance->setCustomer($value); + return $this; + } + + /** + * Initializes a new Risk Supplementary Data object. + */ + public function build(): RiskSupplementaryData + { + return CoreHelper::clone($this->instance); + } +} diff --git a/src/Models/Builders/SellerPayableBreakdownBuilder.php b/src/Models/Builders/SellerPayableBreakdownBuilder.php index be93ee3..690dc4d 100644 --- a/src/Models/Builders/SellerPayableBreakdownBuilder.php +++ b/src/Models/Builders/SellerPayableBreakdownBuilder.php @@ -12,6 +12,8 @@ namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; use PaypalServerSdkLib\Models\Money; +use PaypalServerSdkLib\Models\NetAmountBreakdownItem; +use PaypalServerSdkLib\Models\PlatformFee; use PaypalServerSdkLib\Models\SellerPayableBreakdown; /** @@ -32,7 +34,7 @@ class SellerPayableBreakdownBuilder } /** - * Initializes a new seller payable breakdown Builder object. + * Initializes a new Seller Payable Breakdown Builder object. */ public static function init(): self { @@ -41,6 +43,8 @@ class SellerPayableBreakdownBuilder /** * Sets gross amount field. + * + * @param Money|null $value */ public function grossAmount(?Money $value): self { @@ -50,6 +54,8 @@ class SellerPayableBreakdownBuilder /** * Sets paypal fee field. + * + * @param Money|null $value */ public function paypalFee(?Money $value): self { @@ -59,6 +65,8 @@ class SellerPayableBreakdownBuilder /** * Sets paypal fee in receivable currency field. + * + * @param Money|null $value */ public function paypalFeeInReceivableCurrency(?Money $value): self { @@ -68,6 +76,8 @@ class SellerPayableBreakdownBuilder /** * Sets net amount field. + * + * @param Money|null $value */ public function netAmount(?Money $value): self { @@ -77,6 +87,8 @@ class SellerPayableBreakdownBuilder /** * Sets net amount in receivable currency field. + * + * @param Money|null $value */ public function netAmountInReceivableCurrency(?Money $value): self { @@ -86,6 +98,8 @@ class SellerPayableBreakdownBuilder /** * Sets platform fees field. + * + * @param PlatformFee[]|null $value */ public function platformFees(?array $value): self { @@ -95,6 +109,8 @@ class SellerPayableBreakdownBuilder /** * Sets net amount breakdown field. + * + * @param NetAmountBreakdownItem[]|null $value */ public function netAmountBreakdown(?array $value): self { @@ -104,6 +120,8 @@ class SellerPayableBreakdownBuilder /** * Sets total refunded amount field. + * + * @param Money|null $value */ public function totalRefundedAmount(?Money $value): self { @@ -112,7 +130,7 @@ class SellerPayableBreakdownBuilder } /** - * Initializes a new seller payable breakdown object. + * Initializes a new Seller Payable Breakdown object. */ public function build(): SellerPayableBreakdown { diff --git a/src/Models/Builders/SellerProtectionBuilder.php b/src/Models/Builders/SellerProtectionBuilder.php index 2ec069d..54a3b2b 100644 --- a/src/Models/Builders/SellerProtectionBuilder.php +++ b/src/Models/Builders/SellerProtectionBuilder.php @@ -31,7 +31,7 @@ class SellerProtectionBuilder } /** - * Initializes a new seller protection Builder object. + * Initializes a new Seller Protection Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class SellerProtectionBuilder /** * Sets status field. + * + * @param string|null $value */ public function status(?string $value): self { @@ -49,6 +51,8 @@ class SellerProtectionBuilder /** * Sets dispute categories field. + * + * @param string[]|null $value */ public function disputeCategories(?array $value): self { @@ -57,7 +61,7 @@ class SellerProtectionBuilder } /** - * Initializes a new seller protection object. + * Initializes a new Seller Protection object. */ public function build(): SellerProtection { diff --git a/src/Models/Builders/SellerReceivableBreakdownBuilder.php b/src/Models/Builders/SellerReceivableBreakdownBuilder.php index 21c5596..a9975ad 100644 --- a/src/Models/Builders/SellerReceivableBreakdownBuilder.php +++ b/src/Models/Builders/SellerReceivableBreakdownBuilder.php @@ -13,6 +13,7 @@ namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; use PaypalServerSdkLib\Models\ExchangeRate; use PaypalServerSdkLib\Models\Money; +use PaypalServerSdkLib\Models\PlatformFee; use PaypalServerSdkLib\Models\SellerReceivableBreakdown; /** @@ -33,7 +34,9 @@ class SellerReceivableBreakdownBuilder } /** - * Initializes a new seller receivable breakdown Builder object. + * Initializes a new Seller Receivable Breakdown Builder object. + * + * @param Money $grossAmount */ public static function init(Money $grossAmount): self { @@ -42,6 +45,8 @@ class SellerReceivableBreakdownBuilder /** * Sets paypal fee field. + * + * @param Money|null $value */ public function paypalFee(?Money $value): self { @@ -51,6 +56,8 @@ class SellerReceivableBreakdownBuilder /** * Sets paypal fee in receivable currency field. + * + * @param Money|null $value */ public function paypalFeeInReceivableCurrency(?Money $value): self { @@ -60,6 +67,8 @@ class SellerReceivableBreakdownBuilder /** * Sets net amount field. + * + * @param Money|null $value */ public function netAmount(?Money $value): self { @@ -69,6 +78,8 @@ class SellerReceivableBreakdownBuilder /** * Sets receivable amount field. + * + * @param Money|null $value */ public function receivableAmount(?Money $value): self { @@ -78,6 +89,8 @@ class SellerReceivableBreakdownBuilder /** * Sets exchange rate field. + * + * @param ExchangeRate|null $value */ public function exchangeRate(?ExchangeRate $value): self { @@ -87,6 +100,8 @@ class SellerReceivableBreakdownBuilder /** * Sets platform fees field. + * + * @param PlatformFee[]|null $value */ public function platformFees(?array $value): self { @@ -95,7 +110,7 @@ class SellerReceivableBreakdownBuilder } /** - * Initializes a new seller receivable breakdown object. + * Initializes a new Seller Receivable Breakdown object. */ public function build(): SellerReceivableBreakdown { diff --git a/src/Models/Builders/SetupTokenCardExperienceContextBuilder.php b/src/Models/Builders/SetupTokenCardExperienceContextBuilder.php index 6f8258a..21ac763 100644 --- a/src/Models/Builders/SetupTokenCardExperienceContextBuilder.php +++ b/src/Models/Builders/SetupTokenCardExperienceContextBuilder.php @@ -31,7 +31,7 @@ class SetupTokenCardExperienceContextBuilder } /** - * Initializes a new setup token card experience context Builder object. + * Initializes a new Setup Token Card Experience Context Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class SetupTokenCardExperienceContextBuilder /** * Sets brand name field. + * + * @param string|null $value */ public function brandName(?string $value): self { @@ -49,6 +51,8 @@ class SetupTokenCardExperienceContextBuilder /** * Sets locale field. + * + * @param string|null $value */ public function locale(?string $value): self { @@ -58,6 +62,8 @@ class SetupTokenCardExperienceContextBuilder /** * Sets return url field. + * + * @param string|null $value */ public function returnUrl(?string $value): self { @@ -67,6 +73,8 @@ class SetupTokenCardExperienceContextBuilder /** * Sets cancel url field. + * + * @param string|null $value */ public function cancelUrl(?string $value): self { @@ -76,6 +84,8 @@ class SetupTokenCardExperienceContextBuilder /** * Sets vault instruction field. + * + * @param string|null $value */ public function vaultInstruction(?string $value): self { @@ -84,7 +94,7 @@ class SetupTokenCardExperienceContextBuilder } /** - * Initializes a new setup token card experience context object. + * Initializes a new Setup Token Card Experience Context object. */ public function build(): SetupTokenCardExperienceContext { diff --git a/src/Models/Builders/SetupTokenRequestBuilder.php b/src/Models/Builders/SetupTokenRequestBuilder.php index a699d40..6f05e94 100644 --- a/src/Models/Builders/SetupTokenRequestBuilder.php +++ b/src/Models/Builders/SetupTokenRequestBuilder.php @@ -11,7 +11,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; -use PaypalServerSdkLib\Models\CustomerRequest; +use PaypalServerSdkLib\Models\Customer; use PaypalServerSdkLib\Models\SetupTokenRequest; use PaypalServerSdkLib\Models\SetupTokenRequestPaymentSource; @@ -33,7 +33,9 @@ class SetupTokenRequestBuilder } /** - * Initializes a new setup token request Builder object. + * Initializes a new Setup Token Request Builder object. + * + * @param SetupTokenRequestPaymentSource $paymentSource */ public static function init(SetupTokenRequestPaymentSource $paymentSource): self { @@ -42,15 +44,17 @@ class SetupTokenRequestBuilder /** * Sets customer field. + * + * @param Customer|null $value */ - public function customer(?CustomerRequest $value): self + public function customer(?Customer $value): self { $this->instance->setCustomer($value); return $this; } /** - * Initializes a new setup token request object. + * Initializes a new Setup Token Request object. */ public function build(): SetupTokenRequest { diff --git a/src/Models/Builders/SetupTokenRequestCardBuilder.php b/src/Models/Builders/SetupTokenRequestCardBuilder.php index c460222..8fffc34 100644 --- a/src/Models/Builders/SetupTokenRequestCardBuilder.php +++ b/src/Models/Builders/SetupTokenRequestCardBuilder.php @@ -33,7 +33,7 @@ class SetupTokenRequestCardBuilder } /** - * Initializes a new setup token request card Builder object. + * Initializes a new Setup Token Request Card Builder object. */ public static function init(): self { @@ -42,6 +42,8 @@ class SetupTokenRequestCardBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -51,6 +53,8 @@ class SetupTokenRequestCardBuilder /** * Sets number field. + * + * @param string|null $value */ public function number(?string $value): self { @@ -60,6 +64,8 @@ class SetupTokenRequestCardBuilder /** * Sets expiry field. + * + * @param string|null $value */ public function expiry(?string $value): self { @@ -69,6 +75,8 @@ class SetupTokenRequestCardBuilder /** * Sets security code field. + * + * @param string|null $value */ public function securityCode(?string $value): self { @@ -78,6 +86,8 @@ class SetupTokenRequestCardBuilder /** * Sets brand field. + * + * @param string|null $value */ public function brand(?string $value): self { @@ -87,6 +97,8 @@ class SetupTokenRequestCardBuilder /** * Sets billing address field. + * + * @param Address|null $value */ public function billingAddress(?Address $value): self { @@ -96,6 +108,8 @@ class SetupTokenRequestCardBuilder /** * Sets verification method field. + * + * @param string|null $value */ public function verificationMethod(?string $value): self { @@ -105,6 +119,8 @@ class SetupTokenRequestCardBuilder /** * Sets experience context field. + * + * @param SetupTokenCardExperienceContext|null $value */ public function experienceContext(?SetupTokenCardExperienceContext $value): self { @@ -113,16 +129,7 @@ class SetupTokenRequestCardBuilder } /** - * Sets network transaction reference field. - */ - public function networkTransactionReference($value): self - { - $this->instance->setNetworkTransactionReference($value); - return $this; - } - - /** - * Initializes a new setup token request card object. + * Initializes a new Setup Token Request Card object. */ public function build(): SetupTokenRequestCard { diff --git a/src/Models/Builders/SetupTokenRequestPaymentSourceBuilder.php b/src/Models/Builders/SetupTokenRequestPaymentSourceBuilder.php index 7ea7321..d706d26 100644 --- a/src/Models/Builders/SetupTokenRequestPaymentSourceBuilder.php +++ b/src/Models/Builders/SetupTokenRequestPaymentSourceBuilder.php @@ -35,7 +35,7 @@ class SetupTokenRequestPaymentSourceBuilder } /** - * Initializes a new setup token request payment source Builder object. + * Initializes a new Setup Token Request Payment Source Builder object. */ public static function init(): self { @@ -44,6 +44,8 @@ class SetupTokenRequestPaymentSourceBuilder /** * Sets card field. + * + * @param SetupTokenRequestCard|null $value */ public function card(?SetupTokenRequestCard $value): self { @@ -53,6 +55,8 @@ class SetupTokenRequestPaymentSourceBuilder /** * Sets paypal field. + * + * @param VaultPaypalWalletRequest|null $value */ public function paypal(?VaultPaypalWalletRequest $value): self { @@ -62,6 +66,8 @@ class SetupTokenRequestPaymentSourceBuilder /** * Sets venmo field. + * + * @param VaultVenmoRequest|null $value */ public function venmo(?VaultVenmoRequest $value): self { @@ -71,6 +77,8 @@ class SetupTokenRequestPaymentSourceBuilder /** * Sets token field. + * + * @param VaultTokenRequest|null $value */ public function token(?VaultTokenRequest $value): self { @@ -79,7 +87,7 @@ class SetupTokenRequestPaymentSourceBuilder } /** - * Initializes a new setup token request payment source object. + * Initializes a new Setup Token Request Payment Source object. */ public function build(): SetupTokenRequestPaymentSource { diff --git a/src/Models/Builders/SetupTokenResponseBuilder.php b/src/Models/Builders/SetupTokenResponseBuilder.php index 9cd4ce9..0c45a2d 100644 --- a/src/Models/Builders/SetupTokenResponseBuilder.php +++ b/src/Models/Builders/SetupTokenResponseBuilder.php @@ -11,7 +11,8 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; -use PaypalServerSdkLib\Models\CustomerRequest; +use PaypalServerSdkLib\Models\Customer; +use PaypalServerSdkLib\Models\LinkDescription; use PaypalServerSdkLib\Models\SetupTokenResponse; use PaypalServerSdkLib\Models\SetupTokenResponsePaymentSource; @@ -33,7 +34,7 @@ class SetupTokenResponseBuilder } /** - * Initializes a new setup token response Builder object. + * Initializes a new Setup Token Response Builder object. */ public static function init(): self { @@ -42,6 +43,8 @@ class SetupTokenResponseBuilder /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -49,19 +52,12 @@ class SetupTokenResponseBuilder return $this; } - /** - * Sets ordinal field. - */ - public function ordinal(?int $value): self - { - $this->instance->setOrdinal($value); - return $this; - } - /** * Sets customer field. + * + * @param Customer|null $value */ - public function customer(?CustomerRequest $value): self + public function customer(?Customer $value): self { $this->instance->setCustomer($value); return $this; @@ -69,6 +65,8 @@ class SetupTokenResponseBuilder /** * Sets status field. + * + * @param string|null $value */ public function status(?string $value): self { @@ -78,6 +76,8 @@ class SetupTokenResponseBuilder /** * Sets payment source field. + * + * @param SetupTokenResponsePaymentSource|null $value */ public function paymentSource(?SetupTokenResponsePaymentSource $value): self { @@ -87,6 +87,8 @@ class SetupTokenResponseBuilder /** * Sets links field. + * + * @param LinkDescription[]|null $value */ public function links(?array $value): self { @@ -95,7 +97,7 @@ class SetupTokenResponseBuilder } /** - * Initializes a new setup token response object. + * Initializes a new Setup Token Response object. */ public function build(): SetupTokenResponse { diff --git a/src/Models/Builders/SetupTokenResponseCardBuilder.php b/src/Models/Builders/SetupTokenResponseCardBuilder.php index b3e68c4..d657e58 100644 --- a/src/Models/Builders/SetupTokenResponseCardBuilder.php +++ b/src/Models/Builders/SetupTokenResponseCardBuilder.php @@ -11,9 +11,9 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; -use PaypalServerSdkLib\Models\AddressDetails; use PaypalServerSdkLib\Models\BinDetails; use PaypalServerSdkLib\Models\CardAuthenticationResponse; +use PaypalServerSdkLib\Models\CardResponseAddress; use PaypalServerSdkLib\Models\CardVerificationDetails; use PaypalServerSdkLib\Models\NetworkTransactionReferenceEntity; use PaypalServerSdkLib\Models\SetupTokenResponseCard; @@ -36,7 +36,7 @@ class SetupTokenResponseCardBuilder } /** - * Initializes a new setup token response card Builder object. + * Initializes a new Setup Token Response Card Builder object. */ public static function init(): self { @@ -45,6 +45,8 @@ class SetupTokenResponseCardBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -54,6 +56,8 @@ class SetupTokenResponseCardBuilder /** * Sets last digits field. + * + * @param string|null $value */ public function lastDigits(?string $value): self { @@ -63,6 +67,8 @@ class SetupTokenResponseCardBuilder /** * Sets brand field. + * + * @param string|null $value */ public function brand(?string $value): self { @@ -72,6 +78,8 @@ class SetupTokenResponseCardBuilder /** * Sets expiry field. + * + * @param string|null $value */ public function expiry(?string $value): self { @@ -81,8 +89,10 @@ class SetupTokenResponseCardBuilder /** * Sets billing address field. + * + * @param CardResponseAddress|null $value */ - public function billingAddress(?AddressDetails $value): self + public function billingAddress(?CardResponseAddress $value): self { $this->instance->setBillingAddress($value); return $this; @@ -90,6 +100,8 @@ class SetupTokenResponseCardBuilder /** * Sets verification status field. + * + * @param string|null $value */ public function verificationStatus(?string $value): self { @@ -99,6 +111,8 @@ class SetupTokenResponseCardBuilder /** * Sets verification field. + * + * @param CardVerificationDetails|null $value */ public function verification(?CardVerificationDetails $value): self { @@ -108,6 +122,8 @@ class SetupTokenResponseCardBuilder /** * Sets network transaction reference field. + * + * @param NetworkTransactionReferenceEntity|null $value */ public function networkTransactionReference(?NetworkTransactionReferenceEntity $value): self { @@ -117,6 +133,8 @@ class SetupTokenResponseCardBuilder /** * Sets authentication result field. + * + * @param CardAuthenticationResponse|null $value */ public function authenticationResult(?CardAuthenticationResponse $value): self { @@ -126,6 +144,8 @@ class SetupTokenResponseCardBuilder /** * Sets bin details field. + * + * @param BinDetails|null $value */ public function binDetails(?BinDetails $value): self { @@ -135,6 +155,8 @@ class SetupTokenResponseCardBuilder /** * Sets type field. + * + * @param string|null $value */ public function type(?string $value): self { @@ -143,7 +165,7 @@ class SetupTokenResponseCardBuilder } /** - * Initializes a new setup token response card object. + * Initializes a new Setup Token Response Card object. */ public function build(): SetupTokenResponseCard { diff --git a/src/Models/Builders/SetupTokenResponsePaymentSourceBuilder.php b/src/Models/Builders/SetupTokenResponsePaymentSourceBuilder.php index a957046..370fbd2 100644 --- a/src/Models/Builders/SetupTokenResponsePaymentSourceBuilder.php +++ b/src/Models/Builders/SetupTokenResponsePaymentSourceBuilder.php @@ -34,7 +34,7 @@ class SetupTokenResponsePaymentSourceBuilder } /** - * Initializes a new setup token response payment source Builder object. + * Initializes a new Setup Token Response Payment Source Builder object. */ public static function init(): self { @@ -43,6 +43,8 @@ class SetupTokenResponsePaymentSourceBuilder /** * Sets card field. + * + * @param SetupTokenResponseCard|null $value */ public function card(?SetupTokenResponseCard $value): self { @@ -52,6 +54,8 @@ class SetupTokenResponsePaymentSourceBuilder /** * Sets paypal field. + * + * @param PaypalPaymentToken|null $value */ public function paypal(?PaypalPaymentToken $value): self { @@ -61,6 +65,8 @@ class SetupTokenResponsePaymentSourceBuilder /** * Sets venmo field. + * + * @param VenmoPaymentToken|null $value */ public function venmo(?VenmoPaymentToken $value): self { @@ -69,7 +75,7 @@ class SetupTokenResponsePaymentSourceBuilder } /** - * Initializes a new setup token response payment source object. + * Initializes a new Setup Token Response Payment Source object. */ public function build(): SetupTokenResponsePaymentSource { diff --git a/src/Models/Builders/ShippingDetailsBuilder.php b/src/Models/Builders/ShippingDetailsBuilder.php index 470c319..7974f28 100644 --- a/src/Models/Builders/ShippingDetailsBuilder.php +++ b/src/Models/Builders/ShippingDetailsBuilder.php @@ -15,6 +15,7 @@ use PaypalServerSdkLib\Models\Address; use PaypalServerSdkLib\Models\PhoneNumberWithCountryCode; use PaypalServerSdkLib\Models\ShippingDetails; use PaypalServerSdkLib\Models\ShippingName; +use PaypalServerSdkLib\Models\ShippingOption; /** * Builder for model ShippingDetails @@ -34,7 +35,7 @@ class ShippingDetailsBuilder } /** - * Initializes a new shipping details Builder object. + * Initializes a new Shipping Details Builder object. */ public static function init(): self { @@ -43,6 +44,8 @@ class ShippingDetailsBuilder /** * Sets name field. + * + * @param ShippingName|null $value */ public function name(?ShippingName $value): self { @@ -50,8 +53,21 @@ class ShippingDetailsBuilder return $this; } + /** + * Sets email address field. + * + * @param string|null $value + */ + public function emailAddress(?string $value): self + { + $this->instance->setEmailAddress($value); + return $this; + } + /** * Sets phone number field. + * + * @param PhoneNumberWithCountryCode|null $value */ public function phoneNumber(?PhoneNumberWithCountryCode $value): self { @@ -61,6 +77,8 @@ class ShippingDetailsBuilder /** * Sets type field. + * + * @param string|null $value */ public function type(?string $value): self { @@ -70,6 +88,8 @@ class ShippingDetailsBuilder /** * Sets options field. + * + * @param ShippingOption[]|null $value */ public function options(?array $value): self { @@ -79,6 +99,8 @@ class ShippingDetailsBuilder /** * Sets address field. + * + * @param Address|null $value */ public function address(?Address $value): self { @@ -87,7 +109,7 @@ class ShippingDetailsBuilder } /** - * Initializes a new shipping details object. + * Initializes a new Shipping Details object. */ public function build(): ShippingDetails { diff --git a/src/Models/Builders/ShippingNameBuilder.php b/src/Models/Builders/ShippingNameBuilder.php index 309c373..967b8f4 100644 --- a/src/Models/Builders/ShippingNameBuilder.php +++ b/src/Models/Builders/ShippingNameBuilder.php @@ -31,7 +31,7 @@ class ShippingNameBuilder } /** - * Initializes a new shipping name Builder object. + * Initializes a new Shipping Name Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class ShippingNameBuilder /** * Sets full name field. + * + * @param string|null $value */ public function fullName(?string $value): self { @@ -48,7 +50,7 @@ class ShippingNameBuilder } /** - * Initializes a new shipping name object. + * Initializes a new Shipping Name object. */ public function build(): ShippingName { diff --git a/src/Models/Builders/ShippingOptionBuilder.php b/src/Models/Builders/ShippingOptionBuilder.php index 29ccf4e..671bfbf 100644 --- a/src/Models/Builders/ShippingOptionBuilder.php +++ b/src/Models/Builders/ShippingOptionBuilder.php @@ -32,7 +32,11 @@ class ShippingOptionBuilder } /** - * Initializes a new shipping option Builder object. + * Initializes a new Shipping Option Builder object. + * + * @param string $id + * @param string $label + * @param bool $selected */ public static function init(string $id, string $label, bool $selected): self { @@ -41,6 +45,8 @@ class ShippingOptionBuilder /** * Sets type field. + * + * @param string|null $value */ public function type(?string $value): self { @@ -50,6 +56,8 @@ class ShippingOptionBuilder /** * Sets amount field. + * + * @param Money|null $value */ public function amount(?Money $value): self { @@ -58,7 +66,7 @@ class ShippingOptionBuilder } /** - * Initializes a new shipping option object. + * Initializes a new Shipping Option object. */ public function build(): ShippingOption { diff --git a/src/Models/Builders/ShippingOptionsPurchaseUnitBuilder.php b/src/Models/Builders/ShippingOptionsPurchaseUnitBuilder.php new file mode 100644 index 0000000..78adadb --- /dev/null +++ b/src/Models/Builders/ShippingOptionsPurchaseUnitBuilder.php @@ -0,0 +1,83 @@ +instance = $instance; + } + + /** + * Initializes a new Shipping Options Purchase Unit Builder object. + */ + public static function init(): self + { + return new self(new ShippingOptionsPurchaseUnit()); + } + + /** + * Sets reference id field. + * + * @param string|null $value + */ + public function referenceId(?string $value): self + { + $this->instance->setReferenceId($value); + return $this; + } + + /** + * Sets amount field. + * + * @param AmountWithBreakdown|null $value + */ + public function amount(?AmountWithBreakdown $value): self + { + $this->instance->setAmount($value); + return $this; + } + + /** + * Sets shipping options field. + * + * @param ShippingOption[]|null $value + */ + public function shippingOptions(?array $value): self + { + $this->instance->setShippingOptions($value); + return $this; + } + + /** + * Initializes a new Shipping Options Purchase Unit object. + */ + public function build(): ShippingOptionsPurchaseUnit + { + return CoreHelper::clone($this->instance); + } +} diff --git a/src/Models/Builders/ShippingWithTrackingDetailsBuilder.php b/src/Models/Builders/ShippingWithTrackingDetailsBuilder.php index 347b480..08d692c 100644 --- a/src/Models/Builders/ShippingWithTrackingDetailsBuilder.php +++ b/src/Models/Builders/ShippingWithTrackingDetailsBuilder.php @@ -12,8 +12,10 @@ namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; use PaypalServerSdkLib\Models\Address; +use PaypalServerSdkLib\Models\OrderTrackerResponse; use PaypalServerSdkLib\Models\PhoneNumberWithCountryCode; use PaypalServerSdkLib\Models\ShippingName; +use PaypalServerSdkLib\Models\ShippingOption; use PaypalServerSdkLib\Models\ShippingWithTrackingDetails; /** @@ -34,7 +36,7 @@ class ShippingWithTrackingDetailsBuilder } /** - * Initializes a new shipping with tracking details Builder object. + * Initializes a new Shipping With Tracking Details Builder object. */ public static function init(): self { @@ -43,6 +45,8 @@ class ShippingWithTrackingDetailsBuilder /** * Sets name field. + * + * @param ShippingName|null $value */ public function name(?ShippingName $value): self { @@ -50,8 +54,21 @@ class ShippingWithTrackingDetailsBuilder return $this; } + /** + * Sets email address field. + * + * @param string|null $value + */ + public function emailAddress(?string $value): self + { + $this->instance->setEmailAddress($value); + return $this; + } + /** * Sets phone number field. + * + * @param PhoneNumberWithCountryCode|null $value */ public function phoneNumber(?PhoneNumberWithCountryCode $value): self { @@ -61,6 +78,8 @@ class ShippingWithTrackingDetailsBuilder /** * Sets type field. + * + * @param string|null $value */ public function type(?string $value): self { @@ -70,6 +89,8 @@ class ShippingWithTrackingDetailsBuilder /** * Sets options field. + * + * @param ShippingOption[]|null $value */ public function options(?array $value): self { @@ -79,6 +100,8 @@ class ShippingWithTrackingDetailsBuilder /** * Sets address field. + * + * @param Address|null $value */ public function address(?Address $value): self { @@ -88,6 +111,8 @@ class ShippingWithTrackingDetailsBuilder /** * Sets trackers field. + * + * @param OrderTrackerResponse[]|null $value */ public function trackers(?array $value): self { @@ -96,7 +121,7 @@ class ShippingWithTrackingDetailsBuilder } /** - * Initializes a new shipping with tracking details object. + * Initializes a new Shipping With Tracking Details object. */ public function build(): ShippingWithTrackingDetails { diff --git a/src/Models/Builders/SofortPaymentObjectBuilder.php b/src/Models/Builders/SofortPaymentObjectBuilder.php index d61ccf9..518f07f 100644 --- a/src/Models/Builders/SofortPaymentObjectBuilder.php +++ b/src/Models/Builders/SofortPaymentObjectBuilder.php @@ -31,7 +31,7 @@ class SofortPaymentObjectBuilder } /** - * Initializes a new sofort payment object Builder object. + * Initializes a new Sofort Payment Object Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class SofortPaymentObjectBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -49,6 +51,8 @@ class SofortPaymentObjectBuilder /** * Sets country code field. + * + * @param string|null $value */ public function countryCode(?string $value): self { @@ -58,6 +62,8 @@ class SofortPaymentObjectBuilder /** * Sets bic field. + * + * @param string|null $value */ public function bic(?string $value): self { @@ -67,6 +73,8 @@ class SofortPaymentObjectBuilder /** * Sets iban last chars field. + * + * @param string|null $value */ public function ibanLastChars(?string $value): self { @@ -75,7 +83,7 @@ class SofortPaymentObjectBuilder } /** - * Initializes a new sofort payment object object. + * Initializes a new Sofort Payment Object object. */ public function build(): SofortPaymentObject { diff --git a/src/Models/Builders/SofortPaymentRequestBuilder.php b/src/Models/Builders/SofortPaymentRequestBuilder.php index d8a35b3..706f92a 100644 --- a/src/Models/Builders/SofortPaymentRequestBuilder.php +++ b/src/Models/Builders/SofortPaymentRequestBuilder.php @@ -32,7 +32,10 @@ class SofortPaymentRequestBuilder } /** - * Initializes a new sofort payment request Builder object. + * Initializes a new Sofort Payment Request Builder object. + * + * @param string $name + * @param string $countryCode */ public static function init(string $name, string $countryCode): self { @@ -41,6 +44,8 @@ class SofortPaymentRequestBuilder /** * Sets experience context field. + * + * @param ExperienceContext|null $value */ public function experienceContext(?ExperienceContext $value): self { @@ -49,7 +54,7 @@ class SofortPaymentRequestBuilder } /** - * Initializes a new sofort payment request object. + * Initializes a new Sofort Payment Request object. */ public function build(): SofortPaymentRequest { diff --git a/src/Models/Builders/StoredPaymentSourceBuilder.php b/src/Models/Builders/StoredPaymentSourceBuilder.php index c5e29a8..15c7825 100644 --- a/src/Models/Builders/StoredPaymentSourceBuilder.php +++ b/src/Models/Builders/StoredPaymentSourceBuilder.php @@ -32,7 +32,10 @@ class StoredPaymentSourceBuilder } /** - * Initializes a new stored payment source Builder object. + * Initializes a new Stored Payment Source Builder object. + * + * @param string $paymentInitiator + * @param string $paymentType */ public static function init(string $paymentInitiator, string $paymentType): self { @@ -41,6 +44,8 @@ class StoredPaymentSourceBuilder /** * Sets usage field. + * + * @param string|null $value */ public function usage(?string $value): self { @@ -50,6 +55,8 @@ class StoredPaymentSourceBuilder /** * Sets previous network transaction reference field. + * + * @param NetworkTransactionReference|null $value */ public function previousNetworkTransactionReference(?NetworkTransactionReference $value): self { @@ -58,7 +65,7 @@ class StoredPaymentSourceBuilder } /** - * Initializes a new stored payment source object. + * Initializes a new Stored Payment Source object. */ public function build(): StoredPaymentSource { diff --git a/src/Models/Builders/SupplementaryDataBuilder.php b/src/Models/Builders/SupplementaryDataBuilder.php index a171389..42df62d 100644 --- a/src/Models/Builders/SupplementaryDataBuilder.php +++ b/src/Models/Builders/SupplementaryDataBuilder.php @@ -12,6 +12,7 @@ namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; use PaypalServerSdkLib\Models\CardSupplementaryData; +use PaypalServerSdkLib\Models\RiskSupplementaryData; use PaypalServerSdkLib\Models\SupplementaryData; /** @@ -32,7 +33,7 @@ class SupplementaryDataBuilder } /** - * Initializes a new supplementary data Builder object. + * Initializes a new Supplementary Data Builder object. */ public static function init(): self { @@ -41,6 +42,8 @@ class SupplementaryDataBuilder /** * Sets card field. + * + * @param CardSupplementaryData|null $value */ public function card(?CardSupplementaryData $value): self { @@ -49,7 +52,18 @@ class SupplementaryDataBuilder } /** - * Initializes a new supplementary data object. + * Sets risk field. + * + * @param RiskSupplementaryData|null $value + */ + public function risk(?RiskSupplementaryData $value): self + { + $this->instance->setRisk($value); + return $this; + } + + /** + * Initializes a new Supplementary Data object. */ public function build(): SupplementaryData { diff --git a/src/Models/Builders/SupplementaryPurchaseDataBuilder.php b/src/Models/Builders/SupplementaryPurchaseDataBuilder.php index 49ae9f4..14aa074 100644 --- a/src/Models/Builders/SupplementaryPurchaseDataBuilder.php +++ b/src/Models/Builders/SupplementaryPurchaseDataBuilder.php @@ -31,7 +31,7 @@ class SupplementaryPurchaseDataBuilder } /** - * Initializes a new supplementary purchase data Builder object. + * Initializes a new Supplementary Purchase Data Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class SupplementaryPurchaseDataBuilder /** * Sets invoice id field. + * + * @param string|null $value */ public function invoiceId(?string $value): self { @@ -49,6 +51,8 @@ class SupplementaryPurchaseDataBuilder /** * Sets note to payer field. + * + * @param string|null $value */ public function noteToPayer(?string $value): self { @@ -57,7 +61,7 @@ class SupplementaryPurchaseDataBuilder } /** - * Initializes a new supplementary purchase data object. + * Initializes a new Supplementary Purchase Data object. */ public function build(): SupplementaryPurchaseData { diff --git a/src/Models/Builders/TaxInfoBuilder.php b/src/Models/Builders/TaxInfoBuilder.php index e6b7d70..d085b5b 100644 --- a/src/Models/Builders/TaxInfoBuilder.php +++ b/src/Models/Builders/TaxInfoBuilder.php @@ -31,7 +31,10 @@ class TaxInfoBuilder } /** - * Initializes a new tax info Builder object. + * Initializes a new Tax Info Builder object. + * + * @param string $taxId + * @param string $taxIdType */ public static function init(string $taxId, string $taxIdType): self { @@ -39,7 +42,7 @@ class TaxInfoBuilder } /** - * Initializes a new tax info object. + * Initializes a new Tax Info object. */ public function build(): TaxInfo { diff --git a/src/Models/Builders/ThreeDSecureAuthenticationResponseBuilder.php b/src/Models/Builders/ThreeDSecureAuthenticationResponseBuilder.php index 59b12b6..88ebb93 100644 --- a/src/Models/Builders/ThreeDSecureAuthenticationResponseBuilder.php +++ b/src/Models/Builders/ThreeDSecureAuthenticationResponseBuilder.php @@ -31,7 +31,7 @@ class ThreeDSecureAuthenticationResponseBuilder } /** - * Initializes a new three dsecure authentication response Builder object. + * Initializes a new Three D Secure Authentication Response Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class ThreeDSecureAuthenticationResponseBuilder /** * Sets authentication status field. + * + * @param string|null $value */ public function authenticationStatus(?string $value): self { @@ -49,6 +51,8 @@ class ThreeDSecureAuthenticationResponseBuilder /** * Sets enrollment status field. + * + * @param string|null $value */ public function enrollmentStatus(?string $value): self { @@ -57,7 +61,7 @@ class ThreeDSecureAuthenticationResponseBuilder } /** - * Initializes a new three dsecure authentication response object. + * Initializes a new Three D Secure Authentication Response object. */ public function build(): ThreeDSecureAuthenticationResponse { diff --git a/src/Models/Builders/ThreeDSecureCardAuthenticationResponseBuilder.php b/src/Models/Builders/ThreeDSecureCardAuthenticationResponseBuilder.php new file mode 100644 index 0000000..f2d6ca7 --- /dev/null +++ b/src/Models/Builders/ThreeDSecureCardAuthenticationResponseBuilder.php @@ -0,0 +1,81 @@ +instance = $instance; + } + + /** + * Initializes a new Three D Secure Card Authentication Response Builder object. + */ + public static function init(): self + { + return new self(new ThreeDSecureCardAuthenticationResponse()); + } + + /** + * Sets authentication status field. + * + * @param string|null $value + */ + public function authenticationStatus(?string $value): self + { + $this->instance->setAuthenticationStatus($value); + return $this; + } + + /** + * Sets enrollment status field. + * + * @param string|null $value + */ + public function enrollmentStatus(?string $value): self + { + $this->instance->setEnrollmentStatus($value); + return $this; + } + + /** + * Sets authentication id field. + * + * @param string|null $value + */ + public function authenticationId(?string $value): self + { + $this->instance->setAuthenticationId($value); + return $this; + } + + /** + * Initializes a new Three D Secure Card Authentication Response object. + */ + public function build(): ThreeDSecureCardAuthenticationResponse + { + return CoreHelper::clone($this->instance); + } +} diff --git a/src/Models/Builders/TokenBuilder.php b/src/Models/Builders/TokenBuilder.php index 9ca76b5..7ae65b0 100644 --- a/src/Models/Builders/TokenBuilder.php +++ b/src/Models/Builders/TokenBuilder.php @@ -31,7 +31,10 @@ class TokenBuilder } /** - * Initializes a new token Builder object. + * Initializes a new Token Builder object. + * + * @param string $id + * @param string $type */ public static function init(string $id, string $type): self { @@ -39,7 +42,7 @@ class TokenBuilder } /** - * Initializes a new token object. + * Initializes a new Token object. */ public function build(): Token { diff --git a/src/Models/Builders/TrustlyPaymentObjectBuilder.php b/src/Models/Builders/TrustlyPaymentObjectBuilder.php index 50446f9..9928232 100644 --- a/src/Models/Builders/TrustlyPaymentObjectBuilder.php +++ b/src/Models/Builders/TrustlyPaymentObjectBuilder.php @@ -31,7 +31,7 @@ class TrustlyPaymentObjectBuilder } /** - * Initializes a new trustly payment object Builder object. + * Initializes a new Trustly Payment Object Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class TrustlyPaymentObjectBuilder /** * Sets name field. + * + * @param string|null $value */ public function name(?string $value): self { @@ -49,6 +51,8 @@ class TrustlyPaymentObjectBuilder /** * Sets country code field. + * + * @param string|null $value */ public function countryCode(?string $value): self { @@ -56,8 +60,21 @@ class TrustlyPaymentObjectBuilder return $this; } + /** + * Sets email field. + * + * @param string|null $value + */ + public function email(?string $value): self + { + $this->instance->setEmail($value); + return $this; + } + /** * Sets bic field. + * + * @param string|null $value */ public function bic(?string $value): self { @@ -67,6 +84,8 @@ class TrustlyPaymentObjectBuilder /** * Sets iban last chars field. + * + * @param string|null $value */ public function ibanLastChars(?string $value): self { @@ -75,7 +94,7 @@ class TrustlyPaymentObjectBuilder } /** - * Initializes a new trustly payment object object. + * Initializes a new Trustly Payment Object object. */ public function build(): TrustlyPaymentObject { diff --git a/src/Models/Builders/TrustlyPaymentRequestBuilder.php b/src/Models/Builders/TrustlyPaymentRequestBuilder.php index d3e297b..0e52e46 100644 --- a/src/Models/Builders/TrustlyPaymentRequestBuilder.php +++ b/src/Models/Builders/TrustlyPaymentRequestBuilder.php @@ -32,15 +32,21 @@ class TrustlyPaymentRequestBuilder } /** - * Initializes a new trustly payment request Builder object. + * Initializes a new Trustly Payment Request Builder object. + * + * @param string $name + * @param string $countryCode + * @param string $email */ - public static function init(string $name, string $countryCode): self + public static function init(string $name, string $countryCode, string $email): self { - return new self(new TrustlyPaymentRequest($name, $countryCode)); + return new self(new TrustlyPaymentRequest($name, $countryCode, $email)); } /** * Sets experience context field. + * + * @param ExperienceContext|null $value */ public function experienceContext(?ExperienceContext $value): self { @@ -49,7 +55,7 @@ class TrustlyPaymentRequestBuilder } /** - * Initializes a new trustly payment request object. + * Initializes a new Trustly Payment Request object. */ public function build(): TrustlyPaymentRequest { diff --git a/src/Models/Builders/UniversalProductCodeBuilder.php b/src/Models/Builders/UniversalProductCodeBuilder.php index 08b9c3d..ed5e2fe 100644 --- a/src/Models/Builders/UniversalProductCodeBuilder.php +++ b/src/Models/Builders/UniversalProductCodeBuilder.php @@ -31,7 +31,10 @@ class UniversalProductCodeBuilder } /** - * Initializes a new universal product code Builder object. + * Initializes a new Universal Product Code Builder object. + * + * @param string $type + * @param string $code */ public static function init(string $type, string $code): self { @@ -39,7 +42,7 @@ class UniversalProductCodeBuilder } /** - * Initializes a new universal product code object. + * Initializes a new Universal Product Code object. */ public function build(): UniversalProductCode { diff --git a/src/Models/Builders/VaultCustomerBuilder.php b/src/Models/Builders/VaultCustomerBuilder.php index 184581e..788d524 100644 --- a/src/Models/Builders/VaultCustomerBuilder.php +++ b/src/Models/Builders/VaultCustomerBuilder.php @@ -31,7 +31,7 @@ class VaultCustomerBuilder } /** - * Initializes a new vault customer Builder object. + * Initializes a new Vault Customer Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class VaultCustomerBuilder /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -48,7 +50,7 @@ class VaultCustomerBuilder } /** - * Initializes a new vault customer object. + * Initializes a new Vault Customer object. */ public function build(): VaultCustomer { diff --git a/src/Models/Builders/VaultExperienceContextBuilder.php b/src/Models/Builders/VaultExperienceContextBuilder.php index 001e14a..a86fcbd 100644 --- a/src/Models/Builders/VaultExperienceContextBuilder.php +++ b/src/Models/Builders/VaultExperienceContextBuilder.php @@ -31,7 +31,7 @@ class VaultExperienceContextBuilder } /** - * Initializes a new vault experience context Builder object. + * Initializes a new Vault Experience Context Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class VaultExperienceContextBuilder /** * Sets brand name field. + * + * @param string|null $value */ public function brandName(?string $value): self { @@ -49,6 +51,8 @@ class VaultExperienceContextBuilder /** * Sets locale field. + * + * @param string|null $value */ public function locale(?string $value): self { @@ -58,6 +62,8 @@ class VaultExperienceContextBuilder /** * Sets return url field. + * + * @param string|null $value */ public function returnUrl(?string $value): self { @@ -67,6 +73,8 @@ class VaultExperienceContextBuilder /** * Sets cancel url field. + * + * @param string|null $value */ public function cancelUrl(?string $value): self { @@ -76,6 +84,8 @@ class VaultExperienceContextBuilder /** * Sets shipping preference field. + * + * @param string|null $value */ public function shippingPreference(?string $value): self { @@ -85,6 +95,8 @@ class VaultExperienceContextBuilder /** * Sets vault instruction field. + * + * @param string|null $value */ public function vaultInstruction(?string $value): self { @@ -93,7 +105,7 @@ class VaultExperienceContextBuilder } /** - * Initializes a new vault experience context object. + * Initializes a new Vault Experience Context object. */ public function build(): VaultExperienceContext { diff --git a/src/Models/Builders/VaultInstructionBaseBuilder.php b/src/Models/Builders/VaultInstructionBaseBuilder.php index 671fed3..21a83cb 100644 --- a/src/Models/Builders/VaultInstructionBaseBuilder.php +++ b/src/Models/Builders/VaultInstructionBaseBuilder.php @@ -31,7 +31,7 @@ class VaultInstructionBaseBuilder } /** - * Initializes a new vault instruction base Builder object. + * Initializes a new Vault Instruction Base Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class VaultInstructionBaseBuilder /** * Sets store in vault field. + * + * @param string|null $value */ public function storeInVault(?string $value): self { @@ -48,7 +50,7 @@ class VaultInstructionBaseBuilder } /** - * Initializes a new vault instruction base object. + * Initializes a new Vault Instruction Base object. */ public function build(): VaultInstructionBase { diff --git a/src/Models/Builders/VaultInstructionBuilder.php b/src/Models/Builders/VaultInstructionBuilder.php index 4655371..49ca959 100644 --- a/src/Models/Builders/VaultInstructionBuilder.php +++ b/src/Models/Builders/VaultInstructionBuilder.php @@ -31,7 +31,9 @@ class VaultInstructionBuilder } /** - * Initializes a new vault instruction Builder object. + * Initializes a new Vault Instruction Builder object. + * + * @param string $storeInVault */ public static function init(string $storeInVault): self { @@ -39,7 +41,7 @@ class VaultInstructionBuilder } /** - * Initializes a new vault instruction object. + * Initializes a new Vault Instruction object. */ public function build(): VaultInstruction { diff --git a/src/Models/Builders/VaultPaypalWalletRequestBuilder.php b/src/Models/Builders/VaultPaypalWalletRequestBuilder.php index 4b5c9d9..41c963f 100644 --- a/src/Models/Builders/VaultPaypalWalletRequestBuilder.php +++ b/src/Models/Builders/VaultPaypalWalletRequestBuilder.php @@ -11,6 +11,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; +use PaypalServerSdkLib\Models\Plan; use PaypalServerSdkLib\Models\VaultedDigitalWalletShippingDetails; use PaypalServerSdkLib\Models\VaultExperienceContext; use PaypalServerSdkLib\Models\VaultPaypalWalletRequest; @@ -33,7 +34,7 @@ class VaultPaypalWalletRequestBuilder } /** - * Initializes a new vault paypal wallet request Builder object. + * Initializes a new Vault Paypal Wallet Request Builder object. */ public static function init(): self { @@ -42,6 +43,8 @@ class VaultPaypalWalletRequestBuilder /** * Sets description field. + * + * @param string|null $value */ public function description(?string $value): self { @@ -49,8 +52,21 @@ class VaultPaypalWalletRequestBuilder return $this; } + /** + * Sets usage pattern field. + * + * @param string|null $value + */ + public function usagePattern(?string $value): self + { + $this->instance->setUsagePattern($value); + return $this; + } + /** * Sets shipping field. + * + * @param VaultedDigitalWalletShippingDetails|null $value */ public function shipping(?VaultedDigitalWalletShippingDetails $value): self { @@ -60,6 +76,8 @@ class VaultPaypalWalletRequestBuilder /** * Sets permit multiple payment tokens field. + * + * @param bool|null $value */ public function permitMultiplePaymentTokens(?bool $value): self { @@ -69,6 +87,8 @@ class VaultPaypalWalletRequestBuilder /** * Sets usage type field. + * + * @param string|null $value */ public function usageType(?string $value): self { @@ -78,6 +98,8 @@ class VaultPaypalWalletRequestBuilder /** * Sets customer type field. + * + * @param string|null $value */ public function customerType(?string $value): self { @@ -85,8 +107,21 @@ class VaultPaypalWalletRequestBuilder return $this; } + /** + * Sets billing plan field. + * + * @param Plan|null $value + */ + public function billingPlan(?Plan $value): self + { + $this->instance->setBillingPlan($value); + return $this; + } + /** * Sets experience context field. + * + * @param VaultExperienceContext|null $value */ public function experienceContext(?VaultExperienceContext $value): self { @@ -95,7 +130,7 @@ class VaultPaypalWalletRequestBuilder } /** - * Initializes a new vault paypal wallet request object. + * Initializes a new Vault Paypal Wallet Request object. */ public function build(): VaultPaypalWalletRequest { diff --git a/src/Models/Builders/VaultResponseBuilder.php b/src/Models/Builders/VaultResponseBuilder.php index a9ce2a6..6102b3a 100644 --- a/src/Models/Builders/VaultResponseBuilder.php +++ b/src/Models/Builders/VaultResponseBuilder.php @@ -11,6 +11,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; +use PaypalServerSdkLib\Models\LinkDescription; use PaypalServerSdkLib\Models\VaultCustomer; use PaypalServerSdkLib\Models\VaultResponse; @@ -32,7 +33,7 @@ class VaultResponseBuilder } /** - * Initializes a new vault response Builder object. + * Initializes a new Vault Response Builder object. */ public static function init(): self { @@ -41,6 +42,8 @@ class VaultResponseBuilder /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -50,6 +53,8 @@ class VaultResponseBuilder /** * Sets status field. + * + * @param string|null $value */ public function status(?string $value): self { @@ -59,6 +64,8 @@ class VaultResponseBuilder /** * Sets customer field. + * + * @param VaultCustomer|null $value */ public function customer(?VaultCustomer $value): self { @@ -68,6 +75,8 @@ class VaultResponseBuilder /** * Sets links field. + * + * @param LinkDescription[]|null $value */ public function links(?array $value): self { @@ -76,7 +85,7 @@ class VaultResponseBuilder } /** - * Initializes a new vault response object. + * Initializes a new Vault Response object. */ public function build(): VaultResponse { diff --git a/src/Models/Builders/VaultResponseCustomerBuilder.php b/src/Models/Builders/VaultResponseCustomerBuilder.php new file mode 100644 index 0000000..1c5b5f5 --- /dev/null +++ b/src/Models/Builders/VaultResponseCustomerBuilder.php @@ -0,0 +1,81 @@ +instance = $instance; + } + + /** + * Initializes a new Vault Response Customer Builder object. + */ + public static function init(): self + { + return new self(new VaultResponseCustomer()); + } + + /** + * Sets id field. + * + * @param string|null $value + */ + public function id(?string $value): self + { + $this->instance->setId($value); + return $this; + } + + /** + * Sets merchant customer id field. + * + * @param string|null $value + */ + public function merchantCustomerId(?string $value): self + { + $this->instance->setMerchantCustomerId($value); + return $this; + } + + /** + * Sets links field. + * + * @param array $value + */ + public function links(array $value): self + { + $this->instance->setLinks($value); + return $this; + } + + /** + * Initializes a new Vault Response Customer object. + */ + public function build(): VaultResponseCustomer + { + return CoreHelper::clone($this->instance); + } +} diff --git a/src/Models/Builders/VaultTokenRequestBuilder.php b/src/Models/Builders/VaultTokenRequestBuilder.php index 8d5e544..f1633f4 100644 --- a/src/Models/Builders/VaultTokenRequestBuilder.php +++ b/src/Models/Builders/VaultTokenRequestBuilder.php @@ -31,7 +31,10 @@ class VaultTokenRequestBuilder } /** - * Initializes a new vault token request Builder object. + * Initializes a new Vault Token Request Builder object. + * + * @param string $id + * @param string $type */ public static function init(string $id, string $type): self { @@ -39,7 +42,7 @@ class VaultTokenRequestBuilder } /** - * Initializes a new vault token request object. + * Initializes a new Vault Token Request object. */ public function build(): VaultTokenRequest { diff --git a/src/Models/Builders/VaultVenmoExperienceContextBuilder.php b/src/Models/Builders/VaultVenmoExperienceContextBuilder.php index 1fa2598..b29fb5f 100644 --- a/src/Models/Builders/VaultVenmoExperienceContextBuilder.php +++ b/src/Models/Builders/VaultVenmoExperienceContextBuilder.php @@ -31,7 +31,7 @@ class VaultVenmoExperienceContextBuilder } /** - * Initializes a new vault venmo experience context Builder object. + * Initializes a new Vault Venmo Experience Context Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class VaultVenmoExperienceContextBuilder /** * Sets brand name field. + * + * @param string|null $value */ public function brandName(?string $value): self { @@ -49,6 +51,8 @@ class VaultVenmoExperienceContextBuilder /** * Sets shipping preference field. + * + * @param string|null $value */ public function shippingPreference(?string $value): self { @@ -58,6 +62,8 @@ class VaultVenmoExperienceContextBuilder /** * Sets vault instruction field. + * + * @param string|null $value */ public function vaultInstruction(?string $value): self { @@ -66,7 +72,7 @@ class VaultVenmoExperienceContextBuilder } /** - * Initializes a new vault venmo experience context object. + * Initializes a new Vault Venmo Experience Context object. */ public function build(): VaultVenmoExperienceContext { diff --git a/src/Models/Builders/VaultVenmoRequestBuilder.php b/src/Models/Builders/VaultVenmoRequestBuilder.php index 4495c78..1301cdc 100644 --- a/src/Models/Builders/VaultVenmoRequestBuilder.php +++ b/src/Models/Builders/VaultVenmoRequestBuilder.php @@ -33,7 +33,7 @@ class VaultVenmoRequestBuilder } /** - * Initializes a new vault venmo request Builder object. + * Initializes a new Vault Venmo Request Builder object. */ public static function init(): self { @@ -42,6 +42,8 @@ class VaultVenmoRequestBuilder /** * Sets description field. + * + * @param string|null $value */ public function description(?string $value): self { @@ -49,8 +51,21 @@ class VaultVenmoRequestBuilder return $this; } + /** + * Sets usage pattern field. + * + * @param string|null $value + */ + public function usagePattern(?string $value): self + { + $this->instance->setUsagePattern($value); + return $this; + } + /** * Sets shipping field. + * + * @param VaultedDigitalWalletShippingDetails|null $value */ public function shipping(?VaultedDigitalWalletShippingDetails $value): self { @@ -60,6 +75,8 @@ class VaultVenmoRequestBuilder /** * Sets permit multiple payment tokens field. + * + * @param bool|null $value */ public function permitMultiplePaymentTokens(?bool $value): self { @@ -69,6 +86,8 @@ class VaultVenmoRequestBuilder /** * Sets usage type field. + * + * @param string|null $value */ public function usageType(?string $value): self { @@ -78,6 +97,8 @@ class VaultVenmoRequestBuilder /** * Sets customer type field. + * + * @param string|null $value */ public function customerType(?string $value): self { @@ -87,6 +108,8 @@ class VaultVenmoRequestBuilder /** * Sets experience context field. + * + * @param VaultVenmoExperienceContext|null $value */ public function experienceContext(?VaultVenmoExperienceContext $value): self { @@ -95,7 +118,7 @@ class VaultVenmoRequestBuilder } /** - * Initializes a new vault venmo request object. + * Initializes a new Vault Venmo Request object. */ public function build(): VaultVenmoRequest { diff --git a/src/Models/Builders/VaultedDigitalWalletBuilder.php b/src/Models/Builders/VaultedDigitalWalletBuilder.php index 1e3c6f9..958a148 100644 --- a/src/Models/Builders/VaultedDigitalWalletBuilder.php +++ b/src/Models/Builders/VaultedDigitalWalletBuilder.php @@ -32,7 +32,7 @@ class VaultedDigitalWalletBuilder } /** - * Initializes a new vaulted digital wallet Builder object. + * Initializes a new Vaulted Digital Wallet Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class VaultedDigitalWalletBuilder /** * Sets description field. + * + * @param string|null $value */ public function description(?string $value): self { @@ -48,8 +50,21 @@ class VaultedDigitalWalletBuilder return $this; } + /** + * Sets usage pattern field. + * + * @param string|null $value + */ + public function usagePattern(?string $value): self + { + $this->instance->setUsagePattern($value); + return $this; + } + /** * Sets shipping field. + * + * @param VaultedDigitalWalletShippingDetails|null $value */ public function shipping(?VaultedDigitalWalletShippingDetails $value): self { @@ -59,6 +74,8 @@ class VaultedDigitalWalletBuilder /** * Sets permit multiple payment tokens field. + * + * @param bool|null $value */ public function permitMultiplePaymentTokens(?bool $value): self { @@ -68,6 +85,8 @@ class VaultedDigitalWalletBuilder /** * Sets usage type field. + * + * @param string|null $value */ public function usageType(?string $value): self { @@ -77,6 +96,8 @@ class VaultedDigitalWalletBuilder /** * Sets customer type field. + * + * @param string|null $value */ public function customerType(?string $value): self { @@ -85,7 +106,7 @@ class VaultedDigitalWalletBuilder } /** - * Initializes a new vaulted digital wallet object. + * Initializes a new Vaulted Digital Wallet object. */ public function build(): VaultedDigitalWallet { diff --git a/src/Models/Builders/VaultedDigitalWalletShippingDetailsBuilder.php b/src/Models/Builders/VaultedDigitalWalletShippingDetailsBuilder.php index cbfccf7..a77a2a3 100644 --- a/src/Models/Builders/VaultedDigitalWalletShippingDetailsBuilder.php +++ b/src/Models/Builders/VaultedDigitalWalletShippingDetailsBuilder.php @@ -12,6 +12,7 @@ namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; use PaypalServerSdkLib\Models\Address; +use PaypalServerSdkLib\Models\PhoneNumberWithCountryCode; use PaypalServerSdkLib\Models\ShippingName; use PaypalServerSdkLib\Models\VaultedDigitalWalletShippingDetails; @@ -33,7 +34,7 @@ class VaultedDigitalWalletShippingDetailsBuilder } /** - * Initializes a new vaulted digital wallet shipping details Builder object. + * Initializes a new Vaulted Digital Wallet Shipping Details Builder object. */ public static function init(): self { @@ -42,6 +43,8 @@ class VaultedDigitalWalletShippingDetailsBuilder /** * Sets name field. + * + * @param ShippingName|null $value */ public function name(?ShippingName $value): self { @@ -49,8 +52,21 @@ class VaultedDigitalWalletShippingDetailsBuilder return $this; } + /** + * Sets phone number field. + * + * @param PhoneNumberWithCountryCode|null $value + */ + public function phoneNumber(?PhoneNumberWithCountryCode $value): self + { + $this->instance->setPhoneNumber($value); + return $this; + } + /** * Sets type field. + * + * @param string|null $value */ public function type(?string $value): self { @@ -60,6 +76,8 @@ class VaultedDigitalWalletShippingDetailsBuilder /** * Sets address field. + * + * @param Address|null $value */ public function address(?Address $value): self { @@ -68,7 +86,7 @@ class VaultedDigitalWalletShippingDetailsBuilder } /** - * Initializes a new vaulted digital wallet shipping details object. + * Initializes a new Vaulted Digital Wallet Shipping Details object. */ public function build(): VaultedDigitalWalletShippingDetails { diff --git a/src/Models/Builders/VenmoPaymentTokenBuilder.php b/src/Models/Builders/VenmoPaymentTokenBuilder.php index 6074b1a..364ac91 100644 --- a/src/Models/Builders/VenmoPaymentTokenBuilder.php +++ b/src/Models/Builders/VenmoPaymentTokenBuilder.php @@ -35,7 +35,7 @@ class VenmoPaymentTokenBuilder } /** - * Initializes a new venmo payment token Builder object. + * Initializes a new Venmo Payment Token Builder object. */ public static function init(): self { @@ -44,6 +44,8 @@ class VenmoPaymentTokenBuilder /** * Sets description field. + * + * @param string|null $value */ public function description(?string $value): self { @@ -51,8 +53,21 @@ class VenmoPaymentTokenBuilder return $this; } + /** + * Sets usage pattern field. + * + * @param string|null $value + */ + public function usagePattern(?string $value): self + { + $this->instance->setUsagePattern($value); + return $this; + } + /** * Sets shipping field. + * + * @param VaultedDigitalWalletShippingDetails|null $value */ public function shipping(?VaultedDigitalWalletShippingDetails $value): self { @@ -62,6 +77,8 @@ class VenmoPaymentTokenBuilder /** * Sets permit multiple payment tokens field. + * + * @param bool|null $value */ public function permitMultiplePaymentTokens(?bool $value): self { @@ -71,6 +88,8 @@ class VenmoPaymentTokenBuilder /** * Sets usage type field. + * + * @param string|null $value */ public function usageType(?string $value): self { @@ -80,6 +99,8 @@ class VenmoPaymentTokenBuilder /** * Sets customer type field. + * + * @param string|null $value */ public function customerType(?string $value): self { @@ -89,6 +110,8 @@ class VenmoPaymentTokenBuilder /** * Sets email address field. + * + * @param string|null $value */ public function emailAddress(?string $value): self { @@ -98,6 +121,8 @@ class VenmoPaymentTokenBuilder /** * Sets payer id field. + * + * @param string|null $value */ public function payerId(?string $value): self { @@ -107,6 +132,8 @@ class VenmoPaymentTokenBuilder /** * Sets name field. + * + * @param Name|null $value */ public function name(?Name $value): self { @@ -116,6 +143,8 @@ class VenmoPaymentTokenBuilder /** * Sets phone field. + * + * @param PhoneWithType|null $value */ public function phone(?PhoneWithType $value): self { @@ -125,6 +154,8 @@ class VenmoPaymentTokenBuilder /** * Sets address field. + * + * @param Address|null $value */ public function address(?Address $value): self { @@ -134,6 +165,8 @@ class VenmoPaymentTokenBuilder /** * Sets user name field. + * + * @param string|null $value */ public function userName(?string $value): self { @@ -142,7 +175,7 @@ class VenmoPaymentTokenBuilder } /** - * Initializes a new venmo payment token object. + * Initializes a new Venmo Payment Token object. */ public function build(): VenmoPaymentToken { diff --git a/src/Models/Builders/VenmoWalletAdditionalAttributesBuilder.php b/src/Models/Builders/VenmoWalletAdditionalAttributesBuilder.php index 30026f7..5f00bf9 100644 --- a/src/Models/Builders/VenmoWalletAdditionalAttributesBuilder.php +++ b/src/Models/Builders/VenmoWalletAdditionalAttributesBuilder.php @@ -33,7 +33,7 @@ class VenmoWalletAdditionalAttributesBuilder } /** - * Initializes a new venmo wallet additional attributes Builder object. + * Initializes a new Venmo Wallet Additional Attributes Builder object. */ public static function init(): self { @@ -42,6 +42,8 @@ class VenmoWalletAdditionalAttributesBuilder /** * Sets customer field. + * + * @param VenmoWalletCustomerInformation|null $value */ public function customer(?VenmoWalletCustomerInformation $value): self { @@ -51,6 +53,8 @@ class VenmoWalletAdditionalAttributesBuilder /** * Sets vault field. + * + * @param VenmoWalletVaultAttributes|null $value */ public function vault(?VenmoWalletVaultAttributes $value): self { @@ -59,7 +63,7 @@ class VenmoWalletAdditionalAttributesBuilder } /** - * Initializes a new venmo wallet additional attributes object. + * Initializes a new Venmo Wallet Additional Attributes object. */ public function build(): VenmoWalletAdditionalAttributes { diff --git a/src/Models/Builders/VenmoWalletAttributesResponseBuilder.php b/src/Models/Builders/VenmoWalletAttributesResponseBuilder.php index c2936fc..d97b177 100644 --- a/src/Models/Builders/VenmoWalletAttributesResponseBuilder.php +++ b/src/Models/Builders/VenmoWalletAttributesResponseBuilder.php @@ -32,7 +32,7 @@ class VenmoWalletAttributesResponseBuilder } /** - * Initializes a new venmo wallet attributes response Builder object. + * Initializes a new Venmo Wallet Attributes Response Builder object. */ public static function init(): self { @@ -41,6 +41,8 @@ class VenmoWalletAttributesResponseBuilder /** * Sets vault field. + * + * @param VaultResponse|null $value */ public function vault(?VaultResponse $value): self { @@ -49,7 +51,7 @@ class VenmoWalletAttributesResponseBuilder } /** - * Initializes a new venmo wallet attributes response object. + * Initializes a new Venmo Wallet Attributes Response object. */ public function build(): VenmoWalletAttributesResponse { diff --git a/src/Models/Builders/VenmoWalletCustomerInformationBuilder.php b/src/Models/Builders/VenmoWalletCustomerInformationBuilder.php index c12a4c9..186cefb 100644 --- a/src/Models/Builders/VenmoWalletCustomerInformationBuilder.php +++ b/src/Models/Builders/VenmoWalletCustomerInformationBuilder.php @@ -31,7 +31,7 @@ class VenmoWalletCustomerInformationBuilder } /** - * Initializes a new venmo wallet customer information Builder object. + * Initializes a new Venmo Wallet Customer Information Builder object. */ public static function init(): self { @@ -40,6 +40,8 @@ class VenmoWalletCustomerInformationBuilder /** * Sets id field. + * + * @param string|null $value */ public function id(?string $value): self { @@ -49,6 +51,8 @@ class VenmoWalletCustomerInformationBuilder /** * Sets email address field. + * + * @param string|null $value */ public function emailAddress(?string $value): self { @@ -57,7 +61,7 @@ class VenmoWalletCustomerInformationBuilder } /** - * Initializes a new venmo wallet customer information object. + * Initializes a new Venmo Wallet Customer Information object. */ public function build(): VenmoWalletCustomerInformation { diff --git a/src/Models/Builders/VenmoWalletExperienceContextBuilder.php b/src/Models/Builders/VenmoWalletExperienceContextBuilder.php index 684fe67..bd625f5 100644 --- a/src/Models/Builders/VenmoWalletExperienceContextBuilder.php +++ b/src/Models/Builders/VenmoWalletExperienceContextBuilder.php @@ -11,6 +11,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; +use PaypalServerSdkLib\Models\CallbackConfiguration; use PaypalServerSdkLib\Models\VenmoWalletExperienceContext; /** @@ -31,7 +32,7 @@ class VenmoWalletExperienceContextBuilder } /** - * Initializes a new venmo wallet experience context Builder object. + * Initializes a new Venmo Wallet Experience Context Builder object. */ public static function init(): self { @@ -40,6 +41,8 @@ class VenmoWalletExperienceContextBuilder /** * Sets brand name field. + * + * @param string|null $value */ public function brandName(?string $value): self { @@ -49,6 +52,8 @@ class VenmoWalletExperienceContextBuilder /** * Sets shipping preference field. + * + * @param string|null $value */ public function shippingPreference(?string $value): self { @@ -57,7 +62,18 @@ class VenmoWalletExperienceContextBuilder } /** - * Initializes a new venmo wallet experience context object. + * Sets order update callback config field. + * + * @param CallbackConfiguration|null $value + */ + public function orderUpdateCallbackConfig(?CallbackConfiguration $value): self + { + $this->instance->setOrderUpdateCallbackConfig($value); + return $this; + } + + /** + * Initializes a new Venmo Wallet Experience Context object. */ public function build(): VenmoWalletExperienceContext { diff --git a/src/Models/Builders/VenmoWalletRequestBuilder.php b/src/Models/Builders/VenmoWalletRequestBuilder.php index ae314e1..e1554b0 100644 --- a/src/Models/Builders/VenmoWalletRequestBuilder.php +++ b/src/Models/Builders/VenmoWalletRequestBuilder.php @@ -33,7 +33,7 @@ class VenmoWalletRequestBuilder } /** - * Initializes a new venmo wallet request Builder object. + * Initializes a new Venmo Wallet Request Builder object. */ public static function init(): self { @@ -42,6 +42,8 @@ class VenmoWalletRequestBuilder /** * Sets vault id field. + * + * @param string|null $value */ public function vaultId(?string $value): self { @@ -51,6 +53,8 @@ class VenmoWalletRequestBuilder /** * Sets email address field. + * + * @param string|null $value */ public function emailAddress(?string $value): self { @@ -60,6 +64,8 @@ class VenmoWalletRequestBuilder /** * Sets experience context field. + * + * @param VenmoWalletExperienceContext|null $value */ public function experienceContext(?VenmoWalletExperienceContext $value): self { @@ -69,6 +75,8 @@ class VenmoWalletRequestBuilder /** * Sets attributes field. + * + * @param VenmoWalletAdditionalAttributes|null $value */ public function attributes(?VenmoWalletAdditionalAttributes $value): self { @@ -77,7 +85,7 @@ class VenmoWalletRequestBuilder } /** - * Initializes a new venmo wallet request object. + * Initializes a new Venmo Wallet Request object. */ public function build(): VenmoWalletRequest { diff --git a/src/Models/Builders/VenmoWalletResponseBuilder.php b/src/Models/Builders/VenmoWalletResponseBuilder.php index 6735fa1..8143fb8 100644 --- a/src/Models/Builders/VenmoWalletResponseBuilder.php +++ b/src/Models/Builders/VenmoWalletResponseBuilder.php @@ -35,7 +35,7 @@ class VenmoWalletResponseBuilder } /** - * Initializes a new venmo wallet response Builder object. + * Initializes a new Venmo Wallet Response Builder object. */ public static function init(): self { @@ -44,6 +44,8 @@ class VenmoWalletResponseBuilder /** * Sets email address field. + * + * @param string|null $value */ public function emailAddress(?string $value): self { @@ -53,6 +55,8 @@ class VenmoWalletResponseBuilder /** * Sets account id field. + * + * @param string|null $value */ public function accountId(?string $value): self { @@ -62,6 +66,8 @@ class VenmoWalletResponseBuilder /** * Sets user name field. + * + * @param string|null $value */ public function userName(?string $value): self { @@ -71,6 +77,8 @@ class VenmoWalletResponseBuilder /** * Sets name field. + * + * @param Name|null $value */ public function name(?Name $value): self { @@ -80,6 +88,8 @@ class VenmoWalletResponseBuilder /** * Sets phone number field. + * + * @param PhoneNumber|null $value */ public function phoneNumber(?PhoneNumber $value): self { @@ -89,6 +99,8 @@ class VenmoWalletResponseBuilder /** * Sets address field. + * + * @param Address|null $value */ public function address(?Address $value): self { @@ -98,6 +110,8 @@ class VenmoWalletResponseBuilder /** * Sets attributes field. + * + * @param VenmoWalletAttributesResponse|null $value */ public function attributes(?VenmoWalletAttributesResponse $value): self { @@ -106,7 +120,7 @@ class VenmoWalletResponseBuilder } /** - * Initializes a new venmo wallet response object. + * Initializes a new Venmo Wallet Response object. */ public function build(): VenmoWalletResponse { diff --git a/src/Models/Builders/VenmoWalletVaultAttributesBuilder.php b/src/Models/Builders/VenmoWalletVaultAttributesBuilder.php index 1c11b88..2423079 100644 --- a/src/Models/Builders/VenmoWalletVaultAttributesBuilder.php +++ b/src/Models/Builders/VenmoWalletVaultAttributesBuilder.php @@ -31,7 +31,10 @@ class VenmoWalletVaultAttributesBuilder } /** - * Initializes a new venmo wallet vault attributes Builder object. + * Initializes a new Venmo Wallet Vault Attributes Builder object. + * + * @param string $storeInVault + * @param string $usageType */ public static function init(string $storeInVault, string $usageType): self { @@ -40,6 +43,8 @@ class VenmoWalletVaultAttributesBuilder /** * Sets description field. + * + * @param string|null $value */ public function description(?string $value): self { @@ -49,6 +54,8 @@ class VenmoWalletVaultAttributesBuilder /** * Sets usage pattern field. + * + * @param string|null $value */ public function usagePattern(?string $value): self { @@ -58,6 +65,8 @@ class VenmoWalletVaultAttributesBuilder /** * Sets customer type field. + * + * @param string|null $value */ public function customerType(?string $value): self { @@ -67,6 +76,8 @@ class VenmoWalletVaultAttributesBuilder /** * Sets permit multiple payment tokens field. + * + * @param bool|null $value */ public function permitMultiplePaymentTokens(?bool $value): self { @@ -75,7 +86,7 @@ class VenmoWalletVaultAttributesBuilder } /** - * Initializes a new venmo wallet vault attributes object. + * Initializes a new Venmo Wallet Vault Attributes object. */ public function build(): VenmoWalletVaultAttributes { diff --git a/src/Models/CallbackConfiguration.php b/src/Models/CallbackConfiguration.php new file mode 100644 index 0000000..049538c --- /dev/null +++ b/src/Models/CallbackConfiguration.php @@ -0,0 +1,123 @@ +callbackEvents = $callbackEvents; + $this->callbackUrl = $callbackUrl; + } + + /** + * Returns Callback Events. + * An array of callback events merchant can subscribe to for the corresponding callback url. The + * SHIPPING_ADDRESS callback event is required. + * + * @return string[] + */ + public function getCallbackEvents(): array + { + return $this->callbackEvents; + } + + /** + * Sets Callback Events. + * An array of callback events merchant can subscribe to for the corresponding callback url. The + * SHIPPING_ADDRESS callback event is required. + * + * @required + * @maps callback_events + * + * @param string[] $callbackEvents + */ + public function setCallbackEvents(array $callbackEvents): void + { + $this->callbackEvents = $callbackEvents; + } + + /** + * Returns Callback Url. + * Merchant provided CallBack url.PayPal/Venmo will use this url to call the merchant back when the + * events occur .PayPal/Venmo expects a secured url usually in the https format.merchant can append the + * cart id or other params part of the url as query or path params. + */ + public function getCallbackUrl(): string + { + return $this->callbackUrl; + } + + /** + * Sets Callback Url. + * Merchant provided CallBack url.PayPal/Venmo will use this url to call the merchant back when the + * events occur .PayPal/Venmo expects a secured url usually in the https format.merchant can append the + * cart id or other params part of the url as query or path params. + * + * @required + * @maps callback_url + */ + public function setCallbackUrl(string $callbackUrl): void + { + $this->callbackUrl = $callbackUrl; + } + + /** + * Converts the CallbackConfiguration object to a human-readable string representation. + * + * @return string The string representation of the CallbackConfiguration object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'CallbackConfiguration', + ['callbackEvents' => $this->callbackEvents, 'callbackUrl' => $this->callbackUrl] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + $json['callback_events'] = $this->callbackEvents; + $json['callback_url'] = $this->callbackUrl; + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/CallbackEvents.php b/src/Models/CallbackEvents.php new file mode 100644 index 0000000..e4c9032 --- /dev/null +++ b/src/Models/CallbackEvents.php @@ -0,0 +1,29 @@ +payeeReceivableFxRateId = $payeeReceivableFxRateId; } + /** + * Converts the CapturePaymentInstruction object to a human-readable string representation. + * + * @return string The string representation of the CapturePaymentInstruction object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'CapturePaymentInstruction', + [ + 'platformFees' => $this->platformFees, + 'disbursementMode' => $this->disbursementMode, + 'payeeReceivableFxRateId' => $this->payeeReceivableFxRateId + ] + ); + } + /** * Encode this object to JSON * @@ -117,7 +135,7 @@ class CapturePaymentInstruction implements \JsonSerializable $json['platform_fees'] = $this->platformFees; } if (isset($this->disbursementMode)) { - $json['disbursement_mode'] = DisbursementMode::checkValue($this->disbursementMode); + $json['disbursement_mode'] = $this->disbursementMode; } if (isset($this->payeeReceivableFxRateId)) { $json['payee_receivable_fx_rate_id'] = $this->payeeReceivableFxRateId; diff --git a/src/Models/CaptureRequest.php b/src/Models/CaptureRequest.php index 2a9acba..63846b3 100644 --- a/src/Models/CaptureRequest.php +++ b/src/Models/CaptureRequest.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; class CaptureRequest implements \JsonSerializable @@ -174,6 +175,26 @@ class CaptureRequest implements \JsonSerializable $this->softDescriptor = $softDescriptor; } + /** + * Converts the CaptureRequest object to a human-readable string representation. + * + * @return string The string representation of the CaptureRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'CaptureRequest', + [ + 'invoiceId' => $this->invoiceId, + 'noteToPayer' => $this->noteToPayer, + 'amount' => $this->amount, + 'finalCapture' => $this->finalCapture, + 'paymentInstruction' => $this->paymentInstruction, + 'softDescriptor' => $this->softDescriptor + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/CaptureStatus.php b/src/Models/CaptureStatus.php index 8dc8b4d..8f7ae61 100644 --- a/src/Models/CaptureStatus.php +++ b/src/Models/CaptureStatus.php @@ -10,45 +10,39 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The status of the captured payment. */ class CaptureStatus { + /** + * The funds for this captured payment were credited to the payee's PayPal account. + */ public const COMPLETED = 'COMPLETED'; + /** + * The funds could not be captured. + */ public const DECLINED = 'DECLINED'; + /** + * An amount less than this captured payment's amount was partially refunded to the payer. + */ public const PARTIALLY_REFUNDED = 'PARTIALLY_REFUNDED'; + /** + * The funds for this captured payment was not yet credited to the payee's PayPal account. For more + * information, see status.details. + */ public const PENDING = 'PENDING'; + /** + * An amount greater than or equal to this captured payment's amount was refunded to the payer. + */ public const REFUNDED = 'REFUNDED'; - public const FAILED = 'FAILED'; - - private const _ALL_VALUES = - [self::COMPLETED, self::DECLINED, self::PARTIALLY_REFUNDED, self::PENDING, self::REFUNDED, self::FAILED]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * There was an error while capturing payment. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for CaptureStatus."); - } + public const FAILED = 'FAILED'; } diff --git a/src/Models/CaptureStatusDetails.php b/src/Models/CaptureStatusDetails.php index e1b17cc..8754f50 100644 --- a/src/Models/CaptureStatusDetails.php +++ b/src/Models/CaptureStatusDetails.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -42,6 +43,16 @@ class CaptureStatusDetails implements \JsonSerializable $this->reason = $reason; } + /** + * Converts the CaptureStatusDetails object to a human-readable string representation. + * + * @return string The string representation of the CaptureStatusDetails object. + */ + public function __toString(): string + { + return ApiHelper::stringify('CaptureStatusDetails', ['reason' => $this->reason]); + } + /** * Encode this object to JSON * @@ -55,7 +66,7 @@ class CaptureStatusDetails implements \JsonSerializable { $json = []; if (isset($this->reason)) { - $json['reason'] = CaptureIncompleteReason::checkValue($this->reason); + $json['reason'] = $this->reason; } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; diff --git a/src/Models/CaptureStatusWithDetails.php b/src/Models/CaptureStatusWithDetails.php index b2b340a..4d3e3a8 100644 --- a/src/Models/CaptureStatusWithDetails.php +++ b/src/Models/CaptureStatusWithDetails.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -67,6 +68,19 @@ class CaptureStatusWithDetails implements \JsonSerializable $this->statusDetails = $statusDetails; } + /** + * Converts the CaptureStatusWithDetails object to a human-readable string representation. + * + * @return string The string representation of the CaptureStatusWithDetails object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'CaptureStatusWithDetails', + ['status' => $this->status, 'statusDetails' => $this->statusDetails] + ); + } + /** * Encode this object to JSON * @@ -80,7 +94,7 @@ class CaptureStatusWithDetails implements \JsonSerializable { $json = []; if (isset($this->status)) { - $json['status'] = CaptureStatus::checkValue($this->status); + $json['status'] = $this->status; } if (isset($this->statusDetails)) { $json['status_details'] = $this->statusDetails; diff --git a/src/Models/CapturedPayment.php b/src/Models/CapturedPayment.php index 6b6abbc..59233fc 100644 --- a/src/Models/CapturedPayment.php +++ b/src/Models/CapturedPayment.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -78,7 +79,7 @@ class CapturedPayment implements \JsonSerializable private $links; /** - * @var ProcessorResponse|null + * @var PaymentsProcessorResponse|null */ private $processorResponse; @@ -98,7 +99,7 @@ class CapturedPayment implements \JsonSerializable private $supplementaryData; /** - * @var Payee|null + * @var PayeeBase|null */ private $payee; @@ -362,7 +363,7 @@ class CapturedPayment implements \JsonSerializable * Returns Processor Response. * The processor response information for payment requests, such as direct credit card transactions. */ - public function getProcessorResponse(): ?ProcessorResponse + public function getProcessorResponse(): ?PaymentsProcessorResponse { return $this->processorResponse; } @@ -373,7 +374,7 @@ class CapturedPayment implements \JsonSerializable * * @maps processor_response */ - public function setProcessorResponse(?ProcessorResponse $processorResponse): void + public function setProcessorResponse(?PaymentsProcessorResponse $processorResponse): void { $this->processorResponse = $processorResponse; } @@ -381,8 +382,8 @@ class CapturedPayment implements \JsonSerializable /** * Returns Create Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getCreateTime(): ?string { @@ -392,8 +393,8 @@ class CapturedPayment implements \JsonSerializable /** * Sets Create Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps create_time */ @@ -405,8 +406,8 @@ class CapturedPayment implements \JsonSerializable /** * Returns Update Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getUpdateTime(): ?string { @@ -416,8 +417,8 @@ class CapturedPayment implements \JsonSerializable /** * Sets Update Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps update_time */ @@ -451,7 +452,7 @@ class CapturedPayment implements \JsonSerializable * The details for the merchant who receives the funds and fulfills the order. The merchant is also * known as the payee. */ - public function getPayee(): ?Payee + public function getPayee(): ?PayeeBase { return $this->payee; } @@ -463,11 +464,42 @@ class CapturedPayment implements \JsonSerializable * * @maps payee */ - public function setPayee(?Payee $payee): void + public function setPayee(?PayeeBase $payee): void { $this->payee = $payee; } + /** + * Converts the CapturedPayment object to a human-readable string representation. + * + * @return string The string representation of the CapturedPayment object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'CapturedPayment', + [ + 'status' => $this->status, + 'statusDetails' => $this->statusDetails, + 'id' => $this->id, + 'amount' => $this->amount, + 'invoiceId' => $this->invoiceId, + 'customId' => $this->customId, + 'networkTransactionReference' => $this->networkTransactionReference, + 'sellerProtection' => $this->sellerProtection, + 'finalCapture' => $this->finalCapture, + 'sellerReceivableBreakdown' => $this->sellerReceivableBreakdown, + 'disbursementMode' => $this->disbursementMode, + 'links' => $this->links, + 'processorResponse' => $this->processorResponse, + 'createTime' => $this->createTime, + 'updateTime' => $this->updateTime, + 'supplementaryData' => $this->supplementaryData, + 'payee' => $this->payee + ] + ); + } + /** * Encode this object to JSON * @@ -481,7 +513,7 @@ class CapturedPayment implements \JsonSerializable { $json = []; if (isset($this->status)) { - $json['status'] = CaptureStatus::checkValue($this->status); + $json['status'] = $this->status; } if (isset($this->statusDetails)) { $json['status_details'] = $this->statusDetails; @@ -511,7 +543,7 @@ class CapturedPayment implements \JsonSerializable $json['seller_receivable_breakdown'] = $this->sellerReceivableBreakdown; } if (isset($this->disbursementMode)) { - $json['disbursement_mode'] = DisbursementMode::checkValue($this->disbursementMode); + $json['disbursement_mode'] = $this->disbursementMode; } if (isset($this->links)) { $json['links'] = $this->links; diff --git a/src/Models/CardAttributes.php b/src/Models/CardAttributes.php index cbd3b79..583290c 100644 --- a/src/Models/CardAttributes.php +++ b/src/Models/CardAttributes.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -96,6 +97,19 @@ class CardAttributes implements \JsonSerializable $this->verification = $verification; } + /** + * Converts the CardAttributes object to a human-readable string representation. + * + * @return string The string representation of the CardAttributes object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'CardAttributes', + ['customer' => $this->customer, 'vault' => $this->vault, 'verification' => $this->verification] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/CardAttributesResponse.php b/src/Models/CardAttributesResponse.php index c328117..b90c99c 100644 --- a/src/Models/CardAttributesResponse.php +++ b/src/Models/CardAttributesResponse.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -42,6 +43,16 @@ class CardAttributesResponse implements \JsonSerializable $this->vault = $vault; } + /** + * Converts the CardAttributesResponse object to a human-readable string representation. + * + * @return string The string representation of the CardAttributesResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify('CardAttributesResponse', ['vault' => $this->vault]); + } + /** * Encode this object to JSON * diff --git a/src/Models/CardAuthenticationResponse.php b/src/Models/CardAuthenticationResponse.php index 0f1e79b..e4b291f 100644 --- a/src/Models/CardAuthenticationResponse.php +++ b/src/Models/CardAuthenticationResponse.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -18,7 +19,7 @@ use stdClass; class CardAuthenticationResponse implements \JsonSerializable { /** - * @var ThreeDSecureAuthenticationResponse|null + * @var ThreeDSecureCardAuthenticationResponse|null */ private $threeDSecure; @@ -26,7 +27,7 @@ class CardAuthenticationResponse implements \JsonSerializable * Returns Three D Secure. * Results of 3D Secure Authentication. */ - public function getThreeDSecure(): ?ThreeDSecureAuthenticationResponse + public function getThreeDSecure(): ?ThreeDSecureCardAuthenticationResponse { return $this->threeDSecure; } @@ -37,11 +38,21 @@ class CardAuthenticationResponse implements \JsonSerializable * * @maps three_d_secure */ - public function setThreeDSecure(?ThreeDSecureAuthenticationResponse $threeDSecure): void + public function setThreeDSecure(?ThreeDSecureCardAuthenticationResponse $threeDSecure): void { $this->threeDSecure = $threeDSecure; } + /** + * Converts the CardAuthenticationResponse object to a human-readable string representation. + * + * @return string The string representation of the CardAuthenticationResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify('CardAuthenticationResponse', ['threeDSecure' => $this->threeDSecure]); + } + /** * Encode this object to JSON * diff --git a/src/Models/CardBrand.php b/src/Models/CardBrand.php index 6323811..d3f5ec1 100644 --- a/src/Models/CardBrand.php +++ b/src/Models/CardBrand.php @@ -10,108 +10,134 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The card network or brand. Applies to credit, debit, gift, and payment cards. */ class CardBrand { + /** + * Visa card. + */ public const VISA = 'VISA'; + /** + * Mastecard card. + */ public const MASTERCARD = 'MASTERCARD'; + /** + * Discover card. + */ public const DISCOVER = 'DISCOVER'; + /** + * American Express card. + */ public const AMEX = 'AMEX'; + /** + * Solo debit card. + */ public const SOLO = 'SOLO'; + /** + * Japan Credit Bureau card. + */ public const JCB = 'JCB'; + /** + * Military Star card. + */ public const STAR = 'STAR'; + /** + * Delta Airlines card. + */ public const DELTA = 'DELTA'; + /** + * Switch credit card. + */ public const SWITCH_ = 'SWITCH'; + /** + * Maestro credit card. + */ public const MAESTRO = 'MAESTRO'; + /** + * Carte Bancaire (CB) credit card. + */ public const CB_NATIONALE = 'CB_NATIONALE'; + /** + * Configoga credit card. + */ public const CONFIGOGA = 'CONFIGOGA'; + /** + * Confidis credit card. + */ public const CONFIDIS = 'CONFIDIS'; + /** + * Visa Electron credit card. + */ public const ELECTRON = 'ELECTRON'; + /** + * Cetelem credit card. + */ public const CETELEM = 'CETELEM'; + /** + * China union pay credit card. + */ public const CHINA_UNION_PAY = 'CHINA_UNION_PAY'; + /** + * The Diners Club International banking and payment services capability network owned by Discover + * Financial Services (DFS), one of the most recognized brands in US financial services. + */ public const DINERS = 'DINERS'; + /** + * The Brazilian Elo card payment network. + */ public const ELO = 'ELO'; + /** + * The Hiper - Ingenico ePayment network. + */ public const HIPER = 'HIPER'; + /** + * The Brazilian Hipercard payment network that's widely accepted in the retail market. + */ public const HIPERCARD = 'HIPERCARD'; + /** + * The RuPay payment network. + */ public const RUPAY = 'RUPAY'; + /** + * The GE Credit Union 3Point card payment network. + */ public const GE = 'GE'; + /** + * The Synchrony Financial (SYF) payment network. + */ public const SYNCHRONY = 'SYNCHRONY'; + /** + * The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network. + */ public const EFTPOS = 'EFTPOS'; - public const UNKNOWN = 'UNKNOWN'; - - private const _ALL_VALUES = [ - self::VISA, - self::MASTERCARD, - self::DISCOVER, - self::AMEX, - self::SOLO, - self::JCB, - self::STAR, - self::DELTA, - self::SWITCH_, - self::MAESTRO, - self::CB_NATIONALE, - self::CONFIGOGA, - self::CONFIDIS, - self::ELECTRON, - self::CETELEM, - self::CHINA_UNION_PAY, - self::DINERS, - self::ELO, - self::HIPER, - self::HIPERCARD, - self::RUPAY, - self::GE, - self::SYNCHRONY, - self::EFTPOS, - self::UNKNOWN - ]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * UNKNOWN payment network. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for CardBrand."); - } + public const UNKNOWN = 'UNKNOWN'; } diff --git a/src/Models/CardCustomerInformation.php b/src/Models/CardCustomerInformation.php index 7358d04..264837e 100644 --- a/src/Models/CardCustomerInformation.php +++ b/src/Models/CardCustomerInformation.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -59,10 +60,9 @@ class CardCustomerInformation implements \JsonSerializable /** * Returns Email Address. - * The internationalized email address.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. */ public function getEmailAddress(): ?string { @@ -71,10 +71,9 @@ class CardCustomerInformation implements \JsonSerializable /** * Sets Email Address. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. * * @maps email_address */ @@ -127,6 +126,24 @@ class CardCustomerInformation implements \JsonSerializable $this->merchantCustomerId = $merchantCustomerId; } + /** + * Converts the CardCustomerInformation object to a human-readable string representation. + * + * @return string The string representation of the CardCustomerInformation object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'CardCustomerInformation', + [ + 'id' => $this->id, + 'emailAddress' => $this->emailAddress, + 'phone' => $this->phone, + 'merchantCustomerId' => $this->merchantCustomerId + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/CardExperienceContext.php b/src/Models/CardExperienceContext.php index b55c951..ee8fc07 100644 --- a/src/Models/CardExperienceContext.php +++ b/src/Models/CardExperienceContext.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -67,6 +68,19 @@ class CardExperienceContext implements \JsonSerializable $this->cancelUrl = $cancelUrl; } + /** + * Converts the CardExperienceContext object to a human-readable string representation. + * + * @return string The string representation of the CardExperienceContext object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'CardExperienceContext', + ['returnUrl' => $this->returnUrl, 'cancelUrl' => $this->cancelUrl] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/CardFromRequest.php b/src/Models/CardFromRequest.php index 589114f..fbe0f95 100644 --- a/src/Models/CardFromRequest.php +++ b/src/Models/CardFromRequest.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -69,6 +70,19 @@ class CardFromRequest implements \JsonSerializable $this->lastDigits = $lastDigits; } + /** + * Converts the CardFromRequest object to a human-readable string representation. + * + * @return string The string representation of the CardFromRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'CardFromRequest', + ['expiry' => $this->expiry, 'lastDigits' => $this->lastDigits] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/CardPaymentToken.php b/src/Models/CardPaymentToken.php deleted file mode 100644 index af6c03e..0000000 --- a/src/Models/CardPaymentToken.php +++ /dev/null @@ -1,376 +0,0 @@ -name; - } - - /** - * Sets Name. - * The card holder's name as it appears on the card. - * - * @maps name - */ - public function setName(?string $name): void - { - $this->name = $name; - } - - /** - * Returns Last Digits. - * The last digits of the payment card. - */ - public function getLastDigits(): ?string - { - return $this->lastDigits; - } - - /** - * Sets Last Digits. - * The last digits of the payment card. - * - * @maps last_digits - */ - public function setLastDigits(?string $lastDigits): void - { - $this->lastDigits = $lastDigits; - } - - /** - * Returns Brand. - * The card network or brand. Applies to credit, debit, gift, and payment cards. - */ - public function getBrand(): ?string - { - return $this->brand; - } - - /** - * Sets Brand. - * The card network or brand. Applies to credit, debit, gift, and payment cards. - * - * @maps brand - */ - public function setBrand(?string $brand): void - { - $this->brand = $brand; - } - - /** - * Returns Expiry. - * The year and month, in ISO-8601 `YYYY-MM` date format. See [Internet date and time format](https: - * //tools.ietf.org/html/rfc3339#section-5.6). - */ - public function getExpiry(): ?string - { - return $this->expiry; - } - - /** - * Sets Expiry. - * The year and month, in ISO-8601 `YYYY-MM` date format. See [Internet date and time format](https: - * //tools.ietf.org/html/rfc3339#section-5.6). - * - * @maps expiry - */ - public function setExpiry(?string $expiry): void - { - $this->expiry = $expiry; - } - - /** - * Returns Billing Address. - * Address request details. - */ - public function getBillingAddress(): ?AddressDetails - { - return $this->billingAddress; - } - - /** - * Sets Billing Address. - * Address request details. - * - * @maps billing_address - */ - public function setBillingAddress(?AddressDetails $billingAddress): void - { - $this->billingAddress = $billingAddress; - } - - /** - * Returns Verification Status. - * Verification status of Card. - */ - public function getVerificationStatus(): ?string - { - return $this->verificationStatus; - } - - /** - * Sets Verification Status. - * Verification status of Card. - * - * @maps verification_status - */ - public function setVerificationStatus(?string $verificationStatus): void - { - $this->verificationStatus = $verificationStatus; - } - - /** - * Returns Verification. - * Card Verification details including the authorization details and 3D SECURE details. - */ - public function getVerification(): ?CardVerificationDetails - { - return $this->verification; - } - - /** - * Sets Verification. - * Card Verification details including the authorization details and 3D SECURE details. - * - * @maps verification - */ - public function setVerification(?CardVerificationDetails $verification): void - { - $this->verification = $verification; - } - - /** - * Returns Network Transaction Reference. - * Previous network transaction reference including id in response. - */ - public function getNetworkTransactionReference(): ?NetworkTransactionReferenceEntity - { - return $this->networkTransactionReference; - } - - /** - * Sets Network Transaction Reference. - * Previous network transaction reference including id in response. - * - * @maps network_transaction_reference - */ - public function setNetworkTransactionReference( - ?NetworkTransactionReferenceEntity $networkTransactionReference - ): void { - $this->networkTransactionReference = $networkTransactionReference; - } - - /** - * Returns Authentication Result. - * Results of Authentication such as 3D Secure. - */ - public function getAuthenticationResult(): ?CardAuthenticationResponse - { - return $this->authenticationResult; - } - - /** - * Sets Authentication Result. - * Results of Authentication such as 3D Secure. - * - * @maps authentication_result - */ - public function setAuthenticationResult(?CardAuthenticationResponse $authenticationResult): void - { - $this->authenticationResult = $authenticationResult; - } - - /** - * Returns Bin Details. - * Bank Identification Number (BIN) details used to fund a payment. - */ - public function getBinDetails(): ?BinDetails - { - return $this->binDetails; - } - - /** - * Sets Bin Details. - * Bank Identification Number (BIN) details used to fund a payment. - * - * @maps bin_details - */ - public function setBinDetails(?BinDetails $binDetails): void - { - $this->binDetails = $binDetails; - } - - /** - * Returns Type. - * Type of card. i.e Credit, Debit and so on. - */ - public function getType(): ?string - { - return $this->type; - } - - /** - * Sets Type. - * Type of card. i.e Credit, Debit and so on. - * - * @maps type - */ - public function setType(?string $type): void - { - $this->type = $type; - } - - /** - * Returns Network Token. - * - * @return mixed - */ - public function getNetworkToken() - { - return $this->networkToken; - } - - /** - * Sets Network Token. - * - * @maps network_token - * - * @param mixed $networkToken - */ - public function setNetworkToken($networkToken): void - { - $this->networkToken = $networkToken; - } - - /** - * Encode this object to JSON - * - * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields - * are set. (default: false) - * - * @return array|stdClass - */ - #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) - public function jsonSerialize(bool $asArrayWhenEmpty = false) - { - $json = []; - if (isset($this->name)) { - $json['name'] = $this->name; - } - if (isset($this->lastDigits)) { - $json['last_digits'] = $this->lastDigits; - } - if (isset($this->brand)) { - $json['brand'] = CardBrand::checkValue($this->brand); - } - if (isset($this->expiry)) { - $json['expiry'] = $this->expiry; - } - if (isset($this->billingAddress)) { - $json['billing_address'] = $this->billingAddress; - } - if (isset($this->verificationStatus)) { - $json['verification_status'] = $this->verificationStatus; - } - if (isset($this->verification)) { - $json['verification'] = $this->verification; - } - if (isset($this->networkTransactionReference)) { - $json['network_transaction_reference'] = $this->networkTransactionReference; - } - if (isset($this->authenticationResult)) { - $json['authentication_result'] = $this->authenticationResult; - } - if (isset($this->binDetails)) { - $json['bin_details'] = $this->binDetails; - } - if (isset($this->type)) { - $json['type'] = CardType::checkValue($this->type); - } - if (isset($this->networkToken)) { - $json['network_token'] = $this->networkToken; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/CardResponseEntity.php b/src/Models/CardPaymentTokenEntity.php similarity index 85% rename from src/Models/CardResponseEntity.php rename to src/Models/CardPaymentTokenEntity.php index 555cccc..f74b97e 100644 --- a/src/Models/CardResponseEntity.php +++ b/src/Models/CardPaymentTokenEntity.php @@ -10,12 +10,13 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** * Full representation of a Card Payment Token. */ -class CardResponseEntity implements \JsonSerializable +class CardPaymentTokenEntity implements \JsonSerializable { /** * @var string|null @@ -38,7 +39,7 @@ class CardResponseEntity implements \JsonSerializable private $expiry; /** - * @var AddressDetails|null + * @var CardResponseAddress|null */ private $billingAddress; @@ -158,7 +159,7 @@ class CardResponseEntity implements \JsonSerializable * Returns Billing Address. * Address request details. */ - public function getBillingAddress(): ?AddressDetails + public function getBillingAddress(): ?CardResponseAddress { return $this->billingAddress; } @@ -169,7 +170,7 @@ class CardResponseEntity implements \JsonSerializable * * @maps billing_address */ - public function setBillingAddress(?AddressDetails $billingAddress): void + public function setBillingAddress(?CardResponseAddress $billingAddress): void { $this->billingAddress = $billingAddress; } @@ -295,6 +296,31 @@ class CardResponseEntity implements \JsonSerializable $this->type = $type; } + /** + * Converts the CardPaymentTokenEntity object to a human-readable string representation. + * + * @return string The string representation of the CardPaymentTokenEntity object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'CardPaymentTokenEntity', + [ + 'name' => $this->name, + 'lastDigits' => $this->lastDigits, + 'brand' => $this->brand, + 'expiry' => $this->expiry, + 'billingAddress' => $this->billingAddress, + 'verificationStatus' => $this->verificationStatus, + 'verification' => $this->verification, + 'networkTransactionReference' => $this->networkTransactionReference, + 'authenticationResult' => $this->authenticationResult, + 'binDetails' => $this->binDetails, + 'type' => $this->type + ] + ); + } + /** * Encode this object to JSON * @@ -314,7 +340,7 @@ class CardResponseEntity implements \JsonSerializable $json['last_digits'] = $this->lastDigits; } if (isset($this->brand)) { - $json['brand'] = CardBrand::checkValue($this->brand); + $json['brand'] = $this->brand; } if (isset($this->expiry)) { $json['expiry'] = $this->expiry; @@ -338,7 +364,7 @@ class CardResponseEntity implements \JsonSerializable $json['bin_details'] = $this->binDetails; } if (isset($this->type)) { - $json['type'] = CardType::checkValue($this->type); + $json['type'] = $this->type; } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; diff --git a/src/Models/CardRequest.php b/src/Models/CardRequest.php index 408a8d1..2644675 100644 --- a/src/Models/CardRequest.php +++ b/src/Models/CardRequest.php @@ -10,15 +10,14 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** - * The payment card to use to fund a payment. Can be a credit or debit card.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: - * Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance. - *+ * The payment card to use to fund a payment. Can be a credit or debit card. Note: Passing card number, + * cvv and expiry directly via the API requires PCI SAQ D compliance. *PayPal offers a mechanism by + * which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this + * Integration Guide*. */ class CardRequest implements \JsonSerializable { @@ -254,13 +253,12 @@ class CardRequest implements \JsonSerializable /** * Returns Stored Credential. * Provides additional details to process a payment using a `card` that has been stored or is intended - * to be stored (also referred to as stored_credential or card-on-file).
*PayPal offers a mechanism by which you do not have to take on the PCI SAQ D - * burden by using hosted fields - refer to this Integration Guide*.
Note: The country code for Great Britain is+ * region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. */ public function getCountryCode(): string { @@ -184,10 +186,9 @@ class PortablePostalAddressMediumGrained implements \JsonSerializable /** * Sets Country Code. * The [2-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or - * region.GBand - * notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. * * @required * @maps country_code @@ -197,6 +198,47 @@ class PortablePostalAddressMediumGrained implements \JsonSerializable $this->countryCode = $countryCode; } + /** + * Returns Id. + * The resource ID of the address. + */ + public function getId(): ?string + { + return $this->id; + } + + /** + * Sets Id. + * The resource ID of the address. + * + * @maps id + */ + public function setId(?string $id): void + { + $this->id = $id; + } + + /** + * Converts the CardResponseAddress object to a human-readable string representation. + * + * @return string The string representation of the CardResponseAddress object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'CardResponseAddress', + [ + 'addressLine1' => $this->addressLine1, + 'addressLine2' => $this->addressLine2, + 'adminArea2' => $this->adminArea2, + 'adminArea1' => $this->adminArea1, + 'postalCode' => $this->postalCode, + 'countryCode' => $this->countryCode, + 'id' => $this->id + ] + ); + } + /** * Encode this object to JSON * @@ -225,6 +267,9 @@ class PortablePostalAddressMediumGrained implements \JsonSerializable $json['postal_code'] = $this->postalCode; } $json['country_code'] = $this->countryCode; + if (isset($this->id)) { + $json['id'] = $this->id; + } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; } diff --git a/src/Models/CardStoredCredential.php b/src/Models/CardStoredCredential.php index 4740f03..e9aff57 100644 --- a/src/Models/CardStoredCredential.php +++ b/src/Models/CardStoredCredential.php @@ -10,17 +10,17 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** * Provides additional details to process a payment using a `card` that has been stored or is intended - * to be stored (also referred to as stored_credential or card-on-file).GBand - * notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getTime(): ?string { @@ -130,8 +131,8 @@ class CardVerificationDetails implements \JsonSerializable /** * Sets Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps time */ @@ -182,8 +183,9 @@ class CardVerificationDetails implements \JsonSerializable /** * Returns Three D Secure. - * DEPRECATED. This field is DEPRECATED. Please find the 3D secure authentication data in - * 'three_d_secure' object under 'authentication_result' object instead of the 'verification' field. + * DEPRECATED. This field is DEPRECATED. Please find the 3D secure authentication data in the + * 'three_d_secure' object under the 'authentication_result' object instead of the 'verification' + * object. * * @return mixed */ @@ -194,8 +196,9 @@ class CardVerificationDetails implements \JsonSerializable /** * Sets Three D Secure. - * DEPRECATED. This field is DEPRECATED. Please find the 3D secure authentication data in - * 'three_d_secure' object under 'authentication_result' object instead of the 'verification' field. + * DEPRECATED. This field is DEPRECATED. Please find the 3D secure authentication data in the + * 'three_d_secure' object under the 'authentication_result' object instead of the 'verification' + * object. * * @maps three_d_secure * @@ -206,6 +209,27 @@ class CardVerificationDetails implements \JsonSerializable $this->threeDSecure = $threeDSecure; } + /** + * Converts the CardVerificationDetails object to a human-readable string representation. + * + * @return string The string representation of the CardVerificationDetails object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'CardVerificationDetails', + [ + 'networkTransactionId' => $this->networkTransactionId, + 'date' => $this->date, + 'network' => $this->network, + 'time' => $this->time, + 'amount' => $this->amount, + 'processorResponse' => $this->processorResponse, + 'threeDSecure' => $this->threeDSecure + ] + ); + } + /** * Encode this object to JSON * @@ -225,7 +249,7 @@ class CardVerificationDetails implements \JsonSerializable $json['date'] = $this->date; } if (isset($this->network)) { - $json['network'] = CardBrand::checkValue($this->network); + $json['network'] = $this->network; } if (isset($this->time)) { $json['time'] = $this->time; diff --git a/src/Models/CardVerificationMethod.php b/src/Models/CardVerificationMethod.php deleted file mode 100644 index b41226e..0000000 --- a/src/Models/CardVerificationMethod.php +++ /dev/null @@ -1,49 +0,0 @@ -cvvCode = $cvvCode; } + /** + * Converts the CardVerificationProcessorResponse object to a human-readable string representation. + * + * @return string The string representation of the CardVerificationProcessorResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'CardVerificationProcessorResponse', + ['avsCode' => $this->avsCode, 'cvvCode' => $this->cvvCode] + ); + } + /** * Encode this object to JSON * @@ -80,10 +94,10 @@ class CardVerificationProcessorResponse implements \JsonSerializable { $json = []; if (isset($this->avsCode)) { - $json['avs_code'] = AvsCode::checkValue($this->avsCode); + $json['avs_code'] = $this->avsCode; } if (isset($this->cvvCode)) { - $json['cvv_code'] = CvvCode::checkValue($this->cvvCode); + $json['cvv_code'] = $this->cvvCode; } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; diff --git a/src/Models/CardVerificationStatus.php b/src/Models/CardVerificationStatus.php new file mode 100644 index 0000000..5b85b9f --- /dev/null +++ b/src/Models/CardVerificationStatus.php @@ -0,0 +1,27 @@ +amount = $amount; } + /** + * Converts the CobrandedCard object to a human-readable string representation. + * + * @return string The string representation of the CobrandedCard object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'CobrandedCard', + ['labels' => $this->labels, 'payee' => $this->payee, 'amount' => $this->amount] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/ConfirmOrderRequest.php b/src/Models/ConfirmOrderRequest.php index 2eec226..f2e07ef 100644 --- a/src/Models/ConfirmOrderRequest.php +++ b/src/Models/ConfirmOrderRequest.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -22,11 +23,6 @@ class ConfirmOrderRequest implements \JsonSerializable */ private $paymentSource; - /** - * @var mixed - */ - private $processingInstruction; - /** * @var OrderConfirmApplicationContext|null */ @@ -61,28 +57,6 @@ class ConfirmOrderRequest implements \JsonSerializable $this->paymentSource = $paymentSource; } - /** - * Returns Processing Instruction. - * - * @return mixed - */ - public function getProcessingInstruction() - { - return $this->processingInstruction; - } - - /** - * Sets Processing Instruction. - * - * @maps processing_instruction - * - * @param mixed $processingInstruction - */ - public function setProcessingInstruction($processingInstruction): void - { - $this->processingInstruction = $processingInstruction; - } - /** * Returns Application Context. * Customizes the payer confirmation experience. @@ -103,6 +77,19 @@ class ConfirmOrderRequest implements \JsonSerializable $this->applicationContext = $applicationContext; } + /** + * Converts the ConfirmOrderRequest object to a human-readable string representation. + * + * @return string The string representation of the ConfirmOrderRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'ConfirmOrderRequest', + ['paymentSource' => $this->paymentSource, 'applicationContext' => $this->applicationContext] + ); + } + /** * Encode this object to JSON * @@ -115,12 +102,9 @@ class ConfirmOrderRequest implements \JsonSerializable public function jsonSerialize(bool $asArrayWhenEmpty = false) { $json = []; - $json['payment_source'] = $this->paymentSource; - if (isset($this->processingInstruction)) { - $json['processing_instruction'] = $this->processingInstruction; - } + $json['payment_source'] = $this->paymentSource; if (isset($this->applicationContext)) { - $json['application_context'] = $this->applicationContext; + $json['application_context'] = $this->applicationContext; } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; diff --git a/src/Models/CustomerRequest.php b/src/Models/Customer.php similarity index 79% rename from src/Models/CustomerRequest.php rename to src/Models/Customer.php index e643649..340bba9 100644 --- a/src/Models/CustomerRequest.php +++ b/src/Models/Customer.php @@ -10,12 +10,14 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** - * Customer in merchant's or partner's system of records. + * This object defines a customer in your system. Use it to manage customer profiles, save payment + * methods and contact details. */ -class CustomerRequest implements \JsonSerializable +class Customer implements \JsonSerializable { /** * @var string|null @@ -71,6 +73,19 @@ class CustomerRequest implements \JsonSerializable $this->merchantCustomerId = $merchantCustomerId; } + /** + * Converts the Customer object to a human-readable string representation. + * + * @return string The string representation of the Customer object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'Customer', + ['id' => $this->id, 'merchantCustomerId' => $this->merchantCustomerId] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/CustomerInformation.php b/src/Models/CustomerInformation.php index c799322..0f59133 100644 --- a/src/Models/CustomerInformation.php +++ b/src/Models/CustomerInformation.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -54,10 +55,9 @@ class CustomerInformation implements \JsonSerializable /** * Returns Email Address. - * The internationalized email address.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. */ public function getEmailAddress(): ?string { @@ -66,10 +66,9 @@ class CustomerInformation implements \JsonSerializable /** * Sets Email Address. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. * * @maps email_address */ @@ -98,6 +97,19 @@ class CustomerInformation implements \JsonSerializable $this->phone = $phone; } + /** + * Converts the CustomerInformation object to a human-readable string representation. + * + * @return string The string representation of the CustomerInformation object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'CustomerInformation', + ['id' => $this->id, 'emailAddress' => $this->emailAddress, 'phone' => $this->phone] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/CustomerResponse.php b/src/Models/CustomerResponse.php new file mode 100644 index 0000000..ef14efa --- /dev/null +++ b/src/Models/CustomerResponse.php @@ -0,0 +1,110 @@ +id; + } + + /** + * Sets Id. + * The unique ID for a customer generated by PayPal. + * + * @maps id + */ + public function setId(?string $id): void + { + $this->id = $id; + } + + /** + * Returns Merchant Customer Id. + * Merchants and partners may already have a data-store where their customer information is persisted. + * Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a + * customer. + */ + public function getMerchantCustomerId(): ?string + { + return $this->merchantCustomerId; + } + + /** + * Sets Merchant Customer Id. + * Merchants and partners may already have a data-store where their customer information is persisted. + * Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a + * customer. + * + * @maps merchant_customer_id + */ + public function setMerchantCustomerId(?string $merchantCustomerId): void + { + $this->merchantCustomerId = $merchantCustomerId; + } + + /** + * Converts the CustomerResponse object to a human-readable string representation. + * + * @return string The string representation of the CustomerResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'CustomerResponse', + ['id' => $this->id, 'merchantCustomerId' => $this->merchantCustomerId] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + if (isset($this->id)) { + $json['id'] = $this->id; + } + if (isset($this->merchantCustomerId)) { + $json['merchant_customer_id'] = $this->merchantCustomerId; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/CustomerVaultPaymentTokensResponse.php b/src/Models/CustomerVaultPaymentTokensResponse.php index f5a607f..542bb55 100644 --- a/src/Models/CustomerVaultPaymentTokensResponse.php +++ b/src/Models/CustomerVaultPaymentTokensResponse.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -28,7 +29,7 @@ class CustomerVaultPaymentTokensResponse implements \JsonSerializable private $totalPages; /** - * @var CustomerRequest|null + * @var VaultResponseCustomer|null */ private $customer; @@ -84,20 +85,22 @@ class CustomerVaultPaymentTokensResponse implements \JsonSerializable /** * Returns Customer. - * Customer in merchant's or partner's system of records. + * This object defines a customer in your system. Use it to manage customer profiles, save payment + * methods and contact details. */ - public function getCustomer(): ?CustomerRequest + public function getCustomer(): ?VaultResponseCustomer { return $this->customer; } /** * Sets Customer. - * Customer in merchant's or partner's system of records. + * This object defines a customer in your system. Use it to manage customer profiles, save payment + * methods and contact details. * * @maps customer */ - public function setCustomer(?CustomerRequest $customer): void + public function setCustomer(?VaultResponseCustomer $customer): void { $this->customer = $customer; } @@ -148,6 +151,25 @@ class CustomerVaultPaymentTokensResponse implements \JsonSerializable $this->links = $links; } + /** + * Converts the CustomerVaultPaymentTokensResponse object to a human-readable string representation. + * + * @return string The string representation of the CustomerVaultPaymentTokensResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'CustomerVaultPaymentTokensResponse', + [ + 'totalItems' => $this->totalItems, + 'totalPages' => $this->totalPages, + 'customer' => $this->customer, + 'paymentTokens' => $this->paymentTokens, + 'links' => $this->links + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/CvvCode.php b/src/Models/CvvCode.php index 4fc8da9..0dcca6b 100644 --- a/src/Models/CvvCode.php +++ b/src/Models/CvvCode.php @@ -10,75 +10,79 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The card verification value code for for Visa, Discover, Mastercard, or American Express. */ class CvvCode { - public const E = 'E'; - - public const I = 'I'; - - public const M = 'M'; - - public const N = 'N'; - - public const P = 'P'; - - public const S = 'S'; - - public const U = 'U'; - - public const X = 'X'; - - public const ENUM_ALL_OTHERS = 'All others'; - - public const ENUM_0 = '0'; - - public const ENUM_1 = '1'; - - public const ENUM_2 = '2'; - - public const ENUM_3 = '3'; - - public const ENUM_4 = '4'; - - private const _ALL_VALUES = [ - self::E, - self::I, - self::M, - self::N, - self::P, - self::S, - self::U, - self::X, - self::ENUM_ALL_OTHERS, - self::ENUM_0, - self::ENUM_1, - self::ENUM_2, - self::ENUM_3, - self::ENUM_4 - ]; + /** + * For Visa, Mastercard, Discover, or American Express, error - unrecognized or unknown response. + */ + public const CVV_E = 'E'; /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * For Visa, Mastercard, Discover, or American Express, invalid or null. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for CvvCode."); - } + public const CVV_I = 'I'; + + /** + * For Visa, Mastercard, Discover, or American Express, the CVV2/CSC matches. + */ + public const CVV_M = 'M'; + + /** + * For Visa, Mastercard, Discover, or American Express, the CVV2/CSC does not match. + */ + public const CVV_N = 'N'; + + /** + * For Visa, Mastercard, Discover, or American Express, it was not processed. + */ + public const CVV_P = 'P'; + + /** + * For Visa, Mastercard, Discover, or American Express, the service is not supported. + */ + public const CVV_S = 'S'; + + /** + * For Visa, Mastercard, Discover, or American Express, unknown - the issuer is not certified. + */ + public const CVV_U = 'U'; + + /** + * For Visa, Mastercard, Discover, or American Express, no response. For Maestro, the service is not + * available. + */ + public const CVV_X = 'X'; + + /** + * For Visa, Mastercard, Discover, or American Express, error. + */ + public const ENUM_ALL_OTHERS = 'All others'; + + /** + * For Maestro, the CVV2 matched. + */ + public const CVV_0 = '0'; + + /** + * For Maestro, the CVV2 did not match. + */ + public const CVV_1 = '1'; + + /** + * For Maestro, the merchant has not implemented CVV2 code handling. + */ + public const CVV_2 = '2'; + + /** + * For Maestro, the merchant has indicated that CVV2 is not present on card. + */ + public const CVV_3 = '3'; + + /** + * For Maestro, the service is not available. + */ + public const CVV_4 = '4'; } diff --git a/src/Models/DisbursementMode.php b/src/Models/DisbursementMode.php index fda67de..f13a053 100644 --- a/src/Models/DisbursementMode.php +++ b/src/Models/DisbursementMode.php @@ -10,36 +10,20 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The funds that are held on behalf of the merchant. */ class DisbursementMode { + /** + * The funds are released to the merchant immediately. + */ public const INSTANT = 'INSTANT'; - public const DELAYED = 'DELAYED'; - - private const _ALL_VALUES = [self::INSTANT, self::DELAYED]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * The funds are held for a finite number of days. The actual duration depends on the region and type + * of integration. You can release the funds through a referenced payout. Otherwise, the funds + * disbursed automatically after the specified duration. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for DisbursementMode."); - } + public const DELAYED = 'DELAYED'; } diff --git a/src/Models/DisputeCategory.php b/src/Models/DisputeCategory.php index b52879d..a6be566 100644 --- a/src/Models/DisputeCategory.php +++ b/src/Models/DisputeCategory.php @@ -10,36 +10,18 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The condition that is covered for the transaction. */ class DisputeCategory { + /** + * The payer paid for an item that they did not receive. + */ public const ITEM_NOT_RECEIVED = 'ITEM_NOT_RECEIVED'; - public const UNAUTHORIZED_TRANSACTION = 'UNAUTHORIZED_TRANSACTION'; - - private const _ALL_VALUES = [self::ITEM_NOT_RECEIVED, self::UNAUTHORIZED_TRANSACTION]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * The payer did not authorize the payment. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for DisputeCategory."); - } + public const UNAUTHORIZED_TRANSACTION = 'UNAUTHORIZED_TRANSACTION'; } diff --git a/src/Models/EciFlag.php b/src/Models/EciFlag.php index 8e94749..2c412af 100644 --- a/src/Models/EciFlag.php +++ b/src/Models/EciFlag.php @@ -10,10 +10,6 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the * transaction was processed electronically. This should be passed on the authorization transaction to @@ -21,42 +17,33 @@ use stdClass; */ class EciFlag { + /** + * Mastercard non-3-D Secure transaction. + */ public const MASTERCARD_NON_3D_SECURE_TRANSACTION = 'MASTERCARD_NON_3D_SECURE_TRANSACTION'; + /** + * Mastercard attempted authentication transaction. + */ public const MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION = 'MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION'; + /** + * Mastercard fully authenticated transaction. + */ public const MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION = 'MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION'; + /** + * VISA, AMEX, JCB, DINERS CLUB fully authenticated transaction. + */ public const FULLY_AUTHENTICATED_TRANSACTION = 'FULLY_AUTHENTICATED_TRANSACTION'; + /** + * VISA, AMEX, JCB, DINERS CLUB attempted authentication transaction. + */ public const ATTEMPTED_AUTHENTICATION_TRANSACTION = 'ATTEMPTED_AUTHENTICATION_TRANSACTION'; - public const NON_3D_SECURE_TRANSACTION = 'NON_3D_SECURE_TRANSACTION'; - - private const _ALL_VALUES = [ - self::MASTERCARD_NON_3D_SECURE_TRANSACTION, - self::MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION, - self::MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION, - self::FULLY_AUTHENTICATED_TRANSACTION, - self::ATTEMPTED_AUTHENTICATION_TRANSACTION, - self::NON_3D_SECURE_TRANSACTION - ]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * VISA, AMEX, JCB, DINERS CLUB non-3-D Secure transaction. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for EciFlag."); - } + public const NON_3D_SECURE_TRANSACTION = 'NON_3D_SECURE_TRANSACTION'; } diff --git a/src/Models/EnrollmentStatus.php b/src/Models/EnrollmentStatus.php index 7269a4a..42a09ad 100644 --- a/src/Models/EnrollmentStatus.php +++ b/src/Models/EnrollmentStatus.php @@ -10,40 +10,28 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * Status of Authentication eligibility. */ class EnrollmentStatus { - public const Y = 'Y'; - - public const N = 'N'; - - public const U = 'U'; - - public const B = 'B'; - - private const _ALL_VALUES = [self::Y, self::N, self::U, self::B]; + /** + * Yes. The bank is participating in 3-D Secure protocol and will return the ACSUrl. + */ + public const ENROLLED = 'Y'; /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * No. The bank is not participating in 3-D Secure protocol. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for EnrollmentStatus."); - } + public const NOTENROLLED = 'N'; + + /** + * Unavailable. The DS or ACS is not available for authentication at the time of the request. + */ + public const UNAVAILABLE = 'U'; + + /** + * Bypass. The merchant authentication rule is triggered to bypass authentication. + */ + public const BYPASS = 'B'; } diff --git a/src/Models/EpsPaymentObject.php b/src/Models/EpsPaymentObject.php index 7f1f71b..f14eda9 100644 --- a/src/Models/EpsPaymentObject.php +++ b/src/Models/EpsPaymentObject.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -55,10 +56,9 @@ class EpsPaymentObject implements \JsonSerializable /** * Returns Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. */ public function getCountryCode(): ?string { @@ -68,10 +68,9 @@ class EpsPaymentObject implements \JsonSerializable /** * Sets Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. * * @maps country_code */ @@ -102,6 +101,19 @@ class EpsPaymentObject implements \JsonSerializable $this->bic = $bic; } + /** + * Converts the EpsPaymentObject object to a human-readable string representation. + * + * @return string The string representation of the EpsPaymentObject object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'EpsPaymentObject', + ['name' => $this->name, 'countryCode' => $this->countryCode, 'bic' => $this->bic] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/EpsPaymentRequest.php b/src/Models/EpsPaymentRequest.php index 66a90fa..0cae62e 100644 --- a/src/Models/EpsPaymentRequest.php +++ b/src/Models/EpsPaymentRequest.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -66,10 +67,9 @@ class EpsPaymentRequest implements \JsonSerializable /** * Returns Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. */ public function getCountryCode(): string { @@ -79,10 +79,9 @@ class EpsPaymentRequest implements \JsonSerializable /** * Sets Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. * * @required * @maps country_code @@ -112,6 +111,23 @@ class EpsPaymentRequest implements \JsonSerializable $this->experienceContext = $experienceContext; } + /** + * Converts the EpsPaymentRequest object to a human-readable string representation. + * + * @return string The string representation of the EpsPaymentRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'EpsPaymentRequest', + [ + 'name' => $this->name, + 'countryCode' => $this->countryCode, + 'experienceContext' => $this->experienceContext + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/ErrorDetails.php b/src/Models/ErrorDetails.php index 2a4be67..1dd21a7 100644 --- a/src/Models/ErrorDetails.php +++ b/src/Models/ErrorDetails.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -186,6 +187,26 @@ class ErrorDetails implements \JsonSerializable $this->description = $description; } + /** + * Converts the ErrorDetails object to a human-readable string representation. + * + * @return string The string representation of the ErrorDetails object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'ErrorDetails', + [ + 'field' => $this->field, + 'value' => $this->value, + 'location' => $this->location, + 'issue' => $this->issue, + 'links' => $this->links, + 'description' => $this->description + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/ExchangeRate.php b/src/Models/ExchangeRate.php index 1411fed..2edff04 100644 --- a/src/Models/ExchangeRate.php +++ b/src/Models/ExchangeRate.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -98,6 +99,23 @@ class ExchangeRate implements \JsonSerializable $this->value = $value; } + /** + * Converts the ExchangeRate object to a human-readable string representation. + * + * @return string The string representation of the ExchangeRate object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'ExchangeRate', + [ + 'sourceCurrency' => $this->sourceCurrency, + 'targetCurrency' => $this->targetCurrency, + 'value' => $this->value + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/ExperienceContext.php b/src/Models/ExperienceContext.php index dae3cf5..aa8fbfa 100644 --- a/src/Models/ExperienceContext.php +++ b/src/Models/ExperienceContext.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -154,6 +155,25 @@ class ExperienceContext implements \JsonSerializable $this->cancelUrl = $cancelUrl; } + /** + * Converts the ExperienceContext object to a human-readable string representation. + * + * @return string The string representation of the ExperienceContext object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'ExperienceContext', + [ + 'brandName' => $this->brandName, + 'locale' => $this->locale, + 'shippingPreference' => $this->shippingPreference, + 'returnUrl' => $this->returnUrl, + 'cancelUrl' => $this->cancelUrl + ] + ); + } + /** * Encode this object to JSON * @@ -173,7 +193,7 @@ class ExperienceContext implements \JsonSerializable $json['locale'] = $this->locale; } if (isset($this->shippingPreference)) { - $json['shipping_preference'] = ShippingPreference::checkValue($this->shippingPreference); + $json['shipping_preference'] = $this->shippingPreference; } if (isset($this->returnUrl)) { $json['return_url'] = $this->returnUrl; diff --git a/src/Models/FulfillmentType.php b/src/Models/FulfillmentType.php index f2ec753..e7a5723 100644 --- a/src/Models/FulfillmentType.php +++ b/src/Models/FulfillmentType.php @@ -10,42 +10,32 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either * `type` or `options` may be present, but not both. */ class FulfillmentType { + /** + * The payer intends to receive the items at a specified address. + */ public const SHIPPING = 'SHIPPING'; + /** + * DEPRECATED. Please use "PICKUP_FROM_PERSON" instead. + */ public const PICKUP_IN_PERSON = 'PICKUP_IN_PERSON'; + /** + * The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, "Buy + * Online, Pick-up in Store". Seller protection is provided with this option. + */ public const PICKUP_IN_STORE = 'PICKUP_IN_STORE'; - public const PICKUP_FROM_PERSON = 'PICKUP_FROM_PERSON'; - - private const _ALL_VALUES = - [self::SHIPPING, self::PICKUP_IN_PERSON, self::PICKUP_IN_STORE, self::PICKUP_FROM_PERSON]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, "Buy Online, + * Pick-up in Person". Seller protection is not available, since the payer is receiving the item from + * the payee in person, and can validate the item prior to payment. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for FulfillmentType."); - } + public const PICKUP_FROM_PERSON = 'PICKUP_FROM_PERSON'; } diff --git a/src/Models/GiropayPaymentObject.php b/src/Models/GiropayPaymentObject.php index 68f15d8..5438858 100644 --- a/src/Models/GiropayPaymentObject.php +++ b/src/Models/GiropayPaymentObject.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -55,10 +56,9 @@ class GiropayPaymentObject implements \JsonSerializable /** * Returns Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. */ public function getCountryCode(): ?string { @@ -68,10 +68,9 @@ class GiropayPaymentObject implements \JsonSerializable /** * Sets Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. * * @maps country_code */ @@ -102,6 +101,19 @@ class GiropayPaymentObject implements \JsonSerializable $this->bic = $bic; } + /** + * Converts the GiropayPaymentObject object to a human-readable string representation. + * + * @return string The string representation of the GiropayPaymentObject object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'GiropayPaymentObject', + ['name' => $this->name, 'countryCode' => $this->countryCode, 'bic' => $this->bic] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/GiropayPaymentRequest.php b/src/Models/GiropayPaymentRequest.php index 0dacab0..07d75a3 100644 --- a/src/Models/GiropayPaymentRequest.php +++ b/src/Models/GiropayPaymentRequest.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -66,10 +67,9 @@ class GiropayPaymentRequest implements \JsonSerializable /** * Returns Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. */ public function getCountryCode(): string { @@ -79,10 +79,9 @@ class GiropayPaymentRequest implements \JsonSerializable /** * Sets Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. * * @required * @maps country_code @@ -112,6 +111,23 @@ class GiropayPaymentRequest implements \JsonSerializable $this->experienceContext = $experienceContext; } + /** + * Converts the GiropayPaymentRequest object to a human-readable string representation. + * + * @return string The string representation of the GiropayPaymentRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'GiropayPaymentRequest', + [ + 'name' => $this->name, + 'countryCode' => $this->countryCode, + 'experienceContext' => $this->experienceContext + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/GooglePayAuthenticationMethod.php b/src/Models/GooglePayAuthenticationMethod.php index 4174f58..e60f5b2 100644 --- a/src/Models/GooglePayAuthenticationMethod.php +++ b/src/Models/GooglePayAuthenticationMethod.php @@ -10,36 +10,22 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * Authentication Method which is used for the card transaction. */ class GooglePayAuthenticationMethod { + /** + * This authentication method is associated with payment cards stored on file with the user's Google + * Account. Returned payment data includes primary account number (PAN) with the expiration month and + * the expiration year. + */ public const PAN_ONLY = 'PAN_ONLY'; - public const CRYPTOGRAM_3DS = 'CRYPTOGRAM_3DS'; - - private const _ALL_VALUES = [self::PAN_ONLY, self::CRYPTOGRAM_3DS]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * Returned payment data includes a 3-D Secure (3DS) cryptogram generated on the device. -> If + * authentication_method=CRYPTOGRAM, it is required that 'cryptogram' parameter in the request has a + * valid 3-D Secure (3DS) cryptogram generated on the device. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for GooglePayAuthenticationMethod."); - } + public const CRYPTOGRAM_3DS = 'CRYPTOGRAM_3DS'; } diff --git a/src/Models/GooglePayCard.php b/src/Models/GooglePayCard.php index 0b33213..79a2d25 100644 --- a/src/Models/GooglePayCard.php +++ b/src/Models/GooglePayCard.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -48,7 +49,7 @@ class GooglePayCard implements \JsonSerializable private $brand; /** - * @var PortablePostalAddressMediumGrained|null + * @var Address|null */ private $billingAddress; @@ -181,7 +182,7 @@ class GooglePayCard implements \JsonSerializable * controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form- * controls-the-autocomplete-attribute). */ - public function getBillingAddress(): ?PortablePostalAddressMediumGrained + public function getBillingAddress(): ?Address { return $this->billingAddress; } @@ -195,11 +196,32 @@ class GooglePayCard implements \JsonSerializable * * @maps billing_address */ - public function setBillingAddress(?PortablePostalAddressMediumGrained $billingAddress): void + public function setBillingAddress(?Address $billingAddress): void { $this->billingAddress = $billingAddress; } + /** + * Converts the GooglePayCard object to a human-readable string representation. + * + * @return string The string representation of the GooglePayCard object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'GooglePayCard', + [ + 'name' => $this->name, + 'number' => $this->number, + 'expiry' => $this->expiry, + 'lastDigits' => $this->lastDigits, + 'type' => $this->type, + 'brand' => $this->brand, + 'billingAddress' => $this->billingAddress + ] + ); + } + /** * Encode this object to JSON * @@ -225,10 +247,10 @@ class GooglePayCard implements \JsonSerializable $json['last_digits'] = $this->lastDigits; } if (isset($this->type)) { - $json['type'] = CardType::checkValue($this->type); + $json['type'] = $this->type; } if (isset($this->brand)) { - $json['brand'] = CardBrand::checkValue($this->brand); + $json['brand'] = $this->brand; } if (isset($this->billingAddress)) { $json['billing_address'] = $this->billingAddress; diff --git a/src/Models/GooglePayCardAttributes.php b/src/Models/GooglePayCardAttributes.php deleted file mode 100644 index 9238ea6..0000000 --- a/src/Models/GooglePayCardAttributes.php +++ /dev/null @@ -1,65 +0,0 @@ -verification; - } - - /** - * Sets Verification. - * The API caller can opt in to verify the card through PayPal offered verification services (e.g. - * Smart Dollar Auth, 3DS). - * - * @maps verification - */ - public function setVerification(?CardVerification $verification): void - { - $this->verification = $verification; - } - - /** - * Encode this object to JSON - * - * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields - * are set. (default: false) - * - * @return array|stdClass - */ - #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) - public function jsonSerialize(bool $asArrayWhenEmpty = false) - { - $json = []; - if (isset($this->verification)) { - $json['verification'] = $this->verification; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/GooglePayCardResponse.php b/src/Models/GooglePayCardResponse.php index 0a0b994..3d4a0fe 100644 --- a/src/Models/GooglePayCardResponse.php +++ b/src/Models/GooglePayCardResponse.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -173,6 +174,26 @@ class GooglePayCardResponse implements \JsonSerializable $this->authenticationResult = $authenticationResult; } + /** + * Converts the GooglePayCardResponse object to a human-readable string representation. + * + * @return string The string representation of the GooglePayCardResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'GooglePayCardResponse', + [ + 'name' => $this->name, + 'lastDigits' => $this->lastDigits, + 'type' => $this->type, + 'brand' => $this->brand, + 'billingAddress' => $this->billingAddress, + 'authenticationResult' => $this->authenticationResult + ] + ); + } + /** * Encode this object to JSON * @@ -192,10 +213,10 @@ class GooglePayCardResponse implements \JsonSerializable $json['last_digits'] = $this->lastDigits; } if (isset($this->type)) { - $json['type'] = CardType::checkValue($this->type); + $json['type'] = $this->type; } if (isset($this->brand)) { - $json['brand'] = CardBrand::checkValue($this->brand); + $json['brand'] = $this->brand; } if (isset($this->billingAddress)) { $json['billing_address'] = $this->billingAddress; diff --git a/src/Models/GooglePayDecryptedTokenData.php b/src/Models/GooglePayDecryptedTokenData.php index 6e76815..46b96ef 100644 --- a/src/Models/GooglePayDecryptedTokenData.php +++ b/src/Models/GooglePayDecryptedTokenData.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -214,6 +215,27 @@ class GooglePayDecryptedTokenData implements \JsonSerializable $this->eciIndicator = $eciIndicator; } + /** + * Converts the GooglePayDecryptedTokenData object to a human-readable string representation. + * + * @return string The string representation of the GooglePayDecryptedTokenData object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'GooglePayDecryptedTokenData', + [ + 'messageId' => $this->messageId, + 'messageExpiration' => $this->messageExpiration, + 'paymentMethod' => $this->paymentMethod, + 'card' => $this->card, + 'authenticationMethod' => $this->authenticationMethod, + 'cryptogram' => $this->cryptogram, + 'eciIndicator' => $this->eciIndicator + ] + ); + } + /** * Encode this object to JSON * @@ -232,9 +254,9 @@ class GooglePayDecryptedTokenData implements \JsonSerializable if (isset($this->messageExpiration)) { $json['message_expiration'] = $this->messageExpiration; } - $json['payment_method'] = GooglePayPaymentMethod::checkValue($this->paymentMethod); + $json['payment_method'] = $this->paymentMethod; $json['card'] = $this->card; - $json['authentication_method'] = GooglePayAuthenticationMethod::checkValue($this->authenticationMethod); + $json['authentication_method'] = $this->authenticationMethod; if (isset($this->cryptogram)) { $json['cryptogram'] = $this->cryptogram; } diff --git a/src/Models/GooglePayPaymentMethod.php b/src/Models/GooglePayPaymentMethod.php index 593075f..cb7fea6 100644 --- a/src/Models/GooglePayPaymentMethod.php +++ b/src/Models/GooglePayPaymentMethod.php @@ -10,34 +10,13 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The type of the payment credential. Currently, only CARD is supported. */ class GooglePayPaymentMethod { - public const CARD = 'CARD'; - - private const _ALL_VALUES = [self::CARD]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * CARD is the only value that Google Pay accepts. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for GooglePayPaymentMethod."); - } + public const CARD = 'CARD'; } diff --git a/src/Models/GooglePayRequest.php b/src/Models/GooglePayRequest.php index a2af2ca..629d578 100644 --- a/src/Models/GooglePayRequest.php +++ b/src/Models/GooglePayRequest.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -47,11 +48,6 @@ class GooglePayRequest implements \JsonSerializable */ private $assuranceDetails; - /** - * @var GooglePayCardAttributes|null - */ - private $attributes; - /** * Returns Name. * The full name representation like Mr J Smith. @@ -74,10 +70,9 @@ class GooglePayRequest implements \JsonSerializable /** * Returns Email Address. - * The internationalized email address.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. */ public function getEmailAddress(): ?string { @@ -86,10 +81,9 @@ class GooglePayRequest implements \JsonSerializable /** * Sets Email Address. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. * * @maps email_address */ @@ -185,23 +179,23 @@ class GooglePayRequest implements \JsonSerializable } /** - * Returns Attributes. - * Additional attributes associated with the use of this card. - */ - public function getAttributes(): ?GooglePayCardAttributes - { - return $this->attributes; - } - - /** - * Sets Attributes. - * Additional attributes associated with the use of this card. + * Converts the GooglePayRequest object to a human-readable string representation. * - * @maps attributes + * @return string The string representation of the GooglePayRequest object. */ - public function setAttributes(?GooglePayCardAttributes $attributes): void + public function __toString(): string { - $this->attributes = $attributes; + return ApiHelper::stringify( + 'GooglePayRequest', + [ + 'name' => $this->name, + 'emailAddress' => $this->emailAddress, + 'phoneNumber' => $this->phoneNumber, + 'card' => $this->card, + 'decryptedToken' => $this->decryptedToken, + 'assuranceDetails' => $this->assuranceDetails + ] + ); } /** @@ -234,9 +228,6 @@ class GooglePayRequest implements \JsonSerializable if (isset($this->assuranceDetails)) { $json['assurance_details'] = $this->assuranceDetails; } - if (isset($this->attributes)) { - $json['attributes'] = $this->attributes; - } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; } diff --git a/src/Models/GooglePayRequestCard.php b/src/Models/GooglePayRequestCard.php index 723f327..6f717a9 100644 --- a/src/Models/GooglePayRequestCard.php +++ b/src/Models/GooglePayRequestCard.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -123,6 +124,24 @@ class GooglePayRequestCard implements \JsonSerializable $this->billingAddress = $billingAddress; } + /** + * Converts the GooglePayRequestCard object to a human-readable string representation. + * + * @return string The string representation of the GooglePayRequestCard object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'GooglePayRequestCard', + [ + 'name' => $this->name, + 'type' => $this->type, + 'brand' => $this->brand, + 'billingAddress' => $this->billingAddress + ] + ); + } + /** * Encode this object to JSON * @@ -139,10 +158,10 @@ class GooglePayRequestCard implements \JsonSerializable $json['name'] = $this->name; } if (isset($this->type)) { - $json['type'] = CardType::checkValue($this->type); + $json['type'] = $this->type; } if (isset($this->brand)) { - $json['brand'] = CardBrand::checkValue($this->brand); + $json['brand'] = $this->brand; } if (isset($this->billingAddress)) { $json['billing_address'] = $this->billingAddress; diff --git a/src/Models/GooglePayWalletResponse.php b/src/Models/GooglePayWalletResponse.php index d359528..33a03b9 100644 --- a/src/Models/GooglePayWalletResponse.php +++ b/src/Models/GooglePayWalletResponse.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -59,10 +60,9 @@ class GooglePayWalletResponse implements \JsonSerializable /** * Returns Email Address. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. */ public function getEmailAddress(): ?string { @@ -71,10 +71,9 @@ class GooglePayWalletResponse implements \JsonSerializable /** * Sets Email Address. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. * * @maps email_address */ @@ -125,6 +124,24 @@ class GooglePayWalletResponse implements \JsonSerializable $this->card = $card; } + /** + * Converts the GooglePayWalletResponse object to a human-readable string representation. + * + * @return string The string representation of the GooglePayWalletResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'GooglePayWalletResponse', + [ + 'name' => $this->name, + 'emailAddress' => $this->emailAddress, + 'phoneNumber' => $this->phoneNumber, + 'card' => $this->card + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/IdealPaymentObject.php b/src/Models/IdealPaymentObject.php index 260ad38..8db4d88 100644 --- a/src/Models/IdealPaymentObject.php +++ b/src/Models/IdealPaymentObject.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -60,10 +61,9 @@ class IdealPaymentObject implements \JsonSerializable /** * Returns Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. */ public function getCountryCode(): ?string { @@ -73,10 +73,9 @@ class IdealPaymentObject implements \JsonSerializable /** * Sets Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. * * @maps country_code */ @@ -127,6 +126,24 @@ class IdealPaymentObject implements \JsonSerializable $this->ibanLastChars = $ibanLastChars; } + /** + * Converts the IdealPaymentObject object to a human-readable string representation. + * + * @return string The string representation of the IdealPaymentObject object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'IdealPaymentObject', + [ + 'name' => $this->name, + 'countryCode' => $this->countryCode, + 'bic' => $this->bic, + 'ibanLastChars' => $this->ibanLastChars + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/IdealPaymentRequest.php b/src/Models/IdealPaymentRequest.php index faffeda..657d41e 100644 --- a/src/Models/IdealPaymentRequest.php +++ b/src/Models/IdealPaymentRequest.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -71,10 +72,9 @@ class IdealPaymentRequest implements \JsonSerializable /** * Returns Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. */ public function getCountryCode(): string { @@ -84,10 +84,9 @@ class IdealPaymentRequest implements \JsonSerializable /** * Sets Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. * * @required * @maps country_code @@ -139,6 +138,24 @@ class IdealPaymentRequest implements \JsonSerializable $this->experienceContext = $experienceContext; } + /** + * Converts the IdealPaymentRequest object to a human-readable string representation. + * + * @return string The string representation of the IdealPaymentRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'IdealPaymentRequest', + [ + 'name' => $this->name, + 'countryCode' => $this->countryCode, + 'bic' => $this->bic, + 'experienceContext' => $this->experienceContext + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/Item.php b/src/Models/Item.php index 7d00519..a87701e 100644 --- a/src/Models/Item.php +++ b/src/Models/Item.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -284,6 +285,30 @@ class Item implements \JsonSerializable $this->upc = $upc; } + /** + * Converts the Item object to a human-readable string representation. + * + * @return string The string representation of the Item object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'Item', + [ + 'name' => $this->name, + 'unitAmount' => $this->unitAmount, + 'tax' => $this->tax, + 'quantity' => $this->quantity, + 'description' => $this->description, + 'sku' => $this->sku, + 'url' => $this->url, + 'category' => $this->category, + 'imageUrl' => $this->imageUrl, + 'upc' => $this->upc + ] + ); + } + /** * Encode this object to JSON * @@ -312,7 +337,7 @@ class Item implements \JsonSerializable $json['url'] = $this->url; } if (isset($this->category)) { - $json['category'] = ItemCategory::checkValue($this->category); + $json['category'] = $this->category; } if (isset($this->imageUrl)) { $json['image_url'] = $this->imageUrl; diff --git a/src/Models/ItemCategory.php b/src/Models/ItemCategory.php index 008e641..71fae77 100644 --- a/src/Models/ItemCategory.php +++ b/src/Models/ItemCategory.php @@ -10,38 +10,25 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The item category type. */ class ItemCategory { + /** + * Goods that are stored, delivered, and used in their electronic format. This value is not currently + * supported for API callers that leverage the PayPal for Commerce Platform product. + */ public const DIGITAL_GOODS = 'DIGITAL_GOODS'; + /** + * A tangible item that can be shipped with proof of delivery. + */ public const PHYSICAL_GOODS = 'PHYSICAL_GOODS'; - public const DONATION = 'DONATION'; - - private const _ALL_VALUES = [self::DIGITAL_GOODS, self::PHYSICAL_GOODS, self::DONATION]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * A contribution or gift for which no good or service is exchanged, usually to a not for profit + * organization. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for ItemCategory."); - } + public const DONATION = 'DONATION'; } diff --git a/src/Models/Level2CardProcessingData.php b/src/Models/Level2CardProcessingData.php index 92557c5..28bc258 100644 --- a/src/Models/Level2CardProcessingData.php +++ b/src/Models/Level2CardProcessingData.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -73,6 +74,19 @@ class Level2CardProcessingData implements \JsonSerializable $this->taxTotal = $taxTotal; } + /** + * Converts the Level2CardProcessingData object to a human-readable string representation. + * + * @return string The string representation of the Level2CardProcessingData object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'Level2CardProcessingData', + ['invoiceId' => $this->invoiceId, 'taxTotal' => $this->taxTotal] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/Level3CardProcessingData.php b/src/Models/Level3CardProcessingData.php index 4bfeaa6..7c8a973 100644 --- a/src/Models/Level3CardProcessingData.php +++ b/src/Models/Level3CardProcessingData.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -181,6 +182,26 @@ class Level3CardProcessingData implements \JsonSerializable $this->lineItems = $lineItems; } + /** + * Converts the Level3CardProcessingData object to a human-readable string representation. + * + * @return string The string representation of the Level3CardProcessingData object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'Level3CardProcessingData', + [ + 'shippingAmount' => $this->shippingAmount, + 'dutyAmount' => $this->dutyAmount, + 'discountAmount' => $this->discountAmount, + 'shippingAddress' => $this->shippingAddress, + 'shipsFromPostalCode' => $this->shipsFromPostalCode, + 'lineItems' => $this->lineItems + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/LiabilityShiftIndicator.php b/src/Models/LiabilityShiftIndicator.php index b3ace5b..f2e05de 100644 --- a/src/Models/LiabilityShiftIndicator.php +++ b/src/Models/LiabilityShiftIndicator.php @@ -10,38 +10,23 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * Liability shift indicator. The outcome of the issuer's authentication. */ class LiabilityShiftIndicator { + /** + * Liability is with the merchant. + */ public const NO = 'NO'; + /** + * Liability may shift to the card issuer. + */ public const POSSIBLE = 'POSSIBLE'; - public const UNKNOWN = 'UNKNOWN'; - - private const _ALL_VALUES = [self::NO, self::POSSIBLE, self::UNKNOWN]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * The authentication system is not available. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for LiabilityShiftIndicator."); - } + public const UNKNOWN = 'UNKNOWN'; } diff --git a/src/Models/LineItem.php b/src/Models/LineItem.php index 4d3ce56..fcd6af4 100644 --- a/src/Models/LineItem.php +++ b/src/Models/LineItem.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -369,6 +370,33 @@ class LineItem implements \JsonSerializable $this->unitOfMeasure = $unitOfMeasure; } + /** + * Converts the LineItem object to a human-readable string representation. + * + * @return string The string representation of the LineItem object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'LineItem', + [ + 'name' => $this->name, + 'quantity' => $this->quantity, + 'description' => $this->description, + 'sku' => $this->sku, + 'url' => $this->url, + 'imageUrl' => $this->imageUrl, + 'upc' => $this->upc, + 'unitAmount' => $this->unitAmount, + 'tax' => $this->tax, + 'commodityCode' => $this->commodityCode, + 'discountAmount' => $this->discountAmount, + 'totalAmount' => $this->totalAmount, + 'unitOfMeasure' => $this->unitOfMeasure + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/LinkDescription.php b/src/Models/LinkDescription.php index 4ff471f..5de3877 100644 --- a/src/Models/LinkDescription.php +++ b/src/Models/LinkDescription.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -114,6 +115,19 @@ class LinkDescription implements \JsonSerializable $this->method = $method; } + /** + * Converts the LinkDescription object to a human-readable string representation. + * + * @return string The string representation of the LinkDescription object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'LinkDescription', + ['href' => $this->href, 'rel' => $this->rel, 'method' => $this->method] + ); + } + /** * Encode this object to JSON * @@ -129,7 +143,7 @@ class LinkDescription implements \JsonSerializable $json['href'] = $this->href; $json['rel'] = $this->rel; if (isset($this->method)) { - $json['method'] = LinkHttpMethod::checkValue($this->method); + $json['method'] = $this->method; } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; diff --git a/src/Models/LinkHttpMethod.php b/src/Models/LinkHttpMethod.php index c5dd51d..c8c6f7a 100644 --- a/src/Models/LinkHttpMethod.php +++ b/src/Models/LinkHttpMethod.php @@ -10,10 +10,6 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The HTTP method required to make the related call. */ @@ -34,25 +30,4 @@ class LinkHttpMethod public const OPTIONS = 'OPTIONS'; public const PATCH = 'PATCH'; - - private const _ALL_VALUES = - [self::GET, self::POST, self::PUT, self::DELETE, self::HEAD, self::CONNECT, self::OPTIONS, self::PATCH]; - - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum - */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for LinkHttpMethod."); - } } diff --git a/src/Models/Money.php b/src/Models/Money.php index 5511511..9fd4aef 100644 --- a/src/Models/Money.php +++ b/src/Models/Money.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -62,10 +63,10 @@ class Money implements \JsonSerializable /** * Returns Value. - * The value, which might be:GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. */ public function getCountryCode(): ?string { @@ -73,10 +73,9 @@ class MybankPaymentObject implements \JsonSerializable /** * Sets Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. * * @maps country_code */ @@ -127,6 +126,24 @@ class MybankPaymentObject implements \JsonSerializable $this->ibanLastChars = $ibanLastChars; } + /** + * Converts the MybankPaymentObject object to a human-readable string representation. + * + * @return string The string representation of the MybankPaymentObject object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'MybankPaymentObject', + [ + 'name' => $this->name, + 'countryCode' => $this->countryCode, + 'bic' => $this->bic, + 'ibanLastChars' => $this->ibanLastChars + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/MybankPaymentRequest.php b/src/Models/MybankPaymentRequest.php index 1a757d0..427fe69 100644 --- a/src/Models/MybankPaymentRequest.php +++ b/src/Models/MybankPaymentRequest.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -66,10 +67,9 @@ class MybankPaymentRequest implements \JsonSerializable /** * Returns Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. */ public function getCountryCode(): string { @@ -79,10 +79,9 @@ class MybankPaymentRequest implements \JsonSerializable /** * Sets Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. * * @required * @maps country_code @@ -112,6 +111,23 @@ class MybankPaymentRequest implements \JsonSerializable $this->experienceContext = $experienceContext; } + /** + * Converts the MybankPaymentRequest object to a human-readable string representation. + * + * @return string The string representation of the MybankPaymentRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'MybankPaymentRequest', + [ + 'name' => $this->name, + 'countryCode' => $this->countryCode, + 'experienceContext' => $this->experienceContext + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/Name.php b/src/Models/Name.php index 0bac215..a21f9a2 100644 --- a/src/Models/Name.php +++ b/src/Models/Name.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -71,6 +72,16 @@ class Name implements \JsonSerializable $this->surname = $surname; } + /** + * Converts the Name object to a human-readable string representation. + * + * @return string The string representation of the Name object. + */ + public function __toString(): string + { + return ApiHelper::stringify('Name', ['givenName' => $this->givenName, 'surname' => $this->surname]); + } + /** * Encode this object to JSON * diff --git a/src/Models/NetAmountBreakdownItem.php b/src/Models/NetAmountBreakdownItem.php index be89f1b..3835e58 100644 --- a/src/Models/NetAmountBreakdownItem.php +++ b/src/Models/NetAmountBreakdownItem.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -93,6 +94,23 @@ class NetAmountBreakdownItem implements \JsonSerializable $this->exchangeRate = $exchangeRate; } + /** + * Converts the NetAmountBreakdownItem object to a human-readable string representation. + * + * @return string The string representation of the NetAmountBreakdownItem object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'NetAmountBreakdownItem', + [ + 'payableAmount' => $this->payableAmount, + 'convertedAmount' => $this->convertedAmount, + 'exchangeRate' => $this->exchangeRate + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/NetworkToken.php b/src/Models/NetworkToken.php index 076b5e2..b0ba0d2 100644 --- a/src/Models/NetworkToken.php +++ b/src/Models/NetworkToken.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -166,6 +167,25 @@ class NetworkToken implements \JsonSerializable $this->tokenRequestorId = $tokenRequestorId; } + /** + * Converts the NetworkToken object to a human-readable string representation. + * + * @return string The string representation of the NetworkToken object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'NetworkToken', + [ + 'number' => $this->number, + 'expiry' => $this->expiry, + 'cryptogram' => $this->cryptogram, + 'eciFlag' => $this->eciFlag, + 'tokenRequestorId' => $this->tokenRequestorId + ] + ); + } + /** * Encode this object to JSON * @@ -184,7 +204,7 @@ class NetworkToken implements \JsonSerializable $json['cryptogram'] = $this->cryptogram; } if (isset($this->eciFlag)) { - $json['eci_flag'] = EciFlag::checkValue($this->eciFlag); + $json['eci_flag'] = $this->eciFlag; } if (isset($this->tokenRequestorId)) { $json['token_requestor_id'] = $this->tokenRequestorId; diff --git a/src/Models/NetworkTransactionReference.php b/src/Models/NetworkTransactionReference.php index b573454..9957b89 100644 --- a/src/Models/NetworkTransactionReference.php +++ b/src/Models/NetworkTransactionReference.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -136,6 +137,24 @@ class NetworkTransactionReference implements \JsonSerializable $this->acquirerReferenceNumber = $acquirerReferenceNumber; } + /** + * Converts the NetworkTransactionReference object to a human-readable string representation. + * + * @return string The string representation of the NetworkTransactionReference object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'NetworkTransactionReference', + [ + 'id' => $this->id, + 'date' => $this->date, + 'network' => $this->network, + 'acquirerReferenceNumber' => $this->acquirerReferenceNumber + ] + ); + } + /** * Encode this object to JSON * @@ -153,7 +172,7 @@ class NetworkTransactionReference implements \JsonSerializable $json['date'] = $this->date; } if (isset($this->network)) { - $json['network'] = CardBrand::checkValue($this->network); + $json['network'] = $this->network; } if (isset($this->acquirerReferenceNumber)) { $json['acquirer_reference_number'] = $this->acquirerReferenceNumber; diff --git a/src/Models/NetworkTransactionReferenceEntity.php b/src/Models/NetworkTransactionReferenceEntity.php index 212bdec..26b9088 100644 --- a/src/Models/NetworkTransactionReferenceEntity.php +++ b/src/Models/NetworkTransactionReferenceEntity.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -117,8 +118,8 @@ class NetworkTransactionReferenceEntity implements \JsonSerializable /** * Returns Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getTime(): ?string { @@ -128,8 +129,8 @@ class NetworkTransactionReferenceEntity implements \JsonSerializable /** * Sets Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps time */ @@ -138,6 +139,19 @@ class NetworkTransactionReferenceEntity implements \JsonSerializable $this->time = $time; } + /** + * Converts the NetworkTransactionReferenceEntity object to a human-readable string representation. + * + * @return string The string representation of the NetworkTransactionReferenceEntity object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'NetworkTransactionReferenceEntity', + ['id' => $this->id, 'date' => $this->date, 'network' => $this->network, 'time' => $this->time] + ); + } + /** * Encode this object to JSON * @@ -155,7 +169,7 @@ class NetworkTransactionReferenceEntity implements \JsonSerializable $json['date'] = $this->date; } if (isset($this->network)) { - $json['network'] = CardBrand::checkValue($this->network); + $json['network'] = $this->network; } if (isset($this->time)) { $json['time'] = $this->time; diff --git a/src/Models/OneTimeCharge.php b/src/Models/OneTimeCharge.php new file mode 100644 index 0000000..4a512f1 --- /dev/null +++ b/src/Models/OneTimeCharge.php @@ -0,0 +1,231 @@ +totalAmount = $totalAmount; + } + + /** + * Returns Setup Fee. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getSetupFee(): ?Money + { + return $this->setupFee; + } + + /** + * Sets Setup Fee. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps setup_fee + */ + public function setSetupFee(?Money $setupFee): void + { + $this->setupFee = $setupFee; + } + + /** + * Returns Shipping Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getShippingAmount(): ?Money + { + return $this->shippingAmount; + } + + /** + * Sets Shipping Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps shipping_amount + */ + public function setShippingAmount(?Money $shippingAmount): void + { + $this->shippingAmount = $shippingAmount; + } + + /** + * Returns Taxes. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getTaxes(): ?Money + { + return $this->taxes; + } + + /** + * Sets Taxes. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps taxes + */ + public function setTaxes(?Money $taxes): void + { + $this->taxes = $taxes; + } + + /** + * Returns Product Price. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getProductPrice(): ?Money + { + return $this->productPrice; + } + + /** + * Sets Product Price. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps product_price + */ + public function setProductPrice(?Money $productPrice): void + { + $this->productPrice = $productPrice; + } + + /** + * Returns Subtotal. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getSubtotal(): ?Money + { + return $this->subtotal; + } + + /** + * Sets Subtotal. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps subtotal + */ + public function setSubtotal(?Money $subtotal): void + { + $this->subtotal = $subtotal; + } + + /** + * Returns Total Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getTotalAmount(): Money + { + return $this->totalAmount; + } + + /** + * Sets Total Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @required + * @maps total_amount + */ + public function setTotalAmount(Money $totalAmount): void + { + $this->totalAmount = $totalAmount; + } + + /** + * Converts the OneTimeCharge object to a human-readable string representation. + * + * @return string The string representation of the OneTimeCharge object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'OneTimeCharge', + [ + 'setupFee' => $this->setupFee, + 'shippingAmount' => $this->shippingAmount, + 'taxes' => $this->taxes, + 'productPrice' => $this->productPrice, + 'subtotal' => $this->subtotal, + 'totalAmount' => $this->totalAmount + ] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + if (isset($this->setupFee)) { + $json['setup_fee'] = $this->setupFee; + } + if (isset($this->shippingAmount)) { + $json['shipping_amount'] = $this->shippingAmount; + } + if (isset($this->taxes)) { + $json['taxes'] = $this->taxes; + } + if (isset($this->productPrice)) { + $json['product_price'] = $this->productPrice; + } + if (isset($this->subtotal)) { + $json['subtotal'] = $this->subtotal; + } + $json['total_amount'] = $this->totalAmount; + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/Order.php b/src/Models/Order.php index 99b453d..07c6b0c 100644 --- a/src/Models/Order.php +++ b/src/Models/Order.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -42,11 +43,6 @@ class Order implements \JsonSerializable */ private $intent; - /** - * @var mixed - */ - private $processingInstruction; - /** * @var Payer|null */ @@ -70,8 +66,8 @@ class Order implements \JsonSerializable /** * Returns Create Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getCreateTime(): ?string { @@ -81,8 +77,8 @@ class Order implements \JsonSerializable /** * Sets Create Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps create_time */ @@ -94,8 +90,8 @@ class Order implements \JsonSerializable /** * Returns Update Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getUpdateTime(): ?string { @@ -105,8 +101,8 @@ class Order implements \JsonSerializable /** * Sets Update Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps update_time */ @@ -177,28 +173,6 @@ class Order implements \JsonSerializable $this->intent = $intent; } - /** - * Returns Processing Instruction. - * - * @return mixed - */ - public function getProcessingInstruction() - { - return $this->processingInstruction; - } - - /** - * Sets Processing Instruction. - * - * @maps processing_instruction - * - * @param mixed $processingInstruction - */ - public function setProcessingInstruction($processingInstruction): void - { - $this->processingInstruction = $processingInstruction; - } - /** * Returns Payer. */ @@ -303,6 +277,29 @@ class Order implements \JsonSerializable $this->links = $links; } + /** + * Converts the Order object to a human-readable string representation. + * + * @return string The string representation of the Order object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'Order', + [ + 'createTime' => $this->createTime, + 'updateTime' => $this->updateTime, + 'id' => $this->id, + 'paymentSource' => $this->paymentSource, + 'intent' => $this->intent, + 'payer' => $this->payer, + 'purchaseUnits' => $this->purchaseUnits, + 'status' => $this->status, + 'links' => $this->links + ] + ); + } + /** * Encode this object to JSON * @@ -316,34 +313,31 @@ class Order implements \JsonSerializable { $json = []; if (isset($this->createTime)) { - $json['create_time'] = $this->createTime; + $json['create_time'] = $this->createTime; } if (isset($this->updateTime)) { - $json['update_time'] = $this->updateTime; + $json['update_time'] = $this->updateTime; } if (isset($this->id)) { - $json['id'] = $this->id; + $json['id'] = $this->id; } if (isset($this->paymentSource)) { - $json['payment_source'] = $this->paymentSource; + $json['payment_source'] = $this->paymentSource; } if (isset($this->intent)) { - $json['intent'] = CheckoutPaymentIntent::checkValue($this->intent); - } - if (isset($this->processingInstruction)) { - $json['processing_instruction'] = $this->processingInstruction; + $json['intent'] = $this->intent; } if (isset($this->payer)) { - $json['payer'] = $this->payer; + $json['payer'] = $this->payer; } if (isset($this->purchaseUnits)) { - $json['purchase_units'] = $this->purchaseUnits; + $json['purchase_units'] = $this->purchaseUnits; } if (isset($this->status)) { - $json['status'] = OrderStatus::checkValue($this->status); + $json['status'] = $this->status; } if (isset($this->links)) { - $json['links'] = $this->links; + $json['links'] = $this->links; } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; diff --git a/src/Models/OrderApplicationContext.php b/src/Models/OrderApplicationContext.php index b95ebd3..7730d16 100644 --- a/src/Models/OrderApplicationContext.php +++ b/src/Models/OrderApplicationContext.php @@ -10,13 +10,13 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** - * Customizes the payer experience during the approval process for the payment with PayPal. - *
Note: Partners and Marketplaces might configure+ * Customizes the payer experience during the approval process for the payment with PayPal. Note: + * Partners and Marketplaces might configure brand_name and shipping_preference during partner account + * setup, which overrides the request values. */ class OrderApplicationContext implements \JsonSerializable { @@ -153,13 +153,12 @@ class OrderApplicationContext implements \JsonSerializable /** * Returns Shipping Preference. - * DEPRECATED. DEPRECATED. The shipping preference:brand_name- * andshipping_preferenceduring partner account setup, which overrides the request - * values.
Note: - * Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance. - *+ * The payment card to use to fund a payment. Can be a credit or debit card. Note: Passing card number, + * cvv and expiry directly via the API requires PCI SAQ D compliance. *PayPal offers a mechanism by + * which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this + * Integration Guide*. */ public function getCard(): ?CardRequest { @@ -63,12 +62,10 @@ class OrderAuthorizeRequestPaymentSource implements \JsonSerializable /** * Sets Card. - * The payment card to use to fund a payment. Can be a credit or debit card.
*PayPal offers a mechanism by which you do not have to take on the PCI SAQ D - * burden by using hosted fields - refer to this Integration Guide*.
Note: - * Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance. - *+ * The payment card to use to fund a payment. Can be a credit or debit card. Note: Passing card number, + * cvv and expiry directly via the API requires PCI SAQ D compliance. *PayPal offers a mechanism by + * which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this + * Integration Guide*. * * @maps card */ @@ -177,6 +174,26 @@ class OrderAuthorizeRequestPaymentSource implements \JsonSerializable $this->venmo = $venmo; } + /** + * Converts the OrderAuthorizeRequestPaymentSource object to a human-readable string representation. + * + * @return string The string representation of the OrderAuthorizeRequestPaymentSource object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'OrderAuthorizeRequestPaymentSource', + [ + 'card' => $this->card, + 'token' => $this->token, + 'paypal' => $this->paypal, + 'applePay' => $this->applePay, + 'googlePay' => $this->googlePay, + 'venmo' => $this->venmo + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/OrderAuthorizeResponse.php b/src/Models/OrderAuthorizeResponse.php index 5a79916..58b0619 100644 --- a/src/Models/OrderAuthorizeResponse.php +++ b/src/Models/OrderAuthorizeResponse.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; class OrderAuthorizeResponse implements \JsonSerializable @@ -39,11 +40,6 @@ class OrderAuthorizeResponse implements \JsonSerializable */ private $intent; - /** - * @var mixed - */ - private $processingInstruction; - /** * @var Payer|null */ @@ -67,8 +63,8 @@ class OrderAuthorizeResponse implements \JsonSerializable /** * Returns Create Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
*PayPal offers a mechanism by which you do not have to take on the PCI SAQ D - * burden by using hosted fields - refer to this Integration Guide*.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getCreateTime(): ?string { @@ -78,8 +74,8 @@ class OrderAuthorizeResponse implements \JsonSerializable /** * Sets Create Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps create_time */ @@ -91,8 +87,8 @@ class OrderAuthorizeResponse implements \JsonSerializable /** * Returns Update Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getUpdateTime(): ?string { @@ -102,8 +98,8 @@ class OrderAuthorizeResponse implements \JsonSerializable /** * Sets Update Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps update_time */ @@ -174,28 +170,6 @@ class OrderAuthorizeResponse implements \JsonSerializable $this->intent = $intent; } - /** - * Returns Processing Instruction. - * - * @return mixed - */ - public function getProcessingInstruction() - { - return $this->processingInstruction; - } - - /** - * Sets Processing Instruction. - * - * @maps processing_instruction - * - * @param mixed $processingInstruction - */ - public function setProcessingInstruction($processingInstruction): void - { - $this->processingInstruction = $processingInstruction; - } - /** * Returns Payer. */ @@ -288,6 +262,29 @@ class OrderAuthorizeResponse implements \JsonSerializable $this->links = $links; } + /** + * Converts the OrderAuthorizeResponse object to a human-readable string representation. + * + * @return string The string representation of the OrderAuthorizeResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'OrderAuthorizeResponse', + [ + 'createTime' => $this->createTime, + 'updateTime' => $this->updateTime, + 'id' => $this->id, + 'paymentSource' => $this->paymentSource, + 'intent' => $this->intent, + 'payer' => $this->payer, + 'purchaseUnits' => $this->purchaseUnits, + 'status' => $this->status, + 'links' => $this->links + ] + ); + } + /** * Encode this object to JSON * @@ -301,34 +298,31 @@ class OrderAuthorizeResponse implements \JsonSerializable { $json = []; if (isset($this->createTime)) { - $json['create_time'] = $this->createTime; + $json['create_time'] = $this->createTime; } if (isset($this->updateTime)) { - $json['update_time'] = $this->updateTime; + $json['update_time'] = $this->updateTime; } if (isset($this->id)) { - $json['id'] = $this->id; + $json['id'] = $this->id; } if (isset($this->paymentSource)) { - $json['payment_source'] = $this->paymentSource; + $json['payment_source'] = $this->paymentSource; } if (isset($this->intent)) { - $json['intent'] = CheckoutPaymentIntent::checkValue($this->intent); - } - if (isset($this->processingInstruction)) { - $json['processing_instruction'] = $this->processingInstruction; + $json['intent'] = $this->intent; } if (isset($this->payer)) { - $json['payer'] = $this->payer; + $json['payer'] = $this->payer; } if (isset($this->purchaseUnits)) { - $json['purchase_units'] = $this->purchaseUnits; + $json['purchase_units'] = $this->purchaseUnits; } if (isset($this->status)) { - $json['status'] = OrderStatus::checkValue($this->status); + $json['status'] = $this->status; } if (isset($this->links)) { - $json['links'] = $this->links; + $json['links'] = $this->links; } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; diff --git a/src/Models/OrderAuthorizeResponsePaymentSource.php b/src/Models/OrderAuthorizeResponsePaymentSource.php index 7a2ba49..0d526c1 100644 --- a/src/Models/OrderAuthorizeResponsePaymentSource.php +++ b/src/Models/OrderAuthorizeResponsePaymentSource.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -142,6 +143,25 @@ class OrderAuthorizeResponsePaymentSource implements \JsonSerializable $this->venmo = $venmo; } + /** + * Converts the OrderAuthorizeResponsePaymentSource object to a human-readable string representation. + * + * @return string The string representation of the OrderAuthorizeResponsePaymentSource object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'OrderAuthorizeResponsePaymentSource', + [ + 'card' => $this->card, + 'paypal' => $this->paypal, + 'applePay' => $this->applePay, + 'googlePay' => $this->googlePay, + 'venmo' => $this->venmo + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/OrderCaptureRequest.php b/src/Models/OrderCaptureRequest.php index 5204266..89442ef 100644 --- a/src/Models/OrderCaptureRequest.php +++ b/src/Models/OrderCaptureRequest.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -42,6 +43,16 @@ class OrderCaptureRequest implements \JsonSerializable $this->paymentSource = $paymentSource; } + /** + * Converts the OrderCaptureRequest object to a human-readable string representation. + * + * @return string The string representation of the OrderCaptureRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify('OrderCaptureRequest', ['paymentSource' => $this->paymentSource]); + } + /** * Encode this object to JSON * diff --git a/src/Models/OrderCaptureRequestPaymentSource.php b/src/Models/OrderCaptureRequestPaymentSource.php index e3c2e50..0a65def 100644 --- a/src/Models/OrderCaptureRequestPaymentSource.php +++ b/src/Models/OrderCaptureRequestPaymentSource.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -49,12 +50,10 @@ class OrderCaptureRequestPaymentSource implements \JsonSerializable /** * Returns Card. - * The payment card to use to fund a payment. Can be a credit or debit card.
Note: - * Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance. - *+ * The payment card to use to fund a payment. Can be a credit or debit card. Note: Passing card number, + * cvv and expiry directly via the API requires PCI SAQ D compliance. *PayPal offers a mechanism by + * which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this + * Integration Guide*. */ public function getCard(): ?CardRequest { @@ -63,12 +62,10 @@ class OrderCaptureRequestPaymentSource implements \JsonSerializable /** * Sets Card. - * The payment card to use to fund a payment. Can be a credit or debit card.
*PayPal offers a mechanism by which you do not have to take on the PCI SAQ D - * burden by using hosted fields - refer to this Integration Guide*.
Note: - * Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance. - *+ * The payment card to use to fund a payment. Can be a credit or debit card. Note: Passing card number, + * cvv and expiry directly via the API requires PCI SAQ D compliance. *PayPal offers a mechanism by + * which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this + * Integration Guide*. * * @maps card */ @@ -177,6 +174,26 @@ class OrderCaptureRequestPaymentSource implements \JsonSerializable $this->venmo = $venmo; } + /** + * Converts the OrderCaptureRequestPaymentSource object to a human-readable string representation. + * + * @return string The string representation of the OrderCaptureRequestPaymentSource object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'OrderCaptureRequestPaymentSource', + [ + 'card' => $this->card, + 'token' => $this->token, + 'paypal' => $this->paypal, + 'applePay' => $this->applePay, + 'googlePay' => $this->googlePay, + 'venmo' => $this->venmo + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/OrderConfirmApplicationContext.php b/src/Models/OrderConfirmApplicationContext.php index 2ac6418..6d35301 100644 --- a/src/Models/OrderConfirmApplicationContext.php +++ b/src/Models/OrderConfirmApplicationContext.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -135,13 +136,12 @@ class OrderConfirmApplicationContext implements \JsonSerializable /** * Returns Stored Payment Source. * Provides additional details to process a payment using a `payment_source` that has been stored or is - * intended to be stored (also referred to as stored_credential or card-on-file).
*PayPal offers a mechanism by which you do not have to take on the PCI SAQ D - * burden by using hosted fields - refer to this Integration Guide*.
Note: Partners and Marketplaces might configure+ * Customizes the payer experience during the approval process for the payment with PayPal. Note: + * Partners and Marketplaces might configure brand_name and shipping_preference during partner account + * setup, which overrides the request values. */ public function getApplicationContext(): ?OrderApplicationContext { @@ -156,10 +156,9 @@ class OrderRequest implements \JsonSerializable /** * Sets Application Context. - * Customizes the payer experience during the approval process for the payment with PayPal. - *brand_name- * andshipping_preferenceduring partner account setup, which overrides the request - * values.
Note: Partners and Marketplaces might configure+ * Customizes the payer experience during the approval process for the payment with PayPal. Note: + * Partners and Marketplaces might configure brand_name and shipping_preference during partner account + * setup, which overrides the request values. * * @maps application_context */ @@ -168,6 +167,25 @@ class OrderRequest implements \JsonSerializable $this->applicationContext = $applicationContext; } + /** + * Converts the OrderRequest object to a human-readable string representation. + * + * @return string The string representation of the OrderRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'OrderRequest', + [ + 'intent' => $this->intent, + 'payer' => $this->payer, + 'purchaseUnits' => $this->purchaseUnits, + 'paymentSource' => $this->paymentSource, + 'applicationContext' => $this->applicationContext + ] + ); + } + /** * Encode this object to JSON * @@ -180,7 +198,7 @@ class OrderRequest implements \JsonSerializable public function jsonSerialize(bool $asArrayWhenEmpty = false) { $json = []; - $json['intent'] = CheckoutPaymentIntent::checkValue($this->intent); + $json['intent'] = $this->intent; if (isset($this->payer)) { $json['payer'] = $this->payer; } diff --git a/src/Models/OrderStatus.php b/src/Models/OrderStatus.php index 5e6120a..06b6eb1 100644 --- a/src/Models/OrderStatus.php +++ b/src/Models/OrderStatus.php @@ -10,45 +10,47 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The order status. */ class OrderStatus { + /** + * The order was created with the specified context. + */ public const CREATED = 'CREATED'; + /** + * The order was saved and persisted. The order status continues to be in progress until a capture is + * made with final_capture = true for all purchase units within the order. + */ public const SAVED = 'SAVED'; + /** + * The customer approved the payment through the PayPal wallet or another form of guest or unbranded + * payment. For example, a card, bank account, or so on. + */ public const APPROVED = 'APPROVED'; + /** + * All purchase units in the order are voided. + */ public const VOIDED = 'VOIDED'; + /** + * The intent of the Order was completed and a `payments` resource was created. A completed Order may + * have authorized a payment, captured an authorized payment, or in some cases, the payment may have + * been declined. Please verify the payment status under purchase_unitsArray.payments before proceeding + * with Order fulfillment. + */ public const COMPLETED = 'COMPLETED'; - public const PAYER_ACTION_REQUIRED = 'PAYER_ACTION_REQUIRED'; - - private const _ALL_VALUES = - [self::CREATED, self::SAVED, self::APPROVED, self::VOIDED, self::COMPLETED, self::PAYER_ACTION_REQUIRED]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * The order requires an action from the payer (e.g. 3DS authentication). Redirect the payer to the + * "rel":"payer-action" HATEOAS link returned as part of the response prior to authorizing or capturing + * the order. Some payment sources may not return a payer-action HATEOAS link (eg. MB WAY). For these + * payment sources the payer-action is managed by the scheme itself (eg. through SMS, email, in-app + * notification, etc). */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for OrderStatus."); - } + public const PAYER_ACTION_REQUIRED = 'PAYER_ACTION_REQUIRED'; } diff --git a/src/Models/OrderTrackerItem.php b/src/Models/OrderTrackerItem.php index 05bb9db..7a2de55 100644 --- a/src/Models/OrderTrackerItem.php +++ b/src/Models/OrderTrackerItem.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -169,6 +170,26 @@ class OrderTrackerItem implements \JsonSerializable $this->upc = $upc; } + /** + * Converts the OrderTrackerItem object to a human-readable string representation. + * + * @return string The string representation of the OrderTrackerItem object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'OrderTrackerItem', + [ + 'name' => $this->name, + 'quantity' => $this->quantity, + 'sku' => $this->sku, + 'url' => $this->url, + 'imageUrl' => $this->imageUrl, + 'upc' => $this->upc + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/OrderTrackerRequest.php b/src/Models/OrderTrackerRequest.php index 4a77742..b741d2f 100644 --- a/src/Models/OrderTrackerRequest.php +++ b/src/Models/OrderTrackerRequest.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -81,8 +82,7 @@ class OrderTrackerRequest implements \JsonSerializable * subsidiaries are repeated over many countries and might also have an entry in the global list. * Choose the carrier for your country. If the carrier is not available for your country, choose the * global version of the carrier. If your carrier name is not in the list, set `carrier` to `OTHER` and - * set carrier name in `carrier_name_other`. For allowed values, see Carriers. + * set carrier name in `carrier_name_other`. For allowed values, see Carriers. */ public function getCarrier(): ?string { @@ -95,8 +95,7 @@ class OrderTrackerRequest implements \JsonSerializable * subsidiaries are repeated over many countries and might also have an entry in the global list. * Choose the carrier for your country. If the carrier is not available for your country, choose the * global version of the carrier. If your carrier name is not in the list, set `carrier` to `OTHER` and - * set carrier name in `carrier_name_other`. For allowed values, see Carriers. + * set carrier name in `carrier_name_other`. For allowed values, see Carriers. * * @maps carrier */ @@ -150,8 +149,10 @@ class OrderTrackerRequest implements \JsonSerializable /** * Returns Notify Payer. - * If true, sends an email notification to the payer of the PayPal transaction. The email contains the - * tracking information that was uploaded through the API. + * If true, PayPal will send an email notification to the payer of the PayPal transaction. The email + * contains the tracking details provided through the Orders tracking API request. Independent of any + * value passed for `notify_payer`, the payer may receive tracking notifications within the PayPal app, + * based on the user's notification preferences. */ public function getNotifyPayer(): ?bool { @@ -160,8 +161,10 @@ class OrderTrackerRequest implements \JsonSerializable /** * Sets Notify Payer. - * If true, sends an email notification to the payer of the PayPal transaction. The email contains the - * tracking information that was uploaded through the API. + * If true, PayPal will send an email notification to the payer of the PayPal transaction. The email + * contains the tracking details provided through the Orders tracking API request. Independent of any + * value passed for `notify_payer`, the payer may receive tracking notifications within the PayPal app, + * based on the user's notification preferences. * * @maps notify_payer */ @@ -194,6 +197,26 @@ class OrderTrackerRequest implements \JsonSerializable $this->items = $items; } + /** + * Converts the OrderTrackerRequest object to a human-readable string representation. + * + * @return string The string representation of the OrderTrackerRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'OrderTrackerRequest', + [ + 'trackingNumber' => $this->trackingNumber, + 'carrier' => $this->carrier, + 'carrierNameOther' => $this->carrierNameOther, + 'captureId' => $this->captureId, + 'notifyPayer' => $this->notifyPayer, + 'items' => $this->items + ] + ); + } + /** * Encode this object to JSON * @@ -210,7 +233,7 @@ class OrderTrackerRequest implements \JsonSerializable $json['tracking_number'] = $this->trackingNumber; } if (isset($this->carrier)) { - $json['carrier'] = ShipmentCarrier::checkValue($this->carrier); + $json['carrier'] = $this->carrier; } if (isset($this->carrierNameOther)) { $json['carrier_name_other'] = $this->carrierNameOther; diff --git a/src/Models/OrderTrackerResponse.php b/src/Models/OrderTrackerResponse.php index 135a428..2380416 100644 --- a/src/Models/OrderTrackerResponse.php +++ b/src/Models/OrderTrackerResponse.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -138,8 +139,8 @@ class OrderTrackerResponse implements \JsonSerializable /** * Returns Create Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.brand_name- * andshipping_preferenceduring partner account setup, which overrides the request - * values.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getCreateTime(): ?string { @@ -149,8 +150,8 @@ class OrderTrackerResponse implements \JsonSerializable /** * Sets Create Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps create_time */ @@ -162,8 +163,8 @@ class OrderTrackerResponse implements \JsonSerializable /** * Returns Update Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getUpdateTime(): ?string { @@ -173,8 +174,8 @@ class OrderTrackerResponse implements \JsonSerializable /** * Sets Update Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps update_time */ @@ -183,6 +184,26 @@ class OrderTrackerResponse implements \JsonSerializable $this->updateTime = $updateTime; } + /** + * Converts the OrderTrackerResponse object to a human-readable string representation. + * + * @return string The string representation of the OrderTrackerResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'OrderTrackerResponse', + [ + 'id' => $this->id, + 'status' => $this->status, + 'items' => $this->items, + 'links' => $this->links, + 'createTime' => $this->createTime, + 'updateTime' => $this->updateTime + ] + ); + } + /** * Encode this object to JSON * @@ -199,7 +220,7 @@ class OrderTrackerResponse implements \JsonSerializable $json['id'] = $this->id; } if (isset($this->status)) { - $json['status'] = OrderTrackerStatus::checkValue($this->status); + $json['status'] = $this->status; } if (isset($this->items)) { $json['items'] = $this->items; diff --git a/src/Models/OrderTrackerStatus.php b/src/Models/OrderTrackerStatus.php index 217efac..233398c 100644 --- a/src/Models/OrderTrackerStatus.php +++ b/src/Models/OrderTrackerStatus.php @@ -10,36 +10,20 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The status of the item shipment. */ class OrderTrackerStatus { + /** + * The shipment was cancelled and the tracking number no longer applies. + */ public const CANCELLED = 'CANCELLED'; - public const SHIPPED = 'SHIPPED'; - - private const _ALL_VALUES = [self::CANCELLED, self::SHIPPED]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * The merchant has assigned a tracking number to the items being shipped from the Order. This does not + * correspond to the carrier's actual status for the shipment. The latest status of the parcel must be + * retrieved from the carrier. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for OrderTrackerStatus."); - } + public const SHIPPED = 'SHIPPED'; } diff --git a/src/Models/OrderUpdateCallbackErrorResponse.php b/src/Models/OrderUpdateCallbackErrorResponse.php new file mode 100644 index 0000000..2d77610 --- /dev/null +++ b/src/Models/OrderUpdateCallbackErrorResponse.php @@ -0,0 +1,144 @@ +name = $name; + } + + /** + * Returns Name. + * The human-readable, unique name of the error. + */ + public function getName(): string + { + return $this->name; + } + + /** + * Sets Name. + * The human-readable, unique name of the error. + * + * @required + * @maps name + */ + public function setName(string $name): void + { + $this->name = $name; + } + + /** + * Returns Message. + * The message that describes the error. + */ + public function getMessage(): ?string + { + return $this->message; + } + + /** + * Sets Message. + * The message that describes the error. + * + * @maps message + */ + public function setMessage(?string $message): void + { + $this->message = $message; + } + + /** + * Returns Details. + * An array of additional details about the error. + * + * @return OrderUpdateCallbackErrorResponseDetails[]|null + */ + public function getDetails(): ?array + { + return $this->details; + } + + /** + * Sets Details. + * An array of additional details about the error. + * + * @maps details + * + * @param OrderUpdateCallbackErrorResponseDetails[]|null $details + */ + public function setDetails(?array $details): void + { + $this->details = $details; + } + + /** + * Converts the OrderUpdateCallbackErrorResponse object to a human-readable string representation. + * + * @return string The string representation of the OrderUpdateCallbackErrorResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'OrderUpdateCallbackErrorResponse', + ['name' => $this->name, 'message' => $this->message, 'details' => $this->details] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + $json['name'] = $this->name; + if (isset($this->message)) { + $json['message'] = $this->message; + } + if (isset($this->details)) { + $json['details'] = $this->details; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/OrderUpdateCallbackErrorResponseDetails.php b/src/Models/OrderUpdateCallbackErrorResponseDetails.php new file mode 100644 index 0000000..8f28fff --- /dev/null +++ b/src/Models/OrderUpdateCallbackErrorResponseDetails.php @@ -0,0 +1,143 @@ +issue = $issue; + } + + /** + * Returns Field. + * The field that caused the error. If this field is in the body, set this value to the field's JSON + * pointer value. Required for client-side errors. + */ + public function getField(): ?string + { + return $this->field; + } + + /** + * Sets Field. + * The field that caused the error. If this field is in the body, set this value to the field's JSON + * pointer value. Required for client-side errors. + * + * @maps field + */ + public function setField(?string $field): void + { + $this->field = $field; + } + + /** + * Returns Value. + * The value of the field that caused the error. + */ + public function getValue(): ?string + { + return $this->value; + } + + /** + * Sets Value. + * The value of the field that caused the error. + * + * @maps value + */ + public function setValue(?string $value): void + { + $this->value = $value; + } + + /** + * Returns Issue. + * The unique, fine-grained application-level error code. + */ + public function getIssue(): string + { + return $this->issue; + } + + /** + * Sets Issue. + * The unique, fine-grained application-level error code. + * + * @required + * @maps issue + */ + public function setIssue(string $issue): void + { + $this->issue = $issue; + } + + /** + * Converts the OrderUpdateCallbackErrorResponseDetails object to a human-readable string + * representation. + * + * @return string The string representation of the OrderUpdateCallbackErrorResponseDetails object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'OrderUpdateCallbackErrorResponseDetails', + ['field' => $this->field, 'value' => $this->value, 'issue' => $this->issue] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + if (isset($this->field)) { + $json['field'] = $this->field; + } + if (isset($this->value)) { + $json['value'] = $this->value; + } + $json['issue'] = $this->issue; + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/OrderUpdateCallbackRequest.php b/src/Models/OrderUpdateCallbackRequest.php new file mode 100644 index 0000000..b0b44d1 --- /dev/null +++ b/src/Models/OrderUpdateCallbackRequest.php @@ -0,0 +1,188 @@ +shippingAddress = $shippingAddress; + $this->purchaseUnits = $purchaseUnits; + } + + /** + * Returns Id. + * The ID of the order. + */ + public function getId(): ?string + { + return $this->id; + } + + /** + * Sets Id. + * The ID of the order. + * + * @maps id + */ + public function setId(?string $id): void + { + $this->id = $id; + } + + /** + * Returns Shipping Address. + * The portable international postal address. Maps to [AddressValidationMetadata](https://github. + * com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form + * controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form- + * controls-the-autocomplete-attribute). + */ + public function getShippingAddress(): OrderUpdateCallbackShippingAddress + { + return $this->shippingAddress; + } + + /** + * Sets Shipping Address. + * The portable international postal address. Maps to [AddressValidationMetadata](https://github. + * com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form + * controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form- + * controls-the-autocomplete-attribute). + * + * @required + * @maps shipping_address + */ + public function setShippingAddress(OrderUpdateCallbackShippingAddress $shippingAddress): void + { + $this->shippingAddress = $shippingAddress; + } + + /** + * Returns Shipping Option. + * The options that the payee or merchant offers to the payer to ship or pick up their items. + */ + public function getShippingOption(): ?OrderUpdateCallbackShippingOption + { + return $this->shippingOption; + } + + /** + * Sets Shipping Option. + * The options that the payee or merchant offers to the payer to ship or pick up their items. + * + * @maps shipping_option + */ + public function setShippingOption(?OrderUpdateCallbackShippingOption $shippingOption): void + { + $this->shippingOption = $shippingOption; + } + + /** + * Returns Purchase Units. + * An array of purchase units. At present only 1 purchase_unit is supported. Each purchase unit + * establishes a contract between a payer and the payee. Each purchase unit represents either a full or + * partial order that the payer intends to purchase from the payee. + * + * @return PurchaseUnitRequest[] + */ + public function getPurchaseUnits(): array + { + return $this->purchaseUnits; + } + + /** + * Sets Purchase Units. + * An array of purchase units. At present only 1 purchase_unit is supported. Each purchase unit + * establishes a contract between a payer and the payee. Each purchase unit represents either a full or + * partial order that the payer intends to purchase from the payee. + * + * @required + * @maps purchase_units + * + * @param PurchaseUnitRequest[] $purchaseUnits + */ + public function setPurchaseUnits(array $purchaseUnits): void + { + $this->purchaseUnits = $purchaseUnits; + } + + /** + * Converts the OrderUpdateCallbackRequest object to a human-readable string representation. + * + * @return string The string representation of the OrderUpdateCallbackRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'OrderUpdateCallbackRequest', + [ + 'id' => $this->id, + 'shippingAddress' => $this->shippingAddress, + 'shippingOption' => $this->shippingOption, + 'purchaseUnits' => $this->purchaseUnits + ] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + if (isset($this->id)) { + $json['id'] = $this->id; + } + $json['shipping_address'] = $this->shippingAddress; + if (isset($this->shippingOption)) { + $json['shipping_option'] = $this->shippingOption; + } + $json['purchase_units'] = $this->purchaseUnits; + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/OrderUpdateCallbackResponse.php b/src/Models/OrderUpdateCallbackResponse.php new file mode 100644 index 0000000..509e127 --- /dev/null +++ b/src/Models/OrderUpdateCallbackResponse.php @@ -0,0 +1,105 @@ +id; + } + + /** + * Sets Id. + * The ID of the order. + * + * @maps id + */ + public function setId(?string $id): void + { + $this->id = $id; + } + + /** + * Returns Purchase Units. + * This would contain shipping option and amount data at purchase unit level. + */ + public function getPurchaseUnits(): ?ShippingOptionsPurchaseUnit + { + return $this->purchaseUnits; + } + + /** + * Sets Purchase Units. + * This would contain shipping option and amount data at purchase unit level. + * + * @maps purchase_units + */ + public function setPurchaseUnits(?ShippingOptionsPurchaseUnit $purchaseUnits): void + { + $this->purchaseUnits = $purchaseUnits; + } + + /** + * Converts the OrderUpdateCallbackResponse object to a human-readable string representation. + * + * @return string The string representation of the OrderUpdateCallbackResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'OrderUpdateCallbackResponse', + ['id' => $this->id, 'purchaseUnits' => $this->purchaseUnits] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + if (isset($this->id)) { + $json['id'] = $this->id; + } + if (isset($this->purchaseUnits)) { + $json['purchase_units'] = $this->purchaseUnits; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/OrderUpdateCallbackShippingAddress.php b/src/Models/OrderUpdateCallbackShippingAddress.php new file mode 100644 index 0000000..44602b2 --- /dev/null +++ b/src/Models/OrderUpdateCallbackShippingAddress.php @@ -0,0 +1,190 @@ +countryCode = $countryCode; + } + + /** + * Returns Admin Area 2. + * A city, town, or village. Smaller than `admin_area_level_1`. + */ + public function getAdminArea2(): ?string + { + return $this->adminArea2; + } + + /** + * Sets Admin Area 2. + * A city, town, or village. Smaller than `admin_area_level_1`. + * + * @maps admin_area_2 + */ + public function setAdminArea2(?string $adminArea2): void + { + $this->adminArea2 = $adminArea2; + } + + /** + * Returns Admin Area 1. + * The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 + * subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. + * Value, by country, is: UK. A county. US. A state. Canada. A province. Japan. A prefecture. + * Switzerland. A *kanton*. + */ + public function getAdminArea1(): ?string + { + return $this->adminArea1; + } + + /** + * Sets Admin Area 1. + * The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 + * subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. + * Value, by country, is: UK. A county. US. A state. Canada. A province. Japan. A prefecture. + * Switzerland. A *kanton*. + * + * @maps admin_area_1 + */ + public function setAdminArea1(?string $adminArea1): void + { + $this->adminArea1 = $adminArea1; + } + + /** + * Returns Postal Code. + * The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal + * code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code). + */ + public function getPostalCode(): ?string + { + return $this->postalCode; + } + + /** + * Sets Postal Code. + * The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal + * code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code). + * + * @maps postal_code + */ + public function setPostalCode(?string $postalCode): void + { + $this->postalCode = $postalCode; + } + + /** + * Returns Country Code. + * The [2-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or + * region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. + */ + public function getCountryCode(): string + { + return $this->countryCode; + } + + /** + * Sets Country Code. + * The [2-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or + * region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. + * + * @required + * @maps country_code + */ + public function setCountryCode(string $countryCode): void + { + $this->countryCode = $countryCode; + } + + /** + * Converts the OrderUpdateCallbackShippingAddress object to a human-readable string representation. + * + * @return string The string representation of the OrderUpdateCallbackShippingAddress object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'OrderUpdateCallbackShippingAddress', + [ + 'adminArea2' => $this->adminArea2, + 'adminArea1' => $this->adminArea1, + 'postalCode' => $this->postalCode, + 'countryCode' => $this->countryCode + ] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + if (isset($this->adminArea2)) { + $json['admin_area_2'] = $this->adminArea2; + } + if (isset($this->adminArea1)) { + $json['admin_area_1'] = $this->adminArea1; + } + if (isset($this->postalCode)) { + $json['postal_code'] = $this->postalCode; + } + $json['country_code'] = $this->countryCode; + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/OrderUpdateCallbackShippingOption.php b/src/Models/OrderUpdateCallbackShippingOption.php new file mode 100644 index 0000000..8fd8c68 --- /dev/null +++ b/src/Models/OrderUpdateCallbackShippingOption.php @@ -0,0 +1,173 @@ +id = $id; + $this->label = $label; + } + + /** + * Returns Id. + * A unique ID that identifies a payer-selected shipping option. + */ + public function getId(): string + { + return $this->id; + } + + /** + * Sets Id. + * A unique ID that identifies a payer-selected shipping option. + * + * @required + * @maps id + */ + public function setId(string $id): void + { + $this->id = $id; + } + + /** + * Returns Label. + * A description that the payer sees, which helps them choose an appropriate shipping option. For + * example, `Free Shipping`, `USPS Priority Shipping`, `Expédition prioritaire USPS`, or `USPS yōuxiān + * fā huò`. Localize this description to the payer's locale. + */ + public function getLabel(): string + { + return $this->label; + } + + /** + * Sets Label. + * A description that the payer sees, which helps them choose an appropriate shipping option. For + * example, `Free Shipping`, `USPS Priority Shipping`, `Expédition prioritaire USPS`, or `USPS yōuxiān + * fā huò`. Localize this description to the payer's locale. + * + * @required + * @maps label + */ + public function setLabel(string $label): void + { + $this->label = $label; + } + + /** + * Returns Type. + * A classification for the method of purchase fulfillment. + */ + public function getType(): ?string + { + return $this->type; + } + + /** + * Sets Type. + * A classification for the method of purchase fulfillment. + * + * @maps type + */ + public function setType(?string $type): void + { + $this->type = $type; + } + + /** + * Returns Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getAmount(): ?Money + { + return $this->amount; + } + + /** + * Sets Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps amount + */ + public function setAmount(?Money $amount): void + { + $this->amount = $amount; + } + + /** + * Converts the OrderUpdateCallbackShippingOption object to a human-readable string representation. + * + * @return string The string representation of the OrderUpdateCallbackShippingOption object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'OrderUpdateCallbackShippingOption', + ['id' => $this->id, 'label' => $this->label, 'type' => $this->type, 'amount' => $this->amount] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + $json['id'] = $this->id; + $json['label'] = $this->label; + if (isset($this->type)) { + $json['type'] = $this->type; + } + if (isset($this->amount)) { + $json['amount'] = $this->amount; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/Capture.php b/src/Models/OrdersCapture.php similarity index 87% rename from src/Models/Capture.php rename to src/Models/OrdersCapture.php index 708283a..7172746 100644 --- a/src/Models/Capture.php +++ b/src/Models/OrdersCapture.php @@ -10,12 +10,13 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** * A captured payment. */ -class Capture implements \JsonSerializable +class OrdersCapture implements \JsonSerializable { /** * @var string|null @@ -371,8 +372,8 @@ class Capture implements \JsonSerializable /** * Returns Create Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getCreateTime(): ?string { @@ -382,8 +383,8 @@ class Capture implements \JsonSerializable /** * Sets Create Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps create_time */ @@ -395,8 +396,8 @@ class Capture implements \JsonSerializable /** * Returns Update Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getUpdateTime(): ?string { @@ -406,8 +407,8 @@ class Capture implements \JsonSerializable /** * Sets Update Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps update_time */ @@ -416,6 +417,35 @@ class Capture implements \JsonSerializable $this->updateTime = $updateTime; } + /** + * Converts the OrdersCapture object to a human-readable string representation. + * + * @return string The string representation of the OrdersCapture object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'OrdersCapture', + [ + 'status' => $this->status, + 'statusDetails' => $this->statusDetails, + 'id' => $this->id, + 'amount' => $this->amount, + 'invoiceId' => $this->invoiceId, + 'customId' => $this->customId, + 'networkTransactionReference' => $this->networkTransactionReference, + 'sellerProtection' => $this->sellerProtection, + 'finalCapture' => $this->finalCapture, + 'sellerReceivableBreakdown' => $this->sellerReceivableBreakdown, + 'disbursementMode' => $this->disbursementMode, + 'links' => $this->links, + 'processorResponse' => $this->processorResponse, + 'createTime' => $this->createTime, + 'updateTime' => $this->updateTime + ] + ); + } + /** * Encode this object to JSON * @@ -429,7 +459,7 @@ class Capture implements \JsonSerializable { $json = []; if (isset($this->status)) { - $json['status'] = CaptureStatus::checkValue($this->status); + $json['status'] = $this->status; } if (isset($this->statusDetails)) { $json['status_details'] = $this->statusDetails; @@ -459,7 +489,7 @@ class Capture implements \JsonSerializable $json['seller_receivable_breakdown'] = $this->sellerReceivableBreakdown; } if (isset($this->disbursementMode)) { - $json['disbursement_mode'] = DisbursementMode::checkValue($this->disbursementMode); + $json['disbursement_mode'] = $this->disbursementMode; } if (isset($this->links)) { $json['links'] = $this->links; diff --git a/src/Models/OrdersCardVerificationMethod.php b/src/Models/OrdersCardVerificationMethod.php new file mode 100644 index 0000000..10854f1 --- /dev/null +++ b/src/Models/OrdersCardVerificationMethod.php @@ -0,0 +1,52 @@ +Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the
@ sign. However, the generally
- * accepted maximum length for an email address is 254 characters. The pattern verifies that an
- * unquoted @ sign exists.
+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters
+ * are allowed after the @ sign. However, the generally accepted maximum length for an email address is
+ * 254 characters. The pattern verifies that an unquoted @ sign exists.
*/
public function getEmail(): ?string
{
@@ -81,10 +81,9 @@ class P24PaymentObject implements \JsonSerializable
/**
* Sets Email.
- * The internationalized email address.Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. * * @maps email */ @@ -96,10 +95,9 @@ class P24PaymentObject implements \JsonSerializable /** * Returns Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. */ public function getCountryCode(): ?string { @@ -109,10 +107,9 @@ class P24PaymentObject implements \JsonSerializable /** * Sets Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. * * @maps country_code */ @@ -181,6 +178,26 @@ class P24PaymentObject implements \JsonSerializable $this->methodDescription = $methodDescription; } + /** + * Converts the P24PaymentObject object to a human-readable string representation. + * + * @return string The string representation of the P24PaymentObject object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'P24PaymentObject', + [ + 'name' => $this->name, + 'email' => $this->email, + 'countryCode' => $this->countryCode, + 'paymentDescriptor' => $this->paymentDescriptor, + 'methodId' => $this->methodId, + 'methodDescription' => $this->methodDescription + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/P24PaymentRequest.php b/src/Models/P24PaymentRequest.php index 699f7b5..6d91116 100644 --- a/src/Models/P24PaymentRequest.php +++ b/src/Models/P24PaymentRequest.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -72,10 +73,9 @@ class P24PaymentRequest implements \JsonSerializable /** * Returns Email. - * The internationalized email address.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. */ public function getEmail(): string { @@ -84,10 +84,9 @@ class P24PaymentRequest implements \JsonSerializable /** * Sets Email. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. * * @required * @maps email @@ -100,10 +99,9 @@ class P24PaymentRequest implements \JsonSerializable /** * Returns Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. */ public function getCountryCode(): string { @@ -113,10 +111,9 @@ class P24PaymentRequest implements \JsonSerializable /** * Sets Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. * * @required * @maps country_code @@ -146,6 +143,24 @@ class P24PaymentRequest implements \JsonSerializable $this->experienceContext = $experienceContext; } + /** + * Converts the P24PaymentRequest object to a human-readable string representation. + * + * @return string The string representation of the P24PaymentRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'P24PaymentRequest', + [ + 'name' => $this->name, + 'email' => $this->email, + 'countryCode' => $this->countryCode, + 'experienceContext' => $this->experienceContext + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/PaResStatus.php b/src/Models/PaResStatus.php index 3324d56..6b404c2 100644 --- a/src/Models/PaResStatus.php +++ b/src/Models/PaResStatus.php @@ -10,48 +10,48 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * Transactions status result identifier. The outcome of the issuer's authentication. */ class PaResStatus { - public const Y = 'Y'; - - public const N = 'N'; - - public const U = 'U'; - - public const A = 'A'; - - public const C = 'C'; - - public const R = 'R'; - - public const D = 'D'; - - public const I = 'I'; - - private const _ALL_VALUES = [self::Y, self::N, self::U, self::A, self::C, self::R, self::D, self::I]; + /** + * Successful authentication. + */ + public const SUCCESSFULAUTHENTICATION = 'Y'; /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * Failed authentication / account not verified / transaction denied. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for PaResStatus."); - } + public const FAILEDAUTHENTICATION = 'N'; + + /** + * Unable to complete authentication. + */ + public const UNABLETOCOMPLETEAUTHENTICATION = 'U'; + + /** + * Successful attempts transaction. + */ + public const SUCCESSFULATTEMPTSTRANSACTION = 'A'; + + /** + * Challenge required for authentication. + */ + public const CHALLENGEREQUIRED = 'C'; + + /** + * Authentication rejected (merchant must not submit for authorization). + */ + public const AUTHENTICATIONREJECTED = 'R'; + + /** + * Challenge required; decoupled authentication confirmed. + */ + public const DECOUPLEDAUTHENTICATION = 'D'; + + /** + * Informational only; 3DS requestor challenge preference acknowledged. + */ + public const INFORMATIONALONLY = 'I'; } diff --git a/src/Models/ParticipantMetadata.php b/src/Models/ParticipantMetadata.php new file mode 100644 index 0000000..4dd67b6 --- /dev/null +++ b/src/Models/ParticipantMetadata.php @@ -0,0 +1,78 @@ +ipAddress; + } + + /** + * Sets Ip Address. + * An Internet Protocol address (IP address). This address assigns a numerical label to each device + * that is connected to a computer network through the Internet Protocol. Supports IPv4 and IPv6 + * addresses. + * + * @maps ip_address + */ + public function setIpAddress(?string $ipAddress): void + { + $this->ipAddress = $ipAddress; + } + + /** + * Converts the ParticipantMetadata object to a human-readable string representation. + * + * @return string The string representation of the ParticipantMetadata object. + */ + public function __toString(): string + { + return ApiHelper::stringify('ParticipantMetadata', ['ipAddress' => $this->ipAddress]); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + if (isset($this->ipAddress)) { + $json['ip_address'] = $this->ipAddress; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/Patch.php b/src/Models/Patch.php index 754c4e2..9f0878d 100644 --- a/src/Models/Patch.php +++ b/src/Models/Patch.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -68,8 +69,7 @@ class Patch implements \JsonSerializable /** * Returns Path. - * The JSON Pointer to the target document location - * at which to complete the operation. + * The JSON Pointer to the target document location at which to complete the operation. */ public function getPath(): ?string { @@ -78,8 +78,7 @@ class Patch implements \JsonSerializable /** * Sets Path. - * The JSON Pointer to the target document location - * at which to complete the operation. + * The JSON Pointer to the target document location at which to complete the operation. * * @maps path */ @@ -90,9 +89,8 @@ class Patch implements \JsonSerializable /** * Returns Value. - * The value to apply. TheGB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
remove, copy, and move operations do
- * not require a value. Since JSON Patch allows
- * any type for value, the type property is not specified.
+ * The value to apply. The remove, copy, and move operations do not require a value. Since JSON Patch
+ * allows any type for value, the type property is not specified.
*
* @return mixed
*/
@@ -103,9 +101,8 @@ class Patch implements \JsonSerializable
/**
* Sets Value.
- * The value to apply. The remove, copy, and move operations do
- * not require a value. Since JSON Patch allows
- * any type for value, the type property is not specified.
+ * The value to apply. The remove, copy, and move operations do not require a value. Since JSON Patch
+ * allows any type for value, the type property is not specified.
*
* @maps value
*
@@ -118,8 +115,8 @@ class Patch implements \JsonSerializable
/**
* Returns From.
- * The JSON Pointer to the target document location
- * from which to move the value. Required for the move operation.
+ * The JSON Pointer to the target document location from which to move the value. Required for the move
+ * operation.
*/
public function getFrom(): ?string
{
@@ -128,8 +125,8 @@ class Patch implements \JsonSerializable
/**
* Sets From.
- * The JSON Pointer to the target document location
- * from which to move the value. Required for the move operation.
+ * The JSON Pointer to the target document location from which to move the value. Required for the move
+ * operation.
*
* @maps from
*/
@@ -138,6 +135,19 @@ class Patch implements \JsonSerializable
$this->from = $from;
}
+ /**
+ * Converts the Patch object to a human-readable string representation.
+ *
+ * @return string The string representation of the Patch object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify(
+ 'Patch',
+ ['op' => $this->op, 'path' => $this->path, 'value' => $this->value, 'from' => $this->from]
+ );
+ }
+
/**
* Encode this object to JSON
*
@@ -150,7 +160,7 @@ class Patch implements \JsonSerializable
public function jsonSerialize(bool $asArrayWhenEmpty = false)
{
$json = [];
- $json['op'] = PatchOp::checkValue($this->op);
+ $json['op'] = $this->op;
if (isset($this->path)) {
$json['path'] = $this->path;
}
diff --git a/src/Models/PatchOp.php b/src/Models/PatchOp.php
index 862f4fd..bcada91 100644
--- a/src/Models/PatchOp.php
+++ b/src/Models/PatchOp.php
@@ -10,44 +10,64 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
-use Core\Utils\CoreHelper;
-use Exception;
-use stdClass;
-
/**
* The operation.
*/
class PatchOp
{
+ /**
+ * Depending on the target location reference, completes one of these functions: The target location is
+ * an array index. Inserts a new value into the array at the specified index. The target location is an
+ * object parameter that does not already exist. Adds a new parameter to the object. The target
+ * location is an object parameter that does exist. Replaces that parameter's value. The value
+ * parameter defines the value to add. For more information, see 4.1. add.
+ */
public const ADD = 'add';
+ /**
+ * Removes the value at the target location. For the operation to succeed, the target location must
+ * exist. For more information, see 4.2. remove.
+ */
public const REMOVE = 'remove';
+ /**
+ * Replaces the value at the target location with a new value. The operation object must contain a
+ * value parameter that defines the replacement value. For the operation to succeed, the target
+ * location must exist. For more information, see 4.3. replace.
+ */
public const REPLACE = 'replace';
+ /**
+ * Removes the value at a specified location and adds it to the target location. The operation object
+ * must contain a from parameter, which is a string that contains a JSON pointer value that references
+ * the location in the target document from which to move the value. For the operation to succeed, the
+ * from location must exist. For more information, see 4.4. move.
+ */
public const MOVE = 'move';
+ /**
+ * Copies the value at a specified location to the target location. The operation object must contain a
+ * from parameter, which is a string that contains a JSON pointer value that references the location in
+ * the target document from which to copy the value. For the operation to succeed, the from location
+ * must exist. For more information, see 4.5. copy.
+ */
public const COPY = 'copy';
- public const TEST = 'test';
-
- private const _ALL_VALUES = [self::ADD, self::REMOVE, self::REPLACE, self::MOVE, self::COPY, self::TEST];
-
/**
- * Ensures that all the given values are present in this Enum.
- *
- * @param array|stdClass|null|string $value Value or a list/map of values to be checked
- *
- * @return array|null|string Input value(s), if all are a part of this Enum
- *
- * @throws Exception Throws exception if any given value is not in this Enum
+ * Tests that a value at the target location is equal to a specified value. The operation object must
+ * contain a value parameter that defines the value to compare to the target location's value. For the
+ * operation to succeed, the target location must be equal to the value value. For test, equal
+ * indicates that the value at the target location and the value that value defines are of the same
+ * JSON type. The data type of the value determines how equality is defined: Type Considered equal if
+ * both values strings Contain the same number of Unicode characters and their code points are byte-by-
+ * byte equal. numbers Are numerically equal. arrays Contain the same number of values, and each value
+ * is equal to the value at the corresponding position in the other array, by using these type-specific
+ * rules. objects Contain the same number of parameters, and each parameter is equal to a parameter in
+ * the other object, by comparing their keys (as strings) and their values (by using these type-
+ * specific rules). literals (false, true, and null) Are the same. The comparison is a logical
+ * comparison. For example, whitespace between the parameter values of an array is not significant.
+ * Also, ordering of the serialization of object parameters is not significant. For more information,
+ * see 4.6. test.
*/
- public static function checkValue($value)
- {
- $value = json_decode(json_encode($value), true); // converts stdClass into array
- if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) {
- return $value;
- }
- throw new Exception("$value is invalid for PatchOp.");
- }
+ public const TEST = 'test';
}
diff --git a/src/Models/Payee.php b/src/Models/Payee.php
deleted file mode 100644
index b2e434b..0000000
--- a/src/Models/Payee.php
+++ /dev/null
@@ -1,99 +0,0 @@
-Note: Up to 64 characters are
- * allowed before and 255 characters are allowed after the @ sign. However, the generally
- * accepted maximum length for an email address is 254 characters. The pattern verifies that an
- * unquoted @ sign exists.
- */
- public function getEmailAddress(): ?string
- {
- return $this->emailAddress;
- }
-
- /**
- * Sets Email Address.
- * The internationalized email address.Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the- * - * @maps email_address - */ - public function setEmailAddress(?string $emailAddress): void - { - $this->emailAddress = $emailAddress; - } - - /** - * Returns Merchant Id. - * The account identifier for a PayPal account. - */ - public function getMerchantId(): ?string - { - return $this->merchantId; - } - - /** - * Sets Merchant Id. - * The account identifier for a PayPal account. - * - * @maps merchant_id - */ - public function setMerchantId(?string $merchantId): void - { - $this->merchantId = $merchantId; - } - - /** - * Encode this object to JSON - * - * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields - * are set. (default: false) - * - * @return array|stdClass - */ - #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) - public function jsonSerialize(bool $asArrayWhenEmpty = false) - { - $json = []; - if (isset($this->emailAddress)) { - $json['email_address'] = $this->emailAddress; - } - if (isset($this->merchantId)) { - $json['merchant_id'] = $this->merchantId; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PayeeBase.php b/src/Models/PayeeBase.php index dca7303..7888e48 100644 --- a/src/Models/PayeeBase.php +++ b/src/Models/PayeeBase.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -30,10 +31,9 @@ class PayeeBase implements \JsonSerializable /** * Returns Email Address. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. */ public function getEmailAddress(): ?string { @@ -42,10 +42,9 @@ class PayeeBase implements \JsonSerializable /** * Sets Email Address. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. * * @maps email_address */ @@ -74,6 +73,19 @@ class PayeeBase implements \JsonSerializable $this->merchantId = $merchantId; } + /** + * Converts the PayeeBase object to a human-readable string representation. + * + * @return string The string representation of the PayeeBase object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PayeeBase', + ['emailAddress' => $this->emailAddress, 'merchantId' => $this->merchantId] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/PayeePaymentMethodPreference.php b/src/Models/PayeePaymentMethodPreference.php index 04e2917..2befd1f 100644 --- a/src/Models/PayeePaymentMethodPreference.php +++ b/src/Models/PayeePaymentMethodPreference.php @@ -10,36 +10,19 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The merchant-preferred payment methods. */ class PayeePaymentMethodPreference { + /** + * Accepts any type of payment from the customer. + */ public const UNRESTRICTED = 'UNRESTRICTED'; - public const IMMEDIATE_PAYMENT_REQUIRED = 'IMMEDIATE_PAYMENT_REQUIRED'; - - private const _ALL_VALUES = [self::UNRESTRICTED, self::IMMEDIATE_PAYMENT_REQUIRED]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * Accepts only immediate payment from the customer. For example, credit card, PayPal balance, or + * instant ACH. Ensures that at the time of capture, the payment does not have the `pending` status. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for PayeePaymentMethodPreference."); - } + public const IMMEDIATE_PAYMENT_REQUIRED = 'IMMEDIATE_PAYMENT_REQUIRED'; } diff --git a/src/Models/Payer.php b/src/Models/Payer.php index 3e536d8..abcd4ed 100644 --- a/src/Models/Payer.php +++ b/src/Models/Payer.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; class Payer implements \JsonSerializable @@ -51,10 +52,9 @@ class Payer implements \JsonSerializable /** * Returns Email Address. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. */ public function getEmailAddress(): ?string { @@ -63,10 +63,9 @@ class Payer implements \JsonSerializable /** * Sets Email Address. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. * * @maps email_address */ @@ -211,6 +210,27 @@ class Payer implements \JsonSerializable $this->address = $address; } + /** + * Converts the Payer object to a human-readable string representation. + * + * @return string The string representation of the Payer object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'Payer', + [ + 'emailAddress' => $this->emailAddress, + 'payerId' => $this->payerId, + 'name' => $this->name, + 'phone' => $this->phone, + 'birthDate' => $this->birthDate, + 'taxInfo' => $this->taxInfo, + 'address' => $this->address + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/PayerBase.php b/src/Models/PayerBase.php index f276acb..485a1a3 100644 --- a/src/Models/PayerBase.php +++ b/src/Models/PayerBase.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -29,10 +30,9 @@ class PayerBase implements \JsonSerializable /** * Returns Email Address. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. */ public function getEmailAddress(): ?string { @@ -41,10 +41,9 @@ class PayerBase implements \JsonSerializable /** * Sets Email Address. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. * * @maps email_address */ @@ -73,6 +72,19 @@ class PayerBase implements \JsonSerializable $this->payerId = $payerId; } + /** + * Converts the PayerBase object to a human-readable string representation. + * + * @return string The string representation of the PayerBase object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PayerBase', + ['emailAddress' => $this->emailAddress, 'payerId' => $this->payerId] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/PaymentAdviceCode.php b/src/Models/PaymentAdviceCode.php index 2a0adad..cfb585c 100644 --- a/src/Models/PaymentAdviceCode.php +++ b/src/Models/PaymentAdviceCode.php @@ -10,41 +10,93 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The declined payment transactions might have payment advice codes. The card networks, like Visa and * Mastercard, return payment advice codes. */ class PaymentAdviceCode { - public const ENUM_01 = '01'; - - public const ENUM_02 = '02'; - - public const ENUM_03 = '03'; - - public const ENUM_21 = '21'; - - private const _ALL_VALUES = [self::ENUM_01, self::ENUM_02, self::ENUM_03, self::ENUM_21]; + /** + * For Mastercard, expired card account upgrade or portfolio sale conversion. Obtain new account + * information before next billing cycle. + */ + public const PAYMENTADVICE_01 = '01'; /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * For Mastercard, over credit limit or insufficient funds. Retry the transaction 72 hours later. For + * Visa, the card holder wants to stop only one specific payment in the recurring payment relationship. + * The merchant must NOT resubmit the same transaction. The merchant can continue the billing process + * in the subsequent billing period. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for PaymentAdviceCode."); - } + public const PAYMENTADVICE_02 = '02'; + + /** + * For Mastercard, account closed as fraudulent. Obtain another type of payment from customer due to + * account being closed or fraud. Possible reason: Account closed as fraudulent. For Visa, the card + * holder wants to stop all recurring payment transactions for a specific merchant. Stop recurring + * payment requests. + */ + public const PAYMENTADVICE_03 = '03'; + + /** + * For Mastercard, token requirements not fulfilled for this token type. + */ + public const PAYMENTADVICE_04 = '04'; + + /** + * For Mastercard, the card holder has been unsuccessful at canceling recurring payment through + * merchant. Stop recurring payment requests. For Visa, all recurring payments were canceled for the + * card number requested. Stop recurring payment requests. + */ + public const PAYMENTADVICE_21 = '21'; + + /** + * For Mastercard, merchant does not qualify for product code. + */ + public const PAYMENTADVICE_22 = '22'; + + /** + * For Mastercard, retry after 1 hour. + */ + public const PAYMENTADVICE_24 = '24'; + + /** + * For Mastercard, retry after 24 hours. + */ + public const PAYMENTADVICE_25 = '25'; + + /** + * For Mastercard, retry after 2 days. + */ + public const PAYMENTADVICE_26 = '26'; + + /** + * For Mastercard, retry after 4 days. + */ + public const PAYMENTADVICE_27 = '27'; + + /** + * For Mastercard, retry after 6 days. + */ + public const PAYMENTADVICE_28 = '28'; + + /** + * For Mastercard, retry after 8 days. + */ + public const PAYMENTADVICE_29 = '29'; + + /** + * For Mastercard, retry after 10 days . + */ + public const PAYMENTADVICE_30 = '30'; + + /** + * For Mastercard, consumer non-reloadable prepaid card. + */ + public const PAYMENTADVICE_40 = '40'; + + /** + * For Mastercard, consumer multi-use virtual card number. + */ + public const PAYMENTADVICE_43 = '43'; } diff --git a/src/Models/PaymentAuthorization.php b/src/Models/PaymentAuthorization.php index 37201e5..f193360 100644 --- a/src/Models/PaymentAuthorization.php +++ b/src/Models/PaymentAuthorization.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -83,7 +84,7 @@ class PaymentAuthorization implements \JsonSerializable private $supplementaryData; /** - * @var Payee|null + * @var PayeeBase|null */ private $payee; @@ -256,8 +257,8 @@ class PaymentAuthorization implements \JsonSerializable /** * Returns Expiration Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getExpirationTime(): ?string { @@ -267,8 +268,8 @@ class PaymentAuthorization implements \JsonSerializable /** * Sets Expiration Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps expiration_time */ @@ -304,8 +305,8 @@ class PaymentAuthorization implements \JsonSerializable /** * Returns Create Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getCreateTime(): ?string { @@ -315,8 +316,8 @@ class PaymentAuthorization implements \JsonSerializable /** * Sets Create Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps create_time */ @@ -328,8 +329,8 @@ class PaymentAuthorization implements \JsonSerializable /** * Returns Update Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getUpdateTime(): ?string { @@ -339,8 +340,8 @@ class PaymentAuthorization implements \JsonSerializable /** * Sets Update Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps update_time */ @@ -374,7 +375,7 @@ class PaymentAuthorization implements \JsonSerializable * The details for the merchant who receives the funds and fulfills the order. The merchant is also * known as the payee. */ - public function getPayee(): ?Payee + public function getPayee(): ?PayeeBase { return $this->payee; } @@ -386,11 +387,39 @@ class PaymentAuthorization implements \JsonSerializable * * @maps payee */ - public function setPayee(?Payee $payee): void + public function setPayee(?PayeeBase $payee): void { $this->payee = $payee; } + /** + * Converts the PaymentAuthorization object to a human-readable string representation. + * + * @return string The string representation of the PaymentAuthorization object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PaymentAuthorization', + [ + 'status' => $this->status, + 'statusDetails' => $this->statusDetails, + 'id' => $this->id, + 'amount' => $this->amount, + 'invoiceId' => $this->invoiceId, + 'customId' => $this->customId, + 'networkTransactionReference' => $this->networkTransactionReference, + 'sellerProtection' => $this->sellerProtection, + 'expirationTime' => $this->expirationTime, + 'links' => $this->links, + 'createTime' => $this->createTime, + 'updateTime' => $this->updateTime, + 'supplementaryData' => $this->supplementaryData, + 'payee' => $this->payee + ] + ); + } + /** * Encode this object to JSON * @@ -404,7 +433,7 @@ class PaymentAuthorization implements \JsonSerializable { $json = []; if (isset($this->status)) { - $json['status'] = AuthorizationStatus::checkValue($this->status); + $json['status'] = $this->status; } if (isset($this->statusDetails)) { $json['status_details'] = $this->statusDetails; diff --git a/src/Models/PaymentCollection.php b/src/Models/PaymentCollection.php index 412e94b..1b7a6b3 100644 --- a/src/Models/PaymentCollection.php +++ b/src/Models/PaymentCollection.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -24,7 +25,7 @@ class PaymentCollection implements \JsonSerializable private $authorizations; /** - * @var Capture[]|null + * @var OrdersCapture[]|null */ private $captures; @@ -64,7 +65,7 @@ class PaymentCollection implements \JsonSerializable * An array of captured payments for a purchase unit. A purchase unit can have zero or more captured * payments. * - * @return Capture[]|null + * @return OrdersCapture[]|null */ public function getCaptures(): ?array { @@ -78,7 +79,7 @@ class PaymentCollection implements \JsonSerializable * * @maps captures * - * @param Capture[]|null $captures + * @param OrdersCapture[]|null $captures */ public function setCaptures(?array $captures): void { @@ -109,6 +110,19 @@ class PaymentCollection implements \JsonSerializable $this->refunds = $refunds; } + /** + * Converts the PaymentCollection object to a human-readable string representation. + * + * @return string The string representation of the PaymentCollection object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PaymentCollection', + ['authorizations' => $this->authorizations, 'captures' => $this->captures, 'refunds' => $this->refunds] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/PaymentInitiator.php b/src/Models/PaymentInitiator.php index 19128dc..877bccf 100644 --- a/src/Models/PaymentInitiator.php +++ b/src/Models/PaymentInitiator.php @@ -10,36 +10,20 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The person or party who initiated or triggered the payment. */ class PaymentInitiator { + /** + * Payment is initiated with the active engagement of the customer. e.g. a customer checking out on a + * merchant website. + */ public const CUSTOMER = 'CUSTOMER'; - public const MERCHANT = 'MERCHANT'; - - private const _ALL_VALUES = [self::CUSTOMER, self::MERCHANT]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * Payment is initiated by merchant on behalf of the customer without the active engagement of customer. + * e.g. a merchant charging the monthly payment of a subscription to the customer. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for PaymentInitiator."); - } + public const MERCHANT = 'MERCHANT'; } diff --git a/src/Models/PaymentInstruction.php b/src/Models/PaymentInstruction.php index d514354..f4ad9bf 100644 --- a/src/Models/PaymentInstruction.php +++ b/src/Models/PaymentInstruction.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -134,6 +135,24 @@ class PaymentInstruction implements \JsonSerializable $this->payeeReceivableFxRateId = $payeeReceivableFxRateId; } + /** + * Converts the PaymentInstruction object to a human-readable string representation. + * + * @return string The string representation of the PaymentInstruction object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PaymentInstruction', + [ + 'platformFees' => $this->platformFees, + 'disbursementMode' => $this->disbursementMode, + 'payeePricingTierId' => $this->payeePricingTierId, + 'payeeReceivableFxRateId' => $this->payeeReceivableFxRateId + ] + ); + } + /** * Encode this object to JSON * @@ -150,7 +169,7 @@ class PaymentInstruction implements \JsonSerializable $json['platform_fees'] = $this->platformFees; } if (isset($this->disbursementMode)) { - $json['disbursement_mode'] = DisbursementMode::checkValue($this->disbursementMode); + $json['disbursement_mode'] = $this->disbursementMode; } if (isset($this->payeePricingTierId)) { $json['payee_pricing_tier_id'] = $this->payeePricingTierId; diff --git a/src/Models/PaymentMethodPreference.php b/src/Models/PaymentMethodPreference.php index cbb346b..7812b5e 100644 --- a/src/Models/PaymentMethodPreference.php +++ b/src/Models/PaymentMethodPreference.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -77,6 +78,19 @@ class PaymentMethodPreference implements \JsonSerializable $this->standardEntryClassCode = $standardEntryClassCode; } + /** + * Converts the PaymentMethodPreference object to a human-readable string representation. + * + * @return string The string representation of the PaymentMethodPreference object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PaymentMethodPreference', + ['payeePreferred' => $this->payeePreferred, 'standardEntryClassCode' => $this->standardEntryClassCode] + ); + } + /** * Encode this object to JSON * @@ -90,10 +104,10 @@ class PaymentMethodPreference implements \JsonSerializable { $json = []; if (isset($this->payeePreferred)) { - $json['payee_preferred'] = PayeePaymentMethodPreference::checkValue($this->payeePreferred); + $json['payee_preferred'] = $this->payeePreferred; } if (isset($this->standardEntryClassCode)) { - $json['standard_entry_class_code'] = StandardEntryClassCode::checkValue($this->standardEntryClassCode); + $json['standard_entry_class_code'] = $this->standardEntryClassCode; } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; diff --git a/src/Models/PaymentSource.php b/src/Models/PaymentSource.php index 1035f32..1f53c79 100644 --- a/src/Models/PaymentSource.php +++ b/src/Models/PaymentSource.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -94,12 +95,10 @@ class PaymentSource implements \JsonSerializable /** * Returns Card. - * The payment card to use to fund a payment. Can be a credit or debit card.
Note: - * Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance. - *+ * The payment card to use to fund a payment. Can be a credit or debit card. Note: Passing card number, + * cvv and expiry directly via the API requires PCI SAQ D compliance. *PayPal offers a mechanism by + * which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this + * Integration Guide*. */ public function getCard(): ?CardRequest { @@ -108,12 +107,10 @@ class PaymentSource implements \JsonSerializable /** * Sets Card. - * The payment card to use to fund a payment. Can be a credit or debit card.
*PayPal offers a mechanism by which you do not have to take on the PCI SAQ D - * burden by using hosted fields - refer to this Integration Guide*.
Note: - * Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance. - *+ * The payment card to use to fund a payment. Can be a credit or debit card. Note: Passing card number, + * cvv and expiry directly via the API requires PCI SAQ D compliance. *PayPal offers a mechanism by + * which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this + * Integration Guide*. * * @maps card */ @@ -402,6 +399,35 @@ class PaymentSource implements \JsonSerializable $this->venmo = $venmo; } + /** + * Converts the PaymentSource object to a human-readable string representation. + * + * @return string The string representation of the PaymentSource object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PaymentSource', + [ + 'card' => $this->card, + 'token' => $this->token, + 'paypal' => $this->paypal, + 'bancontact' => $this->bancontact, + 'blik' => $this->blik, + 'eps' => $this->eps, + 'giropay' => $this->giropay, + 'ideal' => $this->ideal, + 'mybank' => $this->mybank, + 'p24' => $this->p24, + 'sofort' => $this->sofort, + 'trustly' => $this->trustly, + 'applePay' => $this->applePay, + 'googlePay' => $this->googlePay, + 'venmo' => $this->venmo + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/PaymentSourceResponse.php b/src/Models/PaymentSourceResponse.php index 071109a..87651bc 100644 --- a/src/Models/PaymentSourceResponse.php +++ b/src/Models/PaymentSourceResponse.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -367,6 +368,34 @@ class PaymentSourceResponse implements \JsonSerializable $this->venmo = $venmo; } + /** + * Converts the PaymentSourceResponse object to a human-readable string representation. + * + * @return string The string representation of the PaymentSourceResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PaymentSourceResponse', + [ + 'card' => $this->card, + 'paypal' => $this->paypal, + 'bancontact' => $this->bancontact, + 'blik' => $this->blik, + 'eps' => $this->eps, + 'giropay' => $this->giropay, + 'ideal' => $this->ideal, + 'mybank' => $this->mybank, + 'p24' => $this->p24, + 'sofort' => $this->sofort, + 'trustly' => $this->trustly, + 'applePay' => $this->applePay, + 'googlePay' => $this->googlePay, + 'venmo' => $this->venmo + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/PaymentSupplementaryData.php b/src/Models/PaymentSupplementaryData.php index c96cb06..f512715 100644 --- a/src/Models/PaymentSupplementaryData.php +++ b/src/Models/PaymentSupplementaryData.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -42,6 +43,16 @@ class PaymentSupplementaryData implements \JsonSerializable $this->relatedIds = $relatedIds; } + /** + * Converts the PaymentSupplementaryData object to a human-readable string representation. + * + * @return string The string representation of the PaymentSupplementaryData object. + */ + public function __toString(): string + { + return ApiHelper::stringify('PaymentSupplementaryData', ['relatedIds' => $this->relatedIds]); + } + /** * Encode this object to JSON * diff --git a/src/Models/PaymentTokenRequest.php b/src/Models/PaymentTokenRequest.php index 2e99cdc..36282b1 100644 --- a/src/Models/PaymentTokenRequest.php +++ b/src/Models/PaymentTokenRequest.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -18,7 +19,7 @@ use stdClass; class PaymentTokenRequest implements \JsonSerializable { /** - * @var CustomerRequest|null + * @var Customer|null */ private $customer; @@ -37,20 +38,22 @@ class PaymentTokenRequest implements \JsonSerializable /** * Returns Customer. - * Customer in merchant's or partner's system of records. + * This object defines a customer in your system. Use it to manage customer profiles, save payment + * methods and contact details. */ - public function getCustomer(): ?CustomerRequest + public function getCustomer(): ?Customer { return $this->customer; } /** * Sets Customer. - * Customer in merchant's or partner's system of records. + * This object defines a customer in your system. Use it to manage customer profiles, save payment + * methods and contact details. * * @maps customer */ - public function setCustomer(?CustomerRequest $customer): void + public function setCustomer(?Customer $customer): void { $this->customer = $customer; } @@ -76,6 +79,19 @@ class PaymentTokenRequest implements \JsonSerializable $this->paymentSource = $paymentSource; } + /** + * Converts the PaymentTokenRequest object to a human-readable string representation. + * + * @return string The string representation of the PaymentTokenRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PaymentTokenRequest', + ['customer' => $this->customer, 'paymentSource' => $this->paymentSource] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/PaymentTokenRequestCard.php b/src/Models/PaymentTokenRequestCard.php index 0caa6c9..4e5d30c 100644 --- a/src/Models/PaymentTokenRequestCard.php +++ b/src/Models/PaymentTokenRequestCard.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -47,11 +48,6 @@ class PaymentTokenRequestCard implements \JsonSerializable */ private $billingAddress; - /** - * @var mixed - */ - private $networkTransactionReference; - /** * Returns Name. * The card holder's name as it appears on the card. @@ -183,25 +179,23 @@ class PaymentTokenRequestCard implements \JsonSerializable } /** - * Returns Network Transaction Reference. + * Converts the PaymentTokenRequestCard object to a human-readable string representation. * - * @return mixed + * @return string The string representation of the PaymentTokenRequestCard object. */ - public function getNetworkTransactionReference() + public function __toString(): string { - return $this->networkTransactionReference; - } - - /** - * Sets Network Transaction Reference. - * - * @maps network_transaction_reference - * - * @param mixed $networkTransactionReference - */ - public function setNetworkTransactionReference($networkTransactionReference): void - { - $this->networkTransactionReference = $networkTransactionReference; + return ApiHelper::stringify( + 'PaymentTokenRequestCard', + [ + 'name' => $this->name, + 'number' => $this->number, + 'expiry' => $this->expiry, + 'securityCode' => $this->securityCode, + 'brand' => $this->brand, + 'billingAddress' => $this->billingAddress + ] + ); } /** @@ -217,25 +211,22 @@ class PaymentTokenRequestCard implements \JsonSerializable { $json = []; if (isset($this->name)) { - $json['name'] = $this->name; + $json['name'] = $this->name; } if (isset($this->number)) { - $json['number'] = $this->number; + $json['number'] = $this->number; } if (isset($this->expiry)) { - $json['expiry'] = $this->expiry; + $json['expiry'] = $this->expiry; } if (isset($this->securityCode)) { - $json['security_code'] = $this->securityCode; + $json['security_code'] = $this->securityCode; } if (isset($this->brand)) { - $json['brand'] = CardBrand::checkValue($this->brand); + $json['brand'] = $this->brand; } if (isset($this->billingAddress)) { - $json['billing_address'] = $this->billingAddress; - } - if (isset($this->networkTransactionReference)) { - $json['network_transaction_reference'] = $this->networkTransactionReference; + $json['billing_address'] = $this->billingAddress; } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; diff --git a/src/Models/PaymentTokenRequestPaymentSource.php b/src/Models/PaymentTokenRequestPaymentSource.php index 02fbfdb..111421a 100644 --- a/src/Models/PaymentTokenRequestPaymentSource.php +++ b/src/Models/PaymentTokenRequestPaymentSource.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -67,6 +68,19 @@ class PaymentTokenRequestPaymentSource implements \JsonSerializable $this->token = $token; } + /** + * Converts the PaymentTokenRequestPaymentSource object to a human-readable string representation. + * + * @return string The string representation of the PaymentTokenRequestPaymentSource object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PaymentTokenRequestPaymentSource', + ['card' => $this->card, 'token' => $this->token] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/PaymentTokenResponse.php b/src/Models/PaymentTokenResponse.php index 64cf4cc..e439c29 100644 --- a/src/Models/PaymentTokenResponse.php +++ b/src/Models/PaymentTokenResponse.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -23,7 +24,7 @@ class PaymentTokenResponse implements \JsonSerializable private $id; /** - * @var CustomerRequest|null + * @var CustomerResponse|null */ private $customer; @@ -59,20 +60,22 @@ class PaymentTokenResponse implements \JsonSerializable /** * Returns Customer. - * Customer in merchant's or partner's system of records. + * This object defines a customer in your system. Use it to manage customer profiles, save payment + * methods and contact details. */ - public function getCustomer(): ?CustomerRequest + public function getCustomer(): ?CustomerResponse { return $this->customer; } /** * Sets Customer. - * Customer in merchant's or partner's system of records. + * This object defines a customer in your system. Use it to manage customer profiles, save payment + * methods and contact details. * * @maps customer */ - public function setCustomer(?CustomerRequest $customer): void + public function setCustomer(?CustomerResponse $customer): void { $this->customer = $customer; } @@ -121,6 +124,24 @@ class PaymentTokenResponse implements \JsonSerializable $this->links = $links; } + /** + * Converts the PaymentTokenResponse object to a human-readable string representation. + * + * @return string The string representation of the PaymentTokenResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PaymentTokenResponse', + [ + 'id' => $this->id, + 'customer' => $this->customer, + 'paymentSource' => $this->paymentSource, + 'links' => $this->links + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/PaymentTokenResponsePaymentSource.php b/src/Models/PaymentTokenResponsePaymentSource.php index f681feb..2c9e3f9 100644 --- a/src/Models/PaymentTokenResponsePaymentSource.php +++ b/src/Models/PaymentTokenResponsePaymentSource.php @@ -19,7 +19,7 @@ use stdClass; class PaymentTokenResponsePaymentSource implements \JsonSerializable { /** - * @var CardPaymentToken|null + * @var CardPaymentTokenEntity|null */ private $card; @@ -38,16 +38,11 @@ class PaymentTokenResponsePaymentSource implements \JsonSerializable */ private $applePay; - /** - * @var mixed - */ - private $bank; - /** * Returns Card. * Full representation of a Card Payment Token including network token. */ - public function getCard(): ?CardPaymentToken + public function getCard(): ?CardPaymentTokenEntity { return $this->card; } @@ -58,7 +53,7 @@ class PaymentTokenResponsePaymentSource implements \JsonSerializable * * @maps card */ - public function setCard(?CardPaymentToken $card): void + public function setCard(?CardPaymentTokenEntity $card): void { $this->card = $card; } @@ -120,27 +115,21 @@ class PaymentTokenResponsePaymentSource implements \JsonSerializable } /** - * Returns Bank. - * Full representation of a Bank Payment Token. + * Converts the PaymentTokenResponsePaymentSource object to a human-readable string representation. * - * @return mixed + * @return string The string representation of the PaymentTokenResponsePaymentSource object. */ - public function getBank() + public function __toString(): string { - return $this->bank; - } - - /** - * Sets Bank. - * Full representation of a Bank Payment Token. - * - * @maps bank - * - * @param mixed $bank - */ - public function setBank($bank): void - { - $this->bank = $bank; + return ApiHelper::stringify( + 'PaymentTokenResponsePaymentSource', + [ + 'card' => $this->card, + 'paypal' => $this->paypal, + 'venmo' => $this->venmo, + 'applePay' => $this->applePay + ] + ); } /** @@ -167,9 +156,6 @@ class PaymentTokenResponsePaymentSource implements \JsonSerializable if (isset($this->applePay)) { $json['apple_pay'] = $this->applePay; } - if (isset($this->bank)) { - $json['bank'] = ApiHelper::decodeJson($this->bank, 'bank'); - } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; } diff --git a/src/Models/PaymentTokenStatus.php b/src/Models/PaymentTokenStatus.php new file mode 100644 index 0000000..59cf0f0 --- /dev/null +++ b/src/Models/PaymentTokenStatus.php @@ -0,0 +1,44 @@ +status; + } + + /** + * Sets Status. + * The status of the captured payment. + * + * @maps status + */ + public function setStatus(?string $status): void + { + $this->status = $status; + } + + /** + * Returns Status Details. + * The details of the captured payment status. + */ + public function getStatusDetails(): ?CaptureStatusDetails + { + return $this->statusDetails; + } + + /** + * Sets Status Details. + * The details of the captured payment status. + * + * @maps status_details + */ + public function setStatusDetails(?CaptureStatusDetails $statusDetails): void + { + $this->statusDetails = $statusDetails; + } + + /** + * Returns Id. + * The PayPal-generated ID for the captured payment. + */ + public function getId(): ?string + { + return $this->id; + } + + /** + * Sets Id. + * The PayPal-generated ID for the captured payment. + * + * @maps id + */ + public function setId(?string $id): void + { + $this->id = $id; + } + + /** + * Returns Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getAmount(): ?Money + { + return $this->amount; + } + + /** + * Sets Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps amount + */ + public function setAmount(?Money $amount): void + { + $this->amount = $amount; + } + + /** + * Returns Invoice Id. + * The API caller-provided external invoice number for this order. Appears in both the payer's + * transaction history and the emails that the payer receives. + */ + public function getInvoiceId(): ?string + { + return $this->invoiceId; + } + + /** + * Sets Invoice Id. + * The API caller-provided external invoice number for this order. Appears in both the payer's + * transaction history and the emails that the payer receives. + * + * @maps invoice_id + */ + public function setInvoiceId(?string $invoiceId): void + { + $this->invoiceId = $invoiceId; + } + + /** + * Returns Custom Id. + * The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal + * transactions. Appears in transaction and settlement reports. + */ + public function getCustomId(): ?string + { + return $this->customId; + } + + /** + * Sets Custom Id. + * The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal + * transactions. Appears in transaction and settlement reports. + * + * @maps custom_id + */ + public function setCustomId(?string $customId): void + { + $this->customId = $customId; + } + + /** + * Returns Network Transaction Reference. + * Reference values used by the card network to identify a transaction. + */ + public function getNetworkTransactionReference(): ?NetworkTransactionReference + { + return $this->networkTransactionReference; + } + + /** + * Sets Network Transaction Reference. + * Reference values used by the card network to identify a transaction. + * + * @maps network_transaction_reference + */ + public function setNetworkTransactionReference(?NetworkTransactionReference $networkTransactionReference): void + { + $this->networkTransactionReference = $networkTransactionReference; + } + + /** + * Returns Seller Protection. + * The level of protection offered as defined by [PayPal Seller Protection for Merchants](https://www. + * paypal.com/us/webapps/mpp/security/seller-protection). + */ + public function getSellerProtection(): ?SellerProtection + { + return $this->sellerProtection; + } + + /** + * Sets Seller Protection. + * The level of protection offered as defined by [PayPal Seller Protection for Merchants](https://www. + * paypal.com/us/webapps/mpp/security/seller-protection). + * + * @maps seller_protection + */ + public function setSellerProtection(?SellerProtection $sellerProtection): void + { + $this->sellerProtection = $sellerProtection; + } + + /** + * Returns Final Capture. + * Indicates whether you can make additional captures against the authorized payment. Set to `true` if + * you do not intend to capture additional payments against the authorization. Set to `false` if you + * intend to capture additional payments against the authorization. + */ + public function getFinalCapture(): ?bool + { + return $this->finalCapture; + } + + /** + * Sets Final Capture. + * Indicates whether you can make additional captures against the authorized payment. Set to `true` if + * you do not intend to capture additional payments against the authorization. Set to `false` if you + * intend to capture additional payments against the authorization. + * + * @maps final_capture + */ + public function setFinalCapture(?bool $finalCapture): void + { + $this->finalCapture = $finalCapture; + } + + /** + * Returns Seller Receivable Breakdown. + * The detailed breakdown of the capture activity. This is not available for transactions that are in + * pending state. + */ + public function getSellerReceivableBreakdown(): ?SellerReceivableBreakdown + { + return $this->sellerReceivableBreakdown; + } + + /** + * Sets Seller Receivable Breakdown. + * The detailed breakdown of the capture activity. This is not available for transactions that are in + * pending state. + * + * @maps seller_receivable_breakdown + */ + public function setSellerReceivableBreakdown(?SellerReceivableBreakdown $sellerReceivableBreakdown): void + { + $this->sellerReceivableBreakdown = $sellerReceivableBreakdown; + } + + /** + * Returns Disbursement Mode. + * The funds that are held on behalf of the merchant. + */ + public function getDisbursementMode(): ?string + { + return $this->disbursementMode; + } + + /** + * Sets Disbursement Mode. + * The funds that are held on behalf of the merchant. + * + * @maps disbursement_mode + */ + public function setDisbursementMode(?string $disbursementMode): void + { + $this->disbursementMode = $disbursementMode; + } + + /** + * Returns Links. + * An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links). + * + * @return LinkDescription[]|null + */ + public function getLinks(): ?array + { + return $this->links; + } + + /** + * Sets Links. + * An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links). + * + * @maps links + * + * @param LinkDescription[]|null $links + */ + public function setLinks(?array $links): void + { + $this->links = $links; + } + + /** + * Returns Processor Response. + * The processor response information for payment requests, such as direct credit card transactions. + */ + public function getProcessorResponse(): ?PaymentsProcessorResponse + { + return $this->processorResponse; + } + + /** + * Sets Processor Response. + * The processor response information for payment requests, such as direct credit card transactions. + * + * @maps processor_response + */ + public function setProcessorResponse(?PaymentsProcessorResponse $processorResponse): void + { + $this->processorResponse = $processorResponse; + } + + /** + * Returns Create Time. + * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. + * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. + */ + public function getCreateTime(): ?string + { + return $this->createTime; + } + + /** + * Sets Create Time. + * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. + * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. + * + * @maps create_time + */ + public function setCreateTime(?string $createTime): void + { + $this->createTime = $createTime; + } + + /** + * Returns Update Time. + * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. + * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. + */ + public function getUpdateTime(): ?string + { + return $this->updateTime; + } + + /** + * Sets Update Time. + * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. + * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. + * + * @maps update_time + */ + public function setUpdateTime(?string $updateTime): void + { + $this->updateTime = $updateTime; + } + + /** + * Converts the PaymentsCapture object to a human-readable string representation. + * + * @return string The string representation of the PaymentsCapture object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PaymentsCapture', + [ + 'status' => $this->status, + 'statusDetails' => $this->statusDetails, + 'id' => $this->id, + 'amount' => $this->amount, + 'invoiceId' => $this->invoiceId, + 'customId' => $this->customId, + 'networkTransactionReference' => $this->networkTransactionReference, + 'sellerProtection' => $this->sellerProtection, + 'finalCapture' => $this->finalCapture, + 'sellerReceivableBreakdown' => $this->sellerReceivableBreakdown, + 'disbursementMode' => $this->disbursementMode, + 'links' => $this->links, + 'processorResponse' => $this->processorResponse, + 'createTime' => $this->createTime, + 'updateTime' => $this->updateTime + ] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + if (isset($this->status)) { + $json['status'] = $this->status; + } + if (isset($this->statusDetails)) { + $json['status_details'] = $this->statusDetails; + } + if (isset($this->id)) { + $json['id'] = $this->id; + } + if (isset($this->amount)) { + $json['amount'] = $this->amount; + } + if (isset($this->invoiceId)) { + $json['invoice_id'] = $this->invoiceId; + } + if (isset($this->customId)) { + $json['custom_id'] = $this->customId; + } + if (isset($this->networkTransactionReference)) { + $json['network_transaction_reference'] = $this->networkTransactionReference; + } + if (isset($this->sellerProtection)) { + $json['seller_protection'] = $this->sellerProtection; + } + if (isset($this->finalCapture)) { + $json['final_capture'] = $this->finalCapture; + } + if (isset($this->sellerReceivableBreakdown)) { + $json['seller_receivable_breakdown'] = $this->sellerReceivableBreakdown; + } + if (isset($this->disbursementMode)) { + $json['disbursement_mode'] = $this->disbursementMode; + } + if (isset($this->links)) { + $json['links'] = $this->links; + } + if (isset($this->processorResponse)) { + $json['processor_response'] = $this->processorResponse; + } + if (isset($this->createTime)) { + $json['create_time'] = $this->createTime; + } + if (isset($this->updateTime)) { + $json['update_time'] = $this->updateTime; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/PaymentsPaymentAdviceCode.php b/src/Models/PaymentsPaymentAdviceCode.php new file mode 100644 index 0000000..1d44dc9 --- /dev/null +++ b/src/Models/PaymentsPaymentAdviceCode.php @@ -0,0 +1,47 @@ +avsCode; + } + + /** + * Sets Avs Code. + * The address verification code for Visa, Discover, Mastercard, or American Express transactions. + * + * @maps avs_code + */ + public function setAvsCode(?string $avsCode): void + { + $this->avsCode = $avsCode; + } + + /** + * Returns Cvv Code. + * The card verification value code for for Visa, Discover, Mastercard, or American Express. + */ + public function getCvvCode(): ?string + { + return $this->cvvCode; + } + + /** + * Sets Cvv Code. + * The card verification value code for for Visa, Discover, Mastercard, or American Express. + * + * @maps cvv_code + */ + public function setCvvCode(?string $cvvCode): void + { + $this->cvvCode = $cvvCode; + } + + /** + * Returns Response Code. + * Processor response code for the non-PayPal payment processor errors. + */ + public function getResponseCode(): ?string + { + return $this->responseCode; + } + + /** + * Sets Response Code. + * Processor response code for the non-PayPal payment processor errors. + * + * @maps response_code + */ + public function setResponseCode(?string $responseCode): void + { + $this->responseCode = $responseCode; + } + + /** + * Returns Payment Advice Code. + * The declined payment transactions might have payment advice codes. The card networks, like Visa and + * Mastercard, return payment advice codes. + */ + public function getPaymentAdviceCode(): ?string + { + return $this->paymentAdviceCode; + } + + /** + * Sets Payment Advice Code. + * The declined payment transactions might have payment advice codes. The card networks, like Visa and + * Mastercard, return payment advice codes. + * + * @maps payment_advice_code + */ + public function setPaymentAdviceCode(?string $paymentAdviceCode): void + { + $this->paymentAdviceCode = $paymentAdviceCode; + } + + /** + * Converts the PaymentsProcessorResponse object to a human-readable string representation. + * + * @return string The string representation of the PaymentsProcessorResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PaymentsProcessorResponse', + [ + 'avsCode' => $this->avsCode, + 'cvvCode' => $this->cvvCode, + 'responseCode' => $this->responseCode, + 'paymentAdviceCode' => $this->paymentAdviceCode + ] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + if (isset($this->avsCode)) { + $json['avs_code'] = $this->avsCode; + } + if (isset($this->cvvCode)) { + $json['cvv_code'] = $this->cvvCode; + } + if (isset($this->responseCode)) { + $json['response_code'] = $this->responseCode; + } + if (isset($this->paymentAdviceCode)) { + $json['payment_advice_code'] = $this->paymentAdviceCode; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/PaypalExperienceLandingPage.php b/src/Models/PaypalExperienceLandingPage.php index dbc87f2..1ad56e7 100644 --- a/src/Models/PaypalExperienceLandingPage.php +++ b/src/Models/PaypalExperienceLandingPage.php @@ -10,38 +10,28 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The type of landing page to show on the PayPal site for customer checkout. */ class PaypalExperienceLandingPage { + /** + * When the customer clicks PayPal Checkout, the customer is redirected to a page to log in to PayPal + * and approve the payment. + */ public const LOGIN = 'LOGIN'; + /** + * When the customer clicks PayPal Checkout, the customer is redirected to a page to enter credit or + * debit card and other relevant billing information required to complete the purchase. This option has + * previously been also called as 'BILLING' + */ public const GUEST_CHECKOUT = 'GUEST_CHECKOUT'; - public const NO_PREFERENCE = 'NO_PREFERENCE'; - - private const _ALL_VALUES = [self::LOGIN, self::GUEST_CHECKOUT, self::NO_PREFERENCE]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * When the customer clicks PayPal Checkout, the customer is redirected to either a page to log in to + * PayPal and approve the payment or to a page to enter credit or debit card and other relevant billing + * information required to complete the purchase, depending on their previous interaction with PayPal. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for PaypalExperienceLandingPage."); - } + public const NO_PREFERENCE = 'NO_PREFERENCE'; } diff --git a/src/Models/PaypalExperienceUserAction.php b/src/Models/PaypalExperienceUserAction.php index 88e3b83..4404f12 100644 --- a/src/Models/PaypalExperienceUserAction.php +++ b/src/Models/PaypalExperienceUserAction.php @@ -10,36 +10,22 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** - * Configures a Continue or Pay Now checkout flow. + * Configures a Continue or Pay Now checkout flow. */ class PaypalExperienceUserAction { + /** + * After you redirect the customer to the PayPal payment page, a Continue button appears. Use this + * option when the final amount is not known when the checkout flow is initiated and you want to + * redirect the customer to the merchant page without processing the payment. + */ public const CONTINUE_ = 'CONTINUE'; - public const PAY_NOW = 'PAY_NOW'; - - private const _ALL_VALUES = [self::CONTINUE_, self::PAY_NOW]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * After you redirect the customer to the PayPal payment page, a Pay Now button appears. Use this + * option when the final amount is known when the checkout is initiated and you want to process the + * payment immediately when the customer clicks Pay Now. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for PaypalExperienceUserAction."); - } + public const PAY_NOW = 'PAY_NOW'; } diff --git a/src/Models/PaypalPaymentToken.php b/src/Models/PaypalPaymentToken.php index 648e9aa..2b13b05 100644 --- a/src/Models/PaypalPaymentToken.php +++ b/src/Models/PaypalPaymentToken.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; class PaypalPaymentToken implements \JsonSerializable @@ -19,6 +20,11 @@ class PaypalPaymentToken implements \JsonSerializable */ private $description; + /** + * @var string|null + */ + private $usagePattern; + /** * @var VaultedDigitalWalletShippingDetails|null */ @@ -96,6 +102,26 @@ class PaypalPaymentToken implements \JsonSerializable $this->description = $description; } + /** + * Returns Usage Pattern. + * Expected business/charge model for the billing agreement. + */ + public function getUsagePattern(): ?string + { + return $this->usagePattern; + } + + /** + * Sets Usage Pattern. + * Expected business/charge model for the billing agreement. + * + * @maps usage_pattern + */ + public function setUsagePattern(?string $usagePattern): void + { + $this->usagePattern = $usagePattern; + } + /** * Returns Shipping. * The shipping details. @@ -190,10 +216,9 @@ class PaypalPaymentToken implements \JsonSerializable /** * Returns Email Address. - * The internationalized email address.
*PayPal offers a mechanism by which you do not have to take on the PCI SAQ D - * burden by using hosted fields - refer to this Integration Guide*.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. */ public function getEmailAddress(): ?string { @@ -202,10 +227,9 @@ class PaypalPaymentToken implements \JsonSerializable /** * Sets Email Address. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. * * @maps email_address */ @@ -342,6 +366,33 @@ class PaypalPaymentToken implements \JsonSerializable $this->phoneNumber = $phoneNumber; } + /** + * Converts the PaypalPaymentToken object to a human-readable string representation. + * + * @return string The string representation of the PaypalPaymentToken object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PaypalPaymentToken', + [ + 'description' => $this->description, + 'usagePattern' => $this->usagePattern, + 'shipping' => $this->shipping, + 'permitMultiplePaymentTokens' => $this->permitMultiplePaymentTokens, + 'usageType' => $this->usageType, + 'customerType' => $this->customerType, + 'emailAddress' => $this->emailAddress, + 'payerId' => $this->payerId, + 'name' => $this->name, + 'phone' => $this->phone, + 'address' => $this->address, + 'accountId' => $this->accountId, + 'phoneNumber' => $this->phoneNumber + ] + ); + } + /** * Encode this object to JSON * @@ -357,6 +408,9 @@ class PaypalPaymentToken implements \JsonSerializable if (isset($this->description)) { $json['description'] = $this->description; } + if (isset($this->usagePattern)) { + $json['usage_pattern'] = $this->usagePattern; + } if (isset($this->shipping)) { $json['shipping'] = $this->shipping; } diff --git a/src/Models/PaypalPaymentTokenCustomerType.php b/src/Models/PaypalPaymentTokenCustomerType.php index 2453888..45c0ef4 100644 --- a/src/Models/PaypalPaymentTokenCustomerType.php +++ b/src/Models/PaypalPaymentTokenCustomerType.php @@ -10,37 +10,21 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The customer type associated with the PayPal payment token. This is to indicate whether the customer - * acting on the merchant / platform is either a business or a consumer. + * acting on the merchant / platform is either a business or a consumer., The customer type associated + * with a digital wallet payment token. This is to indicate whether the customer acting on the merchant + * / platform is either a business or a consumer. */ class PaypalPaymentTokenCustomerType { + /** + * The customer vaulting the PayPal payment token is a consumer on the merchant / platform. + */ public const CONSUMER = 'CONSUMER'; - public const BUSINESS = 'BUSINESS'; - - private const _ALL_VALUES = [self::CONSUMER, self::BUSINESS]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * The customer vaulting the PayPal payment token is a business on merchant / platform. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for PaypalPaymentTokenCustomerType."); - } + public const BUSINESS = 'BUSINESS'; } diff --git a/src/Models/PaypalPaymentTokenUsagePattern.php b/src/Models/PaypalPaymentTokenUsagePattern.php deleted file mode 100644 index 73448c3..0000000 --- a/src/Models/PaypalPaymentTokenUsagePattern.php +++ /dev/null @@ -1,60 +0,0 @@ -Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
@ sign. However, the generally
- * accepted maximum length for an email address is 254 characters. The pattern verifies that an
- * unquoted @ sign exists.
+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters
+ * are allowed after the @ sign. However, the generally accepted maximum length for an email address is
+ * 254 characters. The pattern verifies that an unquoted @ sign exists.
*/
public function getEmailAddress(): ?string
{
@@ -103,10 +108,9 @@ class PaypalWallet implements \JsonSerializable
/**
* Sets Email Address.
- * The internationalized email address.Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. * * @maps email_address */ @@ -253,10 +257,9 @@ class PaypalWallet implements \JsonSerializable /** * Returns Experience Context. - * Customizes the payer experience during the approval process for payment with PayPal. - *@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Partners and Marketplaces might configure+ * Customizes the payer experience during the approval process for payment with PayPal. Note: Partners + * and Marketplaces might configure brand_name and shipping_preference during partner account setup, + * which overrides the request values. */ public function getExperienceContext(): ?PaypalWalletExperienceContext { @@ -265,10 +268,9 @@ class PaypalWallet implements \JsonSerializable /** * Sets Experience Context. - * Customizes the payer experience during the approval process for payment with PayPal. - *brand_name- * andshipping_preferenceduring partner account setup, which overrides the request - * values.
Note: Partners and Marketplaces might configure+ * Customizes the payer experience during the approval process for payment with PayPal. Note: Partners + * and Marketplaces might configure brand_name and shipping_preference during partner account setup, + * which overrides the request values. * * @maps experience_context */ @@ -297,6 +299,53 @@ class PaypalWallet implements \JsonSerializable $this->billingAgreementId = $billingAgreementId; } + /** + * Returns Stored Credential. + * Provides additional details to process a payment using the PayPal wallet billing agreement or a + * vaulted payment method that has been stored or is intended to be stored. + */ + public function getStoredCredential(): ?PaypalWalletStoredCredential + { + return $this->storedCredential; + } + + /** + * Sets Stored Credential. + * Provides additional details to process a payment using the PayPal wallet billing agreement or a + * vaulted payment method that has been stored or is intended to be stored. + * + * @maps stored_credential + */ + public function setStoredCredential(?PaypalWalletStoredCredential $storedCredential): void + { + $this->storedCredential = $storedCredential; + } + + /** + * Converts the PaypalWallet object to a human-readable string representation. + * + * @return string The string representation of the PaypalWallet object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PaypalWallet', + [ + 'vaultId' => $this->vaultId, + 'emailAddress' => $this->emailAddress, + 'name' => $this->name, + 'phone' => $this->phone, + 'birthDate' => $this->birthDate, + 'taxInfo' => $this->taxInfo, + 'address' => $this->address, + 'attributes' => $this->attributes, + 'experienceContext' => $this->experienceContext, + 'billingAgreementId' => $this->billingAgreementId, + 'storedCredential' => $this->storedCredential + ] + ); + } + /** * Encode this object to JSON * @@ -339,6 +388,9 @@ class PaypalWallet implements \JsonSerializable if (isset($this->billingAgreementId)) { $json['billing_agreement_id'] = $this->billingAgreementId; } + if (isset($this->storedCredential)) { + $json['stored_credential'] = $this->storedCredential; + } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; } diff --git a/src/Models/PaypalWalletAccountVerificationStatus.php b/src/Models/PaypalWalletAccountVerificationStatus.php index 96604cf..78433d2 100644 --- a/src/Models/PaypalWalletAccountVerificationStatus.php +++ b/src/Models/PaypalWalletAccountVerificationStatus.php @@ -10,37 +10,21 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The account status indicates whether the buyer has verified the financial details associated with * their PayPal account. */ class PaypalWalletAccountVerificationStatus { + /** + * The buyer has completed the verification of the financial details associated with this PayPal + * account. For example: confirming their bank account. + */ public const VERIFIED = 'VERIFIED'; - public const UNVERIFIED = 'UNVERIFIED'; - - private const _ALL_VALUES = [self::VERIFIED, self::UNVERIFIED]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * The buyer has not completed the verification of the financial details associated with this PayPal + * account. For example: confirming their bank account. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for PaypalWalletAccountVerificationStatus."); - } + public const UNVERIFIED = 'UNVERIFIED'; } diff --git a/src/Models/PaypalWalletAttributes.php b/src/Models/PaypalWalletAttributes.php index afac89c..b776cc2 100644 --- a/src/Models/PaypalWalletAttributes.php +++ b/src/Models/PaypalWalletAttributes.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -63,6 +64,19 @@ class PaypalWalletAttributes implements \JsonSerializable $this->vault = $vault; } + /** + * Converts the PaypalWalletAttributes object to a human-readable string representation. + * + * @return string The string representation of the PaypalWalletAttributes object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PaypalWalletAttributes', + ['customer' => $this->customer, 'vault' => $this->vault] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/PaypalWalletAttributesResponse.php b/src/Models/PaypalWalletAttributesResponse.php index f79c85a..4f71bd4 100644 --- a/src/Models/PaypalWalletAttributesResponse.php +++ b/src/Models/PaypalWalletAttributesResponse.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -73,6 +74,19 @@ class PaypalWalletAttributesResponse implements \JsonSerializable $this->cobrandedCards = $cobrandedCards; } + /** + * Converts the PaypalWalletAttributesResponse object to a human-readable string representation. + * + * @return string The string representation of the PaypalWalletAttributesResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PaypalWalletAttributesResponse', + ['vault' => $this->vault, 'cobrandedCards' => $this->cobrandedCards] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/PaypalWalletContextShippingPreference.php b/src/Models/PaypalWalletContextShippingPreference.php new file mode 100644 index 0000000..670f72a --- /dev/null +++ b/src/Models/PaypalWalletContextShippingPreference.php @@ -0,0 +1,35 @@ +Note: Up to 64 characters are - * allowed before and 255 characters are allowed after thebrand_name- * andshipping_preferenceduring partner account setup, which overrides the request - * values.
@ sign. However, the generally
- * accepted maximum length for an email address is 254 characters. The pattern verifies that an
- * unquoted @ sign exists.
+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters
+ * are allowed after the @ sign. However, the generally accepted maximum length for an email address is
+ * 254 characters. The pattern verifies that an unquoted @ sign exists.
*/
public function getEmailAddress(): ?string
{
@@ -71,10 +71,9 @@ class PaypalWalletCustomer implements \JsonSerializable
/**
* Sets Email Address.
- * The internationalized email address.Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. * * @maps email_address */ @@ -127,6 +126,24 @@ class PaypalWalletCustomer implements \JsonSerializable $this->merchantCustomerId = $merchantCustomerId; } + /** + * Converts the PaypalWalletCustomer object to a human-readable string representation. + * + * @return string The string representation of the PaypalWalletCustomer object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PaypalWalletCustomer', + [ + 'id' => $this->id, + 'emailAddress' => $this->emailAddress, + 'phone' => $this->phone, + 'merchantCustomerId' => $this->merchantCustomerId + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/PaypalWalletCustomerRequest.php b/src/Models/PaypalWalletCustomerRequest.php index f2568f8..9a8752c 100644 --- a/src/Models/PaypalWalletCustomerRequest.php +++ b/src/Models/PaypalWalletCustomerRequest.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; class PaypalWalletCustomerRequest implements \JsonSerializable @@ -56,10 +57,9 @@ class PaypalWalletCustomerRequest implements \JsonSerializable /** * Returns Email Address. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. */ public function getEmailAddress(): ?string { @@ -68,10 +68,9 @@ class PaypalWalletCustomerRequest implements \JsonSerializable /** * Sets Email Address. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. * * @maps email_address */ @@ -124,6 +123,24 @@ class PaypalWalletCustomerRequest implements \JsonSerializable $this->merchantCustomerId = $merchantCustomerId; } + /** + * Converts the PaypalWalletCustomerRequest object to a human-readable string representation. + * + * @return string The string representation of the PaypalWalletCustomerRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PaypalWalletCustomerRequest', + [ + 'id' => $this->id, + 'emailAddress' => $this->emailAddress, + 'phone' => $this->phone, + 'merchantCustomerId' => $this->merchantCustomerId + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/PaypalWalletExperienceContext.php b/src/Models/PaypalWalletExperienceContext.php index 62f4fdb..9777bda 100644 --- a/src/Models/PaypalWalletExperienceContext.php +++ b/src/Models/PaypalWalletExperienceContext.php @@ -10,13 +10,13 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** - * Customizes the payer experience during the approval process for payment with PayPal. - *@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Partners and Marketplaces might configure+ * Customizes the payer experience during the approval process for payment with PayPal. Note: Partners + * and Marketplaces might configure brand_name and shipping_preference during partner account setup, + * which overrides the request values. */ class PaypalWalletExperienceContext implements \JsonSerializable { @@ -33,7 +33,7 @@ class PaypalWalletExperienceContext implements \JsonSerializable /** * @var string|null */ - private $shippingPreference = ShippingPreference::GET_FROM_FILE; + private $shippingPreference = PaypalWalletContextShippingPreference::GET_FROM_FILE; /** * @var string|null @@ -60,6 +60,11 @@ class PaypalWalletExperienceContext implements \JsonSerializable */ private $paymentMethodPreference = PayeePaymentMethodPreference::UNRESTRICTED; + /** + * @var CallbackConfiguration|null + */ + private $orderUpdateCallbackConfig; + /** * Returns Brand Name. * The label that overrides the business name in the PayPal account on the PayPal site. The pattern is @@ -194,7 +199,7 @@ class PaypalWalletExperienceContext implements \JsonSerializable /** * Returns User Action. - * Configures a Continue or Pay Now checkout flow. + * Configures a Continue or Pay Now checkout flow. */ public function getUserAction(): ?string { @@ -203,7 +208,7 @@ class PaypalWalletExperienceContext implements \JsonSerializable /** * Sets User Action. - * Configures a Continue or Pay Now checkout flow. + * Configures a Continue or Pay Now checkout flow. * * @maps user_action */ @@ -232,6 +237,49 @@ class PaypalWalletExperienceContext implements \JsonSerializable $this->paymentMethodPreference = $paymentMethodPreference; } + /** + * Returns Order Update Callback Config. + * CallBack Configuration that the merchant can provide to PayPal/Venmo. + */ + public function getOrderUpdateCallbackConfig(): ?CallbackConfiguration + { + return $this->orderUpdateCallbackConfig; + } + + /** + * Sets Order Update Callback Config. + * CallBack Configuration that the merchant can provide to PayPal/Venmo. + * + * @maps order_update_callback_config + */ + public function setOrderUpdateCallbackConfig(?CallbackConfiguration $orderUpdateCallbackConfig): void + { + $this->orderUpdateCallbackConfig = $orderUpdateCallbackConfig; + } + + /** + * Converts the PaypalWalletExperienceContext object to a human-readable string representation. + * + * @return string The string representation of the PaypalWalletExperienceContext object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PaypalWalletExperienceContext', + [ + 'brandName' => $this->brandName, + 'locale' => $this->locale, + 'shippingPreference' => $this->shippingPreference, + 'returnUrl' => $this->returnUrl, + 'cancelUrl' => $this->cancelUrl, + 'landingPage' => $this->landingPage, + 'userAction' => $this->userAction, + 'paymentMethodPreference' => $this->paymentMethodPreference, + 'orderUpdateCallbackConfig' => $this->orderUpdateCallbackConfig + ] + ); + } + /** * Encode this object to JSON * @@ -245,31 +293,31 @@ class PaypalWalletExperienceContext implements \JsonSerializable { $json = []; if (isset($this->brandName)) { - $json['brand_name'] = $this->brandName; + $json['brand_name'] = $this->brandName; } if (isset($this->locale)) { - $json['locale'] = $this->locale; + $json['locale'] = $this->locale; } if (isset($this->shippingPreference)) { - $json['shipping_preference'] = ShippingPreference::checkValue($this->shippingPreference); + $json['shipping_preference'] = $this->shippingPreference; } if (isset($this->returnUrl)) { - $json['return_url'] = $this->returnUrl; + $json['return_url'] = $this->returnUrl; } if (isset($this->cancelUrl)) { - $json['cancel_url'] = $this->cancelUrl; + $json['cancel_url'] = $this->cancelUrl; } if (isset($this->landingPage)) { - $json['landing_page'] = PaypalExperienceLandingPage::checkValue($this->landingPage); + $json['landing_page'] = $this->landingPage; } if (isset($this->userAction)) { - $json['user_action'] = PaypalExperienceUserAction::checkValue($this->userAction); + $json['user_action'] = $this->userAction; } if (isset($this->paymentMethodPreference)) { - $json['payment_method_preference'] = - PayeePaymentMethodPreference::checkValue( - $this->paymentMethodPreference - ); + $json['payment_method_preference'] = $this->paymentMethodPreference; + } + if (isset($this->orderUpdateCallbackConfig)) { + $json['order_update_callback_config'] = $this->orderUpdateCallbackConfig; } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; diff --git a/src/Models/PaypalWalletResponse.php b/src/Models/PaypalWalletResponse.php index 693e34d..7d3e76a 100644 --- a/src/Models/PaypalWalletResponse.php +++ b/src/Models/PaypalWalletResponse.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -72,12 +73,16 @@ class PaypalWalletResponse implements \JsonSerializable */ private $attributes; + /** + * @var PaypalWalletStoredCredential|null + */ + private $storedCredential; + /** * Returns Email Address. - * The internationalized email address.brand_name- * andshipping_preferenceduring partner account setup, which overrides the request - * values.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. */ public function getEmailAddress(): ?string { @@ -86,10 +91,9 @@ class PaypalWalletResponse implements \JsonSerializable /** * Sets Email Address. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. * * @maps email_address */ @@ -322,6 +326,54 @@ class PaypalWalletResponse implements \JsonSerializable $this->attributes = $attributes; } + /** + * Returns Stored Credential. + * Provides additional details to process a payment using the PayPal wallet billing agreement or a + * vaulted payment method that has been stored or is intended to be stored. + */ + public function getStoredCredential(): ?PaypalWalletStoredCredential + { + return $this->storedCredential; + } + + /** + * Sets Stored Credential. + * Provides additional details to process a payment using the PayPal wallet billing agreement or a + * vaulted payment method that has been stored or is intended to be stored. + * + * @maps stored_credential + */ + public function setStoredCredential(?PaypalWalletStoredCredential $storedCredential): void + { + $this->storedCredential = $storedCredential; + } + + /** + * Converts the PaypalWalletResponse object to a human-readable string representation. + * + * @return string The string representation of the PaypalWalletResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PaypalWalletResponse', + [ + 'emailAddress' => $this->emailAddress, + 'accountId' => $this->accountId, + 'accountStatus' => $this->accountStatus, + 'name' => $this->name, + 'phoneType' => $this->phoneType, + 'phoneNumber' => $this->phoneNumber, + 'birthDate' => $this->birthDate, + 'businessName' => $this->businessName, + 'taxInfo' => $this->taxInfo, + 'address' => $this->address, + 'attributes' => $this->attributes, + 'storedCredential' => $this->storedCredential + ] + ); + } + /** * Encode this object to JSON * @@ -335,37 +387,40 @@ class PaypalWalletResponse implements \JsonSerializable { $json = []; if (isset($this->emailAddress)) { - $json['email_address'] = $this->emailAddress; + $json['email_address'] = $this->emailAddress; } if (isset($this->accountId)) { - $json['account_id'] = $this->accountId; + $json['account_id'] = $this->accountId; } if (isset($this->accountStatus)) { - $json['account_status'] = PaypalWalletAccountVerificationStatus::checkValue($this->accountStatus); + $json['account_status'] = $this->accountStatus; } if (isset($this->name)) { - $json['name'] = $this->name; + $json['name'] = $this->name; } if (isset($this->phoneType)) { - $json['phone_type'] = PhoneType::checkValue($this->phoneType); + $json['phone_type'] = $this->phoneType; } if (isset($this->phoneNumber)) { - $json['phone_number'] = $this->phoneNumber; + $json['phone_number'] = $this->phoneNumber; } if (isset($this->birthDate)) { - $json['birth_date'] = $this->birthDate; + $json['birth_date'] = $this->birthDate; } if (isset($this->businessName)) { - $json['business_name'] = $this->businessName; + $json['business_name'] = $this->businessName; } if (isset($this->taxInfo)) { - $json['tax_info'] = $this->taxInfo; + $json['tax_info'] = $this->taxInfo; } if (isset($this->address)) { - $json['address'] = $this->address; + $json['address'] = $this->address; } if (isset($this->attributes)) { - $json['attributes'] = $this->attributes; + $json['attributes'] = $this->attributes; + } + if (isset($this->storedCredential)) { + $json['stored_credential'] = $this->storedCredential; } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; diff --git a/src/Models/PaypalWalletStoredCredential.php b/src/Models/PaypalWalletStoredCredential.php new file mode 100644 index 0000000..2cd172b --- /dev/null +++ b/src/Models/PaypalWalletStoredCredential.php @@ -0,0 +1,176 @@ +paymentInitiator = $paymentInitiator; + } + + /** + * Returns Payment Initiator. + * The person or party who initiated or triggered the payment. + */ + public function getPaymentInitiator(): string + { + return $this->paymentInitiator; + } + + /** + * Sets Payment Initiator. + * The person or party who initiated or triggered the payment. + * + * @required + * @maps payment_initiator + */ + public function setPaymentInitiator(string $paymentInitiator): void + { + $this->paymentInitiator = $paymentInitiator; + } + + /** + * Returns Charge Pattern. + * Expected business/pricing model for the billing agreement. + */ + public function getChargePattern(): ?string + { + return $this->chargePattern; + } + + /** + * Sets Charge Pattern. + * Expected business/pricing model for the billing agreement. + * + * @maps charge_pattern + */ + public function setChargePattern(?string $chargePattern): void + { + $this->chargePattern = $chargePattern; + } + + /** + * Returns Usage Pattern. + * Expected business/pricing model for the billing agreement. + */ + public function getUsagePattern(): ?string + { + return $this->usagePattern; + } + + /** + * Sets Usage Pattern. + * Expected business/pricing model for the billing agreement. + * + * @maps usage_pattern + */ + public function setUsagePattern(?string $usagePattern): void + { + $this->usagePattern = $usagePattern; + } + + /** + * Returns Usage. + * Indicates if this is a `first` or `subsequent` payment using a stored payment source (also referred + * to as stored credential or card on file). + */ + public function getUsage(): ?string + { + return $this->usage; + } + + /** + * Sets Usage. + * Indicates if this is a `first` or `subsequent` payment using a stored payment source (also referred + * to as stored credential or card on file). + * + * @maps usage + */ + public function setUsage(?string $usage): void + { + $this->usage = $usage; + } + + /** + * Converts the PaypalWalletStoredCredential object to a human-readable string representation. + * + * @return string The string representation of the PaypalWalletStoredCredential object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PaypalWalletStoredCredential', + [ + 'paymentInitiator' => $this->paymentInitiator, + 'chargePattern' => $this->chargePattern, + 'usagePattern' => $this->usagePattern, + 'usage' => $this->usage + ] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + $json['payment_initiator'] = $this->paymentInitiator; + if (isset($this->chargePattern)) { + $json['charge_pattern'] = $this->chargePattern; + } + if (isset($this->usagePattern)) { + $json['usage_pattern'] = $this->usagePattern; + } + if (isset($this->usage)) { + $json['usage'] = $this->usage; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/PaypalWalletVaultInstruction.php b/src/Models/PaypalWalletVaultInstruction.php index 8740740..ae2681a 100644 --- a/src/Models/PaypalWalletVaultInstruction.php +++ b/src/Models/PaypalWalletVaultInstruction.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; class PaypalWalletVaultInstruction implements \JsonSerializable @@ -187,6 +188,26 @@ class PaypalWalletVaultInstruction implements \JsonSerializable $this->permitMultiplePaymentTokens = $permitMultiplePaymentTokens; } + /** + * Converts the PaypalWalletVaultInstruction object to a human-readable string representation. + * + * @return string The string representation of the PaypalWalletVaultInstruction object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PaypalWalletVaultInstruction', + [ + 'storeInVault' => $this->storeInVault, + 'description' => $this->description, + 'usagePattern' => $this->usagePattern, + 'usageType' => $this->usageType, + 'customerType' => $this->customerType, + 'permitMultiplePaymentTokens' => $this->permitMultiplePaymentTokens + ] + ); + } + /** * Encode this object to JSON * @@ -200,17 +221,17 @@ class PaypalWalletVaultInstruction implements \JsonSerializable { $json = []; if (isset($this->storeInVault)) { - $json['store_in_vault'] = StoreInVaultInstruction::checkValue($this->storeInVault); + $json['store_in_vault'] = $this->storeInVault; } if (isset($this->description)) { $json['description'] = $this->description; } if (isset($this->usagePattern)) { - $json['usage_pattern'] = PaypalPaymentTokenUsagePattern::checkValue($this->usagePattern); + $json['usage_pattern'] = $this->usagePattern; } - $json['usage_type'] = PaypalPaymentTokenUsageType::checkValue($this->usageType); + $json['usage_type'] = $this->usageType; if (isset($this->customerType)) { - $json['customer_type'] = PaypalPaymentTokenCustomerType::checkValue($this->customerType); + $json['customer_type'] = $this->customerType; } if (isset($this->permitMultiplePaymentTokens)) { $json['permit_multiple_payment_tokens'] = $this->permitMultiplePaymentTokens; diff --git a/src/Models/PaypalWalletVaultResponse.php b/src/Models/PaypalWalletVaultResponse.php index 409a26c..3c1ce98 100644 --- a/src/Models/PaypalWalletVaultResponse.php +++ b/src/Models/PaypalWalletVaultResponse.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -121,6 +122,19 @@ class PaypalWalletVaultResponse implements \JsonSerializable $this->customer = $customer; } + /** + * Converts the PaypalWalletVaultResponse object to a human-readable string representation. + * + * @return string The string representation of the PaypalWalletVaultResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PaypalWalletVaultResponse', + ['id' => $this->id, 'status' => $this->status, 'links' => $this->links, 'customer' => $this->customer] + ); + } + /** * Encode this object to JSON * @@ -137,7 +151,7 @@ class PaypalWalletVaultResponse implements \JsonSerializable $json['id'] = $this->id; } if (isset($this->status)) { - $json['status'] = PaypalWalletVaultStatus::checkValue($this->status); + $json['status'] = $this->status; } if (isset($this->links)) { $json['links'] = $this->links; diff --git a/src/Models/PaypalWalletVaultStatus.php b/src/Models/PaypalWalletVaultStatus.php index 9bf7b21..c5d1780 100644 --- a/src/Models/PaypalWalletVaultStatus.php +++ b/src/Models/PaypalWalletVaultStatus.php @@ -10,38 +10,26 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The vault status. */ class PaypalWalletVaultStatus { + /** + * The payment source has been saved in your customer's vault. This vault status reflects `/v3/vault` + * status. + */ public const VAULTED = 'VAULTED'; + /** + * DEPRECATED. The payment source has been saved in your customer's vault. This status applies to + * deprecated integration patterns and will not be returned for v3/vault integrations. + */ public const CREATED = 'CREATED'; - public const APPROVED = 'APPROVED'; - - private const _ALL_VALUES = [self::VAULTED, self::CREATED, self::APPROVED]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * Customer has approved the action of saving the specified payment_source into their vault. Use + * v3/vault/payment-tokens with given setup_token to save the payment source in the vault */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for PaypalWalletVaultStatus."); - } + public const APPROVED = 'APPROVED'; } diff --git a/src/Models/Phone.php b/src/Models/Phone.php index 9167e09..8c0cb1c 100644 --- a/src/Models/Phone.php +++ b/src/Models/Phone.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -117,6 +118,23 @@ class Phone implements \JsonSerializable $this->extensionNumber = $extensionNumber; } + /** + * Converts the Phone object to a human-readable string representation. + * + * @return string The string representation of the Phone object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'Phone', + [ + 'countryCode' => $this->countryCode, + 'nationalNumber' => $this->nationalNumber, + 'extensionNumber' => $this->extensionNumber + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/PhoneNumber.php b/src/Models/PhoneNumber.php index e595acc..165d336 100644 --- a/src/Models/PhoneNumber.php +++ b/src/Models/PhoneNumber.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -58,6 +59,16 @@ class PhoneNumber implements \JsonSerializable $this->nationalNumber = $nationalNumber; } + /** + * Converts the PhoneNumber object to a human-readable string representation. + * + * @return string The string representation of the PhoneNumber object. + */ + public function __toString(): string + { + return ApiHelper::stringify('PhoneNumber', ['nationalNumber' => $this->nationalNumber]); + } + /** * Encode this object to JSON * diff --git a/src/Models/PhoneNumberWithCountryCode.php b/src/Models/PhoneNumberWithCountryCode.php index fbec0f9..f5b76b3 100644 --- a/src/Models/PhoneNumberWithCountryCode.php +++ b/src/Models/PhoneNumberWithCountryCode.php @@ -10,11 +10,13 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** * The phone number in its canonical international [E.164 numbering plan format](https://www.itu. - * int/rec/T-REC-E.164/en). + * int/rec/T-REC-E.164/en)., The phone number, in its canonical international [E.164 numbering plan + * format](https://www.itu.int/rec/T-REC-E.164/en). */ class PhoneNumberWithCountryCode implements \JsonSerializable { @@ -92,6 +94,19 @@ class PhoneNumberWithCountryCode implements \JsonSerializable $this->nationalNumber = $nationalNumber; } + /** + * Converts the PhoneNumberWithCountryCode object to a human-readable string representation. + * + * @return string The string representation of the PhoneNumberWithCountryCode object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PhoneNumberWithCountryCode', + ['countryCode' => $this->countryCode, 'nationalNumber' => $this->nationalNumber] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/PhoneType.php b/src/Models/PhoneType.php index db05783..851dad8 100644 --- a/src/Models/PhoneType.php +++ b/src/Models/PhoneType.php @@ -10,10 +10,6 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The phone type. */ @@ -28,24 +24,4 @@ class PhoneType public const OTHER = 'OTHER'; public const PAGER = 'PAGER'; - - private const _ALL_VALUES = [self::FAX, self::HOME, self::MOBILE, self::OTHER, self::PAGER]; - - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum - */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for PhoneType."); - } } diff --git a/src/Models/PhoneWithType.php b/src/Models/PhoneWithType.php index c5737ed..d47c4be 100644 --- a/src/Models/PhoneWithType.php +++ b/src/Models/PhoneWithType.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -78,6 +79,19 @@ class PhoneWithType implements \JsonSerializable $this->phoneNumber = $phoneNumber; } + /** + * Converts the PhoneWithType object to a human-readable string representation. + * + * @return string The string representation of the PhoneWithType object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PhoneWithType', + ['phoneType' => $this->phoneType, 'phoneNumber' => $this->phoneNumber] + ); + } + /** * Encode this object to JSON * @@ -91,7 +105,7 @@ class PhoneWithType implements \JsonSerializable { $json = []; if (isset($this->phoneType)) { - $json['phone_type'] = PhoneType::checkValue($this->phoneType); + $json['phone_type'] = $this->phoneType; } $json['phone_number'] = $this->phoneNumber; diff --git a/src/Models/Plan.php b/src/Models/Plan.php new file mode 100644 index 0000000..2091380 --- /dev/null +++ b/src/Models/Plan.php @@ -0,0 +1,184 @@ +billingCycles = $billingCycles; + $this->oneTimeCharges = $oneTimeCharges; + } + + /** + * Returns Billing Cycles. + * An array of billing cycles for trial billing and regular billing. A plan can have at most two trial + * cycles and only one regular cycle. + * + * @return BillingCycle[] + */ + public function getBillingCycles(): array + { + return $this->billingCycles; + } + + /** + * Sets Billing Cycles. + * An array of billing cycles for trial billing and regular billing. A plan can have at most two trial + * cycles and only one regular cycle. + * + * @required + * @maps billing_cycles + * + * @param BillingCycle[] $billingCycles + */ + public function setBillingCycles(array $billingCycles): void + { + $this->billingCycles = $billingCycles; + } + + /** + * Returns Product. + * Product details associated with any one-time product purchase. + * + * @return mixed + */ + public function getProduct() + { + return $this->product; + } + + /** + * Sets Product. + * Product details associated with any one-time product purchase. + * + * @maps product + * + * @param mixed $product + */ + public function setProduct($product): void + { + $this->product = $product; + } + + /** + * Returns One Time Charges. + * The one-time charge info at the time of checkout. + */ + public function getOneTimeCharges(): OneTimeCharge + { + return $this->oneTimeCharges; + } + + /** + * Sets One Time Charges. + * The one-time charge info at the time of checkout. + * + * @required + * @maps one_time_charges + */ + public function setOneTimeCharges(OneTimeCharge $oneTimeCharges): void + { + $this->oneTimeCharges = $oneTimeCharges; + } + + /** + * Returns Name. + * Name of the recurring plan. + */ + public function getName(): ?string + { + return $this->name; + } + + /** + * Sets Name. + * Name of the recurring plan. + * + * @maps name + */ + public function setName(?string $name): void + { + $this->name = $name; + } + + /** + * Converts the Plan object to a human-readable string representation. + * + * @return string The string representation of the Plan object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'Plan', + [ + 'billingCycles' => $this->billingCycles, + 'product' => $this->product, + 'oneTimeCharges' => $this->oneTimeCharges, + 'name' => $this->name + ] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + $json['billing_cycles'] = $this->billingCycles; + if (isset($this->product)) { + $json['product'] = $this->product; + } + $json['one_time_charges'] = $this->oneTimeCharges; + if (isset($this->name)) { + $json['name'] = $this->name; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/PlatformFee.php b/src/Models/PlatformFee.php index e816df3..77705ff 100644 --- a/src/Models/PlatformFee.php +++ b/src/Models/PlatformFee.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -80,6 +81,16 @@ class PlatformFee implements \JsonSerializable $this->payee = $payee; } + /** + * Converts the PlatformFee object to a human-readable string representation. + * + * @return string The string representation of the PlatformFee object. + */ + public function __toString(): string + { + return ApiHelper::stringify('PlatformFee', ['amount' => $this->amount, 'payee' => $this->payee]); + } + /** * Encode this object to JSON * diff --git a/src/Models/PricingModel.php b/src/Models/PricingModel.php new file mode 100644 index 0000000..443f0d3 --- /dev/null +++ b/src/Models/PricingModel.php @@ -0,0 +1,32 @@ +pricingModel = $pricingModel; + } + + /** + * Returns Price. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getPrice(): ?Money + { + return $this->price; + } + + /** + * Sets Price. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps price + */ + public function setPrice(?Money $price): void + { + $this->price = $price; + } + + /** + * Returns Pricing Model. + * The pricing model for the billing cycle. + */ + public function getPricingModel(): string + { + return $this->pricingModel; + } + + /** + * Sets Pricing Model. + * The pricing model for the billing cycle. + * + * @required + * @maps pricing_model + */ + public function setPricingModel(string $pricingModel): void + { + $this->pricingModel = $pricingModel; + } + + /** + * Returns Reload Threshold Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getReloadThresholdAmount(): ?Money + { + return $this->reloadThresholdAmount; + } + + /** + * Sets Reload Threshold Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps reload_threshold_amount + */ + public function setReloadThresholdAmount(?Money $reloadThresholdAmount): void + { + $this->reloadThresholdAmount = $reloadThresholdAmount; + } + + /** + * Converts the PricingScheme object to a human-readable string representation. + * + * @return string The string representation of the PricingScheme object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PricingScheme', + [ + 'price' => $this->price, + 'pricingModel' => $this->pricingModel, + 'reloadThresholdAmount' => $this->reloadThresholdAmount + ] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + if (isset($this->price)) { + $json['price'] = $this->price; + } + $json['pricing_model'] = $this->pricingModel; + if (isset($this->reloadThresholdAmount)) { + $json['reload_threshold_amount'] = $this->reloadThresholdAmount; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/ProcessorResponse.php b/src/Models/ProcessorResponse.php index 198f79b..2999abc 100644 --- a/src/Models/ProcessorResponse.php +++ b/src/Models/ProcessorResponse.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -119,6 +120,24 @@ class ProcessorResponse implements \JsonSerializable $this->paymentAdviceCode = $paymentAdviceCode; } + /** + * Converts the ProcessorResponse object to a human-readable string representation. + * + * @return string The string representation of the ProcessorResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'ProcessorResponse', + [ + 'avsCode' => $this->avsCode, + 'cvvCode' => $this->cvvCode, + 'responseCode' => $this->responseCode, + 'paymentAdviceCode' => $this->paymentAdviceCode + ] + ); + } + /** * Encode this object to JSON * @@ -132,16 +151,16 @@ class ProcessorResponse implements \JsonSerializable { $json = []; if (isset($this->avsCode)) { - $json['avs_code'] = AvsCode::checkValue($this->avsCode); + $json['avs_code'] = $this->avsCode; } if (isset($this->cvvCode)) { - $json['cvv_code'] = CvvCode::checkValue($this->cvvCode); + $json['cvv_code'] = $this->cvvCode; } if (isset($this->responseCode)) { - $json['response_code'] = ProcessorResponseCode::checkValue($this->responseCode); + $json['response_code'] = $this->responseCode; } if (isset($this->paymentAdviceCode)) { - $json['payment_advice_code'] = PaymentAdviceCode::checkValue($this->paymentAdviceCode); + $json['payment_advice_code'] = $this->paymentAdviceCode; } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; diff --git a/src/Models/ProcessorResponseCode.php b/src/Models/ProcessorResponseCode.php index b44f368..44b50e2 100644 --- a/src/Models/ProcessorResponseCode.php +++ b/src/Models/ProcessorResponseCode.php @@ -10,495 +10,778 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * Processor response code for the non-PayPal payment processor errors. */ class ProcessorResponseCode { - public const ENUM_0000 = '0000'; - - public const ENUM_00N7 = '00N7'; - - public const ENUM_0100 = '0100'; - - public const ENUM_0390 = '0390'; - - public const ENUM_0500 = '0500'; - - public const ENUM_0580 = '0580'; - - public const ENUM_0800 = '0800'; - - public const ENUM_0880 = '0880'; - - public const ENUM_0890 = '0890'; - - public const ENUM_0960 = '0960'; - - public const ENUM_0R00 = '0R00'; - - public const ENUM_1000 = '1000'; - - public const ENUM_10BR = '10BR'; - - public const ENUM_1300 = '1300'; - - public const ENUM_1310 = '1310'; - - public const ENUM_1312 = '1312'; - - public const ENUM_1317 = '1317'; - - public const ENUM_1320 = '1320'; - - public const ENUM_1330 = '1330'; - - public const ENUM_1335 = '1335'; - - public const ENUM_1340 = '1340'; - - public const ENUM_1350 = '1350'; - - public const ENUM_1352 = '1352'; - - public const ENUM_1360 = '1360'; - - public const ENUM_1370 = '1370'; - - public const ENUM_1380 = '1380'; - - public const ENUM_1382 = '1382'; - - public const ENUM_1384 = '1384'; - - public const ENUM_1390 = '1390'; - - public const ENUM_1393 = '1393'; - - public const ENUM_5100 = '5100'; - - public const ENUM_5110 = '5110'; - - public const ENUM_5120 = '5120'; - - public const ENUM_5130 = '5130'; - - public const ENUM_5135 = '5135'; - - public const ENUM_5140 = '5140'; - - public const ENUM_5150 = '5150'; - - public const ENUM_5160 = '5160'; - - public const ENUM_5170 = '5170'; - - public const ENUM_5180 = '5180'; - - public const ENUM_5190 = '5190'; - - public const ENUM_5200 = '5200'; - - public const ENUM_5210 = '5210'; - - public const ENUM_5400 = '5400'; - - public const ENUM_5500 = '5500'; - - public const ENUM_5650 = '5650'; - - public const ENUM_5700 = '5700'; - - public const ENUM_5710 = '5710'; - - public const ENUM_5800 = '5800'; - - public const ENUM_5900 = '5900'; - - public const ENUM_5910 = '5910'; - - public const ENUM_5920 = '5920'; - - public const ENUM_5930 = '5930'; - - public const ENUM_5950 = '5950'; - - public const ENUM_6300 = '6300'; - - public const ENUM_7600 = '7600'; - - public const ENUM_7700 = '7700'; - - public const ENUM_7710 = '7710'; - - public const ENUM_7800 = '7800'; - - public const ENUM_7900 = '7900'; - - public const ENUM_8000 = '8000'; - - public const ENUM_8010 = '8010'; - - public const ENUM_8020 = '8020'; - - public const ENUM_8030 = '8030'; - - public const ENUM_8100 = '8100'; - - public const ENUM_8110 = '8110'; - - public const ENUM_8220 = '8220'; - - public const ENUM_9100 = '9100'; - - public const ENUM_9500 = '9500'; - - public const ENUM_9510 = '9510'; - - public const ENUM_9520 = '9520'; - - public const ENUM_9530 = '9530'; - - public const ENUM_9540 = '9540'; - - public const ENUM_9600 = '9600'; - - public const PCNR = 'PCNR'; - - public const PCVV = 'PCVV'; - - public const PP06 = 'PP06'; - - public const PPRN = 'PPRN'; - - public const PPAD = 'PPAD'; - - public const PPAB = 'PPAB'; - - public const PPAE = 'PPAE'; - - public const PPAG = 'PPAG'; - - public const PPAI = 'PPAI'; - - public const PPAR = 'PPAR'; - - public const PPAU = 'PPAU'; - - public const PPAV = 'PPAV'; - - public const PPAX = 'PPAX'; - - public const PPBG = 'PPBG'; - - public const PPC2 = 'PPC2'; - - public const PPCE = 'PPCE'; - - public const PPCO = 'PPCO'; - - public const PPCR = 'PPCR'; - - public const PPCT = 'PPCT'; - - public const PPCU = 'PPCU'; - - public const PPD3 = 'PPD3'; - - public const PPDC = 'PPDC'; - - public const PPDI = 'PPDI'; - - public const PPDV = 'PPDV'; - - public const PPDT = 'PPDT'; - - public const PPEF = 'PPEF'; - - public const PPEL = 'PPEL'; - - public const PPER = 'PPER'; - - public const PPEX = 'PPEX'; - - public const PPFE = 'PPFE'; - - public const PPFI = 'PPFI'; - - public const PPFR = 'PPFR'; - - public const PPFV = 'PPFV'; - - public const PPGR = 'PPGR'; - - public const PPH1 = 'PPH1'; - - public const PPIF = 'PPIF'; - - public const PPII = 'PPII'; - - public const PPIM = 'PPIM'; - - public const PPIT = 'PPIT'; - - public const PPLR = 'PPLR'; - - public const PPLS = 'PPLS'; - - public const PPMB = 'PPMB'; - - public const PPMC = 'PPMC'; - - public const PPMD = 'PPMD'; - - public const PPNC = 'PPNC'; - - public const PPNL = 'PPNL'; - - public const PPNM = 'PPNM'; - - public const PPNT = 'PPNT'; - - public const PPPH = 'PPPH'; - - public const PPPI = 'PPPI'; - - public const PPPM = 'PPPM'; - - public const PPQC = 'PPQC'; - - public const PPRE = 'PPRE'; - - public const PPRF = 'PPRF'; - - public const PPRR = 'PPRR'; - - public const PPS0 = 'PPS0'; - - public const PPS1 = 'PPS1'; - - public const PPS2 = 'PPS2'; - - public const PPS3 = 'PPS3'; - - public const PPS4 = 'PPS4'; - - public const PPS5 = 'PPS5'; - - public const PPS6 = 'PPS6'; - - public const PPSC = 'PPSC'; - - public const PPSD = 'PPSD'; - - public const PPSE = 'PPSE'; - - public const PPTE = 'PPTE'; - - public const PPTF = 'PPTF'; - - public const PPTI = 'PPTI'; - - public const PPTR = 'PPTR'; - - public const PPTT = 'PPTT'; - - public const PPTV = 'PPTV'; - - public const PPUA = 'PPUA'; - - public const PPUC = 'PPUC'; - - public const PPUE = 'PPUE'; - - public const PPUI = 'PPUI'; - - public const PPUP = 'PPUP'; - - public const PPUR = 'PPUR'; - - public const PPVC = 'PPVC'; - - public const PPVE = 'PPVE'; - - public const PPVT = 'PPVT'; - - private const _ALL_VALUES = [ - self::ENUM_0000, - self::ENUM_00N7, - self::ENUM_0100, - self::ENUM_0390, - self::ENUM_0500, - self::ENUM_0580, - self::ENUM_0800, - self::ENUM_0880, - self::ENUM_0890, - self::ENUM_0960, - self::ENUM_0R00, - self::ENUM_1000, - self::ENUM_10BR, - self::ENUM_1300, - self::ENUM_1310, - self::ENUM_1312, - self::ENUM_1317, - self::ENUM_1320, - self::ENUM_1330, - self::ENUM_1335, - self::ENUM_1340, - self::ENUM_1350, - self::ENUM_1352, - self::ENUM_1360, - self::ENUM_1370, - self::ENUM_1380, - self::ENUM_1382, - self::ENUM_1384, - self::ENUM_1390, - self::ENUM_1393, - self::ENUM_5100, - self::ENUM_5110, - self::ENUM_5120, - self::ENUM_5130, - self::ENUM_5135, - self::ENUM_5140, - self::ENUM_5150, - self::ENUM_5160, - self::ENUM_5170, - self::ENUM_5180, - self::ENUM_5190, - self::ENUM_5200, - self::ENUM_5210, - self::ENUM_5400, - self::ENUM_5500, - self::ENUM_5650, - self::ENUM_5700, - self::ENUM_5710, - self::ENUM_5800, - self::ENUM_5900, - self::ENUM_5910, - self::ENUM_5920, - self::ENUM_5930, - self::ENUM_5950, - self::ENUM_6300, - self::ENUM_7600, - self::ENUM_7700, - self::ENUM_7710, - self::ENUM_7800, - self::ENUM_7900, - self::ENUM_8000, - self::ENUM_8010, - self::ENUM_8020, - self::ENUM_8030, - self::ENUM_8100, - self::ENUM_8110, - self::ENUM_8220, - self::ENUM_9100, - self::ENUM_9500, - self::ENUM_9510, - self::ENUM_9520, - self::ENUM_9530, - self::ENUM_9540, - self::ENUM_9600, - self::PCNR, - self::PCVV, - self::PP06, - self::PPRN, - self::PPAD, - self::PPAB, - self::PPAE, - self::PPAG, - self::PPAI, - self::PPAR, - self::PPAU, - self::PPAV, - self::PPAX, - self::PPBG, - self::PPC2, - self::PPCE, - self::PPCO, - self::PPCR, - self::PPCT, - self::PPCU, - self::PPD3, - self::PPDC, - self::PPDI, - self::PPDV, - self::PPDT, - self::PPEF, - self::PPEL, - self::PPER, - self::PPEX, - self::PPFE, - self::PPFI, - self::PPFR, - self::PPFV, - self::PPGR, - self::PPH1, - self::PPIF, - self::PPII, - self::PPIM, - self::PPIT, - self::PPLR, - self::PPLS, - self::PPMB, - self::PPMC, - self::PPMD, - self::PPNC, - self::PPNL, - self::PPNM, - self::PPNT, - self::PPPH, - self::PPPI, - self::PPPM, - self::PPQC, - self::PPRE, - self::PPRF, - self::PPRR, - self::PPS0, - self::PPS1, - self::PPS2, - self::PPS3, - self::PPS4, - self::PPS5, - self::PPS6, - self::PPSC, - self::PPSD, - self::PPSE, - self::PPTE, - self::PPTF, - self::PPTI, - self::PPTR, - self::PPTT, - self::PPTV, - self::PPUA, - self::PPUC, - self::PPUE, - self::PPUI, - self::PPUP, - self::PPUR, - self::PPVC, - self::PPVE, - self::PPVT - ]; + /** + * APPROVED. + */ + public const RESPONSE_0000 = '0000'; /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * CVV2_FAILURE_POSSIBLE_RETRY_WITH_CVV. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for ProcessorResponseCode."); - } + public const RESPONSE_00N7 = '00N7'; + + /** + * REFERRAL. + */ + public const RESPONSE_0100 = '0100'; + + /** + * ACCOUNT_NOT_FOUND. + */ + public const RESPONSE_0390 = '0390'; + + /** + * DO_NOT_HONOR. + */ + public const RESPONSE_0500 = '0500'; + + /** + * UNAUTHORIZED_TRANSACTION. + */ + public const RESPONSE_0580 = '0580'; + + /** + * BAD_RESPONSE_REVERSAL_REQUIRED. + */ + public const RESPONSE_0800 = '0800'; + + /** + * CRYPTOGRAPHIC_FAILURE. + */ + public const RESPONSE_0880 = '0880'; + + /** + * UNACCEPTABLE_PIN. + */ + public const RESPONSE_0890 = '0890'; + + /** + * SYSTEM_MALFUNCTION. + */ + public const RESPONSE_0960 = '0960'; + + /** + * CANCELLED_PAYMENT. + */ + public const RESPONSE_0R00 = '0R00'; + + /** + * PARTIAL_AUTHORIZATION. + */ + public const RESPONSE_1000 = '1000'; + + /** + * ISSUER_REJECTED. + */ + public const RESPONSE_10BR = '10BR'; + + /** + * INVALID_DATA_FORMAT. + */ + public const RESPONSE_1300 = '1300'; + + /** + * INVALID_AMOUNT. + */ + public const RESPONSE_1310 = '1310'; + + /** + * INVALID_TRANSACTION_CARD_ISSUER_ACQUIRER. + */ + public const RESPONSE_1312 = '1312'; + + /** + * INVALID_CAPTURE_DATE. + */ + public const RESPONSE_1317 = '1317'; + + /** + * INVALID_CURRENCY_CODE. + */ + public const RESPONSE_1320 = '1320'; + + /** + * INVALID_ACCOUNT. + */ + public const RESPONSE_1330 = '1330'; + + /** + * INVALID_ACCOUNT_RECURRING. + */ + public const RESPONSE_1335 = '1335'; + + /** + * INVALID_TERMINAL. + */ + public const RESPONSE_1340 = '1340'; + + /** + * INVALID_MERCHANT. + */ + public const RESPONSE_1350 = '1350'; + + /** + * RESTRICTED_OR_INACTIVE_ACCOUNT. + */ + public const RESPONSE_1352 = '1352'; + + /** + * BAD_PROCESSING_CODE. + */ + public const RESPONSE_1360 = '1360'; + + /** + * INVALID_MCC. + */ + public const RESPONSE_1370 = '1370'; + + /** + * INVALID_EXPIRATION. + */ + public const RESPONSE_1380 = '1380'; + + /** + * INVALID_CARD_VERIFICATION_VALUE. + */ + public const RESPONSE_1382 = '1382'; + + /** + * INVALID_LIFE_CYCLE_OF_TRANSACTION. + */ + public const RESPONSE_1384 = '1384'; + + /** + * INVALID_ORDER. + */ + public const RESPONSE_1390 = '1390'; + + /** + * TRANSACTION_CANNOT_BE_COMPLETED. + */ + public const RESPONSE_1393 = '1393'; + + /** + * GENERIC_DECLINE. + */ + public const RESPONSE_5100 = '5100'; + + /** + * CVV2_FAILURE. + */ + public const RESPONSE_5110 = '5110'; + + /** + * INSUFFICIENT_FUNDS. + */ + public const RESPONSE_5120 = '5120'; + + /** + * INVALID_PIN. + */ + public const RESPONSE_5130 = '5130'; + + /** + * DECLINED_PIN_TRY_EXCEEDED. + */ + public const RESPONSE_5135 = '5135'; + + /** + * CARD_CLOSED. + */ + public const RESPONSE_5140 = '5140'; + + /** + * PICKUP_CARD_SPECIAL_CONDITIONS. Try using another card. Do not retry the same card. + */ + public const RESPONSE_5150 = '5150'; + + /** + * UNAUTHORIZED_USER. + */ + public const RESPONSE_5160 = '5160'; + + /** + * AVS_FAILURE. + */ + public const RESPONSE_5170 = '5170'; + + /** + * INVALID_OR_RESTRICTED_CARD. Try using another card. Do not retry the same card. + */ + public const RESPONSE_5180 = '5180'; + + /** + * SOFT_AVS. + */ + public const RESPONSE_5190 = '5190'; + + /** + * DUPLICATE_TRANSACTION. + */ + public const RESPONSE_5200 = '5200'; + + /** + * INVALID_TRANSACTION. + */ + public const RESPONSE_5210 = '5210'; + + /** + * EXPIRED_CARD. + */ + public const RESPONSE_5400 = '5400'; + + /** + * INCORRECT_PIN_REENTER. + */ + public const RESPONSE_5500 = '5500'; + + /** + * DECLINED_SCA_REQUIRED. + */ + public const RESPONSE_5650 = '5650'; + + /** + * TRANSACTION_NOT_PERMITTED. Outside of scope of accepted business. + */ + public const RESPONSE_5700 = '5700'; + + /** + * TX_ATTEMPTS_EXCEED_LIMIT. + */ + public const RESPONSE_5710 = '5710'; + + /** + * REVERSAL_REJECTED. + */ + public const RESPONSE_5800 = '5800'; + + /** + * INVALID_ISSUE. + */ + public const RESPONSE_5900 = '5900'; + + /** + * ISSUER_NOT_AVAILABLE_NOT_RETRIABLE. + */ + public const RESPONSE_5910 = '5910'; + + /** + * ISSUER_NOT_AVAILABLE_RETRIABLE. + */ + public const RESPONSE_5920 = '5920'; + + /** + * CARD_NOT_ACTIVATED. + */ + public const RESPONSE_5930 = '5930'; + + /** + * DECLINED_DUE_TO_UPDATED_ACCOUNT. External decline as an updated card has been issued. + */ + public const RESPONSE_5950 = '5950'; + + /** + * ACCOUNT_NOT_ON_FILE. + */ + public const RESPONSE_6300 = '6300'; + + /** + * APPROVED_NON_CAPTURE. + */ + public const RESPONSE_7600 = '7600'; + + /** + * ERROR_3DS. + */ + public const RESPONSE_7700 = '7700'; + + /** + * AUTHENTICATION_FAILED. + */ + public const RESPONSE_7710 = '7710'; + + /** + * BIN_ERROR. + */ + public const RESPONSE_7800 = '7800'; + + /** + * PIN_ERROR. + */ + public const RESPONSE_7900 = '7900'; + + /** + * PROCESSOR_SYSTEM_ERROR. + */ + public const RESPONSE_8000 = '8000'; + + /** + * HOST_KEY_ERROR. + */ + public const RESPONSE_8010 = '8010'; + + /** + * CONFIGURATION_ERROR. + */ + public const RESPONSE_8020 = '8020'; + + /** + * UNSUPPORTED_OPERATION. + */ + public const RESPONSE_8030 = '8030'; + + /** + * FATAL_COMMUNICATION_ERROR. + */ + public const RESPONSE_8100 = '8100'; + + /** + * RETRIABLE_COMMUNICATION_ERROR. + */ + public const RESPONSE_8110 = '8110'; + + /** + * SYSTEM_UNAVAILABLE. + */ + public const RESPONSE_8220 = '8220'; + + /** + * DECLINED_PLEASE_RETRY. Retry. + */ + public const RESPONSE_9100 = '9100'; + + /** + * SUSPECTED_FRAUD. Try using another card. Do not retry the same card. + */ + public const RESPONSE_9500 = '9500'; + + /** + * SECURITY_VIOLATION. + */ + public const RESPONSE_9510 = '9510'; + + /** + * LOST_OR_STOLEN. Try using another card. Do not retry the same card. + */ + public const RESPONSE_9520 = '9520'; + + /** + * HOLD_CALL_CENTER. The merchant must call the number on the back of the card. POS scenario. + */ + public const RESPONSE_9530 = '9530'; + + /** + * REFUSED_CARD. + */ + public const RESPONSE_9540 = '9540'; + + /** + * UNRECOGNIZED_RESPONSE_CODE. + */ + public const RESPONSE_9600 = '9600'; + + /** + * CONTINGENCIES_NOT_RESOLVED. + */ + public const RESPONSE_PCNR = 'PCNR'; + + /** + * CVV_FAILURE. + */ + public const RESPONSE_PCVV = 'PCVV'; + + /** + * ACCOUNT_CLOSED. A previously open account is now closed + */ + public const RESPONSE_PP06 = 'PP06'; + + /** + * REATTEMPT_NOT_PERMITTED. + */ + public const RESPONSE_PPRN = 'PPRN'; + + /** + * BILLING_ADDRESS. + */ + public const RESPONSE_PPAD = 'PPAD'; + + /** + * ACCOUNT_BLOCKED_BY_ISSUER. + */ + public const RESPONSE_PPAB = 'PPAB'; + + /** + * AMEX_DISABLED. + */ + public const RESPONSE_PPAE = 'PPAE'; + + /** + * ADULT_GAMING_UNSUPPORTED. + */ + public const RESPONSE_PPAG = 'PPAG'; + + /** + * AMOUNT_INCOMPATIBLE. + */ + public const RESPONSE_PPAI = 'PPAI'; + + /** + * AUTH_RESULT. + */ + public const RESPONSE_PPAR = 'PPAR'; + + /** + * MCC_CODE. + */ + public const RESPONSE_PPAU = 'PPAU'; + + /** + * ARC_AVS. + */ + public const RESPONSE_PPAV = 'PPAV'; + + /** + * AMOUNT_EXCEEDED. + */ + public const RESPONSE_PPAX = 'PPAX'; + + /** + * BAD_GAMING. + */ + public const RESPONSE_PPBG = 'PPBG'; + + /** + * ARC_CVV. + */ + public const RESPONSE_PPC2 = 'PPC2'; + + /** + * CE_REGISTRATION_INCOMPLETE. + */ + public const RESPONSE_PPCE = 'PPCE'; + + /** + * COUNTRY. + */ + public const RESPONSE_PPCO = 'PPCO'; + + /** + * CREDIT_ERROR. + */ + public const RESPONSE_PPCR = 'PPCR'; + + /** + * CARD_TYPE_UNSUPPORTED. + */ + public const RESPONSE_PPCT = 'PPCT'; + + /** + * CURRENCY_USED_INVALID. + */ + public const RESPONSE_PPCU = 'PPCU'; + + /** + * SECURE_ERROR_3DS. + */ + public const RESPONSE_PPD3 = 'PPD3'; + + /** + * DCC_UNSUPPORTED. + */ + public const RESPONSE_PPDC = 'PPDC'; + + /** + * DINERS_REJECT. + */ + public const RESPONSE_PPDI = 'PPDI'; + + /** + * AUTH_MESSAGE. + */ + public const RESPONSE_PPDV = 'PPDV'; + + /** + * DECLINE_THRESHOLD_BREACH. + */ + public const RESPONSE_PPDT = 'PPDT'; + + /** + * EXPIRED_FUNDING_INSTRUMENT. + */ + public const RESPONSE_PPEF = 'PPEF'; + + /** + * EXCEEDS_FREQUENCY_LIMIT. + */ + public const RESPONSE_PPEL = 'PPEL'; + + /** + * INTERNAL_SYSTEM_ERROR. + */ + public const RESPONSE_PPER = 'PPER'; + + /** + * EXPIRY_DATE. + */ + public const RESPONSE_PPEX = 'PPEX'; + + /** + * FUNDING_SOURCE_ALREADY_EXISTS. + */ + public const RESPONSE_PPFE = 'PPFE'; + + /** + * INVALID_FUNDING_INSTRUMENT. + */ + public const RESPONSE_PPFI = 'PPFI'; + + /** + * RESTRICTED_FUNDING_INSTRUMENT. + */ + public const RESPONSE_PPFR = 'PPFR'; + + /** + * FIELD_VALIDATION_FAILED. + */ + public const RESPONSE_PPFV = 'PPFV'; + + /** + * GAMING_REFUND_ERROR. + */ + public const RESPONSE_PPGR = 'PPGR'; + + /** + * H1_ERROR. + */ + public const RESPONSE_PPH1 = 'PPH1'; + + /** + * IDEMPOTENCY_FAILURE. + */ + public const RESPONSE_PPIF = 'PPIF'; + + /** + * INVALID_INPUT_FAILURE. + */ + public const RESPONSE_PPII = 'PPII'; + + /** + * ID_MISMATCH. + */ + public const RESPONSE_PPIM = 'PPIM'; + + /** + * INVALID_TRACE_ID. + */ + public const RESPONSE_PPIT = 'PPIT'; + + /** + * LATE_REVERSAL. + */ + public const RESPONSE_PPLR = 'PPLR'; + + /** + * LARGE_STATUS_CODE. + */ + public const RESPONSE_PPLS = 'PPLS'; + + /** + * MISSING_BUSINESS_RULE_OR_DATA. + */ + public const RESPONSE_PPMB = 'PPMB'; + + /** + * BLOCKED_Mastercard. + */ + public const RESPONSE_PPMC = 'PPMC'; + + /** + * DEPRECATED The PPMD value has been deprecated. + */ + public const RESPONSE_PPMD = 'PPMD'; + + /** + * NOT_SUPPORTED_NRC. + */ + public const RESPONSE_PPNC = 'PPNC'; + + /** + * EXCEEDS_NETWORK_FREQUENCY_LIMIT. + */ + public const RESPONSE_PPNL = 'PPNL'; + + /** + * NO_MID_FOUND. + */ + public const RESPONSE_PPNM = 'PPNM'; + + /** + * NETWORK_ERROR. + */ + public const RESPONSE_PPNT = 'PPNT'; + + /** + * NO_PHONE_FOR_DCC_TRANSACTION. + */ + public const RESPONSE_PPPH = 'PPPH'; + + /** + * INVALID_PRODUCT. + */ + public const RESPONSE_PPPI = 'PPPI'; + + /** + * INVALID_PAYMENT_METHOD. + */ + public const RESPONSE_PPPM = 'PPPM'; + + /** + * QUASI_CASH_UNSUPPORTED. + */ + public const RESPONSE_PPQC = 'PPQC'; + + /** + * UNSUPPORT_REFUND_ON_PENDING_BC. + */ + public const RESPONSE_PPRE = 'PPRE'; + + /** + * INVALID_PARENT_TRANSACTION_STATUS. + */ + public const RESPONSE_PPRF = 'PPRF'; + + /** + * MERCHANT_NOT_REGISTERED. + */ + public const RESPONSE_PPRR = 'PPRR'; + + /** + * BANKAUTH_ROW_MISMATCH. + */ + public const RESPONSE_PPS0 = 'PPS0'; + + /** + * BANKAUTH_ROW_SETTLED. + */ + public const RESPONSE_PPS1 = 'PPS1'; + + /** + * BANKAUTH_ROW_VOIDED. + */ + public const RESPONSE_PPS2 = 'PPS2'; + + /** + * BANKAUTH_EXPIRED. + */ + public const RESPONSE_PPS3 = 'PPS3'; + + /** + * CURRENCY_MISMATCH. + */ + public const RESPONSE_PPS4 = 'PPS4'; + + /** + * CREDITCARD_MISMATCH. + */ + public const RESPONSE_PPS5 = 'PPS5'; + + /** + * AMOUNT_MISMATCH. + */ + public const RESPONSE_PPS6 = 'PPS6'; + + /** + * ARC_SCORE. + */ + public const RESPONSE_PPSC = 'PPSC'; + + /** + * STATUS_DESCRIPTION. + */ + public const RESPONSE_PPSD = 'PPSD'; + + /** + * AMEX_DENIED. + */ + public const RESPONSE_PPSE = 'PPSE'; + + /** + * VERIFICATION_TOKEN_EXPIRED. + */ + public const RESPONSE_PPTE = 'PPTE'; + + /** + * INVALID_TRACE_REFERENCE. + */ + public const RESPONSE_PPTF = 'PPTF'; + + /** + * INVALID_TRANSACTION_ID. + */ + public const RESPONSE_PPTI = 'PPTI'; + + /** + * VERIFICATION_TOKEN_REVOKED. + */ + public const RESPONSE_PPTR = 'PPTR'; + + /** + * TRANSACTION_TYPE_UNSUPPORTED. + */ + public const RESPONSE_PPTT = 'PPTT'; + + /** + * INVALID_VERIFICATION_TOKEN. + */ + public const RESPONSE_PPTV = 'PPTV'; + + /** + * USER_NOT_AUTHORIZED. + */ + public const RESPONSE_PPUA = 'PPUA'; + + /** + * CURRENCY_CODE_UNSUPPORTED. + */ + public const RESPONSE_PPUC = 'PPUC'; + + /** + * UNSUPPORT_ENTITY. + */ + public const RESPONSE_PPUE = 'PPUE'; + + /** + * UNSUPPORT_INSTALLMENT. + */ + public const RESPONSE_PPUI = 'PPUI'; + + /** + * UNSUPPORT_POS_FLAG. + */ + public const RESPONSE_PPUP = 'PPUP'; + + /** + * UNSUPPORTED_REVERSAL. + */ + public const RESPONSE_PPUR = 'PPUR'; + + /** + * VALIDATE_CURRENCY. + */ + public const RESPONSE_PPVC = 'PPVC'; + + /** + * VALIDATION_ERROR. + */ + public const RESPONSE_PPVE = 'PPVE'; + + /** + * VIRTUAL_TERMINAL_UNSUPPORTED. + */ + public const RESPONSE_PPVT = 'PPVT'; } diff --git a/src/Models/PurchaseUnit.php b/src/Models/PurchaseUnit.php index a0b328a..0c58a3b 100644 --- a/src/Models/PurchaseUnit.php +++ b/src/Models/PurchaseUnit.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -28,7 +29,7 @@ class PurchaseUnit implements \JsonSerializable private $amount; /** - * @var Payee|null + * @var PayeeBase|null */ private $payee; @@ -91,8 +92,8 @@ class PurchaseUnit implements \JsonSerializable * Returns Reference Id. * The API caller-provided external ID for the purchase unit. Required for multiple purchase units when * you must update the order through `PATCH`. If you omit this value and the order contains only one - * purchase unit, PayPal sets this value to `default`.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: If there are
- * multiple purchase units, reference_id is required for each purchase unit.
+ * purchase unit, PayPal sets this value to `default`. Note: If there are multiple purchase units,
+ * reference_id is required for each purchase unit.
*/
public function getReferenceId(): ?string
{
@@ -103,8 +104,8 @@ class PurchaseUnit implements \JsonSerializable
* Sets Reference Id.
* The API caller-provided external ID for the purchase unit. Required for multiple purchase units when
* you must update the order through `PATCH`. If you omit this value and the order contains only one
- * purchase unit, PayPal sets this value to `default`. Note: If there are
- * multiple purchase units, reference_id is required for each purchase unit.
+ * purchase unit, PayPal sets this value to `default`. Note: If there are multiple purchase units,
+ * reference_id is required for each purchase unit.
*
* @maps reference_id
*/
@@ -116,11 +117,10 @@ class PurchaseUnit implements \JsonSerializable
/**
* Returns Amount.
* The total order amount with an optional breakdown that provides details, such as the total item
- * amount, total tax amount, shipping, handling, insurance, and discounts, if any.v2/checkout/orders/id/save.
+ * available when an order is saved by calling v2/checkout/orders/id/save.
*/
public function getId(): ?string
{
@@ -264,7 +263,7 @@ class PurchaseUnit implements \JsonSerializable
* The PayPal-generated ID for the purchase unit. This ID appears in both the payer's transaction
* history and the emails that the payer receives. In addition, this ID is available in transaction and
* settlement reports that merchants and API callers can use to reconcile transactions. This ID is only
- * available when an order is saved by calling v2/checkout/orders/id/save.
+ * available when an order is saved by calling v2/checkout/orders/id/save.
*
* @maps id
*/
@@ -277,15 +276,14 @@ class PurchaseUnit implements \JsonSerializable
* Returns Soft Descriptor.
* The payment descriptor on account transactions on the customer's credit card statement, that PayPal
* sends to processors. The maximum length of the soft descriptor information that you can pass in the
- * API field is 22 characters, in the following format:22 - len(PAYPAL * (8)) -
- * len(Descriptor in Payment Receiving Preferences of Merchant account + 1)The PAYPAL
- * prefix uses 8 characters.22 - len(PAYPAL * (8)) -
- * len(Descriptor in Payment Receiving Preferences of Merchant account + 1)The PAYPAL
- * prefix uses 8 characters.PAYPAL_prefix+(space)+merchant_descriptor+(space)+
- * soft_descriptorNote: The merchant descriptor is the - * descriptor of the merchant’s payment receiving preferences which can be seen by logging into the - * merchant account https://www.sandbox.paypal.com/businessprofile/settings/info/editThe - *
PAYPAL prefix uses 8 characters. Only the first 22 characters will be displayed in the
- * statement. PAYPAL *.
- * Janes Gift.800-123-1234.PAYPAL * Janes Gift 80.
+ * payer's card statement. If an Order is paid using the "PayPal Wallet", the statement descriptor will
+ * appear in following format on the payer's card statement:
+ * PAYPAL_prefix+(space)+merchant_descriptor+(space)+ soft_descriptor Note: The merchant descriptor is
+ * the descriptor of the merchant’s payment receiving preferences which can be seen by logging into the
+ * merchant account https://www.sandbox.paypal.com/businessprofile/settings/info/edit The PAYPAL prefix
+ * uses 8 characters. Only the first 22 characters will be displayed in the statement. For example, if:
+ * The PayPal prefix toggle is PAYPAL *. The merchant descriptor in the profile is Janes Gift. The soft
+ * descriptor is 800-123-1234. Then, the statement descriptor on the card is PAYPAL * Janes Gift 80.
*/
public function getSoftDescriptor(): ?string
{
@@ -270,17 +266,14 @@ class PurchaseUnitRequest implements \JsonSerializable
/**
* Sets Soft Descriptor.
* The soft descriptor is the dynamic text used to construct the statement descriptor that appears on a
- * payer's card statement.PAYPAL_prefix+(space)+merchant_descriptor+(space)+
- * soft_descriptorNote: The merchant descriptor is the - * descriptor of the merchant’s payment receiving preferences which can be seen by logging into the - * merchant account https://www.sandbox.paypal.com/businessprofile/settings/info/editThe - *
PAYPAL prefix uses 8 characters. Only the first 22 characters will be displayed in the
- * statement. PAYPAL *.
- * Janes Gift.800-123-1234.PAYPAL * Janes Gift 80.
+ * payer's card statement. If an Order is paid using the "PayPal Wallet", the statement descriptor will
+ * appear in following format on the payer's card statement:
+ * PAYPAL_prefix+(space)+merchant_descriptor+(space)+ soft_descriptor Note: The merchant descriptor is
+ * the descriptor of the merchant’s payment receiving preferences which can be seen by logging into the
+ * merchant account https://www.sandbox.paypal.com/businessprofile/settings/info/edit The PAYPAL prefix
+ * uses 8 characters. Only the first 22 characters will be displayed in the statement. For example, if:
+ * The PayPal prefix toggle is PAYPAL *. The merchant descriptor in the profile is Janes Gift. The soft
+ * descriptor is 800-123-1234. Then, the statement descriptor on the card is PAYPAL * Janes Gift 80.
*
* @maps soft_descriptor
*/
@@ -355,6 +348,31 @@ class PurchaseUnitRequest implements \JsonSerializable
$this->supplementaryData = $supplementaryData;
}
+ /**
+ * Converts the PurchaseUnitRequest object to a human-readable string representation.
+ *
+ * @return string The string representation of the PurchaseUnitRequest object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify(
+ 'PurchaseUnitRequest',
+ [
+ 'referenceId' => $this->referenceId,
+ 'amount' => $this->amount,
+ 'payee' => $this->payee,
+ 'paymentInstruction' => $this->paymentInstruction,
+ 'description' => $this->description,
+ 'customId' => $this->customId,
+ 'invoiceId' => $this->invoiceId,
+ 'softDescriptor' => $this->softDescriptor,
+ 'items' => $this->items,
+ 'shipping' => $this->shipping,
+ 'supplementaryData' => $this->supplementaryData
+ ]
+ );
+ }
+
/**
* Encode this object to JSON
*
diff --git a/src/Models/ReauthorizeRequest.php b/src/Models/ReauthorizeRequest.php
index 65f4493..9b47008 100644
--- a/src/Models/ReauthorizeRequest.php
+++ b/src/Models/ReauthorizeRequest.php
@@ -10,18 +10,19 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
+use PaypalServerSdkLib\ApiHelper;
use stdClass;
/**
* Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available,
* reauthorize a payment after its initial three-day honor period expires. You can reauthorize a
- * payment only once from days four to 29.Note: - * This request is currently not supported for Partner use cases.+ * payment only once from days four to 29. If 30 days have transpired since the date of the original + * authorization, you must create an authorized payment instead of reauthorizing the original + * authorized payment. A reauthorized payment itself has a new honor period of three days. You can + * reauthorize an authorized payment once. The allowed amount depends on context and geography, for + * example in US it is up to 115% of the original authorized amount, not to exceed an increase of $75 + * USD. Supports only the `amount` request parameter. Note: This request is currently not supported for + * Partner use cases. */ class ReauthorizeRequest implements \JsonSerializable { @@ -50,6 +51,16 @@ class ReauthorizeRequest implements \JsonSerializable $this->amount = $amount; } + /** + * Converts the ReauthorizeRequest object to a human-readable string representation. + * + * @return string The string representation of the ReauthorizeRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify('ReauthorizeRequest', ['amount' => $this->amount]); + } + /** * Encode this object to JSON * diff --git a/src/Models/Refund.php b/src/Models/Refund.php index 0d6cc82..f15fe68 100644 --- a/src/Models/Refund.php +++ b/src/Models/Refund.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -319,8 +320,8 @@ class Refund implements \JsonSerializable /** * Returns Create Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getCreateTime(): ?string { @@ -330,8 +331,8 @@ class Refund implements \JsonSerializable /** * Sets Create Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps create_time */ @@ -343,8 +344,8 @@ class Refund implements \JsonSerializable /** * Returns Update Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. */ public function getUpdateTime(): ?string { @@ -354,8 +355,8 @@ class Refund implements \JsonSerializable /** * Sets Update Time. * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. - * 6). Seconds are required while fractional seconds are optional.
Note: - * The regular expression provides guidance but does not reject all invalid dates.+ * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. * * @maps update_time */ @@ -364,6 +365,33 @@ class Refund implements \JsonSerializable $this->updateTime = $updateTime; } + /** + * Converts the Refund object to a human-readable string representation. + * + * @return string The string representation of the Refund object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'Refund', + [ + 'status' => $this->status, + 'statusDetails' => $this->statusDetails, + 'id' => $this->id, + 'amount' => $this->amount, + 'invoiceId' => $this->invoiceId, + 'customId' => $this->customId, + 'acquirerReferenceNumber' => $this->acquirerReferenceNumber, + 'noteToPayer' => $this->noteToPayer, + 'sellerPayableBreakdown' => $this->sellerPayableBreakdown, + 'payer' => $this->payer, + 'links' => $this->links, + 'createTime' => $this->createTime, + 'updateTime' => $this->updateTime + ] + ); + } + /** * Encode this object to JSON * @@ -377,7 +405,7 @@ class Refund implements \JsonSerializable { $json = []; if (isset($this->status)) { - $json['status'] = RefundStatus::checkValue($this->status); + $json['status'] = $this->status; } if (isset($this->statusDetails)) { $json['status_details'] = $this->statusDetails; diff --git a/src/Models/RefundIncompleteReason.php b/src/Models/RefundIncompleteReason.php index efee4e1..5c2f2c0 100644 --- a/src/Models/RefundIncompleteReason.php +++ b/src/Models/RefundIncompleteReason.php @@ -10,34 +10,13 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The reason why the refund has the `PENDING` or `FAILED` status. */ class RefundIncompleteReason { - public const ECHECK = 'ECHECK'; - - private const _ALL_VALUES = [self::ECHECK]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * The customer's account is funded through an eCheck, which has not yet cleared. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for RefundIncompleteReason."); - } + public const ECHECK = 'ECHECK'; } diff --git a/src/Models/RefundPaymentInstruction.php b/src/Models/RefundPaymentInstruction.php index a125bf4..fcecb91 100644 --- a/src/Models/RefundPaymentInstruction.php +++ b/src/Models/RefundPaymentInstruction.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -56,6 +57,16 @@ class RefundPaymentInstruction implements \JsonSerializable $this->platformFees = $platformFees; } + /** + * Converts the RefundPaymentInstruction object to a human-readable string representation. + * + * @return string The string representation of the RefundPaymentInstruction object. + */ + public function __toString(): string + { + return ApiHelper::stringify('RefundPaymentInstruction', ['platformFees' => $this->platformFees]); + } + /** * Encode this object to JSON * diff --git a/src/Models/RefundPlatformFee.php b/src/Models/RefundPlatformFee.php index 365da0a..eb971f2 100644 --- a/src/Models/RefundPlatformFee.php +++ b/src/Models/RefundPlatformFee.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -53,6 +54,16 @@ class RefundPlatformFee implements \JsonSerializable $this->amount = $amount; } + /** + * Converts the RefundPlatformFee object to a human-readable string representation. + * + * @return string The string representation of the RefundPlatformFee object. + */ + public function __toString(): string + { + return ApiHelper::stringify('RefundPlatformFee', ['amount' => $this->amount]); + } + /** * Encode this object to JSON * diff --git a/src/Models/RefundRequest.php b/src/Models/RefundRequest.php index 16fc142..70bc083 100644 --- a/src/Models/RefundRequest.php +++ b/src/Models/RefundRequest.php @@ -10,11 +10,12 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** * Refunds a captured payment, by ID. For a full refund, include an empty request body. For a partial - * refund, include an
amount object in the request body.
+ * refund, include an amount object in the request body.
*/
class RefundRequest implements \JsonSerializable
{
@@ -155,6 +156,25 @@ class RefundRequest implements \JsonSerializable
$this->paymentInstruction = $paymentInstruction;
}
+ /**
+ * Converts the RefundRequest object to a human-readable string representation.
+ *
+ * @return string The string representation of the RefundRequest object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify(
+ 'RefundRequest',
+ [
+ 'amount' => $this->amount,
+ 'customId' => $this->customId,
+ 'invoiceId' => $this->invoiceId,
+ 'noteToPayer' => $this->noteToPayer,
+ 'paymentInstruction' => $this->paymentInstruction
+ ]
+ );
+ }
+
/**
* Encode this object to JSON
*
diff --git a/src/Models/RefundStatus.php b/src/Models/RefundStatus.php
index 8d8fd63..c863d0b 100644
--- a/src/Models/RefundStatus.php
+++ b/src/Models/RefundStatus.php
@@ -10,40 +10,28 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
-use Core\Utils\CoreHelper;
-use Exception;
-use stdClass;
-
/**
* The status of the refund.
*/
class RefundStatus
{
+ /**
+ * The refund was cancelled.
+ */
public const CANCELLED = 'CANCELLED';
+ /**
+ * The refund could not be processed.
+ */
public const FAILED = 'FAILED';
+ /**
+ * The refund is pending. For more information, see status_details.reason.
+ */
public const PENDING = 'PENDING';
- public const COMPLETED = 'COMPLETED';
-
- private const _ALL_VALUES = [self::CANCELLED, self::FAILED, self::PENDING, self::COMPLETED];
-
/**
- * Ensures that all the given values are present in this Enum.
- *
- * @param array|stdClass|null|string $value Value or a list/map of values to be checked
- *
- * @return array|null|string Input value(s), if all are a part of this Enum
- *
- * @throws Exception Throws exception if any given value is not in this Enum
+ * The funds for this transaction were debited to the customer's account.
*/
- public static function checkValue($value)
- {
- $value = json_decode(json_encode($value), true); // converts stdClass into array
- if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) {
- return $value;
- }
- throw new Exception("$value is invalid for RefundStatus.");
- }
+ public const COMPLETED = 'COMPLETED';
}
diff --git a/src/Models/RefundStatusDetails.php b/src/Models/RefundStatusDetails.php
index 1a81aa1..2ce064f 100644
--- a/src/Models/RefundStatusDetails.php
+++ b/src/Models/RefundStatusDetails.php
@@ -10,6 +10,7 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
+use PaypalServerSdkLib\ApiHelper;
use stdClass;
/**
@@ -42,6 +43,16 @@ class RefundStatusDetails implements \JsonSerializable
$this->reason = $reason;
}
+ /**
+ * Converts the RefundStatusDetails object to a human-readable string representation.
+ *
+ * @return string The string representation of the RefundStatusDetails object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify('RefundStatusDetails', ['reason' => $this->reason]);
+ }
+
/**
* Encode this object to JSON
*
@@ -55,7 +66,7 @@ class RefundStatusDetails implements \JsonSerializable
{
$json = [];
if (isset($this->reason)) {
- $json['reason'] = RefundIncompleteReason::checkValue($this->reason);
+ $json['reason'] = $this->reason;
}
return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json;
diff --git a/src/Models/RefundStatusWithDetails.php b/src/Models/RefundStatusWithDetails.php
index b1a4f44..49fdcc1 100644
--- a/src/Models/RefundStatusWithDetails.php
+++ b/src/Models/RefundStatusWithDetails.php
@@ -10,6 +10,7 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
+use PaypalServerSdkLib\ApiHelper;
use stdClass;
/**
@@ -67,6 +68,19 @@ class RefundStatusWithDetails implements \JsonSerializable
$this->statusDetails = $statusDetails;
}
+ /**
+ * Converts the RefundStatusWithDetails object to a human-readable string representation.
+ *
+ * @return string The string representation of the RefundStatusWithDetails object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify(
+ 'RefundStatusWithDetails',
+ ['status' => $this->status, 'statusDetails' => $this->statusDetails]
+ );
+ }
+
/**
* Encode this object to JSON
*
@@ -80,7 +94,7 @@ class RefundStatusWithDetails implements \JsonSerializable
{
$json = [];
if (isset($this->status)) {
- $json['status'] = RefundStatus::checkValue($this->status);
+ $json['status'] = $this->status;
}
if (isset($this->statusDetails)) {
$json['status_details'] = $this->statusDetails;
diff --git a/src/Models/RelatedIdentifiers.php b/src/Models/RelatedIdentifiers.php
index 9608ff8..cc77728 100644
--- a/src/Models/RelatedIdentifiers.php
+++ b/src/Models/RelatedIdentifiers.php
@@ -10,6 +10,7 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
+use PaypalServerSdkLib\ApiHelper;
use stdClass;
/**
@@ -92,6 +93,23 @@ class RelatedIdentifiers implements \JsonSerializable
$this->captureId = $captureId;
}
+ /**
+ * Converts the RelatedIdentifiers object to a human-readable string representation.
+ *
+ * @return string The string representation of the RelatedIdentifiers object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify(
+ 'RelatedIdentifiers',
+ [
+ 'orderId' => $this->orderId,
+ 'authorizationId' => $this->authorizationId,
+ 'captureId' => $this->captureId
+ ]
+ );
+ }
+
/**
* Encode this object to JSON
*
diff --git a/src/Models/RiskSupplementaryData.php b/src/Models/RiskSupplementaryData.php
new file mode 100644
index 0000000..c88f194
--- /dev/null
+++ b/src/Models/RiskSupplementaryData.php
@@ -0,0 +1,74 @@
+customer;
+ }
+
+ /**
+ * Sets Customer.
+ * Profile information of the sender or receiver.
+ *
+ * @maps customer
+ */
+ public function setCustomer(?ParticipantMetadata $customer): void
+ {
+ $this->customer = $customer;
+ }
+
+ /**
+ * Converts the RiskSupplementaryData object to a human-readable string representation.
+ *
+ * @return string The string representation of the RiskSupplementaryData object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify('RiskSupplementaryData', ['customer' => $this->customer]);
+ }
+
+ /**
+ * Encode this object to JSON
+ *
+ * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields
+ * are set. (default: false)
+ *
+ * @return array|stdClass
+ */
+ #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1)
+ public function jsonSerialize(bool $asArrayWhenEmpty = false)
+ {
+ $json = [];
+ if (isset($this->customer)) {
+ $json['customer'] = $this->customer;
+ }
+
+ return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json;
+ }
+}
diff --git a/src/Models/SellerPayableBreakdown.php b/src/Models/SellerPayableBreakdown.php
index c2d5d85..da6353d 100644
--- a/src/Models/SellerPayableBreakdown.php
+++ b/src/Models/SellerPayableBreakdown.php
@@ -10,6 +10,7 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
+use PaypalServerSdkLib\ApiHelper;
use stdClass;
/**
@@ -227,6 +228,28 @@ class SellerPayableBreakdown implements \JsonSerializable
$this->totalRefundedAmount = $totalRefundedAmount;
}
+ /**
+ * Converts the SellerPayableBreakdown object to a human-readable string representation.
+ *
+ * @return string The string representation of the SellerPayableBreakdown object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify(
+ 'SellerPayableBreakdown',
+ [
+ 'grossAmount' => $this->grossAmount,
+ 'paypalFee' => $this->paypalFee,
+ 'paypalFeeInReceivableCurrency' => $this->paypalFeeInReceivableCurrency,
+ 'netAmount' => $this->netAmount,
+ 'netAmountInReceivableCurrency' => $this->netAmountInReceivableCurrency,
+ 'platformFees' => $this->platformFees,
+ 'netAmountBreakdown' => $this->netAmountBreakdown,
+ 'totalRefundedAmount' => $this->totalRefundedAmount
+ ]
+ );
+ }
+
/**
* Encode this object to JSON
*
diff --git a/src/Models/SellerProtection.php b/src/Models/SellerProtection.php
index 61d1a45..2e48bf0 100644
--- a/src/Models/SellerProtection.php
+++ b/src/Models/SellerProtection.php
@@ -10,6 +10,7 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
+use PaypalServerSdkLib\ApiHelper;
use stdClass;
/**
@@ -74,6 +75,19 @@ class SellerProtection implements \JsonSerializable
$this->disputeCategories = $disputeCategories;
}
+ /**
+ * Converts the SellerProtection object to a human-readable string representation.
+ *
+ * @return string The string representation of the SellerProtection object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify(
+ 'SellerProtection',
+ ['status' => $this->status, 'disputeCategories' => $this->disputeCategories]
+ );
+ }
+
/**
* Encode this object to JSON
*
@@ -87,10 +101,10 @@ class SellerProtection implements \JsonSerializable
{
$json = [];
if (isset($this->status)) {
- $json['status'] = SellerProtectionStatus::checkValue($this->status);
+ $json['status'] = $this->status;
}
if (isset($this->disputeCategories)) {
- $json['dispute_categories'] = DisputeCategory::checkValue($this->disputeCategories);
+ $json['dispute_categories'] = $this->disputeCategories;
}
return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json;
diff --git a/src/Models/SellerProtectionStatus.php b/src/Models/SellerProtectionStatus.php
index 8b95e1b..5e0495a 100644
--- a/src/Models/SellerProtectionStatus.php
+++ b/src/Models/SellerProtectionStatus.php
@@ -10,39 +10,25 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
-use Core\Utils\CoreHelper;
-use Exception;
-use stdClass;
-
/**
* Indicates whether the transaction is eligible for seller protection. For information, see [PayPal
* Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection).
*/
class SellerProtectionStatus
{
+ /**
+ * Your PayPal balance remains intact if the customer claims that they did not receive an item or the
+ * account holder claims that they did not authorize the payment.
+ */
public const ELIGIBLE = 'ELIGIBLE';
+ /**
+ * Your PayPal balance remains intact if the customer claims that they did not receive an item.
+ */
public const PARTIALLY_ELIGIBLE = 'PARTIALLY_ELIGIBLE';
- public const NOT_ELIGIBLE = 'NOT_ELIGIBLE';
-
- private const _ALL_VALUES = [self::ELIGIBLE, self::PARTIALLY_ELIGIBLE, self::NOT_ELIGIBLE];
-
/**
- * Ensures that all the given values are present in this Enum.
- *
- * @param array|stdClass|null|string $value Value or a list/map of values to be checked
- *
- * @return array|null|string Input value(s), if all are a part of this Enum
- *
- * @throws Exception Throws exception if any given value is not in this Enum
+ * This transaction is not eligible for seller protection.
*/
- public static function checkValue($value)
- {
- $value = json_decode(json_encode($value), true); // converts stdClass into array
- if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) {
- return $value;
- }
- throw new Exception("$value is invalid for SellerProtectionStatus.");
- }
+ public const NOT_ELIGIBLE = 'NOT_ELIGIBLE';
}
diff --git a/src/Models/SellerReceivableBreakdown.php b/src/Models/SellerReceivableBreakdown.php
index a0e8db3..4d4b1ab 100644
--- a/src/Models/SellerReceivableBreakdown.php
+++ b/src/Models/SellerReceivableBreakdown.php
@@ -10,6 +10,7 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
+use PaypalServerSdkLib\ApiHelper;
use stdClass;
/**
@@ -208,6 +209,27 @@ class SellerReceivableBreakdown implements \JsonSerializable
$this->platformFees = $platformFees;
}
+ /**
+ * Converts the SellerReceivableBreakdown object to a human-readable string representation.
+ *
+ * @return string The string representation of the SellerReceivableBreakdown object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify(
+ 'SellerReceivableBreakdown',
+ [
+ 'grossAmount' => $this->grossAmount,
+ 'paypalFee' => $this->paypalFee,
+ 'paypalFeeInReceivableCurrency' => $this->paypalFeeInReceivableCurrency,
+ 'netAmount' => $this->netAmount,
+ 'receivableAmount' => $this->receivableAmount,
+ 'exchangeRate' => $this->exchangeRate,
+ 'platformFees' => $this->platformFees
+ ]
+ );
+ }
+
/**
* Encode this object to JSON
*
diff --git a/src/Models/SetupTokenCardExperienceContext.php b/src/Models/SetupTokenCardExperienceContext.php
index 845948b..99ed247 100644
--- a/src/Models/SetupTokenCardExperienceContext.php
+++ b/src/Models/SetupTokenCardExperienceContext.php
@@ -10,6 +10,7 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
+use PaypalServerSdkLib\ApiHelper;
use stdClass;
/**
@@ -40,7 +41,7 @@ class SetupTokenCardExperienceContext implements \JsonSerializable
/**
* @var string|null
*/
- private $vaultInstruction = 'ON_CREATE_PAYMENT_TOKENS';
+ private $vaultInstruction = VaultInstructionAction::ON_CREATE_PAYMENT_TOKENS;
/**
* Returns Brand Name.
@@ -158,6 +159,25 @@ class SetupTokenCardExperienceContext implements \JsonSerializable
$this->vaultInstruction = $vaultInstruction;
}
+ /**
+ * Converts the SetupTokenCardExperienceContext object to a human-readable string representation.
+ *
+ * @return string The string representation of the SetupTokenCardExperienceContext object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify(
+ 'SetupTokenCardExperienceContext',
+ [
+ 'brandName' => $this->brandName,
+ 'locale' => $this->locale,
+ 'returnUrl' => $this->returnUrl,
+ 'cancelUrl' => $this->cancelUrl,
+ 'vaultInstruction' => $this->vaultInstruction
+ ]
+ );
+ }
+
/**
* Encode this object to JSON
*
diff --git a/src/Models/SetupTokenRequest.php b/src/Models/SetupTokenRequest.php
index dbb5bd9..8ed0bfa 100644
--- a/src/Models/SetupTokenRequest.php
+++ b/src/Models/SetupTokenRequest.php
@@ -10,6 +10,7 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
+use PaypalServerSdkLib\ApiHelper;
use stdClass;
/**
@@ -18,7 +19,7 @@ use stdClass;
class SetupTokenRequest implements \JsonSerializable
{
/**
- * @var CustomerRequest|null
+ * @var Customer|null
*/
private $customer;
@@ -37,20 +38,22 @@ class SetupTokenRequest implements \JsonSerializable
/**
* Returns Customer.
- * Customer in merchant's or partner's system of records.
+ * This object defines a customer in your system. Use it to manage customer profiles, save payment
+ * methods and contact details.
*/
- public function getCustomer(): ?CustomerRequest
+ public function getCustomer(): ?Customer
{
return $this->customer;
}
/**
* Sets Customer.
- * Customer in merchant's or partner's system of records.
+ * This object defines a customer in your system. Use it to manage customer profiles, save payment
+ * methods and contact details.
*
* @maps customer
*/
- public function setCustomer(?CustomerRequest $customer): void
+ public function setCustomer(?Customer $customer): void
{
$this->customer = $customer;
}
@@ -76,6 +79,19 @@ class SetupTokenRequest implements \JsonSerializable
$this->paymentSource = $paymentSource;
}
+ /**
+ * Converts the SetupTokenRequest object to a human-readable string representation.
+ *
+ * @return string The string representation of the SetupTokenRequest object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify(
+ 'SetupTokenRequest',
+ ['customer' => $this->customer, 'paymentSource' => $this->paymentSource]
+ );
+ }
+
/**
* Encode this object to JSON
*
diff --git a/src/Models/SetupTokenRequestCard.php b/src/Models/SetupTokenRequestCard.php
index 8713278..923b51a 100644
--- a/src/Models/SetupTokenRequestCard.php
+++ b/src/Models/SetupTokenRequestCard.php
@@ -10,6 +10,7 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
+use PaypalServerSdkLib\ApiHelper;
use stdClass;
/**
@@ -57,11 +58,6 @@ class SetupTokenRequestCard implements \JsonSerializable
*/
private $experienceContext;
- /**
- * @var mixed
- */
- private $networkTransactionReference;
-
/**
* Returns Name.
* The card holder's name as it appears on the card.
@@ -233,25 +229,25 @@ class SetupTokenRequestCard implements \JsonSerializable
}
/**
- * Returns Network Transaction Reference.
+ * Converts the SetupTokenRequestCard object to a human-readable string representation.
*
- * @return mixed
+ * @return string The string representation of the SetupTokenRequestCard object.
*/
- public function getNetworkTransactionReference()
+ public function __toString(): string
{
- return $this->networkTransactionReference;
- }
-
- /**
- * Sets Network Transaction Reference.
- *
- * @maps network_transaction_reference
- *
- * @param mixed $networkTransactionReference
- */
- public function setNetworkTransactionReference($networkTransactionReference): void
- {
- $this->networkTransactionReference = $networkTransactionReference;
+ return ApiHelper::stringify(
+ 'SetupTokenRequestCard',
+ [
+ 'name' => $this->name,
+ 'number' => $this->number,
+ 'expiry' => $this->expiry,
+ 'securityCode' => $this->securityCode,
+ 'brand' => $this->brand,
+ 'billingAddress' => $this->billingAddress,
+ 'verificationMethod' => $this->verificationMethod,
+ 'experienceContext' => $this->experienceContext
+ ]
+ );
}
/**
@@ -267,31 +263,28 @@ class SetupTokenRequestCard implements \JsonSerializable
{
$json = [];
if (isset($this->name)) {
- $json['name'] = $this->name;
+ $json['name'] = $this->name;
}
if (isset($this->number)) {
- $json['number'] = $this->number;
+ $json['number'] = $this->number;
}
if (isset($this->expiry)) {
- $json['expiry'] = $this->expiry;
+ $json['expiry'] = $this->expiry;
}
if (isset($this->securityCode)) {
- $json['security_code'] = $this->securityCode;
+ $json['security_code'] = $this->securityCode;
}
if (isset($this->brand)) {
- $json['brand'] = CardBrand::checkValue($this->brand);
+ $json['brand'] = $this->brand;
}
if (isset($this->billingAddress)) {
- $json['billing_address'] = $this->billingAddress;
+ $json['billing_address'] = $this->billingAddress;
}
if (isset($this->verificationMethod)) {
- $json['verification_method'] = $this->verificationMethod;
+ $json['verification_method'] = $this->verificationMethod;
}
if (isset($this->experienceContext)) {
- $json['experience_context'] = $this->experienceContext;
- }
- if (isset($this->networkTransactionReference)) {
- $json['network_transaction_reference'] = $this->networkTransactionReference;
+ $json['experience_context'] = $this->experienceContext;
}
return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json;
diff --git a/src/Models/SetupTokenRequestPaymentSource.php b/src/Models/SetupTokenRequestPaymentSource.php
index ad80f2c..a50faa8 100644
--- a/src/Models/SetupTokenRequestPaymentSource.php
+++ b/src/Models/SetupTokenRequestPaymentSource.php
@@ -10,6 +10,7 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
+use PaypalServerSdkLib\ApiHelper;
use stdClass;
/**
@@ -115,6 +116,19 @@ class SetupTokenRequestPaymentSource implements \JsonSerializable
$this->token = $token;
}
+ /**
+ * Converts the SetupTokenRequestPaymentSource object to a human-readable string representation.
+ *
+ * @return string The string representation of the SetupTokenRequestPaymentSource object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify(
+ 'SetupTokenRequestPaymentSource',
+ ['card' => $this->card, 'paypal' => $this->paypal, 'venmo' => $this->venmo, 'token' => $this->token]
+ );
+ }
+
/**
* Encode this object to JSON
*
diff --git a/src/Models/SetupTokenResponse.php b/src/Models/SetupTokenResponse.php
index db3c8f1..693eb3d 100644
--- a/src/Models/SetupTokenResponse.php
+++ b/src/Models/SetupTokenResponse.php
@@ -10,6 +10,7 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
+use PaypalServerSdkLib\ApiHelper;
use stdClass;
/**
@@ -23,19 +24,14 @@ class SetupTokenResponse implements \JsonSerializable
private $id;
/**
- * @var int|null
- */
- private $ordinal;
-
- /**
- * @var CustomerRequest|null
+ * @var Customer|null
*/
private $customer;
/**
* @var string|null
*/
- private $status = 'CREATED';
+ private $status = PaymentTokenStatus::CREATED;
/**
* @var SetupTokenResponsePaymentSource|null
@@ -67,42 +63,24 @@ class SetupTokenResponse implements \JsonSerializable
$this->id = $id;
}
- /**
- * Returns Ordinal.
- * Ordinal number for sorting.
- */
- public function getOrdinal(): ?int
- {
- return $this->ordinal;
- }
-
- /**
- * Sets Ordinal.
- * Ordinal number for sorting.
- *
- * @maps ordinal
- */
- public function setOrdinal(?int $ordinal): void
- {
- $this->ordinal = $ordinal;
- }
-
/**
* Returns Customer.
- * Customer in merchant's or partner's system of records.
+ * This object defines a customer in your system. Use it to manage customer profiles, save payment
+ * methods and contact details.
*/
- public function getCustomer(): ?CustomerRequest
+ public function getCustomer(): ?Customer
{
return $this->customer;
}
/**
* Sets Customer.
- * Customer in merchant's or partner's system of records.
+ * This object defines a customer in your system. Use it to manage customer profiles, save payment
+ * methods and contact details.
*
* @maps customer
*/
- public function setCustomer(?CustomerRequest $customer): void
+ public function setCustomer(?Customer $customer): void
{
$this->customer = $customer;
}
@@ -171,6 +149,25 @@ class SetupTokenResponse implements \JsonSerializable
$this->links = $links;
}
+ /**
+ * Converts the SetupTokenResponse object to a human-readable string representation.
+ *
+ * @return string The string representation of the SetupTokenResponse object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify(
+ 'SetupTokenResponse',
+ [
+ 'id' => $this->id,
+ 'customer' => $this->customer,
+ 'status' => $this->status,
+ 'paymentSource' => $this->paymentSource,
+ 'links' => $this->links
+ ]
+ );
+ }
+
/**
* Encode this object to JSON
*
@@ -186,9 +183,6 @@ class SetupTokenResponse implements \JsonSerializable
if (isset($this->id)) {
$json['id'] = $this->id;
}
- if (isset($this->ordinal)) {
- $json['ordinal'] = $this->ordinal;
- }
if (isset($this->customer)) {
$json['customer'] = $this->customer;
}
diff --git a/src/Models/SetupTokenResponseCard.php b/src/Models/SetupTokenResponseCard.php
index 467cdb0..afe6042 100644
--- a/src/Models/SetupTokenResponseCard.php
+++ b/src/Models/SetupTokenResponseCard.php
@@ -10,6 +10,7 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
+use PaypalServerSdkLib\ApiHelper;
use stdClass;
class SetupTokenResponseCard implements \JsonSerializable
@@ -35,7 +36,7 @@ class SetupTokenResponseCard implements \JsonSerializable
private $expiry;
/**
- * @var AddressDetails|null
+ * @var CardResponseAddress|null
*/
private $billingAddress;
@@ -155,7 +156,7 @@ class SetupTokenResponseCard implements \JsonSerializable
* Returns Billing Address.
* Address request details.
*/
- public function getBillingAddress(): ?AddressDetails
+ public function getBillingAddress(): ?CardResponseAddress
{
return $this->billingAddress;
}
@@ -166,7 +167,7 @@ class SetupTokenResponseCard implements \JsonSerializable
*
* @maps billing_address
*/
- public function setBillingAddress(?AddressDetails $billingAddress): void
+ public function setBillingAddress(?CardResponseAddress $billingAddress): void
{
$this->billingAddress = $billingAddress;
}
@@ -292,6 +293,31 @@ class SetupTokenResponseCard implements \JsonSerializable
$this->type = $type;
}
+ /**
+ * Converts the SetupTokenResponseCard object to a human-readable string representation.
+ *
+ * @return string The string representation of the SetupTokenResponseCard object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify(
+ 'SetupTokenResponseCard',
+ [
+ 'name' => $this->name,
+ 'lastDigits' => $this->lastDigits,
+ 'brand' => $this->brand,
+ 'expiry' => $this->expiry,
+ 'billingAddress' => $this->billingAddress,
+ 'verificationStatus' => $this->verificationStatus,
+ 'verification' => $this->verification,
+ 'networkTransactionReference' => $this->networkTransactionReference,
+ 'authenticationResult' => $this->authenticationResult,
+ 'binDetails' => $this->binDetails,
+ 'type' => $this->type
+ ]
+ );
+ }
+
/**
* Encode this object to JSON
*
@@ -311,7 +337,7 @@ class SetupTokenResponseCard implements \JsonSerializable
$json['last_digits'] = $this->lastDigits;
}
if (isset($this->brand)) {
- $json['brand'] = CardBrand::checkValue($this->brand);
+ $json['brand'] = $this->brand;
}
if (isset($this->expiry)) {
$json['expiry'] = $this->expiry;
@@ -335,7 +361,7 @@ class SetupTokenResponseCard implements \JsonSerializable
$json['bin_details'] = $this->binDetails;
}
if (isset($this->type)) {
- $json['type'] = CardType::checkValue($this->type);
+ $json['type'] = $this->type;
}
return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json;
diff --git a/src/Models/SetupTokenResponsePaymentSource.php b/src/Models/SetupTokenResponsePaymentSource.php
index 8210166..d07cadc 100644
--- a/src/Models/SetupTokenResponsePaymentSource.php
+++ b/src/Models/SetupTokenResponsePaymentSource.php
@@ -10,6 +10,7 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
+use PaypalServerSdkLib\ApiHelper;
use stdClass;
/**
@@ -86,6 +87,19 @@ class SetupTokenResponsePaymentSource implements \JsonSerializable
$this->venmo = $venmo;
}
+ /**
+ * Converts the SetupTokenResponsePaymentSource object to a human-readable string representation.
+ *
+ * @return string The string representation of the SetupTokenResponsePaymentSource object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify(
+ 'SetupTokenResponsePaymentSource',
+ ['card' => $this->card, 'paypal' => $this->paypal, 'venmo' => $this->venmo]
+ );
+ }
+
/**
* Encode this object to JSON
*
diff --git a/src/Models/ShipmentCarrier.php b/src/Models/ShipmentCarrier.php
index 68d8206..a4f6f96 100644
--- a/src/Models/ShipmentCarrier.php
+++ b/src/Models/ShipmentCarrier.php
@@ -10,4190 +10,6892 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
-use Core\Utils\CoreHelper;
-use Exception;
-use stdClass;
-
/**
* The carrier for the shipment. Some carriers have a global version as well as local subsidiaries. The
* subsidiaries are repeated over many countries and might also have an entry in the global list.
* Choose the carrier for your country. If the carrier is not available for your country, choose the
* global version of the carrier. If your carrier name is not in the list, set `carrier` to `OTHER` and
- * set carrier name in `carrier_name_other`. For allowed values, see Carriers.
+ * set carrier name in `carrier_name_other`. For allowed values, see Carriers.
*/
class ShipmentCarrier
{
+ /**
+ * DPD Russia.
+ */
public const DPD_RU = 'DPD_RU';
+ /**
+ * Bulgarian Posts.
+ */
public const BG_BULGARIAN_POST = 'BG_BULGARIAN_POST';
+ /**
+ * Koreapost (www.koreapost.go.kr).
+ */
public const KR_KOREA_POST = 'KR_KOREA_POST';
+ /**
+ * Courier IT.
+ */
public const ZA_COURIERIT = 'ZA_COURIERIT';
+ /**
+ * DPD France (formerly exapaq).
+ */
public const FR_EXAPAQ = 'FR_EXAPAQ';
+ /**
+ * Emirates Post.
+ */
public const ARE_EMIRATES_POST = 'ARE_EMIRATES_POST';
+ /**
+ * GAC.
+ */
public const GAC = 'GAC';
+ /**
+ * Geis CZ.
+ */
public const GEIS = 'GEIS';
+ /**
+ * SF Express.
+ */
public const SF_EX = 'SF_EX';
+ /**
+ * Pago Logistics.
+ */
public const PAGO = 'PAGO';
+ /**
+ * MyHermes UK.
+ */
public const MYHERMES = 'MYHERMES';
+ /**
+ * Diamond Eurogistics Limited.
+ */
public const DIAMOND_EUROGISTICS = 'DIAMOND_EUROGISTICS';
+ /**
+ * Corporate Couriers.
+ */
public const CORPORATECOURIERS_WEBHOOK = 'CORPORATECOURIERS_WEBHOOK';
+ /**
+ * Bond courier.
+ */
public const BOND = 'BOND';
+ /**
+ * Omni Parcel.
+ */
public const OMNIPARCEL = 'OMNIPARCEL';
+ /**
+ * Slovenska pošta.
+ */
public const SK_POSTA = 'SK_POSTA';
+ /**
+ * purolator.
+ */
public const PUROLATOR = 'PUROLATOR';
+ /**
+ * Mena 360 (Fetchr).
+ */
public const FETCHR_WEBHOOK = 'FETCHR_WEBHOOK';
+ /**
+ * TDG – The Delivery Group.
+ */
public const THEDELIVERYGROUP = 'THEDELIVERYGROUP';
+ /**
+ * Cello Square.
+ */
public const CELLO_SQUARE = 'CELLO_SQUARE';
+ /**
+ * TONDA GLOBAL.
+ */
public const TARRIVE = 'TARRIVE';
+ /**
+ * MDS Collivery Pty (Ltd).
+ */
public const COLLIVERY = 'COLLIVERY';
+ /**
+ * Mainfreight.
+ */
public const MAINFREIGHT = 'MAINFREIGHT';
+ /**
+ * First Flight Couriers.
+ */
public const IND_FIRSTFLIGHT = 'IND_FIRSTFLIGHT';
+ /**
+ * ACS Worldwide Express.
+ */
public const ACSWORLDWIDE = 'ACSWORLDWIDE';
+ /**
+ * Amstan Logistics.
+ */
public const AMSTAN = 'AMSTAN';
+ /**
+ * OkayParcel.
+ */
public const OKAYPARCEL = 'OKAYPARCEL';
+ /**
+ * Envialia Reference.
+ */
public const ENVIALIA_REFERENCE = 'ENVIALIA_REFERENCE';
+ /**
+ * Seur Spain.
+ */
public const SEUR_ES = 'SEUR_ES';
+ /**
+ * Continental.
+ */
public const CONTINENTAL = 'CONTINENTAL';
+ /**
+ * FDSEXPRESS.
+ */
public const FDSEXPRESS = 'FDSEXPRESS';
+ /**
+ * Swiship UK.
+ */
public const AMAZON_FBA_SWISHIP = 'AMAZON_FBA_SWISHIP';
+ /**
+ * Wyngs.
+ */
public const WYNGS = 'WYNGS';
+ /**
+ * DHL Active Tracing.
+ */
public const DHL_ACTIVE_TRACING = 'DHL_ACTIVE_TRACING';
+ /**
+ * Zyllem.
+ */
public const ZYLLEM = 'ZYLLEM';
+ /**
+ * Ruston.
+ */
public const RUSTON = 'RUSTON';
+ /**
+ * Xpost.ph.
+ */
public const XPOST = 'XPOST';
+ /**
+ * correos Express (www.correos.es).
+ */
public const CORREOS_ES = 'CORREOS_ES';
+ /**
+ * DHL France (www.dhl.com).
+ */
public const DHL_FR = 'DHL_FR';
+ /**
+ * Pan-Asia International.
+ */
public const PAN_ASIA = 'PAN_ASIA';
+ /**
+ * BRT couriers Italy (www.brt.it).
+ */
public const BRT_IT = 'BRT_IT';
+ /**
+ * SRE Korea (www.srekorea.co.kr).
+ */
public const SRE_KOREA = 'SRE_KOREA';
+ /**
+ * Spee-Dee Delivery.
+ */
public const SPEEDEE = 'SPEEDEE';
+ /**
+ * TNT UK Limited (www.tnt.com).
+ */
public const TNT_UK = 'TNT_UK';
+ /**
+ * Venipak.
+ */
public const VENIPAK = 'VENIPAK';
+ /**
+ * SHREE NANDAN COURIER.
+ */
public const SHREENANDANCOURIER = 'SHREENANDANCOURIER';
+ /**
+ * Croshot.
+ */
public const CROSHOT = 'CROSHOT';
+ /**
+ * NIpost (www.nipost.gov.ng).
+ */
public const NIPOST_NG = 'NIPOST_NG';
+ /**
+ * ePost Global.
+ */
public const EPST_GLBL = 'EPST_GLBL';
+ /**
+ * Newgistics.
+ */
public const NEWGISTICS = 'NEWGISTICS';
+ /**
+ * Post of Slovenia.
+ */
public const POST_SLOVENIA = 'POST_SLOVENIA';
+ /**
+ * Jersey Post.
+ */
public const JERSEY_POST = 'JERSEY_POST';
+ /**
+ * Bombino Express Pvt.
+ */
public const BOMBINOEXP = 'BOMBINOEXP';
+ /**
+ * WMG Delivery.
+ */
public const WMG = 'WMG';
+ /**
+ * XQ Express.
+ */
public const XQ_EXPRESS = 'XQ_EXPRESS';
+ /**
+ * Furdeco.
+ */
public const FURDECO = 'FURDECO';
+ /**
+ * LHT Express.
+ */
public const LHT_EXPRESS = 'LHT_EXPRESS';
+ /**
+ * South African Post Office.
+ */
public const SOUTH_AFRICAN_POST_OFFICE = 'SOUTH_AFRICAN_POST_OFFICE';
+ /**
+ * SPOTON Logistics Pvt Ltd.
+ */
public const SPOTON = 'SPOTON';
+ /**
+ * Dimerco Express Group.
+ */
public const DIMERCO = 'DIMERCO';
+ /**
+ * cyprus post.
+ */
public const CYPRUS_POST_CYP = 'CYPRUS_POST_CYP';
+ /**
+ * AB Custom Group.
+ */
public const ABCUSTOM = 'ABCUSTOM';
+ /**
+ * deliverE.
+ */
public const IND_DELIVREE = 'IND_DELIVREE';
+ /**
+ * Best Express.
+ */
public const CN_BESTEXPRESS = 'CN_BESTEXPRESS';
+ /**
+ * DX (SFTP).
+ */
public const DX_SFTP = 'DX_SFTP';
+ /**
+ * PICK UPP.
+ */
public const PICKUPP_MYS = 'PICKUPP_MYS';
+ /**
+ * FMX.
+ */
public const FMX = 'FMX';
+ /**
+ * Hellmann Worldwide Logistics.
+ */
public const HELLMANN = 'HELLMANN';
+ /**
+ * Ship It Asia.
+ */
public const SHIP_IT_ASIA = 'SHIP_IT_ASIA';
+ /**
+ * Kerry eCommerce.
+ */
public const KERRY_ECOMMERCE = 'KERRY_ECOMMERCE';
+ /**
+ * Frete Rapido.
+ */
public const FRETERAPIDO = 'FRETERAPIDO';
+ /**
+ * Pitney Bowes.
+ */
public const PITNEY_BOWES = 'PITNEY_BOWES';
+ /**
+ * Xpressen courier.
+ */
public const XPRESSEN_DK = 'XPRESSEN_DK';
+ /**
+ * Spanish Seur API.
+ */
public const SEUR_SP_API = 'SEUR_SP_API';
+ /**
+ * DELIVERYONTIME LOGISTICS PVT LTD.
+ */
public const DELIVERYONTIME = 'DELIVERYONTIME';
+ /**
+ * JINSUNG TRADING.
+ */
public const JINSUNG = 'JINSUNG';
+ /**
+ * Trans Kargo Internasional.
+ */
public const TRANS_KARGO = 'TRANS_KARGO';
+ /**
+ * Swiship DE.
+ */
public const SWISHIP_DE = 'SWISHIP_DE';
+ /**
+ * Ivoy courier.
+ */
public const IVOY_WEBHOOK = 'IVOY_WEBHOOK';
+ /**
+ * Airmee couriers.
+ */
public const AIRMEE_WEBHOOK = 'AIRMEE_WEBHOOK';
+ /**
+ * dhl benelux.
+ */
public const DHL_BENELUX = 'DHL_BENELUX';
+ /**
+ * FirstMile.
+ */
public const FIRSTMILE = 'FIRSTMILE';
+ /**
+ * Fastway Ireland.
+ */
public const FASTWAY_IR = 'FASTWAY_IR';
+ /**
+ * Hua Han Logistics.
+ */
public const HH_EXP = 'HH_EXP';
+ /**
+ * Mypostonline.
+ */
public const MYS_MYPOST_ONLINE = 'MYS_MYPOST_ONLINE';
+ /**
+ * THT Netherland.
+ */
public const TNT_NL = 'TNT_NL';
+ /**
+ * TIPSA courier.
+ */
public const TIPSA = 'TIPSA';
+ /**
+ * TAQBIN Malaysia.
+ */
public const TAQBIN_MY = 'TAQBIN_MY';
+ /**
+ * KGM Hub.
+ */
public const KGMHUB = 'KGMHUB';
+ /**
+ * Internet Express.
+ */
public const INTEXPRESS = 'INTEXPRESS';
+ /**
+ * Overseas Express.
+ */
public const OVERSE_EXP = 'OVERSE_EXP';
+ /**
+ * One click delivery services.
+ */
public const ONECLICK = 'ONECLICK';
+ /**
+ * Roadbull Logistics.
+ */
public const ROADRUNNER_FREIGHT = 'ROADRUNNER_FREIGHT';
+ /**
+ * GLS Croatia.
+ */
public const GLS_CROTIA = 'GLS_CROTIA';
+ /**
+ * MRW courier.
+ */
public const MRW_FTP = 'MRW_FTP';
+ /**
+ * Blue Express.
+ */
public const BLUEX = 'BLUEX';
+ /**
+ * Daylight Transport.
+ */
public const DYLT = 'DYLT';
+ /**
+ * DPD Ireland.
+ */
public const DPD_IR = 'DPD_IR';
+ /**
+ * Sin Global Express.
+ */
public const SIN_GLBL = 'SIN_GLBL';
+ /**
+ * Tuffnells Parcels Express- Reference.
+ */
public const TUFFNELLS_REFERENCE = 'TUFFNELLS_REFERENCE';
+ /**
+ * CJ Packet.
+ */
public const CJPACKET = 'CJPACKET';
+ /**
+ * Milkman courier.
+ */
public const MILKMAN = 'MILKMAN';
+ /**
+ * ASIGNA courier.
+ */
public const ASIGNA = 'ASIGNA';
+ /**
+ * One World Express.
+ */
public const ONEWORLDEXPRESS = 'ONEWORLDEXPRESS';
+ /**
+ * RoyalShipments.
+ */
public const ROYAL_MAIL = 'ROYAL_MAIL';
+ /**
+ * Viaxpress.
+ */
public const VIA_EXPRESS = 'VIA_EXPRESS';
+ /**
+ * TIG Freight.
+ */
public const TIGFREIGHT = 'TIGFREIGHT';
+ /**
+ * ZTO Express.
+ */
public const ZTO_EXPRESS = 'ZTO_EXPRESS';
+ /**
+ * 2GO Courier.
+ */
public const TWO_GO = 'TWO_GO';
+ /**
+ * IML courier.
+ */
public const IML = 'IML';
+ /**
+ * Intel-Valley Supply chain (ShenZhen) Co. Ltd.
+ */
public const INTEL_VALLEY = 'INTEL_VALLEY';
+ /**
+ * EFS (E-commerce Fulfillment Service).
+ */
public const EFS = 'EFS';
+ /**
+ * UK mail (ukmail.com).
+ */
public const UK_UK_MAIL = 'UK_UK_MAIL';
+ /**
+ * RAM courier.
+ */
public const RAM = 'RAM';
+ /**
+ * Allied Express.
+ */
public const ALLIEDEXPRESS = 'ALLIEDEXPRESS';
+ /**
+ * APC overnight (apc-overnight.com).
+ */
public const APC_OVERNIGHT = 'APC_OVERNIGHT';
+ /**
+ * Shippit.
+ */
public const SHIPPIT = 'SHIPPIT';
+ /**
+ * TFM Xpress.
+ */
public const TFM = 'TFM';
+ /**
+ * M Xpress Sdn Bhd.
+ */
public const M_XPRESS = 'M_XPRESS';
+ /**
+ * Haidaibao (BOX).
+ */
public const HDB_BOX = 'HDB_BOX';
+ /**
+ * Clevy Links.
+ */
public const CLEVY_LINKS = 'CLEVY_LINKS';
+ /**
+ * Beone Logistics.
+ */
public const IBEONE = 'IBEONE';
+ /**
+ * Fiege Netherlands.
+ */
public const FIEGE_NL = 'FIEGE_NL';
+ /**
+ * KWE Global.
+ */
public const KWE_GLOBAL = 'KWE_GLOBAL';
+ /**
+ * CTC Express.
+ */
public const CTC_EXPRESS = 'CTC_EXPRESS';
- public const LAO_POST = 'LAO_POST';
-
+ /**
+ * Amazon Shipping.
+ */
public const AMAZON = 'AMAZON';
+ /**
+ * Morelink.
+ */
public const MORE_LINK = 'MORE_LINK';
+ /**
+ * JX courier.
+ */
public const JX = 'JX';
+ /**
+ * Easy Mail.
+ */
public const EASY_MAIL = 'EASY_MAIL';
+ /**
+ * A Duie Pyle.
+ */
public const ADUIEPYLE = 'ADUIEPYLE';
+ /**
+ * Panther.
+ */
public const GB_PANTHER = 'GB_PANTHER';
+ /**
+ * Expresssale.
+ */
public const EXPRESSSALE = 'EXPRESSSALE';
+ /**
+ * Detrack.
+ */
public const SG_DETRACK = 'SG_DETRACK';
+ /**
+ * Trunkrs courier.
+ */
public const TRUNKRS_WEBHOOK = 'TRUNKRS_WEBHOOK';
+ /**
+ * Matdespatch.
+ */
public const MATDESPATCH = 'MATDESPATCH';
+ /**
+ * GLS Logistic Systems Canada Ltd./Dicom.
+ */
public const DICOM = 'DICOM';
+ /**
+ * MBW Courier Inc..
+ */
public const MBW = 'MBW';
+ /**
+ * Cambodia Post.
+ */
public const KHM_CAMBODIA_POST = 'KHM_CAMBODIA_POST';
+ /**
+ * Sinotrans.
+ */
public const SINOTRANS = 'SINOTRANS';
+ /**
+ * BRT Bartolini(Parcel ID).
+ */
public const BRT_IT_PARCELID = 'BRT_IT_PARCELID';
+ /**
+ * DHL Supply Chain APAC.
+ */
public const DHL_SUPPLY_CHAIN = 'DHL_SUPPLY_CHAIN';
+ /**
+ * DHL Poland.
+ */
public const DHL_PL = 'DHL_PL';
+ /**
+ * TopYou.
+ */
public const TOPYOU = 'TOPYOU';
+ /**
+ * PAL Express Limited.
+ */
public const PALEXPRESS = 'PALEXPRESS';
+ /**
+ * dhl Singapore.
+ */
public const DHL_SG = 'DHL_SG';
+ /**
+ * WeDo Logistics.
+ */
public const CN_WEDO = 'CN_WEDO';
+ /**
+ * Fulfillme.
+ */
public const FULFILLME = 'FULFILLME';
+ /**
+ * DPD delistrack.
+ */
public const DPD_DELISTRACK = 'DPD_DELISTRACK';
+ /**
+ * UPS Reference.
+ */
public const UPS_REFERENCE = 'UPS_REFERENCE';
+ /**
+ * Caribou.
+ */
public const CARIBOU = 'CARIBOU';
+ /**
+ * Locus courier.
+ */
public const LOCUS_WEBHOOK = 'LOCUS_WEBHOOK';
+ /**
+ * DSV courier.
+ */
public const DSV = 'DSV';
- public const CN_GOFLY = 'CN_GOFLY';
-
+ /**
+ * P2P TrakPak.
+ */
public const P2P_TRC = 'P2P_TRC';
+ /**
+ * Direct Parcels.
+ */
public const DIRECTPARCELS = 'DIRECTPARCELS';
+ /**
+ * Nova Poshta (International).
+ */
public const NOVA_POSHTA_INT = 'NOVA_POSHTA_INT';
+ /**
+ * FedEx® Poland Domestic.
+ */
public const FEDEX_POLAND = 'FEDEX_POLAND';
+ /**
+ * JCEX courier.
+ */
public const CN_JCEX = 'CN_JCEX';
+ /**
+ * FAR international.
+ */
public const FAR_INTERNATIONAL = 'FAR_INTERNATIONAL';
+ /**
+ * IDEX courier.
+ */
public const IDEXPRESS = 'IDEXPRESS';
+ /**
+ * GANGBAO Supplychain.
+ */
public const GANGBAO = 'GANGBAO';
+ /**
+ * Neway Transport.
+ */
public const NEWAY = 'NEWAY';
+ /**
+ * PostNL International.
+ */
public const POSTNL_INT_3_S = 'POSTNL_INT_3_S';
+ /**
+ * RPX Indonesia.
+ */
public const RPX_ID = 'RPX_ID';
+ /**
+ * Designer Transport.
+ */
public const DESIGNERTRANSPORT_WEBHOOK = 'DESIGNERTRANSPORT_WEBHOOK';
+ /**
+ * GLS Slovenia.
+ */
public const GLS_SLOVEN = 'GLS_SLOVEN';
+ /**
+ * Parcelled.in.
+ */
public const PARCELLED_IN = 'PARCELLED_IN';
+ /**
+ * GSI EXPRESS.
+ */
public const GSI_EXPRESS = 'GSI_EXPRESS';
+ /**
+ * Con-way Freight.
+ */
public const CON_WAY = 'CON_WAY';
+ /**
+ * Brouwer Transport en Logistiek.
+ */
public const BROUWER_TRANSPORT = 'BROUWER_TRANSPORT';
+ /**
+ * Captain Express International.
+ */
public const CPEX = 'CPEX';
+ /**
+ * Israel Post.
+ */
public const ISRAEL_POST = 'ISRAEL_POST';
+ /**
+ * DTDC India.
+ */
public const DTDC_IN = 'DTDC_IN';
+ /**
+ * PTT Post.
+ */
public const PTT_POST = 'PTT_POST';
+ /**
+ * Ximex Delivery Express.
+ */
public const XDE_WEBHOOK = 'XDE_WEBHOOK';
+ /**
+ * Tolos courier.
+ */
public const TOLOS = 'TOLOS';
+ /**
+ * Giao hàng nhanh.
+ */
public const GIAO_HANG = 'GIAO_HANG';
+ /**
+ * Geodis E-space.
+ */
public const GEODIS_ESPACE = 'GEODIS_ESPACE';
+ /**
+ * Magyar Post.
+ */
public const MAGYAR_HU = 'MAGYAR_HU';
+ /**
+ * DoorDash.
+ */
public const DOORDASH_WEBHOOK = 'DOORDASH_WEBHOOK';
+ /**
+ * Tiki shipment.
+ */
public const TIKI_ID = 'TIKI_ID';
+ /**
+ * CJ Logistics International(Hong Kong).
+ */
public const CJ_HK_INTERNATIONAL = 'CJ_HK_INTERNATIONAL';
+ /**
+ * Star Track Express.
+ */
public const STAR_TRACK_EXPRESS = 'STAR_TRACK_EXPRESS';
+ /**
+ * Helthjem.
+ */
public const HELTHJEM = 'HELTHJEM';
+ /**
+ * SF International.
+ */
public const SFB2C = 'SFB2C';
+ /**
+ * Freightquote by C.H. Robinson.
+ */
public const FREIGHTQUOTE = 'FREIGHTQUOTE';
+ /**
+ * Landmark Global Reference.
+ */
public const LANDMARK_GLOBAL_REFERENCE = 'LANDMARK_GLOBAL_REFERENCE';
+ /**
+ * Parcel2Go.
+ */
public const PARCEL2GO = 'PARCEL2GO';
+ /**
+ * Delnext.
+ */
public const DELNEXT = 'DELNEXT';
+ /**
+ * Red Carpet Logistics.
+ */
public const RCL = 'RCL';
+ /**
+ * CGS Express.
+ */
public const CGS_EXPRESS = 'CGS_EXPRESS';
+ /**
+ * Hongkong Post (www.hongkongpost.hk).
+ */
public const HK_POST = 'HK_POST';
+ /**
+ * SAP EXPRESS.
+ */
public const SAP_EXPRESS = 'SAP_EXPRESS';
+ /**
+ * Parcel Post Singapore.
+ */
public const PARCELPOST_SG = 'PARCELPOST_SG';
+ /**
+ * HermesWorld UK.
+ */
public const HERMES = 'HERMES';
+ /**
+ * Safexpress.
+ */
public const IND_SAFEEXPRESS = 'IND_SAFEEXPRESS';
+ /**
+ * Tophatter Express.
+ */
public const TOPHATTEREXPRESS = 'TOPHATTEREXPRESS';
+ /**
+ * PT MGLOBAL LOGISTICS INDONESIA.
+ */
public const MGLOBAL = 'MGLOBAL';
+ /**
+ * Averitt Express.
+ */
public const AVERITT = 'AVERITT';
+ /**
+ * leader.
+ */
public const LEADER = 'LEADER';
+ /**
+ * 2ebox courier.
+ */
public const _2EBOX = '_2EBOX';
+ /**
+ * Singapore Speedpost.
+ */
public const SG_SPEEDPOST = 'SG_SPEEDPOST';
+ /**
+ * DB Schenker (www.dbschenker.com).
+ */
public const DBSCHENKER_SE = 'DBSCHENKER_SE';
+ /**
+ * Israel Post Domestic.
+ */
public const ISR_POST_DOMESTIC = 'ISR_POST_DOMESTIC';
+ /**
+ * Best Way Parcel.
+ */
public const BESTWAYPARCEL = 'BESTWAYPARCEL';
+ /**
+ * asendia_de.
+ */
public const ASENDIA_DE = 'ASENDIA_DE';
+ /**
+ * nightline_uk.
+ */
public const NIGHTLINE_UK = 'NIGHTLINE_UK';
+ /**
+ * taqbin_sg.
+ */
public const TAQBIN_SG = 'TAQBIN_SG';
+ /**
+ * TCK Express.
+ */
public const TCK_EXPRESS = 'TCK_EXPRESS';
+ /**
+ * Endeavour Delivery.
+ */
public const ENDEAVOUR_DELIVERY = 'ENDEAVOUR_DELIVERY';
+ /**
+ * Nanjing Woyuan.
+ */
public const NANJINGWOYUAN = 'NANJINGWOYUAN';
+ /**
+ * Heppner France.
+ */
public const HEPPNER_FR = 'HEPPNER_FR';
+ /**
+ * EMPS Express.
+ */
public const EMPS_CN = 'EMPS_CN';
+ /**
+ * Fonsen Logistics.
+ */
public const FONSEN = 'FONSEN';
+ /**
+ * Pickrr.
+ */
public const PICKRR = 'PICKRR';
+ /**
+ * APC Overnight Consignment.
+ */
public const APC_OVERNIGHT_CONNUM = 'APC_OVERNIGHT_CONNUM';
+ /**
+ * Star Track Next Flight.
+ */
public const STAR_TRACK_NEXT_FLIGHT = 'STAR_TRACK_NEXT_FLIGHT';
+ /**
+ * Shanghai Aqrum Chemical Logistics Co.Ltd.
+ */
public const DAJIN = 'DAJIN';
+ /**
+ * UPS Freight.
+ */
public const UPS_FREIGHT = 'UPS_FREIGHT';
+ /**
+ * Posta Plus.
+ */
public const POSTA_PLUS = 'POSTA_PLUS';
+ /**
+ * CEVA LOGISTICS.
+ */
public const CEVA = 'CEVA';
+ /**
+ * ANSERX courier.
+ */
public const ANSERX = 'ANSERX';
+ /**
+ * JS EXPRESS.
+ */
public const JS_EXPRESS = 'JS_EXPRESS';
+ /**
+ * padtf.com.
+ */
public const PADTF = 'PADTF';
+ /**
+ * UPS Mail Innovations.
+ */
public const UPS_MAIL_INNOVATIONS = 'UPS_MAIL_INNOVATIONS';
- public const EZSHIP = 'EZSHIP';
-
+ /**
+ * Sunyou Post.
+ */
public const SYPOST = 'SYPOST';
+ /**
+ * Amazon Shipping + Amazon MCF.
+ */
public const AMAZON_SHIP_MCF = 'AMAZON_SHIP_MCF';
+ /**
+ * Yusen Logistics.
+ */
public const YUSEN = 'YUSEN';
+ /**
+ * Bring.
+ */
public const BRING = 'BRING';
+ /**
+ * SDA Italy.
+ */
public const SDA_IT = 'SDA_IT';
+ /**
+ * GBA Services Ltd.
+ */
public const GBA = 'GBA';
+ /**
+ * Newegg Express.
+ */
public const NEWEGGEXPRESS = 'NEWEGGEXPRESS';
+ /**
+ * Speed Couriers.
+ */
public const SPEEDCOURIERS_GR = 'SPEEDCOURIERS_GR';
+ /**
+ * forrun Pvt Ltd (Arpatech Venture).
+ */
public const FORRUN = 'FORRUN';
+ /**
+ * Pickupp.
+ */
public const PICKUP = 'PICKUP';
+ /**
+ * ECMS International Logistics Co..
+ */
public const ECMS = 'ECMS';
+ /**
+ * Intelipost (TMS for LATAM).
+ */
public const INTELIPOST = 'INTELIPOST';
+ /**
+ * Flash Express.
+ */
public const FLASHEXPRESS = 'FLASHEXPRESS';
+ /**
+ * STO Express.
+ */
public const CN_STO = 'CN_STO';
+ /**
+ * SEKO Worldwide.
+ */
public const SEKO_SFTP = 'SEKO_SFTP';
+ /**
+ * Home Delivery Solutions Ltd.
+ */
public const HOME_DELIVERY_SOLUTIONS = 'HOME_DELIVERY_SOLUTIONS';
+ /**
+ * DPD Hungary.
+ */
public const DPD_HGRY = 'DPD_HGRY';
+ /**
+ * Kerry Express (Vietnam) Co Ltd.
+ */
public const KERRYTTC_VN = 'KERRYTTC_VN';
+ /**
+ * Joying Box.
+ */
public const JOYING_BOX = 'JOYING_BOX';
+ /**
+ * Total Express.
+ */
public const TOTAL_EXPRESS = 'TOTAL_EXPRESS';
+ /**
+ * ZJS International.
+ */
public const ZJS_EXPRESS = 'ZJS_EXPRESS';
+ /**
+ * STARKEN couriers.
+ */
public const STARKEN = 'STARKEN';
+ /**
+ * DemandShip.
+ */
public const DEMANDSHIP = 'DEMANDSHIP';
+ /**
+ * DPEX.
+ */
public const CN_DPEX = 'CN_DPEX';
+ /**
+ * AuPost China.
+ */
public const AUPOST_CN = 'AUPOST_CN';
+ /**
+ * Logisters.
+ */
public const LOGISTERS = 'LOGISTERS';
+ /**
+ * Global Post.
+ */
public const GOGLOBALPOST = 'GOGLOBALPOST';
+ /**
+ * GLS Czech Republic.
+ */
public const GLS_CZ = 'GLS_CZ';
+ /**
+ * Paack courier.
+ */
public const PAACK_WEBHOOK = 'PAACK_WEBHOOK';
+ /**
+ * Grab courier.
+ */
public const GRAB_WEBHOOK = 'GRAB_WEBHOOK';
+ /**
+ * Parcelpoint.
+ */
public const PARCELPOINT = 'PARCELPOINT';
+ /**
+ * iCumulus.
+ */
public const ICUMULUS = 'ICUMULUS';
+ /**
+ * DAI Post.
+ */
public const DAIGLOBALTRACK = 'DAIGLOBALTRACK';
+ /**
+ * i-parcel.
+ */
public const GLOBAL_IPARCEL = 'GLOBAL_IPARCEL';
+ /**
+ * Yurtici Kargo.
+ */
public const YURTICI_KARGO = 'YURTICI_KARGO';
+ /**
+ * PayPal Package.
+ */
public const CN_PAYPAL_PACKAGE = 'CN_PAYPAL_PACKAGE';
+ /**
+ * Parcel To Post.
+ */
public const PARCEL_2_POST = 'PARCEL_2_POST';
+ /**
+ * GLS Italy.
+ */
public const GLS_IT = 'GLS_IT';
+ /**
+ * PIL Logistics (China) Co..
+ */
public const PIL_LOGISTICS = 'PIL_LOGISTICS';
+ /**
+ * Heppner Internationale Spedition GmbH & Co..
+ */
public const HEPPNER = 'HEPPNER';
+ /**
+ * Go!Express and logistics.
+ */
public const GENERAL_OVERNIGHT = 'GENERAL_OVERNIGHT';
+ /**
+ * Happy 2ThePoint.
+ */
public const HAPPY2POINT = 'HAPPY2POINT';
+ /**
+ * Chit Chats.
+ */
public const CHITCHATS = 'CHITCHATS';
+ /**
+ * Smooth Couriers.
+ */
public const SMOOTH = 'SMOOTH';
+ /**
+ * CL E-Logistics Solutions Limited.
+ */
public const CLE_LOGISTICS = 'CLE_LOGISTICS';
+ /**
+ * Fiege Logistics.
+ */
public const FIEGE = 'FIEGE';
+ /**
+ * M&X cargo.
+ */
public const MX_CARGO = 'MX_CARGO';
+ /**
+ * Ziing Final Mile Inc.
+ */
public const ZIINGFINALMILE = 'ZIINGFINALMILE';
+ /**
+ * Dayton Freight.
+ */
public const DAYTON_FREIGHT = 'DAYTON_FREIGHT';
+ /**
+ * TCS courier.
+ */
public const TCS = 'TCS';
+ /**
+ * AEX Group.
+ */
public const AEX = 'AEX';
+ /**
+ * Hermes Germany.
+ */
public const HERMES_DE = 'HERMES_DE';
+ /**
+ * Routific.
+ */
public const ROUTIFIC_WEBHOOK = 'ROUTIFIC_WEBHOOK';
+ /**
+ * Globavend.
+ */
public const GLOBAVEND = 'GLOBAVEND';
+ /**
+ * CJ Logistics International.
+ */
public const CJ_LOGISTICS = 'CJ_LOGISTICS';
+ /**
+ * The Pallet Network.
+ */
public const PALLET_NETWORK = 'PALLET_NETWORK';
+ /**
+ * RAF Philippines.
+ */
public const RAF_PH = 'RAF_PH';
+ /**
+ * XDP Express.
+ */
public const UK_XDP = 'UK_XDP';
+ /**
+ * Paper Express.
+ */
public const PAPER_EXPRESS = 'PAPER_EXPRESS';
+ /**
+ * La Poste.
+ */
public const LA_POSTE_SUIVI = 'LA_POSTE_SUIVI';
+ /**
+ * Paquetexpress.
+ */
public const PAQUETEXPRESS = 'PAQUETEXPRESS';
+ /**
+ * liefery.
+ */
public const LIEFERY = 'LIEFERY';
+ /**
+ * Streck Transport.
+ */
public const STRECK_TRANSPORT = 'STRECK_TRANSPORT';
+ /**
+ * Pony express.
+ */
public const PONY_EXPRESS = 'PONY_EXPRESS';
+ /**
+ * Always Express.
+ */
public const ALWAYS_EXPRESS = 'ALWAYS_EXPRESS';
+ /**
+ * GBS-Broker.
+ */
public const GBS_BROKER = 'GBS_BROKER';
+ /**
+ * City-Link Express.
+ */
public const CITYLINK_MY = 'CITYLINK_MY';
+ /**
+ * ALLJOY SUPPLY CHAIN.
+ */
public const ALLJOY = 'ALLJOY';
+ /**
+ * yodel.
+ */
public const YODEL = 'YODEL';
+ /**
+ * Yodel Direct.
+ */
public const YODEL_DIR = 'YODEL_DIR';
+ /**
+ * STONE3PL.
+ */
public const STONE3PL = 'STONE3PL';
+ /**
+ * ParcelPal.
+ */
public const PARCELPAL_WEBHOOK = 'PARCELPAL_WEBHOOK';
+ /**
+ * DHL eCommerce Asia (API).
+ */
public const DHL_ECOMERCE_ASA = 'DHL_ECOMERCE_ASA';
+ /**
+ * J&T Express Singapore.
+ */
public const SIMPLYPOST = 'SIMPLYPOST';
+ /**
+ * Kua Yue Express.
+ */
public const KY_EXPRESS = 'KY_EXPRESS';
+ /**
+ * shenzhen 1st International Logistics(Group)Co.
+ */
public const SHENZHEN = 'SHENZHEN';
+ /**
+ * LaserShip.
+ */
public const US_LASERSHIP = 'US_LASERSHIP';
+ /**
+ * ucexpress.
+ */
public const UC_EXPRE = 'UC_EXPRE';
+ /**
+ * DIDADI Logistics tech.
+ */
public const DIDADI = 'DIDADI';
+ /**
+ * CJ Korea Express.
+ */
public const CJ_KR = 'CJ_KR';
+ /**
+ * DB Schenker B2B.
+ */
public const DBSCHENKER_B2B = 'DBSCHENKER_B2B';
+ /**
+ * MXE Express.
+ */
public const MXE = 'MXE';
+ /**
+ * CAE Delivers.
+ */
public const CAE_DELIVERS = 'CAE_DELIVERS';
+ /**
+ * PFC Express.
+ */
public const PFCEXPRESS = 'PFCEXPRESS';
+ /**
+ * Whistl.
+ */
public const WHISTL = 'WHISTL';
+ /**
+ * WePost Sdn Bhd.
+ */
public const WEPOST = 'WEPOST';
+ /**
+ * DHL parcel Spain(www.dhl.com).
+ */
public const DHL_PARCEL_ES = 'DHL_PARCEL_ES';
+ /**
+ * DD Express Courier.
+ */
public const DDEXPRESS = 'DDEXPRESS';
+ /**
+ * Aramex Australia (formerly Fastway AU).
+ */
public const ARAMEX_AU = 'ARAMEX_AU';
+ /**
+ * Bneed courier.
+ */
public const BNEED = 'BNEED';
+ /**
+ * Kerry Express Hong Kong.
+ */
public const HK_TGX = 'HK_TGX';
+ /**
+ * Latvijas Pasts.
+ */
public const LATVIJAS_PASTS = 'LATVIJAS_PASTS';
+ /**
+ * ViaEurope.
+ */
public const VIAEUROPE = 'VIAEUROPE';
+ /**
+ * Correo Uruguayo.
+ */
public const CORREO_UY = 'CORREO_UY';
+ /**
+ * Chronopost france (www.chronopost.fr).
+ */
public const CHRONOPOST_FR = 'CHRONOPOST_FR';
+ /**
+ * J-Net.
+ */
public const J_NET = 'J_NET';
+ /**
+ * 6ls.com.
+ */
public const _6LS = '_6LS';
+ /**
+ * Belpost.
+ */
public const BLR_BELPOST = 'BLR_BELPOST';
+ /**
+ * BirdSystem.
+ */
public const BIRDSYSTEM = 'BIRDSYSTEM';
+ /**
+ * DobroPost.
+ */
public const DOBROPOST = 'DOBROPOST';
+ /**
+ * Wahana express (www.wahana.com).
+ */
public const WAHANA_ID = 'WAHANA_ID';
+ /**
+ * Weaship.
+ */
public const WEASHIP = 'WEASHIP';
+ /**
+ * Sonic Transportation & Logistics.
+ */
public const SONICTL = 'SONICTL';
+ /**
+ * Shenzhen Jinghuada Logistics Co..
+ */
public const KWT = 'KWT';
+ /**
+ * AFL LOGISTICS.
+ */
public const AFLLOG_FTP = 'AFLLOG_FTP';
+ /**
+ * SkyNet Worldwide Express.
+ */
public const SKYNET_WORLDWIDE = 'SKYNET_WORLDWIDE';
+ /**
+ * Nova Poshta (novaposhta.ua).
+ */
public const NOVA_POSHTA = 'NOVA_POSHTA';
+ /**
+ * Seino.
+ */
public const SEINO = 'SEINO';
+ /**
+ * SZENDEX.
+ */
public const SZENDEX = 'SZENDEX';
+ /**
+ * Bpost international.
+ */
public const BPOST_INT = 'BPOST_INT';
+ /**
+ * DB Schenker Sweden.
+ */
public const DBSCHENKER_SV = 'DBSCHENKER_SV';
+ /**
+ * AO Deutschland.
+ */
public const AO_DEUTSCHLAND = 'AO_DEUTSCHLAND';
+ /**
+ * EU Fleet Solutions.
+ */
public const EU_FLEET_SOLUTIONS = 'EU_FLEET_SOLUTIONS';
+ /**
+ * PCF Final Mile.
+ */
public const PCFCORP = 'PCFCORP';
+ /**
+ * Link Bridge(BeiJing)international logistics co..
+ */
public const LINKBRIDGE = 'LINKBRIDGE';
+ /**
+ * PT Prima Multi Cipta.
+ */
public const PRIMAMULTICIPTA = 'PRIMAMULTICIPTA';
+ /**
+ * Urbanfox.
+ */
public const COUREX = 'COUREX';
+ /**
+ * Zajil Express Company.
+ */
public const ZAJIL_EXPRESS = 'ZAJIL_EXPRESS';
+ /**
+ * CollectCo.
+ */
public const COLLECTCO = 'COLLECTCO';
+ /**
+ * J&T EXPRESS MALAYSIA.
+ */
public const JTEXPRESS = 'JTEXPRESS';
+ /**
+ * FedEx® UK.
+ */
public const FEDEX_UK = 'FEDEX_UK';
+ /**
+ * uShip courier.
+ */
public const USHIP = 'USHIP';
+ /**
+ * PIXSELL LOGISTICS.
+ */
public const PIXSELL = 'PIXSELL';
+ /**
+ * Shiptor.
+ */
public const SHIPTOR = 'SHIPTOR';
+ /**
+ * CDEK courier.
+ */
public const CDEK = 'CDEK';
+ /**
+ * ViettelPost.
+ */
public const VNM_VIETTELPOST = 'VNM_VIETTELPOST';
+ /**
+ * CJ Century.
+ */
public const CJ_CENTURY = 'CJ_CENTURY';
+ /**
+ * GSO(GLS-USA).
+ */
public const GSO = 'GSO';
+ /**
+ * VIWO IoT.
+ */
public const VIWO = 'VIWO';
+ /**
+ * SKYBOX.
+ */
public const SKYBOX = 'SKYBOX';
+ /**
+ * Kerry TJ Logistics.
+ */
public const KERRYTJ = 'KERRYTJ';
+ /**
+ * Nhat Tin Logistics.
+ */
public const NTLOGISTICS_VN = 'NTLOGISTICS_VN';
+ /**
+ * lightning monkey.
+ */
public const SDH_SCM = 'SDH_SCM';
+ /**
+ * Zinc courier.
+ */
public const ZINC = 'ZINC';
+ /**
+ * DPE South Africa.
+ */
public const DPE_SOUTH_AFRC = 'DPE_SOUTH_AFRC';
+ /**
+ * Czech Post.
+ */
public const CESKA_CZ = 'CESKA_CZ';
+ /**
+ * ACS Courier.
+ */
public const ACS_GR = 'ACS_GR';
+ /**
+ * DealerSend.
+ */
public const DEALERSEND = 'DEALERSEND';
+ /**
+ * Jocom.
+ */
public const JOCOM = 'JOCOM';
+ /**
+ * CSE courier.
+ */
public const CSE = 'CSE';
+ /**
+ * TForce Final Mile.
+ */
public const TFORCE_FINALMILE = 'TFORCE_FINALMILE';
+ /**
+ * ShipGate.
+ */
public const SHIP_GATE = 'SHIP_GATE';
+ /**
+ * SHIPTER.
+ */
public const SHIPTER = 'SHIPTER';
+ /**
+ * National Sameday.
+ */
public const NATIONAL_SAMEDAY = 'NATIONAL_SAMEDAY';
+ /**
+ * YunExpress.
+ */
public const YUNEXPRESS = 'YUNEXPRESS';
+ /**
+ * AliExpress Standard Shipping.
+ */
public const CAINIAO = 'CAINIAO';
+ /**
+ * DMSMatrix.
+ */
public const DMS_MATRIX = 'DMS_MATRIX';
+ /**
+ * Directlog (www.directlog.com.br).
+ */
public const DIRECTLOG = 'DIRECTLOG';
+ /**
+ * Asendia USA.
+ */
public const ASENDIA_US = 'ASENDIA_US';
+ /**
+ * 3JMS Logistics.
+ */
public const _3JMSLOGISTICS = '_3JMSLOGISTICS';
+ /**
+ * LICCARDI EXPRESS COURIER.
+ */
public const LICCARDI_EXPRESS = 'LICCARDI_EXPRESS';
+ /**
+ * SkyPostal.
+ */
public const SKY_POSTAL = 'SKY_POSTAL';
+ /**
+ * cnwangtong.
+ */
public const CNWANGTONG = 'CNWANGTONG';
+ /**
+ * ostnord denmark.
+ */
public const POSTNORD_LOGISTICS_DK = 'POSTNORD_LOGISTICS_DK';
+ /**
+ * Logistika.
+ */
public const LOGISTIKA = 'LOGISTIKA';
+ /**
+ * Celeritas Transporte.
+ */
public const CELERITAS = 'CELERITAS';
+ /**
+ * Pressio.
+ */
public const PRESSIODE = 'PRESSIODE';
+ /**
+ * Shree Maruti Courier Services Pvt Ltd.
+ */
public const SHREE_MARUTI = 'SHREE_MARUTI';
+ /**
+ * Logistic Worldwide Express (LWE Honkong).
+ */
public const LOGISTICSWORLDWIDE_HK = 'LOGISTICSWORLDWIDE_HK';
+ /**
+ * eFEx (E-Commerce Fulfillment & Express).
+ */
public const EFEX = 'EFEX';
+ /**
+ * Lotte Global Logistics.
+ */
public const LOTTE = 'LOTTE';
+ /**
+ * Lone Star Overnight.
+ */
public const LONESTAR = 'LONESTAR';
+ /**
+ * Aprisa Express.
+ */
public const APRISAEXPRESS = 'APRISAEXPRESS';
+ /**
+ * BEL North Russia.
+ */
public const BEL_RS = 'BEL_RS';
+ /**
+ * OSM Worldwide.
+ */
public const OSM_WORLDWIDE = 'OSM_WORLDWIDE';
+ /**
+ * Westgate Global.
+ */
public const WESTGATE_GL = 'WESTGATE_GL';
+ /**
+ * Fasttrack.
+ */
public const FASTRACK = 'FASTRACK';
+ /**
+ * DTD Express.
+ */
public const DTD_EXPR = 'DTD_EXPR';
+ /**
+ * AlfaTrex.
+ */
public const ALFATREX = 'ALFATREX';
+ /**
+ * ProMed Delivery.
+ */
public const PROMEDDELIVERY = 'PROMEDDELIVERY';
+ /**
+ * Thabit Logistics.
+ */
public const THABIT_LOGISTICS = 'THABIT_LOGISTICS';
+ /**
+ * HCT LOGISTICS CO.LTD..
+ */
public const HCT_LOGISTICS = 'HCT_LOGISTICS';
+ /**
+ * Carry-Flap Co..
+ */
public const CARRY_FLAP = 'CARRY_FLAP';
+ /**
+ * Old Dominion Freight Line.
+ */
public const US_OLD_DOMINION = 'US_OLD_DOMINION';
+ /**
+ * ANICAM BOX EXPRESS.
+ */
public const ANICAM_BOX = 'ANICAM_BOX';
+ /**
+ * WanbExpress.
+ */
public const WANBEXPRESS = 'WANBEXPRESS';
+ /**
+ * An Post.
+ */
public const AN_POST = 'AN_POST';
+ /**
+ * DPD Local.
+ */
public const DPD_LOCAL = 'DPD_LOCAL';
+ /**
+ * Stallion Express.
+ */
public const STALLIONEXPRESS = 'STALLIONEXPRESS';
+ /**
+ * RaidereX.
+ */
public const RAIDEREX = 'RAIDEREX';
+ /**
+ * ShopfansRU LLC.
+ */
public const SHOPFANS = 'SHOPFANS';
+ /**
+ * Kyungdong Parcel.
+ */
public const KYUNGDONG_PARCEL = 'KYUNGDONG_PARCEL';
+ /**
+ * Champion Logistics.
+ */
public const CHAMPION_LOGISTICS = 'CHAMPION_LOGISTICS';
+ /**
+ * PICK UPP (Singapore).
+ */
public const PICKUPP_SGP = 'PICKUPP_SGP';
+ /**
+ * Morning Express.
+ */
public const MORNING_EXPRESS = 'MORNING_EXPRESS';
+ /**
+ * NACEX.
+ */
public const NACEX = 'NACEX';
+ /**
+ * SortHub courier.
+ */
public const THENILE_WEBHOOK = 'THENILE_WEBHOOK';
+ /**
+ * Holisol.
+ */
public const HOLISOL = 'HOLISOL';
+ /**
+ * LBC EXPRESS INC..
+ */
public const LBCEXPRESS_FTP = 'LBCEXPRESS_FTP';
+ /**
+ * KURASI.
+ */
public const KURASI = 'KURASI';
+ /**
+ * USF Reddaway.
+ */
public const USF_REDDAWAY = 'USF_REDDAWAY';
+ /**
+ * APG eCommerce Solutions.
+ */
public const APG = 'APG';
+ /**
+ * BoxC courier.
+ */
public const CN_BOXC = 'CN_BOXC';
+ /**
+ * ECOSCOOTING.
+ */
public const ECOSCOOTING = 'ECOSCOOTING';
+ /**
+ * Mainway.
+ */
public const MAINWAY = 'MAINWAY';
+ /**
+ * Paperfly Private Limited.
+ */
public const PAPERFLY = 'PAPERFLY';
+ /**
+ * Hound Express.
+ */
public const HOUNDEXPRESS = 'HOUNDEXPRESS';
+ /**
+ * Boxberry courier.
+ */
public const BOX_BERRY = 'BOX_BERRY';
+ /**
+ * EP-Box courier.
+ */
public const EP_BOX = 'EP_BOX';
+ /**
+ * Plus UK Logistics.
+ */
public const PLUS_LOG_UK = 'PLUS_LOG_UK';
+ /**
+ * Fulfilla.
+ */
public const FULFILLA = 'FULFILLA';
+ /**
+ * ASE KARGO.
+ */
public const ASE = 'ASE';
+ /**
+ * MailPlus.
+ */
public const MAIL_PLUS = 'MAIL_PLUS';
+ /**
+ * XPO logistics.
+ */
public const XPO_LOGISTICS = 'XPO_LOGISTICS';
+ /**
+ * wnDirect.
+ */
public const WNDIRECT = 'WNDIRECT';
+ /**
+ * Cloudwish Asia.
+ */
public const CLOUDWISH_ASIA = 'CLOUDWISH_ASIA';
+ /**
+ * Zeleris.
+ */
public const ZELERIS = 'ZELERIS';
+ /**
+ * Gio Express.
+ */
public const GIO_EXPRESS = 'GIO_EXPRESS';
+ /**
+ * OCS WORLDWIDE.
+ */
public const OCS_WORLDWIDE = 'OCS_WORLDWIDE';
+ /**
+ * ARK Logistics.
+ */
public const ARK_LOGISTICS = 'ARK_LOGISTICS';
+ /**
+ * Aquiline.
+ */
public const AQUILINE = 'AQUILINE';
+ /**
+ * Pilot Freight Services.
+ */
public const PILOT_FREIGHT = 'PILOT_FREIGHT';
+ /**
+ * Qwintry Logistics.
+ */
public const QWINTRY = 'QWINTRY';
+ /**
+ * Danske Fragtaend.
+ */
public const DANSKE_FRAGT = 'DANSKE_FRAGT';
+ /**
+ * Carriers courier.
+ */
public const CARRIERS = 'CARRIERS';
+ /**
+ * Rivo (Air canada).
+ */
public const AIR_CANADA_GLOBAL = 'AIR_CANADA_GLOBAL';
+ /**
+ * PRESIDENT TRANSNET CORP.
+ */
public const PRESIDENT_TRANS = 'PRESIDENT_TRANS';
+ /**
+ * STEP FORWARD FREIGHT SERVICE CO LTD.
+ */
public const STEPFORWARDFS = 'STEPFORWARDFS';
+ /**
+ * Skynet UK.
+ */
public const SKYNET_UK = 'SKYNET_UK';
+ /**
+ * PITT OHIO.
+ */
public const PITTOHIO = 'PITTOHIO';
+ /**
+ * Correos Express.
+ */
public const CORREOS_EXPRESS = 'CORREOS_EXPRESS';
+ /**
+ * RL Carriers.
+ */
public const RL_US = 'RL_US';
- public const MARA_XPRESS = 'MARA_XPRESS';
-
+ /**
+ * Destiny Transportation.
+ */
public const DESTINY = 'DESTINY';
+ /**
+ * Yodel (www.yodel.co.uk).
+ */
public const UK_YODEL = 'UK_YODEL';
+ /**
+ * CometTech.
+ */
public const COMET_TECH = 'COMET_TECH';
+ /**
+ * DHL Parcel Russia.
+ */
public const DHL_PARCEL_RU = 'DHL_PARCEL_RU';
+ /**
+ * TNT Reference.
+ */
public const TNT_REFR = 'TNT_REFR';
+ /**
+ * Shree Anjani Courier.
+ */
public const SHREE_ANJANI_COURIER = 'SHREE_ANJANI_COURIER';
+ /**
+ * Mikropakket Belgium.
+ */
public const MIKROPAKKET_BE = 'MIKROPAKKET_BE';
+ /**
+ * RETS express.
+ */
public const ETS_EXPRESS = 'ETS_EXPRESS';
+ /**
+ * Colis Privé.
+ */
public const COLIS_PRIVE = 'COLIS_PRIVE';
+ /**
+ * Yunda Express.
+ */
public const CN_YUNDA = 'CN_YUNDA';
+ /**
+ * AAA Cooper.
+ */
public const AAA_COOPER = 'AAA_COOPER';
+ /**
+ * Rocket Parcel International.
+ */
public const ROCKET_PARCEL = 'ROCKET_PARCEL';
+ /**
+ * 360 Lion Express.
+ */
public const _360LION = '_360LION';
+ /**
+ * PANDU.
+ */
public const PANDU = 'PANDU';
+ /**
+ * PROFESSIONAL COURIERS.
+ */
public const PROFESSIONAL_COURIERS = 'PROFESSIONAL_COURIERS';
+ /**
+ * FLYTEXPRESS.
+ */
public const FLYTEXPRESS = 'FLYTEXPRESS';
+ /**
+ * LOGISTICSWORLDWIDE MY.
+ */
public const LOGISTICSWORLDWIDE_MY = 'LOGISTICSWORLDWIDE_MY';
+ /**
+ * CORREOS DE ESPANA.
+ */
public const CORREOS_DE_ESPANA = 'CORREOS_DE_ESPANA';
+ /**
+ * IMX.
+ */
public const IMX = 'IMX';
+ /**
+ * FOUR PX EXPRESS.
+ */
public const FOUR_PX_EXPRESS = 'FOUR_PX_EXPRESS';
+ /**
+ * XPRESSBEES.
+ */
public const XPRESSBEES = 'XPRESSBEES';
+ /**
+ * pickupp_vnm.
+ */
public const PICKUPP_VNM = 'PICKUPP_VNM';
+ /**
+ * startrack_express.
+ */
public const STARTRACK_EXPRESS1 = 'STARTRACK_EXPRESS';
+ /**
+ * fr_colissimo.
+ */
public const FR_COLISSIMO = 'FR_COLISSIMO';
+ /**
+ * nacex_spain_reference.
+ */
public const NACEX_SPAIN_REFERENCE = 'NACEX_SPAIN_REFERENCE';
+ /**
+ * dhl_supply_chain_au.
+ */
public const DHL_SUPPLY_CHAIN_AU = 'DHL_SUPPLY_CHAIN_AU';
+ /**
+ * Eshipping.
+ */
public const ESHIPPING = 'ESHIPPING';
+ /**
+ * SHREE TIRUPATI COURIER SERVICES PVT. LTD..
+ */
public const SHREETIRUPATI = 'SHREETIRUPATI';
+ /**
+ * HX Express.
+ */
public const HX_EXPRESS = 'HX_EXPRESS';
+ /**
+ * INDOPAKET.
+ */
public const INDOPAKET = 'INDOPAKET';
+ /**
+ * 17 Post Service.
+ */
public const CN_17POST = 'CN_17POST';
+ /**
+ * K1 Express.
+ */
public const K1_EXPRESS = 'K1_EXPRESS';
+ /**
+ * CJ GLS.
+ */
public const CJ_GLS = 'CJ_GLS';
+ /**
+ * GDEX courier.
+ */
public const MYS_GDEX = 'MYS_GDEX';
+ /**
+ * Nationex courier.
+ */
public const NATIONEX = 'NATIONEX';
+ /**
+ * Anjun couriers.
+ */
public const ANJUN = 'ANJUN';
+ /**
+ * FarGood.
+ */
public const FARGOOD = 'FARGOOD';
+ /**
+ * SMG Direct.
+ */
public const SMG_EXPRESS = 'SMG_EXPRESS';
+ /**
+ * RZY Express.
+ */
public const RZYEXPRESS = 'RZYEXPRESS';
+ /**
+ * Southeastern Freight Lines.
+ */
public const SEFL = 'SEFL';
+ /**
+ * TNT-Click Italy.
+ */
public const TNT_CLICK_IT = 'TNT_CLICK_IT';
+ /**
+ * Haidaibao.
+ */
public const HDB = 'HDB';
+ /**
+ * Hipshipper.
+ */
public const HIPSHIPPER = 'HIPSHIPPER';
+ /**
+ * RPX Logistics.
+ */
public const RPXLOGISTICS = 'RPXLOGISTICS';
+ /**
+ * Kuehne + Nagel.
+ */
public const KUEHNE = 'KUEHNE';
+ /**
+ * Nexive (TNT Post Italy).
+ */
public const IT_NEXIVE = 'IT_NEXIVE';
+ /**
+ * PTS courier.
+ */
public const PTS = 'PTS';
+ /**
+ * Swiss Post FTP.
+ */
public const SWISS_POST_FTP = 'SWISS_POST_FTP';
+ /**
+ * Fastrak Services.
+ */
public const FASTRK_SERV = 'FASTRK_SERV';
+ /**
+ * 4-72 Entregando.
+ */
public const _4_72 = '_4_72';
+ /**
+ * YRC courier.
+ */
public const US_YRC = 'US_YRC';
+ /**
+ * PostNL International 3S.
+ */
public const POSTNL_INTL_3S = 'POSTNL_INTL_3S';
+ /**
+ * Yilian (Elian) Supply Chain.
+ */
public const ELIAN_POST = 'ELIAN_POST';
+ /**
+ * Cubyn.
+ */
public const CUBYN = 'CUBYN';
+ /**
+ * Saudi Post.
+ */
public const SAU_SAUDI_POST = 'SAU_SAUDI_POST';
+ /**
+ * ABX Express.
+ */
public const ABXEXPRESS_MY = 'ABXEXPRESS_MY';
+ /**
+ * HUAHANG EXPRESS.
+ */
public const HUAHAN_EXPRESS = 'HUAHAN_EXPRESS';
- public const IND_JAYONEXPRESS = 'IND_JAYONEXPRESS';
-
+ /**
+ * Eshun international Logistic.
+ */
public const ZES_EXPRESS = 'ZES_EXPRESS';
+ /**
+ * ZeptoExpress.
+ */
public const ZEPTO_EXPRESS = 'ZEPTO_EXPRESS';
+ /**
+ * Skynet World Wide Express South Africa.
+ */
public const SKYNET_ZA = 'SKYNET_ZA';
+ /**
+ * Zeek2Door.
+ */
public const ZEEK_2_DOOR = 'ZEEK_2_DOOR';
+ /**
+ * Blink.
+ */
public const BLINKLASTMILE = 'BLINKLASTMILE';
+ /**
+ * UkrPoshta.
+ */
public const POSTA_UKR = 'POSTA_UKR';
+ /**
+ * C.H. Robinson Worldwide.
+ */
public const CHROBINSON = 'CHROBINSON';
+ /**
+ * Post56.
+ */
public const CN_POST56 = 'CN_POST56';
+ /**
+ * Courant Plus.
+ */
public const COURANT_PLUS = 'COURANT_PLUS';
+ /**
+ * Scudex Express.
+ */
public const SCUDEX_EXPRESS = 'SCUDEX_EXPRESS';
+ /**
+ * ShipEntegra.
+ */
public const SHIPENTEGRA = 'SHIPENTEGRA';
+ /**
+ * B2C courier Europe.
+ */
public const B_TWO_C_EUROPE = 'B_TWO_C_EUROPE';
+ /**
+ * Cope Sensitive Freight.
+ */
public const COPE = 'COPE';
+ /**
+ * Gati-KWE.
+ */
public const IND_GATI = 'IND_GATI';
+ /**
+ * WishPost.
+ */
public const CN_WISHPOST = 'CN_WISHPOST';
+ /**
+ * NACEX Spain.
+ */
public const NACEX_ES = 'NACEX_ES';
+ /**
+ * TAQBIN Hong Kong.
+ */
public const TAQBIN_HK = 'TAQBIN_HK';
+ /**
+ * GlobalTranz.
+ */
public const GLOBALTRANZ = 'GLOBALTRANZ';
+ /**
+ * Qingdao HKD International Logistics.
+ */
public const HKD = 'HKD';
+ /**
+ * BJS Distribution courier.
+ */
public const BJSHOMEDELIVERY = 'BJSHOMEDELIVERY';
+ /**
+ * Omniva.
+ */
public const OMNIVA = 'OMNIVA';
+ /**
+ * Sutton Transport.
+ */
public const SUTTON = 'SUTTON';
+ /**
+ * Panther Reference.
+ */
public const PANTHER_REFERENCE = 'PANTHER_REFERENCE';
+ /**
+ * SFC Service.
+ */
public const SFCSERVICE = 'SFCSERVICE';
+ /**
+ * LTL COURIER.
+ */
public const LTL = 'LTL';
+ /**
+ * Park N Parcel.
+ */
public const PARKNPARCEL = 'PARKNPARCEL';
+ /**
+ * Spring GDS.
+ */
public const SPRING_GDS = 'SPRING_GDS';
+ /**
+ * ECexpress.
+ */
public const ECEXPRESS = 'ECEXPRESS';
+ /**
+ * Interparcel Australia.
+ */
public const INTERPARCEL_AU = 'INTERPARCEL_AU';
+ /**
+ * Agility.
+ */
public const AGILITY = 'AGILITY';
+ /**
+ * XL Express.
+ */
public const XL_EXPRESS = 'XL_EXPRESS';
+ /**
+ * Ader couriers.
+ */
public const ADERONLINE = 'ADERONLINE';
+ /**
+ * Direct Couriers.
+ */
public const DIRECTCOURIERS = 'DIRECTCOURIERS';
+ /**
+ * Planzer Group.
+ */
public const PLANZER = 'PLANZER';
+ /**
+ * Sending Transporte Urgente y Comunicacion.
+ */
public const SENDING = 'SENDING';
+ /**
+ * Ninjavan Webhook.
+ */
public const NINJAVAN_WB = 'NINJAVAN_WB';
+ /**
+ * Nationwide Express Courier Services Bhd (www.nationwide.com.my).
+ */
public const NATIONWIDE_MY = 'NATIONWIDE_MY';
+ /**
+ * Sendit.
+ */
public const SENDIT = 'SENDIT';
+ /**
+ * Arrow XL.
+ */
public const GB_ARROW = 'GB_ARROW';
+ /**
+ * GoJavas.
+ */
public const IND_GOJAVAS = 'IND_GOJAVAS';
+ /**
+ * Korea Post.
+ */
public const KPOST = 'KPOST';
+ /**
+ * DHL Freight.
+ */
public const DHL_FREIGHT = 'DHL_FREIGHT';
+ /**
+ * Bluecare Express Ltd.
+ */
public const BLUECARE = 'BLUECARE';
+ /**
+ * jindouyun courier.
+ */
public const JINDOUYUN = 'JINDOUYUN';
+ /**
+ * Trackon Couriers Pvt. Ltd.
+ */
public const TRACKON = 'TRACKON';
+ /**
+ * Tuffnells Parcels Express.
+ */
public const GB_TUFFNELLS = 'GB_TUFFNELLS';
+ /**
+ * TRUMPCARD LLC.
+ */
public const TRUMPCARD = 'TRUMPCARD';
+ /**
+ * eTotal Solution Limited.
+ */
public const ETOTAL = 'ETOTAL';
+ /**
+ * Zeek courier.
+ */
public const SFPLUS_WEBHOOK = 'SFPLUS_WEBHOOK';
+ /**
+ * SEKO Logistics.
+ */
public const SEKOLOGISTICS = 'SEKOLOGISTICS';
+ /**
+ * Hermes Einrichtungs Service GmbH & Co. KG.
+ */
public const HERMES_2MANN_HANDLING = 'HERMES_2MANN_HANDLING';
+ /**
+ * DPD Local reference.
+ */
public const DPD_LOCAL_REF = 'DPD_LOCAL_REF';
+ /**
+ * United Delivery Service.
+ */
public const UDS = 'UDS';
+ /**
+ * Specialised Freight.
+ */
public const ZA_SPECIALISED_FREIGHT = 'ZA_SPECIALISED_FREIGHT';
+ /**
+ * Kerry Express Thailand.
+ */
public const THA_KERRY = 'THA_KERRY';
+ /**
+ * SEUR International.
+ */
public const PRT_INT_SEUR = 'PRT_INT_SEUR';
+ /**
+ * Correios Brazil.
+ */
public const BRA_CORREIOS = 'BRA_CORREIOS';
+ /**
+ * New Zealand Post.
+ */
public const NZ_NZ_POST = 'NZ_NZ_POST';
+ /**
+ * Equick China.
+ */
public const CN_EQUICK = 'CN_EQUICK';
+ /**
+ * Malaysia Post EMS / Pos Laju.
+ */
public const MYS_EMS = 'MYS_EMS';
+ /**
+ * Norsk Global.
+ */
public const GB_NORSK = 'GB_NORSK';
+ /**
+ * MRW spain.
+ */
public const ESP_MRW = 'ESP_MRW';
+ /**
+ * Packlink.
+ */
public const ESP_PACKLINK = 'ESP_PACKLINK';
+ /**
+ * Kangaroo Worldwide Express.
+ */
public const KANGAROO_MY = 'KANGAROO_MY';
+ /**
+ * RPX Online.
+ */
public const RPX = 'RPX';
+ /**
+ * XDP Express Reference.
+ */
public const XDP_UK_REFERENCE = 'XDP_UK_REFERENCE';
+ /**
+ * ninja van (www.ninjavan.co).
+ */
public const NINJAVAN_MY = 'NINJAVAN_MY';
+ /**
+ * Adicional Logistics.
+ */
public const ADICIONAL = 'ADICIONAL';
- public const NINJAVAN_ID = 'NINJAVAN_ID';
-
+ /**
+ * Red Carpet Logistics.
+ */
public const ROADBULL = 'ROADBULL';
+ /**
+ * Yakit courier.
+ */
public const YAKIT = 'YAKIT';
+ /**
+ * MailAmericas.
+ */
public const MAILAMERICAS = 'MAILAMERICAS';
+ /**
+ * Mikropakket.
+ */
public const MIKROPAKKET = 'MIKROPAKKET';
+ /**
+ * Dynamic Logistics.
+ */
public const DYNALOGIC = 'DYNALOGIC';
+ /**
+ * DHL Spain(www.dhl.com).
+ */
public const DHL_ES = 'DHL_ES';
+ /**
+ * DHL Parcel NL.
+ */
public const DHL_PARCEL_NL = 'DHL_PARCEL_NL';
+ /**
+ * DHL Global Mail Asia (www.dhl.com).
+ */
public const DHL_GLOBAL_MAIL_ASIA = 'DHL_GLOBAL_MAIL_ASIA';
+ /**
+ * Dawn Wing.
+ */
public const DAWN_WING = 'DAWN_WING';
+ /**
+ * Geniki Taxydromiki.
+ */
public const GENIKI_GR = 'GENIKI_GR';
+ /**
+ * hermesworld_uk.
+ */
public const HERMESWORLD_UK = 'HERMESWORLD_UK';
+ /**
+ * Alphafast (www.alphafast.com).
+ */
public const ALPHAFAST = 'ALPHAFAST';
+ /**
+ * buylogic.
+ */
public const BUYLOGIC = 'BUYLOGIC';
+ /**
+ * Ekart logistics (ekartlogistics.com).
+ */
public const EKART = 'EKART';
+ /**
+ * mexico senda express.
+ */
public const MEX_SENDA = 'MEX_SENDA';
+ /**
+ * SFC.
+ */
public const SFC_LOGISTICS = 'SFC_LOGISTICS';
+ /**
+ * Posta Serbia.
+ */
public const POST_SERBIA = 'POST_SERBIA';
+ /**
+ * Delhivery India.
+ */
public const IND_DELHIVERY = 'IND_DELHIVERY';
+ /**
+ * DPD Germany.
+ */
public const DE_DPD_DELISTRACK = 'DE_DPD_DELISTRACK';
+ /**
+ * RPD2man Deliveries.
+ */
public const RPD2MAN = 'RPD2MAN';
+ /**
+ * SF Express (www.sf-express.com).
+ */
public const CN_SF_EXPRESS = 'CN_SF_EXPRESS';
+ /**
+ * Yanwen Logistics.
+ */
public const YANWEN = 'YANWEN';
+ /**
+ * Skynet Malaysia.
+ */
public const MYS_SKYNET = 'MYS_SKYNET';
+ /**
+ * correos mexico.
+ */
public const CORREOS_DE_MEXICO = 'CORREOS_DE_MEXICO';
+ /**
+ * CBL Logistica.
+ */
public const CBL_LOGISTICA = 'CBL_LOGISTICA';
+ /**
+ * Estafeta (www.estafeta.com).
+ */
public const MEX_ESTAFETA = 'MEX_ESTAFETA';
+ /**
+ * Austrian Post (Registered).
+ */
public const AU_AUSTRIAN_POST = 'AU_AUSTRIAN_POST';
+ /**
+ * Rincos.
+ */
public const RINCOS = 'RINCOS';
+ /**
+ * DHL Netherland.
+ */
public const NLD_DHL = 'NLD_DHL';
+ /**
+ * Russian post.
+ */
public const RUSSIAN_POST = 'RUSSIAN_POST';
+ /**
+ * CouriersPlease (couriersplease.com.au).
+ */
public const COURIERS_PLEASE = 'COURIERS_PLEASE';
+ /**
+ * PostNord Logistics.
+ */
public const POSTNORD_LOGISTICS = 'POSTNORD_LOGISTICS';
+ /**
+ * Fedex.
+ */
public const FEDEX = 'FEDEX';
+ /**
+ * DPE Express.
+ */
public const DPE_EXPRESS = 'DPE_EXPRESS';
+ /**
+ * DPD.
+ */
public const DPD = 'DPD';
+ /**
+ * ADSone.
+ */
public const ADSONE = 'ADSONE';
+ /**
+ * JNE Express (Jalur Nugraha Ekakurir).
+ */
public const IDN_JNE = 'IDN_JNE';
+ /**
+ * The Courier Guy.
+ */
public const THECOURIERGUY = 'THECOURIERGUY';
+ /**
+ * CNE Express.
+ */
public const CNEXPS = 'CNEXPS';
+ /**
+ * Chronopost Portugal.
+ */
public const PRT_CHRONOPOST = 'PRT_CHRONOPOST';
+ /**
+ * Landmark Global.
+ */
public const LANDMARK_GLOBAL = 'LANDMARK_GLOBAL';
+ /**
+ * DHL International.
+ */
public const IT_DHL_ECOMMERCE = 'IT_DHL_ECOMMERCE';
+ /**
+ * NACEX Spain.
+ */
public const ESP_NACEX = 'ESP_NACEX';
+ /**
+ * CTT Portugal.
+ */
public const PRT_CTT = 'PRT_CTT';
+ /**
+ * Kiala.
+ */
public const BE_KIALA = 'BE_KIALA';
+ /**
+ * Asendia UK.
+ */
public const ASENDIA_UK = 'ASENDIA_UK';
+ /**
+ * TNT global.
+ */
public const GLOBAL_TNT = 'GLOBAL_TNT';
+ /**
+ * Iceland Post.
+ */
public const POSTUR_IS = 'POSTUR_IS';
+ /**
+ * eParcel Korea.
+ */
public const EPARCEL_KR = 'EPARCEL_KR';
+ /**
+ * InPost Paczkomaty.
+ */
public const INPOST_PACZKOMATY = 'INPOST_PACZKOMATY';
+ /**
+ * Poste italiane (www.poste.it).
+ */
public const IT_POSTE_ITALIA = 'IT_POSTE_ITALIA';
+ /**
+ * Bpost (www.bpost.be).
+ */
public const BE_BPOST = 'BE_BPOST';
+ /**
+ * Poczta Polska (www.poczta-polska.pl).
+ */
public const PL_POCZTA_POLSKA = 'PL_POCZTA_POLSKA';
+ /**
+ * Malaysia Post.
+ */
public const MYS_MYS_POST = 'MYS_MYS_POST';
+ /**
+ * Singapore Post.
+ */
public const SG_SG_POST = 'SG_SG_POST';
+ /**
+ * Thailand Post (www.thailandpost.co.th).
+ */
public const THA_THAILAND_POST = 'THA_THAILAND_POST';
+ /**
+ * LexShip.
+ */
public const LEXSHIP = 'LEXSHIP';
+ /**
+ * Fastway New Zealand.
+ */
public const FASTWAY_NZ = 'FASTWAY_NZ';
+ /**
+ * DHL Supply Chain Australia.
+ */
public const DHL_AU = 'DHL_AU';
+ /**
+ * Cosmetics Now.
+ */
public const COSTMETICSNOW = 'COSTMETICSNOW';
+ /**
+ * PFL.
+ */
public const PFLOGISTICS = 'PFLOGISTICS';
+ /**
+ * Loomis Express.
+ */
public const LOOMIS_EXPRESS = 'LOOMIS_EXPRESS';
+ /**
+ * GLS Italy.
+ */
public const GLS_ITALY = 'GLS_ITALY';
+ /**
+ * Line Clear Express & Logistics Sdn Bhd.
+ */
public const LINE = 'LINE';
+ /**
+ * Gel Express Logistik.
+ */
public const GEL_EXPRESS = 'GEL_EXPRESS';
+ /**
+ * Huodull.
+ */
public const HUODULL = 'HUODULL';
+ /**
+ * Ninja van Singapore.
+ */
public const NINJAVAN_SG = 'NINJAVAN_SG';
+ /**
+ * Janio Asia.
+ */
public const JANIO = 'JANIO';
+ /**
+ * AO Logistics.
+ */
public const AO_COURIER = 'AO_COURIER';
+ /**
+ * BRT Bartolini(Sender Reference).
+ */
public const BRT_IT_SENDER_REF = 'BRT_IT_SENDER_REF';
+ /**
+ * SAILPOST.
+ */
public const SAILPOST = 'SAILPOST';
+ /**
+ * Lalamove.
+ */
public const LALAMOVE = 'LALAMOVE';
+ /**
+ * NEW ZEALAND COURIERS.
+ */
public const NEWZEALAND_COURIERS = 'NEWZEALAND_COURIERS';
+ /**
+ * Etomars.
+ */
public const ETOMARS = 'ETOMARS';
+ /**
+ * VIR Transport.
+ */
public const VIRTRANSPORT = 'VIRTRANSPORT';
+ /**
+ * Wizmo.
+ */
public const WIZMO = 'WIZMO';
+ /**
+ * Palletways.
+ */
public const PALLETWAYS = 'PALLETWAYS';
+ /**
+ * i-dika.
+ */
public const I_DIKA = 'I_DIKA';
+ /**
+ * CFL Logistics.
+ */
public const CFL_LOGISTICS = 'CFL_LOGISTICS';
+ /**
+ * GEM Worldwide.
+ */
public const GEMWORLDWIDE = 'GEMWORLDWIDE';
+ /**
+ * Tai Wan Global Business.
+ */
public const GLOBAL_EXPRESS = 'GLOBAL_EXPRESS';
+ /**
+ * Transgroup courier.
+ */
public const LOGISTYX_TRANSGROUP = 'LOGISTYX_TRANSGROUP';
+ /**
+ * West Bank Courier.
+ */
public const WESTBANK_COURIER = 'WESTBANK_COURIER';
+ /**
+ * Arco Spedizioni SP.
+ */
public const ARCO_SPEDIZIONI = 'ARCO_SPEDIZIONI';
+ /**
+ * YDH express.
+ */
public const YDH_EXPRESS = 'YDH_EXPRESS';
+ /**
+ * Parcelink Logistics.
+ */
public const PARCELINKLOGISTICS = 'PARCELINKLOGISTICS';
+ /**
+ * CND Express.
+ */
public const CNDEXPRESS = 'CNDEXPRESS';
+ /**
+ * NOX NightTimeExpress.
+ */
public const NOX_NIGHT_TIME_EXPRESS = 'NOX_NIGHT_TIME_EXPRESS';
+ /**
+ * Aeronet couriers.
+ */
public const AERONET = 'AERONET';
+ /**
+ * LTIAN EXP.
+ */
public const LTIANEXP = 'LTIANEXP';
+ /**
+ * Integra2.
+ */
public const INTEGRA2_FTP = 'INTEGRA2_FTP';
+ /**
+ * PARCEL ONE.
+ */
public const PARCELONE = 'PARCELONE';
+ /**
+ * Innight Express Germany GmbH (nox NachtExpress).
+ */
public const NOX_NACHTEXPRESS = 'NOX_NACHTEXPRESS';
+ /**
+ * China Post.
+ */
public const CN_CHINA_POST_EMS = 'CN_CHINA_POST_EMS';
+ /**
+ * Chukou1.
+ */
public const CHUKOU1 = 'CHUKOU1';
+ /**
+ * GLS General Logistics Systems Slovakia s.r.o..
+ */
public const GLS_SLOV = 'GLS_SLOV';
+ /**
+ * OrangeDS (Orange Distribution Solutions Inc).
+ */
public const ORANGE_DS = 'ORANGE_DS';
+ /**
+ * Joom Logistics.
+ */
public const JOOM_LOGIS = 'JOOM_LOGIS';
+ /**
+ * StarTrack (startrack.com.au).
+ */
public const AUS_STARTRACK = 'AUS_STARTRACK';
+ /**
+ * dhl Global.
+ */
public const DHL = 'DHL';
+ /**
+ * APC postal logistics germany.
+ */
public const GB_APC = 'GB_APC';
+ /**
+ * Bonds Courier Service (bondscouriers.com.au).
+ */
public const BONDSCOURIERS = 'BONDSCOURIERS';
+ /**
+ * Japan Post.
+ */
public const JPN_JAPAN_POST = 'JPN_JAPAN_POST';
+ /**
+ * United States Postal Service.
+ */
public const USPS = 'USPS';
+ /**
+ * WinIt.
+ */
public const WINIT = 'WINIT';
+ /**
+ * OCA Argentina.
+ */
public const ARG_OCA = 'ARG_OCA';
+ /**
+ * Taiwan Post.
+ */
public const TW_TAIWAN_POST = 'TW_TAIWAN_POST';
+ /**
+ * DMM Network.
+ */
public const DMM_NETWORK = 'DMM_NETWORK';
+ /**
+ * TNT Express.
+ */
public const TNT = 'TNT';
+ /**
+ * BH Posta (www.posta.ba).
+ */
public const BH_POSTA = 'BH_POSTA';
+ /**
+ * Postnord sweden.
+ */
public const SWE_POSTNORD = 'SWE_POSTNORD';
+ /**
+ * Canada Post.
+ */
public const CA_CANADA_POST = 'CA_CANADA_POST';
+ /**
+ * Wiseloads.
+ */
public const WISELOADS = 'WISELOADS';
+ /**
+ * Asendia HonKong.
+ */
public const ASENDIA_HK = 'ASENDIA_HK';
+ /**
+ * GLS Netherland.
+ */
public const NLD_GLS = 'NLD_GLS';
+ /**
+ * Redpack.
+ */
public const MEX_REDPACK = 'MEX_REDPACK';
+ /**
+ * Jet-Ship Worldwide.
+ */
public const JET_SHIP = 'JET_SHIP';
+ /**
+ * DHL Express.
+ */
public const DE_DHL_EXPRESS = 'DE_DHL_EXPRESS';
+ /**
+ * Ninja van Thai.
+ */
public const NINJAVAN_THAI = 'NINJAVAN_THAI';
+ /**
+ * Raben Group.
+ */
public const RABEN_GROUP = 'RABEN_GROUP';
+ /**
+ * ASM(GLS Spain).
+ */
public const ESP_ASM = 'ESP_ASM';
+ /**
+ * Hrvatska posta.
+ */
public const HRV_HRVATSKA = 'HRV_HRVATSKA';
+ /**
+ * Estes Express Lines.
+ */
public const GLOBAL_ESTES = 'GLOBAL_ESTES';
+ /**
+ * Lietuvos pastas.
+ */
public const LTU_LIETUVOS = 'LTU_LIETUVOS';
+ /**
+ * DHL Benelux.
+ */
public const BEL_DHL = 'BEL_DHL';
+ /**
+ * Australia Post.
+ */
public const AU_AU_POST = 'AU_AU_POST';
+ /**
+ * SPEEDEX couriers.
+ */
public const SPEEDEXCOURIER = 'SPEEDEXCOURIER';
+ /**
+ * Colissimo.
+ */
public const FR_COLIS = 'FR_COLIS';
+ /**
+ * Aramex.
+ */
public const ARAMEX = 'ARAMEX';
+ /**
+ * DPEX (www.dpex.com).
+ */
public const DPEX = 'DPEX';
+ /**
+ * Airpak Express.
+ */
public const MYS_AIRPAK = 'MYS_AIRPAK';
+ /**
+ * Cuckoo Express.
+ */
public const CUCKOOEXPRESS = 'CUCKOOEXPRESS';
+ /**
+ * DPD Poland.
+ */
public const DPD_POLAND = 'DPD_POLAND';
+ /**
+ * PostNL International.
+ */
public const NLD_POSTNL = 'NLD_POSTNL';
+ /**
+ * Nim Express.
+ */
public const NIM_EXPRESS = 'NIM_EXPRESS';
+ /**
+ * Quantium.
+ */
public const QUANTIUM = 'QUANTIUM';
+ /**
+ * Sendle.
+ */
public const SENDLE = 'SENDLE';
+ /**
+ * Redur Spain.
+ */
public const ESP_REDUR = 'ESP_REDUR';
+ /**
+ * Matkahuolto.
+ */
public const MATKAHUOLTO = 'MATKAHUOLTO';
+ /**
+ * Cpacket couriers.
+ */
public const CPACKET = 'CPACKET';
+ /**
+ * Posti courier.
+ */
public const POSTI = 'POSTI';
+ /**
+ * Hunter Express.
+ */
public const HUNTER_EXPRESS = 'HUNTER_EXPRESS';
+ /**
+ * Choir Express Indonesia.
+ */
public const CHOIR_EXP = 'CHOIR_EXP';
+ /**
+ * Legion Express.
+ */
public const LEGION_EXPRESS = 'LEGION_EXPRESS';
+ /**
+ * austrian post.
+ */
public const AUSTRIAN_POST_EXPRESS = 'AUSTRIAN_POST_EXPRESS';
+ /**
+ * Grupo ampm.
+ */
public const GRUPO = 'GRUPO';
+ /**
+ * Post Roman (www.posta-romana.ro).
+ */
public const POSTA_RO = 'POSTA_RO';
+ /**
+ * Interparcel UK.
+ */
public const INTERPARCEL_UK = 'INTERPARCEL_UK';
+ /**
+ * ABF Freight.
+ */
public const GLOBAL_ABF = 'GLOBAL_ABF';
+ /**
+ * Posten Norge (www.posten.no).
+ */
public const POSTEN_NORGE = 'POSTEN_NORGE';
+ /**
+ * Xpert Delivery.
+ */
public const XPERT_DELIVERY = 'XPERT_DELIVERY';
+ /**
+ * DHl (Reference number).
+ */
public const DHL_REFR = 'DHL_REFR';
+ /**
+ * DHL HonKong.
+ */
public const DHL_HK = 'DHL_HK';
+ /**
+ * SKYNET UAE.
+ */
public const SKYNET_UAE = 'SKYNET_UAE';
+ /**
+ * Gojek.
+ */
public const GOJEK = 'GOJEK';
+ /**
+ * Yodel International.
+ */
public const YODEL_INTNL = 'YODEL_INTNL';
+ /**
+ * Janco Ecommerce.
+ */
public const JANCO = 'JANCO';
+ /**
+ * YTO Express.
+ */
public const YTO = 'YTO';
+ /**
+ * Wise Express.
+ */
public const WISE_EXPRESS = 'WISE_EXPRESS';
+ /**
+ * J&T Express Vietnam.
+ */
public const JTEXPRESS_VN = 'JTEXPRESS_VN';
+ /**
+ * FedEx International MailService.
+ */
public const FEDEX_INTL_MLSERV = 'FEDEX_INTL_MLSERV';
+ /**
+ * VAMOX.
+ */
public const VAMOX = 'VAMOX';
+ /**
+ * AMS Group.
+ */
public const AMS_GRP = 'AMS_GRP';
+ /**
+ * DHL Japan.
+ */
public const DHL_JP = 'DHL_JP';
+ /**
+ * HR Parcel.
+ */
public const HRPARCEL = 'HRPARCEL';
+ /**
+ * GESWL Express.
+ */
public const GESWL = 'GESWL';
+ /**
+ * Blue Star.
+ */
public const BLUESTAR = 'BLUESTAR';
+ /**
+ * CDEK TR.
+ */
public const CDEK_TR = 'CDEK_TR';
+ /**
+ * Innovel courier.
+ */
public const DESCARTES = 'DESCARTES';
+ /**
+ * Deltec Courier.
+ */
public const DELTEC_UK = 'DELTEC_UK';
+ /**
+ * DTDC express.
+ */
public const DTDC_EXPRESS = 'DTDC_EXPRESS';
+ /**
+ * tourline.
+ */
public const TOURLINE = 'TOURLINE';
+ /**
+ * B&H Worldwide.
+ */
public const BH_WORLDWIDE = 'BH_WORLDWIDE';
+ /**
+ * OCS ANA Group.
+ */
public const OCS = 'OCS';
+ /**
+ * yingnuo logistics.
+ */
public const YINGNUO_LOGISTICS = 'YINGNUO_LOGISTICS';
+ /**
+ * United Parcel Service.
+ */
public const UPS = 'UPS';
+ /**
+ * Toll IPEC.
+ */
public const TOLL = 'TOLL';
+ /**
+ * SEUR portugal.
+ */
public const PRT_SEUR = 'PRT_SEUR';
+ /**
+ * DTDC Australia.
+ */
public const DTDC_AU = 'DTDC_AU';
+ /**
+ * Dynamic Logistics.
+ */
public const THA_DYNAMIC_LOGISTICS = 'THA_DYNAMIC_LOGISTICS';
+ /**
+ * UBI Smart Parcel.
+ */
public const UBI_LOGISTICS = 'UBI_LOGISTICS';
+ /**
+ * FedEx Cross Border.
+ */
public const FEDEX_CROSSBORDER = 'FEDEX_CROSSBORDER';
+ /**
+ * A1Post.
+ */
public const A1POST = 'A1POST';
+ /**
+ * Tazmanian Freight Systems.
+ */
public const TAZMANIAN_FREIGHT = 'TAZMANIAN_FREIGHT';
+ /**
+ * CJ International malaysia.
+ */
public const CJ_INT_MY = 'CJ_INT_MY';
+ /**
+ * Saia LTL Freight.
+ */
public const SAIA_FREIGHT = 'SAIA_FREIGHT';
+ /**
+ * Qxpress.
+ */
public const SG_QXPRESS = 'SG_QXPRESS';
+ /**
+ * Nhans Solutions.
+ */
public const NHANS_SOLUTIONS = 'NHANS_SOLUTIONS';
+ /**
+ * DPD France.
+ */
public const DPD_FR = 'DPD_FR';
+ /**
+ * Coordinadora.
+ */
public const COORDINADORA = 'COORDINADORA';
+ /**
+ * Grupo logistico Andreani.
+ */
public const ANDREANI = 'ANDREANI';
+ /**
+ * Doora Logistics.
+ */
public const DOORA = 'DOORA';
+ /**
+ * Interparcel New Zealand.
+ */
public const INTERPARCEL_NZ = 'INTERPARCEL_NZ';
+ /**
+ * Jam Express Philippines.
+ */
public const PHL_JAMEXPRESS = 'PHL_JAMEXPRESS';
+ /**
+ * bel_belgium_post.
+ */
public const BEL_BELGIUM_POST = 'BEL_BELGIUM_POST';
+ /**
+ * us_apc.
+ */
public const US_APC = 'US_APC';
+ /**
+ * idn_pos.
+ */
public const IDN_POS = 'IDN_POS';
+ /**
+ * fr_mondial.
+ */
public const FR_MONDIAL = 'FR_MONDIAL';
+ /**
+ * DE DHL.
+ */
public const DE_DHL = 'DE_DHL';
+ /**
+ * hk_rpx.
+ */
public const HK_RPX = 'HK_RPX';
+ /**
+ * dhl_pieceid.
+ */
public const DHL_PIECEID = 'DHL_PIECEID';
+ /**
+ * vnpost_ems.
+ */
public const VNPOST_EMS = 'VNPOST_EMS';
+ /**
+ * rrdonnelley.
+ */
public const RRDONNELLEY = 'RRDONNELLEY';
+ /**
+ * dpd_de.
+ */
public const DPD_DE = 'DPD_DE';
+ /**
+ * delcart_in.
+ */
public const DELCART_IN = 'DELCART_IN';
+ /**
+ * imexglobalsolutions.
+ */
public const IMEXGLOBALSOLUTIONS = 'IMEXGLOBALSOLUTIONS';
+ /**
+ * ACOMMERCE.
+ */
public const ACOMMERCE = 'ACOMMERCE';
+ /**
+ * eurodis.
+ */
public const EURODIS = 'EURODIS';
+ /**
+ * CANPAR.
+ */
public const CANPAR = 'CANPAR';
+ /**
+ * GLS.
+ */
public const GLS = 'GLS';
+ /**
+ * Ecom Express.
+ */
public const IND_ECOM = 'IND_ECOM';
+ /**
+ * Envialia.
+ */
public const ESP_ENVIALIA = 'ESP_ENVIALIA';
+ /**
+ * dhl UK.
+ */
public const DHL_UK = 'DHL_UK';
+ /**
+ * SMSA Express.
+ */
public const SMSA_EXPRESS = 'SMSA_EXPRESS';
+ /**
+ * TNT France.
+ */
public const TNT_FR = 'TNT_FR';
+ /**
+ * DEX-I courier.
+ */
public const DEX_I = 'DEX_I';
+ /**
+ * Budbee courier.
+ */
public const BUDBEE_WEBHOOK = 'BUDBEE_WEBHOOK';
+ /**
+ * Copa Airlines Courier.
+ */
public const COPA_COURIER = 'COPA_COURIER';
+ /**
+ * Vietnam Post.
+ */
public const VNM_VIETNAM_POST = 'VNM_VIETNAM_POST';
+ /**
+ * DPD HongKong.
+ */
public const DPD_HK = 'DPD_HK';
+ /**
+ * Toll New Zealand.
+ */
public const TOLL_NZ = 'TOLL_NZ';
+ /**
+ * Echo courier.
+ */
public const ECHO_ = 'ECHO';
+ /**
+ * FedEx® Freight.
+ */
public const FEDEX_FR = 'FEDEX_FR';
+ /**
+ * Border Express.
+ */
public const BORDEREXPRESS = 'BORDEREXPRESS';
+ /**
+ * MailPlus (Japan).
+ */
public const MAILPLUS_JPN = 'MAILPLUS_JPN';
+ /**
+ * TNT UK Reference.
+ */
public const TNT_UK_REFR = 'TNT_UK_REFR';
+ /**
+ * KEC courier.
+ */
public const KEC = 'KEC';
+ /**
+ * DPD Romania.
+ */
public const DPD_RO = 'DPD_RO';
+ /**
+ * TNT_JP.
+ */
public const TNT_JP = 'TNT_JP';
+ /**
+ * TH_CJ.
+ */
public const TH_CJ = 'TH_CJ';
+ /**
+ * EC_CN.
+ */
public const EC_CN = 'EC_CN';
+ /**
+ * FASTWAY_UK.
+ */
public const FASTWAY_UK = 'FASTWAY_UK';
+ /**
+ * FASTWAY_US.
+ */
public const FASTWAY_US = 'FASTWAY_US';
+ /**
+ * GLS_DE.
+ */
public const GLS_DE = 'GLS_DE';
+ /**
+ * GLS_ES.
+ */
public const GLS_ES = 'GLS_ES';
+ /**
+ * GLS_FR.
+ */
public const GLS_FR = 'GLS_FR';
+ /**
+ * MONDIAL_BE.
+ */
public const MONDIAL_BE = 'MONDIAL_BE';
+ /**
+ * SGT_IT.
+ */
public const SGT_IT = 'SGT_IT';
+ /**
+ * TNT_CN.
+ */
public const TNT_CN = 'TNT_CN';
+ /**
+ * TNT_DE.
+ */
public const TNT_DE = 'TNT_DE';
+ /**
+ * TNT_ES.
+ */
public const TNT_ES = 'TNT_ES';
+ /**
+ * TNT_PL.
+ */
public const TNT_PL = 'TNT_PL';
+ /**
+ * PARCELFORCE.
+ */
public const PARCELFORCE = 'PARCELFORCE';
+ /**
+ * SWISS POST.
+ */
public const SWISS_POST = 'SWISS_POST';
+ /**
+ * TOLL IPEC.
+ */
public const TOLL_IPEC = 'TOLL_IPEC';
+ /**
+ * AIR 21.
+ */
public const AIR_21 = 'AIR_21';
+ /**
+ * AIRSPEED.
+ */
public const AIRSPEED = 'AIRSPEED';
+ /**
+ * BERT.
+ */
public const BERT = 'BERT';
+ /**
+ * BLUEDART.
+ */
public const BLUEDART = 'BLUEDART';
+ /**
+ * COLLECTPLUS.
+ */
public const COLLECTPLUS = 'COLLECTPLUS';
+ /**
+ * COURIERPLUS.
+ */
public const COURIERPLUS = 'COURIERPLUS';
+ /**
+ * COURIER POST.
+ */
public const COURIER_POST = 'COURIER_POST';
+ /**
+ * dhl_global_mail.
+ */
public const DHL_GLOBAL_MAIL = 'DHL_GLOBAL_MAIL';
+ /**
+ * dpd_uk.
+ */
public const DPD_UK = 'DPD_UK';
+ /**
+ * DELTEC DE.
+ */
public const DELTEC_DE = 'DELTEC_DE';
+ /**
+ * deutsche_de.
+ */
public const DEUTSCHE_DE = 'DEUTSCHE_DE';
+ /**
+ * DOTZOT.
+ */
public const DOTZOT = 'DOTZOT';
+ /**
+ * elta_gr.
+ */
public const ELTA_GR = 'ELTA_GR';
+ /**
+ * ems_cn.
+ */
public const EMS_CN = 'EMS_CN';
+ /**
+ * ECARGO.
+ */
public const ECARGO = 'ECARGO';
+ /**
+ * ENSENDA.
+ */
public const ENSENDA = 'ENSENDA';
+ /**
+ * fercam_it.
+ */
public const FERCAM_IT = 'FERCAM_IT';
+ /**
+ * fastway_za.
+ */
public const FASTWAY_ZA = 'FASTWAY_ZA';
+ /**
+ * fastway_au.
+ */
public const FASTWAY_AU = 'FASTWAY_AU';
+ /**
+ * first_logisitcs.
+ */
public const FIRST_LOGISITCS = 'FIRST_LOGISITCS';
+ /**
+ * GEODIS.
+ */
public const GEODIS = 'GEODIS';
+ /**
+ * GLOBEGISTICS.
+ */
public const GLOBEGISTICS = 'GLOBEGISTICS';
+ /**
+ * GREYHOUND.
+ */
public const GREYHOUND = 'GREYHOUND';
+ /**
+ * jetship_my.
+ */
public const JETSHIP_MY = 'JETSHIP_MY';
+ /**
+ * LION PARCEL.
+ */
public const LION_PARCEL = 'LION_PARCEL';
+ /**
+ * AEROFLASH.
+ */
public const AEROFLASH = 'AEROFLASH';
+ /**
+ * ONTRAC.
+ */
public const ONTRAC = 'ONTRAC';
+ /**
+ * SAGAWA.
+ */
public const SAGAWA = 'SAGAWA';
+ /**
+ * SIODEMKA.
+ */
public const SIODEMKA = 'SIODEMKA';
+ /**
+ * startrack.
+ */
public const STARTRACK = 'STARTRACK';
+ /**
+ * tnt_au.
+ */
public const TNT_AU = 'TNT_AU';
+ /**
+ * tnt_it.
+ */
public const TNT_IT = 'TNT_IT';
+ /**
+ * TRANSMISSION.
+ */
public const TRANSMISSION = 'TRANSMISSION';
+ /**
+ * YAMATO.
+ */
public const YAMATO = 'YAMATO';
+ /**
+ * dhl_it.
+ */
public const DHL_IT = 'DHL_IT';
+ /**
+ * dhl_at.
+ */
public const DHL_AT = 'DHL_AT';
+ /**
+ * LOGISTICSWORLDWIDE KR.
+ */
public const LOGISTICSWORLDWIDE_KR = 'LOGISTICSWORLDWIDE_KR';
+ /**
+ * gls_spain.
+ */
public const GLS_SPAIN = 'GLS_SPAIN';
+ /**
+ * amazon_uk_api.
+ */
public const AMAZON_UK_API = 'AMAZON_UK_API';
+ /**
+ * dpd_fr_reference.
+ */
public const DPD_FR_REFERENCE = 'DPD_FR_REFERENCE';
+ /**
+ * dhlparcel_uk.
+ */
public const DHLPARCEL_UK = 'DHLPARCEL_UK';
+ /**
+ * megasave.
+ */
public const MEGASAVE = 'MEGASAVE';
+ /**
+ * qualitypost.
+ */
public const QUALITYPOST = 'QUALITYPOST';
+ /**
+ * ids_logistics.
+ */
public const IDS_LOGISTICS = 'IDS_LOGISTICS';
+ /**
+ * joyingbox.
+ */
public const JOYINGBOX1 = 'JOYINGBOX';
+ /**
+ * panther_order_number.
+ */
public const PANTHER_ORDER_NUMBER = 'PANTHER_ORDER_NUMBER';
+ /**
+ * watkins_shepard.
+ */
public const WATKINS_SHEPARD = 'WATKINS_SHEPARD';
+ /**
+ * fasttrack.
+ */
public const FASTTRACK = 'FASTTRACK';
+ /**
+ * up_express.
+ */
public const UP_EXPRESS = 'UP_EXPRESS';
+ /**
+ * elogistica.
+ */
public const ELOGISTICA = 'ELOGISTICA';
+ /**
+ * ecourier.
+ */
public const ECOURIER = 'ECOURIER';
+ /**
+ * cj_philippines.
+ */
public const CJ_PHILIPPINES = 'CJ_PHILIPPINES';
+ /**
+ * speedex.
+ */
public const SPEEDEX = 'SPEEDEX';
+ /**
+ * orangeconnex.
+ */
public const ORANGECONNEX = 'ORANGECONNEX';
+ /**
+ * tecor.
+ */
public const TECOR = 'TECOR';
+ /**
+ * saee.
+ */
public const SAEE = 'SAEE';
+ /**
+ * gls_italy_ftp.
+ */
public const GLS_ITALY_FTP = 'GLS_ITALY_FTP';
+ /**
+ * delivere.
+ */
public const DELIVERE = 'DELIVERE';
+ /**
+ * yycom.
+ */
public const YYCOM = 'YYCOM';
+ /**
+ * Adicional Logistics.
+ */
public const ADICIONAL_PT = 'ADICIONAL_PT';
+ /**
+ * DKSH.
+ */
public const DKSH = 'DKSH';
+ /**
+ * Nippon Express.
+ */
public const NIPPON_EXPRESS_FTP = 'NIPPON_EXPRESS_FTP';
+ /**
+ * GO Logistics & Storage.
+ */
public const GOLS = 'GOLS';
+ /**
+ * FUJIE EXPRESS.
+ */
public const FUJEXP = 'FUJEXP';
+ /**
+ * QTrack.
+ */
public const QTRACK = 'QTRACK';
+ /**
+ * OM LOGISTICS LTD.
+ */
public const OMLOGISTICS_API = 'OMLOGISTICS_API';
+ /**
+ * GDPharm Logistics.
+ */
public const GDPHARM = 'GDPHARM';
+ /**
+ * MISUMI Group Inc..
+ */
public const MISUMI_CN = 'MISUMI_CN';
+ /**
+ * Rivo.
+ */
public const AIR_CANADA = 'AIR_CANADA';
+ /**
+ * City Express.
+ */
public const CITY56_WEBHOOK = 'CITY56_WEBHOOK';
+ /**
+ * Sagawa.
+ */
public const SAGAWA_API = 'SAGAWA_API';
+ /**
+ * KedaEX.
+ */
public const KEDAEX = 'KEDAEX';
+ /**
+ * Pgeon.
+ */
public const PGEON_API = 'PGEON_API';
+ /**
+ * We World Express.
+ */
public const WEWORLDEXPRESS = 'WEWORLDEXPRESS';
+ /**
+ * J&T International logistics.
+ */
public const JT_LOGISTICS = 'JT_LOGISTICS';
+ /**
+ * Trusk France.
+ */
public const TRUSK = 'TRUSK';
+ /**
+ * ViaXpress.
+ */
public const VIAXPRESS = 'VIAXPRESS';
+ /**
+ * DHL Supply Chain Indonesia.
+ */
public const DHL_SUPPLYCHAIN_ID = 'DHL_SUPPLYCHAIN_ID';
+ /**
+ * Zuellig Pharma Korea.
+ */
public const ZUELLIGPHARMA_SFTP = 'ZUELLIGPHARMA_SFTP';
+ /**
+ * Meest.
+ */
public const MEEST = 'MEEST';
+ /**
+ * Toll Priority.
+ */
public const TOLL_PRIORITY = 'TOLL_PRIORITY';
+ /**
+ * Mothership.
+ */
public const MOTHERSHIP_API = 'MOTHERSHIP_API';
+ /**
+ * Capital Transport.
+ */
public const CAPITAL = 'CAPITAL';
+ /**
+ * Europacket+.
+ */
public const EUROPAKET_API = 'EUROPAKET_API';
+ /**
+ * HFD.
+ */
public const HFD = 'HFD';
+ /**
+ * Tourline Express.
+ */
public const TOURLINE_REFERENCE = 'TOURLINE_REFERENCE';
+ /**
+ * GIO Express Inc.
+ */
public const GIO_ECOURIER = 'GIO_ECOURIER';
+ /**
+ * CN Logistics.
+ */
public const CN_LOGISTICS = 'CN_LOGISTICS';
+ /**
+ * Pandion.
+ */
public const PANDION = 'PANDION';
+ /**
+ * Bpost API.
+ */
public const BPOST_API = 'BPOST_API';
+ /**
+ * Passport Shipping.
+ */
public const PASSPORTSHIPPING = 'PASSPORTSHIPPING';
+ /**
+ * Pakajo World.
+ */
public const PAKAJO = 'PAKAJO';
+ /**
+ * DACHSER.
+ */
public const DACHSER = 'DACHSER';
+ /**
+ * Yusen Logistics.
+ */
public const YUSEN_SFTP = 'YUSEN_SFTP';
+ /**
+ * Shypmax.
+ */
public const SHYPLITE = 'SHYPLITE';
+ /**
+ * Xingyunyi Logistics.
+ */
public const XYY = 'XYY';
+ /**
+ * Metropolitan Warehouse & Delivery.
+ */
public const MWD = 'MWD';
+ /**
+ * Faxe Cargo.
+ */
public const FAXECARGO = 'FAXECARGO';
+ /**
+ * Groupe Mazet.
+ */
public const MAZET = 'MAZET';
+ /**
+ * First Logistics.
+ */
public const FIRST_LOGISTICS_API = 'FIRST_LOGISTICS_API';
+ /**
+ * SPRINT PACK.
+ */
public const SPRINT_PACK = 'SPRINT_PACK';
+ /**
+ * Hermes Germany.
+ */
public const HERMES_DE_FTP = 'HERMES_DE_FTP';
+ /**
+ * Concise.
+ */
public const CONCISE = 'CONCISE';
+ /**
+ * Kerry Express TaiWan.
+ */
public const KERRY_EXPRESS_TW_API = 'KERRY_EXPRESS_TW_API';
+ /**
+ * EWE Global Express.
+ */
public const EWE = 'EWE';
+ /**
+ * Fast Despatch Logistics Limited.
+ */
public const FASTDESPATCH = 'FASTDESPATCH';
+ /**
+ * AB Custom Group.
+ */
public const ABCUSTOM_SFTP = 'ABCUSTOM_SFTP';
+ /**
+ * Chazki.
+ */
public const CHAZKI = 'CHAZKI';
+ /**
+ * Shippie.
+ */
public const SHIPPIE = 'SHIPPIE';
+ /**
+ * GEODIS - Distribution & Express.
+ */
public const GEODIS_API = 'GEODIS_API';
+ /**
+ * Naqel Express.
+ */
public const NAQEL_EXPRESS = 'NAQEL_EXPRESS';
+ /**
+ * Papa.
+ */
public const PAPA_WEBHOOK = 'PAPA_WEBHOOK';
+ /**
+ * Forward Air.
+ */
public const FORWARDAIR = 'FORWARDAIR';
+ /**
+ * Dialogo Logistica.
+ */
public const DIALOGO_LOGISTICA_API = 'DIALOGO_LOGISTICA_API';
+ /**
+ * Lalamove.
+ */
public const LALAMOVE_API = 'LALAMOVE_API';
+ /**
+ * Tomydoor.
+ */
public const TOMYDOOR = 'TOMYDOOR';
+ /**
+ * Kronos Express.
+ */
public const KRONOS_WEBHOOK = 'KRONOS_WEBHOOK';
+ /**
+ * J&T CARGO.
+ */
public const JTCARGO = 'JTCARGO';
+ /**
+ * T-cat.
+ */
public const T_CAT = 'T_CAT';
+ /**
+ * Concise.
+ */
public const CONCISE_WEBHOOK = 'CONCISE_WEBHOOK';
+ /**
+ * Teleport.
+ */
public const TELEPORT_WEBHOOK = 'TELEPORT_WEBHOOK';
+ /**
+ * The Custom Companies.
+ */
public const CUSTOMCO_API = 'CUSTOMCO_API';
+ /**
+ * Shopee Xpress.
+ */
public const SPX_TH = 'SPX_TH';
+ /**
+ * Bollore Logistics.
+ */
public const BOLLORE_LOGISTICS = 'BOLLORE_LOGISTICS';
+ /**
+ * ClickLink.
+ */
public const CLICKLINK_SFTP = 'CLICKLINK_SFTP';
+ /**
+ * M3 Logistics.
+ */
public const M3LOGISTICS = 'M3LOGISTICS';
+ /**
+ * Vietnam Post.
+ */
public const VNPOST_API = 'VNPOST_API';
+ /**
+ * Axlehire.
+ */
public const AXLEHIRE_FTP = 'AXLEHIRE_FTP';
+ /**
+ * Shadowfax.
+ */
public const SHADOWFAX = 'SHADOWFAX';
+ /**
+ * EVRi.
+ */
public const MYHERMES_UK_API = 'MYHERMES_UK_API';
+ /**
+ * Daiichi Freight System Inc.
+ */
public const DAIICHI = 'DAIICHI';
+ /**
+ * Mensajeros Urbanos.
+ */
public const MENSAJEROSURBANOS_API = 'MENSAJEROSURBANOS_API';
+ /**
+ * PolarSpeed Inc.
+ */
public const POLARSPEED = 'POLARSPEED';
+ /**
+ * iDexpress Indonesia.
+ */
public const IDEXPRESS_ID = 'IDEXPRESS_ID';
+ /**
+ * Payo.
+ */
public const PAYO = 'PAYO';
+ /**
+ * Whistl.
+ */
public const WHISTL_SFTP = 'WHISTL_SFTP';
+ /**
+ * INTEX Paketdienst GmbH.
+ */
public const INTEX_DE = 'INTEX_DE';
+ /**
+ * Trans2u.
+ */
public const TRANS2U = 'TRANS2U';
+ /**
+ * Product Care Services Limited.
+ */
public const PRODUCTCAREGROUP_SFTP = 'PRODUCTCAREGROUP_SFTP';
+ /**
+ * Big Smart.
+ */
public const BIGSMART = 'BIGSMART';
+ /**
+ * Expeditors API Reference.
+ */
public const EXPEDITORS_API_REF = 'EXPEDITORS_API_REF';
+ /**
+ * AIT.
+ */
public const AITWORLDWIDE_API = 'AITWORLDWIDE_API';
+ /**
+ * World Courier.
+ */
public const WORLDCOURIER = 'WORLDCOURIER';
+ /**
+ * Quiqup.
+ */
public const QUIQUP = 'QUIQUP';
+ /**
+ * Agediss.
+ */
public const AGEDISS_SFTP = 'AGEDISS_SFTP';
+ /**
+ * Andreani.
+ */
public const ANDREANI_API = 'ANDREANI_API';
+ /**
+ * CRL Express.
+ */
public const CRLEXPRESS = 'CRLEXPRESS';
+ /**
+ * SMARTCAT.
+ */
public const SMARTCAT = 'SMARTCAT';
+ /**
+ * Crossflight Limited.
+ */
public const CROSSFLIGHT = 'CROSSFLIGHT';
+ /**
+ * Pro Carrier.
+ */
public const PROCARRIER = 'PROCARRIER';
+ /**
+ * DHL (Reference number).
+ */
public const DHL_REFERENCE_API = 'DHL_REFERENCE_API';
+ /**
+ * Seino.
+ */
public const SEINO_API = 'SEINO_API';
+ /**
+ * WSP Express.
+ */
public const WSPEXPRESS = 'WSPEXPRESS';
+ /**
+ * Kronos Express.
+ */
public const KRONOS = 'KRONOS';
+ /**
+ * Total Express.
+ */
public const TOTAL_EXPRESS_API = 'TOTAL_EXPRESS_API';
+ /**
+ * PARCLL.
+ */
public const PARCLL = 'PARCLL';
+ /**
+ * Xpedigo.
+ */
public const XPEDIGO = 'XPEDIGO';
+ /**
+ * StarTrack.
+ */
public const STAR_TRACK_WEBHOOK = 'STAR_TRACK_WEBHOOK';
+ /**
+ * Georgian Post.
+ */
public const GPOST = 'GPOST';
+ /**
+ * UCS.
+ */
public const UCS = 'UCS';
+ /**
+ * DMF.
+ */
public const DMFGROUP = 'DMFGROUP';
+ /**
+ * Coordinadora.
+ */
public const COORDINADORA_API = 'COORDINADORA_API';
+ /**
+ * Marken.
+ */
public const MARKEN = 'MARKEN';
+ /**
+ * NTL logistics.
+ */
public const NTL = 'NTL';
+ /**
+ * Red je Pakketje.
+ */
public const REDJEPAKKETJE = 'REDJEPAKKETJE';
+ /**
+ * Allied Express (FTP).
+ */
public const ALLIED_EXPRESS_FTP = 'ALLIED_EXPRESS_FTP';
+ /**
+ * Mondial Relay Spain(Punto Pack).
+ */
public const MONDIALRELAY_ES = 'MONDIALRELAY_ES';
+ /**
+ * Naeko Logistics.
+ */
public const NAEKO_FTP = 'NAEKO_FTP';
+ /**
+ * Mhi.
+ */
public const MHI = 'MHI';
+ /**
+ * Shippify, Inc.
+ */
public const SHIPPIFY = 'SHIPPIFY';
+ /**
+ * Malca Amit.
+ */
public const MALCA_AMIT_API = 'MALCA_AMIT_API';
+ /**
+ * J&T Express Singapore.
+ */
public const JTEXPRESS_SG_API = 'JTEXPRESS_SG_API';
+ /**
+ * DACHSER.
+ */
public const DACHSER_WEB = 'DACHSER_WEB';
+ /**
+ * Flight Logistics Group.
+ */
public const FLIGHTLG = 'FLIGHTLG';
+ /**
+ * Cago.
+ */
public const CAGO = 'CAGO';
+ /**
+ * ComOne Express.
+ */
public const COM1EXPRESS = 'COM1EXPRESS';
+ /**
+ * Tonami.
+ */
public const TONAMI_FTP = 'TONAMI_FTP';
+ /**
+ * PACKFLEET.
+ */
public const PACKFLEET = 'PACKFLEET';
+ /**
+ * Purolator International.
+ */
public const PUROLATOR_INTERNATIONAL = 'PUROLATOR_INTERNATIONAL';
+ /**
+ * Wineshipping.
+ */
public const WINESHIPPING_WEBHOOK = 'WINESHIPPING_WEBHOOK';
+ /**
+ * DHL Spain Domestic.
+ */
public const DHL_ES_SFTP = 'DHL_ES_SFTP';
+ /**
+ * 網家速配股份有限公司.
+ */
public const PCHOME_API = 'PCHOME_API';
+ /**
+ * Czech Post.
+ */
public const CESKAPOSTA_API = 'CESKAPOSTA_API';
+ /**
+ * Go Rush.
+ */
public const GORUSH = 'GORUSH';
+ /**
+ * HomeRunner.
+ */
public const HOMERUNNER = 'HOMERUNNER';
+ /**
+ * Amazon order.
+ */
public const AMAZON_ORDER = 'AMAZON_ORDER';
+ /**
+ * Estes Forwarding Worldwide.
+ */
public const EFWNOW_API = 'EFWNOW_API';
+ /**
+ * CBL Logistica (API).
+ */
public const CBL_LOGISTICA_API = 'CBL_LOGISTICA_API';
+ /**
+ * NimbusPost.
+ */
public const NIMBUSPOST = 'NIMBUSPOST';
+ /**
+ * Logwin Logistics.
+ */
public const LOGWIN_LOGISTICS = 'LOGWIN_LOGISTICS';
+ /**
+ * Sequoialog.
+ */
public const NOWLOG_API = 'NOWLOG_API';
+ /**
+ * DPD Netherlands.
+ */
public const DPD_NL = 'DPD_NL';
+ /**
+ * Dependable Supply Chain Services.
+ */
public const GODEPENDABLE = 'GODEPENDABLE';
+ /**
+ * Top Ideal Express.
+ */
public const ESDEX = 'ESDEX';
+ /**
+ * Kiitäjät.
+ */
public const LOGISYSTEMS_SFTP = 'LOGISYSTEMS_SFTP';
+ /**
+ * Expeditors.
+ */
public const EXPEDITORS = 'EXPEDITORS';
+ /**
+ * Snt Global Etrax.
+ */
public const SNTGLOBAL_API = 'SNTGLOBAL_API';
+ /**
+ * ShipX.
+ */
public const SHIPX = 'SHIPX';
+ /**
+ * Quickstat Courier LLC.
+ */
public const QINTL_API = 'QINTL_API';
+ /**
+ * Packs.
+ */
public const PACKS = 'PACKS';
+ /**
+ * PostNL International.
+ */
public const POSTNL_INTERNATIONAL = 'POSTNL_INTERNATIONAL';
+ /**
+ * Amazon.
+ */
public const AMAZON_EMAIL_PUSH = 'AMAZON_EMAIL_PUSH';
+ /**
+ * DHL.
+ */
public const DHL_API = 'DHL_API';
+ /**
+ * Shopee Express.
+ */
public const SPX = 'SPX';
+ /**
+ * AxleHire.
+ */
public const AXLEHIRE = 'AXLEHIRE';
+ /**
+ * ICS COURIER.
+ */
public const ICSCOURIER = 'ICSCOURIER';
+ /**
+ * Dialogo Logistica.
+ */
public const DIALOGO_LOGISTICA = 'DIALOGO_LOGISTICA';
+ /**
+ * ShunBang Express.
+ */
public const SHUNBANG_EXPRESS = 'SHUNBANG_EXPRESS';
+ /**
+ * TCS.
+ */
public const TCS_API = 'TCS_API';
+ /**
+ * SF Express China.
+ */
public const SF_EXPRESS_CN = 'SF_EXPRESS_CN';
+ /**
+ * Packeta.
+ */
public const PACKETA = 'PACKETA';
+ /**
+ * Teliway SIC Express.
+ */
public const SIC_TELIWAY = 'SIC_TELIWAY';
+ /**
+ * Mondial Relay France.
+ */
public const MONDIALRELAY_FR = 'MONDIALRELAY_FR';
+ /**
+ * InTime.
+ */
public const INTIME_FTP = 'INTIME_FTP';
+ /**
+ * 京东物流.
+ */
public const JD_EXPRESS = 'JD_EXPRESS';
+ /**
+ * Fastbox.
+ */
public const FASTBOX = 'FASTBOX';
+ /**
+ * Patheon Logistics.
+ */
public const PATHEON = 'PATHEON';
+ /**
+ * India Post Domestic.
+ */
public const INDIA_POST = 'INDIA_POST';
+ /**
+ * Tipsa Reference.
+ */
public const TIPSA_REF = 'TIPSA_REF';
+ /**
+ * Eco Freight.
+ */
public const ECOFREIGHT = 'ECOFREIGHT';
+ /**
+ * VOX SOLUCION EMPRESARIAL SRL.
+ */
public const VOX = 'VOX';
+ /**
+ * Direct Freight Express.
+ */
public const DIRECTFREIGHT_AU_REF = 'DIRECTFREIGHT_AU_REF';
+ /**
+ * Best Transport.
+ */
public const BESTTRANSPORT_SFTP = 'BESTTRANSPORT_SFTP';
+ /**
+ * Australia Post.
+ */
public const AUSTRALIA_POST_API = 'AUSTRALIA_POST_API';
+ /**
+ * FragilePAK.
+ */
public const FRAGILEPAK_SFTP = 'FRAGILEPAK_SFTP';
+ /**
+ * FlipXpress.
+ */
public const FLIPXP = 'FLIPXP';
+ /**
+ * Value Logistics.
+ */
public const VALUE_WEBHOOK = 'VALUE_WEBHOOK';
+ /**
+ * Daeshin.
+ */
public const DAESHIN = 'DAESHIN';
+ /**
+ * Sherpa.
+ */
public const SHERPA = 'SHERPA';
+ /**
+ * Metropolitan Warehouse & Delivery.
+ */
public const MWD_API = 'MWD_API';
+ /**
+ * SmartKargo.
+ */
public const SMARTKARGO = 'SMARTKARGO';
+ /**
+ * DNJ Express.
+ */
public const DNJ_EXPRESS = 'DNJ_EXPRESS';
+ /**
+ * Go People.
+ */
public const GOPEOPLE = 'GOPEOPLE';
+ /**
+ * mySendle.
+ */
public const MYSENDLE_API = 'MYSENDLE_API';
+ /**
+ * Aramex.
+ */
public const ARAMEX_API = 'ARAMEX_API';
+ /**
+ * Pidge.
+ */
public const PIDGE = 'PIDGE';
+ /**
+ * TP Logistic.
+ */
public const THAIPARCELS = 'THAIPARCELS';
+ /**
+ * Panther Reference.
+ */
public const PANTHER_REFERENCE_API = 'PANTHER_REFERENCE_API';
+ /**
+ * Posta Plus.
+ */
public const POSTAPLUS1 = 'POSTAPLUS';
+ /**
+ * BUFFALO.
+ */
public const BUFFALO = 'BUFFALO';
+ /**
+ * U-ENVIOS.
+ */
public const U_ENVIOS = 'U_ENVIOS';
+ /**
+ * Elite Express.
+ */
public const ELITE_CO = 'ELITE_CO';
- public const BARQEXP = 'BARQEXP';
-
+ /**
+ * Roche Internal Courier.
+ */
public const ROCHE_INTERNAL_SFTP = 'ROCHE_INTERNAL_SFTP';
+ /**
+ * DB Schenker Iceland.
+ */
public const DBSCHENKER_ICELAND = 'DBSCHENKER_ICELAND';
+ /**
+ * TNT France Reference.
+ */
public const TNT_FR_REFERENCE = 'TNT_FR_REFERENCE';
+ /**
+ * Newgistics API.
+ */
public const NEWGISTICSAPI = 'NEWGISTICSAPI';
+ /**
+ * Glovo.
+ */
public const GLOVO = 'GLOVO';
+ /**
+ * G.I.G.
+ */
public const GWLOGIS_API = 'GWLOGIS_API';
+ /**
+ * Spreetail.
+ */
public const SPREETAIL_API = 'SPREETAIL_API';
+ /**
+ * Moova.
+ */
public const MOOVA = 'MOOVA';
+ /**
+ * Plycon Transportation Group.
+ */
public const PLYCONGROUP = 'PLYCONGROUP';
+ /**
+ * USPS Informed Visibility - Webhook.
+ */
public const USPS_WEBHOOK = 'USPS_WEBHOOK';
+ /**
+ * maergo.
+ */
public const REIMAGINEDELIVERY = 'REIMAGINEDELIVERY';
+ /**
+ * Eurodifarm.
+ */
public const EDF_FTP = 'EDF_FTP';
+ /**
+ * DAO365.
+ */
public const DAO365 = 'DAO365';
+ /**
+ * BioCair.
+ */
public const BIOCAIR_FTP = 'BIOCAIR_FTP';
+ /**
+ * Ransa.
+ */
public const RANSA_WEBHOOK = 'RANSA_WEBHOOK';
+ /**
+ * SHIPXPRESS.
+ */
public const SHIPXPRES = 'SHIPXPRES';
+ /**
+ * Courant Plus.
+ */
public const COURANT_PLUS_API = 'COURANT_PLUS_API';
+ /**
+ * SHIPA.
+ */
public const SHIPA = 'SHIPA';
+ /**
+ * Home Logistics.
+ */
public const HOMELOGISTICS = 'HOMELOGISTICS';
+ /**
+ * DX.
+ */
public const DX = 'DX';
+ /**
+ * Poste Italiane Paccocelere.
+ */
public const POSTE_ITALIANE_PACCOCELERE = 'POSTE_ITALIANE_PACCOCELERE';
+ /**
+ * Toll Group.
+ */
public const TOLL_WEBHOOK = 'TOLL_WEBHOOK';
+ /**
+ * LCT do Brasil.
+ */
public const LCTBR_API = 'LCTBR_API';
+ /**
+ * DX Freight.
+ */
public const DX_FREIGHT = 'DX_FREIGHT';
+ /**
+ * DHL Express.
+ */
public const DHL_SFTP = 'DHL_SFTP';
+ /**
+ * Shiprocket X.
+ */
public const SHIPROCKET = 'SHIPROCKET';
+ /**
+ * Uber.
+ */
public const UBER_WEBHOOK = 'UBER_WEBHOOK';
+ /**
+ * Stat Overnight.
+ */
public const STATOVERNIGHT = 'STATOVERNIGHT';
+ /**
+ * Burd Delivery.
+ */
public const BURD = 'BURD';
+ /**
+ * Fastship Express.
+ */
public const FASTSHIP = 'FASTSHIP';
+ /**
+ * IB Venture.
+ */
public const IBVENTURE_WEBHOOK = 'IBVENTURE_WEBHOOK';
+ /**
+ * Gati-KWE.
+ */
public const GATI_KWE_API = 'GATI_KWE_API';
+ /**
+ * CryoPDP.
+ */
public const CRYOPDP_FTP = 'CRYOPDP_FTP';
+ /**
+ * HUBBED.
+ */
public const HUBBED = 'HUBBED';
+ /**
+ * Tipsa API.
+ */
public const TIPSA_API = 'TIPSA_API';
+ /**
+ * Aras Cargo.
+ */
public const ARASKARGO = 'ARASKARGO';
+ /**
+ * Thijs Logistiek.
+ */
public const THIJS_NL = 'THIJS_NL';
+ /**
+ * ATS Healthcare.
+ */
public const ATSHEALTHCARE_REFERENCE = 'ATSHEALTHCARE_REFERENCE';
+ /**
+ * 99minutos.
+ */
public const ENUM_99MINUTOS = '99MINUTOS';
+ /**
+ * Hellenic (Greece) Post.
+ */
public const HELLENIC_POST = 'HELLENIC_POST';
+ /**
+ * HSM Global.
+ */
public const HSM_GLOBAL = 'HSM_GLOBAL';
+ /**
+ * MNX.
+ */
public const MNX = 'MNX';
+ /**
+ * N&M Transfer Co., Inc..
+ */
public const NMTRANSFER = 'NMTRANSFER';
+ /**
+ * Logysto.
+ */
public const LOGYSTO = 'LOGYSTO';
+ /**
+ * India Post International.
+ */
public const INDIA_POST_INT = 'INDIA_POST_INT';
+ /**
+ * Swiship IN.
+ */
public const AMAZON_FBA_SWISHIP_IN = 'AMAZON_FBA_SWISHIP_IN';
+ /**
+ * SRT Transport.
+ */
public const SRT_TRANSPORT = 'SRT_TRANSPORT';
+ /**
+ * Bomi Group.
+ */
public const BOMI = 'BOMI';
+ /**
+ * Deliverr.
+ */
public const DELIVERR_SFTP = 'DELIVERR_SFTP';
+ /**
+ * HSDEXPRESS.
+ */
public const HSDEXPRESS = 'HSDEXPRESS';
+ /**
+ * SimpleTire.
+ */
public const SIMPLETIRE_WEBHOOK = 'SIMPLETIRE_WEBHOOK';
+ /**
+ * Hunter Express.
+ */
public const HUNTER_EXPRESS_SFTP = 'HUNTER_EXPRESS_SFTP';
+ /**
+ * UPS.
+ */
public const UPS_API = 'UPS_API';
+ /**
+ * WOO YOUNG LOGISTICS CO.,LTD..
+ */
public const WOOYOUNG_LOGISTICS_SFTP = 'WOOYOUNG_LOGISTICS_SFTP';
+ /**
+ * PHSE.
+ */
public const PHSE_API = 'PHSE_API';
+ /**
+ * Wish.
+ */
public const WISH_EMAIL_PUSH = 'WISH_EMAIL_PUSH';
+ /**
+ * Northline.
+ */
public const NORTHLINE = 'NORTHLINE';
+ /**
+ * Med Africa Logistics.
+ */
public const MEDAFRICA = 'MEDAFRICA';
+ /**
+ * DPD Austria.
+ */
public const DPD_AT_SFTP = 'DPD_AT_SFTP';
+ /**
+ * Anteraja.
+ */
public const ANTERAJA = 'ANTERAJA';
+ /**
+ * DHL Global Forwarding API.
+ */
public const DHL_GLOBAL_FORWARDING_API = 'DHL_GLOBAL_FORWARDING_API';
+ /**
+ * LBC EXPRESS INC..
+ */
public const LBCEXPRESS_API = 'LBCEXPRESS_API';
+ /**
+ * Sims Global.
+ */
public const SIMSGLOBAL = 'SIMSGLOBAL';
+ /**
+ * CDL Last Mile.
+ */
public const CDLDELIVERS = 'CDLDELIVERS';
+ /**
+ * TYP.
+ */
public const TYP = 'TYP';
+ /**
+ * Testing Courier.
+ */
public const TESTING_COURIER_WEBHOOK = 'TESTING_COURIER_WEBHOOK';
+ /**
+ * Pandago.
+ */
public const PANDAGO_API = 'PANDAGO_API';
+ /**
+ * Royal Mail.
+ */
public const ROYAL_MAIL_FTP = 'ROYAL_MAIL_FTP';
+ /**
+ * Thunder Express Australia.
+ */
public const THUNDEREXPRESS = 'THUNDEREXPRESS';
+ /**
+ * Secretlab.
+ */
public const SECRETLAB_WEBHOOK = 'SECRETLAB_WEBHOOK';
+ /**
+ * Setel Express.
+ */
public const SETEL = 'SETEL';
+ /**
+ * JD Worldwide.
+ */
public const JD_WORLDWIDE = 'JD_WORLDWIDE';
+ /**
+ * DPD Russia.
+ */
public const DPD_RU_API = 'DPD_RU_API';
+ /**
+ * Argents Express Group.
+ */
public const ARGENTS_WEBHOOK = 'ARGENTS_WEBHOOK';
+ /**
+ * Post ONE.
+ */
public const POSTONE = 'POSTONE';
+ /**
+ * Tusk Logistics.
+ */
public const TUSKLOGISTICS = 'TUSKLOGISTICS';
+ /**
+ * Rhenus Logistics UK.
+ */
public const RHENUS_UK_API = 'RHENUS_UK_API';
+ /**
+ * Yamato Singapore.
+ */
public const TAQBIN_SG_API = 'TAQBIN_SG_API';
+ /**
+ * Inntralog GmbH.
+ */
public const INNTRALOG_SFTP = 'INNTRALOG_SFTP';
+ /**
+ * Day & Ross.
+ */
public const DAYROSS = 'DAYROSS';
+ /**
+ * Correos Express (API).
+ */
public const CORREOSEXPRESS_API = 'CORREOSEXPRESS_API';
+ /**
+ * International Seur API.
+ */
public const INTERNATIONAL_SEUR_API = 'INTERNATIONAL_SEUR_API';
+ /**
+ * Yodel API.
+ */
public const YODEL_API = 'YODEL_API';
+ /**
+ * Hero Express.
+ */
public const HEROEXPRESS = 'HEROEXPRESS';
+ /**
+ * DHL supply chain India.
+ */
public const DHL_SUPPLYCHAIN_IN = 'DHL_SUPPLYCHAIN_IN';
+ /**
+ * Urgent Cargus.
+ */
public const URGENT_CARGUS = 'URGENT_CARGUS';
+ /**
+ * FRONTdoor Collective.
+ */
public const FRONTDOORCORP = 'FRONTDOORCORP';
+ /**
+ * J&T Express Philippines.
+ */
public const JTEXPRESS_PH = 'JTEXPRESS_PH';
+ /**
+ * Parcelstars.
+ */
public const PARCELSTARS_WEBHOOK = 'PARCELSTARS_WEBHOOK';
+ /**
+ * DPD Slovakia.
+ */
public const DPD_SK_SFTP = 'DPD_SK_SFTP';
+ /**
+ * Movianto.
+ */
public const MOVIANTO = 'MOVIANTO';
+ /**
+ * Ozeparts Shipping.
+ */
public const OZEPARTS_SHIPPING = 'OZEPARTS_SHIPPING';
+ /**
+ * KargomKolay (CargoMini).
+ */
public const KARGOMKOLAY = 'KARGOMKOLAY';
+ /**
+ * Trunkrs.
+ */
public const TRUNKRS = 'TRUNKRS';
+ /**
+ * Omni Returns.
+ */
public const OMNIRPS_WEBHOOK = 'OMNIRPS_WEBHOOK';
+ /**
+ * Chile Express.
+ */
public const CHILEXPRESS = 'CHILEXPRESS';
+ /**
+ * Testing Courier.
+ */
public const TESTING_COURIER = 'TESTING_COURIER';
+ /**
+ * JNE (API).
+ */
public const JNE_API = 'JNE_API';
+ /**
+ * BJS Distribution, Storage & Couriers - FTP.
+ */
public const BJSHOMEDELIVERY_FTP = 'BJSHOMEDELIVERY_FTP';
+ /**
+ * D Express.
+ */
public const DEXPRESS_WEBHOOK = 'DEXPRESS_WEBHOOK';
+ /**
+ * USPS API.
+ */
public const USPS_API = 'USPS_API';
+ /**
+ * TransVirtual.
+ */
public const TRANSVIRTUAL = 'TRANSVIRTUAL';
+ /**
+ * solistica.
+ */
public const SOLISTICA_API = 'SOLISTICA_API';
+ /**
+ * Chienventure.
+ */
public const CHIENVENTURE_WEBHOOK = 'CHIENVENTURE_WEBHOOK';
+ /**
+ * DPD UK.
+ */
public const DPD_UK_SFTP = 'DPD_UK_SFTP';
+ /**
+ * InPost.
+ */
public const INPOST_UK = 'INPOST_UK';
+ /**
+ * Javit.
+ */
public const JAVIT = 'JAVIT';
+ /**
+ * ZTO Express China.
+ */
public const ZTO_DOMESTIC = 'ZTO_DOMESTIC';
+ /**
+ * DHL Global Forwarding Guatemala.
+ */
public const DHL_GT_API = 'DHL_GT_API';
+ /**
+ * CEVA Package.
+ */
public const CEVA_TRACKING = 'CEVA_TRACKING';
+ /**
+ * Komon Express.
+ */
public const KOMON_EXPRESS = 'KOMON_EXPRESS';
+ /**
+ * East West Courier Pte Ltd.
+ */
public const EASTWESTCOURIER_FTP = 'EASTWESTCOURIER_FTP';
+ /**
+ * Danniao.
+ */
public const DANNIAO = 'DANNIAO';
+ /**
+ * Spectran.
+ */
public const SPECTRAN = 'SPECTRAN';
+ /**
+ * Deliver-iT.
+ */
public const DELIVER_IT = 'DELIVER_IT';
+ /**
+ * Relais Colis.
+ */
public const RELAISCOLIS = 'RELAISCOLIS';
+ /**
+ * GLS Spain.
+ */
public const GLS_SPAIN_API = 'GLS_SPAIN_API';
+ /**
+ * PostPlus.
+ */
public const POSTPLUS = 'POSTPLUS';
+ /**
+ * Airterra.
+ */
public const AIRTERRA = 'AIRTERRA';
+ /**
+ * GIO Express Ecourier.
+ */
public const GIO_ECOURIER_API = 'GIO_ECOURIER_API';
+ /**
+ * DPD Switzerland.
+ */
public const DPD_CH_SFTP = 'DPD_CH_SFTP';
+ /**
+ * FedEx®.
+ */
public const FEDEX_API = 'FEDEX_API';
+ /**
+ * INTERSMARTTRANS & SOLUTIONS SL.
+ */
public const INTERSMARTTRANS = 'INTERSMARTTRANS';
+ /**
+ * Hermes UK.
+ */
public const HERMES_UK_SFTP = 'HERMES_UK_SFTP';
+ /**
+ * Exelot Ltd..
+ */
public const EXELOT_FTP = 'EXELOT_FTP';
+ /**
+ * DHL GLOBAL FORWARDING PANAMÁ.
+ */
public const DHL_PA_API = 'DHL_PA_API';
+ /**
+ * Vir Transport.
+ */
public const VIRTRANSPORT_SFTP = 'VIRTRANSPORT_SFTP';
+ /**
+ * Worldnet Logistics.
+ */
public const WORLDNET = 'WORLDNET';
+ /**
+ * Instabox.
+ */
public const INSTABOX_WEBHOOK = 'INSTABOX_WEBHOOK';
+ /**
+ * Keuhne + Nagel Global.
+ */
public const KNG = 'KNG';
+ /**
+ * Flash Express.
+ */
public const FLASHEXPRESS_WEBHOOK = 'FLASHEXPRESS_WEBHOOK';
+ /**
+ * Magyar Posta.
+ */
public const MAGYAR_POSTA_API = 'MAGYAR_POSTA_API';
+ /**
+ * WeShip.
+ */
public const WESHIP_API = 'WESHIP_API';
+ /**
+ * Ohi.
+ */
public const OHI_WEBHOOK = 'OHI_WEBHOOK';
+ /**
+ * MUDITA.
+ */
public const MUDITA = 'MUDITA';
+ /**
+ * Bluedart.
+ */
public const BLUEDART_API = 'BLUEDART_API';
+ /**
+ * T-cat.
+ */
public const T_CAT_API = 'T_CAT_API';
+ /**
+ * ADS Express.
+ */
public const ADS = 'ADS';
+ /**
+ * HR Parcel.
+ */
public const HERMES_IT = 'HERMES_IT';
+ /**
+ * FitzMark.
+ */
public const FITZMARK_API = 'FITZMARK_API';
+ /**
+ * Posti API.
+ */
public const POSTI_API = 'POSTI_API';
+ /**
+ * SMSA Express.
+ */
public const SMSA_EXPRESS_WEBHOOK = 'SMSA_EXPRESS_WEBHOOK';
+ /**
+ * Tamer Logistics.
+ */
public const TAMERGROUP_WEBHOOK = 'TAMERGROUP_WEBHOOK';
+ /**
+ * Livrapide.
+ */
public const LIVRAPIDE = 'LIVRAPIDE';
+ /**
+ * Nippon Express.
+ */
public const NIPPON_EXPRESS = 'NIPPON_EXPRESS';
+ /**
+ * Better Trucks.
+ */
public const BETTERTRUCKS = 'BETTERTRUCKS';
+ /**
+ * FAN COURIER EXPRESS.
+ */
public const FAN = 'FAN';
+ /**
+ * USPS Flats (Pitney Bowes).
+ */
public const PB_USPSFLATS_FTP = 'PB_USPSFLATS_FTP';
+ /**
+ * Parcel Right.
+ */
public const PARCELRIGHT = 'PARCELRIGHT';
+ /**
+ * iThink Logistics.
+ */
public const ITHINKLOGISTICS = 'ITHINKLOGISTICS';
+ /**
+ * Kerry Logistics.
+ */
public const KERRY_EXPRESS_TH_WEBHOOK = 'KERRY_EXPRESS_TH_WEBHOOK';
+ /**
+ * eCoutier.
+ */
public const ECOUTIER = 'ECOUTIER';
+ /**
+ * SENHONG INTERNATIONAL LOGISTICS.
+ */
public const SHOWL = 'SHOWL';
+ /**
+ * BRT Bartolini API.
+ */
public const BRT_IT_API = 'BRT_IT_API';
+ /**
+ * Rixon Logistics.
+ */
public const RIXONHK_API = 'RIXONHK_API';
+ /**
+ * DB Schenker.
+ */
public const DBSCHENKER_API = 'DBSCHENKER_API';
+ /**
+ * Ilyang logistics.
+ */
public const ILYANGLOGIS = 'ILYANGLOGIS';
+ /**
+ * Mail Boxes Etc..
+ */
public const MAIL_BOX_ETC = 'MAIL_BOX_ETC';
+ /**
+ * WeShip.
+ */
public const WESHIP = 'WESHIP';
+ /**
+ * DHL eCommerce Solutions.
+ */
public const DHL_GLOBAL_MAIL_API = 'DHL_GLOBAL_MAIL_API';
+ /**
+ * Activos24.
+ */
public const ACTIVOS24_API = 'ACTIVOS24_API';
+ /**
+ * ATS Healthcare.
+ */
public const ATSHEALTHCARE = 'ATSHEALTHCARE';
+ /**
+ * Luwjistik.
+ */
public const LUWJISTIK = 'LUWJISTIK';
+ /**
+ * Gebrüder Weiss.
+ */
public const GW_WORLD = 'GW_WORLD';
+ /**
+ * fairsenden.
+ */
public const FAIRSENDEN_API = 'FAIRSENDEN_API';
+ /**
+ * SerVIP.
+ */
public const SERVIP_WEBHOOK = 'SERVIP_WEBHOOK';
+ /**
+ * Swiship.
+ */
public const SWISHIP = 'SWISHIP';
+ /**
+ * Transport Ambientales.
+ */
public const TANET = 'TANET';
+ /**
+ * SHENZHEN HOTSIN CARGO INT'L FORWARDING CO.,LTD.
+ */
public const HOTSIN_CARGO = 'HOTSIN_CARGO';
+ /**
+ * Direx.
+ */
public const DIREX = 'DIREX';
+ /**
+ * HuanTong.
+ */
public const HUANTONG = 'HUANTONG';
+ /**
+ * iMile.
+ */
public const IMILE_API = 'IMILE_API';
- public const BDMNET = 'BDMNET';
-
+ /**
+ * Au Express.
+ */
public const AUEXPRESS = 'AUEXPRESS';
+ /**
+ * NYT SUPPLY CHAIN LOGISTICS Co.,LTD.
+ */
public const NYTLOGISTICS = 'NYTLOGISTICS';
+ /**
+ * DSV Futurewave.
+ */
public const DSV_REFERENCE = 'DSV_REFERENCE';
+ /**
+ * Novofarma.
+ */
public const NOVOFARMA_WEBHOOK = 'NOVOFARMA_WEBHOOK';
+ /**
+ * AIT.
+ */
public const AITWORLDWIDE_SFTP = 'AITWORLDWIDE_SFTP';
+ /**
+ * Olive.
+ */
public const SHOPOLIVE = 'SHOPOLIVE';
+ /**
+ * Fast & Furious.
+ */
public const FNF_ZA = 'FNF_ZA';
+ /**
+ * DHL eCommerce Greater China.
+ */
public const DHL_ECOMMERCE_GC = 'DHL_ECOMMERCE_GC';
+ /**
+ * Fetchr.
+ */
public const FETCHR = 'FETCHR';
+ /**
+ * Starlinks Global.
+ */
public const STARLINKS_API = 'STARLINKS_API';
+ /**
+ * YYEXPRESS.
+ */
public const YYEXPRESS = 'YYEXPRESS';
+ /**
+ * Servientrega.
+ */
public const SERVIENTREGA = 'SERVIENTREGA';
+ /**
+ * HanJin.
+ */
public const HANJIN = 'HANJIN';
+ /**
+ * Spanish Seur.
+ */
public const SPANISH_SEUR_FTP = 'SPANISH_SEUR_FTP';
+ /**
+ * DX (B2B).
+ */
public const DX_B2B_CONNUM = 'DX_B2B_CONNUM';
+ /**
+ * Helthjem.
+ */
public const HELTHJEM_API = 'HELTHJEM_API';
+ /**
+ * Inexpost.
+ */
public const INEXPOST = 'INEXPOST';
+ /**
+ * A2B Express Logistics.
+ */
public const A2B_BA = 'A2B_BA';
+ /**
+ * Rhenus Logistics.
+ */
public const RHENUS_GROUP = 'RHENUS_GROUP';
+ /**
+ * Sber Logistics.
+ */
public const SBERLOGISTICS_RU = 'SBERLOGISTICS_RU';
+ /**
+ * Malca-Amit.
+ */
public const MALCA_AMIT = 'MALCA_AMIT';
+ /**
+ * Professional Parcel Logistics.
+ */
public const PPL = 'PPL';
+ /**
+ * OSM Worldwide.
+ */
public const OSM_WORLDWIDE_SFTP = 'OSM_WORLDWIDE_SFTP';
+ /**
+ * ACI Logistix.
+ */
public const ACILOGISTIX = 'ACILOGISTIX';
+ /**
+ * Optima Courier.
+ */
public const OPTIMACOURIER = 'OPTIMACOURIER';
+ /**
+ * Nova Poshta API.
+ */
public const NOVA_POSHTA_API = 'NOVA_POSHTA_API';
+ /**
+ * Loggi.
+ */
public const LOGGI = 'LOGGI';
+ /**
+ * YiFan Express.
+ */
public const YIFAN = 'YIFAN';
+ /**
+ * My DynaLogic.
+ */
public const MYDYNALOGIC = 'MYDYNALOGIC';
+ /**
+ * Morning Global.
+ */
public const MORNINGLOBAL = 'MORNINGLOBAL';
+ /**
+ * Concise.
+ */
public const CONCISE_API = 'CONCISE_API';
+ /**
+ * Falcon Express.
+ */
public const FXTRAN = 'FXTRAN';
+ /**
+ * Deliver Your Parcel.
+ */
public const DELIVERYOURPARCEL_ZA = 'DELIVERYOURPARCEL_ZA';
+ /**
+ * uParcel.
+ */
public const UPARCEL = 'UPARCEL';
+ /**
+ * Mobi Logistica.
+ */
public const MOBI_BR = 'MOBI_BR';
+ /**
+ * T&W Delivery.
+ */
public const LOGINEXT_WEBHOOK = 'LOGINEXT_WEBHOOK';
+ /**
+ * EMS.
+ */
public const EMS = 'EMS';
+ /**
+ * Speedy.
+ */
public const SPEEDY = 'SPEEDY';
+ /**
+ * Zoom.
+ */
public const ZOOM_RED = 'ZOOM_RED';
+ /**
+ * Navlungo.
+ */
public const NAVLUNGO = 'NAVLUNGO';
+ /**
+ * Castle Parcels.
+ */
public const CASTLEPARCELS = 'CASTLEPARCELS';
+ /**
+ * Weee.
+ */
public const WEEE = 'WEEE';
+ /**
+ * Packaly.
+ */
public const PACKALY = 'PACKALY';
+ /**
+ * Yunhuipost.
+ */
public const YUNHUIPOST = 'YUNHUIPOST';
+ /**
+ * YouParcel.
+ */
public const YOUPARCEL = 'YOUPARCEL';
+ /**
+ * Leman.
+ */
public const LEMAN = 'LEMAN';
+ /**
+ * Moovin.
+ */
public const MOOVIN = 'MOOVIN';
+ /**
+ * Urb-it.
+ */
public const URB_IT = 'URB_IT';
+ /**
+ * Multientrega.
+ */
public const MULTIENTREGAPANAMA = 'MULTIENTREGAPANAMA';
+ /**
+ * Jusdasr.
+ */
public const JUSDASR = 'JUSDASR';
+ /**
+ * Discount Post.
+ */
public const DISCOUNTPOST = 'DISCOUNTPOST';
+ /**
+ * Rhenus Logistics UK.
+ */
public const RHENUS_UK = 'RHENUS_UK';
+ /**
+ * Swiship JP.
+ */
public const SWISHIP_JP = 'SWISHIP_JP';
+ /**
+ * GLS USA.
+ */
public const GLS_US = 'GLS_US';
+ /**
+ * Southwestern Motor Transport. Inc.
+ */
public const SMTL = 'SMTL';
+ /**
+ * Discount Post Emega.
+ */
public const EMEGA = 'EMEGA';
+ /**
+ * EXPRESSONE Slovenia.
+ */
public const EXPRESSONE_SV = 'EXPRESSONE_SV';
+ /**
+ * hepsiJET.
+ */
public const HEPSIJET = 'HEPSIJET';
+ /**
+ * Welivery.
+ */
public const WELIVERY = 'WELIVERY';
+ /**
+ * Bringer Parcel Services.
+ */
public const BRINGER = 'BRINGER';
+ /**
+ * EasyRoutes.
+ */
public const EASYROUTES = 'EASYROUTES';
+ /**
+ * MRW.
+ */
public const MRW = 'MRW';
+ /**
+ * RPM.
+ */
public const RPM = 'RPM';
+ /**
+ * DPD Portugal.
+ */
public const DPD_PRT = 'DPD_PRT';
+ /**
+ * GLS Romania.
+ */
public const GLS_ROMANIA = 'GLS_ROMANIA';
+ /**
+ * LM Parcel.
+ */
public const LMPARCEL = 'LMPARCEL';
+ /**
+ * GTA GSM.
+ */
public const GTAGSM = 'GTAGSM';
+ /**
+ * DOMINO.
+ */
public const DOMINO = 'DOMINO';
+ /**
+ * eShipper.
+ */
public const ESHIPPER = 'ESHIPPER';
+ /**
+ * Transpak Inc..
+ */
public const TRANSPAK = 'TRANSPAK';
+ /**
+ * Xindus.
+ */
public const XINDUS = 'XINDUS';
+ /**
+ * Aoyue.
+ */
public const AOYUE = 'AOYUE';
+ /**
+ * Easyparcel.
+ */
public const EASYPARCEL = 'EASYPARCEL';
+ /**
+ * EXPRESSONE.
+ */
public const EXPRESSONE = 'EXPRESSONE';
+ /**
+ * Sendeo Kargo.
+ */
public const SENDEO_KARGO = 'SENDEO_KARGO';
+ /**
+ * Speedaf Express.
+ */
public const SPEEDAF = 'SPEEDAF';
+ /**
+ * eTower.
+ */
public const ETOWER = 'ETOWER';
+ /**
+ * GC Express.
+ */
public const GCX = 'GCX';
+ /**
+ * Ninjavan Vietnam.
+ */
public const NINJAVAN_VN = 'NINJAVAN_VN';
+ /**
+ * Allegro.
+ */
public const ALLEGRO = 'ALLEGRO';
+ /**
+ * Jumppoint.
+ */
public const JUMPPOINT = 'JUMPPOINT';
+ /**
+ * ShipGlobal.
+ */
public const SHIPGLOBAL_US = 'SHIPGLOBAL_US';
+ /**
+ * Kinisi Transport Pty Ltd.
+ */
public const KINISI = 'KINISI';
+ /**
+ * Oakh Harbour Freight Lines.
+ */
public const OAKH = 'OAKH';
+ /**
+ * American West.
+ */
public const AWEST = 'AWEST';
+ /**
+ * Barsan Global Lojistik.
+ */
public const BARSAN = 'BARSAN';
+ /**
+ * Energo Logistic.
+ */
public const ENERGOLOGISTIC = 'ENERGOLOGISTIC';
+ /**
+ * Madrooex.
+ */
public const MADROOEX = 'MADROOEX';
+ /**
+ * GoBolt.
+ */
public const GOBOLT = 'GOBOLT';
+ /**
+ * Swiss Universal Express.
+ */
public const SWISS_UNIVERSAL_EXPRESS = 'SWISS_UNIVERSAL_EXPRESS';
+ /**
+ * IOR Direct Solutions.
+ */
public const IORDIRECT = 'IORDIRECT';
+ /**
+ * xmszm.
+ */
public const XMSZM = 'XMSZM';
+ /**
+ * GLS Hungary.
+ */
public const GLS_HUN = 'GLS_HUN';
+ /**
+ * Sendy Express.
+ */
public const SENDY = 'SENDY';
+ /**
+ * Brauns Express.
+ */
public const BRAUNSEXPRESS = 'BRAUNSEXPRESS';
+ /**
+ * Grand Slam Express.
+ */
public const GRANDSLAMEXPRESS = 'GRANDSLAMEXPRESS';
+ /**
+ * XGS.
+ */
public const XGS = 'XGS';
+ /**
+ * OTS.
+ */
public const OTSCHILE = 'OTSCHILE';
+ /**
+ * Pack-Up.
+ */
public const PACK_UP = 'PACK_UP';
+ /**
+ * Parcelstars.
+ */
public const PARCELSTARS = 'PARCELSTARS';
+ /**
+ * Team Express Service LLC.
+ */
public const TEAMEXPRESSLLC = 'TEAMEXPRESSLLC';
+ /**
+ * Asyad Express.
+ */
public const ASYADEXPRESS = 'ASYADEXPRESS';
+ /**
+ * TDN.
+ */
public const TDN = 'TDN';
+ /**
+ * Early Bird.
+ */
public const EARLYBIRD = 'EARLYBIRD';
+ /**
+ * Cacesa.
+ */
public const CACESA = 'CACESA';
+ /**
+ * Parceljet.
+ */
public const PARCELJET = 'PARCELJET';
+ /**
+ * MNG Kargo.
+ */
public const MNG_KARGO = 'MNG_KARGO';
+ /**
+ * Super Pac Line.
+ */
public const SUPERPACKLINE = 'SUPERPACKLINE';
+ /**
+ * SpeedX.
+ */
public const SPEEDX = 'SPEEDX';
+ /**
+ * Vesyl.
+ */
public const VESYL = 'VESYL';
+ /**
+ * Sky King.
+ */
public const SKYKING = 'SKYKING';
+ /**
+ * DIR.
+ */
public const DIRMENSAJERIA = 'DIRMENSAJERIA';
+ /**
+ * Netlogix.
+ */
public const NETLOGIXGROUP = 'NETLOGIXGROUP';
+ /**
+ * ZYEX.
+ */
public const ZYOU = 'ZYOU';
+ /**
+ * Jawar.
+ */
public const JAWAR = 'JAWAR';
+ /**
+ * Associate Global Systems.
+ */
public const AGSYSTEMS = 'AGSYSTEMS';
+ /**
+ * GPS.
+ */
public const GPS = 'GPS';
+ /**
+ * PTT Kargo.
+ */
public const PTT_KARGO = 'PTT_KARGO';
+ /**
+ * Maergo.
+ */
public const MAERGO = 'MAERGO';
+ /**
+ * AICS.
+ */
public const ARIHANTCOURIER = 'ARIHANTCOURIER';
+ /**
+ * VicTas Freight Express.
+ */
public const VTFE = 'VTFE';
+ /**
+ * Yunant.
+ */
public const YUNANT = 'YUNANT';
+ /**
+ * Urbify.
+ */
public const URBIFY = 'URBIFY';
+ /**
+ * pack-man.
+ */
public const PACK_MAN = 'PACK_MAN';
+ /**
+ * LIEFERGRUN.
+ */
public const LIEFERGRUN = 'LIEFERGRUN';
+ /**
+ * Obibox.
+ */
public const OBIBOX = 'OBIBOX';
+ /**
+ * Paikeda.
+ */
public const PAIKEDA = 'PAIKEDA';
+ /**
+ * Scotty.
+ */
public const SCOTTY = 'SCOTTY';
+ /**
+ * Intelcom.
+ */
public const INTELCOM_CA = 'INTELCOM_CA';
+ /**
+ * swe.
+ */
public const SWE = 'SWE';
+ /**
+ * Asendia Global.
+ */
public const ASENDIA = 'ASENDIA';
+ /**
+ * DPD Austria.
+ */
public const DPD_AT = 'DPD_AT';
+ /**
+ * Relay.
+ */
public const RELAY = 'RELAY';
+ /**
+ * ATA.
+ */
public const ATA = 'ATA';
+ /**
+ * SkyExpress Internationals.
+ */
public const SKYEXPRESS_INTERNATIONAL = 'SKYEXPRESS_INTERNATIONAL';
+ /**
+ * Surat Kargo.
+ */
public const SURAT_KARGO = 'SURAT_KARGO';
+ /**
+ * SG LINK.
+ */
public const SGLINK = 'SGLINK';
+ /**
+ * FleetOptics.
+ */
public const FLEETOPTICSINC = 'FLEETOPTICSINC';
+ /**
+ * shopline.
+ */
public const SHOPLINE = 'SHOPLINE';
+ /**
+ * PIGGYSHIP.
+ */
public const PIGGYSHIP = 'PIGGYSHIP';
+ /**
+ * LogoiX.
+ */
public const LOGOIX = 'LOGOIX';
+ /**
+ * Kolay Gelsin.
+ */
public const KOLAY_GELSIN = 'KOLAY_GELSIN';
+ /**
+ * Associated Couriers.
+ */
public const ASSOCIATED_COURIERS = 'ASSOCIATED_COURIERS';
+ /**
+ * ups-checker.
+ */
public const UPS_CHECKER = 'UPS_CHECKER';
+ /**
+ * Wineshipping.
+ */
public const WINESHIPPING = 'WINESHIPPING';
- public const SPEDISCI = 'SPEDISCI';
-
- private const _ALL_VALUES = [
- self::DPD_RU,
- self::BG_BULGARIAN_POST,
- self::KR_KOREA_POST,
- self::ZA_COURIERIT,
- self::FR_EXAPAQ,
- self::ARE_EMIRATES_POST,
- self::GAC,
- self::GEIS,
- self::SF_EX,
- self::PAGO,
- self::MYHERMES,
- self::DIAMOND_EUROGISTICS,
- self::CORPORATECOURIERS_WEBHOOK,
- self::BOND,
- self::OMNIPARCEL,
- self::SK_POSTA,
- self::PUROLATOR,
- self::FETCHR_WEBHOOK,
- self::THEDELIVERYGROUP,
- self::CELLO_SQUARE,
- self::TARRIVE,
- self::COLLIVERY,
- self::MAINFREIGHT,
- self::IND_FIRSTFLIGHT,
- self::ACSWORLDWIDE,
- self::AMSTAN,
- self::OKAYPARCEL,
- self::ENVIALIA_REFERENCE,
- self::SEUR_ES,
- self::CONTINENTAL,
- self::FDSEXPRESS,
- self::AMAZON_FBA_SWISHIP,
- self::WYNGS,
- self::DHL_ACTIVE_TRACING,
- self::ZYLLEM,
- self::RUSTON,
- self::XPOST,
- self::CORREOS_ES,
- self::DHL_FR,
- self::PAN_ASIA,
- self::BRT_IT,
- self::SRE_KOREA,
- self::SPEEDEE,
- self::TNT_UK,
- self::VENIPAK,
- self::SHREENANDANCOURIER,
- self::CROSHOT,
- self::NIPOST_NG,
- self::EPST_GLBL,
- self::NEWGISTICS,
- self::POST_SLOVENIA,
- self::JERSEY_POST,
- self::BOMBINOEXP,
- self::WMG,
- self::XQ_EXPRESS,
- self::FURDECO,
- self::LHT_EXPRESS,
- self::SOUTH_AFRICAN_POST_OFFICE,
- self::SPOTON,
- self::DIMERCO,
- self::CYPRUS_POST_CYP,
- self::ABCUSTOM,
- self::IND_DELIVREE,
- self::CN_BESTEXPRESS,
- self::DX_SFTP,
- self::PICKUPP_MYS,
- self::FMX,
- self::HELLMANN,
- self::SHIP_IT_ASIA,
- self::KERRY_ECOMMERCE,
- self::FRETERAPIDO,
- self::PITNEY_BOWES,
- self::XPRESSEN_DK,
- self::SEUR_SP_API,
- self::DELIVERYONTIME,
- self::JINSUNG,
- self::TRANS_KARGO,
- self::SWISHIP_DE,
- self::IVOY_WEBHOOK,
- self::AIRMEE_WEBHOOK,
- self::DHL_BENELUX,
- self::FIRSTMILE,
- self::FASTWAY_IR,
- self::HH_EXP,
- self::MYS_MYPOST_ONLINE,
- self::TNT_NL,
- self::TIPSA,
- self::TAQBIN_MY,
- self::KGMHUB,
- self::INTEXPRESS,
- self::OVERSE_EXP,
- self::ONECLICK,
- self::ROADRUNNER_FREIGHT,
- self::GLS_CROTIA,
- self::MRW_FTP,
- self::BLUEX,
- self::DYLT,
- self::DPD_IR,
- self::SIN_GLBL,
- self::TUFFNELLS_REFERENCE,
- self::CJPACKET,
- self::MILKMAN,
- self::ASIGNA,
- self::ONEWORLDEXPRESS,
- self::ROYAL_MAIL,
- self::VIA_EXPRESS,
- self::TIGFREIGHT,
- self::ZTO_EXPRESS,
- self::TWO_GO,
- self::IML,
- self::INTEL_VALLEY,
- self::EFS,
- self::UK_UK_MAIL,
- self::RAM,
- self::ALLIEDEXPRESS,
- self::APC_OVERNIGHT,
- self::SHIPPIT,
- self::TFM,
- self::M_XPRESS,
- self::HDB_BOX,
- self::CLEVY_LINKS,
- self::IBEONE,
- self::FIEGE_NL,
- self::KWE_GLOBAL,
- self::CTC_EXPRESS,
- self::LAO_POST,
- self::AMAZON,
- self::MORE_LINK,
- self::JX,
- self::EASY_MAIL,
- self::ADUIEPYLE,
- self::GB_PANTHER,
- self::EXPRESSSALE,
- self::SG_DETRACK,
- self::TRUNKRS_WEBHOOK,
- self::MATDESPATCH,
- self::DICOM,
- self::MBW,
- self::KHM_CAMBODIA_POST,
- self::SINOTRANS,
- self::BRT_IT_PARCELID,
- self::DHL_SUPPLY_CHAIN,
- self::DHL_PL,
- self::TOPYOU,
- self::PALEXPRESS,
- self::DHL_SG,
- self::CN_WEDO,
- self::FULFILLME,
- self::DPD_DELISTRACK,
- self::UPS_REFERENCE,
- self::CARIBOU,
- self::LOCUS_WEBHOOK,
- self::DSV,
- self::CN_GOFLY,
- self::P2P_TRC,
- self::DIRECTPARCELS,
- self::NOVA_POSHTA_INT,
- self::FEDEX_POLAND,
- self::CN_JCEX,
- self::FAR_INTERNATIONAL,
- self::IDEXPRESS,
- self::GANGBAO,
- self::NEWAY,
- self::POSTNL_INT_3_S,
- self::RPX_ID,
- self::DESIGNERTRANSPORT_WEBHOOK,
- self::GLS_SLOVEN,
- self::PARCELLED_IN,
- self::GSI_EXPRESS,
- self::CON_WAY,
- self::BROUWER_TRANSPORT,
- self::CPEX,
- self::ISRAEL_POST,
- self::DTDC_IN,
- self::PTT_POST,
- self::XDE_WEBHOOK,
- self::TOLOS,
- self::GIAO_HANG,
- self::GEODIS_ESPACE,
- self::MAGYAR_HU,
- self::DOORDASH_WEBHOOK,
- self::TIKI_ID,
- self::CJ_HK_INTERNATIONAL,
- self::STAR_TRACK_EXPRESS,
- self::HELTHJEM,
- self::SFB2C,
- self::FREIGHTQUOTE,
- self::LANDMARK_GLOBAL_REFERENCE,
- self::PARCEL2GO,
- self::DELNEXT,
- self::RCL,
- self::CGS_EXPRESS,
- self::HK_POST,
- self::SAP_EXPRESS,
- self::PARCELPOST_SG,
- self::HERMES,
- self::IND_SAFEEXPRESS,
- self::TOPHATTEREXPRESS,
- self::MGLOBAL,
- self::AVERITT,
- self::LEADER,
- self::_2EBOX,
- self::SG_SPEEDPOST,
- self::DBSCHENKER_SE,
- self::ISR_POST_DOMESTIC,
- self::BESTWAYPARCEL,
- self::ASENDIA_DE,
- self::NIGHTLINE_UK,
- self::TAQBIN_SG,
- self::TCK_EXPRESS,
- self::ENDEAVOUR_DELIVERY,
- self::NANJINGWOYUAN,
- self::HEPPNER_FR,
- self::EMPS_CN,
- self::FONSEN,
- self::PICKRR,
- self::APC_OVERNIGHT_CONNUM,
- self::STAR_TRACK_NEXT_FLIGHT,
- self::DAJIN,
- self::UPS_FREIGHT,
- self::POSTA_PLUS,
- self::CEVA,
- self::ANSERX,
- self::JS_EXPRESS,
- self::PADTF,
- self::UPS_MAIL_INNOVATIONS,
- self::EZSHIP,
- self::SYPOST,
- self::AMAZON_SHIP_MCF,
- self::YUSEN,
- self::BRING,
- self::SDA_IT,
- self::GBA,
- self::NEWEGGEXPRESS,
- self::SPEEDCOURIERS_GR,
- self::FORRUN,
- self::PICKUP,
- self::ECMS,
- self::INTELIPOST,
- self::FLASHEXPRESS,
- self::CN_STO,
- self::SEKO_SFTP,
- self::HOME_DELIVERY_SOLUTIONS,
- self::DPD_HGRY,
- self::KERRYTTC_VN,
- self::JOYING_BOX,
- self::TOTAL_EXPRESS,
- self::ZJS_EXPRESS,
- self::STARKEN,
- self::DEMANDSHIP,
- self::CN_DPEX,
- self::AUPOST_CN,
- self::LOGISTERS,
- self::GOGLOBALPOST,
- self::GLS_CZ,
- self::PAACK_WEBHOOK,
- self::GRAB_WEBHOOK,
- self::PARCELPOINT,
- self::ICUMULUS,
- self::DAIGLOBALTRACK,
- self::GLOBAL_IPARCEL,
- self::YURTICI_KARGO,
- self::CN_PAYPAL_PACKAGE,
- self::PARCEL_2_POST,
- self::GLS_IT,
- self::PIL_LOGISTICS,
- self::HEPPNER,
- self::GENERAL_OVERNIGHT,
- self::HAPPY2POINT,
- self::CHITCHATS,
- self::SMOOTH,
- self::CLE_LOGISTICS,
- self::FIEGE,
- self::MX_CARGO,
- self::ZIINGFINALMILE,
- self::DAYTON_FREIGHT,
- self::TCS,
- self::AEX,
- self::HERMES_DE,
- self::ROUTIFIC_WEBHOOK,
- self::GLOBAVEND,
- self::CJ_LOGISTICS,
- self::PALLET_NETWORK,
- self::RAF_PH,
- self::UK_XDP,
- self::PAPER_EXPRESS,
- self::LA_POSTE_SUIVI,
- self::PAQUETEXPRESS,
- self::LIEFERY,
- self::STRECK_TRANSPORT,
- self::PONY_EXPRESS,
- self::ALWAYS_EXPRESS,
- self::GBS_BROKER,
- self::CITYLINK_MY,
- self::ALLJOY,
- self::YODEL,
- self::YODEL_DIR,
- self::STONE3PL,
- self::PARCELPAL_WEBHOOK,
- self::DHL_ECOMERCE_ASA,
- self::SIMPLYPOST,
- self::KY_EXPRESS,
- self::SHENZHEN,
- self::US_LASERSHIP,
- self::UC_EXPRE,
- self::DIDADI,
- self::CJ_KR,
- self::DBSCHENKER_B2B,
- self::MXE,
- self::CAE_DELIVERS,
- self::PFCEXPRESS,
- self::WHISTL,
- self::WEPOST,
- self::DHL_PARCEL_ES,
- self::DDEXPRESS,
- self::ARAMEX_AU,
- self::BNEED,
- self::HK_TGX,
- self::LATVIJAS_PASTS,
- self::VIAEUROPE,
- self::CORREO_UY,
- self::CHRONOPOST_FR,
- self::J_NET,
- self::_6LS,
- self::BLR_BELPOST,
- self::BIRDSYSTEM,
- self::DOBROPOST,
- self::WAHANA_ID,
- self::WEASHIP,
- self::SONICTL,
- self::KWT,
- self::AFLLOG_FTP,
- self::SKYNET_WORLDWIDE,
- self::NOVA_POSHTA,
- self::SEINO,
- self::SZENDEX,
- self::BPOST_INT,
- self::DBSCHENKER_SV,
- self::AO_DEUTSCHLAND,
- self::EU_FLEET_SOLUTIONS,
- self::PCFCORP,
- self::LINKBRIDGE,
- self::PRIMAMULTICIPTA,
- self::COUREX,
- self::ZAJIL_EXPRESS,
- self::COLLECTCO,
- self::JTEXPRESS,
- self::FEDEX_UK,
- self::USHIP,
- self::PIXSELL,
- self::SHIPTOR,
- self::CDEK,
- self::VNM_VIETTELPOST,
- self::CJ_CENTURY,
- self::GSO,
- self::VIWO,
- self::SKYBOX,
- self::KERRYTJ,
- self::NTLOGISTICS_VN,
- self::SDH_SCM,
- self::ZINC,
- self::DPE_SOUTH_AFRC,
- self::CESKA_CZ,
- self::ACS_GR,
- self::DEALERSEND,
- self::JOCOM,
- self::CSE,
- self::TFORCE_FINALMILE,
- self::SHIP_GATE,
- self::SHIPTER,
- self::NATIONAL_SAMEDAY,
- self::YUNEXPRESS,
- self::CAINIAO,
- self::DMS_MATRIX,
- self::DIRECTLOG,
- self::ASENDIA_US,
- self::_3JMSLOGISTICS,
- self::LICCARDI_EXPRESS,
- self::SKY_POSTAL,
- self::CNWANGTONG,
- self::POSTNORD_LOGISTICS_DK,
- self::LOGISTIKA,
- self::CELERITAS,
- self::PRESSIODE,
- self::SHREE_MARUTI,
- self::LOGISTICSWORLDWIDE_HK,
- self::EFEX,
- self::LOTTE,
- self::LONESTAR,
- self::APRISAEXPRESS,
- self::BEL_RS,
- self::OSM_WORLDWIDE,
- self::WESTGATE_GL,
- self::FASTRACK,
- self::DTD_EXPR,
- self::ALFATREX,
- self::PROMEDDELIVERY,
- self::THABIT_LOGISTICS,
- self::HCT_LOGISTICS,
- self::CARRY_FLAP,
- self::US_OLD_DOMINION,
- self::ANICAM_BOX,
- self::WANBEXPRESS,
- self::AN_POST,
- self::DPD_LOCAL,
- self::STALLIONEXPRESS,
- self::RAIDEREX,
- self::SHOPFANS,
- self::KYUNGDONG_PARCEL,
- self::CHAMPION_LOGISTICS,
- self::PICKUPP_SGP,
- self::MORNING_EXPRESS,
- self::NACEX,
- self::THENILE_WEBHOOK,
- self::HOLISOL,
- self::LBCEXPRESS_FTP,
- self::KURASI,
- self::USF_REDDAWAY,
- self::APG,
- self::CN_BOXC,
- self::ECOSCOOTING,
- self::MAINWAY,
- self::PAPERFLY,
- self::HOUNDEXPRESS,
- self::BOX_BERRY,
- self::EP_BOX,
- self::PLUS_LOG_UK,
- self::FULFILLA,
- self::ASE,
- self::MAIL_PLUS,
- self::XPO_LOGISTICS,
- self::WNDIRECT,
- self::CLOUDWISH_ASIA,
- self::ZELERIS,
- self::GIO_EXPRESS,
- self::OCS_WORLDWIDE,
- self::ARK_LOGISTICS,
- self::AQUILINE,
- self::PILOT_FREIGHT,
- self::QWINTRY,
- self::DANSKE_FRAGT,
- self::CARRIERS,
- self::AIR_CANADA_GLOBAL,
- self::PRESIDENT_TRANS,
- self::STEPFORWARDFS,
- self::SKYNET_UK,
- self::PITTOHIO,
- self::CORREOS_EXPRESS,
- self::RL_US,
- self::MARA_XPRESS,
- self::DESTINY,
- self::UK_YODEL,
- self::COMET_TECH,
- self::DHL_PARCEL_RU,
- self::TNT_REFR,
- self::SHREE_ANJANI_COURIER,
- self::MIKROPAKKET_BE,
- self::ETS_EXPRESS,
- self::COLIS_PRIVE,
- self::CN_YUNDA,
- self::AAA_COOPER,
- self::ROCKET_PARCEL,
- self::_360LION,
- self::PANDU,
- self::PROFESSIONAL_COURIERS,
- self::FLYTEXPRESS,
- self::LOGISTICSWORLDWIDE_MY,
- self::CORREOS_DE_ESPANA,
- self::IMX,
- self::FOUR_PX_EXPRESS,
- self::XPRESSBEES,
- self::PICKUPP_VNM,
- self::STARTRACK_EXPRESS1,
- self::FR_COLISSIMO,
- self::NACEX_SPAIN_REFERENCE,
- self::DHL_SUPPLY_CHAIN_AU,
- self::ESHIPPING,
- self::SHREETIRUPATI,
- self::HX_EXPRESS,
- self::INDOPAKET,
- self::CN_17POST,
- self::K1_EXPRESS,
- self::CJ_GLS,
- self::MYS_GDEX,
- self::NATIONEX,
- self::ANJUN,
- self::FARGOOD,
- self::SMG_EXPRESS,
- self::RZYEXPRESS,
- self::SEFL,
- self::TNT_CLICK_IT,
- self::HDB,
- self::HIPSHIPPER,
- self::RPXLOGISTICS,
- self::KUEHNE,
- self::IT_NEXIVE,
- self::PTS,
- self::SWISS_POST_FTP,
- self::FASTRK_SERV,
- self::_4_72,
- self::US_YRC,
- self::POSTNL_INTL_3S,
- self::ELIAN_POST,
- self::CUBYN,
- self::SAU_SAUDI_POST,
- self::ABXEXPRESS_MY,
- self::HUAHAN_EXPRESS,
- self::IND_JAYONEXPRESS,
- self::ZES_EXPRESS,
- self::ZEPTO_EXPRESS,
- self::SKYNET_ZA,
- self::ZEEK_2_DOOR,
- self::BLINKLASTMILE,
- self::POSTA_UKR,
- self::CHROBINSON,
- self::CN_POST56,
- self::COURANT_PLUS,
- self::SCUDEX_EXPRESS,
- self::SHIPENTEGRA,
- self::B_TWO_C_EUROPE,
- self::COPE,
- self::IND_GATI,
- self::CN_WISHPOST,
- self::NACEX_ES,
- self::TAQBIN_HK,
- self::GLOBALTRANZ,
- self::HKD,
- self::BJSHOMEDELIVERY,
- self::OMNIVA,
- self::SUTTON,
- self::PANTHER_REFERENCE,
- self::SFCSERVICE,
- self::LTL,
- self::PARKNPARCEL,
- self::SPRING_GDS,
- self::ECEXPRESS,
- self::INTERPARCEL_AU,
- self::AGILITY,
- self::XL_EXPRESS,
- self::ADERONLINE,
- self::DIRECTCOURIERS,
- self::PLANZER,
- self::SENDING,
- self::NINJAVAN_WB,
- self::NATIONWIDE_MY,
- self::SENDIT,
- self::GB_ARROW,
- self::IND_GOJAVAS,
- self::KPOST,
- self::DHL_FREIGHT,
- self::BLUECARE,
- self::JINDOUYUN,
- self::TRACKON,
- self::GB_TUFFNELLS,
- self::TRUMPCARD,
- self::ETOTAL,
- self::SFPLUS_WEBHOOK,
- self::SEKOLOGISTICS,
- self::HERMES_2MANN_HANDLING,
- self::DPD_LOCAL_REF,
- self::UDS,
- self::ZA_SPECIALISED_FREIGHT,
- self::THA_KERRY,
- self::PRT_INT_SEUR,
- self::BRA_CORREIOS,
- self::NZ_NZ_POST,
- self::CN_EQUICK,
- self::MYS_EMS,
- self::GB_NORSK,
- self::ESP_MRW,
- self::ESP_PACKLINK,
- self::KANGAROO_MY,
- self::RPX,
- self::XDP_UK_REFERENCE,
- self::NINJAVAN_MY,
- self::ADICIONAL,
- self::NINJAVAN_ID,
- self::ROADBULL,
- self::YAKIT,
- self::MAILAMERICAS,
- self::MIKROPAKKET,
- self::DYNALOGIC,
- self::DHL_ES,
- self::DHL_PARCEL_NL,
- self::DHL_GLOBAL_MAIL_ASIA,
- self::DAWN_WING,
- self::GENIKI_GR,
- self::HERMESWORLD_UK,
- self::ALPHAFAST,
- self::BUYLOGIC,
- self::EKART,
- self::MEX_SENDA,
- self::SFC_LOGISTICS,
- self::POST_SERBIA,
- self::IND_DELHIVERY,
- self::DE_DPD_DELISTRACK,
- self::RPD2MAN,
- self::CN_SF_EXPRESS,
- self::YANWEN,
- self::MYS_SKYNET,
- self::CORREOS_DE_MEXICO,
- self::CBL_LOGISTICA,
- self::MEX_ESTAFETA,
- self::AU_AUSTRIAN_POST,
- self::RINCOS,
- self::NLD_DHL,
- self::RUSSIAN_POST,
- self::COURIERS_PLEASE,
- self::POSTNORD_LOGISTICS,
- self::FEDEX,
- self::DPE_EXPRESS,
- self::DPD,
- self::ADSONE,
- self::IDN_JNE,
- self::THECOURIERGUY,
- self::CNEXPS,
- self::PRT_CHRONOPOST,
- self::LANDMARK_GLOBAL,
- self::IT_DHL_ECOMMERCE,
- self::ESP_NACEX,
- self::PRT_CTT,
- self::BE_KIALA,
- self::ASENDIA_UK,
- self::GLOBAL_TNT,
- self::POSTUR_IS,
- self::EPARCEL_KR,
- self::INPOST_PACZKOMATY,
- self::IT_POSTE_ITALIA,
- self::BE_BPOST,
- self::PL_POCZTA_POLSKA,
- self::MYS_MYS_POST,
- self::SG_SG_POST,
- self::THA_THAILAND_POST,
- self::LEXSHIP,
- self::FASTWAY_NZ,
- self::DHL_AU,
- self::COSTMETICSNOW,
- self::PFLOGISTICS,
- self::LOOMIS_EXPRESS,
- self::GLS_ITALY,
- self::LINE,
- self::GEL_EXPRESS,
- self::HUODULL,
- self::NINJAVAN_SG,
- self::JANIO,
- self::AO_COURIER,
- self::BRT_IT_SENDER_REF,
- self::SAILPOST,
- self::LALAMOVE,
- self::NEWZEALAND_COURIERS,
- self::ETOMARS,
- self::VIRTRANSPORT,
- self::WIZMO,
- self::PALLETWAYS,
- self::I_DIKA,
- self::CFL_LOGISTICS,
- self::GEMWORLDWIDE,
- self::GLOBAL_EXPRESS,
- self::LOGISTYX_TRANSGROUP,
- self::WESTBANK_COURIER,
- self::ARCO_SPEDIZIONI,
- self::YDH_EXPRESS,
- self::PARCELINKLOGISTICS,
- self::CNDEXPRESS,
- self::NOX_NIGHT_TIME_EXPRESS,
- self::AERONET,
- self::LTIANEXP,
- self::INTEGRA2_FTP,
- self::PARCELONE,
- self::NOX_NACHTEXPRESS,
- self::CN_CHINA_POST_EMS,
- self::CHUKOU1,
- self::GLS_SLOV,
- self::ORANGE_DS,
- self::JOOM_LOGIS,
- self::AUS_STARTRACK,
- self::DHL,
- self::GB_APC,
- self::BONDSCOURIERS,
- self::JPN_JAPAN_POST,
- self::USPS,
- self::WINIT,
- self::ARG_OCA,
- self::TW_TAIWAN_POST,
- self::DMM_NETWORK,
- self::TNT,
- self::BH_POSTA,
- self::SWE_POSTNORD,
- self::CA_CANADA_POST,
- self::WISELOADS,
- self::ASENDIA_HK,
- self::NLD_GLS,
- self::MEX_REDPACK,
- self::JET_SHIP,
- self::DE_DHL_EXPRESS,
- self::NINJAVAN_THAI,
- self::RABEN_GROUP,
- self::ESP_ASM,
- self::HRV_HRVATSKA,
- self::GLOBAL_ESTES,
- self::LTU_LIETUVOS,
- self::BEL_DHL,
- self::AU_AU_POST,
- self::SPEEDEXCOURIER,
- self::FR_COLIS,
- self::ARAMEX,
- self::DPEX,
- self::MYS_AIRPAK,
- self::CUCKOOEXPRESS,
- self::DPD_POLAND,
- self::NLD_POSTNL,
- self::NIM_EXPRESS,
- self::QUANTIUM,
- self::SENDLE,
- self::ESP_REDUR,
- self::MATKAHUOLTO,
- self::CPACKET,
- self::POSTI,
- self::HUNTER_EXPRESS,
- self::CHOIR_EXP,
- self::LEGION_EXPRESS,
- self::AUSTRIAN_POST_EXPRESS,
- self::GRUPO,
- self::POSTA_RO,
- self::INTERPARCEL_UK,
- self::GLOBAL_ABF,
- self::POSTEN_NORGE,
- self::XPERT_DELIVERY,
- self::DHL_REFR,
- self::DHL_HK,
- self::SKYNET_UAE,
- self::GOJEK,
- self::YODEL_INTNL,
- self::JANCO,
- self::YTO,
- self::WISE_EXPRESS,
- self::JTEXPRESS_VN,
- self::FEDEX_INTL_MLSERV,
- self::VAMOX,
- self::AMS_GRP,
- self::DHL_JP,
- self::HRPARCEL,
- self::GESWL,
- self::BLUESTAR,
- self::CDEK_TR,
- self::DESCARTES,
- self::DELTEC_UK,
- self::DTDC_EXPRESS,
- self::TOURLINE,
- self::BH_WORLDWIDE,
- self::OCS,
- self::YINGNUO_LOGISTICS,
- self::UPS,
- self::TOLL,
- self::PRT_SEUR,
- self::DTDC_AU,
- self::THA_DYNAMIC_LOGISTICS,
- self::UBI_LOGISTICS,
- self::FEDEX_CROSSBORDER,
- self::A1POST,
- self::TAZMANIAN_FREIGHT,
- self::CJ_INT_MY,
- self::SAIA_FREIGHT,
- self::SG_QXPRESS,
- self::NHANS_SOLUTIONS,
- self::DPD_FR,
- self::COORDINADORA,
- self::ANDREANI,
- self::DOORA,
- self::INTERPARCEL_NZ,
- self::PHL_JAMEXPRESS,
- self::BEL_BELGIUM_POST,
- self::US_APC,
- self::IDN_POS,
- self::FR_MONDIAL,
- self::DE_DHL,
- self::HK_RPX,
- self::DHL_PIECEID,
- self::VNPOST_EMS,
- self::RRDONNELLEY,
- self::DPD_DE,
- self::DELCART_IN,
- self::IMEXGLOBALSOLUTIONS,
- self::ACOMMERCE,
- self::EURODIS,
- self::CANPAR,
- self::GLS,
- self::IND_ECOM,
- self::ESP_ENVIALIA,
- self::DHL_UK,
- self::SMSA_EXPRESS,
- self::TNT_FR,
- self::DEX_I,
- self::BUDBEE_WEBHOOK,
- self::COPA_COURIER,
- self::VNM_VIETNAM_POST,
- self::DPD_HK,
- self::TOLL_NZ,
- self::ECHO_,
- self::FEDEX_FR,
- self::BORDEREXPRESS,
- self::MAILPLUS_JPN,
- self::TNT_UK_REFR,
- self::KEC,
- self::DPD_RO,
- self::TNT_JP,
- self::TH_CJ,
- self::EC_CN,
- self::FASTWAY_UK,
- self::FASTWAY_US,
- self::GLS_DE,
- self::GLS_ES,
- self::GLS_FR,
- self::MONDIAL_BE,
- self::SGT_IT,
- self::TNT_CN,
- self::TNT_DE,
- self::TNT_ES,
- self::TNT_PL,
- self::PARCELFORCE,
- self::SWISS_POST,
- self::TOLL_IPEC,
- self::AIR_21,
- self::AIRSPEED,
- self::BERT,
- self::BLUEDART,
- self::COLLECTPLUS,
- self::COURIERPLUS,
- self::COURIER_POST,
- self::DHL_GLOBAL_MAIL,
- self::DPD_UK,
- self::DELTEC_DE,
- self::DEUTSCHE_DE,
- self::DOTZOT,
- self::ELTA_GR,
- self::EMS_CN,
- self::ECARGO,
- self::ENSENDA,
- self::FERCAM_IT,
- self::FASTWAY_ZA,
- self::FASTWAY_AU,
- self::FIRST_LOGISITCS,
- self::GEODIS,
- self::GLOBEGISTICS,
- self::GREYHOUND,
- self::JETSHIP_MY,
- self::LION_PARCEL,
- self::AEROFLASH,
- self::ONTRAC,
- self::SAGAWA,
- self::SIODEMKA,
- self::STARTRACK,
- self::TNT_AU,
- self::TNT_IT,
- self::TRANSMISSION,
- self::YAMATO,
- self::DHL_IT,
- self::DHL_AT,
- self::LOGISTICSWORLDWIDE_KR,
- self::GLS_SPAIN,
- self::AMAZON_UK_API,
- self::DPD_FR_REFERENCE,
- self::DHLPARCEL_UK,
- self::MEGASAVE,
- self::QUALITYPOST,
- self::IDS_LOGISTICS,
- self::JOYINGBOX1,
- self::PANTHER_ORDER_NUMBER,
- self::WATKINS_SHEPARD,
- self::FASTTRACK,
- self::UP_EXPRESS,
- self::ELOGISTICA,
- self::ECOURIER,
- self::CJ_PHILIPPINES,
- self::SPEEDEX,
- self::ORANGECONNEX,
- self::TECOR,
- self::SAEE,
- self::GLS_ITALY_FTP,
- self::DELIVERE,
- self::YYCOM,
- self::ADICIONAL_PT,
- self::DKSH,
- self::NIPPON_EXPRESS_FTP,
- self::GOLS,
- self::FUJEXP,
- self::QTRACK,
- self::OMLOGISTICS_API,
- self::GDPHARM,
- self::MISUMI_CN,
- self::AIR_CANADA,
- self::CITY56_WEBHOOK,
- self::SAGAWA_API,
- self::KEDAEX,
- self::PGEON_API,
- self::WEWORLDEXPRESS,
- self::JT_LOGISTICS,
- self::TRUSK,
- self::VIAXPRESS,
- self::DHL_SUPPLYCHAIN_ID,
- self::ZUELLIGPHARMA_SFTP,
- self::MEEST,
- self::TOLL_PRIORITY,
- self::MOTHERSHIP_API,
- self::CAPITAL,
- self::EUROPAKET_API,
- self::HFD,
- self::TOURLINE_REFERENCE,
- self::GIO_ECOURIER,
- self::CN_LOGISTICS,
- self::PANDION,
- self::BPOST_API,
- self::PASSPORTSHIPPING,
- self::PAKAJO,
- self::DACHSER,
- self::YUSEN_SFTP,
- self::SHYPLITE,
- self::XYY,
- self::MWD,
- self::FAXECARGO,
- self::MAZET,
- self::FIRST_LOGISTICS_API,
- self::SPRINT_PACK,
- self::HERMES_DE_FTP,
- self::CONCISE,
- self::KERRY_EXPRESS_TW_API,
- self::EWE,
- self::FASTDESPATCH,
- self::ABCUSTOM_SFTP,
- self::CHAZKI,
- self::SHIPPIE,
- self::GEODIS_API,
- self::NAQEL_EXPRESS,
- self::PAPA_WEBHOOK,
- self::FORWARDAIR,
- self::DIALOGO_LOGISTICA_API,
- self::LALAMOVE_API,
- self::TOMYDOOR,
- self::KRONOS_WEBHOOK,
- self::JTCARGO,
- self::T_CAT,
- self::CONCISE_WEBHOOK,
- self::TELEPORT_WEBHOOK,
- self::CUSTOMCO_API,
- self::SPX_TH,
- self::BOLLORE_LOGISTICS,
- self::CLICKLINK_SFTP,
- self::M3LOGISTICS,
- self::VNPOST_API,
- self::AXLEHIRE_FTP,
- self::SHADOWFAX,
- self::MYHERMES_UK_API,
- self::DAIICHI,
- self::MENSAJEROSURBANOS_API,
- self::POLARSPEED,
- self::IDEXPRESS_ID,
- self::PAYO,
- self::WHISTL_SFTP,
- self::INTEX_DE,
- self::TRANS2U,
- self::PRODUCTCAREGROUP_SFTP,
- self::BIGSMART,
- self::EXPEDITORS_API_REF,
- self::AITWORLDWIDE_API,
- self::WORLDCOURIER,
- self::QUIQUP,
- self::AGEDISS_SFTP,
- self::ANDREANI_API,
- self::CRLEXPRESS,
- self::SMARTCAT,
- self::CROSSFLIGHT,
- self::PROCARRIER,
- self::DHL_REFERENCE_API,
- self::SEINO_API,
- self::WSPEXPRESS,
- self::KRONOS,
- self::TOTAL_EXPRESS_API,
- self::PARCLL,
- self::XPEDIGO,
- self::STAR_TRACK_WEBHOOK,
- self::GPOST,
- self::UCS,
- self::DMFGROUP,
- self::COORDINADORA_API,
- self::MARKEN,
- self::NTL,
- self::REDJEPAKKETJE,
- self::ALLIED_EXPRESS_FTP,
- self::MONDIALRELAY_ES,
- self::NAEKO_FTP,
- self::MHI,
- self::SHIPPIFY,
- self::MALCA_AMIT_API,
- self::JTEXPRESS_SG_API,
- self::DACHSER_WEB,
- self::FLIGHTLG,
- self::CAGO,
- self::COM1EXPRESS,
- self::TONAMI_FTP,
- self::PACKFLEET,
- self::PUROLATOR_INTERNATIONAL,
- self::WINESHIPPING_WEBHOOK,
- self::DHL_ES_SFTP,
- self::PCHOME_API,
- self::CESKAPOSTA_API,
- self::GORUSH,
- self::HOMERUNNER,
- self::AMAZON_ORDER,
- self::EFWNOW_API,
- self::CBL_LOGISTICA_API,
- self::NIMBUSPOST,
- self::LOGWIN_LOGISTICS,
- self::NOWLOG_API,
- self::DPD_NL,
- self::GODEPENDABLE,
- self::ESDEX,
- self::LOGISYSTEMS_SFTP,
- self::EXPEDITORS,
- self::SNTGLOBAL_API,
- self::SHIPX,
- self::QINTL_API,
- self::PACKS,
- self::POSTNL_INTERNATIONAL,
- self::AMAZON_EMAIL_PUSH,
- self::DHL_API,
- self::SPX,
- self::AXLEHIRE,
- self::ICSCOURIER,
- self::DIALOGO_LOGISTICA,
- self::SHUNBANG_EXPRESS,
- self::TCS_API,
- self::SF_EXPRESS_CN,
- self::PACKETA,
- self::SIC_TELIWAY,
- self::MONDIALRELAY_FR,
- self::INTIME_FTP,
- self::JD_EXPRESS,
- self::FASTBOX,
- self::PATHEON,
- self::INDIA_POST,
- self::TIPSA_REF,
- self::ECOFREIGHT,
- self::VOX,
- self::DIRECTFREIGHT_AU_REF,
- self::BESTTRANSPORT_SFTP,
- self::AUSTRALIA_POST_API,
- self::FRAGILEPAK_SFTP,
- self::FLIPXP,
- self::VALUE_WEBHOOK,
- self::DAESHIN,
- self::SHERPA,
- self::MWD_API,
- self::SMARTKARGO,
- self::DNJ_EXPRESS,
- self::GOPEOPLE,
- self::MYSENDLE_API,
- self::ARAMEX_API,
- self::PIDGE,
- self::THAIPARCELS,
- self::PANTHER_REFERENCE_API,
- self::POSTAPLUS1,
- self::BUFFALO,
- self::U_ENVIOS,
- self::ELITE_CO,
- self::BARQEXP,
- self::ROCHE_INTERNAL_SFTP,
- self::DBSCHENKER_ICELAND,
- self::TNT_FR_REFERENCE,
- self::NEWGISTICSAPI,
- self::GLOVO,
- self::GWLOGIS_API,
- self::SPREETAIL_API,
- self::MOOVA,
- self::PLYCONGROUP,
- self::USPS_WEBHOOK,
- self::REIMAGINEDELIVERY,
- self::EDF_FTP,
- self::DAO365,
- self::BIOCAIR_FTP,
- self::RANSA_WEBHOOK,
- self::SHIPXPRES,
- self::COURANT_PLUS_API,
- self::SHIPA,
- self::HOMELOGISTICS,
- self::DX,
- self::POSTE_ITALIANE_PACCOCELERE,
- self::TOLL_WEBHOOK,
- self::LCTBR_API,
- self::DX_FREIGHT,
- self::DHL_SFTP,
- self::SHIPROCKET,
- self::UBER_WEBHOOK,
- self::STATOVERNIGHT,
- self::BURD,
- self::FASTSHIP,
- self::IBVENTURE_WEBHOOK,
- self::GATI_KWE_API,
- self::CRYOPDP_FTP,
- self::HUBBED,
- self::TIPSA_API,
- self::ARASKARGO,
- self::THIJS_NL,
- self::ATSHEALTHCARE_REFERENCE,
- self::ENUM_99MINUTOS,
- self::HELLENIC_POST,
- self::HSM_GLOBAL,
- self::MNX,
- self::NMTRANSFER,
- self::LOGYSTO,
- self::INDIA_POST_INT,
- self::AMAZON_FBA_SWISHIP_IN,
- self::SRT_TRANSPORT,
- self::BOMI,
- self::DELIVERR_SFTP,
- self::HSDEXPRESS,
- self::SIMPLETIRE_WEBHOOK,
- self::HUNTER_EXPRESS_SFTP,
- self::UPS_API,
- self::WOOYOUNG_LOGISTICS_SFTP,
- self::PHSE_API,
- self::WISH_EMAIL_PUSH,
- self::NORTHLINE,
- self::MEDAFRICA,
- self::DPD_AT_SFTP,
- self::ANTERAJA,
- self::DHL_GLOBAL_FORWARDING_API,
- self::LBCEXPRESS_API,
- self::SIMSGLOBAL,
- self::CDLDELIVERS,
- self::TYP,
- self::TESTING_COURIER_WEBHOOK,
- self::PANDAGO_API,
- self::ROYAL_MAIL_FTP,
- self::THUNDEREXPRESS,
- self::SECRETLAB_WEBHOOK,
- self::SETEL,
- self::JD_WORLDWIDE,
- self::DPD_RU_API,
- self::ARGENTS_WEBHOOK,
- self::POSTONE,
- self::TUSKLOGISTICS,
- self::RHENUS_UK_API,
- self::TAQBIN_SG_API,
- self::INNTRALOG_SFTP,
- self::DAYROSS,
- self::CORREOSEXPRESS_API,
- self::INTERNATIONAL_SEUR_API,
- self::YODEL_API,
- self::HEROEXPRESS,
- self::DHL_SUPPLYCHAIN_IN,
- self::URGENT_CARGUS,
- self::FRONTDOORCORP,
- self::JTEXPRESS_PH,
- self::PARCELSTARS_WEBHOOK,
- self::DPD_SK_SFTP,
- self::MOVIANTO,
- self::OZEPARTS_SHIPPING,
- self::KARGOMKOLAY,
- self::TRUNKRS,
- self::OMNIRPS_WEBHOOK,
- self::CHILEXPRESS,
- self::TESTING_COURIER,
- self::JNE_API,
- self::BJSHOMEDELIVERY_FTP,
- self::DEXPRESS_WEBHOOK,
- self::USPS_API,
- self::TRANSVIRTUAL,
- self::SOLISTICA_API,
- self::CHIENVENTURE_WEBHOOK,
- self::DPD_UK_SFTP,
- self::INPOST_UK,
- self::JAVIT,
- self::ZTO_DOMESTIC,
- self::DHL_GT_API,
- self::CEVA_TRACKING,
- self::KOMON_EXPRESS,
- self::EASTWESTCOURIER_FTP,
- self::DANNIAO,
- self::SPECTRAN,
- self::DELIVER_IT,
- self::RELAISCOLIS,
- self::GLS_SPAIN_API,
- self::POSTPLUS,
- self::AIRTERRA,
- self::GIO_ECOURIER_API,
- self::DPD_CH_SFTP,
- self::FEDEX_API,
- self::INTERSMARTTRANS,
- self::HERMES_UK_SFTP,
- self::EXELOT_FTP,
- self::DHL_PA_API,
- self::VIRTRANSPORT_SFTP,
- self::WORLDNET,
- self::INSTABOX_WEBHOOK,
- self::KNG,
- self::FLASHEXPRESS_WEBHOOK,
- self::MAGYAR_POSTA_API,
- self::WESHIP_API,
- self::OHI_WEBHOOK,
- self::MUDITA,
- self::BLUEDART_API,
- self::T_CAT_API,
- self::ADS,
- self::HERMES_IT,
- self::FITZMARK_API,
- self::POSTI_API,
- self::SMSA_EXPRESS_WEBHOOK,
- self::TAMERGROUP_WEBHOOK,
- self::LIVRAPIDE,
- self::NIPPON_EXPRESS,
- self::BETTERTRUCKS,
- self::FAN,
- self::PB_USPSFLATS_FTP,
- self::PARCELRIGHT,
- self::ITHINKLOGISTICS,
- self::KERRY_EXPRESS_TH_WEBHOOK,
- self::ECOUTIER,
- self::SHOWL,
- self::BRT_IT_API,
- self::RIXONHK_API,
- self::DBSCHENKER_API,
- self::ILYANGLOGIS,
- self::MAIL_BOX_ETC,
- self::WESHIP,
- self::DHL_GLOBAL_MAIL_API,
- self::ACTIVOS24_API,
- self::ATSHEALTHCARE,
- self::LUWJISTIK,
- self::GW_WORLD,
- self::FAIRSENDEN_API,
- self::SERVIP_WEBHOOK,
- self::SWISHIP,
- self::TANET,
- self::HOTSIN_CARGO,
- self::DIREX,
- self::HUANTONG,
- self::IMILE_API,
- self::BDMNET,
- self::AUEXPRESS,
- self::NYTLOGISTICS,
- self::DSV_REFERENCE,
- self::NOVOFARMA_WEBHOOK,
- self::AITWORLDWIDE_SFTP,
- self::SHOPOLIVE,
- self::FNF_ZA,
- self::DHL_ECOMMERCE_GC,
- self::FETCHR,
- self::STARLINKS_API,
- self::YYEXPRESS,
- self::SERVIENTREGA,
- self::HANJIN,
- self::SPANISH_SEUR_FTP,
- self::DX_B2B_CONNUM,
- self::HELTHJEM_API,
- self::INEXPOST,
- self::A2B_BA,
- self::RHENUS_GROUP,
- self::SBERLOGISTICS_RU,
- self::MALCA_AMIT,
- self::PPL,
- self::OSM_WORLDWIDE_SFTP,
- self::ACILOGISTIX,
- self::OPTIMACOURIER,
- self::NOVA_POSHTA_API,
- self::LOGGI,
- self::YIFAN,
- self::MYDYNALOGIC,
- self::MORNINGLOBAL,
- self::CONCISE_API,
- self::FXTRAN,
- self::DELIVERYOURPARCEL_ZA,
- self::UPARCEL,
- self::MOBI_BR,
- self::LOGINEXT_WEBHOOK,
- self::EMS,
- self::SPEEDY,
- self::ZOOM_RED,
- self::NAVLUNGO,
- self::CASTLEPARCELS,
- self::WEEE,
- self::PACKALY,
- self::YUNHUIPOST,
- self::YOUPARCEL,
- self::LEMAN,
- self::MOOVIN,
- self::URB_IT,
- self::MULTIENTREGAPANAMA,
- self::JUSDASR,
- self::DISCOUNTPOST,
- self::RHENUS_UK,
- self::SWISHIP_JP,
- self::GLS_US,
- self::SMTL,
- self::EMEGA,
- self::EXPRESSONE_SV,
- self::HEPSIJET,
- self::WELIVERY,
- self::BRINGER,
- self::EASYROUTES,
- self::MRW,
- self::RPM,
- self::DPD_PRT,
- self::GLS_ROMANIA,
- self::LMPARCEL,
- self::GTAGSM,
- self::DOMINO,
- self::ESHIPPER,
- self::TRANSPAK,
- self::XINDUS,
- self::AOYUE,
- self::EASYPARCEL,
- self::EXPRESSONE,
- self::SENDEO_KARGO,
- self::SPEEDAF,
- self::ETOWER,
- self::GCX,
- self::NINJAVAN_VN,
- self::ALLEGRO,
- self::JUMPPOINT,
- self::SHIPGLOBAL_US,
- self::KINISI,
- self::OAKH,
- self::AWEST,
- self::BARSAN,
- self::ENERGOLOGISTIC,
- self::MADROOEX,
- self::GOBOLT,
- self::SWISS_UNIVERSAL_EXPRESS,
- self::IORDIRECT,
- self::XMSZM,
- self::GLS_HUN,
- self::SENDY,
- self::BRAUNSEXPRESS,
- self::GRANDSLAMEXPRESS,
- self::XGS,
- self::OTSCHILE,
- self::PACK_UP,
- self::PARCELSTARS,
- self::TEAMEXPRESSLLC,
- self::ASYADEXPRESS,
- self::TDN,
- self::EARLYBIRD,
- self::CACESA,
- self::PARCELJET,
- self::MNG_KARGO,
- self::SUPERPACKLINE,
- self::SPEEDX,
- self::VESYL,
- self::SKYKING,
- self::DIRMENSAJERIA,
- self::NETLOGIXGROUP,
- self::ZYOU,
- self::JAWAR,
- self::AGSYSTEMS,
- self::GPS,
- self::PTT_KARGO,
- self::MAERGO,
- self::ARIHANTCOURIER,
- self::VTFE,
- self::YUNANT,
- self::URBIFY,
- self::PACK_MAN,
- self::LIEFERGRUN,
- self::OBIBOX,
- self::PAIKEDA,
- self::SCOTTY,
- self::INTELCOM_CA,
- self::SWE,
- self::ASENDIA,
- self::DPD_AT,
- self::RELAY,
- self::ATA,
- self::SKYEXPRESS_INTERNATIONAL,
- self::SURAT_KARGO,
- self::SGLINK,
- self::FLEETOPTICSINC,
- self::SHOPLINE,
- self::PIGGYSHIP,
- self::LOGOIX,
- self::KOLAY_GELSIN,
- self::ASSOCIATED_COURIERS,
- self::UPS_CHECKER,
- self::WINESHIPPING,
- self::SPEDISCI
- ];
-
/**
- * Ensures that all the given values are present in this Enum.
- *
- * @param array|stdClass|null|string $value Value or a list/map of values to be checked
- *
- * @return array|null|string Input value(s), if all are a part of this Enum
- *
- * @throws Exception Throws exception if any given value is not in this Enum
+ * Spedisci online.
*/
- public static function checkValue($value)
- {
- $value = json_decode(json_encode($value), true); // converts stdClass into array
- if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) {
- return $value;
- }
- throw new Exception("$value is invalid for ShipmentCarrier.");
- }
+ public const SPEDISCI = 'SPEDISCI';
}
diff --git a/src/Models/ShippingDetails.php b/src/Models/ShippingDetails.php
index c77ff8e..fad71dc 100644
--- a/src/Models/ShippingDetails.php
+++ b/src/Models/ShippingDetails.php
@@ -10,6 +10,7 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
+use PaypalServerSdkLib\ApiHelper;
use stdClass;
/**
@@ -22,6 +23,11 @@ class ShippingDetails implements \JsonSerializable
*/
private $name;
+ /**
+ * @var string|null
+ */
+ private $emailAddress;
+
/**
* @var PhoneNumberWithCountryCode|null
*/
@@ -62,6 +68,30 @@ class ShippingDetails implements \JsonSerializable
$this->name = $name;
}
+ /**
+ * Returns Email Address.
+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters
+ * are allowed after the @ sign. However, the generally accepted maximum length for an email address is
+ * 254 characters. The pattern verifies that an unquoted @ sign exists.
+ */
+ public function getEmailAddress(): ?string
+ {
+ return $this->emailAddress;
+ }
+
+ /**
+ * Sets Email Address.
+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters
+ * are allowed after the @ sign. However, the generally accepted maximum length for an email address is
+ * 254 characters. The pattern verifies that an unquoted @ sign exists.
+ *
+ * @maps email_address
+ */
+ public function setEmailAddress(?string $emailAddress): void
+ {
+ $this->emailAddress = $emailAddress;
+ }
+
/**
* Returns Phone Number.
* The phone number in its canonical international [E.164 numbering plan format](https://www.itu.
@@ -158,6 +188,26 @@ class ShippingDetails implements \JsonSerializable
$this->address = $address;
}
+ /**
+ * Converts the ShippingDetails object to a human-readable string representation.
+ *
+ * @return string The string representation of the ShippingDetails object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify(
+ 'ShippingDetails',
+ [
+ 'name' => $this->name,
+ 'emailAddress' => $this->emailAddress,
+ 'phoneNumber' => $this->phoneNumber,
+ 'type' => $this->type,
+ 'options' => $this->options,
+ 'address' => $this->address
+ ]
+ );
+ }
+
/**
* Encode this object to JSON
*
@@ -171,19 +221,22 @@ class ShippingDetails implements \JsonSerializable
{
$json = [];
if (isset($this->name)) {
- $json['name'] = $this->name;
+ $json['name'] = $this->name;
+ }
+ if (isset($this->emailAddress)) {
+ $json['email_address'] = $this->emailAddress;
}
if (isset($this->phoneNumber)) {
- $json['phone_number'] = $this->phoneNumber;
+ $json['phone_number'] = $this->phoneNumber;
}
if (isset($this->type)) {
- $json['type'] = FulfillmentType::checkValue($this->type);
+ $json['type'] = $this->type;
}
if (isset($this->options)) {
- $json['options'] = $this->options;
+ $json['options'] = $this->options;
}
if (isset($this->address)) {
- $json['address'] = $this->address;
+ $json['address'] = $this->address;
}
return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json;
diff --git a/src/Models/ShippingName.php b/src/Models/ShippingName.php
index 9becf00..81b7a20 100644
--- a/src/Models/ShippingName.php
+++ b/src/Models/ShippingName.php
@@ -10,6 +10,7 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
+use PaypalServerSdkLib\ApiHelper;
use stdClass;
/**
@@ -42,6 +43,16 @@ class ShippingName implements \JsonSerializable
$this->fullName = $fullName;
}
+ /**
+ * Converts the ShippingName object to a human-readable string representation.
+ *
+ * @return string The string representation of the ShippingName object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify('ShippingName', ['fullName' => $this->fullName]);
+ }
+
/**
* Encode this object to JSON
*
diff --git a/src/Models/ShippingOption.php b/src/Models/ShippingOption.php
index a2db008..82eec53 100644
--- a/src/Models/ShippingOption.php
+++ b/src/Models/ShippingOption.php
@@ -10,6 +10,7 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
+use PaypalServerSdkLib\ApiHelper;
use stdClass;
/**
@@ -169,6 +170,25 @@ class ShippingOption implements \JsonSerializable
$this->selected = $selected;
}
+ /**
+ * Converts the ShippingOption object to a human-readable string representation.
+ *
+ * @return string The string representation of the ShippingOption object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify(
+ 'ShippingOption',
+ [
+ 'id' => $this->id,
+ 'label' => $this->label,
+ 'type' => $this->type,
+ 'amount' => $this->amount,
+ 'selected' => $this->selected
+ ]
+ );
+ }
+
/**
* Encode this object to JSON
*
@@ -184,7 +204,7 @@ class ShippingOption implements \JsonSerializable
$json['id'] = $this->id;
$json['label'] = $this->label;
if (isset($this->type)) {
- $json['type'] = ShippingType::checkValue($this->type);
+ $json['type'] = $this->type;
}
if (isset($this->amount)) {
$json['amount'] = $this->amount;
diff --git a/src/Models/ShippingOptionsPurchaseUnit.php b/src/Models/ShippingOptionsPurchaseUnit.php
new file mode 100644
index 0000000..11918d2
--- /dev/null
+++ b/src/Models/ShippingOptionsPurchaseUnit.php
@@ -0,0 +1,157 @@
+referenceId;
+ }
+
+ /**
+ * Sets Reference Id.
+ * The API caller-provided external ID for the purchase unit. Required for multiple purchase units when
+ * you must update the order through `PATCH`. If you omit this value and the order contains only one
+ * purchase unit, PayPal sets this value to `default`. Note: If there are multiple purchase units,
+ * reference_id is required for each purchase unit.
+ *
+ * @maps reference_id
+ */
+ public function setReferenceId(?string $referenceId): void
+ {
+ $this->referenceId = $referenceId;
+ }
+
+ /**
+ * Returns Amount.
+ * The total order amount with an optional breakdown that provides details, such as the total item
+ * amount, total tax amount, shipping, handling, insurance, and discounts, if any. If you specify
+ * `amount.breakdown`, the amount equals `item_total` plus `tax_total` plus `shipping` plus `handling`
+ * plus `insurance` minus `shipping_discount` minus discount. The amount must be a positive number. For
+ * listed of supported currencies and decimal precision, see the PayPal REST APIs Currency Codes.
+ */
+ public function getAmount(): ?AmountWithBreakdown
+ {
+ return $this->amount;
+ }
+
+ /**
+ * Sets Amount.
+ * The total order amount with an optional breakdown that provides details, such as the total item
+ * amount, total tax amount, shipping, handling, insurance, and discounts, if any. If you specify
+ * `amount.breakdown`, the amount equals `item_total` plus `tax_total` plus `shipping` plus `handling`
+ * plus `insurance` minus `shipping_discount` minus discount. The amount must be a positive number. For
+ * listed of supported currencies and decimal precision, see the PayPal REST APIs Currency Codes.
+ *
+ * @maps amount
+ */
+ public function setAmount(?AmountWithBreakdown $amount): void
+ {
+ $this->amount = $amount;
+ }
+
+ /**
+ * Returns Shipping Options.
+ * An array of shipping options that the payee or merchant offers to the payer to ship or pick up their
+ * items.
+ *
+ * @return ShippingOption[]|null
+ */
+ public function getShippingOptions(): ?array
+ {
+ return $this->shippingOptions;
+ }
+
+ /**
+ * Sets Shipping Options.
+ * An array of shipping options that the payee or merchant offers to the payer to ship or pick up their
+ * items.
+ *
+ * @maps shipping_options
+ *
+ * @param ShippingOption[]|null $shippingOptions
+ */
+ public function setShippingOptions(?array $shippingOptions): void
+ {
+ $this->shippingOptions = $shippingOptions;
+ }
+
+ /**
+ * Converts the ShippingOptionsPurchaseUnit object to a human-readable string representation.
+ *
+ * @return string The string representation of the ShippingOptionsPurchaseUnit object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify(
+ 'ShippingOptionsPurchaseUnit',
+ [
+ 'referenceId' => $this->referenceId,
+ 'amount' => $this->amount,
+ 'shippingOptions' => $this->shippingOptions
+ ]
+ );
+ }
+
+ /**
+ * Encode this object to JSON
+ *
+ * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields
+ * are set. (default: false)
+ *
+ * @return array|stdClass
+ */
+ #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1)
+ public function jsonSerialize(bool $asArrayWhenEmpty = false)
+ {
+ $json = [];
+ if (isset($this->referenceId)) {
+ $json['reference_id'] = $this->referenceId;
+ }
+ if (isset($this->amount)) {
+ $json['amount'] = $this->amount;
+ }
+ if (isset($this->shippingOptions)) {
+ $json['shipping_options'] = $this->shippingOptions;
+ }
+
+ return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json;
+ }
+}
diff --git a/src/Models/ShippingPreference.php b/src/Models/ShippingPreference.php
index dabbf45..c645c60 100644
--- a/src/Models/ShippingPreference.php
+++ b/src/Models/ShippingPreference.php
@@ -10,38 +10,24 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
-use Core\Utils\CoreHelper;
-use Exception;
-use stdClass;
-
/**
* The location from which the shipping address is derived.
*/
class ShippingPreference
{
+ /**
+ * Get the customer-provided shipping address on the PayPal site.
+ */
public const GET_FROM_FILE = 'GET_FROM_FILE';
+ /**
+ * Redacts the shipping address from the PayPal site. Recommended for digital goods.
+ */
public const NO_SHIPPING = 'NO_SHIPPING';
- public const SET_PROVIDED_ADDRESS = 'SET_PROVIDED_ADDRESS';
-
- private const _ALL_VALUES = [self::GET_FROM_FILE, self::NO_SHIPPING, self::SET_PROVIDED_ADDRESS];
-
/**
- * Ensures that all the given values are present in this Enum.
- *
- * @param array|stdClass|null|string $value Value or a list/map of values to be checked
- *
- * @return array|null|string Input value(s), if all are a part of this Enum
- *
- * @throws Exception Throws exception if any given value is not in this Enum
+ * Get the merchant-provided address. The customer cannot change this address on the PayPal site. If
+ * merchant does not pass an address, customer can choose the address on PayPal pages.
*/
- public static function checkValue($value)
- {
- $value = json_decode(json_encode($value), true); // converts stdClass into array
- if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) {
- return $value;
- }
- throw new Exception("$value is invalid for ShippingPreference.");
- }
+ public const SET_PROVIDED_ADDRESS = 'SET_PROVIDED_ADDRESS';
}
diff --git a/src/Models/ShippingType.php b/src/Models/ShippingType.php
index decc726..130ad89 100644
--- a/src/Models/ShippingType.php
+++ b/src/Models/ShippingType.php
@@ -10,40 +10,33 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
-use Core\Utils\CoreHelper;
-use Exception;
-use stdClass;
-
/**
* A classification for the method of purchase fulfillment.
*/
class ShippingType
{
+ /**
+ * The payer intends to receive the items at a specified address.
+ */
public const SHIPPING = 'SHIPPING';
+ /**
+ * DEPRECATED. To ensure that seller protection is correctly assigned, please use 'PICKUP_IN_STORE' or
+ * 'PICKUP_FROM_PERSON' instead. Currently, this field indicates that the payer intends to pick up the
+ * items at a specified address (ie. a store address).
+ */
public const PICKUP = 'PICKUP';
+ /**
+ * The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, "Buy
+ * Online, Pick-up in Store". Seller protection is provided with this option.
+ */
public const PICKUP_IN_STORE = 'PICKUP_IN_STORE';
- public const PICKUP_FROM_PERSON = 'PICKUP_FROM_PERSON';
-
- private const _ALL_VALUES = [self::SHIPPING, self::PICKUP, self::PICKUP_IN_STORE, self::PICKUP_FROM_PERSON];
-
/**
- * Ensures that all the given values are present in this Enum.
- *
- * @param array|stdClass|null|string $value Value or a list/map of values to be checked
- *
- * @return array|null|string Input value(s), if all are a part of this Enum
- *
- * @throws Exception Throws exception if any given value is not in this Enum
+ * The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, "Buy Online,
+ * Pick-up in Person". Seller protection is not available, since the payer is receiving the item from
+ * the payee in person, and can validate the item prior to payment.
*/
- public static function checkValue($value)
- {
- $value = json_decode(json_encode($value), true); // converts stdClass into array
- if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) {
- return $value;
- }
- throw new Exception("$value is invalid for ShippingType.");
- }
+ public const PICKUP_FROM_PERSON = 'PICKUP_FROM_PERSON';
}
diff --git a/src/Models/ShippingWithTrackingDetails.php b/src/Models/ShippingWithTrackingDetails.php
index 072d79a..025ada7 100644
--- a/src/Models/ShippingWithTrackingDetails.php
+++ b/src/Models/ShippingWithTrackingDetails.php
@@ -10,6 +10,7 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
+use PaypalServerSdkLib\ApiHelper;
use stdClass;
/**
@@ -22,6 +23,11 @@ class ShippingWithTrackingDetails implements \JsonSerializable
*/
private $name;
+ /**
+ * @var string|null
+ */
+ private $emailAddress;
+
/**
* @var PhoneNumberWithCountryCode|null
*/
@@ -67,6 +73,30 @@ class ShippingWithTrackingDetails implements \JsonSerializable
$this->name = $name;
}
+ /**
+ * Returns Email Address.
+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters
+ * are allowed after the @ sign. However, the generally accepted maximum length for an email address is
+ * 254 characters. The pattern verifies that an unquoted @ sign exists.
+ */
+ public function getEmailAddress(): ?string
+ {
+ return $this->emailAddress;
+ }
+
+ /**
+ * Sets Email Address.
+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters
+ * are allowed after the @ sign. However, the generally accepted maximum length for an email address is
+ * 254 characters. The pattern verifies that an unquoted @ sign exists.
+ *
+ * @maps email_address
+ */
+ public function setEmailAddress(?string $emailAddress): void
+ {
+ $this->emailAddress = $emailAddress;
+ }
+
/**
* Returns Phone Number.
* The phone number in its canonical international [E.164 numbering plan format](https://www.itu.
@@ -187,6 +217,27 @@ class ShippingWithTrackingDetails implements \JsonSerializable
$this->trackers = $trackers;
}
+ /**
+ * Converts the ShippingWithTrackingDetails object to a human-readable string representation.
+ *
+ * @return string The string representation of the ShippingWithTrackingDetails object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify(
+ 'ShippingWithTrackingDetails',
+ [
+ 'name' => $this->name,
+ 'emailAddress' => $this->emailAddress,
+ 'phoneNumber' => $this->phoneNumber,
+ 'type' => $this->type,
+ 'options' => $this->options,
+ 'address' => $this->address,
+ 'trackers' => $this->trackers
+ ]
+ );
+ }
+
/**
* Encode this object to JSON
*
@@ -200,22 +251,25 @@ class ShippingWithTrackingDetails implements \JsonSerializable
{
$json = [];
if (isset($this->name)) {
- $json['name'] = $this->name;
+ $json['name'] = $this->name;
+ }
+ if (isset($this->emailAddress)) {
+ $json['email_address'] = $this->emailAddress;
}
if (isset($this->phoneNumber)) {
- $json['phone_number'] = $this->phoneNumber;
+ $json['phone_number'] = $this->phoneNumber;
}
if (isset($this->type)) {
- $json['type'] = FulfillmentType::checkValue($this->type);
+ $json['type'] = $this->type;
}
if (isset($this->options)) {
- $json['options'] = $this->options;
+ $json['options'] = $this->options;
}
if (isset($this->address)) {
- $json['address'] = $this->address;
+ $json['address'] = $this->address;
}
if (isset($this->trackers)) {
- $json['trackers'] = $this->trackers;
+ $json['trackers'] = $this->trackers;
}
return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json;
diff --git a/src/Models/SofortPaymentObject.php b/src/Models/SofortPaymentObject.php
index 793420b..00373e6 100644
--- a/src/Models/SofortPaymentObject.php
+++ b/src/Models/SofortPaymentObject.php
@@ -10,6 +10,7 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
+use PaypalServerSdkLib\ApiHelper;
use stdClass;
/**
@@ -60,10 +61,9 @@ class SofortPaymentObject implements \JsonSerializable
/**
* Returns Country Code.
* The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country
- * or region.Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. */ public function getCountryCode(): ?string { @@ -73,10 +73,9 @@ class SofortPaymentObject implements \JsonSerializable /** * Sets Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. * * @maps country_code */ @@ -127,6 +126,24 @@ class SofortPaymentObject implements \JsonSerializable $this->ibanLastChars = $ibanLastChars; } + /** + * Converts the SofortPaymentObject object to a human-readable string representation. + * + * @return string The string representation of the SofortPaymentObject object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'SofortPaymentObject', + [ + 'name' => $this->name, + 'countryCode' => $this->countryCode, + 'bic' => $this->bic, + 'ibanLastChars' => $this->ibanLastChars + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/SofortPaymentRequest.php b/src/Models/SofortPaymentRequest.php index 6fbff04..d55467f 100644 --- a/src/Models/SofortPaymentRequest.php +++ b/src/Models/SofortPaymentRequest.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -66,10 +67,9 @@ class SofortPaymentRequest implements \JsonSerializable /** * Returns Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. */ public function getCountryCode(): string { @@ -79,10 +79,9 @@ class SofortPaymentRequest implements \JsonSerializable /** * Sets Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. * * @required * @maps country_code @@ -112,6 +111,23 @@ class SofortPaymentRequest implements \JsonSerializable $this->experienceContext = $experienceContext; } + /** + * Converts the SofortPaymentRequest object to a human-readable string representation. + * + * @return string The string representation of the SofortPaymentRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'SofortPaymentRequest', + [ + 'name' => $this->name, + 'countryCode' => $this->countryCode, + 'experienceContext' => $this->experienceContext + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/StandardEntryClassCode.php b/src/Models/StandardEntryClassCode.php index b8e496e..b266003 100644 --- a/src/Models/StandardEntryClassCode.php +++ b/src/Models/StandardEntryClassCode.php @@ -10,10 +10,6 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * NACHA (the regulatory body governing the ACH network) requires that API callers (merchants, * partners) obtain the consumer’s explicit authorization before initiating a transaction. To stay @@ -24,31 +20,28 @@ use stdClass; */ class StandardEntryClassCode { + /** + * The API caller (merchant/partner) accepts authorization and payment information from a consumer over + * the telephone. + */ public const TEL = 'TEL'; + /** + * The API caller (merchant/partner) accepts Debit transactions from a consumer on their website. + */ public const WEB = 'WEB'; + /** + * Cash concentration and disbursement for corporate debit transaction. Used to disburse or consolidate + * funds. Entries are usually Optional high-dollar, low-volume, and time-critical. (e.g. intra-company + * transfers or invoice payments to suppliers). + */ public const CCD = 'CCD'; - public const PPD = 'PPD'; - - private const _ALL_VALUES = [self::TEL, self::WEB, self::CCD, self::PPD]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * Prearranged payment and deposit entries. Used for debit payments authorized by a consumer account + * holder, and usually initiated by a company. These are usually recurring debits (such as insurance + * premiums). */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for StandardEntryClassCode."); - } + public const PPD = 'PPD'; } diff --git a/src/Models/StoreInVaultInstruction.php b/src/Models/StoreInVaultInstruction.php index 5e9f33a..e79c23e 100644 --- a/src/Models/StoreInVaultInstruction.php +++ b/src/Models/StoreInVaultInstruction.php @@ -10,34 +10,14 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * Defines how and when the payment source gets vaulted. */ class StoreInVaultInstruction { - public const ON_SUCCESS = 'ON_SUCCESS'; - - private const _ALL_VALUES = [self::ON_SUCCESS]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * Defines that the payment_source will be vaulted only when at least one authorization or capture + * using that payment_source is successful. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for StoreInVaultInstruction."); - } + public const ON_SUCCESS = 'ON_SUCCESS'; } diff --git a/src/Models/StoredPaymentSource.php b/src/Models/StoredPaymentSource.php index 8d2e18a..502b905 100644 --- a/src/Models/StoredPaymentSource.php +++ b/src/Models/StoredPaymentSource.php @@ -10,17 +10,17 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** * Provides additional details to process a payment using a `payment_source` that has been stored or is - * intended to be stored (also referred to as stored_credential or card-on-file).GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
GB
- * and not UK as used in the top-level domain names for that country. Use the `C2` country
- * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border
- * transactions.
+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain
+ * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled
+ * price (CUP) method, bank card, and cross-border transactions.
*/
public function getCountryCode(): ?string
{
@@ -73,10 +78,9 @@ class TrustlyPaymentObject implements \JsonSerializable
/**
* Sets Country Code.
* The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country
- * or region.Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. * * @maps country_code */ @@ -85,6 +89,30 @@ class TrustlyPaymentObject implements \JsonSerializable $this->countryCode = $countryCode; } + /** + * Returns Email. + * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. + */ + public function getEmail(): ?string + { + return $this->email; + } + + /** + * Sets Email. + * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. + * + * @maps email + */ + public function setEmail(?string $email): void + { + $this->email = $email; + } + /** * Returns Bic. * The business identification code (BIC). In payments systems, a BIC is used to identify a specific @@ -127,6 +155,25 @@ class TrustlyPaymentObject implements \JsonSerializable $this->ibanLastChars = $ibanLastChars; } + /** + * Converts the TrustlyPaymentObject object to a human-readable string representation. + * + * @return string The string representation of the TrustlyPaymentObject object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'TrustlyPaymentObject', + [ + 'name' => $this->name, + 'countryCode' => $this->countryCode, + 'email' => $this->email, + 'bic' => $this->bic, + 'ibanLastChars' => $this->ibanLastChars + ] + ); + } + /** * Encode this object to JSON * @@ -145,6 +192,9 @@ class TrustlyPaymentObject implements \JsonSerializable if (isset($this->countryCode)) { $json['country_code'] = $this->countryCode; } + if (isset($this->email)) { + $json['email'] = $this->email; + } if (isset($this->bic)) { $json['bic'] = $this->bic; } diff --git a/src/Models/TrustlyPaymentRequest.php b/src/Models/TrustlyPaymentRequest.php index f4ac92a..6fd01bc 100644 --- a/src/Models/TrustlyPaymentRequest.php +++ b/src/Models/TrustlyPaymentRequest.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -27,6 +28,11 @@ class TrustlyPaymentRequest implements \JsonSerializable */ private $countryCode; + /** + * @var string + */ + private $email; + /** * @var ExperienceContext|null */ @@ -35,11 +41,13 @@ class TrustlyPaymentRequest implements \JsonSerializable /** * @param string $name * @param string $countryCode + * @param string $email */ - public function __construct(string $name, string $countryCode) + public function __construct(string $name, string $countryCode, string $email) { $this->name = $name; $this->countryCode = $countryCode; + $this->email = $email; } /** @@ -66,10 +74,9 @@ class TrustlyPaymentRequest implements \JsonSerializable /** * Returns Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. */ public function getCountryCode(): string { @@ -79,10 +86,9 @@ class TrustlyPaymentRequest implements \JsonSerializable /** * Sets Country Code. * The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country - * or region.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: The country code for Great Britain is+ * or region. Note: The country code for Great Britain is GB and not UK as used in the top-level domain + * names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled + * price (CUP) method, bank card, and cross-border transactions. * * @required * @maps country_code @@ -92,6 +98,31 @@ class TrustlyPaymentRequest implements \JsonSerializable $this->countryCode = $countryCode; } + /** + * Returns Email. + * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. + */ + public function getEmail(): string + { + return $this->email; + } + + /** + * Sets Email. + * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. + * + * @required + * @maps email + */ + public function setEmail(string $email): void + { + $this->email = $email; + } + /** * Returns Experience Context. * Customizes the payer experience during the approval process for the payment. @@ -112,6 +143,24 @@ class TrustlyPaymentRequest implements \JsonSerializable $this->experienceContext = $experienceContext; } + /** + * Converts the TrustlyPaymentRequest object to a human-readable string representation. + * + * @return string The string representation of the TrustlyPaymentRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'TrustlyPaymentRequest', + [ + 'name' => $this->name, + 'countryCode' => $this->countryCode, + 'email' => $this->email, + 'experienceContext' => $this->experienceContext + ] + ); + } + /** * Encode this object to JSON * @@ -126,6 +175,7 @@ class TrustlyPaymentRequest implements \JsonSerializable $json = []; $json['name'] = $this->name; $json['country_code'] = $this->countryCode; + $json['email'] = $this->email; if (isset($this->experienceContext)) { $json['experience_context'] = $this->experienceContext; } diff --git a/src/Models/UniversalProductCode.php b/src/Models/UniversalProductCode.php index b2eb1ad..0cc6db1 100644 --- a/src/Models/UniversalProductCode.php +++ b/src/Models/UniversalProductCode.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -79,6 +80,16 @@ class UniversalProductCode implements \JsonSerializable $this->code = $code; } + /** + * Converts the UniversalProductCode object to a human-readable string representation. + * + * @return string The string representation of the UniversalProductCode object. + */ + public function __toString(): string + { + return ApiHelper::stringify('UniversalProductCode', ['type' => $this->type, 'code' => $this->code]); + } + /** * Encode this object to JSON * @@ -91,7 +102,7 @@ class UniversalProductCode implements \JsonSerializable public function jsonSerialize(bool $asArrayWhenEmpty = false) { $json = []; - $json['type'] = UpcType::checkValue($this->type); + $json['type'] = $this->type; $json['code'] = $this->code; return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; diff --git a/src/Models/UpcType.php b/src/Models/UpcType.php index e27671a..445c4cf 100644 --- a/src/Models/UpcType.php +++ b/src/Models/UpcType.php @@ -10,46 +10,22 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The Universal Product Code type. */ class UpcType { - public const UPCA = 'UPC-A'; + public const UPC_A = 'UPC-A'; - public const UPCB = 'UPC-B'; + public const UPC_B = 'UPC-B'; - public const UPCC = 'UPC-C'; + public const UPC_C = 'UPC-C'; - public const UPCD = 'UPC-D'; + public const UPC_D = 'UPC-D'; - public const UPCE = 'UPC-E'; + public const UPC_E = 'UPC-E'; - public const UPC2 = 'UPC-2'; + public const UPC_2 = 'UPC-2'; - public const UPC5 = 'UPC-5'; - - private const _ALL_VALUES = [self::UPCA, self::UPCB, self::UPCC, self::UPCD, self::UPCE, self::UPC2, self::UPC5]; - - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum - */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for UpcType."); - } + public const UPC_5 = 'UPC-5'; } diff --git a/src/Models/UsagePattern.php b/src/Models/UsagePattern.php new file mode 100644 index 0000000..9335ba0 --- /dev/null +++ b/src/Models/UsagePattern.php @@ -0,0 +1,87 @@ +id = $id; } + /** + * Converts the VaultCustomer object to a human-readable string representation. + * + * @return string The string representation of the VaultCustomer object. + */ + public function __toString(): string + { + return ApiHelper::stringify('VaultCustomer', ['id' => $this->id]); + } + /** * Encode this object to JSON * diff --git a/src/Models/VaultExperienceContext.php b/src/Models/VaultExperienceContext.php index a83a21b..748ce3c 100644 --- a/src/Models/VaultExperienceContext.php +++ b/src/Models/VaultExperienceContext.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -40,12 +41,12 @@ class VaultExperienceContext implements \JsonSerializable /** * @var string|null */ - private $shippingPreference = 'GET_FROM_FILE'; + private $shippingPreference = OrderApplicationContextShippingPreference::GET_FROM_FILE; /** * @var string|null */ - private $vaultInstruction = 'ON_CREATE_PAYMENT_TOKENS'; + private $vaultInstruction = VaultInstructionAction::ON_CREATE_PAYMENT_TOKENS; /** * Returns Brand Name. @@ -183,6 +184,26 @@ class VaultExperienceContext implements \JsonSerializable $this->vaultInstruction = $vaultInstruction; } + /** + * Converts the VaultExperienceContext object to a human-readable string representation. + * + * @return string The string representation of the VaultExperienceContext object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'VaultExperienceContext', + [ + 'brandName' => $this->brandName, + 'locale' => $this->locale, + 'returnUrl' => $this->returnUrl, + 'cancelUrl' => $this->cancelUrl, + 'shippingPreference' => $this->shippingPreference, + 'vaultInstruction' => $this->vaultInstruction + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/VaultInstruction.php b/src/Models/VaultInstruction.php index fc4f1c0..d81cfbb 100644 --- a/src/Models/VaultInstruction.php +++ b/src/Models/VaultInstruction.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -52,6 +53,16 @@ class VaultInstruction implements \JsonSerializable $this->storeInVault = $storeInVault; } + /** + * Converts the VaultInstruction object to a human-readable string representation. + * + * @return string The string representation of the VaultInstruction object. + */ + public function __toString(): string + { + return ApiHelper::stringify('VaultInstruction', ['storeInVault' => $this->storeInVault]); + } + /** * Encode this object to JSON * @@ -64,7 +75,7 @@ class VaultInstruction implements \JsonSerializable public function jsonSerialize(bool $asArrayWhenEmpty = false) { $json = []; - $json['store_in_vault'] = StoreInVaultInstruction::checkValue($this->storeInVault); + $json['store_in_vault'] = $this->storeInVault; return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; } diff --git a/src/Models/VaultInstructionAction.php b/src/Models/VaultInstructionAction.php new file mode 100644 index 0000000..3fba7a6 --- /dev/null +++ b/src/Models/VaultInstructionAction.php @@ -0,0 +1,27 @@ +storeInVault = $storeInVault; } + /** + * Converts the VaultInstructionBase object to a human-readable string representation. + * + * @return string The string representation of the VaultInstructionBase object. + */ + public function __toString(): string + { + return ApiHelper::stringify('VaultInstructionBase', ['storeInVault' => $this->storeInVault]); + } + /** * Encode this object to JSON * @@ -56,7 +67,7 @@ class VaultInstructionBase implements \JsonSerializable { $json = []; if (isset($this->storeInVault)) { - $json['store_in_vault'] = StoreInVaultInstruction::checkValue($this->storeInVault); + $json['store_in_vault'] = $this->storeInVault; } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; diff --git a/src/Models/VaultPaypalWalletRequest.php b/src/Models/VaultPaypalWalletRequest.php index 3b264f3..f66554d 100644 --- a/src/Models/VaultPaypalWalletRequest.php +++ b/src/Models/VaultPaypalWalletRequest.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -22,6 +23,11 @@ class VaultPaypalWalletRequest implements \JsonSerializable */ private $description; + /** + * @var string|null + */ + private $usagePattern; + /** * @var VaultedDigitalWalletShippingDetails|null */ @@ -42,6 +48,11 @@ class VaultPaypalWalletRequest implements \JsonSerializable */ private $customerType; + /** + * @var Plan|null + */ + private $billingPlan; + /** * @var VaultExperienceContext|null */ @@ -69,6 +80,26 @@ class VaultPaypalWalletRequest implements \JsonSerializable $this->description = $description; } + /** + * Returns Usage Pattern. + * Expected business/charge model for the billing agreement. + */ + public function getUsagePattern(): ?string + { + return $this->usagePattern; + } + + /** + * Sets Usage Pattern. + * Expected business/charge model for the billing agreement. + * + * @maps usage_pattern + */ + public function setUsagePattern(?string $usagePattern): void + { + $this->usagePattern = $usagePattern; + } + /** * Returns Shipping. * The shipping details. @@ -161,6 +192,26 @@ class VaultPaypalWalletRequest implements \JsonSerializable $this->customerType = $customerType; } + /** + * Returns Billing Plan. + * The merchant level Recurring Billing plan metadata for the Billing Agreement. + */ + public function getBillingPlan(): ?Plan + { + return $this->billingPlan; + } + + /** + * Sets Billing Plan. + * The merchant level Recurring Billing plan metadata for the Billing Agreement. + * + * @maps billing_plan + */ + public function setBillingPlan(?Plan $billingPlan): void + { + $this->billingPlan = $billingPlan; + } + /** * Returns Experience Context. * Customizes the Vault creation flow experience for your customers. @@ -181,6 +232,28 @@ class VaultPaypalWalletRequest implements \JsonSerializable $this->experienceContext = $experienceContext; } + /** + * Converts the VaultPaypalWalletRequest object to a human-readable string representation. + * + * @return string The string representation of the VaultPaypalWalletRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'VaultPaypalWalletRequest', + [ + 'description' => $this->description, + 'usagePattern' => $this->usagePattern, + 'shipping' => $this->shipping, + 'permitMultiplePaymentTokens' => $this->permitMultiplePaymentTokens, + 'usageType' => $this->usageType, + 'customerType' => $this->customerType, + 'billingPlan' => $this->billingPlan, + 'experienceContext' => $this->experienceContext + ] + ); + } + /** * Encode this object to JSON * @@ -196,6 +269,9 @@ class VaultPaypalWalletRequest implements \JsonSerializable if (isset($this->description)) { $json['description'] = $this->description; } + if (isset($this->usagePattern)) { + $json['usage_pattern'] = $this->usagePattern; + } if (isset($this->shipping)) { $json['shipping'] = $this->shipping; } @@ -208,6 +284,9 @@ class VaultPaypalWalletRequest implements \JsonSerializable if (isset($this->customerType)) { $json['customer_type'] = $this->customerType; } + if (isset($this->billingPlan)) { + $json['billing_plan'] = $this->billingPlan; + } if (isset($this->experienceContext)) { $json['experience_context'] = $this->experienceContext; } diff --git a/src/Models/VaultResponse.php b/src/Models/VaultResponse.php index 7e26559..57aa9d9 100644 --- a/src/Models/VaultResponse.php +++ b/src/Models/VaultResponse.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -121,6 +122,19 @@ class VaultResponse implements \JsonSerializable $this->links = $links; } + /** + * Converts the VaultResponse object to a human-readable string representation. + * + * @return string The string representation of the VaultResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'VaultResponse', + ['id' => $this->id, 'status' => $this->status, 'customer' => $this->customer, 'links' => $this->links] + ); + } + /** * Encode this object to JSON * @@ -137,7 +151,7 @@ class VaultResponse implements \JsonSerializable $json['id'] = $this->id; } if (isset($this->status)) { - $json['status'] = VaultStatus::checkValue($this->status); + $json['status'] = $this->status; } if (isset($this->customer)) { $json['customer'] = $this->customer; diff --git a/src/Models/VaultResponseCustomer.php b/src/Models/VaultResponseCustomer.php new file mode 100644 index 0000000..ccd0134 --- /dev/null +++ b/src/Models/VaultResponseCustomer.php @@ -0,0 +1,138 @@ +id; + } + + /** + * Sets Id. + * The unique ID for a customer generated by PayPal. + * + * @maps id + */ + public function setId(?string $id): void + { + $this->id = $id; + } + + /** + * Returns Merchant Customer Id. + * Merchants and partners may already have a data-store where their customer information is persisted. + * Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a + * customer. + */ + public function getMerchantCustomerId(): ?string + { + return $this->merchantCustomerId; + } + + /** + * Sets Merchant Customer Id. + * Merchants and partners may already have a data-store where their customer information is persisted. + * Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a + * customer. + * + * @maps merchant_customer_id + */ + public function setMerchantCustomerId(?string $merchantCustomerId): void + { + $this->merchantCustomerId = $merchantCustomerId; + } + + /** + * Returns Links. + * An array of request-related HATEOAS links. + */ + public function getLinks(): array + { + return $this->links; + } + + /** + * Sets Links. + * An array of request-related HATEOAS links. + * + * @maps links + */ + public function setLinks(array $links): void + { + $this->links = $links; + } + + /** + * Converts the VaultResponseCustomer object to a human-readable string representation. + * + * @return string The string representation of the VaultResponseCustomer object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'VaultResponseCustomer', + ['id' => $this->id, 'merchantCustomerId' => $this->merchantCustomerId, 'links' => $this->links] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + if (isset($this->id)) { + $json['id'] = $this->id; + } + if (isset($this->merchantCustomerId)) { + $json['merchant_customer_id'] = $this->merchantCustomerId; + } + if (isset($this->links)) { + $json['links'] = $this->links; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/VaultStatus.php b/src/Models/VaultStatus.php index 21f9a08..10dd0f6 100644 --- a/src/Models/VaultStatus.php +++ b/src/Models/VaultStatus.php @@ -10,38 +10,26 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The vault status. */ class VaultStatus { + /** + * The payment source has been saved in your customer's vault. This vault status reflects `/v3/vault` + * status. + */ public const VAULTED = 'VAULTED'; + /** + * DEPRECATED. The payment source has been saved in your customer's vault. This status applies to + * deprecated integration patterns and will not be returned for v3/vault integrations. + */ public const CREATED = 'CREATED'; - public const APPROVED = 'APPROVED'; - - private const _ALL_VALUES = [self::VAULTED, self::CREATED, self::APPROVED]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * Customer has approved the action of saving the specified payment_source into their vault. Use + * v3/vault/payment-tokens with given setup_token to save the payment source in the vault */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for VaultStatus."); - } + public const APPROVED = 'APPROVED'; } diff --git a/src/Models/VaultTokenRequest.php b/src/Models/VaultTokenRequest.php index d6d428b..365c326 100644 --- a/src/Models/VaultTokenRequest.php +++ b/src/Models/VaultTokenRequest.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -79,6 +80,16 @@ class VaultTokenRequest implements \JsonSerializable $this->type = $type; } + /** + * Converts the VaultTokenRequest object to a human-readable string representation. + * + * @return string The string representation of the VaultTokenRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify('VaultTokenRequest', ['id' => $this->id, 'type' => $this->type]); + } + /** * Encode this object to JSON * @@ -92,7 +103,7 @@ class VaultTokenRequest implements \JsonSerializable { $json = []; $json['id'] = $this->id; - $json['type'] = TokenRequestType::checkValue($this->type); + $json['type'] = $this->type; return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; } diff --git a/src/Models/VaultTokenRequestType.php b/src/Models/VaultTokenRequestType.php new file mode 100644 index 0000000..9b42335 --- /dev/null +++ b/src/Models/VaultTokenRequestType.php @@ -0,0 +1,22 @@ +vaultInstruction = $vaultInstruction; } + /** + * Converts the VaultVenmoExperienceContext object to a human-readable string representation. + * + * @return string The string representation of the VaultVenmoExperienceContext object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'VaultVenmoExperienceContext', + [ + 'brandName' => $this->brandName, + 'shippingPreference' => $this->shippingPreference, + 'vaultInstruction' => $this->vaultInstruction + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/VaultVenmoRequest.php b/src/Models/VaultVenmoRequest.php index 5f5e380..6a442fa 100644 --- a/src/Models/VaultVenmoRequest.php +++ b/src/Models/VaultVenmoRequest.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; class VaultVenmoRequest implements \JsonSerializable @@ -19,6 +20,11 @@ class VaultVenmoRequest implements \JsonSerializable */ private $description; + /** + * @var string|null + */ + private $usagePattern; + /** * @var VaultedDigitalWalletShippingDetails|null */ @@ -66,6 +72,26 @@ class VaultVenmoRequest implements \JsonSerializable $this->description = $description; } + /** + * Returns Usage Pattern. + * Expected business/charge model for the billing agreement. + */ + public function getUsagePattern(): ?string + { + return $this->usagePattern; + } + + /** + * Sets Usage Pattern. + * Expected business/charge model for the billing agreement. + * + * @maps usage_pattern + */ + public function setUsagePattern(?string $usagePattern): void + { + $this->usagePattern = $usagePattern; + } + /** * Returns Shipping. * The shipping details. @@ -178,6 +204,27 @@ class VaultVenmoRequest implements \JsonSerializable $this->experienceContext = $experienceContext; } + /** + * Converts the VaultVenmoRequest object to a human-readable string representation. + * + * @return string The string representation of the VaultVenmoRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'VaultVenmoRequest', + [ + 'description' => $this->description, + 'usagePattern' => $this->usagePattern, + 'shipping' => $this->shipping, + 'permitMultiplePaymentTokens' => $this->permitMultiplePaymentTokens, + 'usageType' => $this->usageType, + 'customerType' => $this->customerType, + 'experienceContext' => $this->experienceContext + ] + ); + } + /** * Encode this object to JSON * @@ -193,6 +240,9 @@ class VaultVenmoRequest implements \JsonSerializable if (isset($this->description)) { $json['description'] = $this->description; } + if (isset($this->usagePattern)) { + $json['usage_pattern'] = $this->usagePattern; + } if (isset($this->shipping)) { $json['shipping'] = $this->shipping; } diff --git a/src/Models/VaultedDigitalWallet.php b/src/Models/VaultedDigitalWallet.php index cbfaf04..9908f07 100644 --- a/src/Models/VaultedDigitalWallet.php +++ b/src/Models/VaultedDigitalWallet.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -22,6 +23,11 @@ class VaultedDigitalWallet implements \JsonSerializable */ private $description; + /** + * @var string|null + */ + private $usagePattern; + /** * @var VaultedDigitalWalletShippingDetails|null */ @@ -64,6 +70,26 @@ class VaultedDigitalWallet implements \JsonSerializable $this->description = $description; } + /** + * Returns Usage Pattern. + * Expected business/charge model for the billing agreement. + */ + public function getUsagePattern(): ?string + { + return $this->usagePattern; + } + + /** + * Sets Usage Pattern. + * Expected business/charge model for the billing agreement. + * + * @maps usage_pattern + */ + public function setUsagePattern(?string $usagePattern): void + { + $this->usagePattern = $usagePattern; + } + /** * Returns Shipping. * The shipping details. @@ -156,6 +182,26 @@ class VaultedDigitalWallet implements \JsonSerializable $this->customerType = $customerType; } + /** + * Converts the VaultedDigitalWallet object to a human-readable string representation. + * + * @return string The string representation of the VaultedDigitalWallet object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'VaultedDigitalWallet', + [ + 'description' => $this->description, + 'usagePattern' => $this->usagePattern, + 'shipping' => $this->shipping, + 'permitMultiplePaymentTokens' => $this->permitMultiplePaymentTokens, + 'usageType' => $this->usageType, + 'customerType' => $this->customerType + ] + ); + } + /** * Encode this object to JSON * @@ -171,6 +217,9 @@ class VaultedDigitalWallet implements \JsonSerializable if (isset($this->description)) { $json['description'] = $this->description; } + if (isset($this->usagePattern)) { + $json['usage_pattern'] = $this->usagePattern; + } if (isset($this->shipping)) { $json['shipping'] = $this->shipping; } diff --git a/src/Models/VaultedDigitalWalletShippingDetails.php b/src/Models/VaultedDigitalWalletShippingDetails.php index b8c5c4b..1433a9d 100644 --- a/src/Models/VaultedDigitalWalletShippingDetails.php +++ b/src/Models/VaultedDigitalWalletShippingDetails.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -22,6 +23,11 @@ class VaultedDigitalWalletShippingDetails implements \JsonSerializable */ private $name; + /** + * @var PhoneNumberWithCountryCode|null + */ + private $phoneNumber; + /** * @var string|null */ @@ -52,6 +58,28 @@ class VaultedDigitalWalletShippingDetails implements \JsonSerializable $this->name = $name; } + /** + * Returns Phone Number. + * The phone number, in its canonical international [E.164 numbering plan format](https://www.itu. + * int/rec/T-REC-E.164/en). + */ + public function getPhoneNumber(): ?PhoneNumberWithCountryCode + { + return $this->phoneNumber; + } + + /** + * Sets Phone Number. + * The phone number, in its canonical international [E.164 numbering plan format](https://www.itu. + * int/rec/T-REC-E.164/en). + * + * @maps phone_number + */ + public function setPhoneNumber(?PhoneNumberWithCountryCode $phoneNumber): void + { + $this->phoneNumber = $phoneNumber; + } + /** * Returns Type. * A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either @@ -100,6 +128,24 @@ class VaultedDigitalWalletShippingDetails implements \JsonSerializable $this->address = $address; } + /** + * Converts the VaultedDigitalWalletShippingDetails object to a human-readable string representation. + * + * @return string The string representation of the VaultedDigitalWalletShippingDetails object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'VaultedDigitalWalletShippingDetails', + [ + 'name' => $this->name, + 'phoneNumber' => $this->phoneNumber, + 'type' => $this->type, + 'address' => $this->address + ] + ); + } + /** * Encode this object to JSON * @@ -113,13 +159,16 @@ class VaultedDigitalWalletShippingDetails implements \JsonSerializable { $json = []; if (isset($this->name)) { - $json['name'] = $this->name; + $json['name'] = $this->name; + } + if (isset($this->phoneNumber)) { + $json['phone_number'] = $this->phoneNumber; } if (isset($this->type)) { - $json['type'] = FulfillmentType::checkValue($this->type); + $json['type'] = $this->type; } if (isset($this->address)) { - $json['address'] = $this->address; + $json['address'] = $this->address; } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; diff --git a/src/Models/VenmoPaymentToken.php b/src/Models/VenmoPaymentToken.php index 9849e5d..eea8533 100644 --- a/src/Models/VenmoPaymentToken.php +++ b/src/Models/VenmoPaymentToken.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; class VenmoPaymentToken implements \JsonSerializable @@ -19,6 +20,11 @@ class VenmoPaymentToken implements \JsonSerializable */ private $description; + /** + * @var string|null + */ + private $usagePattern; + /** * @var VaultedDigitalWalletShippingDetails|null */ @@ -91,6 +97,26 @@ class VenmoPaymentToken implements \JsonSerializable $this->description = $description; } + /** + * Returns Usage Pattern. + * Expected business/charge model for the billing agreement. + */ + public function getUsagePattern(): ?string + { + return $this->usagePattern; + } + + /** + * Sets Usage Pattern. + * Expected business/charge model for the billing agreement. + * + * @maps usage_pattern + */ + public function setUsagePattern(?string $usagePattern): void + { + $this->usagePattern = $usagePattern; + } + /** * Returns Shipping. * The shipping details. @@ -185,10 +211,9 @@ class VenmoPaymentToken implements \JsonSerializable /** * Returns Email Address. - * The internationalized email address.GB- * and notUKas used in the top-level domain names for that country. Use the `C2` country - * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border - * transactions.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. */ public function getEmailAddress(): ?string { @@ -197,10 +222,9 @@ class VenmoPaymentToken implements \JsonSerializable /** * Sets Email Address. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. * * @maps email_address */ @@ -315,6 +339,32 @@ class VenmoPaymentToken implements \JsonSerializable $this->userName = $userName; } + /** + * Converts the VenmoPaymentToken object to a human-readable string representation. + * + * @return string The string representation of the VenmoPaymentToken object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'VenmoPaymentToken', + [ + 'description' => $this->description, + 'usagePattern' => $this->usagePattern, + 'shipping' => $this->shipping, + 'permitMultiplePaymentTokens' => $this->permitMultiplePaymentTokens, + 'usageType' => $this->usageType, + 'customerType' => $this->customerType, + 'emailAddress' => $this->emailAddress, + 'payerId' => $this->payerId, + 'name' => $this->name, + 'phone' => $this->phone, + 'address' => $this->address, + 'userName' => $this->userName + ] + ); + } + /** * Encode this object to JSON * @@ -330,6 +380,9 @@ class VenmoPaymentToken implements \JsonSerializable if (isset($this->description)) { $json['description'] = $this->description; } + if (isset($this->usagePattern)) { + $json['usage_pattern'] = $this->usagePattern; + } if (isset($this->shipping)) { $json['shipping'] = $this->shipping; } diff --git a/src/Models/VenmoPaymentTokenCustomerType.php b/src/Models/VenmoPaymentTokenCustomerType.php index f2ca186..388502c 100644 --- a/src/Models/VenmoPaymentTokenCustomerType.php +++ b/src/Models/VenmoPaymentTokenCustomerType.php @@ -10,37 +10,19 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The customer type associated with the Venmo payment token. This is to indicate whether the customer * acting on the merchant / platform is either a business or a consumer. */ class VenmoPaymentTokenCustomerType { + /** + * The customer vaulting the Venmo payment token is a consumer on the merchant / platform. + */ public const CONSUMER = 'CONSUMER'; - public const BUSINESS = 'BUSINESS'; - - private const _ALL_VALUES = [self::CONSUMER, self::BUSINESS]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * The customer vaulting the Venmo payment token is a business on merchant / platform. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for VenmoPaymentTokenCustomerType."); - } + public const BUSINESS = 'BUSINESS'; } diff --git a/src/Models/VenmoPaymentTokenUsagePattern.php b/src/Models/VenmoPaymentTokenUsagePattern.php index c3bcb98..7c1930f 100644 --- a/src/Models/VenmoPaymentTokenUsagePattern.php +++ b/src/Models/VenmoPaymentTokenUsagePattern.php @@ -10,51 +10,40 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * Expected business/pricing model for the billing agreement. */ class VenmoPaymentTokenUsagePattern { + /** + * On-demand instant payments – non-recurring, pre-paid, variable amount, variable frequency. + */ public const IMMEDIATE = 'IMMEDIATE'; + /** + * Pay after use, non-recurring post-paid, variable amount, irregular frequency. + */ public const DEFERRED = 'DEFERRED'; + /** + * Pay upfront fixed or variable amount on a fixed date before the goods/service is delivered. + */ public const RECURRING_PREPAID = 'RECURRING_PREPAID'; + /** + * Pay on a fixed date based on usage or consumption after the goods/service is delivered. + */ public const RECURRING_POSTPAID = 'RECURRING_POSTPAID'; + /** + * Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, before + * the goods/service is delivered. + */ public const THRESHOLD_PREPAID = 'THRESHOLD_PREPAID'; - public const THRESHOLD_POSTPAID = 'THRESHOLD_POSTPAID'; - - private const _ALL_VALUES = [ - self::IMMEDIATE, - self::DEFERRED, - self::RECURRING_PREPAID, - self::RECURRING_POSTPAID, - self::THRESHOLD_PREPAID, - self::THRESHOLD_POSTPAID - ]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, after + * the goods/service is delivered. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for VenmoPaymentTokenUsagePattern."); - } + public const THRESHOLD_POSTPAID = 'THRESHOLD_POSTPAID'; } diff --git a/src/Models/VenmoPaymentTokenUsageType.php b/src/Models/VenmoPaymentTokenUsageType.php index b48d3c0..b11bb40 100644 --- a/src/Models/VenmoPaymentTokenUsageType.php +++ b/src/Models/VenmoPaymentTokenUsageType.php @@ -10,36 +10,19 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; -use Core\Utils\CoreHelper; -use Exception; -use stdClass; - /** * The usage type associated with the Venmo payment token. */ class VenmoPaymentTokenUsageType { + /** + * The Venmo Payment Token will be used for future transaction directly with a merchant. + */ public const MERCHANT = 'MERCHANT'; - public const PLATFORM = 'PLATFORM'; - - private const _ALL_VALUES = [self::MERCHANT, self::PLATFORM]; - /** - * Ensures that all the given values are present in this Enum. - * - * @param array|stdClass|null|string $value Value or a list/map of values to be checked - * - * @return array|null|string Input value(s), if all are a part of this Enum - * - * @throws Exception Throws exception if any given value is not in this Enum + * The Venmo Payment Token will be used for future transaction on a platform. A platform is typically a + * marketplace or a channel that a payer can purchase goods and services from multiple merchants. */ - public static function checkValue($value) - { - $value = json_decode(json_encode($value), true); // converts stdClass into array - if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { - return $value; - } - throw new Exception("$value is invalid for VenmoPaymentTokenUsageType."); - } + public const PLATFORM = 'PLATFORM'; } diff --git a/src/Models/VenmoWalletAdditionalAttributes.php b/src/Models/VenmoWalletAdditionalAttributes.php index 85cb0d7..f0725fd 100644 --- a/src/Models/VenmoWalletAdditionalAttributes.php +++ b/src/Models/VenmoWalletAdditionalAttributes.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -67,6 +68,19 @@ class VenmoWalletAdditionalAttributes implements \JsonSerializable $this->vault = $vault; } + /** + * Converts the VenmoWalletAdditionalAttributes object to a human-readable string representation. + * + * @return string The string representation of the VenmoWalletAdditionalAttributes object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'VenmoWalletAdditionalAttributes', + ['customer' => $this->customer, 'vault' => $this->vault] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/VenmoWalletAttributesResponse.php b/src/Models/VenmoWalletAttributesResponse.php index ed69629..0a12310 100644 --- a/src/Models/VenmoWalletAttributesResponse.php +++ b/src/Models/VenmoWalletAttributesResponse.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -42,6 +43,16 @@ class VenmoWalletAttributesResponse implements \JsonSerializable $this->vault = $vault; } + /** + * Converts the VenmoWalletAttributesResponse object to a human-readable string representation. + * + * @return string The string representation of the VenmoWalletAttributesResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify('VenmoWalletAttributesResponse', ['vault' => $this->vault]); + } + /** * Encode this object to JSON * diff --git a/src/Models/VenmoWalletCustomerInformation.php b/src/Models/VenmoWalletCustomerInformation.php index 27bea74..0e59160 100644 --- a/src/Models/VenmoWalletCustomerInformation.php +++ b/src/Models/VenmoWalletCustomerInformation.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -49,10 +50,9 @@ class VenmoWalletCustomerInformation implements \JsonSerializable /** * Returns Email Address. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. */ public function getEmailAddress(): ?string { @@ -61,10 +61,9 @@ class VenmoWalletCustomerInformation implements \JsonSerializable /** * Sets Email Address. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. * * @maps email_address */ @@ -73,6 +72,19 @@ class VenmoWalletCustomerInformation implements \JsonSerializable $this->emailAddress = $emailAddress; } + /** + * Converts the VenmoWalletCustomerInformation object to a human-readable string representation. + * + * @return string The string representation of the VenmoWalletCustomerInformation object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'VenmoWalletCustomerInformation', + ['id' => $this->id, 'emailAddress' => $this->emailAddress] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/VenmoWalletExperienceContext.php b/src/Models/VenmoWalletExperienceContext.php index 3c76343..ef67722 100644 --- a/src/Models/VenmoWalletExperienceContext.php +++ b/src/Models/VenmoWalletExperienceContext.php @@ -10,13 +10,13 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** - * Customizes the buyer experience during the approval process for payment with Venmo. - *@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Partners and Marketplaces might configure
- * shipping_preference during partner account setup, which overrides the request values.
- *
+ * Customizes the buyer experience during the approval process for payment with Venmo. Note: Partners
+ * and Marketplaces might configure shipping_preference during partner account setup, which overrides
+ * the request values.
*/
class VenmoWalletExperienceContext implements \JsonSerializable
{
@@ -30,6 +30,11 @@ class VenmoWalletExperienceContext implements \JsonSerializable
*/
private $shippingPreference = ShippingPreference::GET_FROM_FILE;
+ /**
+ * @var CallbackConfiguration|null
+ */
+ private $orderUpdateCallbackConfig;
+
/**
* Returns Brand Name.
* The business name of the merchant. The pattern is defined by an external party and supports Unicode.
@@ -70,6 +75,43 @@ class VenmoWalletExperienceContext implements \JsonSerializable
$this->shippingPreference = $shippingPreference;
}
+ /**
+ * Returns Order Update Callback Config.
+ * CallBack Configuration that the merchant can provide to PayPal/Venmo.
+ */
+ public function getOrderUpdateCallbackConfig(): ?CallbackConfiguration
+ {
+ return $this->orderUpdateCallbackConfig;
+ }
+
+ /**
+ * Sets Order Update Callback Config.
+ * CallBack Configuration that the merchant can provide to PayPal/Venmo.
+ *
+ * @maps order_update_callback_config
+ */
+ public function setOrderUpdateCallbackConfig(?CallbackConfiguration $orderUpdateCallbackConfig): void
+ {
+ $this->orderUpdateCallbackConfig = $orderUpdateCallbackConfig;
+ }
+
+ /**
+ * Converts the VenmoWalletExperienceContext object to a human-readable string representation.
+ *
+ * @return string The string representation of the VenmoWalletExperienceContext object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify(
+ 'VenmoWalletExperienceContext',
+ [
+ 'brandName' => $this->brandName,
+ 'shippingPreference' => $this->shippingPreference,
+ 'orderUpdateCallbackConfig' => $this->orderUpdateCallbackConfig
+ ]
+ );
+ }
+
/**
* Encode this object to JSON
*
@@ -83,10 +125,13 @@ class VenmoWalletExperienceContext implements \JsonSerializable
{
$json = [];
if (isset($this->brandName)) {
- $json['brand_name'] = $this->brandName;
+ $json['brand_name'] = $this->brandName;
}
if (isset($this->shippingPreference)) {
- $json['shipping_preference'] = ShippingPreference::checkValue($this->shippingPreference);
+ $json['shipping_preference'] = $this->shippingPreference;
+ }
+ if (isset($this->orderUpdateCallbackConfig)) {
+ $json['order_update_callback_config'] = $this->orderUpdateCallbackConfig;
}
return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json;
diff --git a/src/Models/VenmoWalletRequest.php b/src/Models/VenmoWalletRequest.php
index b9764e5..adf8af9 100644
--- a/src/Models/VenmoWalletRequest.php
+++ b/src/Models/VenmoWalletRequest.php
@@ -10,6 +10,7 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
+use PaypalServerSdkLib\ApiHelper;
use stdClass;
/**
@@ -61,10 +62,9 @@ class VenmoWalletRequest implements \JsonSerializable
/**
* Returns Email Address.
- * The internationalized email address.Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. */ public function getEmailAddress(): ?string { @@ -73,10 +73,9 @@ class VenmoWalletRequest implements \JsonSerializable /** * Sets Email Address. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. * * @maps email_address */ @@ -87,10 +86,9 @@ class VenmoWalletRequest implements \JsonSerializable /** * Returns Experience Context. - * Customizes the buyer experience during the approval process for payment with Venmo. - *@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Partners and Marketplaces might configure
- * shipping_preference during partner account setup, which overrides the request values.
- *
+ * Customizes the buyer experience during the approval process for payment with Venmo. Note: Partners
+ * and Marketplaces might configure shipping_preference during partner account setup, which overrides
+ * the request values.
*/
public function getExperienceContext(): ?VenmoWalletExperienceContext
{
@@ -99,10 +97,9 @@ class VenmoWalletRequest implements \JsonSerializable
/**
* Sets Experience Context.
- * Customizes the buyer experience during the approval process for payment with Venmo.
- * Note: Partners and Marketplaces might configure
- * shipping_preference during partner account setup, which overrides the request values.
- *
+ * Customizes the buyer experience during the approval process for payment with Venmo. Note: Partners
+ * and Marketplaces might configure shipping_preference during partner account setup, which overrides
+ * the request values.
*
* @maps experience_context
*/
@@ -131,6 +128,24 @@ class VenmoWalletRequest implements \JsonSerializable
$this->attributes = $attributes;
}
+ /**
+ * Converts the VenmoWalletRequest object to a human-readable string representation.
+ *
+ * @return string The string representation of the VenmoWalletRequest object.
+ */
+ public function __toString(): string
+ {
+ return ApiHelper::stringify(
+ 'VenmoWalletRequest',
+ [
+ 'vaultId' => $this->vaultId,
+ 'emailAddress' => $this->emailAddress,
+ 'experienceContext' => $this->experienceContext,
+ 'attributes' => $this->attributes
+ ]
+ );
+ }
+
/**
* Encode this object to JSON
*
diff --git a/src/Models/VenmoWalletResponse.php b/src/Models/VenmoWalletResponse.php
index 915148c..d5285c5 100644
--- a/src/Models/VenmoWalletResponse.php
+++ b/src/Models/VenmoWalletResponse.php
@@ -10,6 +10,7 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models;
+use PaypalServerSdkLib\ApiHelper;
use stdClass;
/**
@@ -54,10 +55,9 @@ class VenmoWalletResponse implements \JsonSerializable
/**
* Returns Email Address.
- * The internationalized email address.Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. */ public function getEmailAddress(): ?string { @@ -66,10 +66,9 @@ class VenmoWalletResponse implements \JsonSerializable /** * Sets Email Address. - * The internationalized email address.@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.
Note: Up to 64 characters are - * allowed before and 255 characters are allowed after the+ * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. * * @maps email_address */ @@ -210,6 +209,27 @@ class VenmoWalletResponse implements \JsonSerializable $this->attributes = $attributes; } + /** + * Converts the VenmoWalletResponse object to a human-readable string representation. + * + * @return string The string representation of the VenmoWalletResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'VenmoWalletResponse', + [ + 'emailAddress' => $this->emailAddress, + 'accountId' => $this->accountId, + 'userName' => $this->userName, + 'name' => $this->name, + 'phoneNumber' => $this->phoneNumber, + 'address' => $this->address, + 'attributes' => $this->attributes + ] + ); + } + /** * Encode this object to JSON * diff --git a/src/Models/VenmoWalletVaultAttributes.php b/src/Models/VenmoWalletVaultAttributes.php index 455901e..ebb2513 100644 --- a/src/Models/VenmoWalletVaultAttributes.php +++ b/src/Models/VenmoWalletVaultAttributes.php @@ -10,6 +10,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models; +use PaypalServerSdkLib\ApiHelper; use stdClass; /** @@ -191,6 +192,26 @@ class VenmoWalletVaultAttributes implements \JsonSerializable $this->permitMultiplePaymentTokens = $permitMultiplePaymentTokens; } + /** + * Converts the VenmoWalletVaultAttributes object to a human-readable string representation. + * + * @return string The string representation of the VenmoWalletVaultAttributes object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'VenmoWalletVaultAttributes', + [ + 'storeInVault' => $this->storeInVault, + 'description' => $this->description, + 'usagePattern' => $this->usagePattern, + 'usageType' => $this->usageType, + 'customerType' => $this->customerType, + 'permitMultiplePaymentTokens' => $this->permitMultiplePaymentTokens + ] + ); + } + /** * Encode this object to JSON * @@ -203,16 +224,16 @@ class VenmoWalletVaultAttributes implements \JsonSerializable public function jsonSerialize(bool $asArrayWhenEmpty = false) { $json = []; - $json['store_in_vault'] = StoreInVaultInstruction::checkValue($this->storeInVault); + $json['store_in_vault'] = $this->storeInVault; if (isset($this->description)) { $json['description'] = $this->description; } if (isset($this->usagePattern)) { - $json['usage_pattern'] = VenmoPaymentTokenUsagePattern::checkValue($this->usagePattern); + $json['usage_pattern'] = $this->usagePattern; } - $json['usage_type'] = VenmoPaymentTokenUsageType::checkValue($this->usageType); + $json['usage_type'] = $this->usageType; if (isset($this->customerType)) { - $json['customer_type'] = VenmoPaymentTokenCustomerType::checkValue($this->customerType); + $json['customer_type'] = $this->customerType; } if (isset($this->permitMultiplePaymentTokens)) { $json['permit_multiple_payment_tokens'] = $this->permitMultiplePaymentTokens; diff --git a/src/PaypalServerSdkClient.php b/src/PaypalServerSdkClient.php index 83a1df3..730e7c6 100644 --- a/src/PaypalServerSdkClient.php +++ b/src/PaypalServerSdkClient.php @@ -62,7 +62,7 @@ class PaypalServerSdkClient implements ConfigurationInterface ->converter(new CompatibilityConverter()) ->jsonHelper(ApiHelper::getJsonHelper()) ->apiCallback($this->config['httpCallback'] ?? null) - ->userAgent('PayPal REST API PHP SDK, Version: 0.6.1, on OS {os-info}') + ->userAgent('PayPal REST API PHP SDK, Version: 0.7.0, on OS {os-info}') ->serverUrls(self::ENVIRONMENT_MAP[$this->getEnvironment()], Server::DEFAULT_) ->authManagers(['Oauth2' => $this->clientCredentialsAuthManager]) ->loggingConfiguration($loggingConfiguration)@sign. However, the generally - * accepted maximum length for an email address is 254 characters. The pattern verifies that an - * unquoted@sign exists.