From f423f69aee1e0398f4f1799831710e6a34ad5e64 Mon Sep 17 00:00:00 2001 From: moizgillani Date: Tue, 10 Sep 2024 15:06:47 +0500 Subject: [PATCH] sdk files removed --- .gitattributes | 1 - .phan/config.php | 79 - LICENSE | 28 - README.md | 182 - composer.json | 51 - doc/api-exception.md | 13 - doc/auth/oauth-2-client-credentials-grant.md | 88 - doc/client.md | 61 - doc/controllers/orders.md | 400 -- doc/controllers/payments.md | 329 -- doc/controllers/vault.md | 262 -- doc/http-request.md | 14 - doc/http-response.md | 13 - doc/logging-configuration-builder.md | 50 - doc/models/ach-debit-response.md | 23 - doc/models/activity-timestamps.md | 25 - doc/models/address-details.md | 38 - doc/models/address.md | 33 - doc/models/amount-breakdown.md | 48 - doc/models/amount-with-breakdown.md | 48 - doc/models/apple-pay-attributes-response.md | 36 - doc/models/apple-pay-attributes.md | 36 - doc/models/apple-pay-card-response.md | 40 - doc/models/apple-pay-card.md | 38 - doc/models/apple-pay-decrypted-token-data.md | 45 - doc/models/apple-pay-payment-data-type.md | 16 - doc/models/apple-pay-payment-data.md | 29 - doc/models/apple-pay-payment-object.md | 35 - doc/models/apple-pay-payment-token.md | 36 - doc/models/apple-pay-request.md | 56 - doc/models/apple-pay-tokenized-card.md | 33 - doc/models/authentication-response.md | 28 - doc/models/authorization-incomplete-reason.md | 16 - doc/models/authorization-status-details.md | 23 - .../authorization-status-with-details.md | 27 - doc/models/authorization-status.md | 20 - .../authorization-with-additional-data.md | 44 - doc/models/authorization.md | 43 - doc/models/avs-code.md | 38 - doc/models/bancontact-payment-object.md | 31 - doc/models/bancontact-payment-request.md | 33 - doc/models/bank-payment-token.md | 44 - doc/models/bin-details.md | 33 - doc/models/blik-experience-context.md | 33 - doc/models/blik-level-0-payment-object.md | 23 - doc/models/blik-one-click-payment-object.md | 23 - doc/models/blik-one-click-payment-request.md | 29 - doc/models/blik-payment-object.md | 31 - doc/models/blik-payment-request.md | 46 - doc/models/capture-incomplete-reason.md | 26 - doc/models/capture-payment-instruction.md | 48 - doc/models/capture-request.md | 68 - doc/models/capture-status-details.md | 23 - doc/models/capture-status-with-details.md | 27 - doc/models/capture-status.md | 20 - doc/models/capture.md | 48 - doc/models/captured-payment.md | 50 - doc/models/card-attributes-response.md | 36 - doc/models/card-attributes.md | 40 - doc/models/card-brand.md | 38 - doc/models/card-experience-context.md | 25 - doc/models/card-from-request.md | 25 - doc/models/card-payment-token.md | 45 - doc/models/card-request.md | 43 - doc/models/card-response-entity.md | 44 - doc/models/card-response.md | 40 - doc/models/card-stored-credential.md | 34 - doc/models/card-supplementary-data.md | 53 - doc/models/card-type.md | 19 - doc/models/card-verification-details.md | 35 - doc/models/card-verification-method.md | 18 - .../card-verification-processor-response.md | 25 - doc/models/card-verification.md | 23 - doc/models/checkout-payment-intent.md | 16 - doc/models/cobranded-card.md | 36 - doc/models/confirm-order-request.md | 109 - doc/models/customer-information.md | 32 - doc/models/customer-request.md | 25 - .../customer-vault-payment-tokens-response.md | 274 -- doc/models/cvv-code.md | 28 - doc/models/disbursement-mode.md | 16 - doc/models/dispute-category.md | 16 - doc/models/eci-flag.md | 20 - doc/models/enrollment-status.md | 18 - doc/models/eps-payment-object.md | 27 - doc/models/eps-payment-request.md | 33 - doc/models/error-details.md | 44 - doc/models/error-exception.md | 81 - doc/models/exchange-rate.md | 27 - doc/models/experience-context.md | 31 - doc/models/fullfillment-type.md | 18 - doc/models/giropay-payment-object.md | 27 - doc/models/giropay-payment-request.md | 33 - .../google-pay-authentication-method.md | 16 - doc/models/google-pay-card-attributes.md | 25 - doc/models/google-pay-card-response.md | 39 - doc/models/google-pay-decrypted-token-data.md | 33 - doc/models/google-pay-payment-method.md | 15 - doc/models/google-pay-request.md | 46 - doc/models/google-pay-wallet-response.md | 45 - doc/models/ideal-payment-object.md | 29 - doc/models/ideal-payment-request.md | 35 - doc/models/instrument-authorization-status.md | 20 - doc/models/item-category.md | 17 - doc/models/item.md | 45 - doc/models/level-2-card-processing-data.md | 28 - doc/models/level-3-card-processing-data.md | 48 - doc/models/liability-shift-indicator.md | 17 - doc/models/line-item.md | 48 - doc/models/link-description.md | 27 - doc/models/link-http-method.md | 22 - doc/models/money.md | 25 - doc/models/my-bank-payment-object.md | 29 - doc/models/my-bank-payment-request.md | 33 - doc/models/name.md | 25 - doc/models/net-amount-breakdown-item.md | 37 - doc/models/network-token.md | 31 - .../network-transaction-reference-entity.md | 29 - doc/models/network-transaction-reference.md | 29 - doc/models/o-auth-provider-error.md | 20 - doc/models/o-auth-provider-exception.md | 27 - doc/models/o-auth-token.md | 35 - .../order-application-context-landing-page.md | 17 - ...application-context-shipping-preference.md | 17 - .../order-application-context-user-action.md | 16 - doc/models/order-application-context.md | 35 - .../order-authorize-request-payment-source.md | 109 - doc/models/order-authorize-request.md | 106 - ...order-authorize-response-payment-source.md | 88 - doc/models/order-authorize-response.md | 98 - .../order-capture-request-payment-source.md | 109 - doc/models/order-capture-request.md | 106 - .../order-confirm-application-context.md | 41 - doc/models/order-request.md | 190 - doc/models/order-status.md | 20 - doc/models/order-tracker-item.md | 32 - doc/models/order-tracker-request.md | 48 - doc/models/order-tracker-response.md | 63 - doc/models/order-tracker-status.md | 16 - doc/models/order.md | 77 - doc/models/p24-payment-object.md | 32 - doc/models/p24-payment-request.md | 35 - doc/models/pa-res-status.md | 22 - doc/models/patch-op.md | 20 - doc/models/patch.md | 32 - doc/models/pay-pal-experience-landing-page.md | 17 - doc/models/pay-pal-experience-user-action.md | 16 - .../pay-pal-payment-token-customer-type.md | 16 - .../pay-pal-payment-token-usage-pattern.md | 20 - .../pay-pal-payment-token-usage-type.md | 16 - doc/models/pay-pal-payment-token.md | 49 - ...-pal-wallet-account-verification-status.md | 16 - .../pay-pal-wallet-attributes-response.md | 75 - doc/models/pay-pal-wallet-attributes.md | 42 - doc/models/pay-pal-wallet-customer-request.md | 32 - doc/models/pay-pal-wallet-customer.md | 34 - .../pay-pal-wallet-experience-context.md | 37 - doc/models/pay-pal-wallet-response.md | 39 - .../pay-pal-wallet-vault-instruction.md | 31 - doc/models/pay-pal-wallet-vault-response.md | 45 - doc/models/pay-pal-wallet-vault-status.md | 17 - doc/models/pay-pal-wallet.md | 44 - doc/models/payee-base.md | 25 - doc/models/payee-payment-method-preference.md | 16 - doc/models/payee.md | 25 - doc/models/payer-base.md | 25 - doc/models/payer.md | 39 - doc/models/payment-advice-code.md | 18 - doc/models/payment-authorization.md | 45 - doc/models/payment-collection.md | 114 - doc/models/payment-initiator.md | 16 - doc/models/payment-instruction.md | 40 - doc/models/payment-method-preference.md | 25 - doc/models/payment-source-response.md | 74 - doc/models/payment-source.md | 101 - doc/models/payment-supplementary-data.md | 27 - doc/models/payment-token-request-card.md | 34 - .../payment-token-request-payment-source.md | 34 - doc/models/payment-token-request.md | 40 - .../payment-token-response-payment-source.md | 119 - doc/models/payment-token-response.md | 137 - doc/models/phone-number-with-country-code.md | 25 - doc/models/phone-number.md | 23 - doc/models/phone-type.md | 19 - doc/models/phone-with-type.md | 27 - doc/models/phone.md | 27 - doc/models/platform-fee.md | 31 - doc/models/processing-instruction.md | 16 - doc/models/processor-response-code.md | 168 - doc/models/processor-response.md | 29 - doc/models/purchase-unit-request.md | 102 - doc/models/purchase-unit.md | 103 - doc/models/reauthorize-request.md | 26 - doc/models/refund-incomplete-reason.md | 15 - doc/models/refund-payment-instruction.md | 36 - doc/models/refund-platform-fee.md | 26 - doc/models/refund-request.md | 55 - doc/models/refund-status-details.md | 23 - doc/models/refund-status-with-details.md | 27 - doc/models/refund-status.md | 18 - doc/models/refund.md | 44 - doc/models/related-identifiers.md | 27 - doc/models/seller-payable-breakdown.md | 49 - doc/models/seller-protection-status.md | 17 - doc/models/seller-protection.md | 27 - doc/models/seller-receivable-breakdown.md | 53 - .../sepa-debit-authorization-details.md | 23 - doc/models/sepa-debit-response.md | 39 - .../setup-token-card-experience-context.md | 31 - doc/models/setup-token-request-card.md | 36 - .../setup-token-request-payment-source.md | 76 - doc/models/setup-token-request.md | 80 - doc/models/setup-token-response-card.md | 42 - .../setup-token-response-payment-source.md | 78 - doc/models/setup-token-response.md | 90 - doc/models/shipment-carrier.md | 1290 ------ doc/models/shipping-details.md | 69 - doc/models/shipping-name.md | 23 - doc/models/shipping-option.md | 34 - doc/models/shipping-preference.md | 17 - doc/models/shipping-type.md | 18 - doc/models/shipping-with-tracking-details.md | 114 - doc/models/sofort-payment-object.md | 29 - doc/models/sofort-payment-request.md | 33 - doc/models/standard-entry-class-code.md | 18 - doc/models/store-in-vault-instruction.md | 15 - .../stored-payment-source-payment-type.md | 17 - .../stored-payment-source-usage-type.md | 17 - doc/models/stored-payment-source.md | 34 - doc/models/supplementary-data.md | 54 - doc/models/supplementary-purchase-data.md | 25 - doc/models/tax-id-type.md | 16 - doc/models/tax-info.md | 25 - .../three-d-secure-authentication-response.md | 25 - doc/models/token-type.md | 16 - doc/models/token.md | 25 - doc/models/trustly-payment-object.md | 29 - doc/models/trustly-payment-request.md | 33 - doc/models/universal-product-code.md | 25 - doc/models/upc-type.md | 21 - doc/models/vault-customer.md | 23 - doc/models/vault-experience-context.md | 33 - doc/models/vault-instruction-base.md | 23 - doc/models/vault-instruction.md | 23 - doc/models/vault-pay-pal-wallet-request.md | 45 - doc/models/vault-response.md | 37 - doc/models/vault-sepa-debit-response.md | 37 - doc/models/vault-status.md | 17 - doc/models/vault-token-request.md | 25 - doc/models/vault-venmo-experience-context.md | 27 - doc/models/vault-venmo-request.md | 43 - ...vaulted-digital-wallet-shipping-details.md | 36 - doc/models/vaulted-digital-wallet.md | 44 - .../venmo-payment-token-customer-type.md | 16 - .../venmo-payment-token-usage-pattern.md | 20 - doc/models/venmo-payment-token-usage-type.md | 16 - doc/models/venmo-payment-token.md | 48 - .../venmo-wallet-additional-attributes.md | 35 - .../venmo-wallet-attributes-response.md | 36 - .../venmo-wallet-customer-information.md | 25 - doc/models/venmo-wallet-experience-context.md | 25 - doc/models/venmo-wallet-request.md | 45 - doc/models/venmo-wallet-response.md | 38 - doc/models/venmo-wallet-vault-attributes.md | 33 - doc/request-logging-configuration-builder.md | 16 - doc/response-logging-configuration-builder.md | 15 - phpcs-ruleset.xml | 5 - src/ApiHelper.php | 114 - ...lientCredentialsAuthCredentialsBuilder.php | 127 - .../ClientCredentialsAuthManager.php | 206 - src/ClientCredentialsAuth.php | 55 - src/ConfigurationDefaults.php | 97 - src/ConfigurationInterface.php | 50 - src/Controllers/BaseController.php | 52 - .../OAuthAuthorizationController.php | 60 - src/Controllers/OrdersController.php | 486 --- src/Controllers/PaymentsController.php | 435 -- src/Controllers/VaultController.php | 260 -- src/Environment.php | 27 - src/Exceptions/ApiException.php | 71 - src/Exceptions/ErrorException.php | 175 - src/Exceptions/OAuthProviderException.php | 114 - src/Http/ApiResponse.php | 45 - src/Http/HttpCallBack.php | 20 - src/Http/HttpContext.php | 39 - src/Http/HttpMethod.php | 26 - src/Http/HttpRequest.php | 20 - src/Http/HttpResponse.php | 20 - src/Logging/LoggingConfigurationBuilder.php | 109 - .../RequestLoggingConfigurationBuilder.php | 93 - .../ResponseLoggingConfigurationBuilder.php | 84 - src/Models/ACHDebitResponse.php | 63 - src/Models/AVSCode.php | 114 - src/Models/ActivityTimestamps.php | 100 - src/Models/Address.php | 231 - src/Models/AddressDetails.php | 372 -- src/Models/AmountBreakdown.php | 232 - src/Models/AmountWithBreakdown.php | 142 - src/Models/ApplePayAttributes.php | 93 - src/Models/ApplePayAttributesResponse.php | 63 - src/Models/ApplePayCard.php | 181 - src/Models/ApplePayCardResponse.php | 391 -- src/Models/ApplePayDecryptedTokenData.php | 186 - src/Models/ApplePayPaymentData.php | 153 - src/Models/ApplePayPaymentDataType.php | 46 - src/Models/ApplePayPaymentObject.php | 243 -- src/Models/ApplePayPaymentToken.php | 63 - src/Models/ApplePayRequest.php | 285 -- src/Models/ApplePayTokenizedCard.php | 239 - src/Models/AuthenticationResponse.php | 91 - src/Models/Authorization.php | 393 -- src/Models/AuthorizationIncompleteReason.php | 45 - src/Models/AuthorizationStatus.php | 54 - src/Models/AuthorizationStatusDetails.php | 63 - src/Models/AuthorizationStatusWithDetails.php | 91 - .../AuthorizationWithAdditionalData.php | 422 -- src/Models/BLIKExperienceContext.php | 247 -- src/Models/BLIKLevel0PaymentObject.php | 70 - src/Models/BLIKOneClickPaymentObject.php | 65 - src/Models/BLIKOneClickPaymentRequest.php | 160 - src/Models/BLIKPaymentObject.php | 161 - src/Models/BLIKPaymentRequest.php | 225 - src/Models/BancontactPaymentObject.php | 185 - src/Models/BancontactPaymentRequest.php | 135 - src/Models/BankPaymentToken.php | 89 - src/Models/BinDetails.php | 163 - .../Builders/ACHDebitResponseBuilder.php | 57 - .../Builders/ActivityTimestampsBuilder.php | 66 - src/Models/Builders/AddressBuilder.php | 93 - src/Models/Builders/AddressDetailsBuilder.php | 140 - .../Builders/AmountBreakdownBuilder.php | 112 - .../Builders/AmountWithBreakdownBuilder.php | 58 - .../Builders/ApplePayAttributesBuilder.php | 68 - .../ApplePayAttributesResponseBuilder.php | 58 - src/Models/Builders/ApplePayCardBuilder.php | 94 - .../Builders/ApplePayCardResponseBuilder.php | 161 - .../ApplePayDecryptedTokenDataBuilder.php | 87 - .../Builders/ApplePayPaymentDataBuilder.php | 84 - .../Builders/ApplePayPaymentObjectBuilder.php | 114 - .../Builders/ApplePayPaymentTokenBuilder.php | 58 - .../Builders/ApplePayRequestBuilder.php | 124 - .../Builders/ApplePayTokenizedCardBuilder.php | 112 - .../AuthenticationResponseBuilder.php | 67 - src/Models/Builders/AuthorizationBuilder.php | 160 - .../AuthorizationStatusDetailsBuilder.php | 57 - .../AuthorizationStatusWithDetailsBuilder.php | 67 - ...AuthorizationWithAdditionalDataBuilder.php | 170 - .../Builders/BLIKExperienceContextBuilder.php | 111 - .../BLIKLevel0PaymentObjectBuilder.php | 48 - .../BLIKOneClickPaymentObjectBuilder.php | 57 - .../BLIKOneClickPaymentRequestBuilder.php | 75 - .../Builders/BLIKPaymentObjectBuilder.php | 85 - .../Builders/BLIKPaymentRequestBuilder.php | 87 - .../BancontactPaymentObjectBuilder.php | 93 - .../BancontactPaymentRequestBuilder.php | 58 - .../Builders/BankPaymentTokenBuilder.php | 68 - src/Models/Builders/BinDetailsBuilder.php | 84 - src/Models/Builders/CaptureBuilder.php | 189 - .../CapturePaymentInstructionBuilder.php | 75 - src/Models/Builders/CaptureRequestBuilder.php | 104 - .../Builders/CaptureStatusDetailsBuilder.php | 57 - .../CaptureStatusWithDetailsBuilder.php | 67 - .../Builders/CapturedPaymentBuilder.php | 209 - src/Models/Builders/CardAttributesBuilder.php | 78 - .../CardAttributesResponseBuilder.php | 58 - .../Builders/CardExperienceContextBuilder.php | 66 - .../Builders/CardFromRequestBuilder.php | 66 - .../Builders/CardPaymentTokenBuilder.php | 161 - src/Models/Builders/CardRequestBuilder.php | 143 - src/Models/Builders/CardResponseBuilder.php | 142 - .../Builders/CardResponseEntityBuilder.php | 152 - .../Builders/CardStoredCredentialBuilder.php | 67 - .../Builders/CardSupplementaryDataBuilder.php | 68 - .../Builders/CardVerificationBuilder.php | 57 - .../CardVerificationDetailsBuilder.php | 104 - ...rdVerificationProcessorResponseBuilder.php | 66 - src/Models/Builders/CobrandedCardBuilder.php | 77 - .../Builders/ConfirmOrderRequestBuilder.php | 68 - .../Builders/CustomerInformationBuilder.php | 76 - .../Builders/CustomerRequestBuilder.php | 66 - ...tomerVaultPaymentTokensResponseBuilder.php | 94 - .../Builders/EPSPaymentObjectBuilder.php | 75 - .../Builders/EPSPaymentRequestBuilder.php | 58 - src/Models/Builders/ErrorDetailsBuilder.php | 93 - src/Models/Builders/ExchangeRateBuilder.php | 75 - .../Builders/ExperienceContextBuilder.php | 93 - .../Builders/GiropayPaymentObjectBuilder.php | 75 - .../Builders/GiropayPaymentRequestBuilder.php | 58 - .../GooglePayCardAttributesBuilder.php | 58 - .../Builders/GooglePayCardResponseBuilder.php | 104 - .../GooglePayDecryptedTokenDataBuilder.php | 84 - .../Builders/GooglePayRequestBuilder.php | 114 - .../GooglePayWalletResponseBuilder.php | 86 - .../Builders/IDEALPaymentObjectBuilder.php | 84 - .../Builders/IDEALPaymentRequestBuilder.php | 67 - src/Models/Builders/ItemBuilder.php | 113 - .../Level2CardProcessingDataBuilder.php | 67 - .../Level3CardProcessingDataBuilder.php | 104 - src/Models/Builders/LineItemBuilder.php | 140 - .../Builders/LinkDescriptionBuilder.php | 57 - src/Models/Builders/MoneyBuilder.php | 48 - .../Builders/MyBankPaymentObjectBuilder.php | 84 - .../Builders/MyBankPaymentRequestBuilder.php | 58 - src/Models/Builders/NameBuilder.php | 66 - .../NetAmountBreakdownItemBuilder.php | 77 - src/Models/Builders/NetworkTokenBuilder.php | 75 - .../NetworkTransactionReferenceBuilder.php | 75 - ...tworkTransactionReferenceEntityBuilder.php | 75 - src/Models/Builders/OAuthTokenBuilder.php | 93 - .../OrderApplicationContextBuilder.php | 131 - .../Builders/OrderAuthorizeRequestBuilder.php | 58 - ...erAuthorizeRequestPaymentSourceBuilder.php | 108 - .../OrderAuthorizeResponseBuilder.php | 140 - ...rAuthorizeResponsePaymentSourceBuilder.php | 98 - src/Models/Builders/OrderBuilder.php | 140 - .../Builders/OrderCaptureRequestBuilder.php | 58 - ...rderCaptureRequestPaymentSourceBuilder.php | 108 - .../OrderConfirmApplicationContextBuilder.php | 94 - src/Models/Builders/OrderRequestBuilder.php | 78 - .../Builders/OrderTrackerItemBuilder.php | 103 - .../Builders/OrderTrackerRequestBuilder.php | 93 - .../Builders/OrderTrackerResponseBuilder.php | 102 - .../Builders/P24PaymentObjectBuilder.php | 102 - .../Builders/P24PaymentRequestBuilder.php | 58 - src/Models/Builders/PatchBuilder.php | 75 - .../Builders/PayPalPaymentTokenBuilder.php | 161 - .../PayPalWalletAttributesBuilder.php | 68 - .../PayPalWalletAttributesResponseBuilder.php | 67 - src/Models/Builders/PayPalWalletBuilder.php | 144 - .../Builders/PayPalWalletCustomerBuilder.php | 85 - .../PayPalWalletCustomerRequestBuilder.php | 85 - .../PayPalWalletExperienceContextBuilder.php | 120 - .../Builders/PayPalWalletResponseBuilder.php | 143 - .../PayPalWalletVaultInstructionBuilder.php | 93 - .../PayPalWalletVaultResponseBuilder.php | 85 - src/Models/Builders/PayeeBaseBuilder.php | 66 - src/Models/Builders/PayeeBuilder.php | 66 - src/Models/Builders/PayerBaseBuilder.php | 66 - src/Models/Builders/PayerBuilder.php | 115 - .../Builders/PaymentAuthorizationBuilder.php | 180 - .../Builders/PaymentCollectionBuilder.php | 75 - .../Builders/PaymentInstructionBuilder.php | 84 - .../PaymentMethodPreferenceBuilder.php | 66 - src/Models/Builders/PaymentSourceBuilder.php | 198 - .../Builders/PaymentSourceResponseBuilder.php | 188 - .../PaymentSupplementaryDataBuilder.php | 58 - .../Builders/PaymentTokenRequestBuilder.php | 59 - .../PaymentTokenRequestCardBuilder.php | 121 - ...aymentTokenRequestPaymentSourceBuilder.php | 68 - .../Builders/PaymentTokenResponseBuilder.php | 86 - ...ymentTokenResponsePaymentSourceBuilder.php | 98 - src/Models/Builders/PhoneBuilder.php | 57 - src/Models/Builders/PhoneNumberBuilder.php | 48 - .../PhoneNumberWithCountryCodeBuilder.php | 48 - src/Models/Builders/PhoneWithTypeBuilder.php | 58 - src/Models/Builders/PlatformFeeBuilder.php | 59 - .../Builders/ProcessorResponseBuilder.php | 84 - src/Models/Builders/PurchaseUnitBuilder.php | 171 - .../Builders/PurchaseUnitRequestBuilder.php | 143 - .../Builders/ReauthorizeRequestBuilder.php | 58 - src/Models/Builders/RefundBuilder.php | 169 - .../RefundPaymentInstructionBuilder.php | 57 - .../Builders/RefundPlatformFeeBuilder.php | 49 - src/Models/Builders/RefundRequestBuilder.php | 95 - .../Builders/RefundStatusDetailsBuilder.php | 57 - .../RefundStatusWithDetailsBuilder.php | 67 - .../Builders/RelatedIdentifiersBuilder.php | 75 - .../SEPADebitAuthorizationDetailsBuilder.php | 57 - .../Builders/SEPADebitResponseBuilder.php | 86 - .../SellerPayableBreakdownBuilder.php | 121 - .../Builders/SellerProtectionBuilder.php | 66 - .../SellerReceivableBreakdownBuilder.php | 104 - ...SetupTokenCardExperienceContextBuilder.php | 93 - .../Builders/SetupTokenRequestBuilder.php | 59 - .../Builders/SetupTokenRequestCardBuilder.php | 140 - .../SetupTokenRequestPaymentSourceBuilder.php | 88 - .../Builders/SetupTokenResponseBuilder.php | 104 - .../SetupTokenResponseCardBuilder.php | 152 - ...SetupTokenResponsePaymentSourceBuilder.php | 78 - .../Builders/ShippingDetailsBuilder.php | 86 - src/Models/Builders/ShippingNameBuilder.php | 57 - src/Models/Builders/ShippingOptionBuilder.php | 67 - .../ShippingWithTrackingDetailsBuilder.php | 95 - .../Builders/SofortPaymentObjectBuilder.php | 84 - .../Builders/SofortPaymentRequestBuilder.php | 58 - .../Builders/StoredPaymentSourceBuilder.php | 67 - .../Builders/SupplementaryDataBuilder.php | 58 - .../SupplementaryPurchaseDataBuilder.php | 66 - src/Models/Builders/TaxInfoBuilder.php | 48 - ...eeDSecureAuthenticationResponseBuilder.php | 66 - src/Models/Builders/TokenBuilder.php | 48 - .../Builders/TrustlyPaymentObjectBuilder.php | 84 - .../Builders/TrustlyPaymentRequestBuilder.php | 58 - .../Builders/UniversalProductCodeBuilder.php | 48 - src/Models/Builders/VaultCustomerBuilder.php | 57 - .../VaultExperienceContextBuilder.php | 102 - .../Builders/VaultInstructionBaseBuilder.php | 57 - .../Builders/VaultInstructionBuilder.php | 48 - .../VaultPayPalWalletRequestBuilder.php | 104 - src/Models/Builders/VaultResponseBuilder.php | 85 - .../VaultSEPADebitResponseBuilder.php | 76 - .../Builders/VaultTokenRequestBuilder.php | 48 - .../VaultVenmoExperienceContextBuilder.php | 75 - .../Builders/VaultVenmoRequestBuilder.php | 104 - .../Builders/VaultedDigitalWalletBuilder.php | 94 - ...tedDigitalWalletShippingDetailsBuilder.php | 77 - .../Builders/VenmoPaymentTokenBuilder.php | 151 - ...VenmoWalletAdditionalAttributesBuilder.php | 68 - .../VenmoWalletAttributesResponseBuilder.php | 58 - .../VenmoWalletCustomerInformationBuilder.php | 66 - .../VenmoWalletExperienceContextBuilder.php | 66 - .../Builders/VenmoWalletRequestBuilder.php | 86 - .../Builders/VenmoWalletResponseBuilder.php | 115 - .../VenmoWalletVaultAttributesBuilder.php | 84 - src/Models/CVVCode.php | 84 - src/Models/Capture.php | 479 -- src/Models/CaptureIncompleteReason.php | 78 - src/Models/CapturePaymentInstruction.php | 128 - src/Models/CaptureRequest.php | 210 - src/Models/CaptureStatus.php | 54 - src/Models/CaptureStatusDetails.php | 63 - src/Models/CaptureStatusWithDetails.php | 91 - src/Models/CapturedPayment.php | 537 --- src/Models/CardAttributes.php | 123 - src/Models/CardAttributesResponse.php | 63 - src/Models/CardBrand.php | 114 - src/Models/CardExperienceContext.php | 91 - src/Models/CardFromRequest.php | 93 - src/Models/CardPaymentToken.php | 376 -- src/Models/CardRequest.php | 346 -- src/Models/CardResponse.php | 321 -- src/Models/CardResponseEntity.php | 346 -- src/Models/CardStoredCredential.php | 168 - src/Models/CardSupplementaryData.php | 102 - src/Models/CardType.php | 51 - src/Models/CardVerification.php | 64 - src/Models/CardVerificationDetails.php | 211 - src/Models/CardVerificationMethod.php | 49 - .../CardVerificationProcessorResponse.php | 91 - src/Models/CheckoutPaymentIntent.php | 46 - src/Models/CobrandedCard.php | 125 - src/Models/ConfirmOrderRequest.php | 126 - src/Models/CustomerInformation.php | 125 - src/Models/CustomerRequest.php | 95 - .../CustomerVaultPaymentTokensResponse.php | 181 - src/Models/DisbursementMode.php | 45 - src/Models/DisputeCategory.php | 45 - src/Models/ECIFlag.php | 62 - src/Models/EPSPaymentObject.php | 129 - src/Models/EPSPaymentRequest.php | 135 - src/Models/EnrollmentStatus.php | 49 - src/Models/ErrorDetails.php | 220 - src/Models/ExchangeRate.php | 125 - src/Models/ExperienceContext.php | 187 - src/Models/FullfillmentType.php | 51 - src/Models/GiropayPaymentObject.php | 129 - src/Models/GiropayPaymentRequest.php | 135 - src/Models/GooglePayAuthenticationMethod.php | 45 - src/Models/GooglePayCardAttributes.php | 65 - src/Models/GooglePayCardResponse.php | 209 - src/Models/GooglePayDecryptedTokenData.php | 218 - src/Models/GooglePayPaymentMethod.php | 43 - src/Models/GooglePayRequest.php | 247 -- src/Models/GooglePayWalletResponse.php | 155 - src/Models/IDEALPaymentObject.php | 157 - src/Models/IDEALPaymentRequest.php | 165 - src/Models/InstrumentAuthorizationStatus.php | 61 - src/Models/Item.php | 326 -- src/Models/ItemCategory.php | 47 - src/Models/Level2CardProcessingData.php | 95 - src/Models/Level3CardProcessingData.php | 217 - src/Models/LiabilityShiftIndicator.php | 47 - src/Models/LineItem.php | 423 -- src/Models/LinkDescription.php | 137 - src/Models/LinkHTTPMethod.php | 58 - src/Models/Money.php | 107 - src/Models/MyBankPaymentObject.php | 157 - src/Models/MyBankPaymentRequest.php | 135 - src/Models/Name.php | 95 - src/Models/NetAmountBreakdownItem.php | 120 - src/Models/NetworkToken.php | 195 - src/Models/NetworkTransactionReference.php | 164 - .../NetworkTransactionReferenceEntity.php | 166 - src/Models/OAuthProviderError.php | 84 - src/Models/OAuthToken.php | 245 -- src/Models/Order.php | 349 -- src/Models/OrderApplicationContext.php | 369 -- .../OrderApplicationContextLandingPage.php | 51 - ...erApplicationContextShippingPreference.php | 53 - .../OrderApplicationContextUserAction.php | 49 - src/Models/OrderAuthorizeRequest.php | 63 - .../OrderAuthorizeRequestPaymentSource.php | 213 - src/Models/OrderAuthorizeResponse.php | 334 -- .../OrderAuthorizeResponsePaymentSource.php | 175 - src/Models/OrderCaptureRequest.php | 63 - .../OrderCaptureRequestPaymentSource.php | 213 - src/Models/OrderConfirmApplicationContext.php | 199 - src/Models/OrderRequest.php | 197 - src/Models/OrderStatus.php | 54 - src/Models/OrderTrackerItem.php | 205 - src/Models/OrderTrackerRequest.php | 228 - src/Models/OrderTrackerResponse.php | 219 - src/Models/OrderTrackerStatus.php | 45 - src/Models/P24PaymentObject.php | 217 - src/Models/P24PaymentRequest.php | 170 - src/Models/PAResStatus.php | 57 - src/Models/Patch.php | 166 - src/Models/PatchOp.php | 53 - src/Models/PayPalExperienceLandingPage.php | 47 - src/Models/PayPalExperienceUserAction.php | 45 - src/Models/PayPalPaymentToken.php | 396 -- src/Models/PayPalPaymentTokenCustomerType.php | 46 - src/Models/PayPalPaymentTokenUsagePattern.php | 60 - src/Models/PayPalPaymentTokenUsageType.php | 45 - src/Models/PayPalWallet.php | 345 -- .../PayPalWalletAccountVerificationStatus.php | 46 - src/Models/PayPalWalletAttributes.php | 87 - src/Models/PayPalWalletAttributesResponse.php | 97 - src/Models/PayPalWalletCustomer.php | 157 - src/Models/PayPalWalletCustomerRequest.php | 154 - src/Models/PayPalWalletExperienceContext.php | 277 -- src/Models/PayPalWalletResponse.php | 345 -- src/Models/PayPalWalletVaultInstruction.php | 221 - src/Models/PayPalWalletVaultResponse.php | 151 - src/Models/PayPalWalletVaultStatus.php | 47 - src/Models/Payee.php | 99 - src/Models/PayeeBase.php | 98 - src/Models/PayeePaymentMethodPreference.php | 45 - src/Models/Payer.php | 250 -- src/Models/PayerBase.php | 97 - src/Models/PaymentAdviceCode.php | 50 - src/Models/PaymentAuthorization.php | 451 -- src/Models/PaymentCollection.php | 136 - src/Models/PaymentInitiator.php | 45 - src/Models/PaymentInstruction.php | 164 - src/Models/PaymentMethodPreference.php | 101 - src/Models/PaymentSource.php | 465 -- src/Models/PaymentSourceResponse.php | 427 -- src/Models/PaymentSupplementaryData.php | 63 - src/Models/PaymentTokenRequest.php | 98 - src/Models/PaymentTokenRequestCard.php | 271 -- .../PaymentTokenRequestPaymentSource.php | 91 - src/Models/PaymentTokenResponse.php | 151 - .../PaymentTokenResponsePaymentSource.php | 171 - src/Models/Phone.php | 140 - src/Models/PhoneNumber.php | 77 - src/Models/PhoneNumberWithCountryCode.php | 112 - src/Models/PhoneType.php | 51 - src/Models/PhoneWithType.php | 100 - src/Models/PlatformFee.php | 102 - src/Models/ProcessingInstruction.php | 45 - src/Models/ProcessorResponse.php | 149 - src/Models/ProcessorResponseCode.php | 504 --- src/Models/PurchaseUnit.php | 453 -- src/Models/PurchaseUnitRequest.php | 404 -- src/Models/ReauthorizeRequest.php | 71 - src/Models/Refund.php | 421 -- src/Models/RefundIncompleteReason.php | 43 - src/Models/RefundPaymentInstruction.php | 77 - src/Models/RefundPlatformFee.php | 72 - src/Models/RefundRequest.php | 188 - src/Models/RefundStatus.php | 49 - src/Models/RefundStatusDetails.php | 63 - src/Models/RefundStatusWithDetails.php | 91 - src/Models/RelatedIdentifiers.php | 119 - src/Models/SEPADebitAuthorizationDetails.php | 63 - src/Models/SEPADebitResponse.php | 152 - src/Models/SellerPayableBreakdown.php | 269 -- src/Models/SellerProtection.php | 98 - src/Models/SellerProtectionStatus.php | 48 - src/Models/SellerReceivableBreakdown.php | 245 -- .../SetupTokenCardExperienceContext.php | 191 - src/Models/SetupTokenRequest.php | 98 - src/Models/SetupTokenRequestCard.php | 327 -- src/Models/SetupTokenRequestPaymentSource.php | 145 - src/Models/SetupTokenResponse.php | 207 - src/Models/SetupTokenResponseCard.php | 343 -- .../SetupTokenResponsePaymentSource.php | 113 - src/Models/ShipmentCarrier.php | 3875 ----------------- src/Models/ShippingDetails.php | 161 - src/Models/ShippingName.php | 63 - src/Models/ShippingOption.php | 196 - src/Models/ShippingPreference.php | 47 - src/Models/ShippingType.php | 49 - src/Models/ShippingWithTrackingDetails.php | 193 - src/Models/SofortPaymentObject.php | 157 - src/Models/SofortPaymentRequest.php | 135 - src/Models/StandardEntryClassCode.php | 54 - src/Models/StoreInVaultInstruction.php | 43 - src/Models/StoredPaymentSource.php | 168 - src/Models/StoredPaymentSourcePaymentType.php | 47 - src/Models/StoredPaymentSourceUsageType.php | 48 - src/Models/SupplementaryData.php | 70 - src/Models/SupplementaryPurchaseData.php | 96 - src/Models/TaxIdType.php | 45 - src/Models/TaxInfo.php | 100 - .../ThreeDSecureAuthenticationResponse.php | 91 - src/Models/Token.php | 99 - src/Models/TokenType.php | 45 - src/Models/TrustlyPaymentObject.php | 157 - src/Models/TrustlyPaymentRequest.php | 135 - src/Models/UPCType.php | 55 - src/Models/UniversalProductCode.php | 99 - src/Models/VaultCustomer.php | 63 - src/Models/VaultExperienceContext.php | 219 - src/Models/VaultInstruction.php | 71 - src/Models/VaultInstructionBase.php | 64 - src/Models/VaultPayPalWalletRequest.php | 217 - src/Models/VaultResponse.php | 151 - src/Models/VaultSEPADebitResponse.php | 127 - src/Models/VaultStatus.php | 47 - src/Models/VaultTokenRequest.php | 99 - src/Models/VaultVenmoExperienceContext.php | 121 - src/Models/VaultVenmoRequest.php | 214 - src/Models/VaultedDigitalWallet.php | 189 - .../VaultedDigitalWalletShippingDetails.php | 127 - src/Models/VenmoPaymentToken.php | 366 -- src/Models/VenmoPaymentTokenCustomerType.php | 46 - src/Models/VenmoPaymentTokenUsagePattern.php | 60 - src/Models/VenmoPaymentTokenUsageType.php | 45 - .../VenmoWalletAdditionalAttributes.php | 91 - src/Models/VenmoWalletAttributesResponse.php | 63 - src/Models/VenmoWalletCustomerInformation.php | 97 - src/Models/VenmoWalletExperienceContext.php | 94 - src/Models/VenmoWalletRequest.php | 161 - src/Models/VenmoWalletResponse.php | 249 -- src/Models/VenmoWalletVaultAttributes.php | 223 - src/PayPalRESTAPIsClient.php | 283 -- src/PayPalRESTAPIsClientBuilder.php | 187 - src/Server.php | 19 - src/Utils/CompatibilityConverter.php | 70 - 731 files changed, 73488 deletions(-) delete mode 100644 .gitattributes delete mode 100644 .phan/config.php delete mode 100644 LICENSE delete mode 100644 README.md delete mode 100644 composer.json delete mode 100644 doc/api-exception.md delete mode 100644 doc/auth/oauth-2-client-credentials-grant.md delete mode 100644 doc/client.md delete mode 100644 doc/controllers/orders.md delete mode 100644 doc/controllers/payments.md delete mode 100644 doc/controllers/vault.md delete mode 100644 doc/http-request.md delete mode 100644 doc/http-response.md delete mode 100644 doc/logging-configuration-builder.md delete mode 100644 doc/models/ach-debit-response.md delete mode 100644 doc/models/activity-timestamps.md delete mode 100644 doc/models/address-details.md delete mode 100644 doc/models/address.md delete mode 100644 doc/models/amount-breakdown.md delete mode 100644 doc/models/amount-with-breakdown.md delete mode 100644 doc/models/apple-pay-attributes-response.md delete mode 100644 doc/models/apple-pay-attributes.md delete mode 100644 doc/models/apple-pay-card-response.md delete mode 100644 doc/models/apple-pay-card.md delete mode 100644 doc/models/apple-pay-decrypted-token-data.md delete mode 100644 doc/models/apple-pay-payment-data-type.md delete mode 100644 doc/models/apple-pay-payment-data.md delete mode 100644 doc/models/apple-pay-payment-object.md delete mode 100644 doc/models/apple-pay-payment-token.md delete mode 100644 doc/models/apple-pay-request.md delete mode 100644 doc/models/apple-pay-tokenized-card.md delete mode 100644 doc/models/authentication-response.md delete mode 100644 doc/models/authorization-incomplete-reason.md delete mode 100644 doc/models/authorization-status-details.md delete mode 100644 doc/models/authorization-status-with-details.md delete mode 100644 doc/models/authorization-status.md delete mode 100644 doc/models/authorization-with-additional-data.md delete mode 100644 doc/models/authorization.md delete mode 100644 doc/models/avs-code.md delete mode 100644 doc/models/bancontact-payment-object.md delete mode 100644 doc/models/bancontact-payment-request.md delete mode 100644 doc/models/bank-payment-token.md delete mode 100644 doc/models/bin-details.md delete mode 100644 doc/models/blik-experience-context.md delete mode 100644 doc/models/blik-level-0-payment-object.md delete mode 100644 doc/models/blik-one-click-payment-object.md delete mode 100644 doc/models/blik-one-click-payment-request.md delete mode 100644 doc/models/blik-payment-object.md delete mode 100644 doc/models/blik-payment-request.md delete mode 100644 doc/models/capture-incomplete-reason.md delete mode 100644 doc/models/capture-payment-instruction.md delete mode 100644 doc/models/capture-request.md delete mode 100644 doc/models/capture-status-details.md delete mode 100644 doc/models/capture-status-with-details.md delete mode 100644 doc/models/capture-status.md delete mode 100644 doc/models/capture.md delete mode 100644 doc/models/captured-payment.md delete mode 100644 doc/models/card-attributes-response.md delete mode 100644 doc/models/card-attributes.md delete mode 100644 doc/models/card-brand.md delete mode 100644 doc/models/card-experience-context.md delete mode 100644 doc/models/card-from-request.md delete mode 100644 doc/models/card-payment-token.md delete mode 100644 doc/models/card-request.md delete mode 100644 doc/models/card-response-entity.md delete mode 100644 doc/models/card-response.md delete mode 100644 doc/models/card-stored-credential.md delete mode 100644 doc/models/card-supplementary-data.md delete mode 100644 doc/models/card-type.md delete mode 100644 doc/models/card-verification-details.md delete mode 100644 doc/models/card-verification-method.md delete mode 100644 doc/models/card-verification-processor-response.md delete mode 100644 doc/models/card-verification.md delete mode 100644 doc/models/checkout-payment-intent.md delete mode 100644 doc/models/cobranded-card.md delete mode 100644 doc/models/confirm-order-request.md delete mode 100644 doc/models/customer-information.md delete mode 100644 doc/models/customer-request.md delete mode 100644 doc/models/customer-vault-payment-tokens-response.md delete mode 100644 doc/models/cvv-code.md delete mode 100644 doc/models/disbursement-mode.md delete mode 100644 doc/models/dispute-category.md delete mode 100644 doc/models/eci-flag.md delete mode 100644 doc/models/enrollment-status.md delete mode 100644 doc/models/eps-payment-object.md delete mode 100644 doc/models/eps-payment-request.md delete mode 100644 doc/models/error-details.md delete mode 100644 doc/models/error-exception.md delete mode 100644 doc/models/exchange-rate.md delete mode 100644 doc/models/experience-context.md delete mode 100644 doc/models/fullfillment-type.md delete mode 100644 doc/models/giropay-payment-object.md delete mode 100644 doc/models/giropay-payment-request.md delete mode 100644 doc/models/google-pay-authentication-method.md delete mode 100644 doc/models/google-pay-card-attributes.md delete mode 100644 doc/models/google-pay-card-response.md delete mode 100644 doc/models/google-pay-decrypted-token-data.md delete mode 100644 doc/models/google-pay-payment-method.md delete mode 100644 doc/models/google-pay-request.md delete mode 100644 doc/models/google-pay-wallet-response.md delete mode 100644 doc/models/ideal-payment-object.md delete mode 100644 doc/models/ideal-payment-request.md delete mode 100644 doc/models/instrument-authorization-status.md delete mode 100644 doc/models/item-category.md delete mode 100644 doc/models/item.md delete mode 100644 doc/models/level-2-card-processing-data.md delete mode 100644 doc/models/level-3-card-processing-data.md delete mode 100644 doc/models/liability-shift-indicator.md delete mode 100644 doc/models/line-item.md delete mode 100644 doc/models/link-description.md delete mode 100644 doc/models/link-http-method.md delete mode 100644 doc/models/money.md delete mode 100644 doc/models/my-bank-payment-object.md delete mode 100644 doc/models/my-bank-payment-request.md delete mode 100644 doc/models/name.md delete mode 100644 doc/models/net-amount-breakdown-item.md delete mode 100644 doc/models/network-token.md delete mode 100644 doc/models/network-transaction-reference-entity.md delete mode 100644 doc/models/network-transaction-reference.md delete mode 100644 doc/models/o-auth-provider-error.md delete mode 100644 doc/models/o-auth-provider-exception.md delete mode 100644 doc/models/o-auth-token.md delete mode 100644 doc/models/order-application-context-landing-page.md delete mode 100644 doc/models/order-application-context-shipping-preference.md delete mode 100644 doc/models/order-application-context-user-action.md delete mode 100644 doc/models/order-application-context.md delete mode 100644 doc/models/order-authorize-request-payment-source.md delete mode 100644 doc/models/order-authorize-request.md delete mode 100644 doc/models/order-authorize-response-payment-source.md delete mode 100644 doc/models/order-authorize-response.md delete mode 100644 doc/models/order-capture-request-payment-source.md delete mode 100644 doc/models/order-capture-request.md delete mode 100644 doc/models/order-confirm-application-context.md delete mode 100644 doc/models/order-request.md delete mode 100644 doc/models/order-status.md delete mode 100644 doc/models/order-tracker-item.md delete mode 100644 doc/models/order-tracker-request.md delete mode 100644 doc/models/order-tracker-response.md delete mode 100644 doc/models/order-tracker-status.md delete mode 100644 doc/models/order.md delete mode 100644 doc/models/p24-payment-object.md delete mode 100644 doc/models/p24-payment-request.md delete mode 100644 doc/models/pa-res-status.md delete mode 100644 doc/models/patch-op.md delete mode 100644 doc/models/patch.md delete mode 100644 doc/models/pay-pal-experience-landing-page.md delete mode 100644 doc/models/pay-pal-experience-user-action.md delete mode 100644 doc/models/pay-pal-payment-token-customer-type.md delete mode 100644 doc/models/pay-pal-payment-token-usage-pattern.md delete mode 100644 doc/models/pay-pal-payment-token-usage-type.md delete mode 100644 doc/models/pay-pal-payment-token.md delete mode 100644 doc/models/pay-pal-wallet-account-verification-status.md delete mode 100644 doc/models/pay-pal-wallet-attributes-response.md delete mode 100644 doc/models/pay-pal-wallet-attributes.md delete mode 100644 doc/models/pay-pal-wallet-customer-request.md delete mode 100644 doc/models/pay-pal-wallet-customer.md delete mode 100644 doc/models/pay-pal-wallet-experience-context.md delete mode 100644 doc/models/pay-pal-wallet-response.md delete mode 100644 doc/models/pay-pal-wallet-vault-instruction.md delete mode 100644 doc/models/pay-pal-wallet-vault-response.md delete mode 100644 doc/models/pay-pal-wallet-vault-status.md delete mode 100644 doc/models/pay-pal-wallet.md delete mode 100644 doc/models/payee-base.md delete mode 100644 doc/models/payee-payment-method-preference.md delete mode 100644 doc/models/payee.md delete mode 100644 doc/models/payer-base.md delete mode 100644 doc/models/payer.md delete mode 100644 doc/models/payment-advice-code.md delete mode 100644 doc/models/payment-authorization.md delete mode 100644 doc/models/payment-collection.md delete mode 100644 doc/models/payment-initiator.md delete mode 100644 doc/models/payment-instruction.md delete mode 100644 doc/models/payment-method-preference.md delete mode 100644 doc/models/payment-source-response.md delete mode 100644 doc/models/payment-source.md delete mode 100644 doc/models/payment-supplementary-data.md delete mode 100644 doc/models/payment-token-request-card.md delete mode 100644 doc/models/payment-token-request-payment-source.md delete mode 100644 doc/models/payment-token-request.md delete mode 100644 doc/models/payment-token-response-payment-source.md delete mode 100644 doc/models/payment-token-response.md delete mode 100644 doc/models/phone-number-with-country-code.md delete mode 100644 doc/models/phone-number.md delete mode 100644 doc/models/phone-type.md delete mode 100644 doc/models/phone-with-type.md delete mode 100644 doc/models/phone.md delete mode 100644 doc/models/platform-fee.md delete mode 100644 doc/models/processing-instruction.md delete mode 100644 doc/models/processor-response-code.md delete mode 100644 doc/models/processor-response.md delete mode 100644 doc/models/purchase-unit-request.md delete mode 100644 doc/models/purchase-unit.md delete mode 100644 doc/models/reauthorize-request.md delete mode 100644 doc/models/refund-incomplete-reason.md delete mode 100644 doc/models/refund-payment-instruction.md delete mode 100644 doc/models/refund-platform-fee.md delete mode 100644 doc/models/refund-request.md delete mode 100644 doc/models/refund-status-details.md delete mode 100644 doc/models/refund-status-with-details.md delete mode 100644 doc/models/refund-status.md delete mode 100644 doc/models/refund.md delete mode 100644 doc/models/related-identifiers.md delete mode 100644 doc/models/seller-payable-breakdown.md delete mode 100644 doc/models/seller-protection-status.md delete mode 100644 doc/models/seller-protection.md delete mode 100644 doc/models/seller-receivable-breakdown.md delete mode 100644 doc/models/sepa-debit-authorization-details.md delete mode 100644 doc/models/sepa-debit-response.md delete mode 100644 doc/models/setup-token-card-experience-context.md delete mode 100644 doc/models/setup-token-request-card.md delete mode 100644 doc/models/setup-token-request-payment-source.md delete mode 100644 doc/models/setup-token-request.md delete mode 100644 doc/models/setup-token-response-card.md delete mode 100644 doc/models/setup-token-response-payment-source.md delete mode 100644 doc/models/setup-token-response.md delete mode 100644 doc/models/shipment-carrier.md delete mode 100644 doc/models/shipping-details.md delete mode 100644 doc/models/shipping-name.md delete mode 100644 doc/models/shipping-option.md delete mode 100644 doc/models/shipping-preference.md delete mode 100644 doc/models/shipping-type.md delete mode 100644 doc/models/shipping-with-tracking-details.md delete mode 100644 doc/models/sofort-payment-object.md delete mode 100644 doc/models/sofort-payment-request.md delete mode 100644 doc/models/standard-entry-class-code.md delete mode 100644 doc/models/store-in-vault-instruction.md delete mode 100644 doc/models/stored-payment-source-payment-type.md delete mode 100644 doc/models/stored-payment-source-usage-type.md delete mode 100644 doc/models/stored-payment-source.md delete mode 100644 doc/models/supplementary-data.md delete mode 100644 doc/models/supplementary-purchase-data.md delete mode 100644 doc/models/tax-id-type.md delete mode 100644 doc/models/tax-info.md delete mode 100644 doc/models/three-d-secure-authentication-response.md delete mode 100644 doc/models/token-type.md delete mode 100644 doc/models/token.md delete mode 100644 doc/models/trustly-payment-object.md delete mode 100644 doc/models/trustly-payment-request.md delete mode 100644 doc/models/universal-product-code.md delete mode 100644 doc/models/upc-type.md delete mode 100644 doc/models/vault-customer.md delete mode 100644 doc/models/vault-experience-context.md delete mode 100644 doc/models/vault-instruction-base.md delete mode 100644 doc/models/vault-instruction.md delete mode 100644 doc/models/vault-pay-pal-wallet-request.md delete mode 100644 doc/models/vault-response.md delete mode 100644 doc/models/vault-sepa-debit-response.md delete mode 100644 doc/models/vault-status.md delete mode 100644 doc/models/vault-token-request.md delete mode 100644 doc/models/vault-venmo-experience-context.md delete mode 100644 doc/models/vault-venmo-request.md delete mode 100644 doc/models/vaulted-digital-wallet-shipping-details.md delete mode 100644 doc/models/vaulted-digital-wallet.md delete mode 100644 doc/models/venmo-payment-token-customer-type.md delete mode 100644 doc/models/venmo-payment-token-usage-pattern.md delete mode 100644 doc/models/venmo-payment-token-usage-type.md delete mode 100644 doc/models/venmo-payment-token.md delete mode 100644 doc/models/venmo-wallet-additional-attributes.md delete mode 100644 doc/models/venmo-wallet-attributes-response.md delete mode 100644 doc/models/venmo-wallet-customer-information.md delete mode 100644 doc/models/venmo-wallet-experience-context.md delete mode 100644 doc/models/venmo-wallet-request.md delete mode 100644 doc/models/venmo-wallet-response.md delete mode 100644 doc/models/venmo-wallet-vault-attributes.md delete mode 100644 doc/request-logging-configuration-builder.md delete mode 100644 doc/response-logging-configuration-builder.md delete mode 100644 phpcs-ruleset.xml delete mode 100644 src/ApiHelper.php delete mode 100644 src/Authentication/ClientCredentialsAuthCredentialsBuilder.php delete mode 100644 src/Authentication/ClientCredentialsAuthManager.php delete mode 100644 src/ClientCredentialsAuth.php delete mode 100644 src/ConfigurationDefaults.php delete mode 100644 src/ConfigurationInterface.php delete mode 100644 src/Controllers/BaseController.php delete mode 100644 src/Controllers/OAuthAuthorizationController.php delete mode 100644 src/Controllers/OrdersController.php delete mode 100644 src/Controllers/PaymentsController.php delete mode 100644 src/Controllers/VaultController.php delete mode 100644 src/Environment.php delete mode 100644 src/Exceptions/ApiException.php delete mode 100644 src/Exceptions/ErrorException.php delete mode 100644 src/Exceptions/OAuthProviderException.php delete mode 100644 src/Http/ApiResponse.php delete mode 100644 src/Http/HttpCallBack.php delete mode 100644 src/Http/HttpContext.php delete mode 100644 src/Http/HttpMethod.php delete mode 100644 src/Http/HttpRequest.php delete mode 100644 src/Http/HttpResponse.php delete mode 100644 src/Logging/LoggingConfigurationBuilder.php delete mode 100644 src/Logging/RequestLoggingConfigurationBuilder.php delete mode 100644 src/Logging/ResponseLoggingConfigurationBuilder.php delete mode 100644 src/Models/ACHDebitResponse.php delete mode 100644 src/Models/AVSCode.php delete mode 100644 src/Models/ActivityTimestamps.php delete mode 100644 src/Models/Address.php delete mode 100644 src/Models/AddressDetails.php delete mode 100644 src/Models/AmountBreakdown.php delete mode 100644 src/Models/AmountWithBreakdown.php delete mode 100644 src/Models/ApplePayAttributes.php delete mode 100644 src/Models/ApplePayAttributesResponse.php delete mode 100644 src/Models/ApplePayCard.php delete mode 100644 src/Models/ApplePayCardResponse.php delete mode 100644 src/Models/ApplePayDecryptedTokenData.php delete mode 100644 src/Models/ApplePayPaymentData.php delete mode 100644 src/Models/ApplePayPaymentDataType.php delete mode 100644 src/Models/ApplePayPaymentObject.php delete mode 100644 src/Models/ApplePayPaymentToken.php delete mode 100644 src/Models/ApplePayRequest.php delete mode 100644 src/Models/ApplePayTokenizedCard.php delete mode 100644 src/Models/AuthenticationResponse.php delete mode 100644 src/Models/Authorization.php delete mode 100644 src/Models/AuthorizationIncompleteReason.php delete mode 100644 src/Models/AuthorizationStatus.php delete mode 100644 src/Models/AuthorizationStatusDetails.php delete mode 100644 src/Models/AuthorizationStatusWithDetails.php delete mode 100644 src/Models/AuthorizationWithAdditionalData.php delete mode 100644 src/Models/BLIKExperienceContext.php delete mode 100644 src/Models/BLIKLevel0PaymentObject.php delete mode 100644 src/Models/BLIKOneClickPaymentObject.php delete mode 100644 src/Models/BLIKOneClickPaymentRequest.php delete mode 100644 src/Models/BLIKPaymentObject.php delete mode 100644 src/Models/BLIKPaymentRequest.php delete mode 100644 src/Models/BancontactPaymentObject.php delete mode 100644 src/Models/BancontactPaymentRequest.php delete mode 100644 src/Models/BankPaymentToken.php delete mode 100644 src/Models/BinDetails.php delete mode 100644 src/Models/Builders/ACHDebitResponseBuilder.php delete mode 100644 src/Models/Builders/ActivityTimestampsBuilder.php delete mode 100644 src/Models/Builders/AddressBuilder.php delete mode 100644 src/Models/Builders/AddressDetailsBuilder.php delete mode 100644 src/Models/Builders/AmountBreakdownBuilder.php delete mode 100644 src/Models/Builders/AmountWithBreakdownBuilder.php delete mode 100644 src/Models/Builders/ApplePayAttributesBuilder.php delete mode 100644 src/Models/Builders/ApplePayAttributesResponseBuilder.php delete mode 100644 src/Models/Builders/ApplePayCardBuilder.php delete mode 100644 src/Models/Builders/ApplePayCardResponseBuilder.php delete mode 100644 src/Models/Builders/ApplePayDecryptedTokenDataBuilder.php delete mode 100644 src/Models/Builders/ApplePayPaymentDataBuilder.php delete mode 100644 src/Models/Builders/ApplePayPaymentObjectBuilder.php delete mode 100644 src/Models/Builders/ApplePayPaymentTokenBuilder.php delete mode 100644 src/Models/Builders/ApplePayRequestBuilder.php delete mode 100644 src/Models/Builders/ApplePayTokenizedCardBuilder.php delete mode 100644 src/Models/Builders/AuthenticationResponseBuilder.php delete mode 100644 src/Models/Builders/AuthorizationBuilder.php delete mode 100644 src/Models/Builders/AuthorizationStatusDetailsBuilder.php delete mode 100644 src/Models/Builders/AuthorizationStatusWithDetailsBuilder.php delete mode 100644 src/Models/Builders/AuthorizationWithAdditionalDataBuilder.php delete mode 100644 src/Models/Builders/BLIKExperienceContextBuilder.php delete mode 100644 src/Models/Builders/BLIKLevel0PaymentObjectBuilder.php delete mode 100644 src/Models/Builders/BLIKOneClickPaymentObjectBuilder.php delete mode 100644 src/Models/Builders/BLIKOneClickPaymentRequestBuilder.php delete mode 100644 src/Models/Builders/BLIKPaymentObjectBuilder.php delete mode 100644 src/Models/Builders/BLIKPaymentRequestBuilder.php delete mode 100644 src/Models/Builders/BancontactPaymentObjectBuilder.php delete mode 100644 src/Models/Builders/BancontactPaymentRequestBuilder.php delete mode 100644 src/Models/Builders/BankPaymentTokenBuilder.php delete mode 100644 src/Models/Builders/BinDetailsBuilder.php delete mode 100644 src/Models/Builders/CaptureBuilder.php delete mode 100644 src/Models/Builders/CapturePaymentInstructionBuilder.php delete mode 100644 src/Models/Builders/CaptureRequestBuilder.php delete mode 100644 src/Models/Builders/CaptureStatusDetailsBuilder.php delete mode 100644 src/Models/Builders/CaptureStatusWithDetailsBuilder.php delete mode 100644 src/Models/Builders/CapturedPaymentBuilder.php delete mode 100644 src/Models/Builders/CardAttributesBuilder.php delete mode 100644 src/Models/Builders/CardAttributesResponseBuilder.php delete mode 100644 src/Models/Builders/CardExperienceContextBuilder.php delete mode 100644 src/Models/Builders/CardFromRequestBuilder.php delete mode 100644 src/Models/Builders/CardPaymentTokenBuilder.php delete mode 100644 src/Models/Builders/CardRequestBuilder.php delete mode 100644 src/Models/Builders/CardResponseBuilder.php delete mode 100644 src/Models/Builders/CardResponseEntityBuilder.php delete mode 100644 src/Models/Builders/CardStoredCredentialBuilder.php delete mode 100644 src/Models/Builders/CardSupplementaryDataBuilder.php delete mode 100644 src/Models/Builders/CardVerificationBuilder.php delete mode 100644 src/Models/Builders/CardVerificationDetailsBuilder.php delete mode 100644 src/Models/Builders/CardVerificationProcessorResponseBuilder.php delete mode 100644 src/Models/Builders/CobrandedCardBuilder.php delete mode 100644 src/Models/Builders/ConfirmOrderRequestBuilder.php delete mode 100644 src/Models/Builders/CustomerInformationBuilder.php delete mode 100644 src/Models/Builders/CustomerRequestBuilder.php delete mode 100644 src/Models/Builders/CustomerVaultPaymentTokensResponseBuilder.php delete mode 100644 src/Models/Builders/EPSPaymentObjectBuilder.php delete mode 100644 src/Models/Builders/EPSPaymentRequestBuilder.php delete mode 100644 src/Models/Builders/ErrorDetailsBuilder.php delete mode 100644 src/Models/Builders/ExchangeRateBuilder.php delete mode 100644 src/Models/Builders/ExperienceContextBuilder.php delete mode 100644 src/Models/Builders/GiropayPaymentObjectBuilder.php delete mode 100644 src/Models/Builders/GiropayPaymentRequestBuilder.php delete mode 100644 src/Models/Builders/GooglePayCardAttributesBuilder.php delete mode 100644 src/Models/Builders/GooglePayCardResponseBuilder.php delete mode 100644 src/Models/Builders/GooglePayDecryptedTokenDataBuilder.php delete mode 100644 src/Models/Builders/GooglePayRequestBuilder.php delete mode 100644 src/Models/Builders/GooglePayWalletResponseBuilder.php delete mode 100644 src/Models/Builders/IDEALPaymentObjectBuilder.php delete mode 100644 src/Models/Builders/IDEALPaymentRequestBuilder.php delete mode 100644 src/Models/Builders/ItemBuilder.php delete mode 100644 src/Models/Builders/Level2CardProcessingDataBuilder.php delete mode 100644 src/Models/Builders/Level3CardProcessingDataBuilder.php delete mode 100644 src/Models/Builders/LineItemBuilder.php delete mode 100644 src/Models/Builders/LinkDescriptionBuilder.php delete mode 100644 src/Models/Builders/MoneyBuilder.php delete mode 100644 src/Models/Builders/MyBankPaymentObjectBuilder.php delete mode 100644 src/Models/Builders/MyBankPaymentRequestBuilder.php delete mode 100644 src/Models/Builders/NameBuilder.php delete mode 100644 src/Models/Builders/NetAmountBreakdownItemBuilder.php delete mode 100644 src/Models/Builders/NetworkTokenBuilder.php delete mode 100644 src/Models/Builders/NetworkTransactionReferenceBuilder.php delete mode 100644 src/Models/Builders/NetworkTransactionReferenceEntityBuilder.php delete mode 100644 src/Models/Builders/OAuthTokenBuilder.php delete mode 100644 src/Models/Builders/OrderApplicationContextBuilder.php delete mode 100644 src/Models/Builders/OrderAuthorizeRequestBuilder.php delete mode 100644 src/Models/Builders/OrderAuthorizeRequestPaymentSourceBuilder.php delete mode 100644 src/Models/Builders/OrderAuthorizeResponseBuilder.php delete mode 100644 src/Models/Builders/OrderAuthorizeResponsePaymentSourceBuilder.php delete mode 100644 src/Models/Builders/OrderBuilder.php delete mode 100644 src/Models/Builders/OrderCaptureRequestBuilder.php delete mode 100644 src/Models/Builders/OrderCaptureRequestPaymentSourceBuilder.php delete mode 100644 src/Models/Builders/OrderConfirmApplicationContextBuilder.php delete mode 100644 src/Models/Builders/OrderRequestBuilder.php delete mode 100644 src/Models/Builders/OrderTrackerItemBuilder.php delete mode 100644 src/Models/Builders/OrderTrackerRequestBuilder.php delete mode 100644 src/Models/Builders/OrderTrackerResponseBuilder.php delete mode 100644 src/Models/Builders/P24PaymentObjectBuilder.php delete mode 100644 src/Models/Builders/P24PaymentRequestBuilder.php delete mode 100644 src/Models/Builders/PatchBuilder.php delete mode 100644 src/Models/Builders/PayPalPaymentTokenBuilder.php delete mode 100644 src/Models/Builders/PayPalWalletAttributesBuilder.php delete mode 100644 src/Models/Builders/PayPalWalletAttributesResponseBuilder.php delete mode 100644 src/Models/Builders/PayPalWalletBuilder.php delete mode 100644 src/Models/Builders/PayPalWalletCustomerBuilder.php delete mode 100644 src/Models/Builders/PayPalWalletCustomerRequestBuilder.php delete mode 100644 src/Models/Builders/PayPalWalletExperienceContextBuilder.php delete mode 100644 src/Models/Builders/PayPalWalletResponseBuilder.php delete mode 100644 src/Models/Builders/PayPalWalletVaultInstructionBuilder.php delete mode 100644 src/Models/Builders/PayPalWalletVaultResponseBuilder.php delete mode 100644 src/Models/Builders/PayeeBaseBuilder.php delete mode 100644 src/Models/Builders/PayeeBuilder.php delete mode 100644 src/Models/Builders/PayerBaseBuilder.php delete mode 100644 src/Models/Builders/PayerBuilder.php delete mode 100644 src/Models/Builders/PaymentAuthorizationBuilder.php delete mode 100644 src/Models/Builders/PaymentCollectionBuilder.php delete mode 100644 src/Models/Builders/PaymentInstructionBuilder.php delete mode 100644 src/Models/Builders/PaymentMethodPreferenceBuilder.php delete mode 100644 src/Models/Builders/PaymentSourceBuilder.php delete mode 100644 src/Models/Builders/PaymentSourceResponseBuilder.php delete mode 100644 src/Models/Builders/PaymentSupplementaryDataBuilder.php delete mode 100644 src/Models/Builders/PaymentTokenRequestBuilder.php delete mode 100644 src/Models/Builders/PaymentTokenRequestCardBuilder.php delete mode 100644 src/Models/Builders/PaymentTokenRequestPaymentSourceBuilder.php delete mode 100644 src/Models/Builders/PaymentTokenResponseBuilder.php delete mode 100644 src/Models/Builders/PaymentTokenResponsePaymentSourceBuilder.php delete mode 100644 src/Models/Builders/PhoneBuilder.php delete mode 100644 src/Models/Builders/PhoneNumberBuilder.php delete mode 100644 src/Models/Builders/PhoneNumberWithCountryCodeBuilder.php delete mode 100644 src/Models/Builders/PhoneWithTypeBuilder.php delete mode 100644 src/Models/Builders/PlatformFeeBuilder.php delete mode 100644 src/Models/Builders/ProcessorResponseBuilder.php delete mode 100644 src/Models/Builders/PurchaseUnitBuilder.php delete mode 100644 src/Models/Builders/PurchaseUnitRequestBuilder.php delete mode 100644 src/Models/Builders/ReauthorizeRequestBuilder.php delete mode 100644 src/Models/Builders/RefundBuilder.php delete mode 100644 src/Models/Builders/RefundPaymentInstructionBuilder.php delete mode 100644 src/Models/Builders/RefundPlatformFeeBuilder.php delete mode 100644 src/Models/Builders/RefundRequestBuilder.php delete mode 100644 src/Models/Builders/RefundStatusDetailsBuilder.php delete mode 100644 src/Models/Builders/RefundStatusWithDetailsBuilder.php delete mode 100644 src/Models/Builders/RelatedIdentifiersBuilder.php delete mode 100644 src/Models/Builders/SEPADebitAuthorizationDetailsBuilder.php delete mode 100644 src/Models/Builders/SEPADebitResponseBuilder.php delete mode 100644 src/Models/Builders/SellerPayableBreakdownBuilder.php delete mode 100644 src/Models/Builders/SellerProtectionBuilder.php delete mode 100644 src/Models/Builders/SellerReceivableBreakdownBuilder.php delete mode 100644 src/Models/Builders/SetupTokenCardExperienceContextBuilder.php delete mode 100644 src/Models/Builders/SetupTokenRequestBuilder.php delete mode 100644 src/Models/Builders/SetupTokenRequestCardBuilder.php delete mode 100644 src/Models/Builders/SetupTokenRequestPaymentSourceBuilder.php delete mode 100644 src/Models/Builders/SetupTokenResponseBuilder.php delete mode 100644 src/Models/Builders/SetupTokenResponseCardBuilder.php delete mode 100644 src/Models/Builders/SetupTokenResponsePaymentSourceBuilder.php delete mode 100644 src/Models/Builders/ShippingDetailsBuilder.php delete mode 100644 src/Models/Builders/ShippingNameBuilder.php delete mode 100644 src/Models/Builders/ShippingOptionBuilder.php delete mode 100644 src/Models/Builders/ShippingWithTrackingDetailsBuilder.php delete mode 100644 src/Models/Builders/SofortPaymentObjectBuilder.php delete mode 100644 src/Models/Builders/SofortPaymentRequestBuilder.php delete mode 100644 src/Models/Builders/StoredPaymentSourceBuilder.php delete mode 100644 src/Models/Builders/SupplementaryDataBuilder.php delete mode 100644 src/Models/Builders/SupplementaryPurchaseDataBuilder.php delete mode 100644 src/Models/Builders/TaxInfoBuilder.php delete mode 100644 src/Models/Builders/ThreeDSecureAuthenticationResponseBuilder.php delete mode 100644 src/Models/Builders/TokenBuilder.php delete mode 100644 src/Models/Builders/TrustlyPaymentObjectBuilder.php delete mode 100644 src/Models/Builders/TrustlyPaymentRequestBuilder.php delete mode 100644 src/Models/Builders/UniversalProductCodeBuilder.php delete mode 100644 src/Models/Builders/VaultCustomerBuilder.php delete mode 100644 src/Models/Builders/VaultExperienceContextBuilder.php delete mode 100644 src/Models/Builders/VaultInstructionBaseBuilder.php delete mode 100644 src/Models/Builders/VaultInstructionBuilder.php delete mode 100644 src/Models/Builders/VaultPayPalWalletRequestBuilder.php delete mode 100644 src/Models/Builders/VaultResponseBuilder.php delete mode 100644 src/Models/Builders/VaultSEPADebitResponseBuilder.php delete mode 100644 src/Models/Builders/VaultTokenRequestBuilder.php delete mode 100644 src/Models/Builders/VaultVenmoExperienceContextBuilder.php delete mode 100644 src/Models/Builders/VaultVenmoRequestBuilder.php delete mode 100644 src/Models/Builders/VaultedDigitalWalletBuilder.php delete mode 100644 src/Models/Builders/VaultedDigitalWalletShippingDetailsBuilder.php delete mode 100644 src/Models/Builders/VenmoPaymentTokenBuilder.php delete mode 100644 src/Models/Builders/VenmoWalletAdditionalAttributesBuilder.php delete mode 100644 src/Models/Builders/VenmoWalletAttributesResponseBuilder.php delete mode 100644 src/Models/Builders/VenmoWalletCustomerInformationBuilder.php delete mode 100644 src/Models/Builders/VenmoWalletExperienceContextBuilder.php delete mode 100644 src/Models/Builders/VenmoWalletRequestBuilder.php delete mode 100644 src/Models/Builders/VenmoWalletResponseBuilder.php delete mode 100644 src/Models/Builders/VenmoWalletVaultAttributesBuilder.php delete mode 100644 src/Models/CVVCode.php delete mode 100644 src/Models/Capture.php delete mode 100644 src/Models/CaptureIncompleteReason.php delete mode 100644 src/Models/CapturePaymentInstruction.php delete mode 100644 src/Models/CaptureRequest.php delete mode 100644 src/Models/CaptureStatus.php delete mode 100644 src/Models/CaptureStatusDetails.php delete mode 100644 src/Models/CaptureStatusWithDetails.php delete mode 100644 src/Models/CapturedPayment.php delete mode 100644 src/Models/CardAttributes.php delete mode 100644 src/Models/CardAttributesResponse.php delete mode 100644 src/Models/CardBrand.php delete mode 100644 src/Models/CardExperienceContext.php delete mode 100644 src/Models/CardFromRequest.php delete mode 100644 src/Models/CardPaymentToken.php delete mode 100644 src/Models/CardRequest.php delete mode 100644 src/Models/CardResponse.php delete mode 100644 src/Models/CardResponseEntity.php delete mode 100644 src/Models/CardStoredCredential.php delete mode 100644 src/Models/CardSupplementaryData.php delete mode 100644 src/Models/CardType.php delete mode 100644 src/Models/CardVerification.php delete mode 100644 src/Models/CardVerificationDetails.php delete mode 100644 src/Models/CardVerificationMethod.php delete mode 100644 src/Models/CardVerificationProcessorResponse.php delete mode 100644 src/Models/CheckoutPaymentIntent.php delete mode 100644 src/Models/CobrandedCard.php delete mode 100644 src/Models/ConfirmOrderRequest.php delete mode 100644 src/Models/CustomerInformation.php delete mode 100644 src/Models/CustomerRequest.php delete mode 100644 src/Models/CustomerVaultPaymentTokensResponse.php delete mode 100644 src/Models/DisbursementMode.php delete mode 100644 src/Models/DisputeCategory.php delete mode 100644 src/Models/ECIFlag.php delete mode 100644 src/Models/EPSPaymentObject.php delete mode 100644 src/Models/EPSPaymentRequest.php delete mode 100644 src/Models/EnrollmentStatus.php delete mode 100644 src/Models/ErrorDetails.php delete mode 100644 src/Models/ExchangeRate.php delete mode 100644 src/Models/ExperienceContext.php delete mode 100644 src/Models/FullfillmentType.php delete mode 100644 src/Models/GiropayPaymentObject.php delete mode 100644 src/Models/GiropayPaymentRequest.php delete mode 100644 src/Models/GooglePayAuthenticationMethod.php delete mode 100644 src/Models/GooglePayCardAttributes.php delete mode 100644 src/Models/GooglePayCardResponse.php delete mode 100644 src/Models/GooglePayDecryptedTokenData.php delete mode 100644 src/Models/GooglePayPaymentMethod.php delete mode 100644 src/Models/GooglePayRequest.php delete mode 100644 src/Models/GooglePayWalletResponse.php delete mode 100644 src/Models/IDEALPaymentObject.php delete mode 100644 src/Models/IDEALPaymentRequest.php delete mode 100644 src/Models/InstrumentAuthorizationStatus.php delete mode 100644 src/Models/Item.php delete mode 100644 src/Models/ItemCategory.php delete mode 100644 src/Models/Level2CardProcessingData.php delete mode 100644 src/Models/Level3CardProcessingData.php delete mode 100644 src/Models/LiabilityShiftIndicator.php delete mode 100644 src/Models/LineItem.php delete mode 100644 src/Models/LinkDescription.php delete mode 100644 src/Models/LinkHTTPMethod.php delete mode 100644 src/Models/Money.php delete mode 100644 src/Models/MyBankPaymentObject.php delete mode 100644 src/Models/MyBankPaymentRequest.php delete mode 100644 src/Models/Name.php delete mode 100644 src/Models/NetAmountBreakdownItem.php delete mode 100644 src/Models/NetworkToken.php delete mode 100644 src/Models/NetworkTransactionReference.php delete mode 100644 src/Models/NetworkTransactionReferenceEntity.php delete mode 100644 src/Models/OAuthProviderError.php delete mode 100644 src/Models/OAuthToken.php delete mode 100644 src/Models/Order.php delete mode 100644 src/Models/OrderApplicationContext.php delete mode 100644 src/Models/OrderApplicationContextLandingPage.php delete mode 100644 src/Models/OrderApplicationContextShippingPreference.php delete mode 100644 src/Models/OrderApplicationContextUserAction.php delete mode 100644 src/Models/OrderAuthorizeRequest.php delete mode 100644 src/Models/OrderAuthorizeRequestPaymentSource.php delete mode 100644 src/Models/OrderAuthorizeResponse.php delete mode 100644 src/Models/OrderAuthorizeResponsePaymentSource.php delete mode 100644 src/Models/OrderCaptureRequest.php delete mode 100644 src/Models/OrderCaptureRequestPaymentSource.php delete mode 100644 src/Models/OrderConfirmApplicationContext.php delete mode 100644 src/Models/OrderRequest.php delete mode 100644 src/Models/OrderStatus.php delete mode 100644 src/Models/OrderTrackerItem.php delete mode 100644 src/Models/OrderTrackerRequest.php delete mode 100644 src/Models/OrderTrackerResponse.php delete mode 100644 src/Models/OrderTrackerStatus.php delete mode 100644 src/Models/P24PaymentObject.php delete mode 100644 src/Models/P24PaymentRequest.php delete mode 100644 src/Models/PAResStatus.php delete mode 100644 src/Models/Patch.php delete mode 100644 src/Models/PatchOp.php delete mode 100644 src/Models/PayPalExperienceLandingPage.php delete mode 100644 src/Models/PayPalExperienceUserAction.php delete mode 100644 src/Models/PayPalPaymentToken.php delete mode 100644 src/Models/PayPalPaymentTokenCustomerType.php delete mode 100644 src/Models/PayPalPaymentTokenUsagePattern.php delete mode 100644 src/Models/PayPalPaymentTokenUsageType.php delete mode 100644 src/Models/PayPalWallet.php delete mode 100644 src/Models/PayPalWalletAccountVerificationStatus.php delete mode 100644 src/Models/PayPalWalletAttributes.php delete mode 100644 src/Models/PayPalWalletAttributesResponse.php delete mode 100644 src/Models/PayPalWalletCustomer.php delete mode 100644 src/Models/PayPalWalletCustomerRequest.php delete mode 100644 src/Models/PayPalWalletExperienceContext.php delete mode 100644 src/Models/PayPalWalletResponse.php delete mode 100644 src/Models/PayPalWalletVaultInstruction.php delete mode 100644 src/Models/PayPalWalletVaultResponse.php delete mode 100644 src/Models/PayPalWalletVaultStatus.php delete mode 100644 src/Models/Payee.php delete mode 100644 src/Models/PayeeBase.php delete mode 100644 src/Models/PayeePaymentMethodPreference.php delete mode 100644 src/Models/Payer.php delete mode 100644 src/Models/PayerBase.php delete mode 100644 src/Models/PaymentAdviceCode.php delete mode 100644 src/Models/PaymentAuthorization.php delete mode 100644 src/Models/PaymentCollection.php delete mode 100644 src/Models/PaymentInitiator.php delete mode 100644 src/Models/PaymentInstruction.php delete mode 100644 src/Models/PaymentMethodPreference.php delete mode 100644 src/Models/PaymentSource.php delete mode 100644 src/Models/PaymentSourceResponse.php delete mode 100644 src/Models/PaymentSupplementaryData.php delete mode 100644 src/Models/PaymentTokenRequest.php delete mode 100644 src/Models/PaymentTokenRequestCard.php delete mode 100644 src/Models/PaymentTokenRequestPaymentSource.php delete mode 100644 src/Models/PaymentTokenResponse.php delete mode 100644 src/Models/PaymentTokenResponsePaymentSource.php delete mode 100644 src/Models/Phone.php delete mode 100644 src/Models/PhoneNumber.php delete mode 100644 src/Models/PhoneNumberWithCountryCode.php delete mode 100644 src/Models/PhoneType.php delete mode 100644 src/Models/PhoneWithType.php delete mode 100644 src/Models/PlatformFee.php delete mode 100644 src/Models/ProcessingInstruction.php delete mode 100644 src/Models/ProcessorResponse.php delete mode 100644 src/Models/ProcessorResponseCode.php delete mode 100644 src/Models/PurchaseUnit.php delete mode 100644 src/Models/PurchaseUnitRequest.php delete mode 100644 src/Models/ReauthorizeRequest.php delete mode 100644 src/Models/Refund.php delete mode 100644 src/Models/RefundIncompleteReason.php delete mode 100644 src/Models/RefundPaymentInstruction.php delete mode 100644 src/Models/RefundPlatformFee.php delete mode 100644 src/Models/RefundRequest.php delete mode 100644 src/Models/RefundStatus.php delete mode 100644 src/Models/RefundStatusDetails.php delete mode 100644 src/Models/RefundStatusWithDetails.php delete mode 100644 src/Models/RelatedIdentifiers.php delete mode 100644 src/Models/SEPADebitAuthorizationDetails.php delete mode 100644 src/Models/SEPADebitResponse.php delete mode 100644 src/Models/SellerPayableBreakdown.php delete mode 100644 src/Models/SellerProtection.php delete mode 100644 src/Models/SellerProtectionStatus.php delete mode 100644 src/Models/SellerReceivableBreakdown.php delete mode 100644 src/Models/SetupTokenCardExperienceContext.php delete mode 100644 src/Models/SetupTokenRequest.php delete mode 100644 src/Models/SetupTokenRequestCard.php delete mode 100644 src/Models/SetupTokenRequestPaymentSource.php delete mode 100644 src/Models/SetupTokenResponse.php delete mode 100644 src/Models/SetupTokenResponseCard.php delete mode 100644 src/Models/SetupTokenResponsePaymentSource.php delete mode 100644 src/Models/ShipmentCarrier.php delete mode 100644 src/Models/ShippingDetails.php delete mode 100644 src/Models/ShippingName.php delete mode 100644 src/Models/ShippingOption.php delete mode 100644 src/Models/ShippingPreference.php delete mode 100644 src/Models/ShippingType.php delete mode 100644 src/Models/ShippingWithTrackingDetails.php delete mode 100644 src/Models/SofortPaymentObject.php delete mode 100644 src/Models/SofortPaymentRequest.php delete mode 100644 src/Models/StandardEntryClassCode.php delete mode 100644 src/Models/StoreInVaultInstruction.php delete mode 100644 src/Models/StoredPaymentSource.php delete mode 100644 src/Models/StoredPaymentSourcePaymentType.php delete mode 100644 src/Models/StoredPaymentSourceUsageType.php delete mode 100644 src/Models/SupplementaryData.php delete mode 100644 src/Models/SupplementaryPurchaseData.php delete mode 100644 src/Models/TaxIdType.php delete mode 100644 src/Models/TaxInfo.php delete mode 100644 src/Models/ThreeDSecureAuthenticationResponse.php delete mode 100644 src/Models/Token.php delete mode 100644 src/Models/TokenType.php delete mode 100644 src/Models/TrustlyPaymentObject.php delete mode 100644 src/Models/TrustlyPaymentRequest.php delete mode 100644 src/Models/UPCType.php delete mode 100644 src/Models/UniversalProductCode.php delete mode 100644 src/Models/VaultCustomer.php delete mode 100644 src/Models/VaultExperienceContext.php delete mode 100644 src/Models/VaultInstruction.php delete mode 100644 src/Models/VaultInstructionBase.php delete mode 100644 src/Models/VaultPayPalWalletRequest.php delete mode 100644 src/Models/VaultResponse.php delete mode 100644 src/Models/VaultSEPADebitResponse.php delete mode 100644 src/Models/VaultStatus.php delete mode 100644 src/Models/VaultTokenRequest.php delete mode 100644 src/Models/VaultVenmoExperienceContext.php delete mode 100644 src/Models/VaultVenmoRequest.php delete mode 100644 src/Models/VaultedDigitalWallet.php delete mode 100644 src/Models/VaultedDigitalWalletShippingDetails.php delete mode 100644 src/Models/VenmoPaymentToken.php delete mode 100644 src/Models/VenmoPaymentTokenCustomerType.php delete mode 100644 src/Models/VenmoPaymentTokenUsagePattern.php delete mode 100644 src/Models/VenmoPaymentTokenUsageType.php delete mode 100644 src/Models/VenmoWalletAdditionalAttributes.php delete mode 100644 src/Models/VenmoWalletAttributesResponse.php delete mode 100644 src/Models/VenmoWalletCustomerInformation.php delete mode 100644 src/Models/VenmoWalletExperienceContext.php delete mode 100644 src/Models/VenmoWalletRequest.php delete mode 100644 src/Models/VenmoWalletResponse.php delete mode 100644 src/Models/VenmoWalletVaultAttributes.php delete mode 100644 src/PayPalRESTAPIsClient.php delete mode 100644 src/PayPalRESTAPIsClientBuilder.php delete mode 100644 src/Server.php delete mode 100644 src/Utils/CompatibilityConverter.php diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index b7d6cdf..0000000 --- a/.gitattributes +++ /dev/null @@ -1 +0,0 @@ -**/*.php -lf diff --git a/.phan/config.php b/.phan/config.php deleted file mode 100644 index f9860e9..0000000 --- a/.phan/config.php +++ /dev/null @@ -1,79 +0,0 @@ - '7.2', - - // A list of directories that should be parsed for class and - // method information. After excluding the directories - // defined in exclude_analysis_directory_list, the remaining - // files will be statically analyzed for errors. - // - // Thus, both first-party and third-party code being used by - // your application should be included in this list. - 'directory_list' => [ - 'src', - $vendor_dir . '/psr/log', - $vendor_dir . '/apimatic/unirest-php', - $vendor_dir . '/apimatic/core', - $vendor_dir . '/apimatic/core-interfaces' - ], - - // A directory list that defines files that will be excluded - // from static analysis, but whose class and method - // information should be included. - // - // Generally, you'll want to include the directories for - // third-party code (such as "vendor/") in this list. - // - // n.b.: If you'd like to parse but not analyze 3rd - // party code, directories containing that code - // should be added to both the `directory_list` - // and `exclude_analysis_directory_list` arrays. - 'exclude_analysis_directory_list' => [ - $vendor_dir - ], - - 'plugin_config' => [ - 'infer_pure_methods' => true - ], - - 'plugins' => [ - 'AlwaysReturnPlugin', - 'DuplicateArrayKeyPlugin', - 'PregRegexCheckerPlugin', - 'PrintfCheckerPlugin', - 'UnreachableCodePlugin', - 'InvokePHPNativeSyntaxCheckPlugin', - 'UseReturnValuePlugin', - 'EmptyStatementListPlugin', - 'LoopVariableReusePlugin', - 'RedundantAssignmentPlugin', - 'NonBoolBranchPlugin', - 'NonBoolInLogicalArithPlugin', - 'InvalidVariableIssetPlugin', - 'NoAssertPlugin', - 'DuplicateExpressionPlugin', - 'WhitespacePlugin', - 'PHPDocToRealTypesPlugin', - 'PHPDocRedundantPlugin', - 'PreferNamespaceUsePlugin', - 'StrictComparisonPlugin', - 'EmptyMethodAndFunctionPlugin', - 'DollarDollarPlugin', - 'AvoidableGetterPlugin' - ] -]; diff --git a/LICENSE b/LICENSE deleted file mode 100644 index b9181f7..0000000 --- a/LICENSE +++ /dev/null @@ -1,28 +0,0 @@ -License: -======== -The MIT License (MIT) -http://opensource.org/licenses/MIT - -Copyright (c) 2014 - 2024 APIMATIC Limited - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. - -Trade Mark: -========== -APIMATIC is a trade mark for APIMATIC Limited \ No newline at end of file diff --git a/README.md b/README.md deleted file mode 100644 index 4a4ee2a..0000000 --- a/README.md +++ /dev/null @@ -1,182 +0,0 @@ - -# Getting Started with PayPal REST APIs - -## Introduction - -An order represents a payment between two or more parties. Use the Orders API to create, update, retrieve, authorize, and capture orders., Call the Payments API to authorize payments, capture authorized payments, refund payments that have already been captured, and show payment information. Use the Payments API in conjunction with the Orders API. For more information, see the PayPal Checkout Overview., The Payment Method Tokens API saves payment methods so payers don't have to enter details for future transactions. Payers can check out faster or pay without being present after they agree to save a payment method.

The API associates a payment method with a temporary setup token. Pass the setup token to the API to exchange the setup token for a permanent token.

The permanent token represents a payment method that's saved to the vault. This token can be used repeatedly for checkout or recurring transactions such as subscriptions.

The Payment Method Tokens API is available in the US only. - -Find out more here: [https://developer.paypal.com/docs/api/orders/v2/](https://developer.paypal.com/docs/api/orders/v2/) - -## Building - -The generated code has dependencies over external libraries like UniRest and JsonMapper. JsonMapper requires docblock annotations like `@var`, `@maps`, and `@factory` to map JSON responses with our class definitions. Hence the docblocks in generated code cannot be disabled by deactivating the PHP configurations like `opcache.save_comments`. These dependencies are defined in the `composer.json` file that comes with the SDK. To resolve these dependencies, we use the Composer package manager which requires PHP greater than or equal to 7.2 installed in your system. Visit [https://getcomposer.org/download/](https://getcomposer.org/download/) to download the installer file for Composer and run it in your system. Open command prompt and type `composer --version`. This should display the current version of the Composer installed if the installation was successful. - -* Using command line, navigate to the directory containing the generated files (including `composer.json`) for the SDK. -* Run the command `composer install`. This should install all the required dependencies and create the `vendor` directory in your project directory. - -![Building SDK - Step 1](https://apidocs.io/illustration/php?workspaceFolder=PayPalRESTAPIs&step=installDependencies) - -### Configuring CURL Certificate Path in php.ini - -:information_source: **Note** This is for Windows users only. - -CURL used to include a list of accepted CAs, but no longer bundles ANY CA certs. So by default it will reject all SSL certificates as unverifiable. You will have to get your CA's cert and point curl at it. The steps are as follows: - -1. Download the certificate bundle (.pem file) from [https://curl.haxx.se/docs/caextract.html](https://curl.haxx.se/docs/caextract.html) on to your system. -2. Add curl.cainfo = "PATH_TO/cacert.pem" to your php.ini file located in your php installation. “PATH_TO” must be an absolute path containing the .pem file. - -``` -[curl]; A default value for the CURLOPT_CAINFO option. This is required to be an -; absolute path. -curl.cainfo = PATH_TO/cacert.pem -``` - -## Installation - -The following section explains how to use the PayPalRESTAPIsLib library in a new project. - -### 1. Open Project in an IDE - -Open an IDE for PHP like PhpStorm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE. - -![Open project in PHPStorm - Step 1](https://apidocs.io/illustration/php?workspaceFolder=PayPalRESTAPIs&step=openIDE) - -Click on `Open` in PhpStorm to browse to your generated SDK directory and then click `OK`. - -![Open project in PHPStorm - Step 2](https://apidocs.io/illustration/php?workspaceFolder=PayPalRESTAPIs&step=openProject0) - -### 2. Add a new Test Project - -Create a new directory by right clicking on the solution name as shown below: - -![Add a new project in PHPStorm - Step 1](https://apidocs.io/illustration/php?workspaceFolder=PayPalRESTAPIs&step=createDirectory) - -Name the directory as "test". - -![Add a new project in PHPStorm - Step 2](https://apidocs.io/illustration/php?workspaceFolder=PayPalRESTAPIs&step=nameDirectory) - -Add a PHP file to this project. - -![Add a new project in PHPStorm - Step 3](https://apidocs.io/illustration/php?workspaceFolder=PayPalRESTAPIs&step=createFile) - -Name it "testSDK". - -![Add a new project in PHPStorm - Step 4](https://apidocs.io/illustration/php?workspaceFolder=PayPalRESTAPIs&step=nameFile) - -Depending on your project setup, you might need to include composer's autoloader in your PHP code to enable auto loading of classes. - -```php -require_once "vendor/autoload.php"; -``` - -It is important that the path inside require_once correctly points to the file `autoload.php` inside the vendor directory created during dependency installations. - -![Add a new project in PHPStorm - Step 5](https://apidocs.io/illustration/php?workspaceFolder=PayPalRESTAPIs&step=projectFiles) - -After this you can add code to initialize the client library and acquire the instance of a Controller class. Sample code to initialize the client library and use the Controller methods is given in the subsequent sections. - -### 3. Run the Test Project - -To run your project you must set the Interpreter for your project. Interpreter is the PHP engine installed on your computer. - -Open `Settings` from `File` menu. - -![Run Test Project - Step 1](https://apidocs.io/illustration/php?workspaceFolder=PayPalRESTAPIs&step=openSettings) - -Select `PHP` from within `Languages & Frameworks`. - -![Run Test Project - Step 2](https://apidocs.io/illustration/php?workspaceFolder=PayPalRESTAPIs&step=setInterpreter0) - -Browse for Interpreters near the `Interpreter` option and choose your interpreter. - -![Run Test Project - Step 3](https://apidocs.io/illustration/php?workspaceFolder=PayPalRESTAPIs&step=setInterpreter1) - -Once the interpreter is selected, click `OK`. - -![Run Test Project - Step 4](https://apidocs.io/illustration/php?workspaceFolder=PayPalRESTAPIs&step=setInterpreter2) - -To run your project, right click on your PHP file inside your Test project and click on `Run`. - -![Run Test Project - Step 5](https://apidocs.io/illustration/php?workspaceFolder=PayPalRESTAPIs&step=runProject) - -## Initialize the API Client - -**_Note:_** Documentation for the client can be found [here.](https://www.github.com/moizgillani/paypal-php-sdk/tree/1.0.3/doc/client.md) - -The following parameters are configurable for the API Client: - -| Parameter | Type | Description | -| --- | --- | --- | -| `environment` | `Environment` | The API environment.
**Default: `Environment.SANDBOX`** | -| `timeout` | `int` | Timeout for API calls in seconds.
*Default*: `0` | -| `enableRetries` | `bool` | Whether to enable retries and backoff feature.
*Default*: `false` | -| `numberOfRetries` | `int` | The number of retries to make.
*Default*: `0` | -| `retryInterval` | `float` | The retry time interval between the endpoint calls.
*Default*: `1` | -| `backOffFactor` | `float` | Exponential backoff factor to increase interval between retries.
*Default*: `2` | -| `maximumRetryWaitTime` | `int` | The maximum wait time in seconds for overall retrying requests.
*Default*: `0` | -| `retryOnTimeout` | `bool` | Whether to retry on request timeout.
*Default*: `true` | -| `httpStatusCodesToRetry` | `array` | Http status codes to retry against.
*Default*: `408, 413, 429, 500, 502, 503, 504, 521, 522, 524` | -| `httpMethodsToRetry` | `array` | Http methods to retry against.
*Default*: `'GET', 'PUT'` | -| `loggingConfiguration` | [`LoggingConfigurationBuilder`](https://www.github.com/moizgillani/paypal-php-sdk/tree/1.0.3/doc/logging-configuration-builder.md) | Represents the logging configurations for API calls | -| `clientCredentialsAuth` | [`ClientCredentialsAuth`](https://www.github.com/moizgillani/paypal-php-sdk/tree/1.0.3/doc/auth/oauth-2-client-credentials-grant.md) | The Credentials Setter for OAuth 2 Client Credentials Grant | - -The API client can be initialized as follows: - -```php -$client = PayPalRESTAPIsClientBuilder::init() - ->clientCredentialsAuthCredentials( - ClientCredentialsAuthCredentialsBuilder::init( - 'OAuthClientId', - 'OAuthClientSecret' - ) - ) - ->environment('Sandbox') - ->loggingConfiguration( - LoggingConfigurationBuilder::init() - ->level(LogLevel::INFO) - ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true)) - ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true)) - ) - ->build(); -``` - -API calls return an `ApiResponse` object that includes the following fields: - -| Field | Description | -| --- | --- | -| `getStatusCode` | Status code of the HTTP response | -| `getHeaders` | Headers of the HTTP response as a Hash | -| `getResult` | The deserialized body of the HTTP response as a String | - -## Environments - -The SDK can be configured to use a different environment for making API calls. Available environments are: - -### Fields - -| Name | Description | -| --- | --- | -| Production | PayPal Live Environment | -| Sandbox | **Default** PayPal Sandbox Environment | - -## Authorization - -This API uses the following authentication schemes. - -* [`Oauth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/moizgillani/paypal-php-sdk/tree/1.0.3/doc/auth/oauth-2-client-credentials-grant.md) - -## List of APIs - -* [Orders](https://www.github.com/moizgillani/paypal-php-sdk/tree/1.0.3/doc/controllers/orders.md) -* [Payments](https://www.github.com/moizgillani/paypal-php-sdk/tree/1.0.3/doc/controllers/payments.md) -* [Vault](https://www.github.com/moizgillani/paypal-php-sdk/tree/1.0.3/doc/controllers/vault.md) - -## Classes Documentation - -* [ApiException](https://www.github.com/moizgillani/paypal-php-sdk/tree/1.0.3/doc/api-exception.md) -* [HttpRequest](https://www.github.com/moizgillani/paypal-php-sdk/tree/1.0.3/doc/http-request.md) -* [HttpResponse](https://www.github.com/moizgillani/paypal-php-sdk/tree/1.0.3/doc/http-response.md) -* [LoggingConfigurationBuilder](https://www.github.com/moizgillani/paypal-php-sdk/tree/1.0.3/doc/logging-configuration-builder.md) -* [RequestLoggingConfigurationBuilder](https://www.github.com/moizgillani/paypal-php-sdk/tree/1.0.3/doc/request-logging-configuration-builder.md) -* [ResponseLoggingConfigurationBuilder](https://www.github.com/moizgillani/paypal-php-sdk/tree/1.0.3/doc/response-logging-configuration-builder.md) - diff --git a/composer.json b/composer.json deleted file mode 100644 index c809994..0000000 --- a/composer.json +++ /dev/null @@ -1,51 +0,0 @@ -{ - "name": "apimatic/paypalrestapis", - "description": "An order represents a payment between two or more parties. Use the Orders API to create, update, retrieve, authorize, and capture orders., Call the Payments API to authorize payments, capture authorized payments, refund payments that have already been captured, and show payment information. Use the Payments API in conjunction with the Orders API. For more information, see the PayPal Checkout Overview., The Payment Method Tokens API saves payment methods so payers don't have to enter details for future transactions. Payers can check out faster or pay without being present after they agree to save a payment method.

The API associates a payment method with a temporary setup token. Pass the setup token to the API to exchange the setup token for a permanent token.

The permanent token represents a payment method that's saved to the vault. This token can be used repeatedly for checkout or recurring transactions such as subscriptions.

The Payment Method Tokens API is available in the US only.", - "type": "library", - "keywords": [ - "PayPal REST APIs", - "API", - "SDK" - ], - "homepage": "https://www.apimatic.io", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "APIMatic Code Generator", - "email": "support@apimatic.io", - "homepage": "https://www.apimatic.io", - "role": "API Tool" - } - ], - "require": { - "php": "^7.2 || ^8.0", - "ext-json": "*", - "apimatic/unirest-php": "^4.0.0", - "apimatic/core-interfaces": "~0.1.5", - "apimatic/core": "~0.3.11" - }, - "require-dev": { - "squizlabs/php_codesniffer": "^3.5", - "phan/phan": "5.4.2" - }, - "autoload": { - "psr-4": { - "PayPalRESTAPIsLib\\": "src/" - } - }, - "autoload-dev": { - "psr-4": { - "PayPalRESTAPIsLib\\Tests\\": "tests/" - } - }, - "scripts": { - "lint-src": "phpcs --standard=phpcs-ruleset.xml src/", - "lint-src-fix": "phpcbf --standard=phpcs-ruleset.xml src/", - "analyze": "phan --allow-polyfill-parser -p", - "lint": [ - "@lint-src" - ] - } -} \ No newline at end of file diff --git a/doc/api-exception.md b/doc/api-exception.md deleted file mode 100644 index 4e41ae0..0000000 --- a/doc/api-exception.md +++ /dev/null @@ -1,13 +0,0 @@ - -# ApiException - -Thrown when there is a network error or HTTP response status code is not okay. - -## Methods - -| Name | Type | Description | -| --- | --- | --- | -| getHttpRequest() | [`HttpRequest`](http-request.md) | Returns the HTTP request. | -| getHttpResponse() | ?[`HttpResponse`](http-response.md) | Returns the HTTP response. | -| hasResponse() | bool | Is the response available? | - diff --git a/doc/auth/oauth-2-client-credentials-grant.md b/doc/auth/oauth-2-client-credentials-grant.md deleted file mode 100644 index 9005855..0000000 --- a/doc/auth/oauth-2-client-credentials-grant.md +++ /dev/null @@ -1,88 +0,0 @@ - -# OAuth 2 Client Credentials Grant - - - -Documentation for accessing and setting credentials for Oauth2. - -## Auth Credentials - -| Name | Type | Description | Setter | Getter | -| --- | --- | --- | --- | --- | -| OAuthClientId | `string` | OAuth 2 Client ID | `oAuthClientId` | `getOAuthClientId()` | -| OAuthClientSecret | `string` | OAuth 2 Client Secret | `oAuthClientSecret` | `getOAuthClientSecret()` | -| OAuthToken | `OAuthToken\|null` | Object for storing information about the OAuth token | `oAuthToken` | `getOAuthToken()` | -| OAuthClockSkew | `int` | Clock skew time in seconds applied while checking the OAuth Token expiry. | `oAuthClockSkew` | - | -| OAuthTokenProvider | `callable(OAuthToken, ClientCredentialsAuthManager): OAuthToken` | Registers a callback for oAuth Token Provider used for automatic token fetching/refreshing. | `oAuthTokenProvider` | - | -| OAuthOnTokenUpdate | `callable(OAuthToken): void` | Registers a callback for token update event. | `oAuthOnTokenUpdate` | - | - - - -**Note:** Auth credentials can be set using `ClientCredentialsAuthCredentialsBuilder::init()` in `clientCredentialsAuthCredentials` method in the client builder and accessed through `getClientCredentialsAuth` method in the client instance. - -## Usage Example - -### Client Initialization - -You must initialize the client with *OAuth 2.0 Client Credentials Grant* credentials as shown in the following code snippet. This will fetch the OAuth token automatically when any of the endpoints, requiring *OAuth 2.0 Client Credentials Grant* autentication, are called. - -```php -$client = PayPalRESTAPIsClientBuilder::init() - ->clientCredentialsAuthCredentials( - ClientCredentialsAuthCredentialsBuilder::init( - 'OAuthClientId', - 'OAuthClientSecret' - ) - ) - ->build(); -``` - - - -Your application can also manually provide an OAuthToken using the setter `oAuthToken` in `ClientCredentialsAuthCredentialsBuilder` object. This function takes in an instance of OAuthToken containing information for authorizing client requests and refreshing the token itself. - -### Adding OAuth Token Update Callback - -Whenever the OAuth Token gets updated, the provided callback implementation will be executed. For instance, you may use it to store your access token whenever it gets updated. - -```php -$client = PayPalRESTAPIsClientBuilder::init() - ->clientCredentialsAuthCredentials( - ClientCredentialsAuthCredentialsBuilder::init( - 'OAuthClientId', - 'OAuthClientSecret' - ) - ->oAuthOnTokenUpdate( - function (OAuthToken $oAuthToken): void { - // Add the callback handler to perform operations like save to DB or file etc. - // It will be triggered whenever the token gets updated. - $this->saveTokenToDatabase($oAuthToken); - } - ) - ) - ->build(); -``` - -### Adding Custom OAuth Token Provider - -To authorize a client using a stored access token, set up the `oAuthTokenProvider` in `ClientCredentialsAuthCredentialsBuilder` along with the other auth parameters before creating the client: - -```php -$client = PayPalRESTAPIsClientBuilder::init() - ->clientCredentialsAuthCredentials( - ClientCredentialsAuthCredentialsBuilder::init( - 'OAuthClientId', - 'OAuthClientSecret' - ) - ->oAuthTokenProvider( - function (?OAuthToken $lastOAuthToken, ClientCredentialsAuthManager $authManager): OAuthToken { - // Add the callback handler to provide a new OAuth token. - // It will be triggered whenever the lastOAuthToken is null or expired. - return $this->loadTokenFromDatabase() ?? $authManager->fetchToken(); - } - ) - ) - ->build(); -``` - - diff --git a/doc/client.md b/doc/client.md deleted file mode 100644 index 7be271f..0000000 --- a/doc/client.md +++ /dev/null @@ -1,61 +0,0 @@ - -# Client Class Documentation - -The following parameters are configurable for the API Client: - -| Parameter | Type | Description | -| --- | --- | --- | -| `environment` | `Environment` | The API environment.
**Default: `Environment.SANDBOX`** | -| `timeout` | `int` | Timeout for API calls in seconds.
*Default*: `0` | -| `enableRetries` | `bool` | Whether to enable retries and backoff feature.
*Default*: `false` | -| `numberOfRetries` | `int` | The number of retries to make.
*Default*: `0` | -| `retryInterval` | `float` | The retry time interval between the endpoint calls.
*Default*: `1` | -| `backOffFactor` | `float` | Exponential backoff factor to increase interval between retries.
*Default*: `2` | -| `maximumRetryWaitTime` | `int` | The maximum wait time in seconds for overall retrying requests.
*Default*: `0` | -| `retryOnTimeout` | `bool` | Whether to retry on request timeout.
*Default*: `true` | -| `httpStatusCodesToRetry` | `array` | Http status codes to retry against.
*Default*: `408, 413, 429, 500, 502, 503, 504, 521, 522, 524` | -| `httpMethodsToRetry` | `array` | Http methods to retry against.
*Default*: `'GET', 'PUT'` | -| `loggingConfiguration` | [`LoggingConfigurationBuilder`](logging-configuration-builder.md) | Represents the logging configurations for API calls | -| `clientCredentialsAuth` | [`ClientCredentialsAuth`](auth/oauth-2-client-credentials-grant.md) | The Credentials Setter for OAuth 2 Client Credentials Grant | - -The API client can be initialized as follows: - -```php -$client = PayPalRESTAPIsClientBuilder::init() - ->clientCredentialsAuthCredentials( - ClientCredentialsAuthCredentialsBuilder::init( - 'OAuthClientId', - 'OAuthClientSecret' - ) - ) - ->environment('Sandbox') - ->loggingConfiguration( - LoggingConfigurationBuilder::init() - ->level(LogLevel::INFO) - ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true)) - ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true)) - ) - ->build(); -``` - -API calls return an `ApiResponse` object that includes the following fields: - -| Field | Description | -| --- | --- | -| `getStatusCode` | Status code of the HTTP response | -| `getHeaders` | Headers of the HTTP response as a Hash | -| `getResult` | The deserialized body of the HTTP response as a String | - -## PayPal REST APIs Client - -The gateway for the SDK. This class acts as a factory for the Controllers and also holds the configuration of the SDK. - -## Controllers - -| Name | Description | -| --- | --- | -| getOrdersController() | Gets OrdersController | -| getPaymentsController() | Gets PaymentsController | -| getVaultController() | Gets VaultController | -| getOAuthAuthorizationController() | Gets OAuthAuthorizationController | - diff --git a/doc/controllers/orders.md b/doc/controllers/orders.md deleted file mode 100644 index 6c29128..0000000 --- a/doc/controllers/orders.md +++ /dev/null @@ -1,400 +0,0 @@ -# Orders - -Use the `/orders` resource to create, update, retrieve, authorize, capture and track orders. - -```php -$ordersController = $client->getOrdersController(); -``` - -## Class Name - -`OrdersController` - -## Methods - -* [Orders Create](../../doc/controllers/orders.md#orders-create) -* [Orders Get](../../doc/controllers/orders.md#orders-get) -* [Orders Patch](../../doc/controllers/orders.md#orders-patch) -* [Orders Confirm](../../doc/controllers/orders.md#orders-confirm) -* [Orders Authorize](../../doc/controllers/orders.md#orders-authorize) -* [Orders Capture](../../doc/controllers/orders.md#orders-capture) -* [Orders Track Create](../../doc/controllers/orders.md#orders-track-create) -* [Orders Trackers Patch](../../doc/controllers/orders.md#orders-trackers-patch) - - -# Orders Create - -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 -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `body` | [`OrderRequest`](../../doc/models/order-request.md) | Body, Required | - | -| `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. | -| `payPalPartnerAttributionId` | `?string` | Header, Optional | - | -| `payPalClientMetadataId` | `?string` | Header, Optional | - | -| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is: | - -## Response Type - -This method returns a `PayPalRESTAPIsLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md). - -## Example Usage - -```php -$collect = [ - 'body' => OrderRequestBuilder::init( - CheckoutPaymentIntent::CAPTURE, - [ - PurchaseUnitRequestBuilder::init( - AmountWithBreakdownBuilder::init( - 'USD', - '100.00' - )->build() - ) - ->referenceId('d9f80740-38f0-11e8-b467-0ed5f89f718b') - ->build() - ] - )->build(), - 'payPalRequestId' => 'PayPal-Request-Id', - 'payPalClientMetadataId' => 'PayPal-Client-Metadata-Id', - 'prefer' => 'return=minimal' -]; - -$apiResponse = $ordersController->ordersCreate($collect); -``` - -## Errors - -| HTTP Status Code | Error Description | Exception Class | -| --- | --- | --- | -| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) | -| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) | -| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) | -| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) | - - -# Orders Get - -Shows details for an order, by ID.
Note: For error handling and troubleshooting, see Orders v2 errors.
- -```php -function ordersGet(array $options): ApiResponse -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `id` | `string` | Template, Required | The ID of the order for which to show details. | -| `fields` | `?string` | Query, Optional | A comma-separated list of fields that should be returned for the order. Valid filter field is `payment_source`. | - -## Response Type - -This method returns a `PayPalRESTAPIsLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md). - -## Example Usage - -```php -$collect = [ - 'id' => 'id0' -]; - -$apiResponse = $ordersController->ordersGet($collect); -``` - -## Errors - -| HTTP Status Code | Error Description | Exception Class | -| --- | --- | --- | -| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) | -| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) | -| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) | - - -# Orders Patch - -Updates an order with a `CREATED` or `APPROVED` status. You cannot update an order with the `COMPLETED` status.

To make an update, you must provide a `reference_id`. If you omit this value with an order that contains only one purchase unit, PayPal sets the value to `default` which enables you to use the path: \"/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:

AttributeOpNotes
intentreplace
payerreplace, addUsing replace op for payer will replace the whole payer object with the value sent in request.
purchase_unitsreplace, add
purchase_units[].custom_idreplace, add, remove
purchase_units[].descriptionreplace, add, remove
purchase_units[].payee.emailreplace
purchase_units[].shipping.namereplace, add
purchase_units[].shipping.email_addressreplace, add
purchase_units[].shipping.phone_numberreplace, add
purchase_units[].shipping.optionsreplace, add
purchase_units[].shipping.addressreplace, add
purchase_units[].shipping.typereplace, add
purchase_units[].soft_descriptorreplace, remove
purchase_units[].amountreplace
purchase_units[].itemsreplace, add, remove
purchase_units[].invoice_idreplace, add, remove
purchase_units[].payment_instructionreplace
purchase_units[].payment_instruction.disbursement_modereplaceBy default, disbursement_mode is INSTANT.
purchase_units[].payment_instruction.payee_receivable_fx_rate_idreplace, add, remove
purchase_units[].payment_instruction.platform_feesreplace, add, remove
purchase_units[].supplementary_data.airlinereplace, add, remove
purchase_units[].supplementary_data.cardreplace, add, remove
application_context.client_configurationreplace, add
- -```php -function ordersPatch(array $options): ApiResponse -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `id` | `string` | Template, Required | The ID of the order to update. | -| `body` | [`?(Patch[])`](../../doc/models/patch.md) | Body, Optional | - | - -## Response Type - -This method returns a `PayPalRESTAPIsLib\Utils\ApiResponse` instance. - -## Example Usage - -```php -$collect = [ - 'id' => 'id0', - 'body' => [ - PatchBuilder::init( - PatchOp::ADD - )->build() - ] -]; - -$apiResponse = $ordersController->ordersPatch($collect); -``` - -## Errors - -| HTTP Status Code | Error Description | Exception Class | -| --- | --- | --- | -| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) | -| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) | -| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) | -| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) | -| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) | - - -# Orders Confirm - -Payer confirms their intent to pay for the the Order with the given payment source. - -```php -function ordersConfirm(array $options): ApiResponse -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `id` | `string` | Template, Required | The ID of the order for which the payer confirms their intent to pay. | -| `payPalClientMetadataId` | `?string` | Header, Optional | - | -| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is: | -| `body` | [`?ConfirmOrderRequest`](../../doc/models/confirm-order-request.md) | Body, Optional | - | - -## Response Type - -This method returns a `PayPalRESTAPIsLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md). - -## Example Usage - -```php -$collect = [ - 'id' => 'id0', - 'prefer' => 'return=minimal', - 'body' => ConfirmOrderRequestBuilder::init( - PaymentSourceBuilder::init()->build() - ) - ->processingInstruction(ProcessingInstruction::NO_INSTRUCTION) - ->build() -]; - -$apiResponse = $ordersController->ordersConfirm($collect); -``` - -## Errors - -| HTTP Status Code | Error Description | Exception Class | -| --- | --- | --- | -| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) | -| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) | -| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) | -| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) | -| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) | - - -# Orders Authorize - -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 -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `id` | `string` | Template, Required | The ID of the order for which to authorize. | -| `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. | -| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is: | -| `payPalClientMetadataId` | `?string` | Header, Optional | - | -| `payPalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion. | -| `body` | [`?OrderAuthorizeRequest`](../../doc/models/order-authorize-request.md) | Body, Optional | - | - -## Response Type - -This method returns a `PayPalRESTAPIsLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`OrderAuthorizeResponse`](../../doc/models/order-authorize-response.md). - -## Example Usage - -```php -$collect = [ - 'id' => 'id0', - 'prefer' => 'return=minimal' -]; - -$apiResponse = $ordersController->ordersAuthorize($collect); -``` - -## Errors - -| HTTP Status Code | Error Description | Exception Class | -| --- | --- | --- | -| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) | -| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) | -| 403 | The authorized payment failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) | -| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) | -| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) | -| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) | -| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) | - - -# Orders Capture - -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 -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `id` | `string` | Template, Required | The ID of the order for which to capture a payment. | -| `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. | -| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is: | -| `payPalClientMetadataId` | `?string` | Header, Optional | - | -| `payPalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion. | -| `body` | [`?OrderCaptureRequest`](../../doc/models/order-capture-request.md) | Body, Optional | - | - -## Response Type - -This method returns a `PayPalRESTAPIsLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md). - -## Example Usage - -```php -$collect = [ - 'id' => 'id0', - 'prefer' => 'return=minimal' -]; - -$apiResponse = $ordersController->ordersCapture($collect); -``` - -## Errors - -| HTTP Status Code | Error Description | Exception Class | -| --- | --- | --- | -| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) | -| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) | -| 403 | The authorized payment failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) | -| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) | -| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) | -| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) | -| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) | - - -# Orders Track Create - -Adds tracking information for an Order. - -```php -function ordersTrackCreate(array $options): ApiResponse -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `id` | `string` | Template, Required | The ID of the order that the tracking information is associated with. | -| `body` | [`OrderTrackerRequest`](../../doc/models/order-tracker-request.md) | Body, Required | - | -| `payPalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion. | - -## Response Type - -This method returns a `PayPalRESTAPIsLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md). - -## Example Usage - -```php -$collect = [ - 'id' => 'id0', - 'body' => OrderTrackerRequestBuilder::init( - 'capture_id8' - ) - ->notifyPayer(false) - ->build() -]; - -$apiResponse = $ordersController->ordersTrackCreate($collect); -``` - -## Errors - -| HTTP Status Code | Error Description | Exception Class | -| --- | --- | --- | -| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) | -| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) | -| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) | -| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) | -| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) | -| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) | - - -# Orders Trackers Patch - -Updates or cancels the tracking information for a PayPal order, by ID. Updatable attributes or objects:

AttributeOpNotes
itemsreplaceUsing replace op for items will replace the entire items object with the value sent in request.
notify_payerreplace, add
statusreplaceOnly patching status to CANCELLED is currently supported.
- -```php -function ordersTrackersPatch(array $options): ApiResponse -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `id` | `string` | Template, Required | The ID of the order that the tracking information is associated with. | -| `trackerId` | `string` | Template, Required | The order tracking ID. | -| `body` | [`?(Patch[])`](../../doc/models/patch.md) | Body, Optional | - | - -## Response Type - -This method returns a `PayPalRESTAPIsLib\Utils\ApiResponse` instance. - -## Example Usage - -```php -$collect = [ - 'id' => 'id0', - 'trackerId' => 'tracker_id2', - 'body' => [ - PatchBuilder::init( - PatchOp::ADD - )->build() - ] -]; - -$apiResponse = $ordersController->ordersTrackersPatch($collect); -``` - -## Errors - -| HTTP Status Code | Error Description | Exception Class | -| --- | --- | --- | -| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) | -| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) | -| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) | -| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) | -| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) | -| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) | - diff --git a/doc/controllers/payments.md b/doc/controllers/payments.md deleted file mode 100644 index 93d749a..0000000 --- a/doc/controllers/payments.md +++ /dev/null @@ -1,329 +0,0 @@ -# Payments - -Use the `/payments` resource to authorize, capture, void authorizations, and retrieve captures. - -```php -$paymentsController = $client->getPaymentsController(); -``` - -## Class Name - -`PaymentsController` - -## Methods - -* [Authorizations Get](../../doc/controllers/payments.md#authorizations-get) -* [Authorizations Capture](../../doc/controllers/payments.md#authorizations-capture) -* [Authorizations Reauthorize](../../doc/controllers/payments.md#authorizations-reauthorize) -* [Authorizations Void](../../doc/controllers/payments.md#authorizations-void) -* [Captures Get](../../doc/controllers/payments.md#captures-get) -* [Captures Refund](../../doc/controllers/payments.md#captures-refund) -* [Refunds Get](../../doc/controllers/payments.md#refunds-get) - - -# Authorizations Get - -Shows details for an authorized payment, by ID. - -```php -function authorizationsGet(string $authorizationId): ApiResponse -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `authorizationId` | `string` | Template, Required | The ID of the authorized payment for which to show details. | - -## Response Type - -This method returns a `PayPalRESTAPIsLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentAuthorization`](../../doc/models/payment-authorization.md). - -## Example Usage - -```php -$authorizationId = 'authorization_id8'; - -$apiResponse = $paymentsController->authorizationsGet($authorizationId); -``` - -## Errors - -| HTTP Status Code | Error Description | Exception Class | -| --- | --- | --- | -| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) | -| 403 | The request failed because the caller has insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) | -| 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) | -| 500 | The request failed because an internal server error occurred. | `ApiException` | -| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) | - - -# Authorizations Capture - -Captures an authorized payment, by ID. - -```php -function authorizationsCapture(array $options): ApiResponse -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to capture. | -| `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: | -| `body` | [`?CaptureRequest`](../../doc/models/capture-request.md) | Body, Optional | - | - -## Response Type - -This method returns a `PayPalRESTAPIsLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`CapturedPayment`](../../doc/models/captured-payment.md). - -## Example Usage - -```php -$collect = [ - 'authorizationId' => 'authorization_id8', - 'prefer' => 'return=minimal', - 'body' => CaptureRequestBuilder::init() - ->finalCapture(false) - ->build() -]; - -$apiResponse = $paymentsController->authorizationsCapture($collect); -``` - -## Errors - -| HTTP Status Code | Error Description | Exception Class | -| --- | --- | --- | -| 400 | The request failed because it is not well-formed or is syntactically incorrect or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) | -| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) | -| 403 | The request failed because the caller has insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) | -| 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) | -| 422 | The request failed because it is semantically incorrect or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) | -| 500 | The request failed because an internal server error occurred. | `ApiException` | -| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) | - - -# Authorizations Reauthorize - -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 -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `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: | -| `body` | [`?ReauthorizeRequest`](../../doc/models/reauthorize-request.md) | Body, Optional | - | - -## Response Type - -This method returns a `PayPalRESTAPIsLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentAuthorization`](../../doc/models/payment-authorization.md). - -## Example Usage - -```php -$collect = [ - 'authorizationId' => 'authorization_id8', - 'prefer' => 'return=minimal' -]; - -$apiResponse = $paymentsController->authorizationsReauthorize($collect); -``` - -## Errors - -| HTTP Status Code | Error Description | Exception Class | -| --- | --- | --- | -| 400 | The request failed because it is not well-formed or is syntactically incorrect or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) | -| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) | -| 403 | The request failed because the caller has insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) | -| 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) | -| 422 | The request failed because it either is semantically incorrect or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) | -| 500 | The request failed because an internal server error occurred. | `ApiException` | -| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) | - - -# Authorizations Void - -Voids, or cancels, an authorized payment, by ID. You cannot void an authorized payment that has been fully captured. - -```php -function authorizationsVoid(array $options): ApiResponse -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to void. | -| `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.
| -| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is: | - -## Response Type - -This method returns a `PayPalRESTAPIsLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`?PaymentAuthorization`](../../doc/models/payment-authorization.md). - -## Example Usage - -```php -$collect = [ - 'authorizationId' => 'authorization_id8', - 'prefer' => 'return=minimal' -]; - -$apiResponse = $paymentsController->authorizationsVoid($collect); -``` - -## Errors - -| HTTP Status Code | Error Description | Exception Class | -| --- | --- | --- | -| 400 | The request failed because it is not well-formed or is syntactically incorrect or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) | -| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) | -| 403 | The request failed because the caller has insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) | -| 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) | -| 409 | The request failed because a previous call for the given resource is in progress. | [`ErrorException`](../../doc/models/error-exception.md) | -| 422 | The request failed because it either is semantically incorrect or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) | -| 500 | The request failed because an internal server error occurred. | `ApiException` | -| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) | - - -# Captures Get - -Shows details for a captured payment, by ID. - -```php -function capturesGet(string $captureId): ApiResponse -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `captureId` | `string` | Template, Required | The PayPal-generated ID for the captured payment for which to show details. | - -## Response Type - -This method returns a `PayPalRESTAPIsLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`CapturedPayment`](../../doc/models/captured-payment.md). - -## Example Usage - -```php -$captureId = 'capture_id2'; - -$apiResponse = $paymentsController->capturesGet($captureId); -``` - -## Errors - -| HTTP Status Code | Error Description | Exception Class | -| --- | --- | --- | -| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) | -| 403 | The request failed because the caller has insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) | -| 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) | -| 500 | The request failed because an internal server error occurred. | `ApiException` | -| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) | - - -# Captures Refund - -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 -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `captureId` | `string` | Template, Required | The PayPal-generated ID for the captured payment to refund. | -| `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: | -| `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.
| -| `body` | [`?RefundRequest`](../../doc/models/refund-request.md) | Body, Optional | - | - -## Response Type - -This method returns a `PayPalRESTAPIsLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Refund`](../../doc/models/refund.md). - -## Example Usage - -```php -$collect = [ - 'captureId' => '1234', - 'payPalRequestId' => '1234', - 'prefer' => 'return=minimal', - 'payPalAuthAssertion' => 'PayPal-Auth-Assertion', - 'body' => RefundRequestBuilder::init() - ->amount( - MoneyBuilder::init( - 'USD', - '1.44' - )->build() - ) - ->noteToPayer('Defective product') - ->build() -]; - -$apiResponse = $paymentsController->capturesRefund($collect); -``` - -## Errors - -| HTTP Status Code | Error Description | Exception Class | -| --- | --- | --- | -| 400 | The request failed because it is not well-formed or is syntactically incorrect or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) | -| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) | -| 403 | The request failed because the caller has insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) | -| 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) | -| 409 | The request failed because a previous call for the given resource is in progress. | [`ErrorException`](../../doc/models/error-exception.md) | -| 422 | The request failed because it either is semantically incorrect or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) | -| 500 | The request failed because an internal server error occurred. | `ApiException` | -| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) | - - -# Refunds Get - -Shows details for a refund, by ID. - -```php -function refundsGet(string $refundId): ApiResponse -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `refundId` | `string` | Template, Required | The PayPal-generated ID for the refund for which to show details. | - -## Response Type - -This method returns a `PayPalRESTAPIsLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Refund`](../../doc/models/refund.md). - -## Example Usage - -```php -$refundId = 'refund_id4'; - -$apiResponse = $paymentsController->refundsGet($refundId); -``` - -## Errors - -| HTTP Status Code | Error Description | Exception Class | -| --- | --- | --- | -| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) | -| 403 | The request failed because the caller has insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) | -| 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) | -| 500 | The request failed because an internal server error occurred. | `ApiException` | -| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) | - diff --git a/doc/controllers/vault.md b/doc/controllers/vault.md deleted file mode 100644 index d58e0ba..0000000 --- a/doc/controllers/vault.md +++ /dev/null @@ -1,262 +0,0 @@ -# Vault - -Use the `/vault` resource to create, retrieve, and delete payment and setup tokens. - -```php -$vaultController = $client->getVaultController(); -``` - -## Class Name - -`VaultController` - -## 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) - - -# Payment-Tokens Create - -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 -``` - -## 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. | - -## Response Type - -This method returns a `PayPalRESTAPIsLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentTokenResponse`](../../doc/models/payment-token-response.md). - -## Example Usage - -```php -$collect = [ - 'payPalRequestId' => '12345', - 'body' => PaymentTokenRequestBuilder::init( - PaymentTokenRequestPaymentSourceBuilder::init() - ->token( - VaultTokenRequestBuilder::init( - '1234', - TokenType::SETUP_TOKEN - )->build() - )->build() - )->build() -]; - -$apiResponse = $vaultController->paymentTokensCreate($collect); -``` - -## Errors - -| HTTP Status Code | Error Description | Exception Class | -| --- | --- | --- | -| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) | -| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) | -| 404 | Request contains reference to resources that do not exist. | [`ErrorException`](../../doc/models/error-exception.md) | -| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) | -| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) | - - -# Customer Payment-Tokens Get - -Returns all payment tokens for a customer. - -```php -function customerPaymentTokensGet(array $options): ApiResponse -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `customerId` | `string` | Query, Required | A unique identifier representing a specific customer in merchant's/partner's system or records. | -| `pageSize` | `?int` | Query, Optional | A non-negative, non-zero integer indicating the maximum number of results to return at one time. | -| `page` | `?int` | Query, Optional | A non-negative, non-zero integer representing the page of the results. | -| `totalRequired` | `?bool` | Query, Optional | A boolean indicating total number of items (total_items) and pages (total_pages) are expected to be returned in the response. | - -## Response Type - -This method returns a `PayPalRESTAPIsLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`CustomerVaultPaymentTokensResponse`](../../doc/models/customer-vault-payment-tokens-response.md). - -## Example Usage - -```php -$collect = [ - 'customerId' => 'customer_id8', - 'pageSize' => 5, - 'page' => 1, - 'totalRequired' => false -]; - -$apiResponse = $vaultController->customerPaymentTokensGet($collect); -``` - -## Errors - -| HTTP Status Code | Error Description | Exception Class | -| --- | --- | --- | -| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) | -| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) | -| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) | - - -# Payment-Tokens Get - -Returns a readable representation of vaulted payment source associated with the payment token id. - -```php -function paymentTokensGet(string $id): ApiResponse -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `id` | `string` | Template, Required | ID of the payment token. | - -## Response Type - -This method returns a `PayPalRESTAPIsLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentTokenResponse`](../../doc/models/payment-token-response.md). - -## Example Usage - -```php -$id = 'id0'; - -$apiResponse = $vaultController->paymentTokensGet($id); -``` - -## Errors - -| HTTP Status Code | Error Description | Exception Class | -| --- | --- | --- | -| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) | -| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) | -| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) | -| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) | - - -# Payment-Tokens Delete - -Delete the payment token associated with the payment token id. - -```php -function paymentTokensDelete(string $id): ApiResponse -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `id` | `string` | Template, Required | ID of the payment token. | - -## Response Type - -This method returns a `PayPalRESTAPIsLib\Utils\ApiResponse` instance. - -## Example Usage - -```php -$id = 'id0'; - -$apiResponse = $vaultController->paymentTokensDelete($id); -``` - -## Errors - -| HTTP Status Code | Error Description | Exception Class | -| --- | --- | --- | -| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) | -| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) | -| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) | - - -# Setup-Tokens Create - -Creates a Setup Token from the given payment source and adds it to the Vault of the associated customer. - -```php -function setupTokensCreate(array $options): ApiResponse -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `payPalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. | -| `body` | [`SetupTokenRequest`](../../doc/models/setup-token-request.md) | Body, Required | Setup Token creation with a instrument type optional financial instrument details and customer_id. | - -## Response Type - -This method returns a `PayPalRESTAPIsLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`SetupTokenResponse`](../../doc/models/setup-token-response.md). - -## Example Usage - -```php -$collect = [ - 'payPalRequestId' => 'PayPal-Request-Id6', - 'body' => SetupTokenRequestBuilder::init( - SetupTokenRequestPaymentSourceBuilder::init()->build() - )->build() -]; - -$apiResponse = $vaultController->setupTokensCreate($collect); -``` - -## Errors - -| HTTP Status Code | Error Description | Exception Class | -| --- | --- | --- | -| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) | -| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) | -| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) | -| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) | - - -# Setup-Tokens Get - -Returns a readable representation of temporarily vaulted payment source associated with the setup token id. - -```php -function setupTokensGet(string $id): ApiResponse -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `id` | `string` | Template, Required | ID of the setup token. | - -## Response Type - -This method returns a `PayPalRESTAPIsLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`SetupTokenResponse`](../../doc/models/setup-token-response.md). - -## Example Usage - -```php -$id = 'id0'; - -$apiResponse = $vaultController->setupTokensGet($id); -``` - -## Errors - -| HTTP Status Code | Error Description | Exception Class | -| --- | --- | --- | -| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) | -| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) | -| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) | -| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) | - diff --git a/doc/http-request.md b/doc/http-request.md deleted file mode 100644 index 065d652..0000000 --- a/doc/http-request.md +++ /dev/null @@ -1,14 +0,0 @@ - -# HttpRequest - -Represents a single Http Request. - -## Methods - -| Name | Type | Description | -| --- | --- | --- | -| getHttpMethod() | string | The HTTP method of the request. | -| getQueryUrl() | string | The endpoint URL for the API request. | -| getHeaders() | array | Request headers. | -| getParameters() | array | Input parameters for the body. | - diff --git a/doc/http-response.md b/doc/http-response.md deleted file mode 100644 index e7bdfc9..0000000 --- a/doc/http-response.md +++ /dev/null @@ -1,13 +0,0 @@ - -# HttpResponse - -Http response received. - -## Methods - -| Name | Type | Description | -| --- | --- | --- | -| getStatusCode() | int | The status code of the response. | -| getHeaders() | array | Response headers. | -| getRawBody() | string | Raw body of the response. | - diff --git a/doc/logging-configuration-builder.md b/doc/logging-configuration-builder.md deleted file mode 100644 index 160fb56..0000000 --- a/doc/logging-configuration-builder.md +++ /dev/null @@ -1,50 +0,0 @@ - -# LoggingConfigurationBuilder Class - -Represents the logging configurations for API calls. Create instance using `LoggingConfigurationBuilder::init()` - -## Methods - -| Name | Parameter Type | Description | -| --- | --- | --- | -| logger | `LoggerInterface` | Takes in your custom implementation of the Psr\Log\LoggerInterface.php. **Default Implementation : `ConsoleLogger`** | -| level | `string(LogLevel)` | Defines the log message severity mentioned in Psr\Log\LogLevel.php (e.g., DEBUG, INFO, etc). **Default : `logLevel::INFO`** | -| maskSensitiveHeaders | `bool` | Toggles the global setting to mask sensitive HTTP headers in both requests and responses before logging, safeguarding confidential data. **Default : `true`** | -| requestConfiguration | [`RequestLoggingConfigurationBuilder`](request-logging-configuration-builder.md) | The logging configurations for an API request. | -| responseConfiguration | [`RequestLoggingConfigurationBuilder`](response-logging-configuration-builder.md) | The logging configurations for an API response. | - -## Usage Example - -### Client Initialization with Custom Logger - -In order to provide custom logger, any implementation of the `Psr\Log\LoggerInterface` can be used so that you can override the `log` behavior and provide its instance directly in the SDK client initialization. - -The following example uses `Monolog\Logger` implementation of `Psr\Log\LoggerInterface` for PayPalRESTAPIsClient initialization. - -```php -pushHandler(new StreamHandler(__DIR__ . '/api_data.log')); - -// initialize the sdk client using this logger -$client = PayPalRESTAPIsClientBuilder::init() - ->loggingConfiguration( - LoggingConfigurationBuilder::init() - ->logger($logger) - ->level(LogLevel::INFO) - ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true)) - ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true)) - ) - ->build(); -``` - diff --git a/doc/models/ach-debit-response.md b/doc/models/ach-debit-response.md deleted file mode 100644 index 7fcff96..0000000 --- a/doc/models/ach-debit-response.md +++ /dev/null @@ -1,23 +0,0 @@ - -# ACH Debit Response - -A Resource representing a response of vaulted a ACH Debit Account. - -## Structure - -`ACHDebitResponse` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `verificationStatus` | `?string` | Optional | The ach debit verification status.
**Default**: `'NOT_VERIFIED'`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | getVerificationStatus(): ?string | setVerificationStatus(?string verificationStatus): void | - -## Example (as JSON) - -```json -{ - "verification_status": "NOT_VERIFIED" -} -``` - diff --git a/doc/models/activity-timestamps.md b/doc/models/activity-timestamps.md deleted file mode 100644 index 32b3e5b..0000000 --- a/doc/models/activity-timestamps.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Activity Timestamps - -The date and time stamps that are common to authorized payment, captured payment, and refund transactions. - -## Structure - -`ActivityTimestamps` - -## Fields - -| 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.
Note: The regular expression provides guidance but does not reject all invalid dates.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getCreateTime(): ?string | setCreateTime(?string createTime): void | -| `updateTime` | `?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.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getUpdateTime(): ?string | setUpdateTime(?string updateTime): void | - -## Example (as JSON) - -```json -{ - "create_time": "create_time2", - "update_time": "update_time2" -} -``` - diff --git a/doc/models/address-details.md b/doc/models/address-details.md deleted file mode 100644 index 22aaad4..0000000 --- a/doc/models/address-details.md +++ /dev/null @@ -1,38 +0,0 @@ - -# Address Details - -Address request details. - -## Structure - -`AddressDetails` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `addressLine1` | `?string` | Optional | 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.
**Constraints**: *Maximum Length*: `300` | getAddressLine1(): ?string | setAddressLine1(?string addressLine1): void | -| `addressLine2` | `?string` | Optional | The second line of the address, for example, a suite or apartment number.
**Constraints**: *Maximum Length*: `300` | getAddressLine2(): ?string | setAddressLine2(?string addressLine2): void | -| `adminArea2` | `?string` | Optional | A city, town, or village. Smaller than `admin_area_level_1`.
**Constraints**: *Maximum Length*: `120` | getAdminArea2(): ?string | setAdminArea2(?string adminArea2): void | -| `adminArea1` | `?string` | Optional | 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:
**Constraints**: *Maximum Length*: `300` | getAdminArea1(): ?string | setAdminArea1(?string adminArea1): void | -| `postalCode` | `?string` | Optional | 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).
**Constraints**: *Maximum Length*: `60` | getPostalCode(): ?string | setPostalCode(?string postalCode): void | -| `countryCode` | `string` | Required | 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.

**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): string | setCountryCode(string countryCode): void | -| `name` | [`?Name`](../../doc/models/name.md) | Optional | The name of the party. | getName(): ?Name | setName(?Name name): void | -| `id` | `?string` | Optional | The resource ID of the address.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[0-9A-Za-z-_]+$` | getId(): ?string | setId(?string id): void | -| `company` | `?string` | Optional | The name of the company or business associated to the address.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `100`, *Pattern*: `^.*$` | getCompany(): ?string | setCompany(?string company): void | -| `phone` | `?string` | Optional | The phone number that can go on the mailing label with the address to track the shipping. Phone number is in E.164 format.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `16`, *Pattern*: `^\+[1-9]\d{1,14}$` | getPhone(): ?string | setPhone(?string phone): void | -| `phoneNumber` | [`?Phone`](../../doc/models/phone.md) | Optional | The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). | getPhoneNumber(): ?Phone | setPhoneNumber(?Phone phoneNumber): void | - -## Example (as JSON) - -```json -{ - "address_line_1": "address_line_10", - "address_line_2": "address_line_20", - "admin_area_2": "admin_area_24", - "admin_area_1": "admin_area_16", - "postal_code": "postal_code2", - "country_code": "country_code0" -} -``` - diff --git a/doc/models/address.md b/doc/models/address.md deleted file mode 100644 index 38a82ce..0000000 --- a/doc/models/address.md +++ /dev/null @@ -1,33 +0,0 @@ - -# 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). - -## Structure - -`Address` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `addressLine1` | `?string` | Optional | 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.
**Constraints**: *Maximum Length*: `300` | getAddressLine1(): ?string | setAddressLine1(?string addressLine1): void | -| `addressLine2` | `?string` | Optional | The second line of the address, for example, a suite or apartment number.
**Constraints**: *Maximum Length*: `300` | getAddressLine2(): ?string | setAddressLine2(?string addressLine2): void | -| `adminArea2` | `?string` | Optional | A city, town, or village. Smaller than `admin_area_level_1`.
**Constraints**: *Maximum Length*: `120` | getAdminArea2(): ?string | setAdminArea2(?string adminArea2): void | -| `adminArea1` | `?string` | Optional | 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:
**Constraints**: *Maximum Length*: `300` | getAdminArea1(): ?string | setAdminArea1(?string adminArea1): void | -| `postalCode` | `?string` | Optional | 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).
**Constraints**: *Maximum Length*: `60` | getPostalCode(): ?string | setPostalCode(?string postalCode): void | -| `countryCode` | `string` | Required | 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.

**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): string | setCountryCode(string countryCode): void | - -## Example (as JSON) - -```json -{ - "address_line_1": "address_line_18", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_22", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" -} -``` - diff --git a/doc/models/amount-breakdown.md b/doc/models/amount-breakdown.md deleted file mode 100644 index 7fa8fe1..0000000 --- a/doc/models/amount-breakdown.md +++ /dev/null @@ -1,48 +0,0 @@ - -# Amount Breakdown - -The breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, shipping, handling, insurance, and discounts, if any. - -## Structure - -`AmountBreakdown` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `itemTotal` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getItemTotal(): ?Money | setItemTotal(?Money itemTotal): void | -| `shipping` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getShipping(): ?Money | setShipping(?Money shipping): void | -| `handling` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getHandling(): ?Money | setHandling(?Money handling): void | -| `taxTotal` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getTaxTotal(): ?Money | setTaxTotal(?Money taxTotal): void | -| `insurance` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getInsurance(): ?Money | setInsurance(?Money insurance): void | -| `shippingDiscount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getShippingDiscount(): ?Money | setShippingDiscount(?Money shippingDiscount): void | -| `discount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getDiscount(): ?Money | setDiscount(?Money discount): void | - -## Example (as JSON) - -```json -{ - "item_total": { - "currency_code": "currency_code0", - "value": "value6" - }, - "shipping": { - "currency_code": "currency_code0", - "value": "value6" - }, - "handling": { - "currency_code": "currency_code2", - "value": "value8" - }, - "tax_total": { - "currency_code": "currency_code4", - "value": "value0" - }, - "insurance": { - "currency_code": "currency_code2", - "value": "value8" - } -} -``` - diff --git a/doc/models/amount-with-breakdown.md b/doc/models/amount-with-breakdown.md deleted file mode 100644 index 120db72..0000000 --- a/doc/models/amount-with-breakdown.md +++ /dev/null @@ -1,48 +0,0 @@ - -# Amount With Breakdown - -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. - -## Structure - -`AmountWithBreakdown` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `currencyCode` | `string` | Required | The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `3` | getCurrencyCode(): string | setCurrencyCode(string currencyCode): void | -| `value` | `string` | Required | The value, which might be:For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).
**Constraints**: *Maximum Length*: `32`, *Pattern*: `^((-?[0-9]+)\|(-?([0-9]+)?[.][0-9]+))$` | getValue(): string | setValue(string value): void | -| `breakdown` | [`?AmountBreakdown`](../../doc/models/amount-breakdown.md) | Optional | The breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, shipping, handling, insurance, and discounts, if any. | getBreakdown(): ?AmountBreakdown | setBreakdown(?AmountBreakdown breakdown): void | - -## Example (as JSON) - -```json -{ - "currency_code": "currency_code4", - "value": "value0", - "breakdown": { - "item_total": { - "currency_code": "currency_code0", - "value": "value6" - }, - "shipping": { - "currency_code": "currency_code0", - "value": "value6" - }, - "handling": { - "currency_code": "currency_code2", - "value": "value8" - }, - "tax_total": { - "currency_code": "currency_code4", - "value": "value0" - }, - "insurance": { - "currency_code": "currency_code2", - "value": "value8" - } - } -} -``` - diff --git a/doc/models/apple-pay-attributes-response.md b/doc/models/apple-pay-attributes-response.md deleted file mode 100644 index 9fa4dbd..0000000 --- a/doc/models/apple-pay-attributes-response.md +++ /dev/null @@ -1,36 +0,0 @@ - -# Apple Pay Attributes Response - -Additional attributes associated with the use of Apple Pay. - -## Structure - -`ApplePayAttributesResponse` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `vault` | [`?VaultResponse`](../../doc/models/vault-response.md) | Optional | The details about a saved payment source. | getVault(): ?VaultResponse | setVault(?VaultResponse vault): void | - -## Example (as JSON) - -```json -{ - "vault": { - "id": "id6", - "status": "APPROVED", - "customer": { - "id": "id0" - }, - "links": [ - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - } - ] - } -} -``` - diff --git a/doc/models/apple-pay-attributes.md b/doc/models/apple-pay-attributes.md deleted file mode 100644 index 41b3b0e..0000000 --- a/doc/models/apple-pay-attributes.md +++ /dev/null @@ -1,36 +0,0 @@ - -# Apple Pay Attributes - -Additional attributes associated with apple pay. - -## Structure - -`ApplePayAttributes` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `customer` | [`?CustomerInformation`](../../doc/models/customer-information.md) | Optional | The details about a customer in PayPal's system of record. | getCustomer(): ?CustomerInformation | setCustomer(?CustomerInformation customer): void | -| `vault` | [`?VaultInstruction`](../../doc/models/vault-instruction.md) | Optional | Base vaulting specification. The object can be extended for specific use cases within each payment_source that supports vaulting. | getVault(): ?VaultInstruction | setVault(?VaultInstruction vault): void | - -## Example (as JSON) - -```json -{ - "customer": { - "id": "id0", - "email_address": "email_address2", - "phone": { - "phone_type": "OTHER", - "phone_number": { - "national_number": "national_number6" - } - } - }, - "vault": { - "store_in_vault": "ON_SUCCESS" - } -} -``` - diff --git a/doc/models/apple-pay-card-response.md b/doc/models/apple-pay-card-response.md deleted file mode 100644 index 026e705..0000000 --- a/doc/models/apple-pay-card-response.md +++ /dev/null @@ -1,40 +0,0 @@ - -# Apple Pay Card Response - -The Card from Apple Pay Wallet used to fund the payment. - -## Structure - -`ApplePayCardResponse` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `?string` | Optional | The card holder's name as it appears on the card.
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `300` | getName(): ?string | setName(?string name): void | -| `lastDigits` | `?string` | Optional | The last digits of the payment card.
**Constraints**: *Pattern*: `[0-9]{2,}` | getLastDigits(): ?string | setLastDigits(?string lastDigits): void | -| `brand` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | The card network or brand. Applies to credit, debit, gift, and payment cards.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getBrand(): ?string | setBrand(?string brand): void | -| `availableNetworks` | [`?(string(CardBrand)[])`](../../doc/models/card-brand.md) | Optional | Array of brands or networks associated with the card.
**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `256`, *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getAvailableNetworks(): ?array | setAvailableNetworks(?array availableNetworks): void | -| `type` | [`?string(CardType)`](../../doc/models/card-type.md) | Optional | Type of card. i.e Credit, Debit and so on.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getType(): ?string | setType(?string type): void | -| `authenticationResult` | [`?AuthenticationResponse`](../../doc/models/authentication-response.md) | Optional | Results of Authentication such as 3D Secure. | getAuthenticationResult(): ?AuthenticationResponse | setAuthenticationResult(?AuthenticationResponse authenticationResult): void | -| `attributes` | [`?CardAttributesResponse`](../../doc/models/card-attributes-response.md) | Optional | Additional attributes associated with the use of this card. | getAttributes(): ?CardAttributesResponse | setAttributes(?CardAttributesResponse attributes): void | -| `fromRequest` | [`?CardFromRequest`](../../doc/models/card-from-request.md) | Optional | Representation of card details as received in the request. | getFromRequest(): ?CardFromRequest | setFromRequest(?CardFromRequest fromRequest): void | -| `expiry` | `?string` | Optional | 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).
**Constraints**: *Minimum Length*: `7`, *Maximum Length*: `7`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])$` | getExpiry(): ?string | setExpiry(?string expiry): void | -| `binDetails` | [`?BinDetails`](../../doc/models/bin-details.md) | Optional | Bank Identification Number (BIN) details used to fund a payment. | getBinDetails(): ?BinDetails | setBinDetails(?BinDetails binDetails): void | -| `billingAddress` | [`?Address`](../../doc/models/address.md) | Optional | 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). | getBillingAddress(): ?Address | setBillingAddress(?Address billingAddress): void | -| `countryCode` | `?string` | Optional | 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 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.

**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): ?string | setCountryCode(?string countryCode): void | - -## Example (as JSON) - -```json -{ - "name": "name4", - "last_digits": "last_digits8", - "brand": "DINERS", - "available_networks": [ - "MASTERCARD" - ], - "type": "DEBIT" -} -``` - diff --git a/doc/models/apple-pay-card.md b/doc/models/apple-pay-card.md deleted file mode 100644 index f04b785..0000000 --- a/doc/models/apple-pay-card.md +++ /dev/null @@ -1,38 +0,0 @@ - -# Apple Pay Card - -The payment card to be used to fund a payment. Can be a credit or debit card. - -## Structure - -`ApplePayCard` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `?string` | Optional | The card holder's name as it appears on the card.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `300`, *Pattern*: `^.{1,300}$` | getName(): ?string | setName(?string name): void | -| `lastDigits` | `?string` | Optional | The last digits of the payment card.
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `4`, *Pattern*: `^[0-9]{2,4}$` | getLastDigits(): ?string | setLastDigits(?string lastDigits): void | -| `type` | [`?string(CardType)`](../../doc/models/card-type.md) | Optional | Type of card. i.e Credit, Debit and so on.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getType(): ?string | setType(?string type): void | -| `brand` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | The card network or brand. Applies to credit, debit, gift, and payment cards.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getBrand(): ?string | setBrand(?string brand): void | -| `billingAddress` | [`?Address`](../../doc/models/address.md) | Optional | 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). | getBillingAddress(): ?Address | setBillingAddress(?Address billingAddress): void | - -## Example (as JSON) - -```json -{ - "name": "name4", - "last_digits": "last_digits8", - "type": "UNKNOWN", - "brand": "CETELEM", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } -} -``` - diff --git a/doc/models/apple-pay-decrypted-token-data.md b/doc/models/apple-pay-decrypted-token-data.md deleted file mode 100644 index 8014371..0000000 --- a/doc/models/apple-pay-decrypted-token-data.md +++ /dev/null @@ -1,45 +0,0 @@ - -# Apple Pay Decrypted Token Data - -Information about the Payment data obtained by decrypting Apple Pay token. - -## Structure - -`ApplePayDecryptedTokenData` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `transactionAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getTransactionAmount(): ?Money | setTransactionAmount(?Money transactionAmount): void | -| `tokenizedCard` | [`ApplePayTokenizedCard`](../../doc/models/apple-pay-tokenized-card.md) | Required | The payment card to use to fund a payment. Can be a credit or debit card. | getTokenizedCard(): ApplePayTokenizedCard | setTokenizedCard(ApplePayTokenizedCard tokenizedCard): void | -| `deviceManufacturerId` | `?string` | Optional | Apple Pay Hex-encoded device manufacturer identifier. The pattern is defined by an external party and supports Unicode.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2000`, *Pattern*: `^.*$` | getDeviceManufacturerId(): ?string | setDeviceManufacturerId(?string deviceManufacturerId): void | -| `paymentDataType` | [`?string(ApplePayPaymentDataType)`](../../doc/models/apple-pay-payment-data-type.md) | Optional | Indicates the type of payment data passed, in case of Non China the payment data is 3DSECURE and for China it is EMV.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `16`, *Pattern*: `^[0-9A-Z_]+$` | getPaymentDataType(): ?string | setPaymentDataType(?string paymentDataType): void | -| `paymentData` | [`?ApplePayPaymentData`](../../doc/models/apple-pay-payment-data.md) | Optional | Information about the decrypted apple pay payment data for the token like cryptogram, eci indicator. | getPaymentData(): ?ApplePayPaymentData | setPaymentData(?ApplePayPaymentData paymentData): void | - -## Example (as JSON) - -```json -{ - "transaction_amount": { - "currency_code": "currency_code6", - "value": "value2" - }, - "tokenized_card": { - "name": "name4", - "number": "number2", - "expiry": "expiry2", - "card_type": "HIPER", - "type": "UNKNOWN" - }, - "device_manufacturer_id": "device_manufacturer_id2", - "payment_data_type": "3DSECURE", - "payment_data": { - "cryptogram": "cryptogram6", - "eci_indicator": "eci_indicator0", - "emv_data": "emv_data0", - "pin": "pin4" - } -} -``` - diff --git a/doc/models/apple-pay-payment-data-type.md b/doc/models/apple-pay-payment-data-type.md deleted file mode 100644 index 87e4229..0000000 --- a/doc/models/apple-pay-payment-data-type.md +++ /dev/null @@ -1,16 +0,0 @@ - -# Apple Pay Payment Data Type - -Indicates the type of payment data passed, in case of Non China the payment data is 3DSECURE and for China it is EMV. - -## Enumeration - -`ApplePayPaymentDataType` - -## Fields - -| Name | -| --- | -| `ENUM_3DSECURE` | -| `EMV` | - diff --git a/doc/models/apple-pay-payment-data.md b/doc/models/apple-pay-payment-data.md deleted file mode 100644 index 6be3094..0000000 --- a/doc/models/apple-pay-payment-data.md +++ /dev/null @@ -1,29 +0,0 @@ - -# Apple Pay Payment Data - -Information about the decrypted apple pay payment data for the token like cryptogram, eci indicator. - -## Structure - -`ApplePayPaymentData` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `cryptogram` | `?string` | Optional | Online payment cryptogram, as defined by 3D Secure. The pattern is defined by an external party and supports Unicode.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2000`, *Pattern*: `^.*$` | getCryptogram(): ?string | setCryptogram(?string cryptogram): void | -| `eciIndicator` | `?string` | Optional | ECI indicator, as defined by 3- Secure. The pattern is defined by an external party and supports Unicode.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `256`, *Pattern*: `^.*$` | getEciIndicator(): ?string | setEciIndicator(?string eciIndicator): void | -| `emvData` | `?string` | Optional | Encoded Apple Pay EMV Payment Structure used for payments in China. The pattern is defined by an external party and supports Unicode.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2000`, *Pattern*: `^.*$` | getEmvData(): ?string | setEmvData(?string emvData): void | -| `pin` | `?string` | Optional | Bank Key encrypted Apple Pay PIN. The pattern is defined by an external party and supports Unicode.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2000`, *Pattern*: `^.*$` | getPin(): ?string | setPin(?string pin): void | - -## Example (as JSON) - -```json -{ - "cryptogram": "cryptogram6", - "eci_indicator": "eci_indicator0", - "emv_data": "emv_data0", - "pin": "pin4" -} -``` - diff --git a/doc/models/apple-pay-payment-object.md b/doc/models/apple-pay-payment-object.md deleted file mode 100644 index b994c46..0000000 --- a/doc/models/apple-pay-payment-object.md +++ /dev/null @@ -1,35 +0,0 @@ - -# Apple Pay Payment Object - -Information needed to pay using ApplePay. - -## Structure - -`ApplePayPaymentObject` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `id` | `?string` | Optional | ApplePay transaction identifier, this will be the unique identifier for this transaction provided by Apple. The pattern is defined by an external party and supports Unicode.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `250`, *Pattern*: `^.*$` | getId(): ?string | setId(?string id): void | -| `token` | `?string` | Optional | Encrypted ApplePay token, containing card information. This token would be base64encoded. The pattern is defined by an external party and supports Unicode.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `10000`, *Pattern*: `^.*$` | getToken(): ?string | setToken(?string token): void | -| `name` | `?string` | Optional | The full name representation like Mr J Smith.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): ?string | setName(?string name): 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.

**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: `^(?:[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\|\[(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?\|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void | -| `phoneNumber` | [`?PhoneNumber`](../../doc/models/phone-number.md) | Optional | The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). | getPhoneNumber(): ?PhoneNumber | setPhoneNumber(?PhoneNumber phoneNumber): void | -| `card` | [`?ApplePayCardResponse`](../../doc/models/apple-pay-card-response.md) | Optional | The Card from Apple Pay Wallet used to fund the payment. | getCard(): ?ApplePayCardResponse | setCard(?ApplePayCardResponse card): void | -| `attributes` | [`?ApplePayAttributesResponse`](../../doc/models/apple-pay-attributes-response.md) | Optional | Additional attributes associated with the use of Apple Pay. | getAttributes(): ?ApplePayAttributesResponse | setAttributes(?ApplePayAttributesResponse attributes): void | - -## Example (as JSON) - -```json -{ - "id": "id6", - "token": "token0", - "name": "name6", - "email_address": "email_address4", - "phone_number": { - "national_number": "national_number6" - } -} -``` - diff --git a/doc/models/apple-pay-payment-token.md b/doc/models/apple-pay-payment-token.md deleted file mode 100644 index 0eaf8cd..0000000 --- a/doc/models/apple-pay-payment-token.md +++ /dev/null @@ -1,36 +0,0 @@ - -# Apple Pay Payment Token - -A resource representing a response for Apple Pay. - -## Structure - -`ApplePayPaymentToken` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `card` | [`?ApplePayCard`](../../doc/models/apple-pay-card.md) | Optional | The payment card to be used to fund a payment. Can be a credit or debit card. | getCard(): ?ApplePayCard | setCard(?ApplePayCard card): void | - -## Example (as JSON) - -```json -{ - "card": { - "name": "name6", - "last_digits": "last_digits0", - "type": "UNKNOWN", - "brand": "SYNCHRONY", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } - } -} -``` - diff --git a/doc/models/apple-pay-request.md b/doc/models/apple-pay-request.md deleted file mode 100644 index afc318c..0000000 --- a/doc/models/apple-pay-request.md +++ /dev/null @@ -1,56 +0,0 @@ - -# Apple Pay Request - -Information needed to pay using ApplePay. - -## Structure - -`ApplePayRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `id` | `?string` | Optional | ApplePay transaction identifier, this will be the unique identifier for this transaction provided by Apple. The pattern is defined by an external party and supports Unicode.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `250`, *Pattern*: `^.*$` | getId(): ?string | setId(?string id): void | -| `name` | `?string` | Optional | The full name representation like Mr J Smith.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): ?string | setName(?string name): 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.

**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: `^(?:[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\|\[(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?\|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void | -| `phoneNumber` | [`?PhoneNumber`](../../doc/models/phone-number.md) | Optional | The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). | getPhoneNumber(): ?PhoneNumber | setPhoneNumber(?PhoneNumber phoneNumber): void | -| `decryptedToken` | [`?ApplePayDecryptedTokenData`](../../doc/models/apple-pay-decrypted-token-data.md) | Optional | Information about the Payment data obtained by decrypting Apple Pay token. | getDecryptedToken(): ?ApplePayDecryptedTokenData | setDecryptedToken(?ApplePayDecryptedTokenData decryptedToken): void | -| `storedCredential` | [`?CardStoredCredential`](../../doc/models/card-stored-credential.md) | Optional | 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:
| getStoredCredential(): ?CardStoredCredential | setStoredCredential(?CardStoredCredential storedCredential): void | -| `vaultId` | `?string` | Optional | The PayPal-generated ID for the vaulted payment source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9a-zA-Z_-]+$` | getVaultId(): ?string | setVaultId(?string vaultId): void | -| `attributes` | [`?ApplePayAttributes`](../../doc/models/apple-pay-attributes.md) | Optional | Additional attributes associated with apple pay. | getAttributes(): ?ApplePayAttributes | setAttributes(?ApplePayAttributes attributes): void | - -## Example (as JSON) - -```json -{ - "id": "id6", - "name": "name6", - "email_address": "email_address4", - "phone_number": { - "national_number": "national_number6" - }, - "decrypted_token": { - "transaction_amount": { - "currency_code": "currency_code6", - "value": "value2" - }, - "tokenized_card": { - "name": "name4", - "number": "number2", - "expiry": "expiry2", - "card_type": "HIPER", - "type": "UNKNOWN" - }, - "device_manufacturer_id": "device_manufacturer_id6", - "payment_data_type": "3DSECURE", - "payment_data": { - "cryptogram": "cryptogram6", - "eci_indicator": "eci_indicator0", - "emv_data": "emv_data0", - "pin": "pin4" - } - } -} -``` - diff --git a/doc/models/apple-pay-tokenized-card.md b/doc/models/apple-pay-tokenized-card.md deleted file mode 100644 index 35a6d53..0000000 --- a/doc/models/apple-pay-tokenized-card.md +++ /dev/null @@ -1,33 +0,0 @@ - -# Apple Pay Tokenized Card - -The payment card to use to fund a payment. Can be a credit or debit card. - -## Structure - -`ApplePayTokenizedCard` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `?string` | Optional | The card holder's name as it appears on the card.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `300`, *Pattern*: `^.{1,300}$` | getName(): ?string | setName(?string name): void | -| `number` | `?string` | Optional | The primary account number (PAN) for the payment card.
**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `19`, *Pattern*: `^[0-9]{13,19}$` | getNumber(): ?string | setNumber(?string number): void | -| `expiry` | `?string` | Optional | 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).
**Constraints**: *Minimum Length*: `7`, *Maximum Length*: `7`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])$` | getExpiry(): ?string | setExpiry(?string expiry): void | -| `cardType` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | The card network or brand. Applies to credit, debit, gift, and payment cards.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getCardType(): ?string | setCardType(?string cardType): void | -| `type` | [`?string(CardType)`](../../doc/models/card-type.md) | Optional | Type of card. i.e Credit, Debit and so on.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getType(): ?string | setType(?string type): void | -| `brand` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | The card network or brand. Applies to credit, debit, gift, and payment cards.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getBrand(): ?string | setBrand(?string brand): void | -| `billingAddress` | [`?Address`](../../doc/models/address.md) | Optional | 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). | getBillingAddress(): ?Address | setBillingAddress(?Address billingAddress): void | - -## Example (as JSON) - -```json -{ - "name": "name8", - "number": "number6", - "expiry": "expiry6", - "card_type": "SYNCHRONY", - "type": "STORE" -} -``` - diff --git a/doc/models/authentication-response.md b/doc/models/authentication-response.md deleted file mode 100644 index 90f5eb8..0000000 --- a/doc/models/authentication-response.md +++ /dev/null @@ -1,28 +0,0 @@ - -# Authentication Response - -Results of Authentication such as 3D Secure. - -## Structure - -`AuthenticationResponse` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `liabilityShift` | [`?string(LiabilityShiftIndicator)`](../../doc/models/liability-shift-indicator.md) | Optional | Liability shift indicator. The outcome of the issuer's authentication.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getLiabilityShift(): ?string | setLiabilityShift(?string liabilityShift): void | -| `threeDSecure` | [`?ThreeDSecureAuthenticationResponse`](../../doc/models/three-d-secure-authentication-response.md) | Optional | Results of 3D Secure Authentication. | getThreeDSecure(): ?ThreeDSecureAuthenticationResponse | setThreeDSecure(?ThreeDSecureAuthenticationResponse threeDSecure): void | - -## Example (as JSON) - -```json -{ - "liability_shift": "POSSIBLE", - "three_d_secure": { - "authentication_status": "C", - "enrollment_status": "Y" - } -} -``` - diff --git a/doc/models/authorization-incomplete-reason.md b/doc/models/authorization-incomplete-reason.md deleted file mode 100644 index d145f01..0000000 --- a/doc/models/authorization-incomplete-reason.md +++ /dev/null @@ -1,16 +0,0 @@ - -# Authorization Incomplete Reason - -The reason why the authorized status is `PENDING`. - -## Enumeration - -`AuthorizationIncompleteReason` - -## Fields - -| Name | -| --- | -| `PENDING_REVIEW` | -| `DECLINED_BY_RISK_FRAUD_FILTERS` | - diff --git a/doc/models/authorization-status-details.md b/doc/models/authorization-status-details.md deleted file mode 100644 index 7f674ba..0000000 --- a/doc/models/authorization-status-details.md +++ /dev/null @@ -1,23 +0,0 @@ - -# Authorization Status Details - -The details of the authorized payment status. - -## Structure - -`AuthorizationStatusDetails` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `reason` | [`?string(AuthorizationIncompleteReason)`](../../doc/models/authorization-incomplete-reason.md) | Optional | The reason why the authorized status is `PENDING`.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64`, *Pattern*: `^[A-Z_]+$` | getReason(): ?string | setReason(?string reason): void | - -## Example (as JSON) - -```json -{ - "reason": "PENDING_REVIEW" -} -``` - diff --git a/doc/models/authorization-status-with-details.md b/doc/models/authorization-status-with-details.md deleted file mode 100644 index ad99074..0000000 --- a/doc/models/authorization-status-with-details.md +++ /dev/null @@ -1,27 +0,0 @@ - -# Authorization Status With Details - -The status fields and status details for an authorized payment. - -## Structure - -`AuthorizationStatusWithDetails` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `status` | [`?string(AuthorizationStatus)`](../../doc/models/authorization-status.md) | Optional | The status for the authorized payment. | getStatus(): ?string | setStatus(?string status): void | -| `statusDetails` | [`?AuthorizationStatusDetails`](../../doc/models/authorization-status-details.md) | Optional | The details of the authorized payment status. | getStatusDetails(): ?AuthorizationStatusDetails | setStatusDetails(?AuthorizationStatusDetails statusDetails): void | - -## Example (as JSON) - -```json -{ - "status": "VOIDED", - "status_details": { - "reason": "PENDING_REVIEW" - } -} -``` - diff --git a/doc/models/authorization-status.md b/doc/models/authorization-status.md deleted file mode 100644 index 07147e9..0000000 --- a/doc/models/authorization-status.md +++ /dev/null @@ -1,20 +0,0 @@ - -# Authorization Status - -The status for the authorized payment. - -## Enumeration - -`AuthorizationStatus` - -## Fields - -| Name | -| --- | -| `CREATED` | -| `CAPTURED` | -| `DENIED` | -| `PARTIALLY_CAPTURED` | -| `VOIDED` | -| `PENDING` | - diff --git a/doc/models/authorization-with-additional-data.md b/doc/models/authorization-with-additional-data.md deleted file mode 100644 index 8ef63ac..0000000 --- a/doc/models/authorization-with-additional-data.md +++ /dev/null @@ -1,44 +0,0 @@ - -# Authorization With Additional Data - -The authorization with additional payment details, such as risk assessment and processor response. These details are populated only for certain payment methods. - -## Structure - -`AuthorizationWithAdditionalData` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `status` | [`?string(AuthorizationStatus)`](../../doc/models/authorization-status.md) | Optional | The status for the authorized payment. | getStatus(): ?string | setStatus(?string status): void | -| `statusDetails` | [`?AuthorizationStatusDetails`](../../doc/models/authorization-status-details.md) | Optional | The details of the authorized payment status. | getStatusDetails(): ?AuthorizationStatusDetails | setStatusDetails(?AuthorizationStatusDetails statusDetails): void | -| `id` | `?string` | Optional | The PayPal-generated ID for the authorized payment. | getId(): ?string | setId(?string id): void | -| `amount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): ?Money | setAmount(?Money amount): void | -| `invoiceId` | `?string` | Optional | 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. | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void | -| `customId` | `?string` | Optional | The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
**Constraints**: *Maximum Length*: `127` | getCustomId(): ?string | setCustomId(?string customId): void | -| `networkTransactionReference` | [`?NetworkTransactionReference`](../../doc/models/network-transaction-reference.md) | Optional | Reference values used by the card network to identify a transaction. | getNetworkTransactionReference(): ?NetworkTransactionReference | setNetworkTransactionReference(?NetworkTransactionReference networkTransactionReference): void | -| `sellerProtection` | [`?SellerProtection`](../../doc/models/seller-protection.md) | Optional | The level of protection offered as defined by [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection). | getSellerProtection(): ?SellerProtection | setSellerProtection(?SellerProtection sellerProtection): void | -| `expirationTime` | `?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.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getExpirationTime(): ?string | setExpirationTime(?string expirationTime): 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.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getCreateTime(): ?string | setCreateTime(?string createTime): void | -| `updateTime` | `?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.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getUpdateTime(): ?string | setUpdateTime(?string updateTime): void | -| `processorResponse` | [`?ProcessorResponse`](../../doc/models/processor-response.md) | Optional | The processor response information for payment requests, such as direct credit card transactions. | getProcessorResponse(): ?ProcessorResponse | setProcessorResponse(?ProcessorResponse processorResponse): void | - -## Example (as JSON) - -```json -{ - "status": "VOIDED", - "status_details": { - "reason": "PENDING_REVIEW" - }, - "id": "id6", - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "invoice_id": "invoice_id6" -} -``` - diff --git a/doc/models/authorization.md b/doc/models/authorization.md deleted file mode 100644 index b16e765..0000000 --- a/doc/models/authorization.md +++ /dev/null @@ -1,43 +0,0 @@ - -# Authorization - -The authorized payment transaction. - -## Structure - -`Authorization` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `status` | [`?string(AuthorizationStatus)`](../../doc/models/authorization-status.md) | Optional | The status for the authorized payment. | getStatus(): ?string | setStatus(?string status): void | -| `statusDetails` | [`?AuthorizationStatusDetails`](../../doc/models/authorization-status-details.md) | Optional | The details of the authorized payment status. | getStatusDetails(): ?AuthorizationStatusDetails | setStatusDetails(?AuthorizationStatusDetails statusDetails): void | -| `id` | `?string` | Optional | The PayPal-generated ID for the authorized payment. | getId(): ?string | setId(?string id): void | -| `amount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): ?Money | setAmount(?Money amount): void | -| `invoiceId` | `?string` | Optional | 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. | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void | -| `customId` | `?string` | Optional | The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
**Constraints**: *Maximum Length*: `127` | getCustomId(): ?string | setCustomId(?string customId): void | -| `networkTransactionReference` | [`?NetworkTransactionReference`](../../doc/models/network-transaction-reference.md) | Optional | Reference values used by the card network to identify a transaction. | getNetworkTransactionReference(): ?NetworkTransactionReference | setNetworkTransactionReference(?NetworkTransactionReference networkTransactionReference): void | -| `sellerProtection` | [`?SellerProtection`](../../doc/models/seller-protection.md) | Optional | The level of protection offered as defined by [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection). | getSellerProtection(): ?SellerProtection | setSellerProtection(?SellerProtection sellerProtection): void | -| `expirationTime` | `?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.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getExpirationTime(): ?string | setExpirationTime(?string expirationTime): 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.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getCreateTime(): ?string | setCreateTime(?string createTime): void | -| `updateTime` | `?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.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getUpdateTime(): ?string | setUpdateTime(?string updateTime): void | - -## Example (as JSON) - -```json -{ - "status": "CREATED", - "status_details": { - "reason": "PENDING_REVIEW" - }, - "id": "id8", - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "invoice_id": "invoice_id8" -} -``` - diff --git a/doc/models/avs-code.md b/doc/models/avs-code.md deleted file mode 100644 index 06db627..0000000 --- a/doc/models/avs-code.md +++ /dev/null @@ -1,38 +0,0 @@ - -# AVS Code - -The address verification code for Visa, Discover, Mastercard, or American Express transactions. - -## Enumeration - -`AVSCode` - -## Fields - -| Name | -| --- | -| `A` | -| `B` | -| `C` | -| `D` | -| `E` | -| `F` | -| `G` | -| `I` | -| `M` | -| `N` | -| `P` | -| `R` | -| `S` | -| `U` | -| `W` | -| `X` | -| `Y` | -| `Z` | -| `NULL` | -| `ENUM_0` | -| `ENUM_1` | -| `ENUM_2` | -| `ENUM_3` | -| `ENUM_4` | - diff --git a/doc/models/bancontact-payment-object.md b/doc/models/bancontact-payment-object.md deleted file mode 100644 index de55a77..0000000 --- a/doc/models/bancontact-payment-object.md +++ /dev/null @@ -1,31 +0,0 @@ - -# Bancontact Payment Object - -Information used to pay Bancontact. - -## Structure - -`BancontactPaymentObject` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `?string` | Optional | The full name representation like Mr J Smith.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): ?string | setName(?string name): void | -| `countryCode` | `?string` | Optional | 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 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.

**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): ?string | setCountryCode(?string countryCode): void | -| `bic` | `?string` | Optional | The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.
**Constraints**: *Minimum Length*: `8`, *Maximum Length*: `11`, *Pattern*: `^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$` | getBic(): ?string | setBic(?string bic): void | -| `ibanLastChars` | `?string` | Optional | The last characters of the IBAN used to pay.
**Constraints**: *Minimum Length*: `4`, *Maximum Length*: `34`, *Pattern*: `[a-zA-Z0-9]{4}` | getIbanLastChars(): ?string | setIbanLastChars(?string ibanLastChars): void | -| `cardLastDigits` | `?string` | Optional | The last digits of the card used to fund the Bancontact payment.
**Constraints**: *Minimum Length*: `4`, *Maximum Length*: `4`, *Pattern*: `[0-9]{4}` | getCardLastDigits(): ?string | setCardLastDigits(?string cardLastDigits): void | - -## Example (as JSON) - -```json -{ - "name": "name6", - "country_code": "country_code6", - "bic": "bic8", - "iban_last_chars": "iban_last_chars4", - "card_last_digits": "card_last_digits0" -} -``` - diff --git a/doc/models/bancontact-payment-request.md b/doc/models/bancontact-payment-request.md deleted file mode 100644 index b5fbea9..0000000 --- a/doc/models/bancontact-payment-request.md +++ /dev/null @@ -1,33 +0,0 @@ - -# Bancontact Payment Request - -Information needed to pay using Bancontact. - -## Structure - -`BancontactPaymentRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `string` | Required | The full name representation like Mr J Smith.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): string | setName(string name): void | -| `countryCode` | `string` | Required | 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 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.

**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): string | setCountryCode(string countryCode): void | -| `experienceContext` | [`?ExperienceContext`](../../doc/models/experience-context.md) | Optional | Customizes the payer experience during the approval process for the payment. | getExperienceContext(): ?ExperienceContext | setExperienceContext(?ExperienceContext experienceContext): void | - -## Example (as JSON) - -```json -{ - "name": "name8", - "country_code": "country_code8", - "experience_context": { - "brand_name": "brand_name2", - "locale": "locale6", - "shipping_preference": "NO_SHIPPING", - "return_url": "return_url4", - "cancel_url": "cancel_url6" - } -} -``` - diff --git a/doc/models/bank-payment-token.md b/doc/models/bank-payment-token.md deleted file mode 100644 index 8c4f7f4..0000000 --- a/doc/models/bank-payment-token.md +++ /dev/null @@ -1,44 +0,0 @@ - -# Bank Payment Token - -Full representation of a Bank Payment Token. - -## Structure - -`BankPaymentToken` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `achDebit` | [`?ACHDebitResponse`](../../doc/models/ach-debit-response.md) | Optional | A Resource representing a response of vaulted a ACH Debit Account. | getAchDebit(): ?ACHDebitResponse | setAchDebit(?ACHDebitResponse achDebit): void | -| `sepaDebit` | [`?SEPADebitResponse`](../../doc/models/sepa-debit-response.md) | Optional | - | getSepaDebit(): ?SEPADebitResponse | setSepaDebit(?SEPADebitResponse sepaDebit): void | - -## Example (as JSON) - -```json -{ - "ach_debit": { - "verification_status": "verification_status6" - }, - "sepa_debit": { - "iban_last_chars": "iban_last_chars8", - "account_holder_name": { - "key1": "val1", - "key2": "val2" - }, - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - }, - "authorization_details": { - "status": "NOT_SUPPORTED" - } - } -} -``` - diff --git a/doc/models/bin-details.md b/doc/models/bin-details.md deleted file mode 100644 index 82d0386..0000000 --- a/doc/models/bin-details.md +++ /dev/null @@ -1,33 +0,0 @@ - -# Bin Details - -Bank Identification Number (BIN) details used to fund a payment. - -## Structure - -`BinDetails` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `bin` | `?string` | Optional | The Bank Identification Number (BIN) signifies the number that is being used to identify the granular level details (except the PII information) of the card.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `25`, *Pattern*: `^[0-9]+$` | getBin(): ?string | setBin(?string bin): void | -| `issuingBank` | `?string` | Optional | The issuer of the card instrument.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64` | getIssuingBank(): ?string | setIssuingBank(?string issuingBank): void | -| `binCountryCode` | `?string` | Optional | 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 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.

**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getBinCountryCode(): ?string | setBinCountryCode(?string binCountryCode): void | -| `products` | `?(string[])` | Optional | The type of card product assigned to the BIN by the issuer. These values are defined by the issuer and may change over time. Some examples include: PREPAID_GIFT, CONSUMER, CORPORATE.
**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `256`, *Minimum Length*: `1`, *Maximum Length*: `255` | getProducts(): ?array | setProducts(?array products): void | - -## Example (as JSON) - -```json -{ - "bin": "bin0", - "issuing_bank": "issuing_bank0", - "bin_country_code": "bin_country_code4", - "products": [ - "products8", - "products9", - "products0" - ] -} -``` - diff --git a/doc/models/blik-experience-context.md b/doc/models/blik-experience-context.md deleted file mode 100644 index 9a964f6..0000000 --- a/doc/models/blik-experience-context.md +++ /dev/null @@ -1,33 +0,0 @@ - -# BLIK Experience Context - -Customizes the payer experience during the approval process for the BLIK payment. - -## Structure - -`BLIKExperienceContext` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `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.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127`, *Pattern*: `^.*$` | getBrandName(): ?string | setBrandName(?string brandName): void | -| `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/).
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `10`, *Pattern*: `^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}\|[0-9]{3}))?$` | getLocale(): ?string | setLocale(?string locale): void | -| `shippingPreference` | [`?string(ShippingPreference)`](../../doc/models/shipping-preference.md) | Optional | The location from which the shipping address is derived.
**Default**: `ShippingPreference::GET_FROM_FILE`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `24`, *Pattern*: `^[A-Z_]+$` | getShippingPreference(): ?string | setShippingPreference(?string shippingPreference): void | -| `returnUrl` | `?string` | Optional | Describes the URL. | getReturnUrl(): ?string | setReturnUrl(?string returnUrl): void | -| `cancelUrl` | `?string` | Optional | Describes the URL. | getCancelUrl(): ?string | setCancelUrl(?string cancelUrl): void | -| `consumerIp` | `?string` | Optional | 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.
**Constraints**: *Minimum Length*: `7`, *Maximum Length*: `39`, *Pattern*: `^(([0-9]\|[1-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5])\.){3}([0-9]\|[1-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5])$\|^(([a-zA-Z]\|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z]\|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9])$\|^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}\|:))\|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}\|((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3})\|:))\|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})\|:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3})\|:))\|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})\|((:[0-9A-Fa-f]{1,4})?:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3}))\|:))\|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})\|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3}))\|:))\|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})\|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3}))\|:))\|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})\|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3}))\|:))\|(:(((:[0-9A-Fa-f]{1,4}){1,7})\|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3}))\|:)))(%.+)?\s*$` | getConsumerIp(): ?string | setConsumerIp(?string consumerIp): void | -| `consumerUserAgent` | `?string` | Optional | The payer's User Agent. For example, Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `256`, *Pattern*: `^.*$` | getConsumerUserAgent(): ?string | setConsumerUserAgent(?string consumerUserAgent): void | - -## Example (as JSON) - -```json -{ - "shipping_preference": "GET_FROM_FILE", - "brand_name": "brand_name0", - "locale": "locale4", - "return_url": "return_url2", - "cancel_url": "cancel_url4" -} -``` - diff --git a/doc/models/blik-level-0-payment-object.md b/doc/models/blik-level-0-payment-object.md deleted file mode 100644 index 3d22135..0000000 --- a/doc/models/blik-level-0-payment-object.md +++ /dev/null @@ -1,23 +0,0 @@ - -# BLIK Level 0 Payment Object - -Information used to pay using BLIK level_0 flow. - -## Structure - -`BLIKLevel0PaymentObject` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `authCode` | `string` | Required | The 6-digit code used to authenticate a consumer within BLIK.
**Constraints**: *Minimum Length*: `6`, *Maximum Length*: `6`, *Pattern*: `^[0-9]{6}$` | getAuthCode(): string | setAuthCode(string authCode): void | - -## Example (as JSON) - -```json -{ - "auth_code": "auth_code6" -} -``` - diff --git a/doc/models/blik-one-click-payment-object.md b/doc/models/blik-one-click-payment-object.md deleted file mode 100644 index 84d842d..0000000 --- a/doc/models/blik-one-click-payment-object.md +++ /dev/null @@ -1,23 +0,0 @@ - -# BLIK One Click Payment Object - -Information used to pay using BLIK one-click flow. - -## Structure - -`BLIKOneClickPaymentObject` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `consumerReference` | `?string` | Optional | The merchant generated, unique reference serving as a primary identifier for accounts connected between Blik and a merchant.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `64`, *Pattern*: `^[ -~]{3,64}$` | getConsumerReference(): ?string | setConsumerReference(?string consumerReference): void | - -## Example (as JSON) - -```json -{ - "consumer_reference": "consumer_reference0" -} -``` - diff --git a/doc/models/blik-one-click-payment-request.md b/doc/models/blik-one-click-payment-request.md deleted file mode 100644 index 66bf619..0000000 --- a/doc/models/blik-one-click-payment-request.md +++ /dev/null @@ -1,29 +0,0 @@ - -# BLIK One Click Payment Request - -Information used to pay using BLIK one-click flow. - -## Structure - -`BLIKOneClickPaymentRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `authCode` | `?string` | Optional | The 6-digit code used to authenticate a consumer within BLIK.
**Constraints**: *Minimum Length*: `6`, *Maximum Length*: `6`, *Pattern*: `^[0-9]{6}$` | getAuthCode(): ?string | setAuthCode(?string authCode): void | -| `consumerReference` | `string` | Required | The merchant generated, unique reference serving as a primary identifier for accounts connected between Blik and a merchant.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `64`, *Pattern*: `^[ -~]{3,64}$` | getConsumerReference(): string | setConsumerReference(string consumerReference): void | -| `aliasLabel` | `?string` | Optional | A bank defined identifier used as a display name to allow the payer to differentiate between multiple registered bank accounts.
**Constraints**: *Minimum Length*: `8`, *Maximum Length*: `35`, *Pattern*: `^[ -~]{8,35}$` | getAliasLabel(): ?string | setAliasLabel(?string aliasLabel): void | -| `aliasKey` | `?string` | Optional | A Blik-defined identifier for a specific Blik-enabled bank account that is associated with a given merchant. Used only in conjunction with a Consumer Reference.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `19`, *Pattern*: `^[0-9]+$` | getAliasKey(): ?string | setAliasKey(?string aliasKey): void | - -## Example (as JSON) - -```json -{ - "auth_code": "auth_code8", - "consumer_reference": "consumer_reference6", - "alias_label": "alias_label2", - "alias_key": "alias_key6" -} -``` - diff --git a/doc/models/blik-payment-object.md b/doc/models/blik-payment-object.md deleted file mode 100644 index c1643aa..0000000 --- a/doc/models/blik-payment-object.md +++ /dev/null @@ -1,31 +0,0 @@ - -# BLIK Payment Object - -Information used to pay using BLIK. - -## Structure - -`BLIKPaymentObject` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `?string` | Optional | The full name representation like Mr J Smith.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): ?string | setName(?string name): void | -| `countryCode` | `?string` | Optional | 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 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.

**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): ?string | setCountryCode(?string countryCode): void | -| `email` | `?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.

**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: `^(?:[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\|\[(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?\|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$` | getEmail(): ?string | setEmail(?string email): void | -| `oneClick` | [`?BLIKOneClickPaymentObject`](../../doc/models/blik-one-click-payment-object.md) | Optional | Information used to pay using BLIK one-click flow. | getOneClick(): ?BLIKOneClickPaymentObject | setOneClick(?BLIKOneClickPaymentObject oneClick): void | - -## Example (as JSON) - -```json -{ - "name": "name8", - "country_code": "country_code8", - "email": "email8", - "one_click": { - "consumer_reference": "consumer_reference2" - } -} -``` - diff --git a/doc/models/blik-payment-request.md b/doc/models/blik-payment-request.md deleted file mode 100644 index 17eb7a7..0000000 --- a/doc/models/blik-payment-request.md +++ /dev/null @@ -1,46 +0,0 @@ - -# BLIK Payment Request - -Information needed to pay using BLIK. - -## Structure - -`BLIKPaymentRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `string` | Required | The full name representation like Mr J Smith.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): string | setName(string name): void | -| `countryCode` | `string` | Required | 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 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.

**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): string | setCountryCode(string countryCode): void | -| `email` | `?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.

**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: `^(?:[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\|\[(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?\|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$` | getEmail(): ?string | setEmail(?string email): void | -| `experienceContext` | [`?BLIKExperienceContext`](../../doc/models/blik-experience-context.md) | Optional | Customizes the payer experience during the approval process for the BLIK payment. | getExperienceContext(): ?BLIKExperienceContext | setExperienceContext(?BLIKExperienceContext experienceContext): void | -| `level0` | [`?BLIKLevel0PaymentObject`](../../doc/models/blik-level-0-payment-object.md) | Optional | Information used to pay using BLIK level_0 flow. | getLevel0(): ?BLIKLevel0PaymentObject | setLevel0(?BLIKLevel0PaymentObject level0): void | -| `oneClick` | [`?BLIKOneClickPaymentRequest`](../../doc/models/blik-one-click-payment-request.md) | Optional | Information used to pay using BLIK one-click flow. | getOneClick(): ?BLIKOneClickPaymentRequest | setOneClick(?BLIKOneClickPaymentRequest oneClick): void | - -## Example (as JSON) - -```json -{ - "name": "name8", - "country_code": "country_code8", - "email": "email8", - "experience_context": { - "brand_name": "brand_name2", - "locale": "locale6", - "shipping_preference": "NO_SHIPPING", - "return_url": "return_url4", - "cancel_url": "cancel_url6" - }, - "level_0": { - "auth_code": "auth_code8" - }, - "one_click": { - "auth_code": "auth_code0", - "consumer_reference": "consumer_reference2", - "alias_label": "alias_label6", - "alias_key": "alias_key4" - } -} -``` - diff --git a/doc/models/capture-incomplete-reason.md b/doc/models/capture-incomplete-reason.md deleted file mode 100644 index bc27f97..0000000 --- a/doc/models/capture-incomplete-reason.md +++ /dev/null @@ -1,26 +0,0 @@ - -# Capture Incomplete Reason - -The reason why the captured payment status is `PENDING` or `DENIED`. - -## Enumeration - -`CaptureIncompleteReason` - -## Fields - -| Name | -| --- | -| `BUYER_COMPLAINT` | -| `CHARGEBACK` | -| `ECHECK` | -| `INTERNATIONAL_WITHDRAWAL` | -| `OTHER` | -| `PENDING_REVIEW` | -| `RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION` | -| `REFUNDED` | -| `TRANSACTION_APPROVED_AWAITING_FUNDING` | -| `UNILATERAL` | -| `VERIFICATION_REQUIRED` | -| `DECLINED_BY_RISK_FRAUD_FILTERS` | - diff --git a/doc/models/capture-payment-instruction.md b/doc/models/capture-payment-instruction.md deleted file mode 100644 index f9fa4a0..0000000 --- a/doc/models/capture-payment-instruction.md +++ /dev/null @@ -1,48 +0,0 @@ - -# Capture Payment Instruction - -Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order. - -## Structure - -`CapturePaymentInstruction` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `platformFees` | [`?(PlatformFee[])`](../../doc/models/platform-fee.md) | Optional | An array of platform or partner fees, commissions, or brokerage fees that associated with the captured payment.
**Constraints**: *Minimum Items*: `0`, *Maximum Items*: `1` | getPlatformFees(): ?array | setPlatformFees(?array platformFees): void | -| `disbursementMode` | [`?string(DisbursementMode)`](../../doc/models/disbursement-mode.md) | Optional | The funds that are held on behalf of the merchant.
**Default**: `DisbursementMode::INSTANT`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `16`, *Pattern*: `^[A-Z_]+$` | getDisbursementMode(): ?string | setDisbursementMode(?string disbursementMode): void | -| `payeeReceivableFxRateId` | `?string` | Optional | FX identifier generated returned by PayPal to be used for payment processing in order to honor FX rate (for eligible integrations) to be used when amount is settled/received into the payee account.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `4000`, *Pattern*: `^.*$` | getPayeeReceivableFxRateId(): ?string | setPayeeReceivableFxRateId(?string payeeReceivableFxRateId): void | - -## Example (as JSON) - -```json -{ - "disbursement_mode": "INSTANT", - "platform_fees": [ - { - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "payee": { - "email_address": "email_address4", - "merchant_id": "merchant_id6" - } - }, - { - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "payee": { - "email_address": "email_address4", - "merchant_id": "merchant_id6" - } - } - ], - "payee_receivable_fx_rate_id": "payee_receivable_fx_rate_id8" -} -``` - diff --git a/doc/models/capture-request.md b/doc/models/capture-request.md deleted file mode 100644 index 99557e8..0000000 --- a/doc/models/capture-request.md +++ /dev/null @@ -1,68 +0,0 @@ - -# Capture Request - -## Structure - -`CaptureRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `invoiceId` | `?string` | Optional | 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.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127`, *Pattern*: `^.{1,127}$` | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void | -| `noteToPayer` | `?string` | Optional | An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^.{1,255}$` | getNoteToPayer(): ?string | setNoteToPayer(?string noteToPayer): void | -| `amount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): ?Money | setAmount(?Money amount): void | -| `finalCapture` | `?bool` | Optional | 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.
**Default**: `false` | getFinalCapture(): ?bool | setFinalCapture(?bool finalCapture): void | -| `paymentInstruction` | [`?CapturePaymentInstruction`](../../doc/models/capture-payment-instruction.md) | Optional | Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order. | getPaymentInstruction(): ?CapturePaymentInstruction | setPaymentInstruction(?CapturePaymentInstruction paymentInstruction): void | -| `softDescriptor` | `?string` | Optional | The payment descriptor on the payer's account statement.
**Constraints**: *Maximum Length*: `22` | getSoftDescriptor(): ?string | setSoftDescriptor(?string softDescriptor): void | - -## Example (as JSON) - -```json -{ - "final_capture": false, - "invoice_id": "invoice_id4", - "note_to_payer": "note_to_payer6", - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "payment_instruction": { - "platform_fees": [ - { - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "payee": { - "email_address": "email_address4", - "merchant_id": "merchant_id6" - } - }, - { - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "payee": { - "email_address": "email_address4", - "merchant_id": "merchant_id6" - } - }, - { - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "payee": { - "email_address": "email_address4", - "merchant_id": "merchant_id6" - } - } - ], - "disbursement_mode": "INSTANT", - "payee_receivable_fx_rate_id": "payee_receivable_fx_rate_id0" - } -} -``` - diff --git a/doc/models/capture-status-details.md b/doc/models/capture-status-details.md deleted file mode 100644 index e8166a5..0000000 --- a/doc/models/capture-status-details.md +++ /dev/null @@ -1,23 +0,0 @@ - -# Capture Status Details - -The details of the captured payment status. - -## Structure - -`CaptureStatusDetails` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `reason` | [`?string(CaptureIncompleteReason)`](../../doc/models/capture-incomplete-reason.md) | Optional | The reason why the captured payment status is `PENDING` or `DENIED`.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64`, *Pattern*: `^[A-Z_]+$` | getReason(): ?string | setReason(?string reason): void | - -## Example (as JSON) - -```json -{ - "reason": "BUYER_COMPLAINT" -} -``` - diff --git a/doc/models/capture-status-with-details.md b/doc/models/capture-status-with-details.md deleted file mode 100644 index dabbc5c..0000000 --- a/doc/models/capture-status-with-details.md +++ /dev/null @@ -1,27 +0,0 @@ - -# Capture Status With Details - -The status and status details of a captured payment. - -## Structure - -`CaptureStatusWithDetails` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `status` | [`?string(CaptureStatus)`](../../doc/models/capture-status.md) | Optional | The status of the captured payment. | getStatus(): ?string | setStatus(?string status): void | -| `statusDetails` | [`?CaptureStatusDetails`](../../doc/models/capture-status-details.md) | Optional | The details of the captured payment status. | getStatusDetails(): ?CaptureStatusDetails | setStatusDetails(?CaptureStatusDetails statusDetails): void | - -## Example (as JSON) - -```json -{ - "status": "COMPLETED", - "status_details": { - "reason": "VERIFICATION_REQUIRED" - } -} -``` - diff --git a/doc/models/capture-status.md b/doc/models/capture-status.md deleted file mode 100644 index ce4005d..0000000 --- a/doc/models/capture-status.md +++ /dev/null @@ -1,20 +0,0 @@ - -# Capture Status - -The status of the captured payment. - -## Enumeration - -`CaptureStatus` - -## Fields - -| Name | -| --- | -| `COMPLETED` | -| `DECLINED` | -| `PARTIALLY_REFUNDED` | -| `PENDING` | -| `REFUNDED` | -| `FAILED` | - diff --git a/doc/models/capture.md b/doc/models/capture.md deleted file mode 100644 index 0c40a1e..0000000 --- a/doc/models/capture.md +++ /dev/null @@ -1,48 +0,0 @@ - -# Capture - -A captured payment. - -## Structure - -`Capture` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `status` | [`?string(CaptureStatus)`](../../doc/models/capture-status.md) | Optional | The status of the captured payment. | getStatus(): ?string | setStatus(?string status): void | -| `statusDetails` | [`?CaptureStatusDetails`](../../doc/models/capture-status-details.md) | Optional | The details of the captured payment status. | getStatusDetails(): ?CaptureStatusDetails | setStatusDetails(?CaptureStatusDetails statusDetails): void | -| `id` | `?string` | Optional | The PayPal-generated ID for the captured payment. | getId(): ?string | setId(?string id): void | -| `amount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): ?Money | setAmount(?Money amount): void | -| `invoiceId` | `?string` | Optional | 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. | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void | -| `customId` | `?string` | Optional | The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
**Constraints**: *Maximum Length*: `127` | getCustomId(): ?string | setCustomId(?string customId): void | -| `networkTransactionReference` | [`?NetworkTransactionReference`](../../doc/models/network-transaction-reference.md) | Optional | Reference values used by the card network to identify a transaction. | getNetworkTransactionReference(): ?NetworkTransactionReference | setNetworkTransactionReference(?NetworkTransactionReference networkTransactionReference): void | -| `sellerProtection` | [`?SellerProtection`](../../doc/models/seller-protection.md) | Optional | The level of protection offered as defined by [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection). | getSellerProtection(): ?SellerProtection | setSellerProtection(?SellerProtection sellerProtection): void | -| `finalCapture` | `?bool` | Optional | 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.
**Default**: `false` | getFinalCapture(): ?bool | setFinalCapture(?bool finalCapture): void | -| `sellerReceivableBreakdown` | [`?SellerReceivableBreakdown`](../../doc/models/seller-receivable-breakdown.md) | Optional | The detailed breakdown of the capture activity. This is not available for transactions that are in pending state. | getSellerReceivableBreakdown(): ?SellerReceivableBreakdown | setSellerReceivableBreakdown(?SellerReceivableBreakdown sellerReceivableBreakdown): void | -| `disbursementMode` | [`?string(DisbursementMode)`](../../doc/models/disbursement-mode.md) | Optional | The funds that are held on behalf of the merchant.
**Default**: `DisbursementMode::INSTANT`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `16`, *Pattern*: `^[A-Z_]+$` | getDisbursementMode(): ?string | setDisbursementMode(?string disbursementMode): 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 | -| `processorResponse` | [`?ProcessorResponse`](../../doc/models/processor-response.md) | Optional | The processor response information for payment requests, such as direct credit card transactions. | getProcessorResponse(): ?ProcessorResponse | setProcessorResponse(?ProcessorResponse processorResponse): 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.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getCreateTime(): ?string | setCreateTime(?string createTime): void | -| `updateTime` | `?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.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getUpdateTime(): ?string | setUpdateTime(?string updateTime): void | - -## Example (as JSON) - -```json -{ - "final_capture": false, - "disbursement_mode": "INSTANT", - "status": "PARTIALLY_REFUNDED", - "status_details": { - "reason": "VERIFICATION_REQUIRED" - }, - "id": "id6", - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "invoice_id": "invoice_id6" -} -``` - diff --git a/doc/models/captured-payment.md b/doc/models/captured-payment.md deleted file mode 100644 index bbd23f8..0000000 --- a/doc/models/captured-payment.md +++ /dev/null @@ -1,50 +0,0 @@ - -# Captured Payment - -A captured payment. - -## Structure - -`CapturedPayment` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `status` | [`?string(CaptureStatus)`](../../doc/models/capture-status.md) | Optional | The status of the captured payment. | getStatus(): ?string | setStatus(?string status): void | -| `statusDetails` | [`?CaptureStatusDetails`](../../doc/models/capture-status-details.md) | Optional | The details of the captured payment status. | getStatusDetails(): ?CaptureStatusDetails | setStatusDetails(?CaptureStatusDetails statusDetails): void | -| `id` | `?string` | Optional | The PayPal-generated ID for the captured payment. | getId(): ?string | setId(?string id): void | -| `amount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): ?Money | setAmount(?Money amount): void | -| `invoiceId` | `?string` | Optional | 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. | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void | -| `customId` | `?string` | Optional | The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
**Constraints**: *Maximum Length*: `127` | getCustomId(): ?string | setCustomId(?string customId): void | -| `networkTransactionReference` | [`?NetworkTransactionReference`](../../doc/models/network-transaction-reference.md) | Optional | Reference values used by the card network to identify a transaction. | getNetworkTransactionReference(): ?NetworkTransactionReference | setNetworkTransactionReference(?NetworkTransactionReference networkTransactionReference): void | -| `sellerProtection` | [`?SellerProtection`](../../doc/models/seller-protection.md) | Optional | The level of protection offered as defined by [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection). | getSellerProtection(): ?SellerProtection | setSellerProtection(?SellerProtection sellerProtection): void | -| `finalCapture` | `?bool` | Optional | 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.
**Default**: `false` | getFinalCapture(): ?bool | setFinalCapture(?bool finalCapture): void | -| `sellerReceivableBreakdown` | [`?SellerReceivableBreakdown`](../../doc/models/seller-receivable-breakdown.md) | Optional | The detailed breakdown of the capture activity. This is not available for transactions that are in pending state. | getSellerReceivableBreakdown(): ?SellerReceivableBreakdown | setSellerReceivableBreakdown(?SellerReceivableBreakdown sellerReceivableBreakdown): void | -| `disbursementMode` | [`?string(DisbursementMode)`](../../doc/models/disbursement-mode.md) | Optional | The funds that are held on behalf of the merchant.
**Default**: `DisbursementMode::INSTANT`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `16`, *Pattern*: `^[A-Z_]+$` | getDisbursementMode(): ?string | setDisbursementMode(?string disbursementMode): 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 | -| `processorResponse` | [`?ProcessorResponse`](../../doc/models/processor-response.md) | Optional | The processor response information for payment requests, such as direct credit card transactions. | getProcessorResponse(): ?ProcessorResponse | setProcessorResponse(?ProcessorResponse processorResponse): 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.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getCreateTime(): ?string | setCreateTime(?string createTime): void | -| `updateTime` | `?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.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getUpdateTime(): ?string | setUpdateTime(?string updateTime): void | -| `supplementaryData` | [`?PaymentSupplementaryData`](../../doc/models/payment-supplementary-data.md) | Optional | The supplementary data. | getSupplementaryData(): ?PaymentSupplementaryData | setSupplementaryData(?PaymentSupplementaryData supplementaryData): void | -| `payee` | [`?Payee`](../../doc/models/payee.md) | Optional | The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee. | getPayee(): ?Payee | setPayee(?Payee payee): void | - -## Example (as JSON) - -```json -{ - "final_capture": false, - "disbursement_mode": "INSTANT", - "status": "PARTIALLY_REFUNDED", - "status_details": { - "reason": "VERIFICATION_REQUIRED" - }, - "id": "id4", - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "invoice_id": "invoice_id4" -} -``` - diff --git a/doc/models/card-attributes-response.md b/doc/models/card-attributes-response.md deleted file mode 100644 index 006b270..0000000 --- a/doc/models/card-attributes-response.md +++ /dev/null @@ -1,36 +0,0 @@ - -# Card Attributes Response - -Additional attributes associated with the use of this card. - -## Structure - -`CardAttributesResponse` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `vault` | [`?VaultResponse`](../../doc/models/vault-response.md) | Optional | The details about a saved payment source. | getVault(): ?VaultResponse | setVault(?VaultResponse vault): void | - -## Example (as JSON) - -```json -{ - "vault": { - "id": "id6", - "status": "APPROVED", - "customer": { - "id": "id0" - }, - "links": [ - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - } - ] - } -} -``` - diff --git a/doc/models/card-attributes.md b/doc/models/card-attributes.md deleted file mode 100644 index 2a480a7..0000000 --- a/doc/models/card-attributes.md +++ /dev/null @@ -1,40 +0,0 @@ - -# Card Attributes - -Additional attributes associated with the use of this card. - -## Structure - -`CardAttributes` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `customer` | [`?CustomerInformation`](../../doc/models/customer-information.md) | Optional | The details about a customer in PayPal's system of record. | getCustomer(): ?CustomerInformation | setCustomer(?CustomerInformation customer): void | -| `vault` | [`?VaultInstructionBase`](../../doc/models/vault-instruction-base.md) | Optional | Basic vault instruction specification that can be extended by specific payment sources that supports vaulting. | getVault(): ?VaultInstructionBase | setVault(?VaultInstructionBase vault): void | -| `verification` | [`?CardVerification`](../../doc/models/card-verification.md) | Optional | The API caller can opt in to verify the card through PayPal offered verification services (e.g. Smart Dollar Auth, 3DS). | getVerification(): ?CardVerification | setVerification(?CardVerification verification): void | - -## Example (as JSON) - -```json -{ - "customer": { - "id": "id0", - "email_address": "email_address2", - "phone": { - "phone_type": "OTHER", - "phone_number": { - "national_number": "national_number6" - } - } - }, - "vault": { - "store_in_vault": "ON_SUCCESS" - }, - "verification": { - "method": "3D_SECURE" - } -} -``` - diff --git a/doc/models/card-brand.md b/doc/models/card-brand.md deleted file mode 100644 index 44b72b6..0000000 --- a/doc/models/card-brand.md +++ /dev/null @@ -1,38 +0,0 @@ - -# Card Brand - -The card network or brand. Applies to credit, debit, gift, and payment cards. - -## Enumeration - -`CardBrand` - -## Fields - -| Name | -| --- | -| `VISA` | -| `MASTERCARD` | -| `DISCOVER` | -| `AMEX` | -| `SOLO` | -| `JCB` | -| `STAR` | -| `DELTA` | -| `SWITCH_` | -| `MAESTRO` | -| `CB_NATIONALE` | -| `CONFIGOGA` | -| `CONFIDIS` | -| `ELECTRON` | -| `CETELEM` | -| `CHINA_UNION_PAY` | -| `DINERS` | -| `ELO` | -| `HIPER` | -| `HIPERCARD` | -| `RUPAY` | -| `GE` | -| `SYNCHRONY` | -| `UNKNOWN` | - diff --git a/doc/models/card-experience-context.md b/doc/models/card-experience-context.md deleted file mode 100644 index fa2673c..0000000 --- a/doc/models/card-experience-context.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Card Experience Context - -Customizes the payer experience during the 3DS Approval for payment. - -## Structure - -`CardExperienceContext` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `returnUrl` | `?string` | Optional | Describes the URL. | getReturnUrl(): ?string | setReturnUrl(?string returnUrl): void | -| `cancelUrl` | `?string` | Optional | Describes the URL. | getCancelUrl(): ?string | setCancelUrl(?string cancelUrl): void | - -## Example (as JSON) - -```json -{ - "return_url": "return_url2", - "cancel_url": "cancel_url0" -} -``` - diff --git a/doc/models/card-from-request.md b/doc/models/card-from-request.md deleted file mode 100644 index c9846cb..0000000 --- a/doc/models/card-from-request.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Card From Request - -Representation of card details as received in the request. - -## Structure - -`CardFromRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `expiry` | `?string` | Optional | 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).
**Constraints**: *Minimum Length*: `7`, *Maximum Length*: `7`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])$` | getExpiry(): ?string | setExpiry(?string expiry): void | -| `lastDigits` | `?string` | Optional | The last digits of the payment card.
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `4`, *Pattern*: `[0-9]{2,}` | getLastDigits(): ?string | setLastDigits(?string lastDigits): void | - -## Example (as JSON) - -```json -{ - "expiry": "expiry6", - "last_digits": "last_digits2" -} -``` - diff --git a/doc/models/card-payment-token.md b/doc/models/card-payment-token.md deleted file mode 100644 index 991921b..0000000 --- a/doc/models/card-payment-token.md +++ /dev/null @@ -1,45 +0,0 @@ - -# Card Payment Token - -Full representation of a Card Payment Token including network token. - -## Structure - -`CardPaymentToken` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `?string` | Optional | The card holder's name as it appears on the card.
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `300`, *Pattern*: `^[A-Za-z ]+$` | getName(): ?string | setName(?string name): void | -| `lastDigits` | `?string` | Optional | The last digits of the payment card.
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `4`, *Pattern*: `[0-9]{2,}` | getLastDigits(): ?string | setLastDigits(?string lastDigits): void | -| `brand` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | The card network or brand. Applies to credit, debit, gift, and payment cards.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getBrand(): ?string | setBrand(?string brand): void | -| `expiry` | `?string` | Optional | 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).
**Constraints**: *Minimum Length*: `7`, *Maximum Length*: `7`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])$` | getExpiry(): ?string | setExpiry(?string expiry): void | -| `billingAddress` | [`?AddressDetails`](../../doc/models/address-details.md) | Optional | Address request details. | getBillingAddress(): ?AddressDetails | setBillingAddress(?AddressDetails billingAddress): void | -| `verificationStatus` | `?string` | Optional | Verification status of Card.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getVerificationStatus(): ?string | setVerificationStatus(?string verificationStatus): void | -| `verification` | [`?CardVerificationDetails`](../../doc/models/card-verification-details.md) | Optional | Card Verification details including the authorization details and 3D SECURE details. | getVerification(): ?CardVerificationDetails | setVerification(?CardVerificationDetails verification): void | -| `networkTransactionReference` | [`?NetworkTransactionReferenceEntity`](../../doc/models/network-transaction-reference-entity.md) | Optional | Previous network transaction reference including id in response. | getNetworkTransactionReference(): ?NetworkTransactionReferenceEntity | setNetworkTransactionReference(?NetworkTransactionReferenceEntity networkTransactionReference): void | -| `authenticationResult` | [`?AuthenticationResponse`](../../doc/models/authentication-response.md) | Optional | Results of Authentication such as 3D Secure. | getAuthenticationResult(): ?AuthenticationResponse | setAuthenticationResult(?AuthenticationResponse authenticationResult): void | -| `binDetails` | [`?BinDetails`](../../doc/models/bin-details.md) | Optional | Bank Identification Number (BIN) details used to fund a payment. | getBinDetails(): ?BinDetails | setBinDetails(?BinDetails binDetails): void | -| `type` | [`?string(CardType)`](../../doc/models/card-type.md) | Optional | Type of card. i.e Credit, Debit and so on.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getType(): ?string | setType(?string type): void | -| `networkToken` | `mixed` | Optional | - | getNetworkToken(): | setNetworkToken( networkToken): void | - -## Example (as JSON) - -```json -{ - "name": "name2", - "last_digits": "last_digits6", - "brand": "RUPAY", - "expiry": "expiry0", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } -} -``` - diff --git a/doc/models/card-request.md b/doc/models/card-request.md deleted file mode 100644 index efb8d02..0000000 --- a/doc/models/card-request.md +++ /dev/null @@ -1,43 +0,0 @@ - -# Card Request - -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 - -`CardRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `?string` | Optional | The card holder's name as it appears on the card.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `300`, *Pattern*: `^.{1,300}$` | getName(): ?string | setName(?string name): void | -| `number` | `?string` | Optional | The primary account number (PAN) for the payment card.
**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `19`, *Pattern*: `^[0-9]{13,19}$` | getNumber(): ?string | setNumber(?string number): void | -| `expiry` | `?string` | Optional | 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).
**Constraints**: *Minimum Length*: `7`, *Maximum Length*: `7`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])$` | getExpiry(): ?string | setExpiry(?string expiry): void | -| `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`.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `4`, *Pattern*: `^[0-9]{3,4}$` | getSecurityCode(): ?string | setSecurityCode(?string securityCode): void | -| `billingAddress` | [`?Address`](../../doc/models/address.md) | Optional | 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). | getBillingAddress(): ?Address | setBillingAddress(?Address billingAddress): void | -| `attributes` | [`?CardAttributes`](../../doc/models/card-attributes.md) | Optional | Additional attributes associated with the use of this card. | getAttributes(): ?CardAttributes | setAttributes(?CardAttributes attributes): void | -| `vaultId` | `?string` | Optional | The PayPal-generated ID for the vaulted payment source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9a-zA-Z_-]+$` | getVaultId(): ?string | setVaultId(?string vaultId): void | -| `storedCredential` | [`?CardStoredCredential`](../../doc/models/card-stored-credential.md) | Optional | 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:
| getStoredCredential(): ?CardStoredCredential | setStoredCredential(?CardStoredCredential storedCredential): void | -| `networkToken` | [`?NetworkToken`](../../doc/models/network-token.md) | Optional | The Third Party Network token used to fund a payment. | getNetworkToken(): ?NetworkToken | setNetworkToken(?NetworkToken networkToken): void | -| `experienceContext` | [`?CardExperienceContext`](../../doc/models/card-experience-context.md) | Optional | Customizes the payer experience during the 3DS Approval for payment. | getExperienceContext(): ?CardExperienceContext | setExperienceContext(?CardExperienceContext experienceContext): void | - -## Example (as JSON) - -```json -{ - "name": "name8", - "number": "number4", - "expiry": "expiry6", - "security_code": "security_code0", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } -} -``` - diff --git a/doc/models/card-response-entity.md b/doc/models/card-response-entity.md deleted file mode 100644 index 93b1157..0000000 --- a/doc/models/card-response-entity.md +++ /dev/null @@ -1,44 +0,0 @@ - -# Card Response Entity - -Full representation of a Card Payment Token. - -## Structure - -`CardResponseEntity` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `?string` | Optional | The card holder's name as it appears on the card.
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `300`, *Pattern*: `^[A-Za-z ]+$` | getName(): ?string | setName(?string name): void | -| `lastDigits` | `?string` | Optional | The last digits of the payment card.
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `4`, *Pattern*: `[0-9]{2,}` | getLastDigits(): ?string | setLastDigits(?string lastDigits): void | -| `brand` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | The card network or brand. Applies to credit, debit, gift, and payment cards.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getBrand(): ?string | setBrand(?string brand): void | -| `expiry` | `?string` | Optional | 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).
**Constraints**: *Minimum Length*: `7`, *Maximum Length*: `7`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])$` | getExpiry(): ?string | setExpiry(?string expiry): void | -| `billingAddress` | [`?AddressDetails`](../../doc/models/address-details.md) | Optional | Address request details. | getBillingAddress(): ?AddressDetails | setBillingAddress(?AddressDetails billingAddress): void | -| `verificationStatus` | `?string` | Optional | Verification status of Card.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getVerificationStatus(): ?string | setVerificationStatus(?string verificationStatus): void | -| `verification` | [`?CardVerificationDetails`](../../doc/models/card-verification-details.md) | Optional | Card Verification details including the authorization details and 3D SECURE details. | getVerification(): ?CardVerificationDetails | setVerification(?CardVerificationDetails verification): void | -| `networkTransactionReference` | [`?NetworkTransactionReferenceEntity`](../../doc/models/network-transaction-reference-entity.md) | Optional | Previous network transaction reference including id in response. | getNetworkTransactionReference(): ?NetworkTransactionReferenceEntity | setNetworkTransactionReference(?NetworkTransactionReferenceEntity networkTransactionReference): void | -| `authenticationResult` | [`?AuthenticationResponse`](../../doc/models/authentication-response.md) | Optional | Results of Authentication such as 3D Secure. | getAuthenticationResult(): ?AuthenticationResponse | setAuthenticationResult(?AuthenticationResponse authenticationResult): void | -| `binDetails` | [`?BinDetails`](../../doc/models/bin-details.md) | Optional | Bank Identification Number (BIN) details used to fund a payment. | getBinDetails(): ?BinDetails | setBinDetails(?BinDetails binDetails): void | -| `type` | [`?string(CardType)`](../../doc/models/card-type.md) | Optional | Type of card. i.e Credit, Debit and so on.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getType(): ?string | setType(?string type): void | - -## Example (as JSON) - -```json -{ - "name": "name4", - "last_digits": "last_digits8", - "brand": "STAR", - "expiry": "expiry2", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } -} -``` - diff --git a/doc/models/card-response.md b/doc/models/card-response.md deleted file mode 100644 index 68ea414..0000000 --- a/doc/models/card-response.md +++ /dev/null @@ -1,40 +0,0 @@ - -# Card Response - -The payment card to use to fund a payment. Card can be a credit or debit card. - -## Structure - -`CardResponse` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `?string` | Optional | The card holder's name as it appears on the card.
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `300` | getName(): ?string | setName(?string name): void | -| `lastDigits` | `?string` | Optional | The last digits of the payment card.
**Constraints**: *Pattern*: `[0-9]{2,}` | getLastDigits(): ?string | setLastDigits(?string lastDigits): void | -| `brand` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | The card network or brand. Applies to credit, debit, gift, and payment cards.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getBrand(): ?string | setBrand(?string brand): void | -| `availableNetworks` | [`?(string(CardBrand)[])`](../../doc/models/card-brand.md) | Optional | Array of brands or networks associated with the card.
**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `256`, *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getAvailableNetworks(): ?array | setAvailableNetworks(?array availableNetworks): void | -| `type` | [`?string(CardType)`](../../doc/models/card-type.md) | Optional | Type of card. i.e Credit, Debit and so on.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getType(): ?string | setType(?string type): void | -| `authenticationResult` | [`?AuthenticationResponse`](../../doc/models/authentication-response.md) | Optional | Results of Authentication such as 3D Secure. | getAuthenticationResult(): ?AuthenticationResponse | setAuthenticationResult(?AuthenticationResponse authenticationResult): void | -| `attributes` | [`?CardAttributesResponse`](../../doc/models/card-attributes-response.md) | Optional | Additional attributes associated with the use of this card. | getAttributes(): ?CardAttributesResponse | setAttributes(?CardAttributesResponse attributes): void | -| `fromRequest` | [`?CardFromRequest`](../../doc/models/card-from-request.md) | Optional | Representation of card details as received in the request. | getFromRequest(): ?CardFromRequest | setFromRequest(?CardFromRequest fromRequest): void | -| `expiry` | `?string` | Optional | 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).
**Constraints**: *Minimum Length*: `7`, *Maximum Length*: `7`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])$` | getExpiry(): ?string | setExpiry(?string expiry): void | -| `binDetails` | [`?BinDetails`](../../doc/models/bin-details.md) | Optional | Bank Identification Number (BIN) details used to fund a payment. | getBinDetails(): ?BinDetails | setBinDetails(?BinDetails binDetails): void | - -## Example (as JSON) - -```json -{ - "name": "name0", - "last_digits": "last_digits4", - "brand": "CONFIDIS", - "available_networks": [ - "ELO", - "DINERS", - "CHINA_UNION_PAY" - ], - "type": "CREDIT" -} -``` - diff --git a/doc/models/card-stored-credential.md b/doc/models/card-stored-credential.md deleted file mode 100644 index d971143..0000000 --- a/doc/models/card-stored-credential.md +++ /dev/null @@ -1,34 +0,0 @@ - -# Card 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:
- -## Structure - -`CardStoredCredential` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `paymentInitiator` | [`string(PaymentInitiator)`](../../doc/models/payment-initiator.md) | Required | The person or party who initiated or triggered the payment.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getPaymentInitiator(): string | setPaymentInitiator(string paymentInitiator): void | -| `paymentType` | [`string(StoredPaymentSourcePaymentType)`](../../doc/models/stored-payment-source-payment-type.md) | Required | Indicates the type of the stored payment_source payment.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getPaymentType(): string | setPaymentType(string paymentType): void | -| `usage` | [`?string(StoredPaymentSourceUsageType)`](../../doc/models/stored-payment-source-usage-type.md) | Optional | Indicates if this is a `first` or `subsequent` payment using a stored payment source (also referred to as stored credential or card on file).
**Default**: `StoredPaymentSourceUsageType::DERIVED`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getUsage(): ?string | setUsage(?string usage): void | -| `previousNetworkTransactionReference` | [`?NetworkTransactionReference`](../../doc/models/network-transaction-reference.md) | Optional | Reference values used by the card network to identify a transaction. | getPreviousNetworkTransactionReference(): ?NetworkTransactionReference | setPreviousNetworkTransactionReference(?NetworkTransactionReference previousNetworkTransactionReference): void | - -## Example (as JSON) - -```json -{ - "payment_initiator": "CUSTOMER", - "payment_type": "ONE_TIME", - "usage": "DERIVED", - "previous_network_transaction_reference": { - "id": "id6", - "date": "date2", - "network": "VISA", - "acquirer_reference_number": "acquirer_reference_number8" - } -} -``` - diff --git a/doc/models/card-supplementary-data.md b/doc/models/card-supplementary-data.md deleted file mode 100644 index d222310..0000000 --- a/doc/models/card-supplementary-data.md +++ /dev/null @@ -1,53 +0,0 @@ - -# Card Supplementary Data - -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. - -## Structure - -`CardSupplementaryData` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `level2` | [`?Level2CardProcessingData`](../../doc/models/level-2-card-processing-data.md) | Optional | The level 2 card processing data collections. If your merchant account has been configured for Level 2 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 2 data for your business. | getLevel2(): ?Level2CardProcessingData | setLevel2(?Level2CardProcessingData level2): void | -| `level3` | [`?Level3CardProcessingData`](../../doc/models/level-3-card-processing-data.md) | Optional | The level 3 card processing data collections, If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 3 data for your business. | getLevel3(): ?Level3CardProcessingData | setLevel3(?Level3CardProcessingData level3): void | - -## Example (as JSON) - -```json -{ - "level_2": { - "invoice_id": "invoice_id4", - "tax_total": { - "currency_code": "currency_code4", - "value": "value0" - } - }, - "level_3": { - "shipping_amount": { - "currency_code": "currency_code0", - "value": "value6" - }, - "duty_amount": { - "currency_code": "currency_code6", - "value": "value2" - }, - "discount_amount": { - "currency_code": "currency_code2", - "value": "value8" - }, - "shipping_address": { - "address_line_1": "address_line_10", - "address_line_2": "address_line_20", - "admin_area_2": "admin_area_24", - "admin_area_1": "admin_area_16", - "postal_code": "postal_code2", - "country_code": "country_code0" - }, - "ships_from_postal_code": "ships_from_postal_code4" - } -} -``` - diff --git a/doc/models/card-type.md b/doc/models/card-type.md deleted file mode 100644 index acb2601..0000000 --- a/doc/models/card-type.md +++ /dev/null @@ -1,19 +0,0 @@ - -# Card Type - -Type of card. i.e Credit, Debit and so on. - -## Enumeration - -`CardType` - -## Fields - -| Name | -| --- | -| `CREDIT` | -| `DEBIT` | -| `PREPAID` | -| `STORE` | -| `UNKNOWN` | - diff --git a/doc/models/card-verification-details.md b/doc/models/card-verification-details.md deleted file mode 100644 index a1a0759..0000000 --- a/doc/models/card-verification-details.md +++ /dev/null @@ -1,35 +0,0 @@ - -# Card Verification Details - -Card Verification details including the authorization details and 3D SECURE details. - -## Structure - -`CardVerificationDetails` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `networkTransactionId` | `?string` | Optional | Transaction Identifier as given by the network to indicate a previously executed CIT authorization. Only present when authorization is successful for a verification.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `1024`, *Pattern*: `^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$` | getNetworkTransactionId(): ?string | setNetworkTransactionId(?string networkTransactionId): void | -| `date` | `?string` | Optional | The date that the transaction was authorized by the scheme. This field may not be returned for all networks. MasterCard refers to this field as "BankNet reference date".
**Constraints**: *Minimum Length*: `4`, *Maximum Length*: `4`, *Pattern*: `^[0-9]+$` | getDate(): ?string | setDate(?string date): void | -| `network` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | The card network or brand. Applies to credit, debit, gift, and payment cards.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getNetwork(): ?string | setNetwork(?string network): void | -| `time` | `?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.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getTime(): ?string | setTime(?string time): void | -| `amount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): ?Money | setAmount(?Money amount): void | -| `processorResponse` | [`?CardVerificationProcessorResponse`](../../doc/models/card-verification-processor-response.md) | Optional | The processor response information for payment requests, such as direct credit card transactions. | getProcessorResponse(): ?CardVerificationProcessorResponse | setProcessorResponse(?CardVerificationProcessorResponse processorResponse): void | - -## Example (as JSON) - -```json -{ - "network_transaction_id": "network_transaction_id4", - "date": "date8", - "network": "SOLO", - "time": "time2", - "amount": { - "currency_code": "currency_code6", - "value": "value0" - } -} -``` - diff --git a/doc/models/card-verification-method.md b/doc/models/card-verification-method.md deleted file mode 100644 index 2cc747c..0000000 --- a/doc/models/card-verification-method.md +++ /dev/null @@ -1,18 +0,0 @@ - -# Card Verification Method - -The method used for card verification. - -## Enumeration - -`CardVerificationMethod` - -## Fields - -| Name | -| --- | -| `SCA_ALWAYS` | -| `SCA_WHEN_REQUIRED` | -| `ENUM_3D_SECURE` | -| `AVS_CVV` | - diff --git a/doc/models/card-verification-processor-response.md b/doc/models/card-verification-processor-response.md deleted file mode 100644 index 2cde41c..0000000 --- a/doc/models/card-verification-processor-response.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Card Verification Processor Response - -The processor response information for payment requests, such as direct credit card transactions. - -## Structure - -`CardVerificationProcessorResponse` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `avsCode` | [`?string(AVSCode)`](../../doc/models/avs-code.md) | Optional | The address verification code for Visa, Discover, Mastercard, or American Express transactions. | getAvsCode(): ?string | setAvsCode(?string avsCode): void | -| `cvvCode` | [`?string(CVVCode)`](../../doc/models/cvv-code.md) | Optional | The card verification value code for for Visa, Discover, Mastercard, or American Express. | getCvvCode(): ?string | setCvvCode(?string cvvCode): void | - -## Example (as JSON) - -```json -{ - "avs_code": "E", - "cvv_code": "All others" -} -``` - diff --git a/doc/models/card-verification.md b/doc/models/card-verification.md deleted file mode 100644 index 89e206f..0000000 --- a/doc/models/card-verification.md +++ /dev/null @@ -1,23 +0,0 @@ - -# Card Verification - -The API caller can opt in to verify the card through PayPal offered verification services (e.g. Smart Dollar Auth, 3DS). - -## Structure - -`CardVerification` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `method` | [`?string(CardVerificationMethod)`](../../doc/models/card-verification-method.md) | Optional | The method used for card verification.
**Default**: `CardVerificationMethod::SCA_WHEN_REQUIRED`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getMethod(): ?string | setMethod(?string method): void | - -## Example (as JSON) - -```json -{ - "method": "SCA_WHEN_REQUIRED" -} -``` - diff --git a/doc/models/checkout-payment-intent.md b/doc/models/checkout-payment-intent.md deleted file mode 100644 index e499f52..0000000 --- a/doc/models/checkout-payment-intent.md +++ /dev/null @@ -1,16 +0,0 @@ - -# Checkout Payment Intent - -The intent to either capture payment immediately or authorize a payment for an order after order creation. - -## Enumeration - -`CheckoutPaymentIntent` - -## Fields - -| Name | -| --- | -| `CAPTURE` | -| `AUTHORIZE` | - diff --git a/doc/models/cobranded-card.md b/doc/models/cobranded-card.md deleted file mode 100644 index 9ac3efd..0000000 --- a/doc/models/cobranded-card.md +++ /dev/null @@ -1,36 +0,0 @@ - -# Cobranded Card - -Details about the merchant cobranded card used for order purchase. - -## Structure - -`CobrandedCard` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `labels` | `?(string[])` | Optional | Array of labels for the cobranded card.
**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `25`, *Minimum Length*: `1`, *Maximum Length*: `256` | getLabels(): ?array | setLabels(?array labels): void | -| `payee` | [`?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. | getPayee(): ?PayeeBase | setPayee(?PayeeBase payee): void | -| `amount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): ?Money | setAmount(?Money amount): void | - -## Example (as JSON) - -```json -{ - "labels": [ - "labels2", - "labels3" - ], - "payee": { - "email_address": "email_address4", - "merchant_id": "merchant_id6" - }, - "amount": { - "currency_code": "currency_code6", - "value": "value0" - } -} -``` - diff --git a/doc/models/confirm-order-request.md b/doc/models/confirm-order-request.md deleted file mode 100644 index 69f5308..0000000 --- a/doc/models/confirm-order-request.md +++ /dev/null @@ -1,109 +0,0 @@ - -# Confirm Order Request - -Payer confirms the intent to pay for the Order using the provided payment source. - -## Structure - -`ConfirmOrderRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `paymentSource` | [`PaymentSource`](../../doc/models/payment-source.md) | Required | The payment source definition. | getPaymentSource(): PaymentSource | setPaymentSource(PaymentSource paymentSource): void | -| `processingInstruction` | [`?string(ProcessingInstruction)`](../../doc/models/processing-instruction.md) | Optional | The instruction to process an order.
**Default**: `ProcessingInstruction::NO_INSTRUCTION`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[0-9A-Z_]+$` | getProcessingInstruction(): ?string | setProcessingInstruction(?string processingInstruction): void | -| `applicationContext` | [`?OrderConfirmApplicationContext`](../../doc/models/order-confirm-application-context.md) | Optional | Customizes the payer confirmation experience. | getApplicationContext(): ?OrderConfirmApplicationContext | setApplicationContext(?OrderConfirmApplicationContext applicationContext): void | - -## Example (as JSON) - -```json -{ - "payment_source": { - "card": { - "name": "name6", - "number": "number6", - "expiry": "expiry4", - "security_code": "security_code8", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } - }, - "token": { - "id": "id6", - "type": "BILLING_AGREEMENT" - }, - "paypal": { - "vault_id": "vault_id0", - "email_address": "email_address0", - "name": { - "given_name": "given_name2", - "surname": "surname8" - }, - "phone": { - "phone_type": "OTHER", - "phone_number": { - "national_number": "national_number6" - } - }, - "birth_date": "birth_date8" - }, - "bancontact": { - "name": "name0", - "country_code": "country_code0", - "experience_context": { - "brand_name": "brand_name2", - "locale": "locale6", - "shipping_preference": "NO_SHIPPING", - "return_url": "return_url4", - "cancel_url": "cancel_url6" - } - }, - "blik": { - "name": "name2", - "country_code": "country_code2", - "email": "email4", - "experience_context": { - "brand_name": "brand_name2", - "locale": "locale6", - "shipping_preference": "NO_SHIPPING", - "return_url": "return_url4", - "cancel_url": "cancel_url6" - }, - "level_0": { - "auth_code": "auth_code8" - }, - "one_click": { - "auth_code": "auth_code0", - "consumer_reference": "consumer_reference2", - "alias_label": "alias_label6", - "alias_key": "alias_key4" - } - } - }, - "processing_instruction": "NO_INSTRUCTION", - "application_context": { - "brand_name": "brand_name8", - "locale": "locale2", - "return_url": "return_url0", - "cancel_url": "cancel_url2", - "stored_payment_source": { - "payment_initiator": "CUSTOMER", - "payment_type": "RECURRING", - "usage": "FIRST", - "previous_network_transaction_reference": { - "id": "id6", - "date": "date2", - "network": "VISA", - "acquirer_reference_number": "acquirer_reference_number8" - } - } - } -} -``` - diff --git a/doc/models/customer-information.md b/doc/models/customer-information.md deleted file mode 100644 index 5cf92e8..0000000 --- a/doc/models/customer-information.md +++ /dev/null @@ -1,32 +0,0 @@ - -# Customer Information - -The details about a customer in PayPal's system of record. - -## Structure - -`CustomerInformation` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `id` | `?string` | Optional | The unique ID for a customer generated by PayPal.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `22`, *Pattern*: `^[0-9a-zA-Z_-]+$` | getId(): ?string | setId(?string id): 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.

**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: `(?:[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\|\[(?:(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9])\|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void | -| `phone` | [`?PhoneWithType`](../../doc/models/phone-with-type.md) | Optional | The phone information. | getPhone(): ?PhoneWithType | setPhone(?PhoneWithType phone): void | - -## Example (as JSON) - -```json -{ - "id": "id6", - "email_address": "email_address4", - "phone": { - "phone_type": "OTHER", - "phone_number": { - "national_number": "national_number6" - } - } -} -``` - diff --git a/doc/models/customer-request.md b/doc/models/customer-request.md deleted file mode 100644 index 09387af..0000000 --- a/doc/models/customer-request.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Customer Request - -Customer in merchant's or partner's system of records. - -## Structure - -`CustomerRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `id` | `?string` | Optional | The unique ID for a customer generated by PayPal.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `22`, *Pattern*: `^[0-9a-zA-Z_-]+$` | getId(): ?string | setId(?string id): void | -| `merchantCustomerId` | `?string` | Optional | 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.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64`, *Pattern*: `^[0-9a-zA-Z-_.^*$@#]+$` | getMerchantCustomerId(): ?string | setMerchantCustomerId(?string merchantCustomerId): void | - -## Example (as JSON) - -```json -{ - "id": "id8", - "merchant_customer_id": "merchant_customer_id0" -} -``` - diff --git a/doc/models/customer-vault-payment-tokens-response.md b/doc/models/customer-vault-payment-tokens-response.md deleted file mode 100644 index 6bd88e2..0000000 --- a/doc/models/customer-vault-payment-tokens-response.md +++ /dev/null @@ -1,274 +0,0 @@ - -# Customer Vault Payment Tokens Response - -Collection of payment tokens saved for a given customer. - -## Structure - -`CustomerVaultPaymentTokensResponse` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `totalItems` | `?int` | Optional | Total number of items.
**Constraints**: `>= 1`, `<= 50` | getTotalItems(): ?int | setTotalItems(?int totalItems): void | -| `totalPages` | `?int` | Optional | Total number of pages.
**Constraints**: `>= 1`, `<= 10` | getTotalPages(): ?int | setTotalPages(?int totalPages): void | -| `customer` | [`?CustomerRequest`](../../doc/models/customer-request.md) | Optional | Customer in merchant's or partner's system of records. | getCustomer(): ?CustomerRequest | setCustomer(?CustomerRequest customer): void | -| `paymentTokens` | [`?(PaymentTokenResponse[])`](../../doc/models/payment-token-response.md) | Optional | **Constraints**: *Minimum Items*: `0`, *Maximum Items*: `64` | getPaymentTokens(): ?array | setPaymentTokens(?array paymentTokens): void | -| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of related [HATEOAS links](/api/rest/responses/#hateoas).
**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `32` | getLinks(): ?array | setLinks(?array links): void | - -## Example (as JSON) - -```json -{ - "total_items": 132, - "total_pages": 168, - "customer": { - "id": "id0", - "merchant_customer_id": "merchant_customer_id2" - }, - "payment_tokens": [ - { - "id": "id4", - "customer": { - "id": "id0", - "merchant_customer_id": "merchant_customer_id2" - }, - "payment_source": { - "card": { - "name": "name6", - "last_digits": "last_digits0", - "brand": "SYNCHRONY", - "expiry": "expiry4", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } - }, - "paypal": { - "description": "description2", - "shipping": { - "name": { - "full_name": "full_name6" - }, - "type": "SHIPPING", - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - } - }, - "permit_multiple_payment_tokens": false, - "usage_type": "usage_type2", - "customer_type": "customer_type6" - }, - "venmo": { - "description": "description6", - "shipping": { - "name": { - "full_name": "full_name6" - }, - "type": "SHIPPING", - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - } - }, - "permit_multiple_payment_tokens": false, - "usage_type": "usage_type6", - "customer_type": "customer_type0" - }, - "apple_pay": { - "card": { - "name": "name6", - "last_digits": "last_digits0", - "type": "UNKNOWN", - "brand": "SYNCHRONY", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } - } - }, - "bank": { - "ach_debit": { - "verification_status": "verification_status6" - }, - "sepa_debit": { - "iban_last_chars": "iban_last_chars8", - "account_holder_name": { - "key1": "val1", - "key2": "val2" - }, - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - }, - "authorization_details": { - "status": "NOT_SUPPORTED" - } - } - } - }, - "links": [ - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - }, - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - } - ] - }, - { - "id": "id4", - "customer": { - "id": "id0", - "merchant_customer_id": "merchant_customer_id2" - }, - "payment_source": { - "card": { - "name": "name6", - "last_digits": "last_digits0", - "brand": "SYNCHRONY", - "expiry": "expiry4", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } - }, - "paypal": { - "description": "description2", - "shipping": { - "name": { - "full_name": "full_name6" - }, - "type": "SHIPPING", - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - } - }, - "permit_multiple_payment_tokens": false, - "usage_type": "usage_type2", - "customer_type": "customer_type6" - }, - "venmo": { - "description": "description6", - "shipping": { - "name": { - "full_name": "full_name6" - }, - "type": "SHIPPING", - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - } - }, - "permit_multiple_payment_tokens": false, - "usage_type": "usage_type6", - "customer_type": "customer_type0" - }, - "apple_pay": { - "card": { - "name": "name6", - "last_digits": "last_digits0", - "type": "UNKNOWN", - "brand": "SYNCHRONY", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } - } - }, - "bank": { - "ach_debit": { - "verification_status": "verification_status6" - }, - "sepa_debit": { - "iban_last_chars": "iban_last_chars8", - "account_holder_name": { - "key1": "val1", - "key2": "val2" - }, - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - }, - "authorization_details": { - "status": "NOT_SUPPORTED" - } - } - } - }, - "links": [ - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - }, - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - } - ] - } - ], - "links": [ - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - }, - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - } - ] -} -``` - diff --git a/doc/models/cvv-code.md b/doc/models/cvv-code.md deleted file mode 100644 index 48872cd..0000000 --- a/doc/models/cvv-code.md +++ /dev/null @@ -1,28 +0,0 @@ - -# CVV Code - -The card verification value code for for Visa, Discover, Mastercard, or American Express. - -## Enumeration - -`CVVCode` - -## Fields - -| Name | -| --- | -| `E` | -| `I` | -| `M` | -| `N` | -| `P` | -| `S` | -| `U` | -| `X` | -| `ENUM_ALL_OTHERS` | -| `ENUM_0` | -| `ENUM_1` | -| `ENUM_2` | -| `ENUM_3` | -| `ENUM_4` | - diff --git a/doc/models/disbursement-mode.md b/doc/models/disbursement-mode.md deleted file mode 100644 index ce3a783..0000000 --- a/doc/models/disbursement-mode.md +++ /dev/null @@ -1,16 +0,0 @@ - -# Disbursement Mode - -The funds that are held on behalf of the merchant. - -## Enumeration - -`DisbursementMode` - -## Fields - -| Name | -| --- | -| `INSTANT` | -| `DELAYED` | - diff --git a/doc/models/dispute-category.md b/doc/models/dispute-category.md deleted file mode 100644 index 248d986..0000000 --- a/doc/models/dispute-category.md +++ /dev/null @@ -1,16 +0,0 @@ - -# Dispute Category - -The condition that is covered for the transaction. - -## Enumeration - -`DisputeCategory` - -## Fields - -| Name | -| --- | -| `ITEM_NOT_RECEIVED` | -| `UNAUTHORIZED_TRANSACTION` | - diff --git a/doc/models/eci-flag.md b/doc/models/eci-flag.md deleted file mode 100644 index f89dc2b..0000000 --- a/doc/models/eci-flag.md +++ /dev/null @@ -1,20 +0,0 @@ - -# ECI Flag - -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 the Gateway/Processor. - -## Enumeration - -`ECIFlag` - -## Fields - -| Name | -| --- | -| `MASTERCARD_NON_3D_SECURE_TRANSACTION` | -| `MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION` | -| `MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION` | -| `FULLY_AUTHENTICATED_TRANSACTION` | -| `ATTEMPTED_AUTHENTICATION_TRANSACTION` | -| `NON_3D_SECURE_TRANSACTION` | - diff --git a/doc/models/enrollment-status.md b/doc/models/enrollment-status.md deleted file mode 100644 index f256314..0000000 --- a/doc/models/enrollment-status.md +++ /dev/null @@ -1,18 +0,0 @@ - -# Enrollment Status - -Status of Authentication eligibility. - -## Enumeration - -`EnrollmentStatus` - -## Fields - -| Name | -| --- | -| `Y` | -| `N` | -| `U` | -| `B` | - diff --git a/doc/models/eps-payment-object.md b/doc/models/eps-payment-object.md deleted file mode 100644 index 91921a2..0000000 --- a/doc/models/eps-payment-object.md +++ /dev/null @@ -1,27 +0,0 @@ - -# EPS Payment Object - -Information used to pay using eps. - -## Structure - -`EPSPaymentObject` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `?string` | Optional | The full name representation like Mr J Smith.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): ?string | setName(?string name): void | -| `countryCode` | `?string` | Optional | 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 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.

**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): ?string | setCountryCode(?string countryCode): void | -| `bic` | `?string` | Optional | The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.
**Constraints**: *Minimum Length*: `8`, *Maximum Length*: `11`, *Pattern*: `^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$` | getBic(): ?string | setBic(?string bic): void | - -## Example (as JSON) - -```json -{ - "name": "name6", - "country_code": "country_code6", - "bic": "bic8" -} -``` - diff --git a/doc/models/eps-payment-request.md b/doc/models/eps-payment-request.md deleted file mode 100644 index 5f1285d..0000000 --- a/doc/models/eps-payment-request.md +++ /dev/null @@ -1,33 +0,0 @@ - -# EPS Payment Request - -Information needed to pay using eps. - -## Structure - -`EPSPaymentRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `string` | Required | The full name representation like Mr J Smith.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): string | setName(string name): void | -| `countryCode` | `string` | Required | 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 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.

**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): string | setCountryCode(string countryCode): void | -| `experienceContext` | [`?ExperienceContext`](../../doc/models/experience-context.md) | Optional | Customizes the payer experience during the approval process for the payment. | getExperienceContext(): ?ExperienceContext | setExperienceContext(?ExperienceContext experienceContext): void | - -## Example (as JSON) - -```json -{ - "name": "name8", - "country_code": "country_code2", - "experience_context": { - "brand_name": "brand_name2", - "locale": "locale6", - "shipping_preference": "NO_SHIPPING", - "return_url": "return_url4", - "cancel_url": "cancel_url6" - } -} -``` - diff --git a/doc/models/error-details.md b/doc/models/error-details.md deleted file mode 100644 index a5ceaea..0000000 --- a/doc/models/error-details.md +++ /dev/null @@ -1,44 +0,0 @@ - -# Error Details - -The error details. Required for client-side `4XX` errors. - -## Structure - -`ErrorDetails` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `field` | `?string` | Optional | 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. | getField(): ?string | setField(?string field): void | -| `value` | `?string` | Optional | The value of the field that caused the error. | getValue(): ?string | setValue(?string value): void | -| `location` | `?string` | Optional | The location of the field that caused the error. Value is `body`, `path`, or `query`.
**Default**: `'body'` | getLocation(): ?string | setLocation(?string location): void | -| `issue` | `string` | Required | The unique, fine-grained application-level error code. | getIssue(): string | setIssue(string issue): void | -| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links) that are either relevant to the issue by providing additional information or offering potential resolutions.
**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `4` | getLinks(): ?array | setLinks(?array links): void | -| `description` | `?string` | Optional | The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value. | getDescription(): ?string | setDescription(?string description): void | - -## Example (as JSON) - -```json -{ - "location": "body", - "issue": "issue8", - "field": "field0", - "value": "value8", - "links": [ - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - }, - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - } - ], - "description": "description4" -} -``` - diff --git a/doc/models/error-exception.md b/doc/models/error-exception.md deleted file mode 100644 index 888c418..0000000 --- a/doc/models/error-exception.md +++ /dev/null @@ -1,81 +0,0 @@ - -# Error Exception - -The error details. - -## Structure - -`ErrorException` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `string` | Required | The human-readable, unique name of the error. | getName(): string | setName(string name): void | -| `message` | `string` | Required | The message that describes the error. | getMessage(): string | setMessage(string message): void | -| `debugId` | `string` | Required | The PayPal internal ID. Used for correlation purposes. | getDebugId(): string | setDebugId(string debugId): void | -| `details` | [`?(ErrorDetails[])`](../../doc/models/error-details.md) | Optional | An array of additional details about the error. | getDetails(): ?array | setDetails(?array details): void | -| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links). | getLinks(): ?array | setLinks(?array links): void | - -## Example (as JSON) - -```json -{ - "name": "name4", - "message": "message4", - "debug_id": "debug_id0", - "details": [ - { - "field": "field4", - "value": "value2", - "location": "location4", - "issue": "issue6", - "links": [ - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - }, - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - } - ], - "description": "description0" - }, - { - "field": "field4", - "value": "value2", - "location": "location4", - "issue": "issue6", - "links": [ - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - }, - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - } - ], - "description": "description0" - } - ], - "links": [ - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - }, - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - } - ] -} -``` - diff --git a/doc/models/exchange-rate.md b/doc/models/exchange-rate.md deleted file mode 100644 index e0e95ce..0000000 --- a/doc/models/exchange-rate.md +++ /dev/null @@ -1,27 +0,0 @@ - -# Exchange Rate - -The exchange rate that determines the amount to convert from one currency to another currency. - -## Structure - -`ExchangeRate` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `sourceCurrency` | `?string` | Optional | The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `3` | getSourceCurrency(): ?string | setSourceCurrency(?string sourceCurrency): void | -| `targetCurrency` | `?string` | Optional | The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `3` | getTargetCurrency(): ?string | setTargetCurrency(?string targetCurrency): void | -| `value` | `?string` | Optional | The target currency amount. Equivalent to one unit of the source currency. Formatted as integer or decimal value with one to 15 digits to the right of the decimal point. | getValue(): ?string | setValue(?string value): void | - -## Example (as JSON) - -```json -{ - "source_currency": "source_currency0", - "target_currency": "target_currency2", - "value": "value2" -} -``` - diff --git a/doc/models/experience-context.md b/doc/models/experience-context.md deleted file mode 100644 index 8db27e3..0000000 --- a/doc/models/experience-context.md +++ /dev/null @@ -1,31 +0,0 @@ - -# Experience Context - -Customizes the payer experience during the approval process for the payment. - -## Structure - -`ExperienceContext` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `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.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127`, *Pattern*: `^.*$` | getBrandName(): ?string | setBrandName(?string brandName): void | -| `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/).
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `10`, *Pattern*: `^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}\|[0-9]{3}))?$` | getLocale(): ?string | setLocale(?string locale): void | -| `shippingPreference` | [`?string(ShippingPreference)`](../../doc/models/shipping-preference.md) | Optional | The location from which the shipping address is derived.
**Default**: `ShippingPreference::GET_FROM_FILE`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `24`, *Pattern*: `^[A-Z_]+$` | getShippingPreference(): ?string | setShippingPreference(?string shippingPreference): void | -| `returnUrl` | `?string` | Optional | Describes the URL. | getReturnUrl(): ?string | setReturnUrl(?string returnUrl): void | -| `cancelUrl` | `?string` | Optional | Describes the URL. | getCancelUrl(): ?string | setCancelUrl(?string cancelUrl): void | - -## Example (as JSON) - -```json -{ - "shipping_preference": "GET_FROM_FILE", - "brand_name": "brand_name0", - "locale": "locale4", - "return_url": "return_url2", - "cancel_url": "cancel_url4" -} -``` - diff --git a/doc/models/fullfillment-type.md b/doc/models/fullfillment-type.md deleted file mode 100644 index 3c9598b..0000000 --- a/doc/models/fullfillment-type.md +++ /dev/null @@ -1,18 +0,0 @@ - -# Fullfillment Type - -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. - -## Enumeration - -`FullfillmentType` - -## Fields - -| Name | -| --- | -| `SHIPPING` | -| `PICKUP_IN_PERSON` | -| `PICKUP_IN_STORE` | -| `PICKUP_FROM_PERSON` | - diff --git a/doc/models/giropay-payment-object.md b/doc/models/giropay-payment-object.md deleted file mode 100644 index dbf7a2c..0000000 --- a/doc/models/giropay-payment-object.md +++ /dev/null @@ -1,27 +0,0 @@ - -# Giropay Payment Object - -Information needed to pay using giropay. - -## Structure - -`GiropayPaymentObject` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `?string` | Optional | The full name representation like Mr J Smith.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): ?string | setName(?string name): void | -| `countryCode` | `?string` | Optional | 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 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.

**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): ?string | setCountryCode(?string countryCode): void | -| `bic` | `?string` | Optional | The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.
**Constraints**: *Minimum Length*: `8`, *Maximum Length*: `11`, *Pattern*: `^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$` | getBic(): ?string | setBic(?string bic): void | - -## Example (as JSON) - -```json -{ - "name": "name6", - "country_code": "country_code6", - "bic": "bic8" -} -``` - diff --git a/doc/models/giropay-payment-request.md b/doc/models/giropay-payment-request.md deleted file mode 100644 index c0fd1e3..0000000 --- a/doc/models/giropay-payment-request.md +++ /dev/null @@ -1,33 +0,0 @@ - -# Giropay Payment Request - -Information needed to pay using giropay. - -## Structure - -`GiropayPaymentRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `string` | Required | The full name representation like Mr J Smith.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): string | setName(string name): void | -| `countryCode` | `string` | Required | 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 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.

**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): string | setCountryCode(string countryCode): void | -| `experienceContext` | [`?ExperienceContext`](../../doc/models/experience-context.md) | Optional | Customizes the payer experience during the approval process for the payment. | getExperienceContext(): ?ExperienceContext | setExperienceContext(?ExperienceContext experienceContext): void | - -## Example (as JSON) - -```json -{ - "name": "name8", - "country_code": "country_code8", - "experience_context": { - "brand_name": "brand_name2", - "locale": "locale6", - "shipping_preference": "NO_SHIPPING", - "return_url": "return_url4", - "cancel_url": "cancel_url6" - } -} -``` - diff --git a/doc/models/google-pay-authentication-method.md b/doc/models/google-pay-authentication-method.md deleted file mode 100644 index b86c36e..0000000 --- a/doc/models/google-pay-authentication-method.md +++ /dev/null @@ -1,16 +0,0 @@ - -# Google Pay Authentication Method - -Authentication Method which is used for the card transaction. - -## Enumeration - -`GooglePayAuthenticationMethod` - -## Fields - -| Name | -| --- | -| `PAN_ONLY` | -| `CRYPTOGRAM_3DS` | - diff --git a/doc/models/google-pay-card-attributes.md b/doc/models/google-pay-card-attributes.md deleted file mode 100644 index ef9765b..0000000 --- a/doc/models/google-pay-card-attributes.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Google Pay Card Attributes - -Additional attributes associated with the use of this card. - -## Structure - -`GooglePayCardAttributes` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `verification` | [`?CardVerification`](../../doc/models/card-verification.md) | Optional | The API caller can opt in to verify the card through PayPal offered verification services (e.g. Smart Dollar Auth, 3DS). | getVerification(): ?CardVerification | setVerification(?CardVerification verification): void | - -## Example (as JSON) - -```json -{ - "verification": { - "method": "3D_SECURE" - } -} -``` - diff --git a/doc/models/google-pay-card-response.md b/doc/models/google-pay-card-response.md deleted file mode 100644 index 3d67861..0000000 --- a/doc/models/google-pay-card-response.md +++ /dev/null @@ -1,39 +0,0 @@ - -# Google Pay Card Response - -The payment card to use to fund a Google Pay payment response. Can be a credit or debit card. - -## Structure - -`GooglePayCardResponse` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `?string` | Optional | The card holder's name as it appears on the card.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `300`, *Pattern*: `^.{1,300}$` | getName(): ?string | setName(?string name): void | -| `lastDigits` | `?string` | Optional | The last digits of the payment card.
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `4`, *Pattern*: `^[0-9]{2,4}$` | getLastDigits(): ?string | setLastDigits(?string lastDigits): void | -| `type` | [`?string(CardType)`](../../doc/models/card-type.md) | Optional | Type of card. i.e Credit, Debit and so on.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getType(): ?string | setType(?string type): void | -| `brand` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | The card network or brand. Applies to credit, debit, gift, and payment cards.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getBrand(): ?string | setBrand(?string brand): void | -| `billingAddress` | [`?Address`](../../doc/models/address.md) | Optional | 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). | getBillingAddress(): ?Address | setBillingAddress(?Address billingAddress): void | -| `authenticationResult` | [`?AuthenticationResponse`](../../doc/models/authentication-response.md) | Optional | Results of Authentication such as 3D Secure. | getAuthenticationResult(): ?AuthenticationResponse | setAuthenticationResult(?AuthenticationResponse authenticationResult): void | - -## Example (as JSON) - -```json -{ - "name": "name4", - "last_digits": "last_digits8", - "type": "DEBIT", - "brand": "SYNCHRONY", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } -} -``` - diff --git a/doc/models/google-pay-decrypted-token-data.md b/doc/models/google-pay-decrypted-token-data.md deleted file mode 100644 index 20a3832..0000000 --- a/doc/models/google-pay-decrypted-token-data.md +++ /dev/null @@ -1,33 +0,0 @@ - -# Google Pay Decrypted Token Data - -Details shared by Google for the merchant to be shared with PayPal. This is required to process the transaction using the Google Pay payment method. - -## Structure - -`GooglePayDecryptedTokenData` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `messageId` | `?string` | Optional | A unique ID that identifies the message in case it needs to be revoked or located at a later time.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `250`, *Pattern*: `^.*$` | getMessageId(): ?string | setMessageId(?string messageId): void | -| `messageExpiration` | `?string` | Optional | Date and time at which the message expires as UTC milliseconds since epoch. Integrators should reject any message that's expired.
**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `13`, *Pattern*: `\d{13}` | getMessageExpiration(): ?string | setMessageExpiration(?string messageExpiration): void | -| `paymentMethod` | [`string(GooglePayPaymentMethod)`](../../doc/models/google-pay-payment-method.md) | Required | The type of the payment credential. Currently, only CARD is supported.
**Constraints**: *Minimum Length*: `4`, *Maximum Length*: `4` | getPaymentMethod(): string | setPaymentMethod(string paymentMethod): void | -| `authenticationMethod` | [`string(GooglePayAuthenticationMethod)`](../../doc/models/google-pay-authentication-method.md) | Required | Authentication Method which is used for the card transaction.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `50` | getAuthenticationMethod(): string | setAuthenticationMethod(string authenticationMethod): void | -| `cryptogram` | `?string` | Optional | Base-64 cryptographic identifier used by card schemes to validate the token verification result. This is a conditionally required field if authentication_method is CRYPTOGRAM_3DS.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2000` | getCryptogram(): ?string | setCryptogram(?string cryptogram): void | -| `eciIndicator` | `?string` | Optional | Electronic Commerce Indicator may not always be present. It is only returned for tokens on the Visa card network. This value is passed through in the payment authorization request.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `256`, *Pattern*: `^.*$` | getEciIndicator(): ?string | setEciIndicator(?string eciIndicator): void | - -## Example (as JSON) - -```json -{ - "message_id": "message_id4", - "message_expiration": "message_expiration8", - "payment_method": "CARD", - "authentication_method": "PAN_ONLY", - "cryptogram": "cryptogram0", - "eci_indicator": "eci_indicator4" -} -``` - diff --git a/doc/models/google-pay-payment-method.md b/doc/models/google-pay-payment-method.md deleted file mode 100644 index 5b7b60f..0000000 --- a/doc/models/google-pay-payment-method.md +++ /dev/null @@ -1,15 +0,0 @@ - -# Google Pay Payment Method - -The type of the payment credential. Currently, only CARD is supported. - -## Enumeration - -`GooglePayPaymentMethod` - -## Fields - -| Name | -| --- | -| `CARD` | - diff --git a/doc/models/google-pay-request.md b/doc/models/google-pay-request.md deleted file mode 100644 index ab509de..0000000 --- a/doc/models/google-pay-request.md +++ /dev/null @@ -1,46 +0,0 @@ - -# Google Pay Request - -Information needed to pay using Google Pay. - -## Structure - -`GooglePayRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `?string` | Optional | The full name representation like Mr J Smith.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): ?string | setName(?string name): 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.

**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: `^(?:[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\|\[(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?\|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void | -| `phoneNumber` | [`?PhoneNumberWithCountryCode`](../../doc/models/phone-number-with-country-code.md) | Optional | The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). | getPhoneNumber(): ?PhoneNumberWithCountryCode | setPhoneNumber(?PhoneNumberWithCountryCode phoneNumber): void | -| `card` | `mixed` | Optional | The payment card information. | getCard(): | setCard( card): void | -| `decryptedToken` | [`?GooglePayDecryptedTokenData`](../../doc/models/google-pay-decrypted-token-data.md) | Optional | Details shared by Google for the merchant to be shared with PayPal. This is required to process the transaction using the Google Pay payment method. | getDecryptedToken(): ?GooglePayDecryptedTokenData | setDecryptedToken(?GooglePayDecryptedTokenData decryptedToken): void | -| `assuranceDetails` | `mixed` | Optional | - | getAssuranceDetails(): | setAssuranceDetails( assuranceDetails): void | -| `attributes` | [`?GooglePayCardAttributes`](../../doc/models/google-pay-card-attributes.md) | Optional | Additional attributes associated with the use of this card. | getAttributes(): ?GooglePayCardAttributes | setAttributes(?GooglePayCardAttributes attributes): void | - -## Example (as JSON) - -```json -{ - "name": "name4", - "email_address": "email_address2", - "phone_number": { - "country_code": "country_code2", - "national_number": "national_number6" - }, - "card": { - "key1": "val1", - "key2": "val2" - }, - "decrypted_token": { - "message_id": "message_id0", - "message_expiration": "message_expiration2", - "payment_method": "CARD", - "authentication_method": "PAN_ONLY", - "cryptogram": "cryptogram6", - "eci_indicator": "eci_indicator0" - } -} -``` - diff --git a/doc/models/google-pay-wallet-response.md b/doc/models/google-pay-wallet-response.md deleted file mode 100644 index 1972340..0000000 --- a/doc/models/google-pay-wallet-response.md +++ /dev/null @@ -1,45 +0,0 @@ - -# Google Pay Wallet Response - -Google Pay Wallet payment data. - -## Structure - -`GooglePayWalletResponse` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `?string` | Optional | The full name representation like Mr J Smith.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): ?string | setName(?string name): 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.

**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: `^(?:[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\|\[(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?\|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void | -| `phoneNumber` | [`?PhoneNumberWithCountryCode`](../../doc/models/phone-number-with-country-code.md) | Optional | The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). | getPhoneNumber(): ?PhoneNumberWithCountryCode | setPhoneNumber(?PhoneNumberWithCountryCode phoneNumber): void | -| `card` | [`?GooglePayCardResponse`](../../doc/models/google-pay-card-response.md) | Optional | The payment card to use to fund a Google Pay payment response. Can be a credit or debit card. | getCard(): ?GooglePayCardResponse | setCard(?GooglePayCardResponse card): void | - -## Example (as JSON) - -```json -{ - "name": "name0", - "email_address": "email_address2", - "phone_number": { - "country_code": "country_code2", - "national_number": "national_number6" - }, - "card": { - "name": "name6", - "last_digits": "last_digits0", - "type": "UNKNOWN", - "brand": "SYNCHRONY", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } - } -} -``` - diff --git a/doc/models/ideal-payment-object.md b/doc/models/ideal-payment-object.md deleted file mode 100644 index 1645254..0000000 --- a/doc/models/ideal-payment-object.md +++ /dev/null @@ -1,29 +0,0 @@ - -# IDEAL Payment Object - -Information used to pay using iDEAL. - -## Structure - -`IDEALPaymentObject` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `?string` | Optional | The full name representation like Mr J Smith.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): ?string | setName(?string name): void | -| `countryCode` | `?string` | Optional | 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 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.

**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): ?string | setCountryCode(?string countryCode): void | -| `bic` | `?string` | Optional | The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.
**Constraints**: *Minimum Length*: `8`, *Maximum Length*: `11`, *Pattern*: `^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$` | getBic(): ?string | setBic(?string bic): void | -| `ibanLastChars` | `?string` | Optional | The last characters of the IBAN used to pay.
**Constraints**: *Minimum Length*: `4`, *Maximum Length*: `34`, *Pattern*: `[a-zA-Z0-9]{4}` | getIbanLastChars(): ?string | setIbanLastChars(?string ibanLastChars): void | - -## Example (as JSON) - -```json -{ - "name": "name6", - "country_code": "country_code4", - "bic": "bic8", - "iban_last_chars": "iban_last_chars4" -} -``` - diff --git a/doc/models/ideal-payment-request.md b/doc/models/ideal-payment-request.md deleted file mode 100644 index 933b1db..0000000 --- a/doc/models/ideal-payment-request.md +++ /dev/null @@ -1,35 +0,0 @@ - -# IDEAL Payment Request - -Information needed to pay using iDEAL. - -## Structure - -`IDEALPaymentRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `string` | Required | The full name representation like Mr J Smith.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): string | setName(string name): void | -| `countryCode` | `string` | Required | 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 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.

**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): string | setCountryCode(string countryCode): void | -| `bic` | `?string` | Optional | The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.
**Constraints**: *Minimum Length*: `8`, *Maximum Length*: `11`, *Pattern*: `^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$` | getBic(): ?string | setBic(?string bic): void | -| `experienceContext` | [`?ExperienceContext`](../../doc/models/experience-context.md) | Optional | Customizes the payer experience during the approval process for the payment. | getExperienceContext(): ?ExperienceContext | setExperienceContext(?ExperienceContext experienceContext): void | - -## Example (as JSON) - -```json -{ - "name": "name6", - "country_code": "country_code4", - "bic": "bic8", - "experience_context": { - "brand_name": "brand_name2", - "locale": "locale6", - "shipping_preference": "NO_SHIPPING", - "return_url": "return_url4", - "cancel_url": "cancel_url6" - } -} -``` - diff --git a/doc/models/instrument-authorization-status.md b/doc/models/instrument-authorization-status.md deleted file mode 100644 index f119e0d..0000000 --- a/doc/models/instrument-authorization-status.md +++ /dev/null @@ -1,20 +0,0 @@ - -# Instrument Authorization Status - -The authorization status of the wallet instrument. - -## Enumeration - -`InstrumentAuthorizationStatus` - -## Fields - -| Name | -| --- | -| `AUTHORIZED` | -| `BLOCKED` | -| `FAILED` | -| `NOT_APPLICABLE` | -| `NOT_SUPPORTED` | -| `UNAUTHORIZED` | - diff --git a/doc/models/item-category.md b/doc/models/item-category.md deleted file mode 100644 index 47cdb63..0000000 --- a/doc/models/item-category.md +++ /dev/null @@ -1,17 +0,0 @@ - -# Item Category - -The item category type. - -## Enumeration - -`ItemCategory` - -## Fields - -| Name | -| --- | -| `DIGITAL_GOODS` | -| `PHYSICAL_GOODS` | -| `DONATION` | - diff --git a/doc/models/item.md b/doc/models/item.md deleted file mode 100644 index b950693..0000000 --- a/doc/models/item.md +++ /dev/null @@ -1,45 +0,0 @@ - -# Item - -The details for the items to be purchased. - -## Structure - -`Item` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `string` | Required | The item name or title.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127` | getName(): string | setName(string name): void | -| `unitAmount` | [`Money`](../../doc/models/money.md) | Required | The currency and amount for a financial transaction, such as a balance or payment due. | getUnitAmount(): Money | setUnitAmount(Money unitAmount): void | -| `tax` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getTax(): ?Money | setTax(?Money tax): void | -| `quantity` | `string` | Required | The item quantity. Must be a whole number.
**Constraints**: *Maximum Length*: `10`, *Pattern*: `^[1-9][0-9]{0,9}$` | getQuantity(): string | setQuantity(string quantity): void | -| `description` | `?string` | Optional | The detailed item description.
**Constraints**: *Maximum Length*: `127` | getDescription(): ?string | setDescription(?string description): void | -| `sku` | `?string` | Optional | The stock keeping unit (SKU) for the item.
**Constraints**: *Maximum Length*: `127` | getSku(): ?string | setSku(?string sku): void | -| `url` | `?string` | Optional | The URL to the item being purchased. Visible to buyer and used in buyer experiences.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2048` | getUrl(): ?string | setUrl(?string url): void | -| `category` | [`?string(ItemCategory)`](../../doc/models/item-category.md) | Optional | The item category type.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `20` | getCategory(): ?string | setCategory(?string category): void | -| `imageUrl` | `?string` | Optional | The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2048`, *Pattern*: `^(https:)([/\|.\|\w\|\s\|-])*\.(?:jpg\|gif\|png\|jpeg\|JPG\|GIF\|PNG\|JPEG)` | getImageUrl(): ?string | setImageUrl(?string imageUrl): void | -| `upc` | [`?UniversalProductCode`](../../doc/models/universal-product-code.md) | Optional | The Universal Product Code of the item. | getUpc(): ?UniversalProductCode | setUpc(?UniversalProductCode upc): void | - -## Example (as JSON) - -```json -{ - "name": "name2", - "unit_amount": { - "currency_code": "currency_code2", - "value": "value8" - }, - "tax": { - "currency_code": "currency_code0", - "value": "value6" - }, - "quantity": "quantity8", - "description": "description2", - "sku": "sku8", - "url": "url6", - "category": "DIGITAL_GOODS" -} -``` - diff --git a/doc/models/level-2-card-processing-data.md b/doc/models/level-2-card-processing-data.md deleted file mode 100644 index 3097809..0000000 --- a/doc/models/level-2-card-processing-data.md +++ /dev/null @@ -1,28 +0,0 @@ - -# Level 2 Card Processing Data - -The level 2 card processing data collections. If your merchant account has been configured for Level 2 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 2 data for your business. - -## Structure - -`Level2CardProcessingData` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `invoiceId` | `?string` | Optional | Use this field to pass a purchase identification value of up to 12 ASCII characters for AIB and 17 ASCII characters for all other processors.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `17`, *Pattern*: `^[\w‘\-.,":;\!?]*$` | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void | -| `taxTotal` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getTaxTotal(): ?Money | setTaxTotal(?Money taxTotal): void | - -## Example (as JSON) - -```json -{ - "invoice_id": "invoice_id8", - "tax_total": { - "currency_code": "currency_code4", - "value": "value0" - } -} -``` - diff --git a/doc/models/level-3-card-processing-data.md b/doc/models/level-3-card-processing-data.md deleted file mode 100644 index df20637..0000000 --- a/doc/models/level-3-card-processing-data.md +++ /dev/null @@ -1,48 +0,0 @@ - -# Level 3 Card Processing Data - -The level 3 card processing data collections, If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 3 data for your business. - -## Structure - -`Level3CardProcessingData` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `shippingAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getShippingAmount(): ?Money | setShippingAmount(?Money shippingAmount): void | -| `dutyAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getDutyAmount(): ?Money | setDutyAmount(?Money dutyAmount): void | -| `discountAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getDiscountAmount(): ?Money | setDiscountAmount(?Money discountAmount): void | -| `shippingAddress` | [`?Address`](../../doc/models/address.md) | Optional | 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). | getShippingAddress(): ?Address | setShippingAddress(?Address shippingAddress): void | -| `shipsFromPostalCode` | `?string` | Optional | Use this field to specify the postal code of the shipping location.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `60`, *Pattern*: `^[a-zA-Z0-9_'.-]*$` | getShipsFromPostalCode(): ?string | setShipsFromPostalCode(?string shipsFromPostalCode): void | -| `lineItems` | [`?(LineItem[])`](../../doc/models/line-item.md) | Optional | A list of the items that were purchased with this payment. If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf.
**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `100` | getLineItems(): ?array | setLineItems(?array lineItems): void | - -## Example (as JSON) - -```json -{ - "shipping_amount": { - "currency_code": "currency_code0", - "value": "value6" - }, - "duty_amount": { - "currency_code": "currency_code6", - "value": "value2" - }, - "discount_amount": { - "currency_code": "currency_code2", - "value": "value8" - }, - "shipping_address": { - "address_line_1": "address_line_10", - "address_line_2": "address_line_20", - "admin_area_2": "admin_area_24", - "admin_area_1": "admin_area_16", - "postal_code": "postal_code2", - "country_code": "country_code0" - }, - "ships_from_postal_code": "ships_from_postal_code6" -} -``` - diff --git a/doc/models/liability-shift-indicator.md b/doc/models/liability-shift-indicator.md deleted file mode 100644 index dbd5882..0000000 --- a/doc/models/liability-shift-indicator.md +++ /dev/null @@ -1,17 +0,0 @@ - -# Liability Shift Indicator - -Liability shift indicator. The outcome of the issuer's authentication. - -## Enumeration - -`LiabilityShiftIndicator` - -## Fields - -| Name | -| --- | -| `NO` | -| `POSSIBLE` | -| `UNKNOWN` | - diff --git a/doc/models/line-item.md b/doc/models/line-item.md deleted file mode 100644 index c0a2854..0000000 --- a/doc/models/line-item.md +++ /dev/null @@ -1,48 +0,0 @@ - -# Line Item - -The line items for this purchase. If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf. - -## Structure - -`LineItem` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `string` | Required | The item name or title.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127` | getName(): string | setName(string name): void | -| `unitAmount` | [`Money`](../../doc/models/money.md) | Required | The currency and amount for a financial transaction, such as a balance or payment due. | getUnitAmount(): Money | setUnitAmount(Money unitAmount): void | -| `tax` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getTax(): ?Money | setTax(?Money tax): void | -| `quantity` | `string` | Required | The item quantity. Must be a whole number.
**Constraints**: *Maximum Length*: `10`, *Pattern*: `^[1-9][0-9]{0,9}$` | getQuantity(): string | setQuantity(string quantity): void | -| `description` | `?string` | Optional | The detailed item description.
**Constraints**: *Maximum Length*: `127` | getDescription(): ?string | setDescription(?string description): void | -| `sku` | `?string` | Optional | The stock keeping unit (SKU) for the item.
**Constraints**: *Maximum Length*: `127` | getSku(): ?string | setSku(?string sku): void | -| `url` | `?string` | Optional | The URL to the item being purchased. Visible to buyer and used in buyer experiences.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2048` | getUrl(): ?string | setUrl(?string url): void | -| `imageUrl` | `?string` | Optional | The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2048`, *Pattern*: `^(https:)([/\|.\|\w\|\s\|-])*\.(?:jpg\|gif\|png\|jpeg\|JPG\|GIF\|PNG\|JPEG)` | getImageUrl(): ?string | setImageUrl(?string imageUrl): void | -| `upc` | [`?UniversalProductCode`](../../doc/models/universal-product-code.md) | Optional | The Universal Product Code of the item. | getUpc(): ?UniversalProductCode | setUpc(?UniversalProductCode upc): void | -| `commodityCode` | `?string` | Optional | Code used to classify items purchased and track the total amount spent across various categories of products and services. Different corporate purchasing organizations may use different standards, but the United Nations Standard Products and Services Code (UNSPSC) is frequently used.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `12`, *Pattern*: `^[a-zA-Z0-9_'.-]*$` | getCommodityCode(): ?string | setCommodityCode(?string commodityCode): void | -| `discountAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getDiscountAmount(): ?Money | setDiscountAmount(?Money discountAmount): void | -| `totalAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getTotalAmount(): ?Money | setTotalAmount(?Money totalAmount): void | -| `unitOfMeasure` | `?string` | Optional | Unit of measure is a standard used to express the magnitude of a quantity in international trade. Most commonly used (but not limited to) examples are: Acre (ACR), Ampere (AMP), Centigram (CGM), Centimetre (CMT), Cubic inch (INQ), Cubic metre (MTQ), Fluid ounce (OZA), Foot (FOT), Hour (HUR), Item (ITM), Kilogram (KGM), Kilometre (KMT), Kilowatt (KWT), Liquid gallon (GLL), Liter (LTR), Pounds (LBS), Square foot (FTK).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `12`, *Pattern*: `^[a-zA-Z0-9_'.-]*$` | getUnitOfMeasure(): ?string | setUnitOfMeasure(?string unitOfMeasure): void | - -## Example (as JSON) - -```json -{ - "name": "name8", - "unit_amount": { - "currency_code": "currency_code2", - "value": "value8" - }, - "tax": { - "currency_code": "currency_code0", - "value": "value6" - }, - "quantity": "quantity4", - "description": "description8", - "sku": "sku6", - "url": "url2", - "image_url": "image_url4" -} -``` - diff --git a/doc/models/link-description.md b/doc/models/link-description.md deleted file mode 100644 index cd4a067..0000000 --- a/doc/models/link-description.md +++ /dev/null @@ -1,27 +0,0 @@ - -# Link Description - -The request-related [HATEOAS link](/api/rest/responses/#hateoas-links) information. - -## Structure - -`LinkDescription` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `href` | `string` | Required | The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call. | getHref(): string | setHref(string href): void | -| `rel` | `string` | Required | The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml). | getRel(): string | setRel(string rel): void | -| `method` | [`?string(LinkHTTPMethod)`](../../doc/models/link-http-method.md) | Optional | The HTTP method required to make the related call. | getMethod(): ?string | setMethod(?string method): void | - -## Example (as JSON) - -```json -{ - "href": "href2", - "rel": "rel6", - "method": "PUT" -} -``` - diff --git a/doc/models/link-http-method.md b/doc/models/link-http-method.md deleted file mode 100644 index 45341a5..0000000 --- a/doc/models/link-http-method.md +++ /dev/null @@ -1,22 +0,0 @@ - -# Link HTTP Method - -The HTTP method required to make the related call. - -## Enumeration - -`LinkHTTPMethod` - -## Fields - -| Name | -| --- | -| `GET` | -| `POST` | -| `PUT` | -| `DELETE` | -| `HEAD` | -| `CONNECT` | -| `OPTIONS` | -| `PATCH` | - diff --git a/doc/models/money.md b/doc/models/money.md deleted file mode 100644 index 671e7f1..0000000 --- a/doc/models/money.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Money - -The currency and amount for a financial transaction, such as a balance or payment due. - -## Structure - -`Money` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `currencyCode` | `string` | Required | The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `3` | getCurrencyCode(): string | setCurrencyCode(string currencyCode): void | -| `value` | `string` | Required | The value, which might be:For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).
**Constraints**: *Maximum Length*: `32`, *Pattern*: `^((-?[0-9]+)\|(-?([0-9]+)?[.][0-9]+))$` | getValue(): string | setValue(string value): void | - -## Example (as JSON) - -```json -{ - "currency_code": "currency_code6", - "value": "value2" -} -``` - diff --git a/doc/models/my-bank-payment-object.md b/doc/models/my-bank-payment-object.md deleted file mode 100644 index d5fa99a..0000000 --- a/doc/models/my-bank-payment-object.md +++ /dev/null @@ -1,29 +0,0 @@ - -# My Bank Payment Object - -Information used to pay using MyBank. - -## Structure - -`MyBankPaymentObject` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `?string` | Optional | The full name representation like Mr J Smith.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): ?string | setName(?string name): void | -| `countryCode` | `?string` | Optional | 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 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.

**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): ?string | setCountryCode(?string countryCode): void | -| `bic` | `?string` | Optional | The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.
**Constraints**: *Minimum Length*: `8`, *Maximum Length*: `11`, *Pattern*: `^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$` | getBic(): ?string | setBic(?string bic): void | -| `ibanLastChars` | `?string` | Optional | The last characters of the IBAN used to pay.
**Constraints**: *Minimum Length*: `4`, *Maximum Length*: `34`, *Pattern*: `[a-zA-Z0-9]{4}` | getIbanLastChars(): ?string | setIbanLastChars(?string ibanLastChars): void | - -## Example (as JSON) - -```json -{ - "name": "name4", - "country_code": "country_code4", - "bic": "bic6", - "iban_last_chars": "iban_last_chars2" -} -``` - diff --git a/doc/models/my-bank-payment-request.md b/doc/models/my-bank-payment-request.md deleted file mode 100644 index 06a5836..0000000 --- a/doc/models/my-bank-payment-request.md +++ /dev/null @@ -1,33 +0,0 @@ - -# My Bank Payment Request - -Information needed to pay using MyBank. - -## Structure - -`MyBankPaymentRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `string` | Required | The full name representation like Mr J Smith.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): string | setName(string name): void | -| `countryCode` | `string` | Required | 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 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.

**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): string | setCountryCode(string countryCode): void | -| `experienceContext` | [`?ExperienceContext`](../../doc/models/experience-context.md) | Optional | Customizes the payer experience during the approval process for the payment. | getExperienceContext(): ?ExperienceContext | setExperienceContext(?ExperienceContext experienceContext): void | - -## Example (as JSON) - -```json -{ - "name": "name0", - "country_code": "country_code0", - "experience_context": { - "brand_name": "brand_name2", - "locale": "locale6", - "shipping_preference": "NO_SHIPPING", - "return_url": "return_url4", - "cancel_url": "cancel_url6" - } -} -``` - diff --git a/doc/models/name.md b/doc/models/name.md deleted file mode 100644 index ea6375d..0000000 --- a/doc/models/name.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Name - -The name of the party. - -## Structure - -`Name` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `givenName` | `?string` | Optional | When the party is a person, the party's given, or first, name.
**Constraints**: *Maximum Length*: `140` | getGivenName(): ?string | setGivenName(?string givenName): void | -| `surname` | `?string` | Optional | When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.
**Constraints**: *Maximum Length*: `140` | getSurname(): ?string | setSurname(?string surname): void | - -## Example (as JSON) - -```json -{ - "given_name": "given_name2", - "surname": "surname8" -} -``` - diff --git a/doc/models/net-amount-breakdown-item.md b/doc/models/net-amount-breakdown-item.md deleted file mode 100644 index 3013cef..0000000 --- a/doc/models/net-amount-breakdown-item.md +++ /dev/null @@ -1,37 +0,0 @@ - -# Net Amount Breakdown Item - -The net amount. Returned when the currency of the refund is different from the currency of the PayPal account where the merchant holds their funds. - -## Structure - -`NetAmountBreakdownItem` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `payableAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getPayableAmount(): ?Money | setPayableAmount(?Money payableAmount): void | -| `convertedAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getConvertedAmount(): ?Money | setConvertedAmount(?Money convertedAmount): void | -| `exchangeRate` | [`?ExchangeRate`](../../doc/models/exchange-rate.md) | Optional | The exchange rate that determines the amount to convert from one currency to another currency. | getExchangeRate(): ?ExchangeRate | setExchangeRate(?ExchangeRate exchangeRate): void | - -## Example (as JSON) - -```json -{ - "payable_amount": { - "currency_code": "currency_code8", - "value": "value4" - }, - "converted_amount": { - "currency_code": "currency_code0", - "value": "value6" - }, - "exchange_rate": { - "source_currency": "source_currency4", - "target_currency": "target_currency6", - "value": "value6" - } -} -``` - diff --git a/doc/models/network-token.md b/doc/models/network-token.md deleted file mode 100644 index d89c921..0000000 --- a/doc/models/network-token.md +++ /dev/null @@ -1,31 +0,0 @@ - -# Network Token - -The Third Party Network token used to fund a payment. - -## Structure - -`NetworkToken` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `number` | `string` | Required | Third party network token number.
**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `19`, *Pattern*: `^[0-9]{13,19}$` | getNumber(): string | setNumber(string number): void | -| `expiry` | `string` | Required | 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).
**Constraints**: *Minimum Length*: `7`, *Maximum Length*: `7`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])$` | getExpiry(): string | setExpiry(string expiry): void | -| `cryptogram` | `?string` | Optional | An Encrypted one-time use value that's sent along with Network Token. This field is not required to be present for recurring transactions.
**Constraints**: *Minimum Length*: `28`, *Maximum Length*: `32`, *Pattern*: `^.*$` | getCryptogram(): ?string | setCryptogram(?string cryptogram): void | -| `eciFlag` | [`?string(ECIFlag)`](../../doc/models/eci-flag.md) | Optional | 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 the Gateway/Processor.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getEciFlag(): ?string | setEciFlag(?string eciFlag): void | -| `tokenRequestorId` | `?string` | Optional | A TRID, or a Token Requestor ID, is an identifier used by merchants to request network tokens from card networks. A TRID is a precursor to obtaining a network token for a credit card primary account number (PAN), and will aid in enabling secure card on file (COF) payments and reducing fraud.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `11`, *Pattern*: `^[0-9A-Z_]+$` | getTokenRequestorId(): ?string | setTokenRequestorId(?string tokenRequestorId): void | - -## Example (as JSON) - -```json -{ - "number": "number0", - "expiry": "expiry0", - "cryptogram": "cryptogram2", - "eci_flag": "ATTEMPTED_AUTHENTICATION_TRANSACTION", - "token_requestor_id": "token_requestor_id8" -} -``` - diff --git a/doc/models/network-transaction-reference-entity.md b/doc/models/network-transaction-reference-entity.md deleted file mode 100644 index 47431cd..0000000 --- a/doc/models/network-transaction-reference-entity.md +++ /dev/null @@ -1,29 +0,0 @@ - -# Network Transaction Reference Entity - -Previous network transaction reference including id and network. - -## Structure - -`NetworkTransactionReferenceEntity` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `id` | `string` | Required | Transaction reference id returned by the scheme. For Visa and Amex, this is the "Tran id" field in response. For MasterCard, this is the "BankNet reference id" field in response. For Discover, this is the "NRID" field in response. The pattern we expect for this field from Visa/Amex/CB/Discover is numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric with special character -.
**Constraints**: *Minimum Length*: `9`, *Maximum Length*: `36`, *Pattern*: `^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$` | getId(): string | setId(string id): void | -| `date` | `?string` | Optional | The date that the transaction was authorized by the scheme. This field may not be returned for all networks. MasterCard refers to this field as "BankNet reference date.
**Constraints**: *Minimum Length*: `4`, *Maximum Length*: `4`, *Pattern*: `^[0-9]+$` | getDate(): ?string | setDate(?string date): void | -| `network` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | The card network or brand. Applies to credit, debit, gift, and payment cards.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getNetwork(): ?string | setNetwork(?string network): void | -| `time` | `?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.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getTime(): ?string | setTime(?string time): void | - -## Example (as JSON) - -```json -{ - "id": "id6", - "date": "date2", - "network": "VISA", - "time": "time6" -} -``` - diff --git a/doc/models/network-transaction-reference.md b/doc/models/network-transaction-reference.md deleted file mode 100644 index 6d831c9..0000000 --- a/doc/models/network-transaction-reference.md +++ /dev/null @@ -1,29 +0,0 @@ - -# Network Transaction Reference - -Reference values used by the card network to identify a transaction. - -## Structure - -`NetworkTransactionReference` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `id` | `string` | Required | Transaction reference id returned by the scheme. For Visa and Amex, this is the "Tran id" field in response. For MasterCard, this is the "BankNet reference id" field in response. For Discover, this is the "NRID" field in response. The pattern we expect for this field from Visa/Amex/CB/Discover is numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric with special character -.
**Constraints**: *Minimum Length*: `9`, *Maximum Length*: `36`, *Pattern*: `^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$` | getId(): string | setId(string id): void | -| `date` | `?string` | Optional | The date that the transaction was authorized by the scheme. This field may not be returned for all networks. MasterCard refers to this field as "BankNet reference date.
**Constraints**: *Minimum Length*: `4`, *Maximum Length*: `4`, *Pattern*: `^[0-9]+$` | getDate(): ?string | setDate(?string date): void | -| `network` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | The card network or brand. Applies to credit, debit, gift, and payment cards.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getNetwork(): ?string | setNetwork(?string network): void | -| `acquirerReferenceNumber` | `?string` | Optional | Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[a-zA-Z0-9]+$` | getAcquirerReferenceNumber(): ?string | setAcquirerReferenceNumber(?string acquirerReferenceNumber): void | - -## Example (as JSON) - -```json -{ - "id": "id6", - "date": "date8", - "network": "CB_NATIONALE", - "acquirer_reference_number": "acquirer_reference_number2" -} -``` - diff --git a/doc/models/o-auth-provider-error.md b/doc/models/o-auth-provider-error.md deleted file mode 100644 index ab73f72..0000000 --- a/doc/models/o-auth-provider-error.md +++ /dev/null @@ -1,20 +0,0 @@ - -# O Auth Provider Error - -OAuth 2 Authorization error codes - -## Enumeration - -`OAuthProviderError` - -## Fields - -| Name | Description | -| --- | --- | -| `INVALID_REQUEST` | The request is missing a required parameter, includes an unsupported parameter value (other than grant type), repeats a parameter, includes multiple credentials, utilizes more than one mechanism for authenticating the client, or is otherwise malformed. | -| `INVALID_CLIENT` | Client authentication failed (e.g., unknown client, no client authentication included, or unsupported authentication method). | -| `INVALID_GRANT` | The provided authorization grant (e.g., authorization code, resource owner credentials) or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client. | -| `UNAUTHORIZED_CLIENT` | The authenticated client is not authorized to use this authorization grant type. | -| `UNSUPPORTED_GRANT_TYPE` | The authorization grant type is not supported by the authorization server. | -| `INVALID_SCOPE` | The requested scope is invalid, unknown, malformed, or exceeds the scope granted by the resource owner. | - diff --git a/doc/models/o-auth-provider-exception.md b/doc/models/o-auth-provider-exception.md deleted file mode 100644 index d39fb3f..0000000 --- a/doc/models/o-auth-provider-exception.md +++ /dev/null @@ -1,27 +0,0 @@ - -# O Auth Provider Exception - -OAuth 2 Authorization endpoint exception. - -## Structure - -`OAuthProviderException` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `error` | [`string(OAuthProviderError)`](../../doc/models/o-auth-provider-error.md) | Required | Gets or sets error code. | getError(): string | setError(string error): void | -| `errorDescription` | `?string` | Optional | Gets or sets human-readable text providing additional information on error.
Used to assist the client developer in understanding the error that occurred. | getErrorDescription(): ?string | setErrorDescription(?string errorDescription): void | -| `errorUri` | `?string` | Optional | Gets or sets a URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error. | getErrorUri(): ?string | setErrorUri(?string errorUri): void | - -## Example (as JSON) - -```json -{ - "error": "unsupported_grant_type", - "error_description": "error_description8", - "error_uri": "error_uri8" -} -``` - diff --git a/doc/models/o-auth-token.md b/doc/models/o-auth-token.md deleted file mode 100644 index 52da177..0000000 --- a/doc/models/o-auth-token.md +++ /dev/null @@ -1,35 +0,0 @@ - -# O Auth Token - -OAuth 2 Authorization endpoint response - -## Structure - -`OAuthToken` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `accessToken` | `string` | Required | Access token | getAccessToken(): string | setAccessToken(string accessToken): void | -| `tokenType` | `string` | Required | Type of access token | getTokenType(): string | setTokenType(string tokenType): void | -| `expiresIn` | `?int` | Optional | Time in seconds before the access token expires | getExpiresIn(): ?int | setExpiresIn(?int expiresIn): void | -| `scope` | `?string` | Optional | List of scopes granted
This is a space-delimited list of strings. | getScope(): ?string | setScope(?string scope): void | -| `expiry` | `?int` | Optional | Time of token expiry as unix timestamp (UTC) | getExpiry(): ?int | setExpiry(?int expiry): void | -| `refreshToken` | `?string` | Optional | Refresh token
Used to get a new access token when it expires. | getRefreshToken(): ?string | setRefreshToken(?string refreshToken): void | -| `idToken` | `?string` | Optional | An ID token response type is of JSON Web Token (JWT) that contains claims about the identity of the authenticated user. | getIdToken(): ?string | setIdToken(?string idToken): void | - -## Example (as JSON) - -```json -{ - "access_token": "access_token4", - "token_type": "token_type6", - "expires_in": 74, - "scope": "scope6", - "expiry": 88, - "refresh_token": "refresh_token6", - "id_token": "id_token6" -} -``` - diff --git a/doc/models/order-application-context-landing-page.md b/doc/models/order-application-context-landing-page.md deleted file mode 100644 index 7b60be3..0000000 --- a/doc/models/order-application-context-landing-page.md +++ /dev/null @@ -1,17 +0,0 @@ - -# Order Application Context Landing Page - -DEPRECATED. DEPRECATED. The type of landing page to show on the PayPal site for customer checkout. 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.landing_page`). Please specify this field in the `experience_context` object instead of the `application_context` object. - -## Enumeration - -`OrderApplicationContextLandingPage` - -## Fields - -| Name | -| --- | -| `LOGIN` | -| `BILLING` | -| `NO_PREFERENCE` | - diff --git a/doc/models/order-application-context-shipping-preference.md b/doc/models/order-application-context-shipping-preference.md deleted file mode 100644 index 165eb75..0000000 --- a/doc/models/order-application-context-shipping-preference.md +++ /dev/null @@ -1,17 +0,0 @@ - -# Order Application Context Shipping Preference - -DEPRECATED. DEPRECATED. The shipping preference:. 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.shipping_preference`). Please specify this field in the `experience_context` object instead of the `application_context` object. - -## Enumeration - -`OrderApplicationContextShippingPreference` - -## Fields - -| Name | -| --- | -| `GET_FROM_FILE` | -| `NO_SHIPPING` | -| `SET_PROVIDED_ADDRESS` | - diff --git a/doc/models/order-application-context-user-action.md b/doc/models/order-application-context-user-action.md deleted file mode 100644 index 08b3b1e..0000000 --- a/doc/models/order-application-context-user-action.md +++ /dev/null @@ -1,16 +0,0 @@ - -# Order Application Context User Action - -DEPRECATED. Configures a Continue or Pay Now checkout flow. 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.user_action`). Please specify this field in the `experience_context` object instead of the `application_context` object. - -## Enumeration - -`OrderApplicationContextUserAction` - -## Fields - -| Name | -| --- | -| `CONTINUE_` | -| `PAY_NOW` | - diff --git a/doc/models/order-application-context.md b/doc/models/order-application-context.md deleted file mode 100644 index ab0c829..0000000 --- a/doc/models/order-application-context.md +++ /dev/null @@ -1,35 +0,0 @@ - -# Order Application Context - -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 - -`OrderApplicationContext` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `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.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127` | getBrandName(): ?string | setBrandName(?string brandName): void | -| `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/).
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `10`, *Pattern*: `^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}\|[0-9]{3}))?$` | getLocale(): ?string | setLocale(?string locale): void | -| `landingPage` | [`?string(OrderApplicationContextLandingPage)`](../../doc/models/order-application-context-landing-page.md) | Optional | DEPRECATED. DEPRECATED. The type of landing page to show on the PayPal site for customer checkout. 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.landing_page`). Please specify this field in the `experience_context` object instead of the `application_context` object.
**Default**: `OrderApplicationContextLandingPage::NO_PREFERENCE`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `13`, *Pattern*: `^[0-9A-Z_]+$` | getLandingPage(): ?string | setLandingPage(?string landingPage): void | -| `shippingPreference` | [`?string(OrderApplicationContextShippingPreference)`](../../doc/models/order-application-context-shipping-preference.md) | Optional | DEPRECATED. DEPRECATED. The shipping preference:. 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.shipping_preference`). Please specify this field in the `experience_context` object instead of the `application_context` object.
**Default**: `OrderApplicationContextShippingPreference::GET_FROM_FILE`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `20`, *Pattern*: `^[0-9A-Z_]+$` | getShippingPreference(): ?string | setShippingPreference(?string shippingPreference): void | -| `userAction` | [`?string(OrderApplicationContextUserAction)`](../../doc/models/order-application-context-user-action.md) | Optional | DEPRECATED. Configures a Continue or Pay Now checkout flow. 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.user_action`). Please specify this field in the `experience_context` object instead of the `application_context` object.
**Default**: `OrderApplicationContextUserAction::CONTINUE_`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `8`, *Pattern*: `^[0-9A-Z_]+$` | getUserAction(): ?string | setUserAction(?string userAction): void | -| `paymentMethod` | [`?PaymentMethodPreference`](../../doc/models/payment-method-preference.md) | Optional | The customer and merchant payment preferences. | getPaymentMethod(): ?PaymentMethodPreference | setPaymentMethod(?PaymentMethodPreference paymentMethod): void | -| `returnUrl` | `?string` | Optional | DEPRECATED. The URL where the customer is redirected after the customer approves the payment. 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.return_url`). Please specify this field in the `experience_context` object instead of the `application_context` object. | getReturnUrl(): ?string | setReturnUrl(?string returnUrl): void | -| `cancelUrl` | `?string` | Optional | DEPRECATED. The URL where the customer is redirected after the customer cancels the payment. 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.cancel_url`). Please specify this field in the `experience_context` object instead of the `application_context` object. | getCancelUrl(): ?string | setCancelUrl(?string cancelUrl): void | -| `storedPaymentSource` | [`?StoredPaymentSource`](../../doc/models/stored-payment-source.md) | Optional | 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).
Parameter compatibility:
| getStoredPaymentSource(): ?StoredPaymentSource | setStoredPaymentSource(?StoredPaymentSource storedPaymentSource): void | - -## Example (as JSON) - -```json -{ - "landing_page": "NO_PREFERENCE", - "shipping_preference": "GET_FROM_FILE", - "user_action": "CONTINUE", - "brand_name": "brand_name2", - "locale": "locale6" -} -``` - diff --git a/doc/models/order-authorize-request-payment-source.md b/doc/models/order-authorize-request-payment-source.md deleted file mode 100644 index bafa765..0000000 --- a/doc/models/order-authorize-request-payment-source.md +++ /dev/null @@ -1,109 +0,0 @@ - -# Order Authorize Request Payment Source - -The payment source definition. - -## Structure - -`OrderAuthorizeRequestPaymentSource` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `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/pay-pal-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 | -| `googlePay` | [`?GooglePayRequest`](../../doc/models/google-pay-request.md) | Optional | Information needed to pay using Google Pay. | getGooglePay(): ?GooglePayRequest | setGooglePay(?GooglePayRequest googlePay): void | -| `venmo` | [`?VenmoWalletRequest`](../../doc/models/venmo-wallet-request.md) | Optional | Information needed to pay using Venmo. | getVenmo(): ?VenmoWalletRequest | setVenmo(?VenmoWalletRequest venmo): void | - -## Example (as JSON) - -```json -{ - "card": { - "name": "name6", - "number": "number6", - "expiry": "expiry4", - "security_code": "security_code8", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } - }, - "token": { - "id": "id6", - "type": "BILLING_AGREEMENT" - }, - "paypal": { - "vault_id": "vault_id0", - "email_address": "email_address0", - "name": { - "given_name": "given_name2", - "surname": "surname8" - }, - "phone": { - "phone_type": "OTHER", - "phone_number": { - "national_number": "national_number6" - } - }, - "birth_date": "birth_date8" - }, - "apple_pay": { - "id": "id0", - "name": "name0", - "email_address": "email_address8", - "phone_number": { - "national_number": "national_number6" - }, - "decrypted_token": { - "transaction_amount": { - "currency_code": "currency_code6", - "value": "value2" - }, - "tokenized_card": { - "name": "name4", - "number": "number2", - "expiry": "expiry2", - "card_type": "HIPER", - "type": "UNKNOWN" - }, - "device_manufacturer_id": "device_manufacturer_id6", - "payment_data_type": "3DSECURE", - "payment_data": { - "cryptogram": "cryptogram6", - "eci_indicator": "eci_indicator0", - "emv_data": "emv_data0", - "pin": "pin4" - } - } - }, - "google_pay": { - "name": "name8", - "email_address": "email_address6", - "phone_number": { - "country_code": "country_code2", - "national_number": "national_number6" - }, - "card": { - "key1": "val1", - "key2": "val2" - }, - "decrypted_token": { - "message_id": "message_id0", - "message_expiration": "message_expiration2", - "payment_method": "CARD", - "authentication_method": "PAN_ONLY", - "cryptogram": "cryptogram6", - "eci_indicator": "eci_indicator0" - } - } -} -``` - diff --git a/doc/models/order-authorize-request.md b/doc/models/order-authorize-request.md deleted file mode 100644 index 13b2bb8..0000000 --- a/doc/models/order-authorize-request.md +++ /dev/null @@ -1,106 +0,0 @@ - -# Order Authorize Request - -The authorization of an order request. - -## Structure - -`OrderAuthorizeRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `paymentSource` | [`?OrderAuthorizeRequestPaymentSource`](../../doc/models/order-authorize-request-payment-source.md) | Optional | The payment source definition. | getPaymentSource(): ?OrderAuthorizeRequestPaymentSource | setPaymentSource(?OrderAuthorizeRequestPaymentSource paymentSource): void | - -## Example (as JSON) - -```json -{ - "payment_source": { - "card": { - "name": "name6", - "number": "number6", - "expiry": "expiry4", - "security_code": "security_code8", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } - }, - "token": { - "id": "id6", - "type": "BILLING_AGREEMENT" - }, - "paypal": { - "vault_id": "vault_id0", - "email_address": "email_address0", - "name": { - "given_name": "given_name2", - "surname": "surname8" - }, - "phone": { - "phone_type": "OTHER", - "phone_number": { - "national_number": "national_number6" - } - }, - "birth_date": "birth_date8" - }, - "apple_pay": { - "id": "id0", - "name": "name0", - "email_address": "email_address8", - "phone_number": { - "national_number": "national_number6" - }, - "decrypted_token": { - "transaction_amount": { - "currency_code": "currency_code6", - "value": "value2" - }, - "tokenized_card": { - "name": "name4", - "number": "number2", - "expiry": "expiry2", - "card_type": "HIPER", - "type": "UNKNOWN" - }, - "device_manufacturer_id": "device_manufacturer_id6", - "payment_data_type": "3DSECURE", - "payment_data": { - "cryptogram": "cryptogram6", - "eci_indicator": "eci_indicator0", - "emv_data": "emv_data0", - "pin": "pin4" - } - } - }, - "google_pay": { - "name": "name8", - "email_address": "email_address6", - "phone_number": { - "country_code": "country_code2", - "national_number": "national_number6" - }, - "card": { - "key1": "val1", - "key2": "val2" - }, - "decrypted_token": { - "message_id": "message_id0", - "message_expiration": "message_expiration2", - "payment_method": "CARD", - "authentication_method": "PAN_ONLY", - "cryptogram": "cryptogram6", - "eci_indicator": "eci_indicator0" - } - } - } -} -``` - diff --git a/doc/models/order-authorize-response-payment-source.md b/doc/models/order-authorize-response-payment-source.md deleted file mode 100644 index a77e1c2..0000000 --- a/doc/models/order-authorize-response-payment-source.md +++ /dev/null @@ -1,88 +0,0 @@ - -# Order Authorize Response Payment Source - -The payment source used to fund the payment. - -## Structure - -`OrderAuthorizeResponsePaymentSource` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `card` | [`?CardResponse`](../../doc/models/card-response.md) | Optional | The payment card to use to fund a payment. Card can be a credit or debit card. | getCard(): ?CardResponse | setCard(?CardResponse card): void | -| `paypal` | [`?PayPalWalletResponse`](../../doc/models/pay-pal-wallet-response.md) | Optional | The PayPal Wallet response. | getPaypal(): ?PayPalWalletResponse | setPaypal(?PayPalWalletResponse paypal): void | -| `applePay` | [`?ApplePayPaymentObject`](../../doc/models/apple-pay-payment-object.md) | Optional | Information needed to pay using ApplePay. | getApplePay(): ?ApplePayPaymentObject | setApplePay(?ApplePayPaymentObject applePay): void | -| `googlePay` | [`?GooglePayWalletResponse`](../../doc/models/google-pay-wallet-response.md) | Optional | Google Pay Wallet payment data. | getGooglePay(): ?GooglePayWalletResponse | setGooglePay(?GooglePayWalletResponse googlePay): void | -| `venmo` | [`?VenmoWalletResponse`](../../doc/models/venmo-wallet-response.md) | Optional | Venmo wallet response. | getVenmo(): ?VenmoWalletResponse | setVenmo(?VenmoWalletResponse venmo): void | - -## Example (as JSON) - -```json -{ - "card": { - "name": "name6", - "last_digits": "last_digits0", - "brand": "SYNCHRONY", - "available_networks": [ - "DELTA" - ], - "type": "UNKNOWN" - }, - "paypal": { - "email_address": "email_address0", - "account_id": "account_id4", - "account_status": "VERIFIED", - "name": { - "given_name": "given_name2", - "surname": "surname8" - }, - "phone_type": "FAX" - }, - "apple_pay": { - "id": "id0", - "token": "token6", - "name": "name0", - "email_address": "email_address8", - "phone_number": { - "national_number": "national_number6" - } - }, - "google_pay": { - "name": "name8", - "email_address": "email_address6", - "phone_number": { - "country_code": "country_code2", - "national_number": "national_number6" - }, - "card": { - "name": "name6", - "last_digits": "last_digits0", - "type": "UNKNOWN", - "brand": "SYNCHRONY", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } - } - }, - "venmo": { - "email_address": "email_address4", - "account_id": "account_id8", - "user_name": "user_name2", - "name": { - "given_name": "given_name2", - "surname": "surname8" - }, - "phone_number": { - "national_number": "national_number6" - } - } -} -``` - diff --git a/doc/models/order-authorize-response.md b/doc/models/order-authorize-response.md deleted file mode 100644 index 4744550..0000000 --- a/doc/models/order-authorize-response.md +++ /dev/null @@ -1,98 +0,0 @@ - -# Order Authorize Response - -## Structure - -`OrderAuthorizeResponse` - -## Fields - -| 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.
Note: The regular expression provides guidance but does not reject all invalid dates.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getCreateTime(): ?string | setCreateTime(?string createTime): void | -| `updateTime` | `?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.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getUpdateTime(): ?string | setUpdateTime(?string updateTime): void | -| `id` | `?string` | Optional | The ID of the order. | getId(): ?string | setId(?string id): void | -| `paymentSource` | [`?OrderAuthorizeResponsePaymentSource`](../../doc/models/order-authorize-response-payment-source.md) | Optional | The payment source used to fund the payment. | getPaymentSource(): ?OrderAuthorizeResponsePaymentSource | setPaymentSource(?OrderAuthorizeResponsePaymentSource paymentSource): void | -| `intent` | [`?string(CheckoutPaymentIntent)`](../../doc/models/checkout-payment-intent.md) | Optional | The intent to either capture payment immediately or authorize a payment for an order after order creation. | getIntent(): ?string | setIntent(?string intent): void | -| `processingInstruction` | [`?string(ProcessingInstruction)`](../../doc/models/processing-instruction.md) | Optional | The instruction to process an order.
**Default**: `ProcessingInstruction::NO_INSTRUCTION`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[0-9A-Z_]+$` | getProcessingInstruction(): ?string | setProcessingInstruction(?string processingInstruction): void | -| `payer` | [`?Payer`](../../doc/models/payer.md) | Optional | - | getPayer(): ?Payer | setPayer(?Payer payer): void | -| `purchaseUnits` | [`?(PurchaseUnit[])`](../../doc/models/purchase-unit.md) | Optional | An array of purchase units. Each purchase unit establishes a contract between a customer and merchant. Each purchase unit represents either a full or partial order that the customer intends to purchase from the merchant.
**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `10` | getPurchaseUnits(): ?array | setPurchaseUnits(?array purchaseUnits): void | -| `status` | [`?string(OrderStatus)`](../../doc/models/order-status.md) | Optional | The order status.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getStatus(): ?string | setStatus(?string status): void | -| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links) that are either relevant to the issue by providing additional information or offering potential resolutions.
**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `4` | getLinks(): ?array | setLinks(?array links): void | - -## Example (as JSON) - -```json -{ - "processing_instruction": "NO_INSTRUCTION", - "create_time": "create_time0", - "update_time": "update_time4", - "id": "id4", - "payment_source": { - "card": { - "name": "name6", - "last_digits": "last_digits0", - "brand": "SYNCHRONY", - "available_networks": [ - "DELTA" - ], - "type": "UNKNOWN" - }, - "paypal": { - "email_address": "email_address0", - "account_id": "account_id4", - "account_status": "VERIFIED", - "name": { - "given_name": "given_name2", - "surname": "surname8" - }, - "phone_type": "FAX" - }, - "apple_pay": { - "id": "id0", - "token": "token6", - "name": "name0", - "email_address": "email_address8", - "phone_number": { - "national_number": "national_number6" - } - }, - "google_pay": { - "name": "name8", - "email_address": "email_address6", - "phone_number": { - "country_code": "country_code2", - "national_number": "national_number6" - }, - "card": { - "name": "name6", - "last_digits": "last_digits0", - "type": "UNKNOWN", - "brand": "SYNCHRONY", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } - } - }, - "venmo": { - "email_address": "email_address4", - "account_id": "account_id8", - "user_name": "user_name2", - "name": { - "given_name": "given_name2", - "surname": "surname8" - }, - "phone_number": { - "national_number": "national_number6" - } - } - }, - "intent": "CAPTURE" -} -``` - diff --git a/doc/models/order-capture-request-payment-source.md b/doc/models/order-capture-request-payment-source.md deleted file mode 100644 index b12eb6b..0000000 --- a/doc/models/order-capture-request-payment-source.md +++ /dev/null @@ -1,109 +0,0 @@ - -# Order Capture Request Payment Source - -The payment source definition. - -## Structure - -`OrderCaptureRequestPaymentSource` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `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/pay-pal-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 | -| `googlePay` | [`?GooglePayRequest`](../../doc/models/google-pay-request.md) | Optional | Information needed to pay using Google Pay. | getGooglePay(): ?GooglePayRequest | setGooglePay(?GooglePayRequest googlePay): void | -| `venmo` | [`?VenmoWalletRequest`](../../doc/models/venmo-wallet-request.md) | Optional | Information needed to pay using Venmo. | getVenmo(): ?VenmoWalletRequest | setVenmo(?VenmoWalletRequest venmo): void | - -## Example (as JSON) - -```json -{ - "card": { - "name": "name6", - "number": "number6", - "expiry": "expiry4", - "security_code": "security_code8", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } - }, - "token": { - "id": "id6", - "type": "BILLING_AGREEMENT" - }, - "paypal": { - "vault_id": "vault_id0", - "email_address": "email_address0", - "name": { - "given_name": "given_name2", - "surname": "surname8" - }, - "phone": { - "phone_type": "OTHER", - "phone_number": { - "national_number": "national_number6" - } - }, - "birth_date": "birth_date8" - }, - "apple_pay": { - "id": "id0", - "name": "name0", - "email_address": "email_address8", - "phone_number": { - "national_number": "national_number6" - }, - "decrypted_token": { - "transaction_amount": { - "currency_code": "currency_code6", - "value": "value2" - }, - "tokenized_card": { - "name": "name4", - "number": "number2", - "expiry": "expiry2", - "card_type": "HIPER", - "type": "UNKNOWN" - }, - "device_manufacturer_id": "device_manufacturer_id6", - "payment_data_type": "3DSECURE", - "payment_data": { - "cryptogram": "cryptogram6", - "eci_indicator": "eci_indicator0", - "emv_data": "emv_data0", - "pin": "pin4" - } - } - }, - "google_pay": { - "name": "name8", - "email_address": "email_address6", - "phone_number": { - "country_code": "country_code2", - "national_number": "national_number6" - }, - "card": { - "key1": "val1", - "key2": "val2" - }, - "decrypted_token": { - "message_id": "message_id0", - "message_expiration": "message_expiration2", - "payment_method": "CARD", - "authentication_method": "PAN_ONLY", - "cryptogram": "cryptogram6", - "eci_indicator": "eci_indicator0" - } - } -} -``` - diff --git a/doc/models/order-capture-request.md b/doc/models/order-capture-request.md deleted file mode 100644 index e1a9589..0000000 --- a/doc/models/order-capture-request.md +++ /dev/null @@ -1,106 +0,0 @@ - -# Order Capture Request - -Completes an capture payment for an order. - -## Structure - -`OrderCaptureRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `paymentSource` | [`?OrderCaptureRequestPaymentSource`](../../doc/models/order-capture-request-payment-source.md) | Optional | The payment source definition. | getPaymentSource(): ?OrderCaptureRequestPaymentSource | setPaymentSource(?OrderCaptureRequestPaymentSource paymentSource): void | - -## Example (as JSON) - -```json -{ - "payment_source": { - "card": { - "name": "name6", - "number": "number6", - "expiry": "expiry4", - "security_code": "security_code8", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } - }, - "token": { - "id": "id6", - "type": "BILLING_AGREEMENT" - }, - "paypal": { - "vault_id": "vault_id0", - "email_address": "email_address0", - "name": { - "given_name": "given_name2", - "surname": "surname8" - }, - "phone": { - "phone_type": "OTHER", - "phone_number": { - "national_number": "national_number6" - } - }, - "birth_date": "birth_date8" - }, - "apple_pay": { - "id": "id0", - "name": "name0", - "email_address": "email_address8", - "phone_number": { - "national_number": "national_number6" - }, - "decrypted_token": { - "transaction_amount": { - "currency_code": "currency_code6", - "value": "value2" - }, - "tokenized_card": { - "name": "name4", - "number": "number2", - "expiry": "expiry2", - "card_type": "HIPER", - "type": "UNKNOWN" - }, - "device_manufacturer_id": "device_manufacturer_id6", - "payment_data_type": "3DSECURE", - "payment_data": { - "cryptogram": "cryptogram6", - "eci_indicator": "eci_indicator0", - "emv_data": "emv_data0", - "pin": "pin4" - } - } - }, - "google_pay": { - "name": "name8", - "email_address": "email_address6", - "phone_number": { - "country_code": "country_code2", - "national_number": "national_number6" - }, - "card": { - "key1": "val1", - "key2": "val2" - }, - "decrypted_token": { - "message_id": "message_id0", - "message_expiration": "message_expiration2", - "payment_method": "CARD", - "authentication_method": "PAN_ONLY", - "cryptogram": "cryptogram6", - "eci_indicator": "eci_indicator0" - } - } - } -} -``` - diff --git a/doc/models/order-confirm-application-context.md b/doc/models/order-confirm-application-context.md deleted file mode 100644 index 10778e0..0000000 --- a/doc/models/order-confirm-application-context.md +++ /dev/null @@ -1,41 +0,0 @@ - -# Order Confirm Application Context - -Customizes the payer confirmation experience. - -## Structure - -`OrderConfirmApplicationContext` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `brandName` | `?string` | Optional | Label to present to your payer as part of the PayPal hosted web experience.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127` | getBrandName(): ?string | setBrandName(?string brandName): void | -| `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/).
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `10`, *Pattern*: `^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}\|[0-9]{3}))?$` | getLocale(): ?string | setLocale(?string locale): void | -| `returnUrl` | `?string` | Optional | The URL where the customer is redirected after the customer approves the payment.
**Constraints**: *Minimum Length*: `10`, *Maximum Length*: `4000` | getReturnUrl(): ?string | setReturnUrl(?string returnUrl): void | -| `cancelUrl` | `?string` | Optional | The URL where the customer is redirected after the customer cancels the payment.
**Constraints**: *Minimum Length*: `10`, *Maximum Length*: `4000` | getCancelUrl(): ?string | setCancelUrl(?string cancelUrl): void | -| `storedPaymentSource` | [`?StoredPaymentSource`](../../doc/models/stored-payment-source.md) | Optional | 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).
Parameter compatibility:
| getStoredPaymentSource(): ?StoredPaymentSource | setStoredPaymentSource(?StoredPaymentSource storedPaymentSource): void | - -## Example (as JSON) - -```json -{ - "brand_name": "brand_name6", - "locale": "locale0", - "return_url": "return_url8", - "cancel_url": "cancel_url0", - "stored_payment_source": { - "payment_initiator": "CUSTOMER", - "payment_type": "RECURRING", - "usage": "FIRST", - "previous_network_transaction_reference": { - "id": "id6", - "date": "date2", - "network": "VISA", - "acquirer_reference_number": "acquirer_reference_number8" - } - } -} -``` - diff --git a/doc/models/order-request.md b/doc/models/order-request.md deleted file mode 100644 index 0988b81..0000000 --- a/doc/models/order-request.md +++ /dev/null @@ -1,190 +0,0 @@ - -# Order Request - -The order request details. - -## Structure - -`OrderRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `intent` | [`string(CheckoutPaymentIntent)`](../../doc/models/checkout-payment-intent.md) | Required | The intent to either capture payment immediately or authorize a payment for an order after order creation. | getIntent(): string | setIntent(string intent): void | -| `payer` | [`?Payer`](../../doc/models/payer.md) | Optional | - | getPayer(): ?Payer | setPayer(?Payer payer): void | -| `purchaseUnits` | [`PurchaseUnitRequest[]`](../../doc/models/purchase-unit-request.md) | Required | An array of purchase units. 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.
**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `10` | getPurchaseUnits(): array | setPurchaseUnits(array purchaseUnits): void | -| `paymentSource` | [`?PaymentSource`](../../doc/models/payment-source.md) | Optional | The payment source definition. | getPaymentSource(): ?PaymentSource | setPaymentSource(?PaymentSource paymentSource): 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) - -```json -{ - "intent": "CAPTURE", - "purchase_units": [ - { - "reference_id": "reference_id4", - "amount": { - "currency_code": "currency_code6", - "value": "value0", - "breakdown": { - "item_total": { - "currency_code": "currency_code0", - "value": "value6" - }, - "shipping": { - "currency_code": "currency_code0", - "value": "value6" - }, - "handling": { - "currency_code": "currency_code2", - "value": "value8" - }, - "tax_total": { - "currency_code": "currency_code4", - "value": "value0" - }, - "insurance": { - "currency_code": "currency_code2", - "value": "value8" - } - } - }, - "payee": { - "email_address": "email_address4", - "merchant_id": "merchant_id6" - }, - "payment_instruction": { - "platform_fees": [ - { - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "payee": { - "email_address": "email_address4", - "merchant_id": "merchant_id6" - } - }, - { - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "payee": { - "email_address": "email_address4", - "merchant_id": "merchant_id6" - } - }, - { - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "payee": { - "email_address": "email_address4", - "merchant_id": "merchant_id6" - } - } - ], - "disbursement_mode": "INSTANT", - "payee_pricing_tier_id": "payee_pricing_tier_id2", - "payee_receivable_fx_rate_id": "payee_receivable_fx_rate_id0" - }, - "description": "description6", - "custom_id": "custom_id4" - } - ], - "payer": { - "email_address": "email_address6", - "payer_id": "payer_id6", - "name": { - "given_name": "given_name2", - "surname": "surname8" - }, - "phone": { - "phone_type": "OTHER", - "phone_number": { - "national_number": "national_number6" - } - }, - "birth_date": "birth_date4" - }, - "payment_source": { - "card": { - "name": "name6", - "number": "number6", - "expiry": "expiry4", - "security_code": "security_code8", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } - }, - "token": { - "id": "id6", - "type": "BILLING_AGREEMENT" - }, - "paypal": { - "vault_id": "vault_id0", - "email_address": "email_address0", - "name": { - "given_name": "given_name2", - "surname": "surname8" - }, - "phone": { - "phone_type": "OTHER", - "phone_number": { - "national_number": "national_number6" - } - }, - "birth_date": "birth_date8" - }, - "bancontact": { - "name": "name0", - "country_code": "country_code0", - "experience_context": { - "brand_name": "brand_name2", - "locale": "locale6", - "shipping_preference": "NO_SHIPPING", - "return_url": "return_url4", - "cancel_url": "cancel_url6" - } - }, - "blik": { - "name": "name2", - "country_code": "country_code2", - "email": "email4", - "experience_context": { - "brand_name": "brand_name2", - "locale": "locale6", - "shipping_preference": "NO_SHIPPING", - "return_url": "return_url4", - "cancel_url": "cancel_url6" - }, - "level_0": { - "auth_code": "auth_code8" - }, - "one_click": { - "auth_code": "auth_code0", - "consumer_reference": "consumer_reference2", - "alias_label": "alias_label6", - "alias_key": "alias_key4" - } - } - }, - "application_context": { - "brand_name": "brand_name8", - "locale": "locale2", - "landing_page": "BILLING", - "shipping_preference": "SET_PROVIDED_ADDRESS", - "user_action": "CONTINUE" - } -} -``` - diff --git a/doc/models/order-status.md b/doc/models/order-status.md deleted file mode 100644 index 64f7c6f..0000000 --- a/doc/models/order-status.md +++ /dev/null @@ -1,20 +0,0 @@ - -# Order Status - -The order status. - -## Enumeration - -`OrderStatus` - -## Fields - -| Name | -| --- | -| `CREATED` | -| `SAVED` | -| `APPROVED` | -| `VOIDED` | -| `COMPLETED` | -| `PAYER_ACTION_REQUIRED` | - diff --git a/doc/models/order-tracker-item.md b/doc/models/order-tracker-item.md deleted file mode 100644 index 4ff5d1c..0000000 --- a/doc/models/order-tracker-item.md +++ /dev/null @@ -1,32 +0,0 @@ - -# Order Tracker Item - -The details of the items in the shipment. - -## Structure - -`OrderTrackerItem` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `?string` | Optional | The item name or title.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127` | getName(): ?string | setName(?string name): void | -| `quantity` | `?string` | Optional | The item quantity. Must be a whole number.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `10`, *Pattern*: `^[1-9][0-9]{0,9}$` | getQuantity(): ?string | setQuantity(?string quantity): void | -| `sku` | `?string` | Optional | The stock keeping unit (SKU) for the item. This can contain unicode characters.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127` | getSku(): ?string | setSku(?string sku): void | -| `url` | `?string` | Optional | The URL to the item being purchased. Visible to buyer and used in buyer experiences.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2048` | getUrl(): ?string | setUrl(?string url): void | -| `imageUrl` | `?string` | Optional | The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2048`, *Pattern*: `^(https:)([/\|.\|\w\|\s\|-])*\.(?:jpg\|gif\|png\|jpeg\|JPG\|GIF\|PNG\|JPEG)` | getImageUrl(): ?string | setImageUrl(?string imageUrl): void | -| `upc` | [`?UniversalProductCode`](../../doc/models/universal-product-code.md) | Optional | The Universal Product Code of the item. | getUpc(): ?UniversalProductCode | setUpc(?UniversalProductCode upc): void | - -## Example (as JSON) - -```json -{ - "name": "name6", - "quantity": "quantity2", - "sku": "sku2", - "url": "url0", - "image_url": "image_url2" -} -``` - diff --git a/doc/models/order-tracker-request.md b/doc/models/order-tracker-request.md deleted file mode 100644 index 6d651c6..0000000 --- a/doc/models/order-tracker-request.md +++ /dev/null @@ -1,48 +0,0 @@ - -# Order Tracker Request - -The tracking details of an order. - -## Structure - -`OrderTrackerRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `trackingNumber` | `?string` | Optional | The tracking number for the shipment. This property supports Unicode.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64` | getTrackingNumber(): ?string | setTrackingNumber(?string trackingNumber): void | -| `carrier` | [`?string(ShipmentCarrier)`](../../doc/models/shipment-carrier.md) | Optional | 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.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64`, *Pattern*: `^[0-9A-Z_]+$` | getCarrier(): ?string | setCarrier(?string carrier): void | -| `carrierNameOther` | `?string` | Optional | The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER. This property supports Unicode.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64` | getCarrierNameOther(): ?string | setCarrierNameOther(?string carrierNameOther): void | -| `captureId` | `string` | Required | The PayPal capture ID.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `50`, *Pattern*: `^[a-zA-Z0-9]*$` | getCaptureId(): string | setCaptureId(string captureId): void | -| `notifyPayer` | `?bool` | Optional | 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.
**Default**: `false` | getNotifyPayer(): ?bool | setNotifyPayer(?bool notifyPayer): void | -| `items` | [`?(OrderTrackerItem[])`](../../doc/models/order-tracker-item.md) | Optional | An array of details of items in the shipment. | getItems(): ?array | setItems(?array items): void | - -## Example (as JSON) - -```json -{ - "capture_id": "capture_id0", - "notify_payer": false, - "tracking_number": "tracking_number6", - "carrier": "SNTGLOBAL_API", - "carrier_name_other": "carrier_name_other0", - "items": [ - { - "name": "name8", - "quantity": "quantity4", - "sku": "sku6", - "url": "url2", - "image_url": "image_url4" - }, - { - "name": "name8", - "quantity": "quantity4", - "sku": "sku6", - "url": "url2", - "image_url": "image_url4" - } - ] -} -``` - diff --git a/doc/models/order-tracker-response.md b/doc/models/order-tracker-response.md deleted file mode 100644 index 6f7f370..0000000 --- a/doc/models/order-tracker-response.md +++ /dev/null @@ -1,63 +0,0 @@ - -# Order Tracker Response - -The tracking response on creation of tracker. - -## Structure - -`OrderTrackerResponse` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `id` | `?string` | Optional | The tracker id. | getId(): ?string | setId(?string id): void | -| `status` | [`?string(OrderTrackerStatus)`](../../doc/models/order-tracker-status.md) | Optional | The status of the item shipment.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64`, *Pattern*: `^[0-9A-Z_]+$` | getStatus(): ?string | setStatus(?string status): void | -| `items` | [`?(OrderTrackerItem[])`](../../doc/models/order-tracker-item.md) | Optional | An array of details of items in the shipment. | getItems(): ?array | setItems(?array items): void | -| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of request-related 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.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getCreateTime(): ?string | setCreateTime(?string createTime): void | -| `updateTime` | `?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.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getUpdateTime(): ?string | setUpdateTime(?string updateTime): void | - -## Example (as JSON) - -```json -{ - "id": "id2", - "status": "CANCELLED", - "items": [ - { - "name": "name8", - "quantity": "quantity4", - "sku": "sku6", - "url": "url2", - "image_url": "image_url4" - }, - { - "name": "name8", - "quantity": "quantity4", - "sku": "sku6", - "url": "url2", - "image_url": "image_url4" - } - ], - "links": [ - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - }, - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - }, - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - } - ], - "create_time": "create_time8" -} -``` - diff --git a/doc/models/order-tracker-status.md b/doc/models/order-tracker-status.md deleted file mode 100644 index ce13a7a..0000000 --- a/doc/models/order-tracker-status.md +++ /dev/null @@ -1,16 +0,0 @@ - -# Order Tracker Status - -The status of the item shipment. - -## Enumeration - -`OrderTrackerStatus` - -## Fields - -| Name | -| --- | -| `CANCELLED` | -| `SHIPPED` | - diff --git a/doc/models/order.md b/doc/models/order.md deleted file mode 100644 index 23e3c07..0000000 --- a/doc/models/order.md +++ /dev/null @@ -1,77 +0,0 @@ - -# Order - -The order details. - -## Structure - -`Order` - -## Fields - -| 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.
Note: The regular expression provides guidance but does not reject all invalid dates.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getCreateTime(): ?string | setCreateTime(?string createTime): void | -| `updateTime` | `?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.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getUpdateTime(): ?string | setUpdateTime(?string updateTime): void | -| `id` | `?string` | Optional | The ID of the order. | getId(): ?string | setId(?string id): void | -| `paymentSource` | [`?PaymentSourceResponse`](../../doc/models/payment-source-response.md) | Optional | The payment source used to fund the payment. | getPaymentSource(): ?PaymentSourceResponse | setPaymentSource(?PaymentSourceResponse paymentSource): void | -| `intent` | [`?string(CheckoutPaymentIntent)`](../../doc/models/checkout-payment-intent.md) | Optional | The intent to either capture payment immediately or authorize a payment for an order after order creation. | getIntent(): ?string | setIntent(?string intent): void | -| `processingInstruction` | [`?string(ProcessingInstruction)`](../../doc/models/processing-instruction.md) | Optional | The instruction to process an order.
**Default**: `ProcessingInstruction::NO_INSTRUCTION`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[0-9A-Z_]+$` | getProcessingInstruction(): ?string | setProcessingInstruction(?string processingInstruction): void | -| `payer` | [`?Payer`](../../doc/models/payer.md) | Optional | - | getPayer(): ?Payer | setPayer(?Payer payer): void | -| `purchaseUnits` | [`?(PurchaseUnit[])`](../../doc/models/purchase-unit.md) | Optional | An array of purchase units. Each purchase unit establishes a contract between a customer and merchant. Each purchase unit represents either a full or partial order that the customer intends to purchase from the merchant.
**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `10` | getPurchaseUnits(): ?array | setPurchaseUnits(?array purchaseUnits): void | -| `status` | [`?string(OrderStatus)`](../../doc/models/order-status.md) | Optional | The order status.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getStatus(): ?string | setStatus(?string status): void | -| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of request-related HATEOAS links. To complete payer approval, use the `approve` link to redirect the payer. The API caller has 3 hours (default setting, this which can be changed by your account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, to redirect your payer. Once redirected, the API caller has 3 hours for the payer to approve the order and either authorize or capture the order. If you are not using the PayPal JavaScript SDK to initiate PayPal Checkout (in context) ensure that you include `application_context.return_url` is specified or you will get "We're sorry, Things don't appear to be working at the moment" after the payer approves the payment. | getLinks(): ?array | setLinks(?array links): void | - -## Example (as JSON) - -```json -{ - "processing_instruction": "NO_INSTRUCTION", - "create_time": "create_time8", - "update_time": "update_time4", - "id": "id2", - "payment_source": { - "card": { - "name": "name6", - "last_digits": "last_digits0", - "brand": "SYNCHRONY", - "available_networks": [ - "DELTA" - ], - "type": "UNKNOWN" - }, - "paypal": { - "email_address": "email_address0", - "account_id": "account_id4", - "account_status": "VERIFIED", - "name": { - "given_name": "given_name2", - "surname": "surname8" - }, - "phone_type": "FAX" - }, - "bancontact": { - "name": "name0", - "country_code": "country_code0", - "bic": "bic2", - "iban_last_chars": "iban_last_chars8", - "card_last_digits": "card_last_digits4" - }, - "blik": { - "name": "name2", - "country_code": "country_code2", - "email": "email4", - "one_click": { - "consumer_reference": "consumer_reference2" - } - }, - "eps": { - "name": "name6", - "country_code": "country_code6", - "bic": "bic8" - } - }, - "intent": "CAPTURE" -} -``` - diff --git a/doc/models/p24-payment-object.md b/doc/models/p24-payment-object.md deleted file mode 100644 index caad8dd..0000000 --- a/doc/models/p24-payment-object.md +++ /dev/null @@ -1,32 +0,0 @@ - -# P24 Payment Object - -Information used to pay using P24(Przelewy24). - -## Structure - -`P24PaymentObject` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `?string` | Optional | The full name representation like Mr J Smith.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): ?string | setName(?string name): void | -| `email` | `?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.

**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: `^(?:[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\|\[(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?\|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$` | getEmail(): ?string | setEmail(?string email): void | -| `countryCode` | `?string` | Optional | 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 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.

**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): ?string | setCountryCode(?string countryCode): void | -| `paymentDescriptor` | `?string` | Optional | P24 generated payment description.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2000` | getPaymentDescriptor(): ?string | setPaymentDescriptor(?string paymentDescriptor): void | -| `methodId` | `?string` | Optional | Numeric identifier of the payment scheme or bank used for the payment.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `300` | getMethodId(): ?string | setMethodId(?string methodId): void | -| `methodDescription` | `?string` | Optional | Friendly name of the payment scheme or bank used for the payment.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2000` | getMethodDescription(): ?string | setMethodDescription(?string methodDescription): void | - -## Example (as JSON) - -```json -{ - "name": "name4", - "email": "email2", - "country_code": "country_code4", - "payment_descriptor": "payment_descriptor8", - "method_id": "method_id8" -} -``` - diff --git a/doc/models/p24-payment-request.md b/doc/models/p24-payment-request.md deleted file mode 100644 index 9ddf73b..0000000 --- a/doc/models/p24-payment-request.md +++ /dev/null @@ -1,35 +0,0 @@ - -# P24 Payment Request - -Information needed to pay using P24 (Przelewy24). - -## Structure - -`P24PaymentRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `string` | Required | The full name representation like Mr J Smith.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): string | setName(string name): void | -| `email` | `string` | Required | 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.

**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: `^(?:[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\|\[(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?\|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$` | getEmail(): string | setEmail(string email): void | -| `countryCode` | `string` | Required | 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 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.

**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): string | setCountryCode(string countryCode): void | -| `experienceContext` | [`?ExperienceContext`](../../doc/models/experience-context.md) | Optional | Customizes the payer experience during the approval process for the payment. | getExperienceContext(): ?ExperienceContext | setExperienceContext(?ExperienceContext experienceContext): void | - -## Example (as JSON) - -```json -{ - "name": "name6", - "email": "email0", - "country_code": "country_code6", - "experience_context": { - "brand_name": "brand_name2", - "locale": "locale6", - "shipping_preference": "NO_SHIPPING", - "return_url": "return_url4", - "cancel_url": "cancel_url6" - } -} -``` - diff --git a/doc/models/pa-res-status.md b/doc/models/pa-res-status.md deleted file mode 100644 index f1a5579..0000000 --- a/doc/models/pa-res-status.md +++ /dev/null @@ -1,22 +0,0 @@ - -# PA Res Status - -Transactions status result identifier. The outcome of the issuer's authentication. - -## Enumeration - -`PAResStatus` - -## Fields - -| Name | -| --- | -| `Y` | -| `N` | -| `U` | -| `A` | -| `C` | -| `R` | -| `D` | -| `I` | - diff --git a/doc/models/patch-op.md b/doc/models/patch-op.md deleted file mode 100644 index e8ec8f7..0000000 --- a/doc/models/patch-op.md +++ /dev/null @@ -1,20 +0,0 @@ - -# Patch Op - -The operation. - -## Enumeration - -`PatchOp` - -## Fields - -| Name | -| --- | -| `ADD` | -| `REMOVE` | -| `REPLACE` | -| `MOVE` | -| `COPY` | -| `TEST` | - diff --git a/doc/models/patch.md b/doc/models/patch.md deleted file mode 100644 index 337ed84..0000000 --- a/doc/models/patch.md +++ /dev/null @@ -1,32 +0,0 @@ - -# Patch - -The JSON patch object to apply partial updates to resources. - -## Structure - -`Patch` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `op` | [`string(PatchOp)`](../../doc/models/patch-op.md) | Required | The operation. | getOp(): string | setOp(string op): 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) - -```json -{ - "op": "add", - "path": "path6", - "value": { - "key1": "val1", - "key2": "val2" - }, - "from": "from0" -} -``` - diff --git a/doc/models/pay-pal-experience-landing-page.md b/doc/models/pay-pal-experience-landing-page.md deleted file mode 100644 index 76138a3..0000000 --- a/doc/models/pay-pal-experience-landing-page.md +++ /dev/null @@ -1,17 +0,0 @@ - -# Pay Pal Experience Landing Page - -The type of landing page to show on the PayPal site for customer checkout. - -## Enumeration - -`PayPalExperienceLandingPage` - -## Fields - -| Name | -| --- | -| `LOGIN` | -| `GUEST_CHECKOUT` | -| `NO_PREFERENCE` | - diff --git a/doc/models/pay-pal-experience-user-action.md b/doc/models/pay-pal-experience-user-action.md deleted file mode 100644 index 49906d0..0000000 --- a/doc/models/pay-pal-experience-user-action.md +++ /dev/null @@ -1,16 +0,0 @@ - -# Pay Pal Experience User Action - -Configures a Continue or Pay Now checkout flow. - -## Enumeration - -`PayPalExperienceUserAction` - -## Fields - -| Name | -| --- | -| `CONTINUE_` | -| `PAY_NOW` | - diff --git a/doc/models/pay-pal-payment-token-customer-type.md b/doc/models/pay-pal-payment-token-customer-type.md deleted file mode 100644 index 1496795..0000000 --- a/doc/models/pay-pal-payment-token-customer-type.md +++ /dev/null @@ -1,16 +0,0 @@ - -# Pay Pal Payment Token Customer Type - -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. - -## Enumeration - -`PayPalPaymentTokenCustomerType` - -## Fields - -| Name | -| --- | -| `CONSUMER` | -| `BUSINESS` | - diff --git a/doc/models/pay-pal-payment-token-usage-pattern.md b/doc/models/pay-pal-payment-token-usage-pattern.md deleted file mode 100644 index ff90cbb..0000000 --- a/doc/models/pay-pal-payment-token-usage-pattern.md +++ /dev/null @@ -1,20 +0,0 @@ - -# Pay Pal Payment Token Usage Pattern - -Expected business/pricing model for the billing agreement. - -## Enumeration - -`PayPalPaymentTokenUsagePattern` - -## Fields - -| Name | -| --- | -| `IMMEDIATE` | -| `DEFERRED` | -| `RECURRING_PREPAID` | -| `RECURRING_POSTPAID` | -| `THRESHOLD_PREPAID` | -| `THRESHOLD_POSTPAID` | - diff --git a/doc/models/pay-pal-payment-token-usage-type.md b/doc/models/pay-pal-payment-token-usage-type.md deleted file mode 100644 index c725536..0000000 --- a/doc/models/pay-pal-payment-token-usage-type.md +++ /dev/null @@ -1,16 +0,0 @@ - -# Pay Pal Payment Token Usage Type - -The usage type associated with the PayPal payment token. - -## Enumeration - -`PayPalPaymentTokenUsageType` - -## Fields - -| Name | -| --- | -| `MERCHANT` | -| `PLATFORM` | - diff --git a/doc/models/pay-pal-payment-token.md b/doc/models/pay-pal-payment-token.md deleted file mode 100644 index 4cc5b20..0000000 --- a/doc/models/pay-pal-payment-token.md +++ /dev/null @@ -1,49 +0,0 @@ - -# Pay Pal Payment Token - -## Structure - -`PayPalPaymentToken` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `description` | `?string` | Optional | The description displayed to the consumer on the approval flow for a digital wallet, as well as on the merchant view of the payment token management experience. exp: PayPal.com.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128`, *Pattern*: `^.*$` | getDescription(): ?string | setDescription(?string description): void | -| `shipping` | [`?VaultedDigitalWalletShippingDetails`](../../doc/models/vaulted-digital-wallet-shipping-details.md) | Optional | The shipping details. | getShipping(): ?VaultedDigitalWalletShippingDetails | setShipping(?VaultedDigitalWalletShippingDetails shipping): void | -| `permitMultiplePaymentTokens` | `?bool` | Optional | Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same PayPal account. This only applies to PayPal payment source.
**Default**: `false` | getPermitMultiplePaymentTokens(): ?bool | setPermitMultiplePaymentTokens(?bool permitMultiplePaymentTokens): void | -| `usageType` | `?string` | Optional | The usage type associated with a digital wallet payment token.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getUsageType(): ?string | setUsageType(?string usageType): void | -| `customerType` | `?string` | Optional | 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.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getCustomerType(): ?string | setCustomerType(?string customerType): 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.

**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: `(?:[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\|\[(?:(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9])\|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void | -| `payerId` | `?string` | Optional | The account identifier for a PayPal account.
**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `13`, *Pattern*: `^[2-9A-HJ-NP-Z]{13}$` | getPayerId(): ?string | setPayerId(?string payerId): void | -| `name` | [`?Name`](../../doc/models/name.md) | Optional | The name of the party. | getName(): ?Name | setName(?Name name): void | -| `phone` | [`?PhoneWithType`](../../doc/models/phone-with-type.md) | Optional | The phone information. | getPhone(): ?PhoneWithType | setPhone(?PhoneWithType phone): void | -| `address` | [`?Address`](../../doc/models/address.md) | Optional | 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). | getAddress(): ?Address | setAddress(?Address address): void | -| `accountId` | `?string` | Optional | The account identifier for a PayPal account.
**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `13`, *Pattern*: `^[2-9A-HJ-NP-Z]{13}$` | getAccountId(): ?string | setAccountId(?string accountId): void | -| `phoneNumber` | [`?Phone`](../../doc/models/phone.md) | Optional | The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). | getPhoneNumber(): ?Phone | setPhoneNumber(?Phone phoneNumber): void | - -## Example (as JSON) - -```json -{ - "permit_multiple_payment_tokens": false, - "description": "description6", - "shipping": { - "name": { - "full_name": "full_name6" - }, - "type": "SHIPPING", - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - } - }, - "usage_type": "usage_type6", - "customer_type": "customer_type0" -} -``` - diff --git a/doc/models/pay-pal-wallet-account-verification-status.md b/doc/models/pay-pal-wallet-account-verification-status.md deleted file mode 100644 index 1d3724b..0000000 --- a/doc/models/pay-pal-wallet-account-verification-status.md +++ /dev/null @@ -1,16 +0,0 @@ - -# Pay Pal Wallet Account Verification Status - -The account status indicates whether the buyer has verified the financial details associated with their PayPal account. - -## Enumeration - -`PayPalWalletAccountVerificationStatus` - -## Fields - -| Name | -| --- | -| `VERIFIED` | -| `UNVERIFIED` | - diff --git a/doc/models/pay-pal-wallet-attributes-response.md b/doc/models/pay-pal-wallet-attributes-response.md deleted file mode 100644 index 1ef7513..0000000 --- a/doc/models/pay-pal-wallet-attributes-response.md +++ /dev/null @@ -1,75 +0,0 @@ - -# Pay Pal Wallet Attributes Response - -Additional attributes associated with the use of a PayPal Wallet. - -## Structure - -`PayPalWalletAttributesResponse` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `vault` | [`?PayPalWalletVaultResponse`](../../doc/models/pay-pal-wallet-vault-response.md) | Optional | The details about a saved PayPal Wallet payment source. | getVault(): ?PayPalWalletVaultResponse | setVault(?PayPalWalletVaultResponse vault): void | -| `cobrandedCards` | [`?(CobrandedCard[])`](../../doc/models/cobranded-card.md) | Optional | An array of merchant cobranded cards used by buyer to complete an order. This array will be present if a merchant has onboarded their cobranded card with PayPal and provided corresponding label(s).
**Constraints**: *Minimum Items*: `0`, *Maximum Items*: `25` | getCobrandedCards(): ?array | setCobrandedCards(?array cobrandedCards): void | - -## Example (as JSON) - -```json -{ - "vault": { - "id": "id6", - "status": "APPROVED", - "links": [ - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - } - ], - "customer": { - "id": "id0", - "email_address": "email_address2", - "phone": { - "phone_type": "OTHER", - "phone_number": { - "national_number": "national_number6" - } - }, - "merchant_customer_id": "merchant_customer_id2" - } - }, - "cobranded_cards": [ - { - "labels": [ - "labels4", - "labels3" - ], - "payee": { - "email_address": "email_address4", - "merchant_id": "merchant_id6" - }, - "amount": { - "currency_code": "currency_code6", - "value": "value0" - } - }, - { - "labels": [ - "labels4", - "labels3" - ], - "payee": { - "email_address": "email_address4", - "merchant_id": "merchant_id6" - }, - "amount": { - "currency_code": "currency_code6", - "value": "value0" - } - } - ] -} -``` - diff --git a/doc/models/pay-pal-wallet-attributes.md b/doc/models/pay-pal-wallet-attributes.md deleted file mode 100644 index 68a20d5..0000000 --- a/doc/models/pay-pal-wallet-attributes.md +++ /dev/null @@ -1,42 +0,0 @@ - -# Pay Pal Wallet Attributes - -Additional attributes associated with the use of this PayPal Wallet. - -## Structure - -`PayPalWalletAttributes` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `customer` | [`?PayPalWalletCustomerRequest`](../../doc/models/pay-pal-wallet-customer-request.md) | Optional | - | getCustomer(): ?PayPalWalletCustomerRequest | setCustomer(?PayPalWalletCustomerRequest customer): void | -| `vault` | [`?PayPalWalletVaultInstruction`](../../doc/models/pay-pal-wallet-vault-instruction.md) | Optional | - | getVault(): ?PayPalWalletVaultInstruction | setVault(?PayPalWalletVaultInstruction vault): void | - -## Example (as JSON) - -```json -{ - "customer": { - "id": "id0", - "email_address": "email_address2", - "phone": { - "phone_type": "OTHER", - "phone_number": { - "national_number": "national_number6" - } - }, - "merchant_customer_id": "merchant_customer_id2" - }, - "vault": { - "store_in_vault": "ON_SUCCESS", - "description": "description6", - "usage_pattern": "THRESHOLD_PREPAID", - "usage_type": "MERCHANT", - "customer_type": "CONSUMER", - "permit_multiple_payment_tokens": false - } -} -``` - diff --git a/doc/models/pay-pal-wallet-customer-request.md b/doc/models/pay-pal-wallet-customer-request.md deleted file mode 100644 index d07019e..0000000 --- a/doc/models/pay-pal-wallet-customer-request.md +++ /dev/null @@ -1,32 +0,0 @@ - -# Pay Pal Wallet Customer Request - -## Structure - -`PayPalWalletCustomerRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `id` | `?string` | Optional | The unique ID for a customer generated by PayPal.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `22`, *Pattern*: `^[0-9a-zA-Z_-]+$` | getId(): ?string | setId(?string id): 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.

**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: `(?:[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\|\[(?:(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9])\|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void | -| `phone` | [`?PhoneWithType`](../../doc/models/phone-with-type.md) | Optional | The phone information. | getPhone(): ?PhoneWithType | setPhone(?PhoneWithType phone): void | -| `merchantCustomerId` | `?string` | Optional | 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.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64`, *Pattern*: `^[0-9a-zA-Z-_.^*$@#]+$` | getMerchantCustomerId(): ?string | setMerchantCustomerId(?string merchantCustomerId): void | - -## Example (as JSON) - -```json -{ - "id": "id2", - "email_address": "email_address0", - "phone": { - "phone_type": "OTHER", - "phone_number": { - "national_number": "national_number6" - } - }, - "merchant_customer_id": "merchant_customer_id4" -} -``` - diff --git a/doc/models/pay-pal-wallet-customer.md b/doc/models/pay-pal-wallet-customer.md deleted file mode 100644 index 817e3c9..0000000 --- a/doc/models/pay-pal-wallet-customer.md +++ /dev/null @@ -1,34 +0,0 @@ - -# Pay Pal Wallet Customer - -The details about a customer in PayPal's system of record. - -## Structure - -`PayPalWalletCustomer` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `id` | `?string` | Optional | The unique ID for a customer generated by PayPal.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `22`, *Pattern*: `^[0-9a-zA-Z_-]+$` | getId(): ?string | setId(?string id): 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.

**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: `(?:[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\|\[(?:(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9])\|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void | -| `phone` | [`?PhoneWithType`](../../doc/models/phone-with-type.md) | Optional | The phone information. | getPhone(): ?PhoneWithType | setPhone(?PhoneWithType phone): void | -| `merchantCustomerId` | `?string` | Optional | 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.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64`, *Pattern*: `^[0-9a-zA-Z-_.^*$@#]+$` | getMerchantCustomerId(): ?string | setMerchantCustomerId(?string merchantCustomerId): void | - -## Example (as JSON) - -```json -{ - "id": "id8", - "email_address": "email_address4", - "phone": { - "phone_type": "OTHER", - "phone_number": { - "national_number": "national_number6" - } - }, - "merchant_customer_id": "merchant_customer_id0" -} -``` - diff --git a/doc/models/pay-pal-wallet-experience-context.md b/doc/models/pay-pal-wallet-experience-context.md deleted file mode 100644 index 15bb43a..0000000 --- a/doc/models/pay-pal-wallet-experience-context.md +++ /dev/null @@ -1,37 +0,0 @@ - -# Pay Pal Wallet Experience Context - -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 - -`PayPalWalletExperienceContext` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `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.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127`, *Pattern*: `^.*$` | getBrandName(): ?string | setBrandName(?string brandName): void | -| `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/).
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `10`, *Pattern*: `^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}\|[0-9]{3}))?$` | getLocale(): ?string | setLocale(?string locale): void | -| `shippingPreference` | [`?string(ShippingPreference)`](../../doc/models/shipping-preference.md) | Optional | The location from which the shipping address is derived.
**Default**: `ShippingPreference::GET_FROM_FILE`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `24`, *Pattern*: `^[A-Z_]+$` | getShippingPreference(): ?string | setShippingPreference(?string shippingPreference): void | -| `returnUrl` | `?string` | Optional | Describes the URL. | getReturnUrl(): ?string | setReturnUrl(?string returnUrl): void | -| `cancelUrl` | `?string` | Optional | Describes the URL. | getCancelUrl(): ?string | setCancelUrl(?string cancelUrl): void | -| `landingPage` | [`?string(PayPalExperienceLandingPage)`](../../doc/models/pay-pal-experience-landing-page.md) | Optional | The type of landing page to show on the PayPal site for customer checkout.
**Default**: `PayPalExperienceLandingPage::NO_PREFERENCE`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `13`, *Pattern*: `^[0-9A-Z_]+$` | getLandingPage(): ?string | setLandingPage(?string landingPage): void | -| `userAction` | [`?string(PayPalExperienceUserAction)`](../../doc/models/pay-pal-experience-user-action.md) | Optional | Configures a Continue or Pay Now checkout flow.
**Default**: `PayPalExperienceUserAction::CONTINUE_`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `8`, *Pattern*: `^[0-9A-Z_]+$` | getUserAction(): ?string | setUserAction(?string userAction): void | -| `paymentMethodPreference` | [`?string(PayeePaymentMethodPreference)`](../../doc/models/payee-payment-method-preference.md) | Optional | The merchant-preferred payment methods.
**Default**: `PayeePaymentMethodPreference::UNRESTRICTED`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getPaymentMethodPreference(): ?string | setPaymentMethodPreference(?string paymentMethodPreference): void | - -## Example (as JSON) - -```json -{ - "shipping_preference": "GET_FROM_FILE", - "landing_page": "NO_PREFERENCE", - "user_action": "CONTINUE", - "payment_method_preference": "UNRESTRICTED", - "brand_name": "brand_name6", - "locale": "locale0", - "return_url": "return_url8", - "cancel_url": "cancel_url0" -} -``` - diff --git a/doc/models/pay-pal-wallet-response.md b/doc/models/pay-pal-wallet-response.md deleted file mode 100644 index 5cac99e..0000000 --- a/doc/models/pay-pal-wallet-response.md +++ /dev/null @@ -1,39 +0,0 @@ - -# Pay Pal Wallet Response - -The PayPal Wallet response. - -## Structure - -`PayPalWalletResponse` - -## Fields - -| 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.

**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: `(?:[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\|\[(?:(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9])\|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void | -| `accountId` | `?string` | Optional | The PayPal payer ID, which is a masked version of the PayPal account number intended for use with third parties. The account number is reversibly encrypted and a proprietary variant of Base32 is used to encode the result.
**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `13`, *Pattern*: `^[2-9A-HJ-NP-Z]{13}$` | getAccountId(): ?string | setAccountId(?string accountId): void | -| `accountStatus` | [`?string(PayPalWalletAccountVerificationStatus)`](../../doc/models/pay-pal-wallet-account-verification-status.md) | Optional | The account status indicates whether the buyer has verified the financial details associated with their PayPal account.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getAccountStatus(): ?string | setAccountStatus(?string accountStatus): void | -| `name` | [`?Name`](../../doc/models/name.md) | Optional | The name of the party. | getName(): ?Name | setName(?Name name): void | -| `phoneType` | [`?string(PhoneType)`](../../doc/models/phone-type.md) | Optional | The phone type. | getPhoneType(): ?string | setPhoneType(?string phoneType): void | -| `phoneNumber` | [`?PhoneNumber`](../../doc/models/phone-number.md) | Optional | The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). | getPhoneNumber(): ?PhoneNumber | setPhoneNumber(?PhoneNumber phoneNumber): void | -| `birthDate` | `?string` | Optional | 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.
**Constraints**: *Minimum Length*: `10`, *Maximum Length*: `10`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])$` | getBirthDate(): ?string | setBirthDate(?string birthDate): void | -| `taxInfo` | [`?TaxInfo`](../../doc/models/tax-info.md) | Optional | The tax ID of the customer. The customer is also known as the payer. Both `tax_id` and `tax_id_type` are required. | getTaxInfo(): ?TaxInfo | setTaxInfo(?TaxInfo taxInfo): void | -| `address` | [`?Address`](../../doc/models/address.md) | Optional | 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). | getAddress(): ?Address | setAddress(?Address address): void | -| `attributes` | [`?PayPalWalletAttributesResponse`](../../doc/models/pay-pal-wallet-attributes-response.md) | Optional | Additional attributes associated with the use of a PayPal Wallet. | getAttributes(): ?PayPalWalletAttributesResponse | setAttributes(?PayPalWalletAttributesResponse attributes): void | - -## Example (as JSON) - -```json -{ - "email_address": "email_address8", - "account_id": "account_id2", - "account_status": "VERIFIED", - "name": { - "given_name": "given_name2", - "surname": "surname8" - }, - "phone_type": "OTHER" -} -``` - diff --git a/doc/models/pay-pal-wallet-vault-instruction.md b/doc/models/pay-pal-wallet-vault-instruction.md deleted file mode 100644 index 1702506..0000000 --- a/doc/models/pay-pal-wallet-vault-instruction.md +++ /dev/null @@ -1,31 +0,0 @@ - -# Pay Pal Wallet Vault Instruction - -## Structure - -`PayPalWalletVaultInstruction` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `storeInVault` | [`?string(StoreInVaultInstruction)`](../../doc/models/store-in-vault-instruction.md) | Optional | Defines how and when the payment source gets vaulted.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getStoreInVault(): ?string | setStoreInVault(?string storeInVault): void | -| `description` | `?string` | Optional | The description displayed to PayPal consumer on the approval flow for PayPal, as well as on the PayPal payment token management experience on PayPal.com.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128` | getDescription(): ?string | setDescription(?string description): void | -| `usagePattern` | [`?string(PayPalPaymentTokenUsagePattern)`](../../doc/models/pay-pal-payment-token-usage-pattern.md) | Optional | Expected business/pricing model for the billing agreement.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `30` | getUsagePattern(): ?string | setUsagePattern(?string usagePattern): void | -| `usageType` | [`string(PayPalPaymentTokenUsageType)`](../../doc/models/pay-pal-payment-token-usage-type.md) | Required | The usage type associated with the PayPal payment token.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getUsageType(): string | setUsageType(string usageType): void | -| `customerType` | [`?string(PayPalPaymentTokenCustomerType)`](../../doc/models/pay-pal-payment-token-customer-type.md) | Optional | 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.
**Default**: `PayPalPaymentTokenCustomerType::CONSUMER`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getCustomerType(): ?string | setCustomerType(?string customerType): void | -| `permitMultiplePaymentTokens` | `?bool` | Optional | Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same PayPal account. This only applies to PayPal payment source.
**Default**: `false` | getPermitMultiplePaymentTokens(): ?bool | setPermitMultiplePaymentTokens(?bool permitMultiplePaymentTokens): void | - -## Example (as JSON) - -```json -{ - "usage_type": "MERCHANT", - "customer_type": "CONSUMER", - "permit_multiple_payment_tokens": false, - "store_in_vault": "ON_SUCCESS", - "description": "description4", - "usage_pattern": "RECURRING_PREPAID" -} -``` - diff --git a/doc/models/pay-pal-wallet-vault-response.md b/doc/models/pay-pal-wallet-vault-response.md deleted file mode 100644 index a5f3525..0000000 --- a/doc/models/pay-pal-wallet-vault-response.md +++ /dev/null @@ -1,45 +0,0 @@ - -# Pay Pal Wallet Vault Response - -The details about a saved PayPal Wallet payment source. - -## Structure - -`PayPalWalletVaultResponse` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `id` | `?string` | Optional | The PayPal-generated ID for the saved payment source.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | getId(): ?string | setId(?string id): void | -| `status` | [`?string(PayPalWalletVaultStatus)`](../../doc/models/pay-pal-wallet-vault-status.md) | Optional | The vault status.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getStatus(): ?string | setStatus(?string status): void | -| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of request-related HATEOAS links.
**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `10` | getLinks(): ?array | setLinks(?array links): void | -| `customer` | [`?PayPalWalletCustomer`](../../doc/models/pay-pal-wallet-customer.md) | Optional | The details about a customer in PayPal's system of record. | getCustomer(): ?PayPalWalletCustomer | setCustomer(?PayPalWalletCustomer customer): void | - -## Example (as JSON) - -```json -{ - "id": "id0", - "status": "CREATED", - "links": [ - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - } - ], - "customer": { - "id": "id0", - "email_address": "email_address2", - "phone": { - "phone_type": "OTHER", - "phone_number": { - "national_number": "national_number6" - } - }, - "merchant_customer_id": "merchant_customer_id2" - } -} -``` - diff --git a/doc/models/pay-pal-wallet-vault-status.md b/doc/models/pay-pal-wallet-vault-status.md deleted file mode 100644 index 7e9a6b9..0000000 --- a/doc/models/pay-pal-wallet-vault-status.md +++ /dev/null @@ -1,17 +0,0 @@ - -# Pay Pal Wallet Vault Status - -The vault status. - -## Enumeration - -`PayPalWalletVaultStatus` - -## Fields - -| Name | -| --- | -| `VAULTED` | -| `CREATED` | -| `APPROVED` | - diff --git a/doc/models/pay-pal-wallet.md b/doc/models/pay-pal-wallet.md deleted file mode 100644 index bace786..0000000 --- a/doc/models/pay-pal-wallet.md +++ /dev/null @@ -1,44 +0,0 @@ - -# Pay Pal Wallet - -A resource that identifies a PayPal Wallet is used for payment. - -## Structure - -`PayPalWallet` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `vaultId` | `?string` | Optional | The PayPal-generated ID for the vaulted payment source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9a-zA-Z_-]+$` | getVaultId(): ?string | setVaultId(?string vaultId): 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.

**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: `(?:[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\|\[(?:(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9])\|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void | -| `name` | [`?Name`](../../doc/models/name.md) | Optional | The name of the party. | getName(): ?Name | setName(?Name name): void | -| `phone` | [`?PhoneWithType`](../../doc/models/phone-with-type.md) | Optional | The phone information. | getPhone(): ?PhoneWithType | setPhone(?PhoneWithType phone): void | -| `birthDate` | `?string` | Optional | 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.
**Constraints**: *Minimum Length*: `10`, *Maximum Length*: `10`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])$` | getBirthDate(): ?string | setBirthDate(?string birthDate): void | -| `taxInfo` | [`?TaxInfo`](../../doc/models/tax-info.md) | Optional | The tax ID of the customer. The customer is also known as the payer. Both `tax_id` and `tax_id_type` are required. | getTaxInfo(): ?TaxInfo | setTaxInfo(?TaxInfo taxInfo): void | -| `address` | [`?Address`](../../doc/models/address.md) | Optional | 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). | getAddress(): ?Address | setAddress(?Address address): void | -| `attributes` | [`?PayPalWalletAttributes`](../../doc/models/pay-pal-wallet-attributes.md) | Optional | Additional attributes associated with the use of this PayPal Wallet. | getAttributes(): ?PayPalWalletAttributes | setAttributes(?PayPalWalletAttributes attributes): void | -| `experienceContext` | [`?PayPalWalletExperienceContext`](../../doc/models/pay-pal-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.
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `128`, *Pattern*: `^[a-zA-Z0-9-]+$` | getBillingAgreementId(): ?string | setBillingAgreementId(?string billingAgreementId): void | - -## Example (as JSON) - -```json -{ - "vault_id": "vault_id8", - "email_address": "email_address8", - "name": { - "given_name": "given_name2", - "surname": "surname8" - }, - "phone": { - "phone_type": "OTHER", - "phone_number": { - "national_number": "national_number6" - } - }, - "birth_date": "birth_date4" -} -``` - diff --git a/doc/models/payee-base.md b/doc/models/payee-base.md deleted file mode 100644 index a6a9c82..0000000 --- a/doc/models/payee-base.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Payee Base - -The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee. - -## Structure - -`PayeeBase` - -## Fields - -| 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.

**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: `(?:[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\|\[(?:(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9])\|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void | -| `merchantId` | `?string` | Optional | The account identifier for a PayPal account.
**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `13`, *Pattern*: `^[2-9A-HJ-NP-Z]{13}$` | getMerchantId(): ?string | setMerchantId(?string merchantId): void | - -## Example (as JSON) - -```json -{ - "email_address": "email_address0", - "merchant_id": "merchant_id2" -} -``` - diff --git a/doc/models/payee-payment-method-preference.md b/doc/models/payee-payment-method-preference.md deleted file mode 100644 index b7df62b..0000000 --- a/doc/models/payee-payment-method-preference.md +++ /dev/null @@ -1,16 +0,0 @@ - -# Payee Payment Method Preference - -The merchant-preferred payment methods. - -## Enumeration - -`PayeePaymentMethodPreference` - -## Fields - -| Name | -| --- | -| `UNRESTRICTED` | -| `IMMEDIATE_PAYMENT_REQUIRED` | - diff --git a/doc/models/payee.md b/doc/models/payee.md deleted file mode 100644 index 33c4ce2..0000000 --- a/doc/models/payee.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Payee - -The merchant who receives the funds and fulfills the order. The merchant is also known as the payee., The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee. - -## Structure - -`Payee` - -## Fields - -| 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.

**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: `(?:[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\|\[(?:(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9])\|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void | -| `merchantId` | `?string` | Optional | The account identifier for a PayPal account.
**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `13`, *Pattern*: `^[2-9A-HJ-NP-Z]{13}$` | getMerchantId(): ?string | setMerchantId(?string merchantId): void | - -## Example (as JSON) - -```json -{ - "email_address": "email_address6", - "merchant_id": "merchant_id6" -} -``` - diff --git a/doc/models/payer-base.md b/doc/models/payer-base.md deleted file mode 100644 index 61fe68d..0000000 --- a/doc/models/payer-base.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Payer Base - -The customer who approves and pays for the order. The customer is also known as the payer. - -## Structure - -`PayerBase` - -## Fields - -| 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.

**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: `(?:[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\|\[(?:(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9])\|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void | -| `payerId` | `?string` | Optional | The account identifier for a PayPal account.
**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `13`, *Pattern*: `^[2-9A-HJ-NP-Z]{13}$` | getPayerId(): ?string | setPayerId(?string payerId): void | - -## Example (as JSON) - -```json -{ - "email_address": "email_address2", - "payer_id": "payer_id2" -} -``` - diff --git a/doc/models/payer.md b/doc/models/payer.md deleted file mode 100644 index a507d60..0000000 --- a/doc/models/payer.md +++ /dev/null @@ -1,39 +0,0 @@ - -# Payer - -## Structure - -`Payer` - -## Fields - -| 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.

**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: `(?:[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\|\[(?:(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9])\|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void | -| `payerId` | `?string` | Optional | The account identifier for a PayPal account.
**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `13`, *Pattern*: `^[2-9A-HJ-NP-Z]{13}$` | getPayerId(): ?string | setPayerId(?string payerId): void | -| `name` | [`?Name`](../../doc/models/name.md) | Optional | The name of the party. | getName(): ?Name | setName(?Name name): void | -| `phone` | [`?PhoneWithType`](../../doc/models/phone-with-type.md) | Optional | The phone information. | getPhone(): ?PhoneWithType | setPhone(?PhoneWithType phone): void | -| `birthDate` | `?string` | Optional | 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.
**Constraints**: *Minimum Length*: `10`, *Maximum Length*: `10`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])$` | getBirthDate(): ?string | setBirthDate(?string birthDate): void | -| `taxInfo` | [`?TaxInfo`](../../doc/models/tax-info.md) | Optional | The tax ID of the customer. The customer is also known as the payer. Both `tax_id` and `tax_id_type` are required. | getTaxInfo(): ?TaxInfo | setTaxInfo(?TaxInfo taxInfo): void | -| `address` | [`?Address`](../../doc/models/address.md) | Optional | 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). | getAddress(): ?Address | setAddress(?Address address): void | - -## Example (as JSON) - -```json -{ - "email_address": "email_address8", - "payer_id": "payer_id8", - "name": { - "given_name": "given_name2", - "surname": "surname8" - }, - "phone": { - "phone_type": "OTHER", - "phone_number": { - "national_number": "national_number6" - } - }, - "birth_date": "birth_date6" -} -``` - diff --git a/doc/models/payment-advice-code.md b/doc/models/payment-advice-code.md deleted file mode 100644 index df4c7e3..0000000 --- a/doc/models/payment-advice-code.md +++ /dev/null @@ -1,18 +0,0 @@ - -# Payment Advice Code - -The declined payment transactions might have payment advice codes. The card networks, like Visa and Mastercard, return payment advice codes. - -## Enumeration - -`PaymentAdviceCode` - -## Fields - -| Name | -| --- | -| `ENUM_01` | -| `ENUM_02` | -| `ENUM_03` | -| `ENUM_21` | - diff --git a/doc/models/payment-authorization.md b/doc/models/payment-authorization.md deleted file mode 100644 index 9bcb43c..0000000 --- a/doc/models/payment-authorization.md +++ /dev/null @@ -1,45 +0,0 @@ - -# Payment Authorization - -The authorized payment transaction. - -## Structure - -`PaymentAuthorization` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `status` | [`?string(AuthorizationStatus)`](../../doc/models/authorization-status.md) | Optional | The status for the authorized payment. | getStatus(): ?string | setStatus(?string status): void | -| `statusDetails` | [`?AuthorizationStatusDetails`](../../doc/models/authorization-status-details.md) | Optional | The details of the authorized payment status. | getStatusDetails(): ?AuthorizationStatusDetails | setStatusDetails(?AuthorizationStatusDetails statusDetails): void | -| `id` | `?string` | Optional | The PayPal-generated ID for the authorized payment. | getId(): ?string | setId(?string id): void | -| `amount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): ?Money | setAmount(?Money amount): void | -| `invoiceId` | `?string` | Optional | 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. | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void | -| `customId` | `?string` | Optional | The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
**Constraints**: *Maximum Length*: `127` | getCustomId(): ?string | setCustomId(?string customId): void | -| `networkTransactionReference` | [`?NetworkTransactionReference`](../../doc/models/network-transaction-reference.md) | Optional | Reference values used by the card network to identify a transaction. | getNetworkTransactionReference(): ?NetworkTransactionReference | setNetworkTransactionReference(?NetworkTransactionReference networkTransactionReference): void | -| `sellerProtection` | [`?SellerProtection`](../../doc/models/seller-protection.md) | Optional | The level of protection offered as defined by [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection). | getSellerProtection(): ?SellerProtection | setSellerProtection(?SellerProtection sellerProtection): void | -| `expirationTime` | `?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.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getExpirationTime(): ?string | setExpirationTime(?string expirationTime): 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.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getCreateTime(): ?string | setCreateTime(?string createTime): void | -| `updateTime` | `?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.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getUpdateTime(): ?string | setUpdateTime(?string updateTime): void | -| `supplementaryData` | [`?PaymentSupplementaryData`](../../doc/models/payment-supplementary-data.md) | Optional | The supplementary data. | getSupplementaryData(): ?PaymentSupplementaryData | setSupplementaryData(?PaymentSupplementaryData supplementaryData): void | -| `payee` | [`?Payee`](../../doc/models/payee.md) | Optional | The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee. | getPayee(): ?Payee | setPayee(?Payee payee): void | - -## Example (as JSON) - -```json -{ - "status": "VOIDED", - "status_details": { - "reason": "PENDING_REVIEW" - }, - "id": "id0", - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "invoice_id": "invoice_id0" -} -``` - diff --git a/doc/models/payment-collection.md b/doc/models/payment-collection.md deleted file mode 100644 index 68ed216..0000000 --- a/doc/models/payment-collection.md +++ /dev/null @@ -1,114 +0,0 @@ - -# Payment Collection - -The collection of payments, or transactions, for a purchase unit in an order. For example, authorized payments, captured payments, and refunds. - -## Structure - -`PaymentCollection` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `authorizations` | [`?(AuthorizationWithAdditionalData[])`](../../doc/models/authorization-with-additional-data.md) | Optional | An array of authorized payments for a purchase unit. A purchase unit can have zero or more authorized payments. | getAuthorizations(): ?array | setAuthorizations(?array authorizations): void | -| `captures` | [`?(Capture[])`](../../doc/models/capture.md) | Optional | An array of captured payments for a purchase unit. A purchase unit can have zero or more captured payments. | getCaptures(): ?array | setCaptures(?array captures): void | -| `refunds` | [`?(Refund[])`](../../doc/models/refund.md) | Optional | An array of refunds for a purchase unit. A purchase unit can have zero or more refunds. | getRefunds(): ?array | setRefunds(?array refunds): void | - -## Example (as JSON) - -```json -{ - "authorizations": [ - { - "status": "DENIED", - "status_details": { - "reason": "PENDING_REVIEW" - }, - "id": "id2", - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "invoice_id": "invoice_id2" - }, - { - "status": "DENIED", - "status_details": { - "reason": "PENDING_REVIEW" - }, - "id": "id2", - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "invoice_id": "invoice_id2" - }, - { - "status": "DENIED", - "status_details": { - "reason": "PENDING_REVIEW" - }, - "id": "id2", - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "invoice_id": "invoice_id2" - } - ], - "captures": [ - { - "status": "REFUNDED", - "status_details": { - "reason": "VERIFICATION_REQUIRED" - }, - "id": "id4", - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "invoice_id": "invoice_id4" - }, - { - "status": "REFUNDED", - "status_details": { - "reason": "VERIFICATION_REQUIRED" - }, - "id": "id4", - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "invoice_id": "invoice_id4" - } - ], - "refunds": [ - { - "status": "CANCELLED", - "status_details": { - "reason": "ECHECK" - }, - "id": "id8", - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "invoice_id": "invoice_id8" - }, - { - "status": "CANCELLED", - "status_details": { - "reason": "ECHECK" - }, - "id": "id8", - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "invoice_id": "invoice_id8" - } - ] -} -``` - diff --git a/doc/models/payment-initiator.md b/doc/models/payment-initiator.md deleted file mode 100644 index 79aed2b..0000000 --- a/doc/models/payment-initiator.md +++ /dev/null @@ -1,16 +0,0 @@ - -# Payment Initiator - -The person or party who initiated or triggered the payment. - -## Enumeration - -`PaymentInitiator` - -## Fields - -| Name | -| --- | -| `CUSTOMER` | -| `MERCHANT` | - diff --git a/doc/models/payment-instruction.md b/doc/models/payment-instruction.md deleted file mode 100644 index 0aeb339..0000000 --- a/doc/models/payment-instruction.md +++ /dev/null @@ -1,40 +0,0 @@ - -# Payment Instruction - -Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order. - -## Structure - -`PaymentInstruction` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `platformFees` | [`?(PlatformFee[])`](../../doc/models/platform-fee.md) | Optional | An array of various fees, commissions, tips, or donations. This field is only applicable to merchants that been enabled for PayPal Complete Payments Platform for Marketplaces and Platforms capability.
**Constraints**: *Minimum Items*: `0`, *Maximum Items*: `1` | getPlatformFees(): ?array | setPlatformFees(?array platformFees): void | -| `disbursementMode` | [`?string(DisbursementMode)`](../../doc/models/disbursement-mode.md) | Optional | The funds that are held on behalf of the merchant.
**Default**: `DisbursementMode::INSTANT`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `16`, *Pattern*: `^[A-Z_]+$` | getDisbursementMode(): ?string | setDisbursementMode(?string disbursementMode): void | -| `payeePricingTierId` | `?string` | Optional | This field is only enabled for selected merchants/partners to use and provides the ability to trigger a specific pricing rate/plan for a payment transaction. The list of eligible 'payee_pricing_tier_id' would be provided to you by your Account Manager. Specifying values other than the one provided to you by your account manager would result in an error.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `20`, *Pattern*: `^.*$` | getPayeePricingTierId(): ?string | setPayeePricingTierId(?string payeePricingTierId): void | -| `payeeReceivableFxRateId` | `?string` | Optional | FX identifier generated returned by PayPal to be used for payment processing in order to honor FX rate (for eligible integrations) to be used when amount is settled/received into the payee account.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `4000`, *Pattern*: `^.*$` | getPayeeReceivableFxRateId(): ?string | setPayeeReceivableFxRateId(?string payeeReceivableFxRateId): void | - -## Example (as JSON) - -```json -{ - "disbursement_mode": "INSTANT", - "platform_fees": [ - { - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "payee": { - "email_address": "email_address4", - "merchant_id": "merchant_id6" - } - } - ], - "payee_pricing_tier_id": "payee_pricing_tier_id6", - "payee_receivable_fx_rate_id": "payee_receivable_fx_rate_id4" -} -``` - diff --git a/doc/models/payment-method-preference.md b/doc/models/payment-method-preference.md deleted file mode 100644 index cc524e4..0000000 --- a/doc/models/payment-method-preference.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Payment Method Preference - -The customer and merchant payment preferences. - -## Structure - -`PaymentMethodPreference` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `payeePreferred` | [`?string(PayeePaymentMethodPreference)`](../../doc/models/payee-payment-method-preference.md) | Optional | The merchant-preferred payment methods.
**Default**: `PayeePaymentMethodPreference::UNRESTRICTED`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getPayeePreferred(): ?string | setPayeePreferred(?string payeePreferred): void | -| `standardEntryClassCode` | [`?string(StandardEntryClassCode)`](../../doc/models/standard-entry-class-code.md) | Optional | 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 compliant, you’ll need to make sure that you retain a compliant authorization for each transaction that you originate to the ACH Network using this API. ACH transactions are categorized (using SEC codes) by how you capture authorization from the Receiver (the person whose bank account is being debited or credited). PayPal supports the following SEC codes.
**Default**: `StandardEntryClassCode::WEB`
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `255` | getStandardEntryClassCode(): ?string | setStandardEntryClassCode(?string standardEntryClassCode): void | - -## Example (as JSON) - -```json -{ - "payee_preferred": "UNRESTRICTED", - "standard_entry_class_code": "WEB" -} -``` - diff --git a/doc/models/payment-source-response.md b/doc/models/payment-source-response.md deleted file mode 100644 index 53e51c1..0000000 --- a/doc/models/payment-source-response.md +++ /dev/null @@ -1,74 +0,0 @@ - -# Payment Source Response - -The payment source used to fund the payment. - -## Structure - -`PaymentSourceResponse` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `card` | [`?CardResponse`](../../doc/models/card-response.md) | Optional | The payment card to use to fund a payment. Card can be a credit or debit card. | getCard(): ?CardResponse | setCard(?CardResponse card): void | -| `paypal` | [`?PayPalWalletResponse`](../../doc/models/pay-pal-wallet-response.md) | Optional | The PayPal Wallet response. | getPaypal(): ?PayPalWalletResponse | setPaypal(?PayPalWalletResponse paypal): void | -| `bancontact` | [`?BancontactPaymentObject`](../../doc/models/bancontact-payment-object.md) | Optional | Information used to pay Bancontact. | getBancontact(): ?BancontactPaymentObject | setBancontact(?BancontactPaymentObject bancontact): void | -| `blik` | [`?BLIKPaymentObject`](../../doc/models/blik-payment-object.md) | Optional | Information used to pay using BLIK. | getBlik(): ?BLIKPaymentObject | setBlik(?BLIKPaymentObject blik): void | -| `eps` | [`?EPSPaymentObject`](../../doc/models/eps-payment-object.md) | Optional | Information used to pay using eps. | getEps(): ?EPSPaymentObject | setEps(?EPSPaymentObject eps): void | -| `giropay` | [`?GiropayPaymentObject`](../../doc/models/giropay-payment-object.md) | Optional | Information needed to pay using giropay. | getGiropay(): ?GiropayPaymentObject | setGiropay(?GiropayPaymentObject giropay): void | -| `ideal` | [`?IDEALPaymentObject`](../../doc/models/ideal-payment-object.md) | Optional | Information used to pay using iDEAL. | getIdeal(): ?IDEALPaymentObject | setIdeal(?IDEALPaymentObject ideal): void | -| `mybank` | [`?MyBankPaymentObject`](../../doc/models/my-bank-payment-object.md) | Optional | Information used to pay using MyBank. | getMybank(): ?MyBankPaymentObject | setMybank(?MyBankPaymentObject mybank): void | -| `p24` | [`?P24PaymentObject`](../../doc/models/p24-payment-object.md) | Optional | Information used to pay using P24(Przelewy24). | getP24(): ?P24PaymentObject | setP24(?P24PaymentObject p24): void | -| `sofort` | [`?SofortPaymentObject`](../../doc/models/sofort-payment-object.md) | Optional | Information used to pay using Sofort. | getSofort(): ?SofortPaymentObject | setSofort(?SofortPaymentObject sofort): void | -| `trustly` | [`?TrustlyPaymentObject`](../../doc/models/trustly-payment-object.md) | Optional | Information needed to pay using Trustly. | getTrustly(): ?TrustlyPaymentObject | setTrustly(?TrustlyPaymentObject trustly): void | -| `applePay` | [`?ApplePayPaymentObject`](../../doc/models/apple-pay-payment-object.md) | Optional | Information needed to pay using ApplePay. | getApplePay(): ?ApplePayPaymentObject | setApplePay(?ApplePayPaymentObject applePay): void | -| `googlePay` | [`?GooglePayWalletResponse`](../../doc/models/google-pay-wallet-response.md) | Optional | Google Pay Wallet payment data. | getGooglePay(): ?GooglePayWalletResponse | setGooglePay(?GooglePayWalletResponse googlePay): void | -| `venmo` | [`?VenmoWalletResponse`](../../doc/models/venmo-wallet-response.md) | Optional | Venmo wallet response. | getVenmo(): ?VenmoWalletResponse | setVenmo(?VenmoWalletResponse venmo): void | - -## Example (as JSON) - -```json -{ - "card": { - "name": "name6", - "last_digits": "last_digits0", - "brand": "SYNCHRONY", - "available_networks": [ - "DELTA" - ], - "type": "UNKNOWN" - }, - "paypal": { - "email_address": "email_address0", - "account_id": "account_id4", - "account_status": "VERIFIED", - "name": { - "given_name": "given_name2", - "surname": "surname8" - }, - "phone_type": "FAX" - }, - "bancontact": { - "name": "name0", - "country_code": "country_code0", - "bic": "bic2", - "iban_last_chars": "iban_last_chars8", - "card_last_digits": "card_last_digits4" - }, - "blik": { - "name": "name2", - "country_code": "country_code2", - "email": "email4", - "one_click": { - "consumer_reference": "consumer_reference2" - } - }, - "eps": { - "name": "name6", - "country_code": "country_code6", - "bic": "bic8" - } -} -``` - diff --git a/doc/models/payment-source.md b/doc/models/payment-source.md deleted file mode 100644 index c2e818a..0000000 --- a/doc/models/payment-source.md +++ /dev/null @@ -1,101 +0,0 @@ - -# Payment Source - -The payment source definition. - -## Structure - -`PaymentSource` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `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/pay-pal-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 | -| `blik` | [`?BLIKPaymentRequest`](../../doc/models/blik-payment-request.md) | Optional | Information needed to pay using BLIK. | getBlik(): ?BLIKPaymentRequest | setBlik(?BLIKPaymentRequest blik): void | -| `eps` | [`?EPSPaymentRequest`](../../doc/models/eps-payment-request.md) | Optional | Information needed to pay using eps. | getEps(): ?EPSPaymentRequest | setEps(?EPSPaymentRequest eps): void | -| `giropay` | [`?GiropayPaymentRequest`](../../doc/models/giropay-payment-request.md) | Optional | Information needed to pay using giropay. | getGiropay(): ?GiropayPaymentRequest | setGiropay(?GiropayPaymentRequest giropay): void | -| `ideal` | [`?IDEALPaymentRequest`](../../doc/models/ideal-payment-request.md) | Optional | Information needed to pay using iDEAL. | getIdeal(): ?IDEALPaymentRequest | setIdeal(?IDEALPaymentRequest ideal): void | -| `mybank` | [`?MyBankPaymentRequest`](../../doc/models/my-bank-payment-request.md) | Optional | Information needed to pay using MyBank. | getMybank(): ?MyBankPaymentRequest | setMybank(?MyBankPaymentRequest mybank): void | -| `p24` | [`?P24PaymentRequest`](../../doc/models/p24-payment-request.md) | Optional | Information needed to pay using P24 (Przelewy24). | getP24(): ?P24PaymentRequest | setP24(?P24PaymentRequest p24): void | -| `sofort` | [`?SofortPaymentRequest`](../../doc/models/sofort-payment-request.md) | Optional | Information needed to pay using Sofort. | getSofort(): ?SofortPaymentRequest | setSofort(?SofortPaymentRequest sofort): void | -| `trustly` | [`?TrustlyPaymentRequest`](../../doc/models/trustly-payment-request.md) | Optional | Information needed to pay using Trustly. | getTrustly(): ?TrustlyPaymentRequest | setTrustly(?TrustlyPaymentRequest trustly): void | -| `applePay` | [`?ApplePayRequest`](../../doc/models/apple-pay-request.md) | Optional | Information needed to pay using ApplePay. | getApplePay(): ?ApplePayRequest | setApplePay(?ApplePayRequest applePay): void | -| `googlePay` | [`?GooglePayRequest`](../../doc/models/google-pay-request.md) | Optional | Information needed to pay using Google Pay. | getGooglePay(): ?GooglePayRequest | setGooglePay(?GooglePayRequest googlePay): void | -| `venmo` | [`?VenmoWalletRequest`](../../doc/models/venmo-wallet-request.md) | Optional | Information needed to pay using Venmo. | getVenmo(): ?VenmoWalletRequest | setVenmo(?VenmoWalletRequest venmo): void | - -## Example (as JSON) - -```json -{ - "card": { - "name": "name6", - "number": "number6", - "expiry": "expiry4", - "security_code": "security_code8", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } - }, - "token": { - "id": "id6", - "type": "BILLING_AGREEMENT" - }, - "paypal": { - "vault_id": "vault_id0", - "email_address": "email_address0", - "name": { - "given_name": "given_name2", - "surname": "surname8" - }, - "phone": { - "phone_type": "OTHER", - "phone_number": { - "national_number": "national_number6" - } - }, - "birth_date": "birth_date8" - }, - "bancontact": { - "name": "name0", - "country_code": "country_code0", - "experience_context": { - "brand_name": "brand_name2", - "locale": "locale6", - "shipping_preference": "NO_SHIPPING", - "return_url": "return_url4", - "cancel_url": "cancel_url6" - } - }, - "blik": { - "name": "name2", - "country_code": "country_code2", - "email": "email4", - "experience_context": { - "brand_name": "brand_name2", - "locale": "locale6", - "shipping_preference": "NO_SHIPPING", - "return_url": "return_url4", - "cancel_url": "cancel_url6" - }, - "level_0": { - "auth_code": "auth_code8" - }, - "one_click": { - "auth_code": "auth_code0", - "consumer_reference": "consumer_reference2", - "alias_label": "alias_label6", - "alias_key": "alias_key4" - } - } -} -``` - diff --git a/doc/models/payment-supplementary-data.md b/doc/models/payment-supplementary-data.md deleted file mode 100644 index 97af675..0000000 --- a/doc/models/payment-supplementary-data.md +++ /dev/null @@ -1,27 +0,0 @@ - -# Payment Supplementary Data - -The supplementary data. - -## Structure - -`PaymentSupplementaryData` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `relatedIds` | [`?RelatedIdentifiers`](../../doc/models/related-identifiers.md) | Optional | Identifiers related to a specific resource. | getRelatedIds(): ?RelatedIdentifiers | setRelatedIds(?RelatedIdentifiers relatedIds): void | - -## Example (as JSON) - -```json -{ - "related_ids": { - "order_id": "order_id2", - "authorization_id": "authorization_id0", - "capture_id": "capture_id0" - } -} -``` - diff --git a/doc/models/payment-token-request-card.md b/doc/models/payment-token-request-card.md deleted file mode 100644 index 4f3a337..0000000 --- a/doc/models/payment-token-request-card.md +++ /dev/null @@ -1,34 +0,0 @@ - -# Payment Token Request Card - -A Resource representing a request to vault a Card. - -## Structure - -`PaymentTokenRequestCard` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `?string` | Optional | The card holder's name as it appears on the card.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `300`, *Pattern*: `^.{1,300}$` | getName(): ?string | setName(?string name): void | -| `number` | `?string` | Optional | The primary account number (PAN) for the payment card.
**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `19`, *Pattern*: `^[0-9]{13,19}$` | getNumber(): ?string | setNumber(?string number): void | -| `expiry` | `?string` | Optional | 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).
**Constraints**: *Minimum Length*: `7`, *Maximum Length*: `7`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])$` | getExpiry(): ?string | setExpiry(?string expiry): void | -| `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`.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `4`, *Pattern*: `^[0-9]{3,4}$` | getSecurityCode(): ?string | setSecurityCode(?string securityCode): void | -| `type` | [`?string(CardType)`](../../doc/models/card-type.md) | Optional | Type of card. i.e Credit, Debit and so on.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getType(): ?string | setType(?string type): void | -| `brand` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | The card network or brand. Applies to credit, debit, gift, and payment cards.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getBrand(): ?string | setBrand(?string brand): void | -| `billingAddress` | [`?Address`](../../doc/models/address.md) | Optional | 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). | getBillingAddress(): ?Address | setBillingAddress(?Address billingAddress): void | -| `networkTransactionReference` | `mixed` | Optional | - | getNetworkTransactionReference(): | setNetworkTransactionReference( networkTransactionReference): void | - -## Example (as JSON) - -```json -{ - "name": "name4", - "number": "number8", - "expiry": "expiry2", - "security_code": "security_code6", - "type": "DEBIT" -} -``` - diff --git a/doc/models/payment-token-request-payment-source.md b/doc/models/payment-token-request-payment-source.md deleted file mode 100644 index 4d3fd62..0000000 --- a/doc/models/payment-token-request-payment-source.md +++ /dev/null @@ -1,34 +0,0 @@ - -# Payment Token Request Payment Source - -The payment method to vault with the instrument details. - -## Structure - -`PaymentTokenRequestPaymentSource` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `card` | [`?PaymentTokenRequestCard`](../../doc/models/payment-token-request-card.md) | Optional | A Resource representing a request to vault a Card. | getCard(): ?PaymentTokenRequestCard | setCard(?PaymentTokenRequestCard card): void | -| `token` | [`?VaultTokenRequest`](../../doc/models/vault-token-request.md) | Optional | The Tokenized Payment Source representing a Request to Vault a Token. | getToken(): ?VaultTokenRequest | setToken(?VaultTokenRequest token): void | - -## Example (as JSON) - -```json -{ - "card": { - "name": "name6", - "number": "number6", - "expiry": "expiry4", - "security_code": "security_code8", - "type": "UNKNOWN" - }, - "token": { - "id": "id6", - "type": "BILLING_AGREEMENT" - } -} -``` - diff --git a/doc/models/payment-token-request.md b/doc/models/payment-token-request.md deleted file mode 100644 index 36be6bc..0000000 --- a/doc/models/payment-token-request.md +++ /dev/null @@ -1,40 +0,0 @@ - -# Payment Token Request - -Payment Token Request where the `source` defines the type of instrument to be stored. - -## Structure - -`PaymentTokenRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `customer` | [`?CustomerRequest`](../../doc/models/customer-request.md) | Optional | Customer in merchant's or partner's system of records. | getCustomer(): ?CustomerRequest | setCustomer(?CustomerRequest customer): void | -| `paymentSource` | [`PaymentTokenRequestPaymentSource`](../../doc/models/payment-token-request-payment-source.md) | Required | The payment method to vault with the instrument details. | getPaymentSource(): PaymentTokenRequestPaymentSource | setPaymentSource(PaymentTokenRequestPaymentSource paymentSource): void | - -## Example (as JSON) - -```json -{ - "customer": { - "id": "id0", - "merchant_customer_id": "merchant_customer_id2" - }, - "payment_source": { - "card": { - "name": "name6", - "number": "number6", - "expiry": "expiry4", - "security_code": "security_code8", - "type": "UNKNOWN" - }, - "token": { - "id": "id6", - "type": "BILLING_AGREEMENT" - } - } -} -``` - diff --git a/doc/models/payment-token-response-payment-source.md b/doc/models/payment-token-response-payment-source.md deleted file mode 100644 index bdafff4..0000000 --- a/doc/models/payment-token-response-payment-source.md +++ /dev/null @@ -1,119 +0,0 @@ - -# Payment Token Response Payment Source - -The vaulted payment method details. - -## Structure - -`PaymentTokenResponsePaymentSource` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `card` | [`?CardPaymentToken`](../../doc/models/card-payment-token.md) | Optional | Full representation of a Card Payment Token including network token. | getCard(): ?CardPaymentToken | setCard(?CardPaymentToken card): void | -| `paypal` | [`?PayPalPaymentToken`](../../doc/models/pay-pal-payment-token.md) | Optional | - | getPaypal(): ?PayPalPaymentToken | setPaypal(?PayPalPaymentToken paypal): void | -| `venmo` | [`?VenmoPaymentToken`](../../doc/models/venmo-payment-token.md) | Optional | - | getVenmo(): ?VenmoPaymentToken | setVenmo(?VenmoPaymentToken venmo): void | -| `applePay` | [`?ApplePayPaymentToken`](../../doc/models/apple-pay-payment-token.md) | Optional | A resource representing a response for Apple Pay. | getApplePay(): ?ApplePayPaymentToken | setApplePay(?ApplePayPaymentToken applePay): void | -| `bank` | [`?BankPaymentToken`](../../doc/models/bank-payment-token.md) | Optional | Full representation of a Bank Payment Token. | getBank(): ?BankPaymentToken | setBank(?BankPaymentToken bank): void | - -## Example (as JSON) - -```json -{ - "card": { - "name": "name6", - "last_digits": "last_digits0", - "brand": "SYNCHRONY", - "expiry": "expiry4", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } - }, - "paypal": { - "description": "description2", - "shipping": { - "name": { - "full_name": "full_name6" - }, - "type": "SHIPPING", - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - } - }, - "permit_multiple_payment_tokens": false, - "usage_type": "usage_type2", - "customer_type": "customer_type6" - }, - "venmo": { - "description": "description6", - "shipping": { - "name": { - "full_name": "full_name6" - }, - "type": "SHIPPING", - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - } - }, - "permit_multiple_payment_tokens": false, - "usage_type": "usage_type6", - "customer_type": "customer_type0" - }, - "apple_pay": { - "card": { - "name": "name6", - "last_digits": "last_digits0", - "type": "UNKNOWN", - "brand": "SYNCHRONY", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } - } - }, - "bank": { - "ach_debit": { - "verification_status": "verification_status6" - }, - "sepa_debit": { - "iban_last_chars": "iban_last_chars8", - "account_holder_name": { - "key1": "val1", - "key2": "val2" - }, - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - }, - "authorization_details": { - "status": "NOT_SUPPORTED" - } - } - } -} -``` - diff --git a/doc/models/payment-token-response.md b/doc/models/payment-token-response.md deleted file mode 100644 index 2555619..0000000 --- a/doc/models/payment-token-response.md +++ /dev/null @@ -1,137 +0,0 @@ - -# Payment Token Response - -Full representation of a saved payment token. - -## Structure - -`PaymentTokenResponse` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `id` | `?string` | Optional | The PayPal-generated ID for the vault token.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[0-9a-zA-Z_-]+$` | getId(): ?string | setId(?string id): void | -| `customer` | [`?CustomerRequest`](../../doc/models/customer-request.md) | Optional | Customer in merchant's or partner's system of records. | getCustomer(): ?CustomerRequest | setCustomer(?CustomerRequest customer): void | -| `paymentSource` | [`?PaymentTokenResponsePaymentSource`](../../doc/models/payment-token-response-payment-source.md) | Optional | The vaulted payment method details. | getPaymentSource(): ?PaymentTokenResponsePaymentSource | setPaymentSource(?PaymentTokenResponsePaymentSource paymentSource): void | -| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of related [HATEOAS links](/api/rest/responses/#hateoas).
**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `32` | getLinks(): ?array | setLinks(?array links): void | - -## Example (as JSON) - -```json -{ - "id": "id0", - "customer": { - "id": "id0", - "merchant_customer_id": "merchant_customer_id2" - }, - "payment_source": { - "card": { - "name": "name6", - "last_digits": "last_digits0", - "brand": "SYNCHRONY", - "expiry": "expiry4", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } - }, - "paypal": { - "description": "description2", - "shipping": { - "name": { - "full_name": "full_name6" - }, - "type": "SHIPPING", - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - } - }, - "permit_multiple_payment_tokens": false, - "usage_type": "usage_type2", - "customer_type": "customer_type6" - }, - "venmo": { - "description": "description6", - "shipping": { - "name": { - "full_name": "full_name6" - }, - "type": "SHIPPING", - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - } - }, - "permit_multiple_payment_tokens": false, - "usage_type": "usage_type6", - "customer_type": "customer_type0" - }, - "apple_pay": { - "card": { - "name": "name6", - "last_digits": "last_digits0", - "type": "UNKNOWN", - "brand": "SYNCHRONY", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } - } - }, - "bank": { - "ach_debit": { - "verification_status": "verification_status6" - }, - "sepa_debit": { - "iban_last_chars": "iban_last_chars8", - "account_holder_name": { - "key1": "val1", - "key2": "val2" - }, - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - }, - "authorization_details": { - "status": "NOT_SUPPORTED" - } - } - } - }, - "links": [ - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - }, - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - } - ] -} -``` - diff --git a/doc/models/phone-number-with-country-code.md b/doc/models/phone-number-with-country-code.md deleted file mode 100644 index 0c394ea..0000000 --- a/doc/models/phone-number-with-country-code.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Phone Number With Country Code - -The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). - -## Structure - -`PhoneNumberWithCountryCode` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `countryCode` | `string` | Required | The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `3`, *Pattern*: `^[0-9]{1,3}?$` | getCountryCode(): string | setCountryCode(string countryCode): void | -| `nationalNumber` | `string` | Required | The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `14`, *Pattern*: `^[0-9]{1,14}?$` | getNationalNumber(): string | setNationalNumber(string nationalNumber): void | - -## Example (as JSON) - -```json -{ - "country_code": "country_code4", - "national_number": "national_number8" -} -``` - diff --git a/doc/models/phone-number.md b/doc/models/phone-number.md deleted file mode 100644 index f37a8d1..0000000 --- a/doc/models/phone-number.md +++ /dev/null @@ -1,23 +0,0 @@ - -# Phone Number - -The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). - -## Structure - -`PhoneNumber` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `nationalNumber` | `string` | Required | The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `14`, *Pattern*: `^[0-9]{1,14}?$` | getNationalNumber(): string | setNationalNumber(string nationalNumber): void | - -## Example (as JSON) - -```json -{ - "national_number": "national_number8" -} -``` - diff --git a/doc/models/phone-type.md b/doc/models/phone-type.md deleted file mode 100644 index 99bb423..0000000 --- a/doc/models/phone-type.md +++ /dev/null @@ -1,19 +0,0 @@ - -# Phone Type - -The phone type. - -## Enumeration - -`PhoneType` - -## Fields - -| Name | -| --- | -| `FAX` | -| `HOME` | -| `MOBILE` | -| `OTHER` | -| `PAGER` | - diff --git a/doc/models/phone-with-type.md b/doc/models/phone-with-type.md deleted file mode 100644 index cde34e9..0000000 --- a/doc/models/phone-with-type.md +++ /dev/null @@ -1,27 +0,0 @@ - -# Phone With Type - -The phone information. - -## Structure - -`PhoneWithType` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `phoneType` | [`?string(PhoneType)`](../../doc/models/phone-type.md) | Optional | The phone type. | getPhoneType(): ?string | setPhoneType(?string phoneType): void | -| `phoneNumber` | [`PhoneNumber`](../../doc/models/phone-number.md) | Required | The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). | getPhoneNumber(): PhoneNumber | setPhoneNumber(PhoneNumber phoneNumber): void | - -## Example (as JSON) - -```json -{ - "phone_type": "PAGER", - "phone_number": { - "national_number": "national_number6" - } -} -``` - diff --git a/doc/models/phone.md b/doc/models/phone.md deleted file mode 100644 index f11e9d7..0000000 --- a/doc/models/phone.md +++ /dev/null @@ -1,27 +0,0 @@ - -# Phone - -The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). - -## Structure - -`Phone` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `countryCode` | `string` | Required | The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `3`, *Pattern*: `^[0-9]{1,3}?$` | getCountryCode(): string | setCountryCode(string countryCode): void | -| `nationalNumber` | `string` | Required | The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `14`, *Pattern*: `^[0-9]{1,14}?$` | getNationalNumber(): string | setNationalNumber(string nationalNumber): void | -| `extensionNumber` | `?string` | Optional | The extension number.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `15`, *Pattern*: `^[0-9]{1,15}?$` | getExtensionNumber(): ?string | setExtensionNumber(?string extensionNumber): void | - -## Example (as JSON) - -```json -{ - "country_code": "country_code8", - "national_number": "national_number2", - "extension_number": "extension_number2" -} -``` - diff --git a/doc/models/platform-fee.md b/doc/models/platform-fee.md deleted file mode 100644 index e94a481..0000000 --- a/doc/models/platform-fee.md +++ /dev/null @@ -1,31 +0,0 @@ - -# Platform Fee - -The platform or partner fee, commission, or brokerage fee that is associated with the transaction. Not a separate or isolated transaction leg from the external perspective. The platform fee is limited in scope and is always associated with the original payment for the purchase unit. - -## Structure - -`PlatformFee` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `amount` | [`Money`](../../doc/models/money.md) | Required | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): Money | setAmount(Money amount): void | -| `payee` | [`?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. | getPayee(): ?PayeeBase | setPayee(?PayeeBase payee): void | - -## Example (as JSON) - -```json -{ - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "payee": { - "email_address": "email_address4", - "merchant_id": "merchant_id6" - } -} -``` - diff --git a/doc/models/processing-instruction.md b/doc/models/processing-instruction.md deleted file mode 100644 index 1d19956..0000000 --- a/doc/models/processing-instruction.md +++ /dev/null @@ -1,16 +0,0 @@ - -# Processing Instruction - -The instruction to process an order. - -## Enumeration - -`ProcessingInstruction` - -## Fields - -| Name | -| --- | -| `ORDER_COMPLETE_ON_PAYMENT_APPROVAL` | -| `NO_INSTRUCTION` | - diff --git a/doc/models/processor-response-code.md b/doc/models/processor-response-code.md deleted file mode 100644 index 68b8bbb..0000000 --- a/doc/models/processor-response-code.md +++ /dev/null @@ -1,168 +0,0 @@ - -# Processor Response Code - -Processor response code for the non-PayPal payment processor errors. - -## Enumeration - -`ProcessorResponseCode` - -## Fields - -| Name | -| --- | -| `ENUM_0000` | -| `ENUM_00N7` | -| `ENUM_0100` | -| `ENUM_0390` | -| `ENUM_0500` | -| `ENUM_0580` | -| `ENUM_0800` | -| `ENUM_0880` | -| `ENUM_0890` | -| `ENUM_0960` | -| `ENUM_0R00` | -| `ENUM_1000` | -| `ENUM_10BR` | -| `ENUM_1300` | -| `ENUM_1310` | -| `ENUM_1312` | -| `ENUM_1317` | -| `ENUM_1320` | -| `ENUM_1330` | -| `ENUM_1335` | -| `ENUM_1340` | -| `ENUM_1350` | -| `ENUM_1352` | -| `ENUM_1360` | -| `ENUM_1370` | -| `ENUM_1380` | -| `ENUM_1382` | -| `ENUM_1384` | -| `ENUM_1390` | -| `ENUM_1393` | -| `ENUM_5100` | -| `ENUM_5110` | -| `ENUM_5120` | -| `ENUM_5130` | -| `ENUM_5135` | -| `ENUM_5140` | -| `ENUM_5150` | -| `ENUM_5160` | -| `ENUM_5170` | -| `ENUM_5180` | -| `ENUM_5190` | -| `ENUM_5200` | -| `ENUM_5210` | -| `ENUM_5400` | -| `ENUM_5500` | -| `ENUM_5650` | -| `ENUM_5700` | -| `ENUM_5710` | -| `ENUM_5800` | -| `ENUM_5900` | -| `ENUM_5910` | -| `ENUM_5920` | -| `ENUM_5930` | -| `ENUM_5950` | -| `ENUM_6300` | -| `ENUM_7600` | -| `ENUM_7700` | -| `ENUM_7710` | -| `ENUM_7800` | -| `ENUM_7900` | -| `ENUM_8000` | -| `ENUM_8010` | -| `ENUM_8020` | -| `ENUM_8030` | -| `ENUM_8100` | -| `ENUM_8110` | -| `ENUM_8220` | -| `ENUM_9100` | -| `ENUM_9500` | -| `ENUM_9510` | -| `ENUM_9520` | -| `ENUM_9530` | -| `ENUM_9540` | -| `ENUM_9600` | -| `PCNR` | -| `PCVV` | -| `PP06` | -| `PPRN` | -| `PPAD` | -| `PPAB` | -| `PPAE` | -| `PPAG` | -| `PPAI` | -| `PPAR` | -| `PPAU` | -| `PPAV` | -| `PPAX` | -| `PPBG` | -| `PPC2` | -| `PPCE` | -| `PPCO` | -| `PPCR` | -| `PPCT` | -| `PPCU` | -| `PPD3` | -| `PPDC` | -| `PPDI` | -| `PPDV` | -| `PPDT` | -| `PPEF` | -| `PPEL` | -| `PPER` | -| `PPEX` | -| `PPFE` | -| `PPFI` | -| `PPFR` | -| `PPFV` | -| `PPGR` | -| `PPH1` | -| `PPIF` | -| `PPII` | -| `PPIM` | -| `PPIT` | -| `PPLR` | -| `PPLS` | -| `PPMB` | -| `PPMC` | -| `PPMD` | -| `PPNC` | -| `PPNL` | -| `PPNM` | -| `PPNT` | -| `PPPH` | -| `PPPI` | -| `PPPM` | -| `PPQC` | -| `PPRE` | -| `PPRF` | -| `PPRR` | -| `PPS0` | -| `PPS1` | -| `PPS2` | -| `PPS3` | -| `PPS4` | -| `PPS5` | -| `PPS6` | -| `PPSC` | -| `PPSD` | -| `PPSE` | -| `PPTE` | -| `PPTF` | -| `PPTI` | -| `PPTR` | -| `PPTT` | -| `PPTV` | -| `PPUA` | -| `PPUC` | -| `PPUE` | -| `PPUI` | -| `PPUP` | -| `PPUR` | -| `PPVC` | -| `PPVE` | -| `PPVT` | - diff --git a/doc/models/processor-response.md b/doc/models/processor-response.md deleted file mode 100644 index b1cec8c..0000000 --- a/doc/models/processor-response.md +++ /dev/null @@ -1,29 +0,0 @@ - -# Processor Response - -The processor response information for payment requests, such as direct credit card transactions. - -## Structure - -`ProcessorResponse` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `avsCode` | [`?string(AVSCode)`](../../doc/models/avs-code.md) | Optional | The address verification code for Visa, Discover, Mastercard, or American Express transactions. | getAvsCode(): ?string | setAvsCode(?string avsCode): void | -| `cvvCode` | [`?string(CVVCode)`](../../doc/models/cvv-code.md) | Optional | The card verification value code for for Visa, Discover, Mastercard, or American Express. | getCvvCode(): ?string | setCvvCode(?string cvvCode): void | -| `responseCode` | [`?string(ProcessorResponseCode)`](../../doc/models/processor-response-code.md) | Optional | Processor response code for the non-PayPal payment processor errors. | getResponseCode(): ?string | setResponseCode(?string responseCode): void | -| `paymentAdviceCode` | [`?string(PaymentAdviceCode)`](../../doc/models/payment-advice-code.md) | Optional | The declined payment transactions might have payment advice codes. The card networks, like Visa and Mastercard, return payment advice codes. | getPaymentAdviceCode(): ?string | setPaymentAdviceCode(?string paymentAdviceCode): void | - -## Example (as JSON) - -```json -{ - "avs_code": "M", - "cvv_code": "U", - "response_code": "PPII", - "payment_advice_code": "01" -} -``` - diff --git a/doc/models/purchase-unit-request.md b/doc/models/purchase-unit-request.md deleted file mode 100644 index 319a340..0000000 --- a/doc/models/purchase-unit-request.md +++ /dev/null @@ -1,102 +0,0 @@ - -# Purchase Unit Request - -The purchase unit request. Includes required information for the payment contract. - -## Structure - -`PurchaseUnitRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `referenceId` | `?string` | Optional | 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`.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `256` | getReferenceId(): ?string | setReferenceId(?string referenceId): void | -| `amount` | [`AmountWithBreakdown`](../../doc/models/amount-with-breakdown.md) | Required | 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. | getAmount(): AmountWithBreakdown | setAmount(AmountWithBreakdown amount): void | -| `payee` | [`?Payee`](../../doc/models/payee.md) | Optional | The merchant who receives the funds and fulfills the order. The merchant is also known as the payee. | getPayee(): ?Payee | setPayee(?Payee payee): void | -| `paymentInstruction` | [`?PaymentInstruction`](../../doc/models/payment-instruction.md) | Optional | Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order. | getPaymentInstruction(): ?PaymentInstruction | setPaymentInstruction(?PaymentInstruction paymentInstruction): void | -| `description` | `?string` | Optional | The purchase description. The maximum length of the character is dependent on the type of characters used. The character length is specified assuming a US ASCII character. Depending on type of character; (e.g. accented character, Japanese characters) the number of characters that that can be specified as input might not equal the permissible max length.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127` | getDescription(): ?string | setDescription(?string description): void | -| `customId` | `?string` | Optional | The API caller-provided external ID. Used to reconcile client transactions with PayPal transactions. Appears in transaction and settlement reports but is not visible to the payer.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127` | getCustomId(): ?string | setCustomId(?string customId): void | -| `invoiceId` | `?string` | Optional | 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.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127` | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void | -| `softDescriptor` | `?string` | Optional | The soft descriptor is the dynamic text used to construct the statement descriptor that appears on a 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:Then, the statement descriptor on the card is PAYPAL * Janes Gift 80.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `22` | getSoftDescriptor(): ?string | setSoftDescriptor(?string softDescriptor): void | -| `items` | [`?(Item[])`](../../doc/models/item.md) | Optional | An array of items that the customer purchases from the merchant. | getItems(): ?array | setItems(?array items): void | -| `shipping` | [`?ShippingDetails`](../../doc/models/shipping-details.md) | Optional | The shipping details. | getShipping(): ?ShippingDetails | setShipping(?ShippingDetails shipping): void | -| `supplementaryData` | [`?SupplementaryData`](../../doc/models/supplementary-data.md) | Optional | Supplementary data about a payment. This object passes information that can be used to improve risk assessments and processing costs, for example, by providing Level 2 and Level 3 payment data. | getSupplementaryData(): ?SupplementaryData | setSupplementaryData(?SupplementaryData supplementaryData): void | - -## Example (as JSON) - -```json -{ - "reference_id": "reference_id6", - "amount": { - "currency_code": "currency_code6", - "value": "value0", - "breakdown": { - "item_total": { - "currency_code": "currency_code0", - "value": "value6" - }, - "shipping": { - "currency_code": "currency_code0", - "value": "value6" - }, - "handling": { - "currency_code": "currency_code2", - "value": "value8" - }, - "tax_total": { - "currency_code": "currency_code4", - "value": "value0" - }, - "insurance": { - "currency_code": "currency_code2", - "value": "value8" - } - } - }, - "payee": { - "email_address": "email_address4", - "merchant_id": "merchant_id6" - }, - "payment_instruction": { - "platform_fees": [ - { - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "payee": { - "email_address": "email_address4", - "merchant_id": "merchant_id6" - } - }, - { - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "payee": { - "email_address": "email_address4", - "merchant_id": "merchant_id6" - } - }, - { - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "payee": { - "email_address": "email_address4", - "merchant_id": "merchant_id6" - } - } - ], - "disbursement_mode": "INSTANT", - "payee_pricing_tier_id": "payee_pricing_tier_id2", - "payee_receivable_fx_rate_id": "payee_receivable_fx_rate_id0" - }, - "description": "description6", - "custom_id": "custom_id4" -} -``` - diff --git a/doc/models/purchase-unit.md b/doc/models/purchase-unit.md deleted file mode 100644 index 6e40ffe..0000000 --- a/doc/models/purchase-unit.md +++ /dev/null @@ -1,103 +0,0 @@ - -# Purchase Unit - -The purchase unit details. Used to capture required information for the payment contract. - -## Structure - -`PurchaseUnit` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `referenceId` | `?string` | Optional | 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.

**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `256` | getReferenceId(): ?string | setReferenceId(?string referenceId): void | -| `amount` | [`?AmountWithBreakdown`](../../doc/models/amount-with-breakdown.md) | Optional | 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. | getAmount(): ?AmountWithBreakdown | setAmount(?AmountWithBreakdown amount): void | -| `payee` | [`?Payee`](../../doc/models/payee.md) | Optional | The merchant who receives the funds and fulfills the order. The merchant is also known as the payee. | getPayee(): ?Payee | setPayee(?Payee payee): void | -| `paymentInstruction` | [`?PaymentInstruction`](../../doc/models/payment-instruction.md) | Optional | Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order. | getPaymentInstruction(): ?PaymentInstruction | setPaymentInstruction(?PaymentInstruction paymentInstruction): void | -| `description` | `?string` | Optional | The purchase description.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127` | getDescription(): ?string | setDescription(?string description): void | -| `customId` | `?string` | Optional | The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127` | getCustomId(): ?string | setCustomId(?string customId): void | -| `invoiceId` | `?string` | Optional | The API caller-provided external invoice ID for this order.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127` | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void | -| `id` | `?string` | Optional | 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.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `19` | getId(): ?string | setId(?string id): void | -| `softDescriptor` | `?string` | Optional | 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.

The soft descriptor supports the following ASCII characters:For Wallet payments marketplace integrations:
For unbranded payments (Direct Card) marketplace integrations, use a combination of the seller name and phone number.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `22` | getSoftDescriptor(): ?string | setSoftDescriptor(?string softDescriptor): void | -| `items` | [`?(Item[])`](../../doc/models/item.md) | Optional | An array of items that the customer purchases from the merchant. | getItems(): ?array | setItems(?array items): void | -| `shipping` | [`?ShippingWithTrackingDetails`](../../doc/models/shipping-with-tracking-details.md) | Optional | The order shipping details. | getShipping(): ?ShippingWithTrackingDetails | setShipping(?ShippingWithTrackingDetails shipping): void | -| `supplementaryData` | [`?SupplementaryData`](../../doc/models/supplementary-data.md) | Optional | Supplementary data about a payment. This object passes information that can be used to improve risk assessments and processing costs, for example, by providing Level 2 and Level 3 payment data. | getSupplementaryData(): ?SupplementaryData | setSupplementaryData(?SupplementaryData supplementaryData): void | -| `payments` | [`?PaymentCollection`](../../doc/models/payment-collection.md) | Optional | The collection of payments, or transactions, for a purchase unit in an order. For example, authorized payments, captured payments, and refunds. | getPayments(): ?PaymentCollection | setPayments(?PaymentCollection payments): void | - -## Example (as JSON) - -```json -{ - "reference_id": "reference_id8", - "amount": { - "currency_code": "currency_code6", - "value": "value0", - "breakdown": { - "item_total": { - "currency_code": "currency_code0", - "value": "value6" - }, - "shipping": { - "currency_code": "currency_code0", - "value": "value6" - }, - "handling": { - "currency_code": "currency_code2", - "value": "value8" - }, - "tax_total": { - "currency_code": "currency_code4", - "value": "value0" - }, - "insurance": { - "currency_code": "currency_code2", - "value": "value8" - } - } - }, - "payee": { - "email_address": "email_address4", - "merchant_id": "merchant_id6" - }, - "payment_instruction": { - "platform_fees": [ - { - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "payee": { - "email_address": "email_address4", - "merchant_id": "merchant_id6" - } - }, - { - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "payee": { - "email_address": "email_address4", - "merchant_id": "merchant_id6" - } - }, - { - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "payee": { - "email_address": "email_address4", - "merchant_id": "merchant_id6" - } - } - ], - "disbursement_mode": "INSTANT", - "payee_pricing_tier_id": "payee_pricing_tier_id2", - "payee_receivable_fx_rate_id": "payee_receivable_fx_rate_id0" - }, - "description": "description0" -} -``` - diff --git a/doc/models/reauthorize-request.md b/doc/models/reauthorize-request.md deleted file mode 100644 index b58a601..0000000 --- a/doc/models/reauthorize-request.md +++ /dev/null @@ -1,26 +0,0 @@ - -# Reauthorize Request - -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 - -`ReauthorizeRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `amount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): ?Money | setAmount(?Money amount): void | - -## Example (as JSON) - -```json -{ - "amount": { - "currency_code": "currency_code6", - "value": "value0" - } -} -``` - diff --git a/doc/models/refund-incomplete-reason.md b/doc/models/refund-incomplete-reason.md deleted file mode 100644 index f1fb1a8..0000000 --- a/doc/models/refund-incomplete-reason.md +++ /dev/null @@ -1,15 +0,0 @@ - -# Refund Incomplete Reason - -The reason why the refund has the `PENDING` or `FAILED` status. - -## Enumeration - -`RefundIncompleteReason` - -## Fields - -| Name | -| --- | -| `ECHECK` | - diff --git a/doc/models/refund-payment-instruction.md b/doc/models/refund-payment-instruction.md deleted file mode 100644 index 2423f8e..0000000 --- a/doc/models/refund-payment-instruction.md +++ /dev/null @@ -1,36 +0,0 @@ - -# Refund Payment Instruction - -Any additional payments instructions during refund payment processing. This object is only applicable to merchants that have been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability. Please speak to your account manager if you want to use this capability. - -## Structure - -`RefundPaymentInstruction` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `platformFees` | [`?(RefundPlatformFee[])`](../../doc/models/refund-platform-fee.md) | Optional | Specifies the amount that the API caller will contribute to the refund being processed. The amount needs to be lower than platform_fees amount originally captured or the amount that is remaining if multiple refunds have been processed. This field is only applicable to merchants that have been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability. Please speak to your account manager if you want to use this capability.
**Constraints**: *Minimum Items*: `0`, *Maximum Items*: `1` | getPlatformFees(): ?array | setPlatformFees(?array platformFees): void | - -## Example (as JSON) - -```json -{ - "platform_fees": [ - { - "amount": { - "currency_code": "currency_code6", - "value": "value0" - } - }, - { - "amount": { - "currency_code": "currency_code6", - "value": "value0" - } - } - ] -} -``` - diff --git a/doc/models/refund-platform-fee.md b/doc/models/refund-platform-fee.md deleted file mode 100644 index 1b536d1..0000000 --- a/doc/models/refund-platform-fee.md +++ /dev/null @@ -1,26 +0,0 @@ - -# Refund Platform Fee - -The platform or partner fee, commission, or brokerage fee that is associated with the transaction. Not a separate or isolated transaction leg from the external perspective. The platform fee is limited in scope and is always associated with the original payment for the purchase unit. - -## Structure - -`RefundPlatformFee` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `amount` | [`Money`](../../doc/models/money.md) | Required | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): Money | setAmount(Money amount): void | - -## Example (as JSON) - -```json -{ - "amount": { - "currency_code": "currency_code6", - "value": "value0" - } -} -``` - diff --git a/doc/models/refund-request.md b/doc/models/refund-request.md deleted file mode 100644 index e463bab..0000000 --- a/doc/models/refund-request.md +++ /dev/null @@ -1,55 +0,0 @@ - -# 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. - -## Structure - -`RefundRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `amount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): ?Money | setAmount(?Money amount): void | -| `customId` | `?string` | Optional | The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports. The pattern is defined by an external party and supports Unicode.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127`, *Pattern*: `^.*$` | getCustomId(): ?string | setCustomId(?string customId): void | -| `invoiceId` | `?string` | Optional | The API caller-provided external invoice ID for this order. The pattern is defined by an external party and supports Unicode.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127`, *Pattern*: `^.*$` | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void | -| `noteToPayer` | `?string` | Optional | The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives. The pattern is defined by an external party and supports Unicode.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^.*$` | getNoteToPayer(): ?string | setNoteToPayer(?string noteToPayer): void | -| `paymentInstruction` | [`?RefundPaymentInstruction`](../../doc/models/refund-payment-instruction.md) | Optional | Any additional payments instructions during refund payment processing. This object is only applicable to merchants that have been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability. Please speak to your account manager if you want to use this capability. | getPaymentInstruction(): ?RefundPaymentInstruction | setPaymentInstruction(?RefundPaymentInstruction paymentInstruction): void | - -## Example (as JSON) - -```json -{ - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "custom_id": "custom_id6", - "invoice_id": "invoice_id8", - "note_to_payer": "note_to_payer0", - "payment_instruction": { - "platform_fees": [ - { - "amount": { - "currency_code": "currency_code6", - "value": "value0" - } - }, - { - "amount": { - "currency_code": "currency_code6", - "value": "value0" - } - }, - { - "amount": { - "currency_code": "currency_code6", - "value": "value0" - } - } - ] - } -} -``` - diff --git a/doc/models/refund-status-details.md b/doc/models/refund-status-details.md deleted file mode 100644 index be91bca..0000000 --- a/doc/models/refund-status-details.md +++ /dev/null @@ -1,23 +0,0 @@ - -# Refund Status Details - -The details of the refund status. - -## Structure - -`RefundStatusDetails` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `reason` | [`?string(RefundIncompleteReason)`](../../doc/models/refund-incomplete-reason.md) | Optional | The reason why the refund has the `PENDING` or `FAILED` status. | getReason(): ?string | setReason(?string reason): void | - -## Example (as JSON) - -```json -{ - "reason": "ECHECK" -} -``` - diff --git a/doc/models/refund-status-with-details.md b/doc/models/refund-status-with-details.md deleted file mode 100644 index cfb77ec..0000000 --- a/doc/models/refund-status-with-details.md +++ /dev/null @@ -1,27 +0,0 @@ - -# Refund Status With Details - -The refund status with details. - -## Structure - -`RefundStatusWithDetails` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `status` | [`?string(RefundStatus)`](../../doc/models/refund-status.md) | Optional | The status of the refund. | getStatus(): ?string | setStatus(?string status): void | -| `statusDetails` | [`?RefundStatusDetails`](../../doc/models/refund-status-details.md) | Optional | The details of the refund status. | getStatusDetails(): ?RefundStatusDetails | setStatusDetails(?RefundStatusDetails statusDetails): void | - -## Example (as JSON) - -```json -{ - "status": "PENDING", - "status_details": { - "reason": "ECHECK" - } -} -``` - diff --git a/doc/models/refund-status.md b/doc/models/refund-status.md deleted file mode 100644 index 3a9da87..0000000 --- a/doc/models/refund-status.md +++ /dev/null @@ -1,18 +0,0 @@ - -# Refund Status - -The status of the refund. - -## Enumeration - -`RefundStatus` - -## Fields - -| Name | -| --- | -| `CANCELLED` | -| `FAILED` | -| `PENDING` | -| `COMPLETED` | - diff --git a/doc/models/refund.md b/doc/models/refund.md deleted file mode 100644 index dc7ed0e..0000000 --- a/doc/models/refund.md +++ /dev/null @@ -1,44 +0,0 @@ - -# Refund - -The refund information. - -## Structure - -`Refund` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `status` | [`?string(RefundStatus)`](../../doc/models/refund-status.md) | Optional | The status of the refund. | getStatus(): ?string | setStatus(?string status): void | -| `statusDetails` | [`?RefundStatusDetails`](../../doc/models/refund-status-details.md) | Optional | The details of the refund status. | getStatusDetails(): ?RefundStatusDetails | setStatusDetails(?RefundStatusDetails statusDetails): void | -| `id` | `?string` | Optional | The PayPal-generated ID for the refund. | getId(): ?string | setId(?string id): void | -| `amount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): ?Money | setAmount(?Money amount): void | -| `invoiceId` | `?string` | Optional | 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. | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void | -| `customId` | `?string` | Optional | The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127`, *Pattern*: `^[A-Za-z0-9-_.,]*$` | getCustomId(): ?string | setCustomId(?string customId): void | -| `acquirerReferenceNumber` | `?string` | Optional | Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[a-zA-Z0-9]+$` | getAcquirerReferenceNumber(): ?string | setAcquirerReferenceNumber(?string acquirerReferenceNumber): void | -| `noteToPayer` | `?string` | Optional | The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives. | getNoteToPayer(): ?string | setNoteToPayer(?string noteToPayer): void | -| `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.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getCreateTime(): ?string | setCreateTime(?string createTime): void | -| `updateTime` | `?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.

**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getUpdateTime(): ?string | setUpdateTime(?string updateTime): void | - -## Example (as JSON) - -```json -{ - "status": "CANCELLED", - "status_details": { - "reason": "ECHECK" - }, - "id": "id6", - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "invoice_id": "invoice_id6" -} -``` - diff --git a/doc/models/related-identifiers.md b/doc/models/related-identifiers.md deleted file mode 100644 index ac58443..0000000 --- a/doc/models/related-identifiers.md +++ /dev/null @@ -1,27 +0,0 @@ - -# Related Identifiers - -Identifiers related to a specific resource. - -## Structure - -`RelatedIdentifiers` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `orderId` | `?string` | Optional | Order ID related to the resource.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `20`, *Pattern*: `^[A-Z0-9]+$` | getOrderId(): ?string | setOrderId(?string orderId): void | -| `authorizationId` | `?string` | Optional | Authorization ID related to the resource.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `20`, *Pattern*: `^[A-Z0-9]+$` | getAuthorizationId(): ?string | setAuthorizationId(?string authorizationId): void | -| `captureId` | `?string` | Optional | Capture ID related to the resource.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `20`, *Pattern*: `^[A-Z0-9]+$` | getCaptureId(): ?string | setCaptureId(?string captureId): void | - -## Example (as JSON) - -```json -{ - "order_id": "order_id0", - "authorization_id": "authorization_id8", - "capture_id": "capture_id8" -} -``` - diff --git a/doc/models/seller-payable-breakdown.md b/doc/models/seller-payable-breakdown.md deleted file mode 100644 index 8def8ec..0000000 --- a/doc/models/seller-payable-breakdown.md +++ /dev/null @@ -1,49 +0,0 @@ - -# Seller Payable Breakdown - -The breakdown of the refund. - -## Structure - -`SellerPayableBreakdown` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `grossAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getGrossAmount(): ?Money | setGrossAmount(?Money grossAmount): void | -| `paypalFee` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getPaypalFee(): ?Money | setPaypalFee(?Money paypalFee): void | -| `paypalFeeInReceivableCurrency` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getPaypalFeeInReceivableCurrency(): ?Money | setPaypalFeeInReceivableCurrency(?Money paypalFeeInReceivableCurrency): void | -| `netAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getNetAmount(): ?Money | setNetAmount(?Money netAmount): void | -| `netAmountInReceivableCurrency` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getNetAmountInReceivableCurrency(): ?Money | setNetAmountInReceivableCurrency(?Money netAmountInReceivableCurrency): void | -| `platformFees` | [`?(PlatformFee[])`](../../doc/models/platform-fee.md) | Optional | An array of platform or partner fees, commissions, or brokerage fees for the refund.
**Constraints**: *Minimum Items*: `0`, *Maximum Items*: `1` | getPlatformFees(): ?array | setPlatformFees(?array platformFees): void | -| `netAmountBreakdown` | [`?(NetAmountBreakdownItem[])`](../../doc/models/net-amount-breakdown-item.md) | Optional | An array of breakdown values for the net amount. Returned when the currency of the refund is different from the currency of the PayPal account where the payee holds their funds. | getNetAmountBreakdown(): ?array | setNetAmountBreakdown(?array netAmountBreakdown): void | -| `totalRefundedAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getTotalRefundedAmount(): ?Money | setTotalRefundedAmount(?Money totalRefundedAmount): void | - -## Example (as JSON) - -```json -{ - "gross_amount": { - "currency_code": "currency_code4", - "value": "value0" - }, - "paypal_fee": { - "currency_code": "currency_code4", - "value": "value2" - }, - "paypal_fee_in_receivable_currency": { - "currency_code": "currency_code2", - "value": "value8" - }, - "net_amount": { - "currency_code": "currency_code6", - "value": "value2" - }, - "net_amount_in_receivable_currency": { - "currency_code": "currency_code8", - "value": "value4" - } -} -``` - diff --git a/doc/models/seller-protection-status.md b/doc/models/seller-protection-status.md deleted file mode 100644 index b178b73..0000000 --- a/doc/models/seller-protection-status.md +++ /dev/null @@ -1,17 +0,0 @@ - -# Seller Protection Status - -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). - -## Enumeration - -`SellerProtectionStatus` - -## Fields - -| Name | -| --- | -| `ELIGIBLE` | -| `PARTIALLY_ELIGIBLE` | -| `NOT_ELIGIBLE` | - diff --git a/doc/models/seller-protection.md b/doc/models/seller-protection.md deleted file mode 100644 index e777283..0000000 --- a/doc/models/seller-protection.md +++ /dev/null @@ -1,27 +0,0 @@ - -# 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). - -## Structure - -`SellerProtection` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `status` | [`?string(SellerProtectionStatus)`](../../doc/models/seller-protection-status.md) | Optional | 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). | getStatus(): ?string | setStatus(?string status): void | -| `disputeCategories` | [`?(string(DisputeCategory)[])`](../../doc/models/dispute-category.md) | Optional | An array of conditions that are covered for the transaction. | getDisputeCategories(): ?array | setDisputeCategories(?array disputeCategories): void | - -## Example (as JSON) - -```json -{ - "status": "NOT_ELIGIBLE", - "dispute_categories": [ - "ITEM_NOT_RECEIVED" - ] -} -``` - diff --git a/doc/models/seller-receivable-breakdown.md b/doc/models/seller-receivable-breakdown.md deleted file mode 100644 index 65abca3..0000000 --- a/doc/models/seller-receivable-breakdown.md +++ /dev/null @@ -1,53 +0,0 @@ - -# Seller Receivable Breakdown - -The detailed breakdown of the capture activity. This is not available for transactions that are in pending state. - -## Structure - -`SellerReceivableBreakdown` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `grossAmount` | [`Money`](../../doc/models/money.md) | Required | The currency and amount for a financial transaction, such as a balance or payment due. | getGrossAmount(): Money | setGrossAmount(Money grossAmount): void | -| `paypalFee` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getPaypalFee(): ?Money | setPaypalFee(?Money paypalFee): void | -| `paypalFeeInReceivableCurrency` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getPaypalFeeInReceivableCurrency(): ?Money | setPaypalFeeInReceivableCurrency(?Money paypalFeeInReceivableCurrency): void | -| `netAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getNetAmount(): ?Money | setNetAmount(?Money netAmount): void | -| `receivableAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getReceivableAmount(): ?Money | setReceivableAmount(?Money receivableAmount): void | -| `exchangeRate` | [`?ExchangeRate`](../../doc/models/exchange-rate.md) | Optional | The exchange rate that determines the amount to convert from one currency to another currency. | getExchangeRate(): ?ExchangeRate | setExchangeRate(?ExchangeRate exchangeRate): void | -| `platformFees` | [`?(PlatformFee[])`](../../doc/models/platform-fee.md) | Optional | An array of platform or partner fees, commissions, or brokerage fees that associated with the captured payment.
**Constraints**: *Minimum Items*: `0`, *Maximum Items*: `1` | getPlatformFees(): ?array | setPlatformFees(?array platformFees): void | - -## Example (as JSON) - -```json -{ - "gross_amount": { - "currency_code": "currency_code4", - "value": "value0" - }, - "paypal_fee": { - "currency_code": "currency_code4", - "value": "value2" - }, - "paypal_fee_in_receivable_currency": { - "currency_code": "currency_code2", - "value": "value8" - }, - "net_amount": { - "currency_code": "currency_code6", - "value": "value2" - }, - "receivable_amount": { - "currency_code": "currency_code2", - "value": "value8" - }, - "exchange_rate": { - "source_currency": "source_currency4", - "target_currency": "target_currency6", - "value": "value6" - } -} -``` - diff --git a/doc/models/sepa-debit-authorization-details.md b/doc/models/sepa-debit-authorization-details.md deleted file mode 100644 index 21c3672..0000000 --- a/doc/models/sepa-debit-authorization-details.md +++ /dev/null @@ -1,23 +0,0 @@ - -# SEPA Debit Authorization Details - -Authorization details. - -## Structure - -`SEPADebitAuthorizationDetails` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `status` | [`?string(InstrumentAuthorizationStatus)`](../../doc/models/instrument-authorization-status.md) | Optional | The authorization status of the wallet instrument.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `100`, *Pattern*: `^[0-9A-Z_]+$` | getStatus(): ?string | setStatus(?string status): void | - -## Example (as JSON) - -```json -{ - "status": "NOT_SUPPORTED" -} -``` - diff --git a/doc/models/sepa-debit-response.md b/doc/models/sepa-debit-response.md deleted file mode 100644 index 808435b..0000000 --- a/doc/models/sepa-debit-response.md +++ /dev/null @@ -1,39 +0,0 @@ - -# SEPA Debit Response - -## Structure - -`SEPADebitResponse` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `ibanLastChars` | `?string` | Optional | The last characters of the IBAN used to pay.
**Constraints**: *Minimum Length*: `4`, *Maximum Length*: `34`, *Pattern*: `[a-zA-Z0-9]{4}` | getIbanLastChars(): ?string | setIbanLastChars(?string ibanLastChars): void | -| `accountHolderName` | `mixed` | Optional | - | getAccountHolderName(): | setAccountHolderName( accountHolderName): void | -| `billingAddress` | [`?Address`](../../doc/models/address.md) | Optional | 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). | getBillingAddress(): ?Address | setBillingAddress(?Address billingAddress): void | -| `authorizationDetails` | [`?SEPADebitAuthorizationDetails`](../../doc/models/sepa-debit-authorization-details.md) | Optional | Authorization details. | getAuthorizationDetails(): ?SEPADebitAuthorizationDetails | setAuthorizationDetails(?SEPADebitAuthorizationDetails authorizationDetails): void | - -## Example (as JSON) - -```json -{ - "iban_last_chars": "iban_last_chars4", - "account_holder_name": { - "key1": "val1", - "key2": "val2" - }, - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - }, - "authorization_details": { - "status": "NOT_SUPPORTED" - } -} -``` - diff --git a/doc/models/setup-token-card-experience-context.md b/doc/models/setup-token-card-experience-context.md deleted file mode 100644 index 17ac82f..0000000 --- a/doc/models/setup-token-card-experience-context.md +++ /dev/null @@ -1,31 +0,0 @@ - -# Setup Token Card Experience Context - -Customizes the Vault creation flow experience for your customers. - -## Structure - -`SetupTokenCardExperienceContext` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `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.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `300`, *Pattern*: `^.*$` | getBrandName(): ?string | setBrandName(?string brandName): void | -| `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/).
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `10`, *Pattern*: `^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}\|[0-9]{3}))?$` | getLocale(): ?string | setLocale(?string locale): void | -| `returnUrl` | `?string` | Optional | The URL where the customer is redirected after customer approves leaves the flow. It is a required field for contingency flows like PayPal wallet, 3DS.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `4000` | getReturnUrl(): ?string | setReturnUrl(?string returnUrl): void | -| `cancelUrl` | `?string` | Optional | The URL where the customer is redirected after customer cancels or leaves the flow. It is a required field for contingency flows like PayPal wallet, 3DS.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `4000` | getCancelUrl(): ?string | setCancelUrl(?string cancelUrl): void | -| `vaultInstruction` | `?string` | Optional | Vault Instruction on action to be performed after a successful payer approval.
**Default**: `'ON_CREATE_PAYMENT_TOKENS'`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getVaultInstruction(): ?string | setVaultInstruction(?string vaultInstruction): void | - -## Example (as JSON) - -```json -{ - "vault_instruction": "ON_CREATE_PAYMENT_TOKENS", - "brand_name": "brand_name2", - "locale": "locale6", - "return_url": "return_url4", - "cancel_url": "cancel_url6" -} -``` - diff --git a/doc/models/setup-token-request-card.md b/doc/models/setup-token-request-card.md deleted file mode 100644 index 00bbffd..0000000 --- a/doc/models/setup-token-request-card.md +++ /dev/null @@ -1,36 +0,0 @@ - -# Setup Token Request Card - -A Resource representing a request to vault a Card. - -## Structure - -`SetupTokenRequestCard` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `?string` | Optional | The card holder's name as it appears on the card.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `300`, *Pattern*: `^.{1,300}$` | getName(): ?string | setName(?string name): void | -| `number` | `?string` | Optional | The primary account number (PAN) for the payment card.
**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `19`, *Pattern*: `^[0-9]{13,19}$` | getNumber(): ?string | setNumber(?string number): void | -| `expiry` | `?string` | Optional | 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).
**Constraints**: *Minimum Length*: `7`, *Maximum Length*: `7`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])$` | getExpiry(): ?string | setExpiry(?string expiry): void | -| `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`.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `4`, *Pattern*: `^[0-9]{3,4}$` | getSecurityCode(): ?string | setSecurityCode(?string securityCode): void | -| `type` | [`?string(CardType)`](../../doc/models/card-type.md) | Optional | Type of card. i.e Credit, Debit and so on.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getType(): ?string | setType(?string type): void | -| `brand` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | The card network or brand. Applies to credit, debit, gift, and payment cards.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getBrand(): ?string | setBrand(?string brand): void | -| `billingAddress` | [`?Address`](../../doc/models/address.md) | Optional | 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). | getBillingAddress(): ?Address | setBillingAddress(?Address billingAddress): void | -| `verificationMethod` | `?string` | Optional | The verification method of the card.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getVerificationMethod(): ?string | setVerificationMethod(?string verificationMethod): void | -| `experienceContext` | [`?SetupTokenCardExperienceContext`](../../doc/models/setup-token-card-experience-context.md) | Optional | Customizes the Vault creation flow experience for your customers. | getExperienceContext(): ?SetupTokenCardExperienceContext | setExperienceContext(?SetupTokenCardExperienceContext experienceContext): void | -| `networkTransactionReference` | `mixed` | Optional | - | getNetworkTransactionReference(): | setNetworkTransactionReference( networkTransactionReference): void | - -## Example (as JSON) - -```json -{ - "name": "name2", - "number": "number0", - "expiry": "expiry0", - "security_code": "security_code4", - "type": "STORE" -} -``` - diff --git a/doc/models/setup-token-request-payment-source.md b/doc/models/setup-token-request-payment-source.md deleted file mode 100644 index f812e4e..0000000 --- a/doc/models/setup-token-request-payment-source.md +++ /dev/null @@ -1,76 +0,0 @@ - -# Setup Token Request Payment Source - -The payment method to vault with the instrument details. - -## Structure - -`SetupTokenRequestPaymentSource` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `card` | [`?SetupTokenRequestCard`](../../doc/models/setup-token-request-card.md) | Optional | A Resource representing a request to vault a Card. | getCard(): ?SetupTokenRequestCard | setCard(?SetupTokenRequestCard card): void | -| `paypal` | [`?VaultPayPalWalletRequest`](../../doc/models/vault-pay-pal-wallet-request.md) | Optional | A resource representing a request to vault PayPal Wallet. | getPaypal(): ?VaultPayPalWalletRequest | setPaypal(?VaultPayPalWalletRequest paypal): void | -| `venmo` | [`?VaultVenmoRequest`](../../doc/models/vault-venmo-request.md) | Optional | - | getVenmo(): ?VaultVenmoRequest | setVenmo(?VaultVenmoRequest venmo): void | -| `token` | [`?VaultTokenRequest`](../../doc/models/vault-token-request.md) | Optional | The Tokenized Payment Source representing a Request to Vault a Token. | getToken(): ?VaultTokenRequest | setToken(?VaultTokenRequest token): void | - -## Example (as JSON) - -```json -{ - "card": { - "name": "name6", - "number": "number6", - "expiry": "expiry4", - "security_code": "security_code8", - "type": "UNKNOWN" - }, - "paypal": { - "description": "description2", - "shipping": { - "name": { - "full_name": "full_name6" - }, - "type": "SHIPPING", - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - } - }, - "permit_multiple_payment_tokens": false, - "usage_type": "usage_type2", - "customer_type": "customer_type6" - }, - "venmo": { - "description": "description6", - "shipping": { - "name": { - "full_name": "full_name6" - }, - "type": "SHIPPING", - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - } - }, - "permit_multiple_payment_tokens": false, - "usage_type": "usage_type6", - "customer_type": "customer_type0" - }, - "token": { - "id": "id6", - "type": "BILLING_AGREEMENT" - } -} -``` - diff --git a/doc/models/setup-token-request.md b/doc/models/setup-token-request.md deleted file mode 100644 index d69047a..0000000 --- a/doc/models/setup-token-request.md +++ /dev/null @@ -1,80 +0,0 @@ - -# Setup Token Request - -Setup Token Request where the `source` defines the type of instrument to be stored. - -## Structure - -`SetupTokenRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `customer` | [`?CustomerRequest`](../../doc/models/customer-request.md) | Optional | Customer in merchant's or partner's system of records. | getCustomer(): ?CustomerRequest | setCustomer(?CustomerRequest customer): void | -| `paymentSource` | [`SetupTokenRequestPaymentSource`](../../doc/models/setup-token-request-payment-source.md) | Required | The payment method to vault with the instrument details. | getPaymentSource(): SetupTokenRequestPaymentSource | setPaymentSource(SetupTokenRequestPaymentSource paymentSource): void | - -## Example (as JSON) - -```json -{ - "customer": { - "id": "id0", - "merchant_customer_id": "merchant_customer_id2" - }, - "payment_source": { - "card": { - "name": "name6", - "number": "number6", - "expiry": "expiry4", - "security_code": "security_code8", - "type": "UNKNOWN" - }, - "paypal": { - "description": "description2", - "shipping": { - "name": { - "full_name": "full_name6" - }, - "type": "SHIPPING", - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - } - }, - "permit_multiple_payment_tokens": false, - "usage_type": "usage_type2", - "customer_type": "customer_type6" - }, - "venmo": { - "description": "description6", - "shipping": { - "name": { - "full_name": "full_name6" - }, - "type": "SHIPPING", - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - } - }, - "permit_multiple_payment_tokens": false, - "usage_type": "usage_type6", - "customer_type": "customer_type0" - }, - "token": { - "id": "id6", - "type": "BILLING_AGREEMENT" - } - } -} -``` - diff --git a/doc/models/setup-token-response-card.md b/doc/models/setup-token-response-card.md deleted file mode 100644 index e99dc6e..0000000 --- a/doc/models/setup-token-response-card.md +++ /dev/null @@ -1,42 +0,0 @@ - -# Setup Token Response Card - -## Structure - -`SetupTokenResponseCard` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `?string` | Optional | The card holder's name as it appears on the card.
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `300`, *Pattern*: `^[A-Za-z ]+$` | getName(): ?string | setName(?string name): void | -| `lastDigits` | `?string` | Optional | The last digits of the payment card.
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `4`, *Pattern*: `[0-9]{2,}` | getLastDigits(): ?string | setLastDigits(?string lastDigits): void | -| `brand` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | The card network or brand. Applies to credit, debit, gift, and payment cards.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getBrand(): ?string | setBrand(?string brand): void | -| `expiry` | `?string` | Optional | 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).
**Constraints**: *Minimum Length*: `7`, *Maximum Length*: `7`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])$` | getExpiry(): ?string | setExpiry(?string expiry): void | -| `billingAddress` | [`?AddressDetails`](../../doc/models/address-details.md) | Optional | Address request details. | getBillingAddress(): ?AddressDetails | setBillingAddress(?AddressDetails billingAddress): void | -| `verificationStatus` | `?string` | Optional | Verification status of Card.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getVerificationStatus(): ?string | setVerificationStatus(?string verificationStatus): void | -| `verification` | [`?CardVerificationDetails`](../../doc/models/card-verification-details.md) | Optional | Card Verification details including the authorization details and 3D SECURE details. | getVerification(): ?CardVerificationDetails | setVerification(?CardVerificationDetails verification): void | -| `networkTransactionReference` | [`?NetworkTransactionReferenceEntity`](../../doc/models/network-transaction-reference-entity.md) | Optional | Previous network transaction reference including id in response. | getNetworkTransactionReference(): ?NetworkTransactionReferenceEntity | setNetworkTransactionReference(?NetworkTransactionReferenceEntity networkTransactionReference): void | -| `authenticationResult` | [`?AuthenticationResponse`](../../doc/models/authentication-response.md) | Optional | Results of Authentication such as 3D Secure. | getAuthenticationResult(): ?AuthenticationResponse | setAuthenticationResult(?AuthenticationResponse authenticationResult): void | -| `binDetails` | [`?BinDetails`](../../doc/models/bin-details.md) | Optional | Bank Identification Number (BIN) details used to fund a payment. | getBinDetails(): ?BinDetails | setBinDetails(?BinDetails binDetails): void | -| `type` | [`?string(CardType)`](../../doc/models/card-type.md) | Optional | Type of card. i.e Credit, Debit and so on.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getType(): ?string | setType(?string type): void | - -## Example (as JSON) - -```json -{ - "name": "name8", - "last_digits": "last_digits2", - "brand": "RUPAY", - "expiry": "expiry6", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } -} -``` - diff --git a/doc/models/setup-token-response-payment-source.md b/doc/models/setup-token-response-payment-source.md deleted file mode 100644 index 954d527..0000000 --- a/doc/models/setup-token-response-payment-source.md +++ /dev/null @@ -1,78 +0,0 @@ - -# Setup Token Response Payment Source - -The setup payment method details. - -## Structure - -`SetupTokenResponsePaymentSource` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `card` | [`?SetupTokenResponseCard`](../../doc/models/setup-token-response-card.md) | Optional | - | getCard(): ?SetupTokenResponseCard | setCard(?SetupTokenResponseCard card): void | -| `paypal` | [`?PayPalPaymentToken`](../../doc/models/pay-pal-payment-token.md) | Optional | - | getPaypal(): ?PayPalPaymentToken | setPaypal(?PayPalPaymentToken paypal): void | -| `venmo` | [`?VenmoPaymentToken`](../../doc/models/venmo-payment-token.md) | Optional | - | getVenmo(): ?VenmoPaymentToken | setVenmo(?VenmoPaymentToken venmo): void | - -## Example (as JSON) - -```json -{ - "card": { - "name": "name6", - "last_digits": "last_digits0", - "brand": "SYNCHRONY", - "expiry": "expiry4", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } - }, - "paypal": { - "description": "description2", - "shipping": { - "name": { - "full_name": "full_name6" - }, - "type": "SHIPPING", - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - } - }, - "permit_multiple_payment_tokens": false, - "usage_type": "usage_type2", - "customer_type": "customer_type6" - }, - "venmo": { - "description": "description6", - "shipping": { - "name": { - "full_name": "full_name6" - }, - "type": "SHIPPING", - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - } - }, - "permit_multiple_payment_tokens": false, - "usage_type": "usage_type6", - "customer_type": "customer_type0" - } -} -``` - diff --git a/doc/models/setup-token-response.md b/doc/models/setup-token-response.md deleted file mode 100644 index 4a3d7ef..0000000 --- a/doc/models/setup-token-response.md +++ /dev/null @@ -1,90 +0,0 @@ - -# Setup Token Response - -Minimal representation of a cached setup token. - -## Structure - -`SetupTokenResponse` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `id` | `?string` | Optional | The PayPal-generated ID for the vault token.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[0-9a-zA-Z_-]+$` | getId(): ?string | setId(?string id): void | -| `ordinal` | `?int` | Optional | Ordinal number for sorting.
**Constraints**: `>= 1`, `<= 99` | getOrdinal(): ?int | setOrdinal(?int ordinal): void | -| `customer` | [`?CustomerRequest`](../../doc/models/customer-request.md) | Optional | Customer in merchant's or partner's system of records. | getCustomer(): ?CustomerRequest | setCustomer(?CustomerRequest customer): void | -| `status` | `?string` | Optional | The status of the payment token.
**Default**: `'CREATED'`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getStatus(): ?string | setStatus(?string status): void | -| `paymentSource` | [`?SetupTokenResponsePaymentSource`](../../doc/models/setup-token-response-payment-source.md) | Optional | The setup payment method details. | getPaymentSource(): ?SetupTokenResponsePaymentSource | setPaymentSource(?SetupTokenResponsePaymentSource paymentSource): void | -| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of related [HATEOAS links](/api/rest/responses/#hateoas).
**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `32` | getLinks(): ?array | setLinks(?array links): void | - -## Example (as JSON) - -```json -{ - "status": "CREATED", - "id": "id6", - "ordinal": 0, - "customer": { - "id": "id0", - "merchant_customer_id": "merchant_customer_id2" - }, - "payment_source": { - "card": { - "name": "name6", - "last_digits": "last_digits0", - "brand": "SYNCHRONY", - "expiry": "expiry4", - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } - }, - "paypal": { - "description": "description2", - "shipping": { - "name": { - "full_name": "full_name6" - }, - "type": "SHIPPING", - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - } - }, - "permit_multiple_payment_tokens": false, - "usage_type": "usage_type2", - "customer_type": "customer_type6" - }, - "venmo": { - "description": "description6", - "shipping": { - "name": { - "full_name": "full_name6" - }, - "type": "SHIPPING", - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - } - }, - "permit_multiple_payment_tokens": false, - "usage_type": "usage_type6", - "customer_type": "customer_type0" - } - } -} -``` - diff --git a/doc/models/shipment-carrier.md b/doc/models/shipment-carrier.md deleted file mode 100644 index ecbf9ed..0000000 --- a/doc/models/shipment-carrier.md +++ /dev/null @@ -1,1290 +0,0 @@ - -# Shipment Carrier - -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. - -## Enumeration - -`ShipmentCarrier` - -## Fields - -| Name | -| --- | -| `DPD_RU` | -| `BG_BULGARIAN_POST` | -| `KR_KOREA_POST` | -| `ZA_COURIERIT` | -| `FR_EXAPAQ` | -| `ARE_EMIRATES_POST` | -| `GAC` | -| `GEIS` | -| `SF_EX` | -| `PAGO` | -| `MYHERMES` | -| `DIAMOND_EUROGISTICS` | -| `CORPORATECOURIERS_WEBHOOK` | -| `BOND` | -| `OMNIPARCEL` | -| `SK_POSTA` | -| `PUROLATOR` | -| `FETCHR_WEBHOOK` | -| `THEDELIVERYGROUP` | -| `CELLO_SQUARE` | -| `TARRIVE` | -| `COLLIVERY` | -| `MAINFREIGHT` | -| `IND_FIRSTFLIGHT` | -| `ACSWORLDWIDE` | -| `AMSTAN` | -| `OKAYPARCEL` | -| `ENVIALIA_REFERENCE` | -| `SEUR_ES` | -| `CONTINENTAL` | -| `FDSEXPRESS` | -| `AMAZON_FBA_SWISHIP` | -| `WYNGS` | -| `DHL_ACTIVE_TRACING` | -| `ZYLLEM` | -| `RUSTON` | -| `XPOST` | -| `CORREOS_ES` | -| `DHL_FR` | -| `PAN_ASIA` | -| `BRT_IT` | -| `SRE_KOREA` | -| `SPEEDEE` | -| `TNT_UK` | -| `VENIPAK` | -| `SHREENANDANCOURIER` | -| `CROSHOT` | -| `NIPOST_NG` | -| `EPST_GLBL` | -| `NEWGISTICS` | -| `POST_SLOVENIA` | -| `JERSEY_POST` | -| `BOMBINOEXP` | -| `WMG` | -| `XQ_EXPRESS` | -| `FURDECO` | -| `LHT_EXPRESS` | -| `SOUTH_AFRICAN_POST_OFFICE` | -| `SPOTON` | -| `DIMERCO` | -| `CYPRUS_POST_CYP` | -| `ABCUSTOM` | -| `IND_DELIVREE` | -| `CN_BESTEXPRESS` | -| `DX_SFTP` | -| `PICKUPP_MYS` | -| `FMX` | -| `HELLMANN` | -| `SHIP_IT_ASIA` | -| `KERRY_ECOMMERCE` | -| `FRETERAPIDO` | -| `PITNEY_BOWES` | -| `XPRESSEN_DK` | -| `SEUR_SP_API` | -| `DELIVERYONTIME` | -| `JINSUNG` | -| `TRANS_KARGO` | -| `SWISHIP_DE` | -| `IVOY_WEBHOOK` | -| `AIRMEE_WEBHOOK` | -| `DHL_BENELUX` | -| `FIRSTMILE` | -| `FASTWAY_IR` | -| `HH_EXP` | -| `MYS_MYPOST_ONLINE` | -| `TNT_NL` | -| `TIPSA` | -| `TAQBIN_MY` | -| `KGMHUB` | -| `INTEXPRESS` | -| `OVERSE_EXP` | -| `ONECLICK` | -| `ROADRUNNER_FREIGHT` | -| `GLS_CROTIA` | -| `MRW_FTP` | -| `BLUEX` | -| `DYLT` | -| `DPD_IR` | -| `SIN_GLBL` | -| `TUFFNELLS_REFERENCE` | -| `CJPACKET` | -| `MILKMAN` | -| `ASIGNA` | -| `ONEWORLDEXPRESS` | -| `ROYAL_MAIL` | -| `VIA_EXPRESS` | -| `TIGFREIGHT` | -| `ZTO_EXPRESS` | -| `TWO_GO` | -| `IML` | -| `INTEL_VALLEY` | -| `EFS` | -| `UK_UK_MAIL` | -| `RAM` | -| `ALLIEDEXPRESS` | -| `APC_OVERNIGHT` | -| `SHIPPIT` | -| `TFM` | -| `M_XPRESS` | -| `HDB_BOX` | -| `CLEVY_LINKS` | -| `IBEONE` | -| `FIEGE_NL` | -| `KWE_GLOBAL` | -| `CTC_EXPRESS` | -| `LAO_POST` | -| `AMAZON` | -| `MORE_LINK` | -| `JX` | -| `EASY_MAIL` | -| `ADUIEPYLE` | -| `GB_PANTHER` | -| `EXPRESSSALE` | -| `SG_DETRACK` | -| `TRUNKRS_WEBHOOK` | -| `MATDESPATCH` | -| `DICOM` | -| `MBW` | -| `KHM_CAMBODIA_POST` | -| `SINOTRANS` | -| `BRT_IT_PARCELID` | -| `DHL_SUPPLY_CHAIN` | -| `DHL_PL` | -| `TOPYOU` | -| `PALEXPRESS` | -| `DHL_SG` | -| `CN_WEDO` | -| `FULFILLME` | -| `DPD_DELISTRACK` | -| `UPS_REFERENCE` | -| `CARIBOU` | -| `LOCUS_WEBHOOK` | -| `DSV` | -| `CN_GOFLY` | -| `P2P_TRC` | -| `DIRECTPARCELS` | -| `NOVA_POSHTA_INT` | -| `FEDEX_POLAND` | -| `CN_JCEX` | -| `FAR_INTERNATIONAL` | -| `IDEXPRESS` | -| `GANGBAO` | -| `NEWAY` | -| `POSTNL_INT_3_S` | -| `RPX_ID` | -| `DESIGNERTRANSPORT_WEBHOOK` | -| `GLS_SLOVEN` | -| `PARCELLED_IN` | -| `GSI_EXPRESS` | -| `CON_WAY` | -| `BROUWER_TRANSPORT` | -| `CPEX` | -| `ISRAEL_POST` | -| `DTDC_IN` | -| `PTT_POST` | -| `XDE_WEBHOOK` | -| `TOLOS` | -| `GIAO_HANG` | -| `GEODIS_ESPACE` | -| `MAGYAR_HU` | -| `DOORDASH_WEBHOOK` | -| `TIKI_ID` | -| `CJ_HK_INTERNATIONAL` | -| `STAR_TRACK_EXPRESS` | -| `HELTHJEM` | -| `SFB2C` | -| `FREIGHTQUOTE` | -| `LANDMARK_GLOBAL_REFERENCE` | -| `PARCEL2GO` | -| `DELNEXT` | -| `RCL` | -| `CGS_EXPRESS` | -| `HK_POST` | -| `SAP_EXPRESS` | -| `PARCELPOST_SG` | -| `HERMES` | -| `IND_SAFEEXPRESS` | -| `TOPHATTEREXPRESS` | -| `MGLOBAL` | -| `AVERITT` | -| `LEADER` | -| `_2EBOX` | -| `SG_SPEEDPOST` | -| `DBSCHENKER_SE` | -| `ISR_POST_DOMESTIC` | -| `BESTWAYPARCEL` | -| `ASENDIA_DE` | -| `NIGHTLINE_UK` | -| `TAQBIN_SG` | -| `TCK_EXPRESS` | -| `ENDEAVOUR_DELIVERY` | -| `NANJINGWOYUAN` | -| `HEPPNER_FR` | -| `EMPS_CN` | -| `FONSEN` | -| `PICKRR` | -| `APC_OVERNIGHT_CONNUM` | -| `STAR_TRACK_NEXT_FLIGHT` | -| `DAJIN` | -| `UPS_FREIGHT` | -| `POSTA_PLUS` | -| `CEVA` | -| `ANSERX` | -| `JS_EXPRESS` | -| `PADTF` | -| `UPS_MAIL_INNOVATIONS` | -| `EZSHIP` | -| `SYPOST` | -| `AMAZON_SHIP_MCF` | -| `YUSEN` | -| `BRING` | -| `SDA_IT` | -| `GBA` | -| `NEWEGGEXPRESS` | -| `SPEEDCOURIERS_GR` | -| `FORRUN` | -| `PICKUP` | -| `ECMS` | -| `INTELIPOST` | -| `FLASHEXPRESS` | -| `CN_STO` | -| `SEKO_SFTP` | -| `HOME_DELIVERY_SOLUTIONS` | -| `DPD_HGRY` | -| `KERRYTTC_VN` | -| `JOYING_BOX` | -| `TOTAL_EXPRESS` | -| `ZJS_EXPRESS` | -| `STARKEN` | -| `DEMANDSHIP` | -| `CN_DPEX` | -| `AUPOST_CN` | -| `LOGISTERS` | -| `GOGLOBALPOST` | -| `GLS_CZ` | -| `PAACK_WEBHOOK` | -| `GRAB_WEBHOOK` | -| `PARCELPOINT` | -| `ICUMULUS` | -| `DAIGLOBALTRACK` | -| `GLOBAL_IPARCEL` | -| `YURTICI_KARGO` | -| `CN_PAYPAL_PACKAGE` | -| `PARCEL_2_POST` | -| `GLS_IT` | -| `PIL_LOGISTICS` | -| `HEPPNER` | -| `GENERAL_OVERNIGHT` | -| `HAPPY2POINT` | -| `CHITCHATS` | -| `SMOOTH` | -| `CLE_LOGISTICS` | -| `FIEGE` | -| `MX_CARGO` | -| `ZIINGFINALMILE` | -| `DAYTON_FREIGHT` | -| `TCS` | -| `AEX` | -| `HERMES_DE` | -| `ROUTIFIC_WEBHOOK` | -| `GLOBAVEND` | -| `CJ_LOGISTICS` | -| `PALLET_NETWORK` | -| `RAF_PH` | -| `UK_XDP` | -| `PAPER_EXPRESS` | -| `LA_POSTE_SUIVI` | -| `PAQUETEXPRESS` | -| `LIEFERY` | -| `STRECK_TRANSPORT` | -| `PONY_EXPRESS` | -| `ALWAYS_EXPRESS` | -| `GBS_BROKER` | -| `CITYLINK_MY` | -| `ALLJOY` | -| `YODEL` | -| `YODEL_DIR` | -| `STONE3PL` | -| `PARCELPAL_WEBHOOK` | -| `DHL_ECOMERCE_ASA` | -| `SIMPLYPOST` | -| `KY_EXPRESS` | -| `SHENZHEN` | -| `US_LASERSHIP` | -| `UC_EXPRE` | -| `DIDADI` | -| `CJ_KR` | -| `DBSCHENKER_B2B` | -| `MXE` | -| `CAE_DELIVERS` | -| `PFCEXPRESS` | -| `WHISTL` | -| `WEPOST` | -| `DHL_PARCEL_ES` | -| `DDEXPRESS` | -| `ARAMEX_AU` | -| `BNEED` | -| `HK_TGX` | -| `LATVIJAS_PASTS` | -| `VIAEUROPE` | -| `CORREO_UY` | -| `CHRONOPOST_FR` | -| `J_NET` | -| `_6LS` | -| `BLR_BELPOST` | -| `BIRDSYSTEM` | -| `DOBROPOST` | -| `WAHANA_ID` | -| `WEASHIP` | -| `SONICTL` | -| `KWT` | -| `AFLLOG_FTP` | -| `SKYNET_WORLDWIDE` | -| `NOVA_POSHTA` | -| `SEINO` | -| `SZENDEX` | -| `BPOST_INT` | -| `DBSCHENKER_SV` | -| `AO_DEUTSCHLAND` | -| `EU_FLEET_SOLUTIONS` | -| `PCFCORP` | -| `LINKBRIDGE` | -| `PRIMAMULTICIPTA` | -| `COUREX` | -| `ZAJIL_EXPRESS` | -| `COLLECTCO` | -| `JTEXPRESS` | -| `FEDEX_UK` | -| `USHIP` | -| `PIXSELL` | -| `SHIPTOR` | -| `CDEK` | -| `VNM_VIETTELPOST` | -| `CJ_CENTURY` | -| `GSO` | -| `VIWO` | -| `SKYBOX` | -| `KERRYTJ` | -| `NTLOGISTICS_VN` | -| `SDH_SCM` | -| `ZINC` | -| `DPE_SOUTH_AFRC` | -| `CESKA_CZ` | -| `ACS_GR` | -| `DEALERSEND` | -| `JOCOM` | -| `CSE` | -| `TFORCE_FINALMILE` | -| `SHIP_GATE` | -| `SHIPTER` | -| `NATIONAL_SAMEDAY` | -| `YUNEXPRESS` | -| `CAINIAO` | -| `DMS_MATRIX` | -| `DIRECTLOG` | -| `ASENDIA_US` | -| `_3JMSLOGISTICS` | -| `LICCARDI_EXPRESS` | -| `SKY_POSTAL` | -| `CNWANGTONG` | -| `POSTNORD_LOGISTICS_DK` | -| `LOGISTIKA` | -| `CELERITAS` | -| `PRESSIODE` | -| `SHREE_MARUTI` | -| `LOGISTICSWORLDWIDE_HK` | -| `EFEX` | -| `LOTTE` | -| `LONESTAR` | -| `APRISAEXPRESS` | -| `BEL_RS` | -| `OSM_WORLDWIDE` | -| `WESTGATE_GL` | -| `FASTRACK` | -| `DTD_EXPR` | -| `ALFATREX` | -| `PROMEDDELIVERY` | -| `THABIT_LOGISTICS` | -| `HCT_LOGISTICS` | -| `CARRY_FLAP` | -| `US_OLD_DOMINION` | -| `ANICAM_BOX` | -| `WANBEXPRESS` | -| `AN_POST` | -| `DPD_LOCAL` | -| `STALLIONEXPRESS` | -| `RAIDEREX` | -| `SHOPFANS` | -| `KYUNGDONG_PARCEL` | -| `CHAMPION_LOGISTICS` | -| `PICKUPP_SGP` | -| `MORNING_EXPRESS` | -| `NACEX` | -| `THENILE_WEBHOOK` | -| `HOLISOL` | -| `LBCEXPRESS_FTP` | -| `KURASI` | -| `USF_REDDAWAY` | -| `APG` | -| `CN_BOXC` | -| `ECOSCOOTING` | -| `MAINWAY` | -| `PAPERFLY` | -| `HOUNDEXPRESS` | -| `BOX_BERRY` | -| `EP_BOX` | -| `PLUS_LOG_UK` | -| `FULFILLA` | -| `ASE` | -| `MAIL_PLUS` | -| `XPO_LOGISTICS` | -| `WNDIRECT` | -| `CLOUDWISH_ASIA` | -| `ZELERIS` | -| `GIO_EXPRESS` | -| `OCS_WORLDWIDE` | -| `ARK_LOGISTICS` | -| `AQUILINE` | -| `PILOT_FREIGHT` | -| `QWINTRY` | -| `DANSKE_FRAGT` | -| `CARRIERS` | -| `AIR_CANADA_GLOBAL` | -| `PRESIDENT_TRANS` | -| `STEPFORWARDFS` | -| `SKYNET_UK` | -| `PITTOHIO` | -| `CORREOS_EXPRESS` | -| `RL_US` | -| `MARA_XPRESS` | -| `DESTINY` | -| `UK_YODEL` | -| `COMET_TECH` | -| `DHL_PARCEL_RU` | -| `TNT_REFR` | -| `SHREE_ANJANI_COURIER` | -| `MIKROPAKKET_BE` | -| `ETS_EXPRESS` | -| `COLIS_PRIVE` | -| `CN_YUNDA` | -| `AAA_COOPER` | -| `ROCKET_PARCEL` | -| `_360LION` | -| `PANDU` | -| `PROFESSIONAL_COURIERS` | -| `FLYTEXPRESS` | -| `LOGISTICSWORLDWIDE_MY` | -| `CORREOS_DE_ESPANA` | -| `IMX` | -| `FOUR_PX_EXPRESS` | -| `XPRESSBEES` | -| `PICKUPP_VNM` | -| `STARTRACK_EXPRESS1` | -| `FR_COLISSIMO` | -| `NACEX_SPAIN_REFERENCE` | -| `DHL_SUPPLY_CHAIN_AU` | -| `ESHIPPING` | -| `SHREETIRUPATI` | -| `HX_EXPRESS` | -| `INDOPAKET` | -| `CN_17POST` | -| `K1_EXPRESS` | -| `CJ_GLS` | -| `MYS_GDEX` | -| `NATIONEX` | -| `ANJUN` | -| `FARGOOD` | -| `SMG_EXPRESS` | -| `RZYEXPRESS` | -| `SEFL` | -| `TNT_CLICK_IT` | -| `HDB` | -| `HIPSHIPPER` | -| `RPXLOGISTICS` | -| `KUEHNE` | -| `IT_NEXIVE` | -| `PTS` | -| `SWISS_POST_FTP` | -| `FASTRK_SERV` | -| `_4_72` | -| `US_YRC` | -| `POSTNL_INTL_3S` | -| `ELIAN_POST` | -| `CUBYN` | -| `SAU_SAUDI_POST` | -| `ABXEXPRESS_MY` | -| `HUAHAN_EXPRESS` | -| `IND_JAYONEXPRESS` | -| `ZES_EXPRESS` | -| `ZEPTO_EXPRESS` | -| `SKYNET_ZA` | -| `ZEEK_2_DOOR` | -| `BLINKLASTMILE` | -| `POSTA_UKR` | -| `CHROBINSON` | -| `CN_POST56` | -| `COURANT_PLUS` | -| `SCUDEX_EXPRESS` | -| `SHIPENTEGRA` | -| `B_TWO_C_EUROPE` | -| `COPE` | -| `IND_GATI` | -| `CN_WISHPOST` | -| `NACEX_ES` | -| `TAQBIN_HK` | -| `GLOBALTRANZ` | -| `HKD` | -| `BJSHOMEDELIVERY` | -| `OMNIVA` | -| `SUTTON` | -| `PANTHER_REFERENCE` | -| `SFCSERVICE` | -| `LTL` | -| `PARKNPARCEL` | -| `SPRING_GDS` | -| `ECEXPRESS` | -| `INTERPARCEL_AU` | -| `AGILITY` | -| `XL_EXPRESS` | -| `ADERONLINE` | -| `DIRECTCOURIERS` | -| `PLANZER` | -| `SENDING` | -| `NINJAVAN_WB` | -| `NATIONWIDE_MY` | -| `SENDIT` | -| `GB_ARROW` | -| `IND_GOJAVAS` | -| `KPOST` | -| `DHL_FREIGHT` | -| `BLUECARE` | -| `JINDOUYUN` | -| `TRACKON` | -| `GB_TUFFNELLS` | -| `TRUMPCARD` | -| `ETOTAL` | -| `SFPLUS_WEBHOOK` | -| `SEKOLOGISTICS` | -| `HERMES_2MANN_HANDLING` | -| `DPD_LOCAL_REF` | -| `UDS` | -| `ZA_SPECIALISED_FREIGHT` | -| `THA_KERRY` | -| `PRT_INT_SEUR` | -| `BRA_CORREIOS` | -| `NZ_NZ_POST` | -| `CN_EQUICK` | -| `MYS_EMS` | -| `GB_NORSK` | -| `ESP_MRW` | -| `ESP_PACKLINK` | -| `KANGAROO_MY` | -| `RPX` | -| `XDP_UK_REFERENCE` | -| `NINJAVAN_MY` | -| `ADICIONAL` | -| `NINJAVAN_ID` | -| `ROADBULL` | -| `YAKIT` | -| `MAILAMERICAS` | -| `MIKROPAKKET` | -| `DYNALOGIC` | -| `DHL_ES` | -| `DHL_PARCEL_NL` | -| `DHL_GLOBAL_MAIL_ASIA` | -| `DAWN_WING` | -| `GENIKI_GR` | -| `HERMESWORLD_UK` | -| `ALPHAFAST` | -| `BUYLOGIC` | -| `EKART` | -| `MEX_SENDA` | -| `SFC_LOGISTICS` | -| `POST_SERBIA` | -| `IND_DELHIVERY` | -| `DE_DPD_DELISTRACK` | -| `RPD2MAN` | -| `CN_SF_EXPRESS` | -| `YANWEN` | -| `MYS_SKYNET` | -| `CORREOS_DE_MEXICO` | -| `CBL_LOGISTICA` | -| `MEX_ESTAFETA` | -| `AU_AUSTRIAN_POST` | -| `RINCOS` | -| `NLD_DHL` | -| `RUSSIAN_POST` | -| `COURIERS_PLEASE` | -| `POSTNORD_LOGISTICS` | -| `FEDEX` | -| `DPE_EXPRESS` | -| `DPD` | -| `ADSONE` | -| `IDN_JNE` | -| `THECOURIERGUY` | -| `CNEXPS` | -| `PRT_CHRONOPOST` | -| `LANDMARK_GLOBAL` | -| `IT_DHL_ECOMMERCE` | -| `ESP_NACEX` | -| `PRT_CTT` | -| `BE_KIALA` | -| `ASENDIA_UK` | -| `GLOBAL_TNT` | -| `POSTUR_IS` | -| `EPARCEL_KR` | -| `INPOST_PACZKOMATY` | -| `IT_POSTE_ITALIA` | -| `BE_BPOST` | -| `PL_POCZTA_POLSKA` | -| `MYS_MYS_POST` | -| `SG_SG_POST` | -| `THA_THAILAND_POST` | -| `LEXSHIP` | -| `FASTWAY_NZ` | -| `DHL_AU` | -| `COSTMETICSNOW` | -| `PFLOGISTICS` | -| `LOOMIS_EXPRESS` | -| `GLS_ITALY` | -| `LINE` | -| `GEL_EXPRESS` | -| `HUODULL` | -| `NINJAVAN_SG` | -| `JANIO` | -| `AO_COURIER` | -| `BRT_IT_SENDER_REF` | -| `SAILPOST` | -| `LALAMOVE` | -| `NEWZEALAND_COURIERS` | -| `ETOMARS` | -| `VIRTRANSPORT` | -| `WIZMO` | -| `PALLETWAYS` | -| `I_DIKA` | -| `CFL_LOGISTICS` | -| `GEMWORLDWIDE` | -| `GLOBAL_EXPRESS` | -| `LOGISTYX_TRANSGROUP` | -| `WESTBANK_COURIER` | -| `ARCO_SPEDIZIONI` | -| `YDH_EXPRESS` | -| `PARCELINKLOGISTICS` | -| `CNDEXPRESS` | -| `NOX_NIGHT_TIME_EXPRESS` | -| `AERONET` | -| `LTIANEXP` | -| `INTEGRA2_FTP` | -| `PARCELONE` | -| `NOX_NACHTEXPRESS` | -| `CN_CHINA_POST_EMS` | -| `CHUKOU1` | -| `GLS_SLOV` | -| `ORANGE_DS` | -| `JOOM_LOGIS` | -| `AUS_STARTRACK` | -| `DHL` | -| `GB_APC` | -| `BONDSCOURIERS` | -| `JPN_JAPAN_POST` | -| `USPS` | -| `WINIT` | -| `ARG_OCA` | -| `TW_TAIWAN_POST` | -| `DMM_NETWORK` | -| `TNT` | -| `BH_POSTA` | -| `SWE_POSTNORD` | -| `CA_CANADA_POST` | -| `WISELOADS` | -| `ASENDIA_HK` | -| `NLD_GLS` | -| `MEX_REDPACK` | -| `JET_SHIP` | -| `DE_DHL_EXPRESS` | -| `NINJAVAN_THAI` | -| `RABEN_GROUP` | -| `ESP_ASM` | -| `HRV_HRVATSKA` | -| `GLOBAL_ESTES` | -| `LTU_LIETUVOS` | -| `BEL_DHL` | -| `AU_AU_POST` | -| `SPEEDEXCOURIER` | -| `FR_COLIS` | -| `ARAMEX` | -| `DPEX` | -| `MYS_AIRPAK` | -| `CUCKOOEXPRESS` | -| `DPD_POLAND` | -| `NLD_POSTNL` | -| `NIM_EXPRESS` | -| `QUANTIUM` | -| `SENDLE` | -| `ESP_REDUR` | -| `MATKAHUOLTO` | -| `CPACKET` | -| `POSTI` | -| `HUNTER_EXPRESS` | -| `CHOIR_EXP` | -| `LEGION_EXPRESS` | -| `AUSTRIAN_POST_EXPRESS` | -| `GRUPO` | -| `POSTA_RO` | -| `INTERPARCEL_UK` | -| `GLOBAL_ABF` | -| `POSTEN_NORGE` | -| `XPERT_DELIVERY` | -| `DHL_REFR` | -| `DHL_HK` | -| `SKYNET_UAE` | -| `GOJEK` | -| `YODEL_INTNL` | -| `JANCO` | -| `YTO` | -| `WISE_EXPRESS` | -| `JTEXPRESS_VN` | -| `FEDEX_INTL_MLSERV` | -| `VAMOX` | -| `AMS_GRP` | -| `DHL_JP` | -| `HRPARCEL` | -| `GESWL` | -| `BLUESTAR` | -| `CDEK_TR` | -| `DESCARTES` | -| `DELTEC_UK` | -| `DTDC_EXPRESS` | -| `TOURLINE` | -| `BH_WORLDWIDE` | -| `OCS` | -| `YINGNUO_LOGISTICS` | -| `UPS` | -| `TOLL` | -| `PRT_SEUR` | -| `DTDC_AU` | -| `THA_DYNAMIC_LOGISTICS` | -| `UBI_LOGISTICS` | -| `FEDEX_CROSSBORDER` | -| `A1POST` | -| `TAZMANIAN_FREIGHT` | -| `CJ_INT_MY` | -| `SAIA_FREIGHT` | -| `SG_QXPRESS` | -| `NHANS_SOLUTIONS` | -| `DPD_FR` | -| `COORDINADORA` | -| `ANDREANI` | -| `DOORA` | -| `INTERPARCEL_NZ` | -| `PHL_JAMEXPRESS` | -| `BEL_BELGIUM_POST` | -| `US_APC` | -| `IDN_POS` | -| `FR_MONDIAL` | -| `DE_DHL` | -| `HK_RPX` | -| `DHL_PIECEID` | -| `VNPOST_EMS` | -| `RRDONNELLEY` | -| `DPD_DE` | -| `DELCART_IN` | -| `IMEXGLOBALSOLUTIONS` | -| `ACOMMERCE` | -| `EURODIS` | -| `CANPAR` | -| `GLS` | -| `IND_ECOM` | -| `ESP_ENVIALIA` | -| `DHL_UK` | -| `SMSA_EXPRESS` | -| `TNT_FR` | -| `DEX_I` | -| `BUDBEE_WEBHOOK` | -| `COPA_COURIER` | -| `VNM_VIETNAM_POST` | -| `DPD_HK` | -| `TOLL_NZ` | -| `ECHO_` | -| `FEDEX_FR` | -| `BORDEREXPRESS` | -| `MAILPLUS_JPN` | -| `TNT_UK_REFR` | -| `KEC` | -| `DPD_RO` | -| `TNT_JP` | -| `TH_CJ` | -| `EC_CN` | -| `FASTWAY_UK` | -| `FASTWAY_US` | -| `GLS_DE` | -| `GLS_ES` | -| `GLS_FR` | -| `MONDIAL_BE` | -| `SGT_IT` | -| `TNT_CN` | -| `TNT_DE` | -| `TNT_ES` | -| `TNT_PL` | -| `PARCELFORCE` | -| `SWISS_POST` | -| `TOLL_IPEC` | -| `AIR_21` | -| `AIRSPEED` | -| `BERT` | -| `BLUEDART` | -| `COLLECTPLUS` | -| `COURIERPLUS` | -| `COURIER_POST` | -| `DHL_GLOBAL_MAIL` | -| `DPD_UK` | -| `DELTEC_DE` | -| `DEUTSCHE_DE` | -| `DOTZOT` | -| `ELTA_GR` | -| `EMS_CN` | -| `ECARGO` | -| `ENSENDA` | -| `FERCAM_IT` | -| `FASTWAY_ZA` | -| `FASTWAY_AU` | -| `FIRST_LOGISITCS` | -| `GEODIS` | -| `GLOBEGISTICS` | -| `GREYHOUND` | -| `JETSHIP_MY` | -| `LION_PARCEL` | -| `AEROFLASH` | -| `ONTRAC` | -| `SAGAWA` | -| `SIODEMKA` | -| `STARTRACK` | -| `TNT_AU` | -| `TNT_IT` | -| `TRANSMISSION` | -| `YAMATO` | -| `DHL_IT` | -| `DHL_AT` | -| `LOGISTICSWORLDWIDE_KR` | -| `GLS_SPAIN` | -| `AMAZON_UK_API` | -| `DPD_FR_REFERENCE` | -| `DHLPARCEL_UK` | -| `MEGASAVE` | -| `QUALITYPOST` | -| `IDS_LOGISTICS` | -| `JOYINGBOX1` | -| `PANTHER_ORDER_NUMBER` | -| `WATKINS_SHEPARD` | -| `FASTTRACK` | -| `UP_EXPRESS` | -| `ELOGISTICA` | -| `ECOURIER` | -| `CJ_PHILIPPINES` | -| `SPEEDEX` | -| `ORANGECONNEX` | -| `TECOR` | -| `SAEE` | -| `GLS_ITALY_FTP` | -| `DELIVERE` | -| `YYCOM` | -| `ADICIONAL_PT` | -| `DKSH` | -| `NIPPON_EXPRESS_FTP` | -| `GOLS` | -| `FUJEXP` | -| `QTRACK` | -| `OMLOGISTICS_API` | -| `GDPHARM` | -| `MISUMI_CN` | -| `AIR_CANADA` | -| `CITY56_WEBHOOK` | -| `SAGAWA_API` | -| `KEDAEX` | -| `PGEON_API` | -| `WEWORLDEXPRESS` | -| `JT_LOGISTICS` | -| `TRUSK` | -| `VIAXPRESS` | -| `DHL_SUPPLYCHAIN_ID` | -| `ZUELLIGPHARMA_SFTP` | -| `MEEST` | -| `TOLL_PRIORITY` | -| `MOTHERSHIP_API` | -| `CAPITAL` | -| `EUROPAKET_API` | -| `HFD` | -| `TOURLINE_REFERENCE` | -| `GIO_ECOURIER` | -| `CN_LOGISTICS` | -| `PANDION` | -| `BPOST_API` | -| `PASSPORTSHIPPING` | -| `PAKAJO` | -| `DACHSER` | -| `YUSEN_SFTP` | -| `SHYPLITE` | -| `XYY` | -| `MWD` | -| `FAXECARGO` | -| `MAZET` | -| `FIRST_LOGISTICS_API` | -| `SPRINT_PACK` | -| `HERMES_DE_FTP` | -| `CONCISE` | -| `KERRY_EXPRESS_TW_API` | -| `EWE` | -| `FASTDESPATCH` | -| `ABCUSTOM_SFTP` | -| `CHAZKI` | -| `SHIPPIE` | -| `GEODIS_API` | -| `NAQEL_EXPRESS` | -| `PAPA_WEBHOOK` | -| `FORWARDAIR` | -| `DIALOGO_LOGISTICA_API` | -| `LALAMOVE_API` | -| `TOMYDOOR` | -| `KRONOS_WEBHOOK` | -| `JTCARGO` | -| `T_CAT` | -| `CONCISE_WEBHOOK` | -| `TELEPORT_WEBHOOK` | -| `CUSTOMCO_API` | -| `SPX_TH` | -| `BOLLORE_LOGISTICS` | -| `CLICKLINK_SFTP` | -| `M3LOGISTICS` | -| `VNPOST_API` | -| `AXLEHIRE_FTP` | -| `SHADOWFAX` | -| `MYHERMES_UK_API` | -| `DAIICHI` | -| `MENSAJEROSURBANOS_API` | -| `POLARSPEED` | -| `IDEXPRESS_ID` | -| `PAYO` | -| `WHISTL_SFTP` | -| `INTEX_DE` | -| `TRANS2U` | -| `PRODUCTCAREGROUP_SFTP` | -| `BIGSMART` | -| `EXPEDITORS_API_REF` | -| `AITWORLDWIDE_API` | -| `WORLDCOURIER` | -| `QUIQUP` | -| `AGEDISS_SFTP` | -| `ANDREANI_API` | -| `CRLEXPRESS` | -| `SMARTCAT` | -| `CROSSFLIGHT` | -| `PROCARRIER` | -| `DHL_REFERENCE_API` | -| `SEINO_API` | -| `WSPEXPRESS` | -| `KRONOS` | -| `TOTAL_EXPRESS_API` | -| `PARCLL` | -| `XPEDIGO` | -| `STAR_TRACK_WEBHOOK` | -| `GPOST` | -| `UCS` | -| `DMFGROUP` | -| `COORDINADORA_API` | -| `MARKEN` | -| `NTL` | -| `REDJEPAKKETJE` | -| `ALLIED_EXPRESS_FTP` | -| `MONDIALRELAY_ES` | -| `NAEKO_FTP` | -| `MHI` | -| `SHIPPIFY` | -| `MALCA_AMIT_API` | -| `JTEXPRESS_SG_API` | -| `DACHSER_WEB` | -| `FLIGHTLG` | -| `CAGO` | -| `COM1EXPRESS` | -| `TONAMI_FTP` | -| `PACKFLEET` | -| `PUROLATOR_INTERNATIONAL` | -| `WINESHIPPING_WEBHOOK` | -| `DHL_ES_SFTP` | -| `PCHOME_API` | -| `CESKAPOSTA_API` | -| `GORUSH` | -| `HOMERUNNER` | -| `AMAZON_ORDER` | -| `EFWNOW_API` | -| `CBL_LOGISTICA_API` | -| `NIMBUSPOST` | -| `LOGWIN_LOGISTICS` | -| `NOWLOG_API` | -| `DPD_NL` | -| `GODEPENDABLE` | -| `ESDEX` | -| `LOGISYSTEMS_SFTP` | -| `EXPEDITORS` | -| `SNTGLOBAL_API` | -| `SHIPX` | -| `QINTL_API` | -| `PACKS` | -| `POSTNL_INTERNATIONAL` | -| `AMAZON_EMAIL_PUSH` | -| `DHL_API` | -| `SPX` | -| `AXLEHIRE` | -| `ICSCOURIER` | -| `DIALOGO_LOGISTICA` | -| `SHUNBANG_EXPRESS` | -| `TCS_API` | -| `SF_EXPRESS_CN` | -| `PACKETA` | -| `SIC_TELIWAY` | -| `MONDIALRELAY_FR` | -| `INTIME_FTP` | -| `JD_EXPRESS` | -| `FASTBOX` | -| `PATHEON` | -| `INDIA_POST` | -| `TIPSA_REF` | -| `ECOFREIGHT` | -| `VOX` | -| `DIRECTFREIGHT_AU_REF` | -| `BESTTRANSPORT_SFTP` | -| `AUSTRALIA_POST_API` | -| `FRAGILEPAK_SFTP` | -| `FLIPXP` | -| `VALUE_WEBHOOK` | -| `DAESHIN` | -| `SHERPA` | -| `MWD_API` | -| `SMARTKARGO` | -| `DNJ_EXPRESS` | -| `GOPEOPLE` | -| `MYSENDLE_API` | -| `ARAMEX_API` | -| `PIDGE` | -| `THAIPARCELS` | -| `PANTHER_REFERENCE_API` | -| `POSTAPLUS1` | -| `BUFFALO` | -| `U_ENVIOS` | -| `ELITE_CO` | -| `BARQEXP` | -| `ROCHE_INTERNAL_SFTP` | -| `DBSCHENKER_ICELAND` | -| `TNT_FR_REFERENCE` | -| `NEWGISTICSAPI` | -| `GLOVO` | -| `GWLOGIS_API` | -| `SPREETAIL_API` | -| `MOOVA` | -| `PLYCONGROUP` | -| `USPS_WEBHOOK` | -| `REIMAGINEDELIVERY` | -| `EDF_FTP` | -| `DAO365` | -| `BIOCAIR_FTP` | -| `RANSA_WEBHOOK` | -| `SHIPXPRES` | -| `COURANT_PLUS_API` | -| `SHIPA` | -| `HOMELOGISTICS` | -| `DX` | -| `POSTE_ITALIANE_PACCOCELERE` | -| `TOLL_WEBHOOK` | -| `LCTBR_API` | -| `DX_FREIGHT` | -| `DHL_SFTP` | -| `SHIPROCKET` | -| `UBER_WEBHOOK` | -| `STATOVERNIGHT` | -| `BURD` | -| `FASTSHIP` | -| `IBVENTURE_WEBHOOK` | -| `GATI_KWE_API` | -| `CRYOPDP_FTP` | -| `HUBBED` | -| `TIPSA_API` | -| `ARASKARGO` | -| `THIJS_NL` | -| `ATSHEALTHCARE_REFERENCE` | -| `ENUM_99MINUTOS` | -| `HELLENIC_POST` | -| `HSM_GLOBAL` | -| `MNX` | -| `NMTRANSFER` | -| `LOGYSTO` | -| `INDIA_POST_INT` | -| `AMAZON_FBA_SWISHIP_IN` | -| `SRT_TRANSPORT` | -| `BOMI` | -| `DELIVERR_SFTP` | -| `HSDEXPRESS` | -| `SIMPLETIRE_WEBHOOK` | -| `HUNTER_EXPRESS_SFTP` | -| `UPS_API` | -| `WOOYOUNG_LOGISTICS_SFTP` | -| `PHSE_API` | -| `WISH_EMAIL_PUSH` | -| `NORTHLINE` | -| `MEDAFRICA` | -| `DPD_AT_SFTP` | -| `ANTERAJA` | -| `DHL_GLOBAL_FORWARDING_API` | -| `LBCEXPRESS_API` | -| `SIMSGLOBAL` | -| `CDLDELIVERS` | -| `TYP` | -| `TESTING_COURIER_WEBHOOK` | -| `PANDAGO_API` | -| `ROYAL_MAIL_FTP` | -| `THUNDEREXPRESS` | -| `SECRETLAB_WEBHOOK` | -| `SETEL` | -| `JD_WORLDWIDE` | -| `DPD_RU_API` | -| `ARGENTS_WEBHOOK` | -| `POSTONE` | -| `TUSKLOGISTICS` | -| `RHENUS_UK_API` | -| `TAQBIN_SG_API` | -| `INNTRALOG_SFTP` | -| `DAYROSS` | -| `CORREOSEXPRESS_API` | -| `INTERNATIONAL_SEUR_API` | -| `YODEL_API` | -| `HEROEXPRESS` | -| `DHL_SUPPLYCHAIN_IN` | -| `URGENT_CARGUS` | -| `FRONTDOORCORP` | -| `JTEXPRESS_PH` | -| `PARCELSTARS_WEBHOOK` | -| `DPD_SK_SFTP` | -| `MOVIANTO` | -| `OZEPARTS_SHIPPING` | -| `KARGOMKOLAY` | -| `TRUNKRS` | -| `OMNIRPS_WEBHOOK` | -| `CHILEXPRESS` | -| `TESTING_COURIER` | -| `JNE_API` | -| `BJSHOMEDELIVERY_FTP` | -| `DEXPRESS_WEBHOOK` | -| `USPS_API` | -| `TRANSVIRTUAL` | -| `SOLISTICA_API` | -| `CHIENVENTURE_WEBHOOK` | -| `DPD_UK_SFTP` | -| `INPOST_UK` | -| `JAVIT` | -| `ZTO_DOMESTIC` | -| `DHL_GT_API` | -| `CEVA_TRACKING` | -| `KOMON_EXPRESS` | -| `EASTWESTCOURIER_FTP` | -| `DANNIAO` | -| `SPECTRAN` | -| `DELIVER_IT` | -| `RELAISCOLIS` | -| `GLS_SPAIN_API` | -| `POSTPLUS` | -| `AIRTERRA` | -| `GIO_ECOURIER_API` | -| `DPD_CH_SFTP` | -| `FEDEX_API` | -| `INTERSMARTTRANS` | -| `HERMES_UK_SFTP` | -| `EXELOT_FTP` | -| `DHL_PA_API` | -| `VIRTRANSPORT_SFTP` | -| `WORLDNET` | -| `INSTABOX_WEBHOOK` | -| `KNG` | -| `FLASHEXPRESS_WEBHOOK` | -| `MAGYAR_POSTA_API` | -| `WESHIP_API` | -| `OHI_WEBHOOK` | -| `MUDITA` | -| `BLUEDART_API` | -| `T_CAT_API` | -| `ADS` | -| `HERMES_IT` | -| `FITZMARK_API` | -| `POSTI_API` | -| `SMSA_EXPRESS_WEBHOOK` | -| `TAMERGROUP_WEBHOOK` | -| `LIVRAPIDE` | -| `NIPPON_EXPRESS` | -| `BETTERTRUCKS` | -| `FAN` | -| `PB_USPSFLATS_FTP` | -| `PARCELRIGHT` | -| `ITHINKLOGISTICS` | -| `KERRY_EXPRESS_TH_WEBHOOK` | -| `ECOUTIER` | -| `SHOWL` | -| `BRT_IT_API` | -| `RIXONHK_API` | -| `DBSCHENKER_API` | -| `ILYANGLOGIS` | -| `MAIL_BOX_ETC` | -| `WESHIP` | -| `DHL_GLOBAL_MAIL_API` | -| `ACTIVOS24_API` | -| `ATSHEALTHCARE` | -| `LUWJISTIK` | -| `GW_WORLD` | -| `FAIRSENDEN_API` | -| `SERVIP_WEBHOOK` | -| `SWISHIP` | -| `TANET` | -| `HOTSIN_CARGO` | -| `DIREX` | -| `HUANTONG` | -| `IMILE_API` | -| `BDMNET` | -| `AUEXPRESS` | -| `NYTLOGISTICS` | -| `DSV_REFERENCE` | -| `NOVOFARMA_WEBHOOK` | -| `AITWORLDWIDE_SFTP` | -| `SHOPOLIVE` | -| `FNF_ZA` | -| `DHL_ECOMMERCE_GC` | -| `FETCHR` | -| `STARLINKS_API` | -| `YYEXPRESS` | -| `SERVIENTREGA` | -| `HANJIN` | -| `SPANISH_SEUR_FTP` | -| `DX_B2B_CONNUM` | -| `HELTHJEM_API` | -| `INEXPOST` | -| `A2B_BA` | -| `RHENUS_GROUP` | -| `SBERLOGISTICS_RU` | -| `MALCA_AMIT` | -| `PPL` | -| `OSM_WORLDWIDE_SFTP` | -| `ACILOGISTIX` | -| `OPTIMACOURIER` | -| `NOVA_POSHTA_API` | -| `LOGGI` | -| `YIFAN` | -| `MYDYNALOGIC` | -| `MORNINGLOBAL` | -| `CONCISE_API` | -| `FXTRAN` | -| `DELIVERYOURPARCEL_ZA` | -| `UPARCEL` | -| `MOBI_BR` | -| `LOGINEXT_WEBHOOK` | -| `EMS` | -| `SPEEDY` | - diff --git a/doc/models/shipping-details.md b/doc/models/shipping-details.md deleted file mode 100644 index 3bcc21e..0000000 --- a/doc/models/shipping-details.md +++ /dev/null @@ -1,69 +0,0 @@ - -# Shipping Details - -The shipping details. - -## Structure - -`ShippingDetails` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | [`?ShippingName`](../../doc/models/shipping-name.md) | Optional | The name of the party. | getName(): ?ShippingName | setName(?ShippingName name): void | -| `type` | [`?string(FullfillmentType)`](../../doc/models/fullfillment-type.md) | Optional | 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.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getType(): ?string | setType(?string type): void | -| `options` | [`?(ShippingOption[])`](../../doc/models/shipping-option.md) | Optional | An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.
**Constraints**: *Minimum Items*: `0`, *Maximum Items*: `10` | getOptions(): ?array | setOptions(?array options): void | -| `address` | [`?Address`](../../doc/models/address.md) | Optional | 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). | getAddress(): ?Address | setAddress(?Address address): void | - -## Example (as JSON) - -```json -{ - "name": { - "full_name": "full_name6" - }, - "type": "PICKUP_IN_STORE", - "options": [ - { - "id": "id2", - "label": "label2", - "type": "SHIPPING", - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "selected": false - }, - { - "id": "id2", - "label": "label2", - "type": "SHIPPING", - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "selected": false - }, - { - "id": "id2", - "label": "label2", - "type": "SHIPPING", - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "selected": false - } - ], - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - } -} -``` - diff --git a/doc/models/shipping-name.md b/doc/models/shipping-name.md deleted file mode 100644 index 1b9af96..0000000 --- a/doc/models/shipping-name.md +++ /dev/null @@ -1,23 +0,0 @@ - -# Shipping Name - -The name of the party. - -## Structure - -`ShippingName` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `fullName` | `?string` | Optional | When the party is a person, the party's full name.
**Constraints**: *Maximum Length*: `300` | getFullName(): ?string | setFullName(?string fullName): void | - -## Example (as JSON) - -```json -{ - "full_name": "full_name6" -} -``` - diff --git a/doc/models/shipping-option.md b/doc/models/shipping-option.md deleted file mode 100644 index 5775454..0000000 --- a/doc/models/shipping-option.md +++ /dev/null @@ -1,34 +0,0 @@ - -# Shipping Option - -The options that the payee or merchant offers to the payer to ship or pick up their items. - -## Structure - -`ShippingOption` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `id` | `string` | Required | A unique ID that identifies a payer-selected shipping option.
**Constraints**: *Maximum Length*: `127` | getId(): string | setId(string id): void | -| `label` | `string` | Required | 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.
**Constraints**: *Maximum Length*: `127` | getLabel(): string | setLabel(string label): void | -| `type` | [`?string(ShippingType)`](../../doc/models/shipping-type.md) | Optional | A classification for the method of purchase fulfillment. | getType(): ?string | setType(?string type): void | -| `amount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): ?Money | setAmount(?Money amount): void | -| `selected` | `bool` | Required | If the API request sets `selected = true`, it represents the shipping option that the payee or merchant expects to be pre-selected for the payer when they first view the `shipping.options` in the PayPal Checkout experience. As part of the response if a `shipping.option` contains `selected=true`, it represents the shipping option that the payer selected during the course of checkout with PayPal. Only one `shipping.option` can be set to `selected=true`. | getSelected(): bool | setSelected(bool selected): void | - -## Example (as JSON) - -```json -{ - "id": "id4", - "label": "label4", - "type": "SHIPPING", - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "selected": false -} -``` - diff --git a/doc/models/shipping-preference.md b/doc/models/shipping-preference.md deleted file mode 100644 index 8aedb56..0000000 --- a/doc/models/shipping-preference.md +++ /dev/null @@ -1,17 +0,0 @@ - -# Shipping Preference - -The location from which the shipping address is derived. - -## Enumeration - -`ShippingPreference` - -## Fields - -| Name | -| --- | -| `GET_FROM_FILE` | -| `NO_SHIPPING` | -| `SET_PROVIDED_ADDRESS` | - diff --git a/doc/models/shipping-type.md b/doc/models/shipping-type.md deleted file mode 100644 index de49788..0000000 --- a/doc/models/shipping-type.md +++ /dev/null @@ -1,18 +0,0 @@ - -# Shipping Type - -A classification for the method of purchase fulfillment. - -## Enumeration - -`ShippingType` - -## Fields - -| Name | -| --- | -| `SHIPPING` | -| `PICKUP` | -| `PICKUP_IN_STORE` | -| `PICKUP_FROM_PERSON` | - diff --git a/doc/models/shipping-with-tracking-details.md b/doc/models/shipping-with-tracking-details.md deleted file mode 100644 index 50002c1..0000000 --- a/doc/models/shipping-with-tracking-details.md +++ /dev/null @@ -1,114 +0,0 @@ - -# Shipping With Tracking Details - -The order shipping details. - -## Structure - -`ShippingWithTrackingDetails` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | [`?ShippingName`](../../doc/models/shipping-name.md) | Optional | The name of the party. | getName(): ?ShippingName | setName(?ShippingName name): void | -| `type` | [`?string(FullfillmentType)`](../../doc/models/fullfillment-type.md) | Optional | 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.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getType(): ?string | setType(?string type): void | -| `options` | [`?(ShippingOption[])`](../../doc/models/shipping-option.md) | Optional | An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.
**Constraints**: *Minimum Items*: `0`, *Maximum Items*: `10` | getOptions(): ?array | setOptions(?array options): void | -| `address` | [`?Address`](../../doc/models/address.md) | Optional | 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). | getAddress(): ?Address | setAddress(?Address address): void | -| `trackers` | [`?(OrderTrackerResponse[])`](../../doc/models/order-tracker-response.md) | Optional | An array of trackers for a transaction. | getTrackers(): ?array | setTrackers(?array trackers): void | - -## Example (as JSON) - -```json -{ - "name": { - "full_name": "full_name6" - }, - "type": "SHIPPING", - "options": [ - { - "id": "id2", - "label": "label2", - "type": "SHIPPING", - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "selected": false - }, - { - "id": "id2", - "label": "label2", - "type": "SHIPPING", - "amount": { - "currency_code": "currency_code6", - "value": "value0" - }, - "selected": false - } - ], - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - }, - "trackers": [ - { - "id": "id2", - "status": "CANCELLED", - "items": [ - { - "name": "name8", - "quantity": "quantity4", - "sku": "sku6", - "url": "url2", - "image_url": "image_url4" - } - ], - "links": [ - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - }, - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - } - ], - "create_time": "create_time8" - }, - { - "id": "id2", - "status": "CANCELLED", - "items": [ - { - "name": "name8", - "quantity": "quantity4", - "sku": "sku6", - "url": "url2", - "image_url": "image_url4" - } - ], - "links": [ - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - }, - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - } - ], - "create_time": "create_time8" - } - ] -} -``` - diff --git a/doc/models/sofort-payment-object.md b/doc/models/sofort-payment-object.md deleted file mode 100644 index ae5fc32..0000000 --- a/doc/models/sofort-payment-object.md +++ /dev/null @@ -1,29 +0,0 @@ - -# Sofort Payment Object - -Information used to pay using Sofort. - -## Structure - -`SofortPaymentObject` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `?string` | Optional | The full name representation like Mr J Smith.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): ?string | setName(?string name): void | -| `countryCode` | `?string` | Optional | 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 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.

**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): ?string | setCountryCode(?string countryCode): void | -| `bic` | `?string` | Optional | The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.
**Constraints**: *Minimum Length*: `8`, *Maximum Length*: `11`, *Pattern*: `^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$` | getBic(): ?string | setBic(?string bic): void | -| `ibanLastChars` | `?string` | Optional | The last characters of the IBAN used to pay.
**Constraints**: *Minimum Length*: `4`, *Maximum Length*: `34`, *Pattern*: `[a-zA-Z0-9]{4}` | getIbanLastChars(): ?string | setIbanLastChars(?string ibanLastChars): void | - -## Example (as JSON) - -```json -{ - "name": "name6", - "country_code": "country_code6", - "bic": "bic8", - "iban_last_chars": "iban_last_chars4" -} -``` - diff --git a/doc/models/sofort-payment-request.md b/doc/models/sofort-payment-request.md deleted file mode 100644 index 02e255b..0000000 --- a/doc/models/sofort-payment-request.md +++ /dev/null @@ -1,33 +0,0 @@ - -# Sofort Payment Request - -Information needed to pay using Sofort. - -## Structure - -`SofortPaymentRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `string` | Required | The full name representation like Mr J Smith.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): string | setName(string name): void | -| `countryCode` | `string` | Required | 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 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.

**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): string | setCountryCode(string countryCode): void | -| `experienceContext` | [`?ExperienceContext`](../../doc/models/experience-context.md) | Optional | Customizes the payer experience during the approval process for the payment. | getExperienceContext(): ?ExperienceContext | setExperienceContext(?ExperienceContext experienceContext): void | - -## Example (as JSON) - -```json -{ - "name": "name4", - "country_code": "country_code4", - "experience_context": { - "brand_name": "brand_name2", - "locale": "locale6", - "shipping_preference": "NO_SHIPPING", - "return_url": "return_url4", - "cancel_url": "cancel_url6" - } -} -``` - diff --git a/doc/models/standard-entry-class-code.md b/doc/models/standard-entry-class-code.md deleted file mode 100644 index f60023f..0000000 --- a/doc/models/standard-entry-class-code.md +++ /dev/null @@ -1,18 +0,0 @@ - -# Standard Entry Class Code - -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 compliant, you’ll need to make sure that you retain a compliant authorization for each transaction that you originate to the ACH Network using this API. ACH transactions are categorized (using SEC codes) by how you capture authorization from the Receiver (the person whose bank account is being debited or credited). PayPal supports the following SEC codes. - -## Enumeration - -`StandardEntryClassCode` - -## Fields - -| Name | -| --- | -| `TEL` | -| `WEB` | -| `CCD` | -| `PPD` | - diff --git a/doc/models/store-in-vault-instruction.md b/doc/models/store-in-vault-instruction.md deleted file mode 100644 index ece80a5..0000000 --- a/doc/models/store-in-vault-instruction.md +++ /dev/null @@ -1,15 +0,0 @@ - -# Store in Vault Instruction - -Defines how and when the payment source gets vaulted. - -## Enumeration - -`StoreInVaultInstruction` - -## Fields - -| Name | -| --- | -| `ON_SUCCESS` | - diff --git a/doc/models/stored-payment-source-payment-type.md b/doc/models/stored-payment-source-payment-type.md deleted file mode 100644 index 28d25b3..0000000 --- a/doc/models/stored-payment-source-payment-type.md +++ /dev/null @@ -1,17 +0,0 @@ - -# Stored Payment Source Payment Type - -Indicates the type of the stored payment_source payment. - -## Enumeration - -`StoredPaymentSourcePaymentType` - -## Fields - -| Name | -| --- | -| `ONE_TIME` | -| `RECURRING` | -| `UNSCHEDULED` | - diff --git a/doc/models/stored-payment-source-usage-type.md b/doc/models/stored-payment-source-usage-type.md deleted file mode 100644 index 30a870d..0000000 --- a/doc/models/stored-payment-source-usage-type.md +++ /dev/null @@ -1,17 +0,0 @@ - -# Stored Payment Source Usage Type - -Indicates if this is a `first` or `subsequent` payment using a stored payment source (also referred to as stored credential or card on file). - -## Enumeration - -`StoredPaymentSourceUsageType` - -## Fields - -| Name | -| --- | -| `FIRST` | -| `SUBSEQUENT` | -| `DERIVED` | - diff --git a/doc/models/stored-payment-source.md b/doc/models/stored-payment-source.md deleted file mode 100644 index d42ed1f..0000000 --- a/doc/models/stored-payment-source.md +++ /dev/null @@ -1,34 +0,0 @@ - -# 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).
Parameter compatibility:
- -## Structure - -`StoredPaymentSource` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `paymentInitiator` | [`string(PaymentInitiator)`](../../doc/models/payment-initiator.md) | Required | The person or party who initiated or triggered the payment.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getPaymentInitiator(): string | setPaymentInitiator(string paymentInitiator): void | -| `paymentType` | [`string(StoredPaymentSourcePaymentType)`](../../doc/models/stored-payment-source-payment-type.md) | Required | Indicates the type of the stored payment_source payment.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getPaymentType(): string | setPaymentType(string paymentType): void | -| `usage` | [`?string(StoredPaymentSourceUsageType)`](../../doc/models/stored-payment-source-usage-type.md) | Optional | Indicates if this is a `first` or `subsequent` payment using a stored payment source (also referred to as stored credential or card on file).
**Default**: `StoredPaymentSourceUsageType::DERIVED`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getUsage(): ?string | setUsage(?string usage): void | -| `previousNetworkTransactionReference` | [`?NetworkTransactionReference`](../../doc/models/network-transaction-reference.md) | Optional | Reference values used by the card network to identify a transaction. | getPreviousNetworkTransactionReference(): ?NetworkTransactionReference | setPreviousNetworkTransactionReference(?NetworkTransactionReference previousNetworkTransactionReference): void | - -## Example (as JSON) - -```json -{ - "payment_initiator": "CUSTOMER", - "payment_type": "RECURRING", - "usage": "DERIVED", - "previous_network_transaction_reference": { - "id": "id6", - "date": "date2", - "network": "VISA", - "acquirer_reference_number": "acquirer_reference_number8" - } -} -``` - diff --git a/doc/models/supplementary-data.md b/doc/models/supplementary-data.md deleted file mode 100644 index 134e39d..0000000 --- a/doc/models/supplementary-data.md +++ /dev/null @@ -1,54 +0,0 @@ - -# Supplementary Data - -Supplementary data about a payment. This object passes information that can be used to improve risk assessments and processing costs, for example, by providing Level 2 and Level 3 payment data. - -## Structure - -`SupplementaryData` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `card` | [`?CardSupplementaryData`](../../doc/models/card-supplementary-data.md) | Optional | 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. | getCard(): ?CardSupplementaryData | setCard(?CardSupplementaryData card): void | - -## Example (as JSON) - -```json -{ - "card": { - "level_2": { - "invoice_id": "invoice_id4", - "tax_total": { - "currency_code": "currency_code4", - "value": "value0" - } - }, - "level_3": { - "shipping_amount": { - "currency_code": "currency_code0", - "value": "value6" - }, - "duty_amount": { - "currency_code": "currency_code6", - "value": "value2" - }, - "discount_amount": { - "currency_code": "currency_code2", - "value": "value8" - }, - "shipping_address": { - "address_line_1": "address_line_10", - "address_line_2": "address_line_20", - "admin_area_2": "admin_area_24", - "admin_area_1": "admin_area_16", - "postal_code": "postal_code2", - "country_code": "country_code0" - }, - "ships_from_postal_code": "ships_from_postal_code4" - } - } -} -``` - diff --git a/doc/models/supplementary-purchase-data.md b/doc/models/supplementary-purchase-data.md deleted file mode 100644 index 2b668a1..0000000 --- a/doc/models/supplementary-purchase-data.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Supplementary Purchase Data - -The capture identification-related fields. Includes the invoice ID, custom ID, note to payer, and soft descriptor. - -## Structure - -`SupplementaryPurchaseData` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `invoiceId` | `?string` | Optional | 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.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127`, *Pattern*: `^.{1,127}$` | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void | -| `noteToPayer` | `?string` | Optional | An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^.{1,255}$` | getNoteToPayer(): ?string | setNoteToPayer(?string noteToPayer): void | - -## Example (as JSON) - -```json -{ - "invoice_id": "invoice_id8", - "note_to_payer": "note_to_payer0" -} -``` - diff --git a/doc/models/tax-id-type.md b/doc/models/tax-id-type.md deleted file mode 100644 index 9a846e4..0000000 --- a/doc/models/tax-id-type.md +++ /dev/null @@ -1,16 +0,0 @@ - -# Tax Id Type - -The customer's tax ID type. - -## Enumeration - -`TaxIdType` - -## Fields - -| Name | -| --- | -| `BR_CPF` | -| `BR_CNPJ` | - diff --git a/doc/models/tax-info.md b/doc/models/tax-info.md deleted file mode 100644 index 2cabd07..0000000 --- a/doc/models/tax-info.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Tax Info - -The tax ID of the customer. The customer is also known as the payer. Both `tax_id` and `tax_id_type` are required. - -## Structure - -`TaxInfo` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `taxId` | `string` | Required | The customer's tax ID value.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `14`, *Pattern*: `([a-zA-Z0-9])` | getTaxId(): string | setTaxId(string taxId): void | -| `taxIdType` | [`string(TaxIdType)`](../../doc/models/tax-id-type.md) | Required | The customer's tax ID type.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `14`, *Pattern*: `^[A-Z0-9_]+$` | getTaxIdType(): string | setTaxIdType(string taxIdType): void | - -## Example (as JSON) - -```json -{ - "tax_id": "tax_id0", - "tax_id_type": "BR_CPF" -} -``` - diff --git a/doc/models/three-d-secure-authentication-response.md b/doc/models/three-d-secure-authentication-response.md deleted file mode 100644 index 61606a3..0000000 --- a/doc/models/three-d-secure-authentication-response.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Three D Secure Authentication Response - -Results of 3D Secure Authentication. - -## Structure - -`ThreeDSecureAuthenticationResponse` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `authenticationStatus` | [`?string(PAResStatus)`](../../doc/models/pa-res-status.md) | Optional | Transactions status result identifier. The outcome of the issuer's authentication.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getAuthenticationStatus(): ?string | setAuthenticationStatus(?string authenticationStatus): void | -| `enrollmentStatus` | [`?string(EnrollmentStatus)`](../../doc/models/enrollment-status.md) | Optional | Status of Authentication eligibility.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getEnrollmentStatus(): ?string | setEnrollmentStatus(?string enrollmentStatus): void | - -## Example (as JSON) - -```json -{ - "authentication_status": "C", - "enrollment_status": "Y" -} -``` - diff --git a/doc/models/token-type.md b/doc/models/token-type.md deleted file mode 100644 index 0001c8b..0000000 --- a/doc/models/token-type.md +++ /dev/null @@ -1,16 +0,0 @@ - -# Token Type - -The tokenization method that generated the ID. - -## Enumeration - -`TokenType` - -## Fields - -| Name | -| --- | -| `BILLING_AGREEMENT` | -| `SETUP_TOKEN` | - diff --git a/doc/models/token.md b/doc/models/token.md deleted file mode 100644 index 1539d57..0000000 --- a/doc/models/token.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Token - -The tokenized payment source to fund a payment. - -## Structure - -`Token` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `id` | `string` | Required | The PayPal-generated ID for the token.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9a-zA-Z_-]+$` | getId(): string | setId(string id): void | -| `type` | [`string(TokenType)`](../../doc/models/token-type.md) | Required | The tokenization method that generated the ID.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_-]+$` | getType(): string | setType(string type): void | - -## Example (as JSON) - -```json -{ - "id": "id6", - "type": "BILLING_AGREEMENT" -} -``` - diff --git a/doc/models/trustly-payment-object.md b/doc/models/trustly-payment-object.md deleted file mode 100644 index 1659b98..0000000 --- a/doc/models/trustly-payment-object.md +++ /dev/null @@ -1,29 +0,0 @@ - -# Trustly Payment Object - -Information needed to pay using Trustly. - -## Structure - -`TrustlyPaymentObject` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `?string` | Optional | The full name representation like Mr J Smith.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): ?string | setName(?string name): void | -| `countryCode` | `?string` | Optional | 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 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.

**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): ?string | setCountryCode(?string countryCode): void | -| `bic` | `?string` | Optional | The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.
**Constraints**: *Minimum Length*: `8`, *Maximum Length*: `11`, *Pattern*: `^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$` | getBic(): ?string | setBic(?string bic): void | -| `ibanLastChars` | `?string` | Optional | The last characters of the IBAN used to pay.
**Constraints**: *Minimum Length*: `4`, *Maximum Length*: `34`, *Pattern*: `[a-zA-Z0-9]{4}` | getIbanLastChars(): ?string | setIbanLastChars(?string ibanLastChars): void | - -## Example (as JSON) - -```json -{ - "name": "name6", - "country_code": "country_code6", - "bic": "bic8", - "iban_last_chars": "iban_last_chars4" -} -``` - diff --git a/doc/models/trustly-payment-request.md b/doc/models/trustly-payment-request.md deleted file mode 100644 index 95e4044..0000000 --- a/doc/models/trustly-payment-request.md +++ /dev/null @@ -1,33 +0,0 @@ - -# Trustly Payment Request - -Information needed to pay using Trustly. - -## Structure - -`TrustlyPaymentRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | `string` | Required | The full name representation like Mr J Smith.
**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): string | setName(string name): void | -| `countryCode` | `string` | Required | 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 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.

**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): string | setCountryCode(string countryCode): void | -| `experienceContext` | [`?ExperienceContext`](../../doc/models/experience-context.md) | Optional | Customizes the payer experience during the approval process for the payment. | getExperienceContext(): ?ExperienceContext | setExperienceContext(?ExperienceContext experienceContext): void | - -## Example (as JSON) - -```json -{ - "name": "name2", - "country_code": "country_code2", - "experience_context": { - "brand_name": "brand_name2", - "locale": "locale6", - "shipping_preference": "NO_SHIPPING", - "return_url": "return_url4", - "cancel_url": "cancel_url6" - } -} -``` - diff --git a/doc/models/universal-product-code.md b/doc/models/universal-product-code.md deleted file mode 100644 index 96af0d7..0000000 --- a/doc/models/universal-product-code.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Universal Product Code - -The Universal Product Code of the item. - -## Structure - -`UniversalProductCode` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `type` | [`string(UPCType)`](../../doc/models/upc-type.md) | Required | The Universal Product Code type.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `5`, *Pattern*: `^[0-9A-Z_-]+$` | getType(): string | setType(string type): void | -| `code` | `string` | Required | The UPC product code of the item.
**Constraints**: *Minimum Length*: `6`, *Maximum Length*: `17`, *Pattern*: `^[0-9]{0,17}$` | getCode(): string | setCode(string code): void | - -## Example (as JSON) - -```json -{ - "type": "UPC-E", - "code": "code2" -} -``` - diff --git a/doc/models/upc-type.md b/doc/models/upc-type.md deleted file mode 100644 index 720374a..0000000 --- a/doc/models/upc-type.md +++ /dev/null @@ -1,21 +0,0 @@ - -# UPC Type - -The Universal Product Code type. - -## Enumeration - -`UPCType` - -## Fields - -| Name | -| --- | -| `UPCA` | -| `UPCB` | -| `UPCC` | -| `UPCD` | -| `UPCE` | -| `UPC2` | -| `UPC5` | - diff --git a/doc/models/vault-customer.md b/doc/models/vault-customer.md deleted file mode 100644 index 63fbb5d..0000000 --- a/doc/models/vault-customer.md +++ /dev/null @@ -1,23 +0,0 @@ - -# Vault Customer - -The details about a customer in PayPal's system of record. - -## Structure - -`VaultCustomer` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `id` | `?string` | Optional | The unique ID for a customer generated by PayPal.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `22`, *Pattern*: `^[0-9a-zA-Z_-]+$` | getId(): ?string | setId(?string id): void | - -## Example (as JSON) - -```json -{ - "id": "id2" -} -``` - diff --git a/doc/models/vault-experience-context.md b/doc/models/vault-experience-context.md deleted file mode 100644 index 2ff0802..0000000 --- a/doc/models/vault-experience-context.md +++ /dev/null @@ -1,33 +0,0 @@ - -# Vault Experience Context - -Customizes the Vault creation flow experience for your customers. - -## Structure - -`VaultExperienceContext` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `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.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `300`, *Pattern*: `^.*$` | getBrandName(): ?string | setBrandName(?string brandName): void | -| `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/).
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `10`, *Pattern*: `^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}\|[0-9]{3}))?$` | getLocale(): ?string | setLocale(?string locale): void | -| `returnUrl` | `?string` | Optional | The URL where the customer is redirected after customer approves leaves the flow. It is a required field for contingency flows like PayPal wallet, 3DS.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `4000` | getReturnUrl(): ?string | setReturnUrl(?string returnUrl): void | -| `cancelUrl` | `?string` | Optional | The URL where the customer is redirected after customer cancels or leaves the flow. It is a required field for contingency flows like PayPal wallet, 3DS.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `4000` | getCancelUrl(): ?string | setCancelUrl(?string cancelUrl): void | -| `shippingPreference` | `?string` | Optional | The shipping preference. This only applies to PayPal payment source.
**Default**: `'GET_FROM_FILE'`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getShippingPreference(): ?string | setShippingPreference(?string shippingPreference): void | -| `vaultInstruction` | `?string` | Optional | Vault Instruction on action to be performed after a successful payer approval.
**Default**: `'ON_CREATE_PAYMENT_TOKENS'`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getVaultInstruction(): ?string | setVaultInstruction(?string vaultInstruction): void | - -## Example (as JSON) - -```json -{ - "shipping_preference": "GET_FROM_FILE", - "vault_instruction": "ON_CREATE_PAYMENT_TOKENS", - "brand_name": "brand_name0", - "locale": "locale4", - "return_url": "return_url2", - "cancel_url": "cancel_url4" -} -``` - diff --git a/doc/models/vault-instruction-base.md b/doc/models/vault-instruction-base.md deleted file mode 100644 index c1f6802..0000000 --- a/doc/models/vault-instruction-base.md +++ /dev/null @@ -1,23 +0,0 @@ - -# Vault Instruction Base - -Basic vault instruction specification that can be extended by specific payment sources that supports vaulting. - -## Structure - -`VaultInstructionBase` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `storeInVault` | [`?string(StoreInVaultInstruction)`](../../doc/models/store-in-vault-instruction.md) | Optional | Defines how and when the payment source gets vaulted.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getStoreInVault(): ?string | setStoreInVault(?string storeInVault): void | - -## Example (as JSON) - -```json -{ - "store_in_vault": "ON_SUCCESS" -} -``` - diff --git a/doc/models/vault-instruction.md b/doc/models/vault-instruction.md deleted file mode 100644 index 912d07c..0000000 --- a/doc/models/vault-instruction.md +++ /dev/null @@ -1,23 +0,0 @@ - -# Vault Instruction - -Base vaulting specification. The object can be extended for specific use cases within each payment_source that supports vaulting. - -## Structure - -`VaultInstruction` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `storeInVault` | [`string(StoreInVaultInstruction)`](../../doc/models/store-in-vault-instruction.md) | Required | Defines how and when the payment source gets vaulted.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getStoreInVault(): string | setStoreInVault(string storeInVault): void | - -## Example (as JSON) - -```json -{ - "store_in_vault": "ON_SUCCESS" -} -``` - diff --git a/doc/models/vault-pay-pal-wallet-request.md b/doc/models/vault-pay-pal-wallet-request.md deleted file mode 100644 index 3fc2ad3..0000000 --- a/doc/models/vault-pay-pal-wallet-request.md +++ /dev/null @@ -1,45 +0,0 @@ - -# Vault Pay Pal Wallet Request - -A resource representing a request to vault PayPal Wallet. - -## Structure - -`VaultPayPalWalletRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `description` | `?string` | Optional | The description displayed to the consumer on the approval flow for a digital wallet, as well as on the merchant view of the payment token management experience. exp: PayPal.com.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128`, *Pattern*: `^.*$` | getDescription(): ?string | setDescription(?string description): void | -| `shipping` | [`?VaultedDigitalWalletShippingDetails`](../../doc/models/vaulted-digital-wallet-shipping-details.md) | Optional | The shipping details. | getShipping(): ?VaultedDigitalWalletShippingDetails | setShipping(?VaultedDigitalWalletShippingDetails shipping): void | -| `permitMultiplePaymentTokens` | `?bool` | Optional | Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same PayPal account. This only applies to PayPal payment source.
**Default**: `false` | getPermitMultiplePaymentTokens(): ?bool | setPermitMultiplePaymentTokens(?bool permitMultiplePaymentTokens): void | -| `usageType` | `?string` | Optional | The usage type associated with a digital wallet payment token.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getUsageType(): ?string | setUsageType(?string usageType): void | -| `customerType` | `?string` | Optional | 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.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getCustomerType(): ?string | setCustomerType(?string customerType): void | -| `experienceContext` | [`?VaultExperienceContext`](../../doc/models/vault-experience-context.md) | Optional | Customizes the Vault creation flow experience for your customers. | getExperienceContext(): ?VaultExperienceContext | setExperienceContext(?VaultExperienceContext experienceContext): void | - -## Example (as JSON) - -```json -{ - "permit_multiple_payment_tokens": false, - "description": "description0", - "shipping": { - "name": { - "full_name": "full_name6" - }, - "type": "SHIPPING", - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - } - }, - "usage_type": "usage_type0", - "customer_type": "customer_type6" -} -``` - diff --git a/doc/models/vault-response.md b/doc/models/vault-response.md deleted file mode 100644 index c3a27eb..0000000 --- a/doc/models/vault-response.md +++ /dev/null @@ -1,37 +0,0 @@ - -# Vault Response - -The details about a saved payment source. - -## Structure - -`VaultResponse` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `id` | `?string` | Optional | The PayPal-generated ID for the saved payment source.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | getId(): ?string | setId(?string id): void | -| `status` | [`?string(VaultStatus)`](../../doc/models/vault-status.md) | Optional | The vault status.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getStatus(): ?string | setStatus(?string status): void | -| `customer` | [`?VaultCustomer`](../../doc/models/vault-customer.md) | Optional | The details about a customer in PayPal's system of record. | getCustomer(): ?VaultCustomer | setCustomer(?VaultCustomer customer): void | -| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of request-related HATEOAS links.
**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `10` | getLinks(): ?array | setLinks(?array links): void | - -## Example (as JSON) - -```json -{ - "id": "id2", - "status": "CREATED", - "customer": { - "id": "id0" - }, - "links": [ - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - } - ] -} -``` - diff --git a/doc/models/vault-sepa-debit-response.md b/doc/models/vault-sepa-debit-response.md deleted file mode 100644 index 41fcb52..0000000 --- a/doc/models/vault-sepa-debit-response.md +++ /dev/null @@ -1,37 +0,0 @@ - -# Vault SEPA Debit Response - -An API resource used in the response of securely storing a SEPA Debit. - -## Structure - -`VaultSEPADebitResponse` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `ibanLastChars` | `?string` | Optional | The last characters of the IBAN used to pay.
**Constraints**: *Minimum Length*: `4`, *Maximum Length*: `34`, *Pattern*: `[a-zA-Z0-9]{4}` | getIbanLastChars(): ?string | setIbanLastChars(?string ibanLastChars): void | -| `accountHolderName` | `mixed` | Optional | - | getAccountHolderName(): | setAccountHolderName( accountHolderName): void | -| `billingAddress` | [`?Address`](../../doc/models/address.md) | Optional | 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). | getBillingAddress(): ?Address | setBillingAddress(?Address billingAddress): void | - -## Example (as JSON) - -```json -{ - "iban_last_chars": "iban_last_chars8", - "account_holder_name": { - "key1": "val1", - "key2": "val2" - }, - "billing_address": { - "address_line_1": "address_line_12", - "address_line_2": "address_line_28", - "admin_area_2": "admin_area_28", - "admin_area_1": "admin_area_14", - "postal_code": "postal_code0", - "country_code": "country_code8" - } -} -``` - diff --git a/doc/models/vault-status.md b/doc/models/vault-status.md deleted file mode 100644 index 042bb3c..0000000 --- a/doc/models/vault-status.md +++ /dev/null @@ -1,17 +0,0 @@ - -# Vault Status - -The vault status. - -## Enumeration - -`VaultStatus` - -## Fields - -| Name | -| --- | -| `VAULTED` | -| `CREATED` | -| `APPROVED` | - diff --git a/doc/models/vault-token-request.md b/doc/models/vault-token-request.md deleted file mode 100644 index 8640563..0000000 --- a/doc/models/vault-token-request.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Vault Token Request - -The Tokenized Payment Source representing a Request to Vault a Token. - -## Structure - -`VaultTokenRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `id` | `string` | Required | The PayPal-generated ID for the token.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Za-z_-]+$` | getId(): string | setId(string id): void | -| `type` | [`string(TokenType)`](../../doc/models/token-type.md) | Required | The tokenization method that generated the ID.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_-]+$` | getType(): string | setType(string type): void | - -## Example (as JSON) - -```json -{ - "id": "id8", - "type": "BILLING_AGREEMENT" -} -``` - diff --git a/doc/models/vault-venmo-experience-context.md b/doc/models/vault-venmo-experience-context.md deleted file mode 100644 index c2f75f2..0000000 --- a/doc/models/vault-venmo-experience-context.md +++ /dev/null @@ -1,27 +0,0 @@ - -# Vault Venmo Experience Context - -Customizes the Vault creation flow experience for your customers. - -## Structure - -`VaultVenmoExperienceContext` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `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.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `300`, *Pattern*: `^.*$` | getBrandName(): ?string | setBrandName(?string brandName): void | -| `shippingPreference` | `?string` | Optional | The shipping preference. This only applies to PayPal payment source.
**Default**: `'GET_FROM_FILE'`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getShippingPreference(): ?string | setShippingPreference(?string shippingPreference): void | -| `vaultInstruction` | `?string` | Optional | Vault Instruction on action to be performed after a successful payer approval.
**Default**: `'ON_CREATE_PAYMENT_TOKENS'`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getVaultInstruction(): ?string | setVaultInstruction(?string vaultInstruction): void | - -## Example (as JSON) - -```json -{ - "shipping_preference": "GET_FROM_FILE", - "vault_instruction": "ON_CREATE_PAYMENT_TOKENS", - "brand_name": "brand_name0" -} -``` - diff --git a/doc/models/vault-venmo-request.md b/doc/models/vault-venmo-request.md deleted file mode 100644 index eb6ba74..0000000 --- a/doc/models/vault-venmo-request.md +++ /dev/null @@ -1,43 +0,0 @@ - -# Vault Venmo Request - -## Structure - -`VaultVenmoRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `description` | `?string` | Optional | The description displayed to the consumer on the approval flow for a digital wallet, as well as on the merchant view of the payment token management experience. exp: PayPal.com.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128`, *Pattern*: `^.*$` | getDescription(): ?string | setDescription(?string description): void | -| `shipping` | [`?VaultedDigitalWalletShippingDetails`](../../doc/models/vaulted-digital-wallet-shipping-details.md) | Optional | The shipping details. | getShipping(): ?VaultedDigitalWalletShippingDetails | setShipping(?VaultedDigitalWalletShippingDetails shipping): void | -| `permitMultiplePaymentTokens` | `?bool` | Optional | Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same PayPal account. This only applies to PayPal payment source.
**Default**: `false` | getPermitMultiplePaymentTokens(): ?bool | setPermitMultiplePaymentTokens(?bool permitMultiplePaymentTokens): void | -| `usageType` | `?string` | Optional | The usage type associated with a digital wallet payment token.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getUsageType(): ?string | setUsageType(?string usageType): void | -| `customerType` | `?string` | Optional | 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.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getCustomerType(): ?string | setCustomerType(?string customerType): void | -| `experienceContext` | [`?VaultVenmoExperienceContext`](../../doc/models/vault-venmo-experience-context.md) | Optional | Customizes the Vault creation flow experience for your customers. | getExperienceContext(): ?VaultVenmoExperienceContext | setExperienceContext(?VaultVenmoExperienceContext experienceContext): void | - -## Example (as JSON) - -```json -{ - "permit_multiple_payment_tokens": false, - "description": "description0", - "shipping": { - "name": { - "full_name": "full_name6" - }, - "type": "SHIPPING", - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - } - }, - "usage_type": "usage_type0", - "customer_type": "customer_type4" -} -``` - diff --git a/doc/models/vaulted-digital-wallet-shipping-details.md b/doc/models/vaulted-digital-wallet-shipping-details.md deleted file mode 100644 index d2ba5c4..0000000 --- a/doc/models/vaulted-digital-wallet-shipping-details.md +++ /dev/null @@ -1,36 +0,0 @@ - -# Vaulted Digital Wallet Shipping Details - -The shipping details. - -## Structure - -`VaultedDigitalWalletShippingDetails` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `name` | [`?ShippingName`](../../doc/models/shipping-name.md) | Optional | The name of the party. | getName(): ?ShippingName | setName(?ShippingName name): void | -| `type` | [`?string(FullfillmentType)`](../../doc/models/fullfillment-type.md) | Optional | 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.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getType(): ?string | setType(?string type): void | -| `address` | [`?Address`](../../doc/models/address.md) | Optional | 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). | getAddress(): ?Address | setAddress(?Address address): void | - -## Example (as JSON) - -```json -{ - "name": { - "full_name": "full_name6" - }, - "type": "PICKUP_IN_STORE", - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - } -} -``` - diff --git a/doc/models/vaulted-digital-wallet.md b/doc/models/vaulted-digital-wallet.md deleted file mode 100644 index 1a2333c..0000000 --- a/doc/models/vaulted-digital-wallet.md +++ /dev/null @@ -1,44 +0,0 @@ - -# Vaulted Digital Wallet - -Resource consolidating common request and response attributes for vaulting a Digital Wallet. - -## Structure - -`VaultedDigitalWallet` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `description` | `?string` | Optional | The description displayed to the consumer on the approval flow for a digital wallet, as well as on the merchant view of the payment token management experience. exp: PayPal.com.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128`, *Pattern*: `^.*$` | getDescription(): ?string | setDescription(?string description): void | -| `shipping` | [`?VaultedDigitalWalletShippingDetails`](../../doc/models/vaulted-digital-wallet-shipping-details.md) | Optional | The shipping details. | getShipping(): ?VaultedDigitalWalletShippingDetails | setShipping(?VaultedDigitalWalletShippingDetails shipping): void | -| `permitMultiplePaymentTokens` | `?bool` | Optional | Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same PayPal account. This only applies to PayPal payment source.
**Default**: `false` | getPermitMultiplePaymentTokens(): ?bool | setPermitMultiplePaymentTokens(?bool permitMultiplePaymentTokens): void | -| `usageType` | `?string` | Optional | The usage type associated with a digital wallet payment token.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getUsageType(): ?string | setUsageType(?string usageType): void | -| `customerType` | `?string` | Optional | 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.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getCustomerType(): ?string | setCustomerType(?string customerType): void | - -## Example (as JSON) - -```json -{ - "permit_multiple_payment_tokens": false, - "description": "description2", - "shipping": { - "name": { - "full_name": "full_name6" - }, - "type": "SHIPPING", - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - } - }, - "usage_type": "usage_type2", - "customer_type": "customer_type6" -} -``` - diff --git a/doc/models/venmo-payment-token-customer-type.md b/doc/models/venmo-payment-token-customer-type.md deleted file mode 100644 index 229a38c..0000000 --- a/doc/models/venmo-payment-token-customer-type.md +++ /dev/null @@ -1,16 +0,0 @@ - -# Venmo Payment Token Customer Type - -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. - -## Enumeration - -`VenmoPaymentTokenCustomerType` - -## Fields - -| Name | -| --- | -| `CONSUMER` | -| `BUSINESS` | - diff --git a/doc/models/venmo-payment-token-usage-pattern.md b/doc/models/venmo-payment-token-usage-pattern.md deleted file mode 100644 index a6ab607..0000000 --- a/doc/models/venmo-payment-token-usage-pattern.md +++ /dev/null @@ -1,20 +0,0 @@ - -# Venmo Payment Token Usage Pattern - -Expected business/pricing model for the billing agreement. - -## Enumeration - -`VenmoPaymentTokenUsagePattern` - -## Fields - -| Name | -| --- | -| `IMMEDIATE` | -| `DEFERRED` | -| `RECURRING_PREPAID` | -| `RECURRING_POSTPAID` | -| `THRESHOLD_PREPAID` | -| `THRESHOLD_POSTPAID` | - diff --git a/doc/models/venmo-payment-token-usage-type.md b/doc/models/venmo-payment-token-usage-type.md deleted file mode 100644 index 6a67f04..0000000 --- a/doc/models/venmo-payment-token-usage-type.md +++ /dev/null @@ -1,16 +0,0 @@ - -# Venmo Payment Token Usage Type - -The usage type associated with the Venmo payment token. - -## Enumeration - -`VenmoPaymentTokenUsageType` - -## Fields - -| Name | -| --- | -| `MERCHANT` | -| `PLATFORM` | - diff --git a/doc/models/venmo-payment-token.md b/doc/models/venmo-payment-token.md deleted file mode 100644 index 81dd162..0000000 --- a/doc/models/venmo-payment-token.md +++ /dev/null @@ -1,48 +0,0 @@ - -# Venmo Payment Token - -## Structure - -`VenmoPaymentToken` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `description` | `?string` | Optional | The description displayed to the consumer on the approval flow for a digital wallet, as well as on the merchant view of the payment token management experience. exp: PayPal.com.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128`, *Pattern*: `^.*$` | getDescription(): ?string | setDescription(?string description): void | -| `shipping` | [`?VaultedDigitalWalletShippingDetails`](../../doc/models/vaulted-digital-wallet-shipping-details.md) | Optional | The shipping details. | getShipping(): ?VaultedDigitalWalletShippingDetails | setShipping(?VaultedDigitalWalletShippingDetails shipping): void | -| `permitMultiplePaymentTokens` | `?bool` | Optional | Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same PayPal account. This only applies to PayPal payment source.
**Default**: `false` | getPermitMultiplePaymentTokens(): ?bool | setPermitMultiplePaymentTokens(?bool permitMultiplePaymentTokens): void | -| `usageType` | `?string` | Optional | The usage type associated with a digital wallet payment token.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getUsageType(): ?string | setUsageType(?string usageType): void | -| `customerType` | `?string` | Optional | 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.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getCustomerType(): ?string | setCustomerType(?string customerType): 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.

**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: `(?:[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\|\[(?:(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9])\|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void | -| `payerId` | `?string` | Optional | The account identifier for a PayPal account.
**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `13`, *Pattern*: `^[2-9A-HJ-NP-Z]{13}$` | getPayerId(): ?string | setPayerId(?string payerId): void | -| `name` | [`?Name`](../../doc/models/name.md) | Optional | The name of the party. | getName(): ?Name | setName(?Name name): void | -| `phone` | [`?PhoneWithType`](../../doc/models/phone-with-type.md) | Optional | The phone information. | getPhone(): ?PhoneWithType | setPhone(?PhoneWithType phone): void | -| `address` | [`?Address`](../../doc/models/address.md) | Optional | 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). | getAddress(): ?Address | setAddress(?Address address): void | -| `userName` | `?string` | Optional | The Venmo username, as chosen by the user.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `50`, *Pattern*: `^[-a-zA-Z0-9_]*$` | getUserName(): ?string | setUserName(?string userName): void | - -## Example (as JSON) - -```json -{ - "permit_multiple_payment_tokens": false, - "description": "description4", - "shipping": { - "name": { - "full_name": "full_name6" - }, - "type": "SHIPPING", - "address": { - "address_line_1": "address_line_16", - "address_line_2": "address_line_26", - "admin_area_2": "admin_area_20", - "admin_area_1": "admin_area_12", - "postal_code": "postal_code8", - "country_code": "country_code6" - } - }, - "usage_type": "usage_type4", - "customer_type": "customer_type8" -} -``` - diff --git a/doc/models/venmo-wallet-additional-attributes.md b/doc/models/venmo-wallet-additional-attributes.md deleted file mode 100644 index 83af2ba..0000000 --- a/doc/models/venmo-wallet-additional-attributes.md +++ /dev/null @@ -1,35 +0,0 @@ - -# Venmo Wallet Additional Attributes - -Additional attributes associated with the use of this Venmo Wallet. - -## Structure - -`VenmoWalletAdditionalAttributes` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `customer` | [`?VenmoWalletCustomerInformation`](../../doc/models/venmo-wallet-customer-information.md) | Optional | The details about a customer in PayPal's system of record. | getCustomer(): ?VenmoWalletCustomerInformation | setCustomer(?VenmoWalletCustomerInformation customer): void | -| `vault` | [`?VenmoWalletVaultAttributes`](../../doc/models/venmo-wallet-vault-attributes.md) | Optional | Resource consolidating common request and response attirbutes for vaulting Venmo Wallet. | getVault(): ?VenmoWalletVaultAttributes | setVault(?VenmoWalletVaultAttributes vault): void | - -## Example (as JSON) - -```json -{ - "customer": { - "id": "id0", - "email_address": "email_address2" - }, - "vault": { - "store_in_vault": "ON_SUCCESS", - "description": "description6", - "usage_pattern": "THRESHOLD_PREPAID", - "usage_type": "MERCHANT", - "customer_type": "CONSUMER", - "permit_multiple_payment_tokens": false - } -} -``` - diff --git a/doc/models/venmo-wallet-attributes-response.md b/doc/models/venmo-wallet-attributes-response.md deleted file mode 100644 index 2c52332..0000000 --- a/doc/models/venmo-wallet-attributes-response.md +++ /dev/null @@ -1,36 +0,0 @@ - -# Venmo Wallet Attributes Response - -Additional attributes associated with the use of a Venmo Wallet. - -## Structure - -`VenmoWalletAttributesResponse` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `vault` | [`?VaultResponse`](../../doc/models/vault-response.md) | Optional | The details about a saved payment source. | getVault(): ?VaultResponse | setVault(?VaultResponse vault): void | - -## Example (as JSON) - -```json -{ - "vault": { - "id": "id6", - "status": "APPROVED", - "customer": { - "id": "id0" - }, - "links": [ - { - "href": "href6", - "rel": "rel0", - "method": "HEAD" - } - ] - } -} -``` - diff --git a/doc/models/venmo-wallet-customer-information.md b/doc/models/venmo-wallet-customer-information.md deleted file mode 100644 index 5741112..0000000 --- a/doc/models/venmo-wallet-customer-information.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Venmo Wallet Customer Information - -The details about a customer in PayPal's system of record. - -## Structure - -`VenmoWalletCustomerInformation` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `id` | `?string` | Optional | The unique ID for a customer generated by PayPal.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `22`, *Pattern*: `^[0-9a-zA-Z_-]+$` | getId(): ?string | setId(?string id): 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.

**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: `(?:[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\|\[(?:(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9])\|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void | - -## Example (as JSON) - -```json -{ - "id": "id4", - "email_address": "email_address2" -} -``` - diff --git a/doc/models/venmo-wallet-experience-context.md b/doc/models/venmo-wallet-experience-context.md deleted file mode 100644 index 53fc873..0000000 --- a/doc/models/venmo-wallet-experience-context.md +++ /dev/null @@ -1,25 +0,0 @@ - -# Venmo Wallet 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.
- -## Structure - -`VenmoWalletExperienceContext` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `brandName` | `?string` | Optional | The business name of the merchant. The pattern is defined by an external party and supports Unicode.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127`, *Pattern*: `^.*$` | getBrandName(): ?string | setBrandName(?string brandName): void | -| `shippingPreference` | [`?string(ShippingPreference)`](../../doc/models/shipping-preference.md) | Optional | The location from which the shipping address is derived.
**Default**: `ShippingPreference::GET_FROM_FILE`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `24`, *Pattern*: `^[A-Z_]+$` | getShippingPreference(): ?string | setShippingPreference(?string shippingPreference): void | - -## Example (as JSON) - -```json -{ - "shipping_preference": "GET_FROM_FILE", - "brand_name": "brand_name6" -} -``` - diff --git a/doc/models/venmo-wallet-request.md b/doc/models/venmo-wallet-request.md deleted file mode 100644 index 438165f..0000000 --- a/doc/models/venmo-wallet-request.md +++ /dev/null @@ -1,45 +0,0 @@ - -# Venmo Wallet Request - -Information needed to pay using Venmo. - -## Structure - -`VenmoWalletRequest` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `vaultId` | `?string` | Optional | The PayPal-generated ID for the vaulted payment source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9a-zA-Z_-]+$` | getVaultId(): ?string | setVaultId(?string vaultId): 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.

**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: `(?:[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\|\[(?:(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9])\|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void | -| `experienceContext` | [`?VenmoWalletExperienceContext`](../../doc/models/venmo-wallet-experience-context.md) | Optional | 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.
| getExperienceContext(): ?VenmoWalletExperienceContext | setExperienceContext(?VenmoWalletExperienceContext experienceContext): void | -| `attributes` | [`?VenmoWalletAdditionalAttributes`](../../doc/models/venmo-wallet-additional-attributes.md) | Optional | Additional attributes associated with the use of this Venmo Wallet. | getAttributes(): ?VenmoWalletAdditionalAttributes | setAttributes(?VenmoWalletAdditionalAttributes attributes): void | - -## Example (as JSON) - -```json -{ - "vault_id": "vault_id2", - "email_address": "email_address2", - "experience_context": { - "brand_name": "brand_name2", - "shipping_preference": "NO_SHIPPING" - }, - "attributes": { - "customer": { - "id": "id0", - "email_address": "email_address2" - }, - "vault": { - "store_in_vault": "ON_SUCCESS", - "description": "description6", - "usage_pattern": "THRESHOLD_PREPAID", - "usage_type": "MERCHANT", - "customer_type": "CONSUMER", - "permit_multiple_payment_tokens": false - } - } -} -``` - diff --git a/doc/models/venmo-wallet-response.md b/doc/models/venmo-wallet-response.md deleted file mode 100644 index df7ab82..0000000 --- a/doc/models/venmo-wallet-response.md +++ /dev/null @@ -1,38 +0,0 @@ - -# Venmo Wallet Response - -Venmo wallet response. - -## Structure - -`VenmoWalletResponse` - -## Fields - -| 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.

**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: `(?:[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\|\[(?:(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9])\|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void | -| `accountId` | `?string` | Optional | The PayPal payer ID, which is a masked version of the PayPal account number intended for use with third parties. The account number is reversibly encrypted and a proprietary variant of Base32 is used to encode the result.
**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `13`, *Pattern*: `^[2-9A-HJ-NP-Z]{13}$` | getAccountId(): ?string | setAccountId(?string accountId): void | -| `userName` | `?string` | Optional | The Venmo user name chosen by the user, also know as a Venmo handle.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `50`, *Pattern*: `^[-a-zA-Z0-9_]*$` | getUserName(): ?string | setUserName(?string userName): void | -| `name` | [`?Name`](../../doc/models/name.md) | Optional | The name of the party. | getName(): ?Name | setName(?Name name): void | -| `phoneNumber` | [`?PhoneNumber`](../../doc/models/phone-number.md) | Optional | The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). | getPhoneNumber(): ?PhoneNumber | setPhoneNumber(?PhoneNumber phoneNumber): void | -| `address` | [`?Address`](../../doc/models/address.md) | Optional | 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). | getAddress(): ?Address | setAddress(?Address address): void | -| `attributes` | [`?VenmoWalletAttributesResponse`](../../doc/models/venmo-wallet-attributes-response.md) | Optional | Additional attributes associated with the use of a Venmo Wallet. | getAttributes(): ?VenmoWalletAttributesResponse | setAttributes(?VenmoWalletAttributesResponse attributes): void | - -## Example (as JSON) - -```json -{ - "email_address": "email_address6", - "account_id": "account_id8", - "user_name": "user_name2", - "name": { - "given_name": "given_name2", - "surname": "surname8" - }, - "phone_number": { - "national_number": "national_number6" - } -} -``` - diff --git a/doc/models/venmo-wallet-vault-attributes.md b/doc/models/venmo-wallet-vault-attributes.md deleted file mode 100644 index 877af86..0000000 --- a/doc/models/venmo-wallet-vault-attributes.md +++ /dev/null @@ -1,33 +0,0 @@ - -# Venmo Wallet Vault Attributes - -Resource consolidating common request and response attirbutes for vaulting Venmo Wallet. - -## Structure - -`VenmoWalletVaultAttributes` - -## Fields - -| Name | Type | Tags | Description | Getter | Setter | -| --- | --- | --- | --- | --- | --- | -| `storeInVault` | [`string(StoreInVaultInstruction)`](../../doc/models/store-in-vault-instruction.md) | Required | Defines how and when the payment source gets vaulted.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getStoreInVault(): string | setStoreInVault(string storeInVault): void | -| `description` | `?string` | Optional | The description displayed to Venmo consumer on the approval flow for Venmo, as well as on the Venmo payment token management experience on Venmo.com.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128`, *Pattern*: `^[a-zA-Z0-9_'\-., :;\!?"]*$` | getDescription(): ?string | setDescription(?string description): void | -| `usagePattern` | [`?string(VenmoPaymentTokenUsagePattern)`](../../doc/models/venmo-payment-token-usage-pattern.md) | Optional | Expected business/pricing model for the billing agreement.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `30`, *Pattern*: `^[0-9A-Z_]+$` | getUsagePattern(): ?string | setUsagePattern(?string usagePattern): void | -| `usageType` | [`string(VenmoPaymentTokenUsageType)`](../../doc/models/venmo-payment-token-usage-type.md) | Required | The usage type associated with the Venmo payment token.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getUsageType(): string | setUsageType(string usageType): void | -| `customerType` | [`?string(VenmoPaymentTokenCustomerType)`](../../doc/models/venmo-payment-token-customer-type.md) | Optional | 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.
**Default**: `VenmoPaymentTokenCustomerType::CONSUMER`
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getCustomerType(): ?string | setCustomerType(?string customerType): void | -| `permitMultiplePaymentTokens` | `?bool` | Optional | Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same Venmo account.
**Default**: `false` | getPermitMultiplePaymentTokens(): ?bool | setPermitMultiplePaymentTokens(?bool permitMultiplePaymentTokens): void | - -## Example (as JSON) - -```json -{ - "store_in_vault": "ON_SUCCESS", - "usage_type": "MERCHANT", - "customer_type": "CONSUMER", - "permit_multiple_payment_tokens": false, - "description": "description6", - "usage_pattern": "RECURRING_PREPAID" -} -``` - diff --git a/doc/request-logging-configuration-builder.md b/doc/request-logging-configuration-builder.md deleted file mode 100644 index 3786dfb..0000000 --- a/doc/request-logging-configuration-builder.md +++ /dev/null @@ -1,16 +0,0 @@ - -# RequestLoggingConfigurationBuilder Class - -Represents the logging configurations for API requests. Create instance using `RequestLoggingConfigurationBuilder::init()` - -## Methods - -| Name | Parameter Type | Description | -| --- | --- | --- | -| includeQueryInPath | `bool` | Toggles the inclusion of query parameters in the logged request path. **Default : `false`** | -| body | `bool` | Toggles the logging of the request body. **Default : `false`** | -| headers | `bool` | Toggles the logging of the request headers. **Default : `false`** | -| includeHeaders | `string[]` | Includes only specified request headers in the log output. **Default : `[]`** | -| excludeHeaders | `string[]` | Excludes specified request headers from the log output. **Default : `[]`** | -| unmaskHeaders | `string[]` | Logs specified request headers without masking, revealing their actual values. **Default : `[]`** | - diff --git a/doc/response-logging-configuration-builder.md b/doc/response-logging-configuration-builder.md deleted file mode 100644 index 82ab88e..0000000 --- a/doc/response-logging-configuration-builder.md +++ /dev/null @@ -1,15 +0,0 @@ - -# ResponseLoggingConfigurationBuilder Class - -Represents the logging configurations for API responses. Create instance using `ResponseLoggingConfigurationBuilder::init()` - -## Methods - -| Name | Parameter Type | Description | -| --- | --- | --- | -| body | `bool` | Toggles the logging of the request body. **Default : `false`** | -| headers | `bool` | Toggles the logging of the request headers. **Default : `false`** | -| includeHeaders | `string[]` | Includes only specified request headers in the log output. **Default : `[]`** | -| excludeHeaders | `string[]` | Excludes specified request headers from the log output. **Default : `[]`** | -| unmaskHeaders | `string[]` | Logs specified request headers without masking, revealing their actual values. **Default : `[]`** | - diff --git a/phpcs-ruleset.xml b/phpcs-ruleset.xml deleted file mode 100644 index 6f78d30..0000000 --- a/phpcs-ruleset.xml +++ /dev/null @@ -1,5 +0,0 @@ - - - - - diff --git a/src/ApiHelper.php b/src/ApiHelper.php deleted file mode 100644 index 99c4826..0000000 --- a/src/ApiHelper.php +++ /dev/null @@ -1,114 +0,0 @@ -config = $config; - } - - /** - * Initializer for ClientCredentialsAuthCredentialsBuilder - * - * @param string $oAuthClientId - * @param string $oAuthClientSecret - */ - public static function init(string $oAuthClientId, string $oAuthClientSecret): self - { - return new self(['oAuthClientId' => $oAuthClientId, 'oAuthClientSecret' => $oAuthClientSecret]); - } - - /** - * Setter for OAuthClientId. - * - * @param string $oAuthClientId - * - * @return $this - */ - public function oAuthClientId(string $oAuthClientId): self - { - $this->config['oAuthClientId'] = $oAuthClientId; - return $this; - } - - /** - * Setter for OAuthClientSecret. - * - * @param string $oAuthClientSecret - * - * @return $this - */ - public function oAuthClientSecret(string $oAuthClientSecret): self - { - $this->config['oAuthClientSecret'] = $oAuthClientSecret; - return $this; - } - - /** - * Setter for OAuthToken. - * - * @param OAuthToken|null $oAuthToken - * - * @return $this - */ - public function oAuthToken(?OAuthToken $oAuthToken): self - { - $this->config['oAuthToken'] = $oAuthToken; - return $this; - } - - /** - * Setter for clock skew time in seconds applied while checking the OAuth Token expiry. - * - * @param int $oAuthClockSkew - * - * @return $this - */ - public function oAuthClockSkew(int $oAuthClockSkew): self - { - $this->config['Oauth2-ClockSkew'] = $oAuthClockSkew; - return $this; - } - - /** - * Setter for the OAuthTokenProvider callable with 2 arguments. Arg1 will be the last OAuthToken - * instance, while Arg2 will be an instance of ClientCredentialsAuthManager. The return type of - * callable should be an instance of OAuthToken model. - * - * @param callable(OAuthToken, ClientCredentialsAuthManager): OAuthToken $oAuthTokenProvider - * - * @return $this - */ - public function oAuthTokenProvider(callable $oAuthTokenProvider): self - { - $this->config['Oauth2-TokenProvider'] = $oAuthTokenProvider; - return $this; - } - - /** - * Setter for the OAuthOnTokenUpdate callable with the updated OAuthToken instance as the only argument. - * Here the return type of callable should be void - * - * @param callable(OAuthToken): void $oAuthOnTokenUpdate - * - * @return $this - */ - public function oAuthOnTokenUpdate(callable $oAuthOnTokenUpdate): self - { - $this->config['Oauth2-OnTokenUpdate'] = $oAuthOnTokenUpdate; - return $this; - } - - public function getConfiguration(): array - { - return CoreHelper::clone($this->config); - } -} diff --git a/src/Authentication/ClientCredentialsAuthManager.php b/src/Authentication/ClientCredentialsAuthManager.php deleted file mode 100644 index 173a53f..0000000 --- a/src/Authentication/ClientCredentialsAuthManager.php +++ /dev/null @@ -1,206 +0,0 @@ -config = $config; - $this->internalOAuthToken = $this->getOAuthToken(); - } - - public function setClient(Client $client): void - { - $this->oAuthApi = new OAuthAuthorizationController($client); - } - - /** - * String value for oAuthClientId. - */ - public function getOAuthClientId(): string - { - return $this->config['oAuthClientId'] ?? ConfigurationDefaults::O_AUTH_CLIENT_ID; - } - - /** - * String value for oAuthClientSecret. - */ - public function getOAuthClientSecret(): string - { - return $this->config['oAuthClientSecret'] ?? ConfigurationDefaults::O_AUTH_CLIENT_SECRET; - } - - /** - * OAuthToken value for oAuthToken. - */ - public function getOAuthToken(): ?OAuthToken - { - $oAuthToken = $this->config['oAuthToken']; - if ($oAuthToken instanceof OAuthToken) { - return clone $oAuthToken; - } - return ConfigurationDefaults::O_AUTH_TOKEN; - } - - /** - * Checks if provided credentials match with existing ones. - * - * @param string $oAuthClientId OAuth 2 Client ID - * @param string $oAuthClientSecret OAuth 2 Client Secret - */ - public function equals(string $oAuthClientId, string $oAuthClientSecret): bool - { - return $oAuthClientId == $this->getOAuthClientId() && - $oAuthClientSecret == $this->getOAuthClientSecret(); - } - - /** - * Clock skew time in seconds applied while checking the OAuth Token expiry. - */ - public function getOAuthClockSkew(): int - { - return $this->config['Oauth2-ClockSkew'] ?? ConfigurationDefaults::OAUTH_2_CLOCK_SKEW; - } - - /** - * Fetch the OAuth token. - * @param array|null $additionalParams Additional parameters to send during authorization - */ - public function fetchToken(?array $additionalParams = null): OAuthToken - { - //send request for access token - $oAuthToken = $this->oAuthApi->requestToken( - [ - 'authorization' => $this->buildBasicHeader(), - 'scope' => null, - ], - $additionalParams - )->getResult(); - - $this->addExpiryTime($oAuthToken); - - return $oAuthToken; - } - - /** - * Has the OAuth token expired? If the token argument is not provided then this function will check the expiry of - * the initial oauthToken, that's set in the client initialization. - */ - public function isTokenExpired(?OAuthToken $token = null): bool - { - $token = $token ?? $this->getOAuthToken(); - if ($token == null || empty($token->getExpiry())) { - return true; - } - return $token->getExpiry() < time() + $this->getOAuthClockSkew(); - } - - private function getTokenFromProvider(): ?OAuthToken - { - if ($this->internalOAuthToken != null && !$this->isTokenExpired($this->internalOAuthToken)) { - return $this->internalOAuthToken; - } - $provider = $this->config['Oauth2-TokenProvider']; - if (is_callable($provider)) { - $token = Closure::fromCallable($provider)($this->internalOAuthToken, $this); - } else { - try { - $token = $this->fetchToken(); - } catch (Exception $exp) { - return $this->internalOAuthToken; - } - } - $updateCallback = $this->config['Oauth2-OnTokenUpdate']; - if (is_callable($updateCallback)) { - Closure::fromCallable($updateCallback)($token); - } - return $token; - } - - /** - * Check if client is authorized, throws exceptions when token is null or expired. - * - * @throws InvalidArgumentException - */ - public function validate(TypeValidatorInterface $validator): void - { - $this->internalOAuthToken = $this->getTokenFromProvider(); - if ($this->internalOAuthToken == null) { - throw new InvalidArgumentException('Client is not authorized. An OAuth token is needed to make API calls.'); - } - if ($this->isTokenExpired($this->internalOAuthToken)) { - throw new InvalidArgumentException('OAuth token is expired. A valid token is needed to make API calls.'); - } - parent::__construct( - HeaderParam::init( - 'Authorization', - CoreHelper::getBearerAuthString($this->internalOAuthToken->getAccessToken()) - )->requiredNonEmpty() - ); - parent::validate($validator); - } - - /** - * Build authorization header value for basic auth. - */ - private function buildBasicHeader(): string - { - return 'Basic ' . base64_encode( - $this->getOAuthClientId() . ':' . $this->getOAuthClientSecret() - ); - } - - /** - * Adds the expiry time to the given oAuthToken instance. - */ - private function addExpiryTime(OAuthToken $oAuthToken): void - { - $expiresIn = $oAuthToken->getExpiresIn(); - if (empty($expiresIn)) { - return; - } - $oAuthToken->setExpiry(time() + $expiresIn); - } -} diff --git a/src/ClientCredentialsAuth.php b/src/ClientCredentialsAuth.php deleted file mode 100644 index 3c57bb3..0000000 --- a/src/ClientCredentialsAuth.php +++ /dev/null @@ -1,55 +0,0 @@ - self::TIMEOUT, - 'enableRetries' => self::ENABLE_RETRIES, - 'numberOfRetries' => self::NUMBER_OF_RETRIES, - 'retryInterval' => self::RETRY_INTERVAL, - 'backOffFactor' => self::BACK_OFF_FACTOR, - 'maximumRetryWaitTime' => self::MAXIMUM_RETRY_WAIT_TIME, - 'retryOnTimeout' => self::RETRY_ON_TIMEOUT, - 'httpStatusCodesToRetry' => self::HTTP_STATUS_CODES_TO_RETRY, - 'httpMethodsToRetry' => self::HTTP_METHODS_TO_RETRY, - 'environment' => self::ENVIRONMENT, - 'oAuthClientId' => self::O_AUTH_CLIENT_ID, - 'oAuthClientSecret' => self::O_AUTH_CLIENT_SECRET, - 'oAuthToken' => self::O_AUTH_TOKEN, - 'Oauth2-ClockSkew' => self::OAUTH_2_CLOCK_SKEW, - 'Oauth2-TokenProvider' => null, - 'Oauth2-OnTokenUpdate' => null, - 'loggingConfiguration' => null - ]; -} diff --git a/src/ConfigurationInterface.php b/src/ConfigurationInterface.php deleted file mode 100644 index 9997cc3..0000000 --- a/src/ConfigurationInterface.php +++ /dev/null @@ -1,50 +0,0 @@ -client = $client; - } - - protected function execute(RequestBuilder $requestBuilder, ?ResponseHandler $responseHandler = null) - { - return (new ApiCall($this->client)) - ->requestBuilder($requestBuilder) - ->responseHandler($responseHandler ?? $this->responseHandler()) - ->execute(); - } - - protected function requestBuilder(string $requestMethod, string $path): RequestBuilder - { - return new RequestBuilder($requestMethod, $path); - } - - protected function responseHandler(): ResponseHandler - { - return $this->client->getGlobalResponseHandler(); - } -} diff --git a/src/Controllers/OAuthAuthorizationController.php b/src/Controllers/OAuthAuthorizationController.php deleted file mode 100644 index 6da26d8..0000000 --- a/src/Controllers/OAuthAuthorizationController.php +++ /dev/null @@ -1,60 +0,0 @@ -requestBuilder(RequestMethod::POST, '/v1/oauth2/token') - ->parameters( - FormParam::init('grant_type', 'client_credentials'), - HeaderParam::init('Authorization', $options)->extract('authorization'), - FormParam::init('scope', $options)->extract('scope'), - AdditionalFormParams::init($fieldParameters) - ); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '400', - ErrorType::init('OAuth 2 provider returned an error.', OAuthProviderException::class) - ) - ->throwErrorOn( - '401', - ErrorType::init( - 'OAuth 2 provider says client authentication failed.', - OAuthProviderException::class - ) - ) - ->type(OAuthToken::class) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } -} diff --git a/src/Controllers/OrdersController.php b/src/Controllers/OrdersController.php deleted file mode 100644 index 5325cba..0000000 --- a/src/Controllers/OrdersController.php +++ /dev/null @@ -1,486 +0,0 @@ -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 - { - $_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-Request-Id', $options)->extract('payPalRequestId'), - HeaderParam::init('PayPal-Partner-Attribution-Id', $options)->extract('payPalPartnerAttributionId'), - HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('payPalClientMetadataId'), - HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal') - ); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '400', - ErrorType::init( - 'Request is not well-formed, syntactically incorrect, or violates schema.', - ErrorException::class - ) - ) - ->throwErrorOn( - '401', - ErrorType::init( - 'Authentication failed due to missing authorization header, or invalid auth' . - 'entication credentials.', - ErrorException::class - ) - ) - ->throwErrorOn( - '422', - ErrorType::init( - 'The requested action could not be performed, semantically incorrect, or fa' . - 'iled business validation.', - ErrorException::class - ) - ) - ->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class)) - ->type(Order::class) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } - - /** - * 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 - { - $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/checkout/orders/{id}') - ->auth('Oauth2') - ->parameters( - TemplateParam::init('id', $options)->extract('id'), - QueryParam::init('fields', $options)->extract('fields') - ); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '401', - ErrorType::init( - 'Authentication failed due to missing authorization header, or invalid auth' . - 'entication credentials.', - ErrorException::class - ) - ) - ->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class)) - ->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class)) - ->type(Order::class) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } - - /** - * Updates an order with a `CREATED` or `APPROVED` status. You cannot update an order with the - * `COMPLETED` status.

To make an update, you must provide a `reference_id`. If you omit this - * value with an order that contains only one purchase unit, PayPal sets the value to `default` which - * enables you to use the path: \"/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: - *

AttributeOpNotes
inte - * ntreplace
payerreplace, - * addUsing replace op for payer will replace the whole payer object - * with the value sent in request.
purchase_unitsreplace, - * add
purchase_units[].custom_idreplace, add, - * remove
purchase_units[].descriptionreplace, add, - * remove
purchase_units[].payee. - * emailreplace
purchase_units[].shipping. - * namereplace, add
purchase_units[].shipping. - * email_addressreplace, add
purchase_units[].shipping. - * phone_numberreplace, add
purchase_units[].shipping. - * optionsreplace, add
purchase_units[].shipping. - * addressreplace, add
purchase_units[].shipping. - * typereplace, add
purchase_units[]. - * soft_descriptorreplace, remove
purchase_units[]. - * amountreplace
purchase_units[]. - * itemsreplace, add, remove
purchase_units[]. - * invoice_idreplace, add, remove
purchase_units[]. - * payment_instructionreplace
purchase_units[]. - * payment_instruction.disbursement_modereplaceBy default, - * disbursement_mode is INSTANT.
purchase_units[]. - * payment_instruction.payee_receivable_fx_rate_idreplace, add, - * remove
purchase_units[].payment_instruction. - * platform_feesreplace, add, remove
purchase_units[]. - * supplementary_data.airlinereplace, add, - * remove
purchase_units[].supplementary_data. - * cardreplace, add, remove
application_context. - * client_configurationreplace, add
- * - * @param array $options Array with all options for search - * - * @return ApiResponse Response from the API call - */ - public function ordersPatch(array $options): ApiResponse - { - $_reqBuilder = $this->requestBuilder(RequestMethod::PATCH, '/v2/checkout/orders/{id}') - ->auth('Oauth2') - ->parameters( - TemplateParam::init('id', $options)->extract('id'), - HeaderParam::init('Content-Type', 'application/json'), - BodyParam::init($options)->extract('body') - ); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '400', - ErrorType::init( - 'Request is not well-formed, syntactically incorrect, or violates schema.', - ErrorException::class - ) - ) - ->throwErrorOn( - '401', - ErrorType::init( - 'Authentication failed due to missing authorization header, or invalid auth' . - 'entication credentials.', - ErrorException::class - ) - ) - ->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class)) - ->throwErrorOn( - '422', - ErrorType::init( - 'The requested action could not be performed, semantically incorrect, or fa' . - 'iled business validation.', - ErrorException::class - ) - ) - ->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class)) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } - - /** - * Payer confirms their intent to pay for the the Order with the given payment source. - * - * @param array $options Array with all options for search - * - * @return ApiResponse Response from the API call - */ - public function ordersConfirm(array $options): ApiResponse - { - $_reqBuilder = $this->requestBuilder( - RequestMethod::POST, - '/v2/checkout/orders/{id}/confirm-payment-source' - ) - ->auth('Oauth2') - ->parameters( - TemplateParam::init('id', $options)->extract('id'), - HeaderParam::init('Content-Type', 'application/json'), - HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('payPalClientMetadataId'), - HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'), - BodyParam::init($options)->extract('body') - ); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '400', - ErrorType::init( - 'Request is not well-formed, syntactically incorrect, or violates schema.', - ErrorException::class - ) - ) - ->throwErrorOn( - '403', - ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class) - ) - ->throwErrorOn( - '422', - ErrorType::init( - 'The requested action could not be performed, semantically incorrect, or fa' . - 'iled business validation.', - ErrorException::class - ) - ) - ->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class)) - ->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class)) - ->type(Order::class) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } - - /** - * 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.
- * - * @param array $options Array with all options for search - * - * @return ApiResponse Response from the API call - */ - public function ordersAuthorize(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-Request-Id', $options)->extract('payPalRequestId'), - HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'), - HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('payPalClientMetadataId'), - HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('payPalAuthAssertion'), - BodyParam::init($options)->extract('body') - ); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '400', - ErrorType::init( - 'Request is not well-formed, syntactically incorrect, or violates schema.', - ErrorException::class - ) - ) - ->throwErrorOn( - '401', - ErrorType::init( - 'Authentication failed due to missing authorization header, or invalid auth' . - 'entication credentials.', - ErrorException::class - ) - ) - ->throwErrorOn( - '403', - ErrorType::init( - 'The authorized payment failed due to insufficient permissions.', - ErrorException::class - ) - ) - ->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class)) - ->throwErrorOn( - '422', - ErrorType::init( - 'The requested action could not be performed, semantically incorrect, or fa' . - 'iled business validation.', - ErrorException::class - ) - ) - ->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class)) - ->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class)) - ->type(OrderAuthorizeResponse::class) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } - - /** - * 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.
- * - * @param array $options Array with all options for search - * - * @return ApiResponse Response from the API call - */ - public function ordersCapture(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-Request-Id', $options)->extract('payPalRequestId'), - HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'), - HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('payPalClientMetadataId'), - HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('payPalAuthAssertion'), - BodyParam::init($options)->extract('body') - ); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '400', - ErrorType::init( - 'Request is not well-formed, syntactically incorrect, or violates schema.', - ErrorException::class - ) - ) - ->throwErrorOn( - '401', - ErrorType::init( - 'Authentication failed due to missing authorization header, or invalid auth' . - 'entication credentials.', - ErrorException::class - ) - ) - ->throwErrorOn( - '403', - ErrorType::init( - 'The authorized payment failed due to insufficient permissions.', - ErrorException::class - ) - ) - ->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class)) - ->throwErrorOn( - '422', - ErrorType::init( - 'The requested action could not be performed, semantically incorrect, or fa' . - 'iled business validation.', - ErrorException::class - ) - ) - ->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class)) - ->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class)) - ->type(Order::class) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } - - /** - * Adds tracking information for an Order. - * - * @param array $options Array with all options for search - * - * @return ApiResponse Response from the API call - */ - public function ordersTrackCreate(array $options): ApiResponse - { - $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/checkout/orders/{id}/track') - ->auth('Oauth2') - ->parameters( - TemplateParam::init('id', $options)->extract('id'), - HeaderParam::init('Content-Type', 'application/json'), - BodyParam::init($options)->extract('body'), - HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('payPalAuthAssertion') - ); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '400', - ErrorType::init( - 'Request is not well-formed, syntactically incorrect, or violates schema.', - ErrorException::class - ) - ) - ->throwErrorOn( - '403', - ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class) - ) - ->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class)) - ->throwErrorOn( - '422', - ErrorType::init( - 'The requested action could not be performed, semantically incorrect, or fa' . - 'iled business validation.', - ErrorException::class - ) - ) - ->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class)) - ->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class)) - ->type(Order::class) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } - - /** - * Updates or cancels the tracking information for a PayPal order, by ID. Updatable attributes or - * objects: - *

AttributeOpNotes
itemsreplaceUsing replace op for items will replace the - * entire items object with the value sent in request. - *
notify_payerreplace, - * add
statusreplaceOnly patching status to - * CANCELLED is currently supported.
- * - * @param array $options Array with all options for search - * - * @return ApiResponse Response from the API call - */ - public function ordersTrackersPatch(array $options): ApiResponse - { - $_reqBuilder = $this->requestBuilder( - RequestMethod::PATCH, - '/v2/checkout/orders/{id}/trackers/{tracker_id}' - ) - ->auth('Oauth2') - ->parameters( - TemplateParam::init('id', $options)->extract('id'), - TemplateParam::init('tracker_id', $options)->extract('trackerId'), - HeaderParam::init('Content-Type', 'application/json'), - BodyParam::init($options)->extract('body') - ); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '400', - ErrorType::init( - 'Request is not well-formed, syntactically incorrect, or violates schema.', - ErrorException::class - ) - ) - ->throwErrorOn( - '403', - ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class) - ) - ->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class)) - ->throwErrorOn( - '422', - ErrorType::init( - 'The requested action could not be performed, semantically incorrect, or fa' . - 'iled business validation.', - ErrorException::class - ) - ) - ->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class)) - ->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class)) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } -} diff --git a/src/Controllers/PaymentsController.php b/src/Controllers/PaymentsController.php deleted file mode 100644 index 570d22b..0000000 --- a/src/Controllers/PaymentsController.php +++ /dev/null @@ -1,435 +0,0 @@ -requestBuilder(RequestMethod::GET, '/v2/payments/authorizations/{authorization_id}') - ->auth('Oauth2') - ->parameters(TemplateParam::init('authorization_id', $authorizationId)); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '401', - ErrorType::init( - 'Authentication failed due to missing authorization header, or invalid auth' . - 'entication credentials.', - ErrorException::class - ) - ) - ->throwErrorOn( - '403', - ErrorType::init( - 'The request failed because the caller has insufficient permissions.', - ErrorException::class - ) - ) - ->throwErrorOn( - '404', - ErrorType::init('The request failed because the resource does not exist.', ErrorException::class) - ) - ->throwErrorOn('500', ErrorType::init('The request failed because an internal server error occurred.')) - ->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class)) - ->type(PaymentAuthorization::class) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } - - /** - * Captures an authorized payment, by ID. - * - * @param array $options Array with all options for search - * - * @return ApiResponse Response from the API call - */ - public function authorizationsCapture(array $options): ApiResponse - { - $_reqBuilder = $this->requestBuilder( - RequestMethod::POST, - '/v2/payments/authorizations/{authorization_id}/capture' - ) - ->auth('Oauth2') - ->parameters( - TemplateParam::init('authorization_id', $options)->extract('authorizationId'), - HeaderParam::init('Content-Type', 'application/json'), - HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'), - HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'), - BodyParam::init($options)->extract('body') - ); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '400', - ErrorType::init( - 'The request failed because it is not well-formed or is syntactically incor' . - 'rect or violates schema.', - ErrorException::class - ) - ) - ->throwErrorOn( - '401', - ErrorType::init( - 'Authentication failed due to missing authorization header, or invalid auth' . - 'entication credentials.', - ErrorException::class - ) - ) - ->throwErrorOn( - '403', - ErrorType::init( - 'The request failed because the caller has insufficient permissions.', - ErrorException::class - ) - ) - ->throwErrorOn( - '404', - ErrorType::init('The request failed because the resource does not exist.', ErrorException::class) - ) - ->throwErrorOn( - '422', - ErrorType::init( - 'The request failed because it is semantically incorrect or failed business validation.', - ErrorException::class - ) - ) - ->throwErrorOn('500', ErrorType::init('The request failed because an internal server error occurred.')) - ->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class)) - ->type(CapturedPayment::class) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } - - /** - * 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. - *
- * - * @param array $options Array with all options for search - * - * @return ApiResponse Response from the API call - */ - public function authorizationsReauthorize(array $options): ApiResponse - { - $_reqBuilder = $this->requestBuilder( - RequestMethod::POST, - '/v2/payments/authorizations/{authorization_id}/reauthorize' - ) - ->auth('Oauth2') - ->parameters( - TemplateParam::init('authorization_id', $options)->extract('authorizationId'), - HeaderParam::init('Content-Type', 'application/json'), - HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'), - HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'), - BodyParam::init($options)->extract('body') - ); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '400', - ErrorType::init( - 'The request failed because it is not well-formed or is syntactically incor' . - 'rect or violates schema.', - ErrorException::class - ) - ) - ->throwErrorOn( - '401', - ErrorType::init( - 'Authentication failed due to missing authorization header, or invalid auth' . - 'entication credentials.', - ErrorException::class - ) - ) - ->throwErrorOn( - '403', - ErrorType::init( - 'The request failed because the caller has insufficient permissions.', - ErrorException::class - ) - ) - ->throwErrorOn( - '404', - ErrorType::init('The request failed because the resource does not exist.', ErrorException::class) - ) - ->throwErrorOn( - '422', - ErrorType::init( - 'The request failed because it either is semantically incorrect or failed b' . - 'usiness validation.', - ErrorException::class - ) - ) - ->throwErrorOn('500', ErrorType::init('The request failed because an internal server error occurred.')) - ->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class)) - ->type(PaymentAuthorization::class) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } - - /** - * Voids, or cancels, an authorized payment, by ID. You cannot void an authorized payment that has been - * fully captured. - * - * @param array $options Array with all options for search - * - * @return ApiResponse Response from the API call - */ - public function authorizationsVoid(array $options): ApiResponse - { - $_reqBuilder = $this->requestBuilder( - RequestMethod::POST, - '/v2/payments/authorizations/{authorization_id}/void' - ) - ->auth('Oauth2') - ->parameters( - TemplateParam::init('authorization_id', $options)->extract('authorizationId'), - HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('payPalAuthAssertion'), - HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal') - ); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '400', - ErrorType::init( - 'The request failed because it is not well-formed or is syntactically incor' . - 'rect or violates schema.', - ErrorException::class - ) - ) - ->throwErrorOn( - '401', - ErrorType::init( - 'Authentication failed due to missing authorization header, or invalid auth' . - 'entication credentials.', - ErrorException::class - ) - ) - ->throwErrorOn( - '403', - ErrorType::init( - 'The request failed because the caller has insufficient permissions.', - ErrorException::class - ) - ) - ->throwErrorOn( - '404', - ErrorType::init('The request failed because the resource does not exist.', ErrorException::class) - ) - ->throwErrorOn( - '409', - ErrorType::init( - 'The request failed because a previous call for the given resource is in progress.', - ErrorException::class - ) - ) - ->throwErrorOn( - '422', - ErrorType::init( - 'The request failed because it either is semantically incorrect or failed b' . - 'usiness validation.', - ErrorException::class - ) - ) - ->throwErrorOn('500', ErrorType::init('The request failed because an internal server error occurred.')) - ->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class)) - ->nullableType() - ->type(PaymentAuthorization::class) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } - - /** - * Shows details for a captured payment, by ID. - * - * @param string $captureId The PayPal-generated ID for the captured payment for which to show - * details. - * - * @return ApiResponse Response from the API call - */ - public function capturesGet(string $captureId): ApiResponse - { - $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/payments/captures/{capture_id}') - ->auth('Oauth2') - ->parameters(TemplateParam::init('capture_id', $captureId)); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '401', - ErrorType::init( - 'Authentication failed due to missing authorization header, or invalid auth' . - 'entication credentials.', - ErrorException::class - ) - ) - ->throwErrorOn( - '403', - ErrorType::init( - 'The request failed because the caller has insufficient permissions.', - ErrorException::class - ) - ) - ->throwErrorOn( - '404', - ErrorType::init('The request failed because the resource does not exist.', ErrorException::class) - ) - ->throwErrorOn('500', ErrorType::init('The request failed because an internal server error occurred.')) - ->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class)) - ->type(CapturedPayment::class) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } - - /** - * 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. - * - * @param array $options Array with all options for search - * - * @return ApiResponse Response from the API call - */ - public function capturesRefund(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-Request-Id', $options)->extract('payPalRequestId'), - HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'), - HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('payPalAuthAssertion'), - BodyParam::init($options)->extract('body') - ); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '400', - ErrorType::init( - 'The request failed because it is not well-formed or is syntactically incor' . - 'rect or violates schema.', - ErrorException::class - ) - ) - ->throwErrorOn( - '401', - ErrorType::init( - 'Authentication failed due to missing authorization header, or invalid auth' . - 'entication credentials.', - ErrorException::class - ) - ) - ->throwErrorOn( - '403', - ErrorType::init( - 'The request failed because the caller has insufficient permissions.', - ErrorException::class - ) - ) - ->throwErrorOn( - '404', - ErrorType::init('The request failed because the resource does not exist.', ErrorException::class) - ) - ->throwErrorOn( - '409', - ErrorType::init( - 'The request failed because a previous call for the given resource is in progress.', - ErrorException::class - ) - ) - ->throwErrorOn( - '422', - ErrorType::init( - 'The request failed because it either is semantically incorrect or failed b' . - 'usiness validation.', - ErrorException::class - ) - ) - ->throwErrorOn('500', ErrorType::init('The request failed because an internal server error occurred.')) - ->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class)) - ->type(Refund::class) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } - - /** - * Shows details for a refund, by ID. - * - * @param string $refundId The PayPal-generated ID for the refund for which to show details. - * - * @return ApiResponse Response from the API call - */ - public function refundsGet(string $refundId): ApiResponse - { - $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/payments/refunds/{refund_id}') - ->auth('Oauth2') - ->parameters(TemplateParam::init('refund_id', $refundId)); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '401', - ErrorType::init( - 'Authentication failed due to missing authorization header, or invalid auth' . - 'entication credentials.', - ErrorException::class - ) - ) - ->throwErrorOn( - '403', - ErrorType::init( - 'The request failed because the caller has insufficient permissions.', - ErrorException::class - ) - ) - ->throwErrorOn( - '404', - ErrorType::init('The request failed because the resource does not exist.', ErrorException::class) - ) - ->throwErrorOn('500', ErrorType::init('The request failed because an internal server error occurred.')) - ->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class)) - ->type(Refund::class) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } -} diff --git a/src/Controllers/VaultController.php b/src/Controllers/VaultController.php deleted file mode 100644 index 374c299..0000000 --- a/src/Controllers/VaultController.php +++ /dev/null @@ -1,260 +0,0 @@ -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') - ); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '400', - ErrorType::init( - 'Request is not well-formed, syntactically incorrect, or violates schema.', - ErrorException::class - ) - ) - ->throwErrorOn( - '403', - ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class) - ) - ->throwErrorOn( - '404', - ErrorType::init( - 'Request contains reference to resources that do not exist.', - ErrorException::class - ) - ) - ->throwErrorOn( - '422', - ErrorType::init( - 'The requested action could not be performed, semantically incorrect, or fa' . - 'iled business validation.', - ErrorException::class - ) - ) - ->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class)) - ->type(PaymentTokenResponse::class) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } - - /** - * Returns all payment tokens for a customer. - * - * @param array $options Array with all options for search - * - * @return ApiResponse Response from the API call - */ - public function customerPaymentTokensGet(array $options): ApiResponse - { - $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v3/vault/payment-tokens') - ->auth('Oauth2') - ->parameters( - QueryParam::init('customer_id', $options)->extract('customerId'), - QueryParam::init('page_size', $options)->extract('pageSize', 5), - QueryParam::init('page', $options)->extract('page', 1), - QueryParam::init('total_required', $options)->extract('totalRequired', false) - ); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '400', - ErrorType::init( - 'Request is not well-formed, syntactically incorrect, or violates schema.', - ErrorException::class - ) - ) - ->throwErrorOn( - '403', - ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class) - ) - ->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class)) - ->type(CustomerVaultPaymentTokensResponse::class) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } - - /** - * Returns a readable representation of vaulted payment source associated with the payment token id. - * - * @param string $id ID of the payment token. - * - * @return ApiResponse Response from the API call - */ - public function paymentTokensGet(string $id): ApiResponse - { - $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v3/vault/payment-tokens/{id}') - ->auth('Oauth2') - ->parameters(TemplateParam::init('id', $id)); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '403', - ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class) - ) - ->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class)) - ->throwErrorOn( - '422', - ErrorType::init( - 'The requested action could not be performed, semantically incorrect, or fa' . - 'iled business validation.', - ErrorException::class - ) - ) - ->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class)) - ->type(PaymentTokenResponse::class) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } - - /** - * Delete the payment token associated with the payment token id. - * - * @param string $id ID of the payment token. - * - * @return ApiResponse Response from the API call - */ - public function paymentTokensDelete(string $id): ApiResponse - { - $_reqBuilder = $this->requestBuilder(RequestMethod::DELETE, '/v3/vault/payment-tokens/{id}') - ->auth('Oauth2') - ->parameters(TemplateParam::init('id', $id)); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '400', - ErrorType::init( - 'Request is not well-formed, syntactically incorrect, or violates schema.', - ErrorException::class - ) - ) - ->throwErrorOn( - '403', - ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class) - ) - ->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class)) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } - - /** - * Creates a Setup Token from the given payment source and adds it to the Vault of the associated - * customer. - * - * @param array $options Array with all options for search - * - * @return ApiResponse Response from the API call - */ - public function setupTokensCreate(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') - ); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '400', - ErrorType::init( - 'Request is not well-formed, syntactically incorrect, or violates schema.', - ErrorException::class - ) - ) - ->throwErrorOn( - '403', - ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class) - ) - ->throwErrorOn( - '422', - ErrorType::init( - 'The requested action could not be performed, semantically incorrect, or fa' . - 'iled business validation.', - ErrorException::class - ) - ) - ->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class)) - ->type(SetupTokenResponse::class) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } - - /** - * Returns a readable representation of temporarily vaulted payment source associated with the setup - * token id. - * - * @param string $id ID of the setup token. - * - * @return ApiResponse Response from the API call - */ - public function setupTokensGet(string $id): ApiResponse - { - $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v3/vault/setup-tokens/{id}') - ->auth('Oauth2') - ->parameters(TemplateParam::init('id', $id)); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '403', - ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class) - ) - ->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class)) - ->throwErrorOn( - '422', - ErrorType::init( - 'The requested action could not be performed, semantically incorrect, or fa' . - 'iled business validation.', - ErrorException::class - ) - ) - ->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class)) - ->type(SetupTokenResponse::class) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } -} diff --git a/src/Environment.php b/src/Environment.php deleted file mode 100644 index 8d156b2..0000000 --- a/src/Environment.php +++ /dev/null @@ -1,27 +0,0 @@ -getStatusCode()); - $this->request = $request; - $this->response = $response; - } - - /** - * Returns the HTTP request - */ - public function getHttpRequest(): HttpRequest - { - return $this->request; - } - - /** - * Returns the HTTP response - */ - public function getHttpResponse(): ?HttpResponse - { - return $this->response; - } - - /** - * Is the response available? - */ - public function hasResponse(): bool - { - return !\is_null($this->response); - } -} diff --git a/src/Exceptions/ErrorException.php b/src/Exceptions/ErrorException.php deleted file mode 100644 index 0c8c029..0000000 --- a/src/Exceptions/ErrorException.php +++ /dev/null @@ -1,175 +0,0 @@ -name = $name; - $this->messageProperty = $messageProperty; - $this->debugId = $debugId; - } - - /** - * 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 Property. - * The message that describes the error. - */ - public function getMessageProperty(): string - { - return $this->messageProperty; - } - - /** - * Sets Message Property. - * The message that describes the error. - * - * @required - * @maps message - */ - public function setMessageProperty(string $messageProperty): void - { - $this->messageProperty = $messageProperty; - } - - /** - * Returns Debug Id. - * The PayPal internal ID. Used for correlation purposes. - */ - public function getDebugId(): string - { - return $this->debugId; - } - - /** - * Sets Debug Id. - * The PayPal internal ID. Used for correlation purposes. - * - * @required - * @maps debug_id - */ - public function setDebugId(string $debugId): void - { - $this->debugId = $debugId; - } - - /** - * Returns Details. - * An array of additional details about the error. - * - * @return \PayPalRESTAPIsLib\Models\ErrorDetails[]|null - */ - public function getDetails(): ?array - { - return $this->details; - } - - /** - * Sets Details. - * An array of additional details about the error. - * - * @maps details - * - * @param \PayPalRESTAPIsLib\Models\ErrorDetails[]|null $details - */ - public function setDetails(?array $details): void - { - $this->details = $details; - } - - /** - * Returns Links. - * An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links). - * - * @return \PayPalRESTAPIsLib\Models\LinkDescription[]|null - */ - public function getLinks(): ?array - { - return $this->links; - } - - /** - * Sets Links. - * An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links). - * - * @maps links - * - * @param \PayPalRESTAPIsLib\Models\LinkDescription[]|null $links - */ - public function setLinks(?array $links): void - { - $this->links = $links; - } -} diff --git a/src/Exceptions/OAuthProviderException.php b/src/Exceptions/OAuthProviderException.php deleted file mode 100644 index fa7aa55..0000000 --- a/src/Exceptions/OAuthProviderException.php +++ /dev/null @@ -1,114 +0,0 @@ -error = $error; - } - - /** - * Returns Error. - * Gets or sets error code. - */ - public function getError(): string - { - return $this->error; - } - - /** - * Sets Error. - * Gets or sets error code. - * - * @required - * @maps error - * @factory \PayPalRESTAPIsLib\Models\OAuthProviderError::checkValue - */ - public function setError(string $error): void - { - $this->error = $error; - } - - /** - * Returns Error Description. - * Gets or sets human-readable text providing additional information on error. - * Used to assist the client developer in understanding the error that occurred. - */ - public function getErrorDescription(): ?string - { - return $this->errorDescription; - } - - /** - * Sets Error Description. - * Gets or sets human-readable text providing additional information on error. - * Used to assist the client developer in understanding the error that occurred. - * - * @maps error_description - */ - public function setErrorDescription(?string $errorDescription): void - { - $this->errorDescription = $errorDescription; - } - - /** - * Returns Error Uri. - * Gets or sets a URI identifying a human-readable web page with information about the error, used to - * provide the client developer with additional information about the error. - */ - public function getErrorUri(): ?string - { - return $this->errorUri; - } - - /** - * Sets Error Uri. - * Gets or sets a URI identifying a human-readable web page with information about the error, used to - * provide the client developer with additional information about the error. - * - * @maps error_uri - */ - public function setErrorUri(?string $errorUri): void - { - $this->errorUri = $errorUri; - } -} diff --git a/src/Http/ApiResponse.php b/src/Http/ApiResponse.php deleted file mode 100644 index 9b32757..0000000 --- a/src/Http/ApiResponse.php +++ /dev/null @@ -1,45 +0,0 @@ -getRequest(); - $statusCode = $context->getResponse()->getStatusCode(); - $reasonPhrase = null; // TODO - $headers = $context->getResponse()->getHeaders(); - $body = $context->getResponse()->getRawBody(); - - return new self($request, $statusCode, $reasonPhrase, $headers, $result, $body); - } - - /** - * Returns the original request that resulted in this response. - */ - public function getRequest(): HttpRequest - { - return $this->request; - } -} diff --git a/src/Http/HttpCallBack.php b/src/Http/HttpCallBack.php deleted file mode 100644 index ea0dd59..0000000 --- a/src/Http/HttpCallBack.php +++ /dev/null @@ -1,20 +0,0 @@ -request; - } - - /** - * Returns the HTTP Response - * - * @return HttpResponse response - */ - public function getResponse(): HttpResponse - { - return $this->response; - } -} diff --git a/src/Http/HttpMethod.php b/src/Http/HttpMethod.php deleted file mode 100644 index ce307a9..0000000 --- a/src/Http/HttpMethod.php +++ /dev/null @@ -1,26 +0,0 @@ -logger = new ConsoleLogger('printf'); - $this->requestConfig = RequestLoggingConfigurationBuilder::init(); - $this->responseConfig = ResponseLoggingConfigurationBuilder::init(); - } - - /** - * Initializer for LoggingConfigurationBuilder. - */ - public static function init(): self - { - return new self(); - } - - public function logger(LoggerInterface $logger): self - { - $this->logger = $logger; - return $this; - } - - /** - * Setter for level of logging. See Psr\Log\LogLevel.php for possible values of log levels. - * - * @param string $level - * - * @return $this - */ - public function level(string $level): self - { - if (!in_array($level, ConfigurationDefaults::LOGGER_ALLOWED_LEVELS, true)) { - throw new InvalidArgumentException( - 'Invalid LogLevel. See Psr\Log\LogLevel.php for possible values of log levels.' - ); - } - $this->level = $level; - return $this; - } - - public function maskSensitiveHeaders(bool $maskSensitiveHeaders): self - { - $this->maskSensitiveHeaders = $maskSensitiveHeaders; - return $this; - } - - public function requestConfiguration(RequestLoggingConfigurationBuilder $requestConfig): self - { - $this->requestConfig = $requestConfig; - return $this; - } - - public function responseConfiguration(ResponseLoggingConfigurationBuilder $responseConfig): self - { - $this->responseConfig = $responseConfig; - return $this; - } - - public function getConfiguration(): array - { - return [ - 'logger' => CoreHelper::clone($this->logger), - 'level' => $this->level, - 'maskSensitiveHeaders' => $this->maskSensitiveHeaders, - 'requestConfiguration' => $this->requestConfig->getConfiguration(), - 'responseConfiguration' => $this->responseConfig->getConfiguration() - ]; - } - - public function build(): LoggingConfiguration - { - return new LoggingConfiguration( - $this->logger, - $this->level, - $this->maskSensitiveHeaders, - $this->requestConfig->build(), - $this->responseConfig->build() - ); - } -} diff --git a/src/Logging/RequestLoggingConfigurationBuilder.php b/src/Logging/RequestLoggingConfigurationBuilder.php deleted file mode 100644 index 2805187..0000000 --- a/src/Logging/RequestLoggingConfigurationBuilder.php +++ /dev/null @@ -1,93 +0,0 @@ -includeQueryInPath = $includeQueryInPath; - return $this; - } - - public function body(bool $body): self - { - $this->body = $body; - return $this; - } - - public function headers(bool $headers): self - { - $this->headers = $headers; - return $this; - } - - public function includeHeaders(string ...$includeHeaders): self - { - $this->includeHeaders = $includeHeaders; - return $this; - } - - public function excludeHeaders(string ...$excludeHeaders): self - { - $this->excludeHeaders = $excludeHeaders; - return $this; - } - - public function unmaskHeaders(string ...$unmaskHeaders): self - { - $this->unmaskHeaders = $unmaskHeaders; - return $this; - } - - public function getConfiguration(): array - { - return [ - 'includeQueryInPath' => $this->includeQueryInPath, - 'body' => $this->body, - 'headers' => $this->headers, - 'includeHeaders' => CoreHelper::clone($this->includeHeaders), - 'excludeHeaders' => CoreHelper::clone($this->excludeHeaders), - 'unmaskHeaders' => CoreHelper::clone($this->unmaskHeaders) - ]; - } - - public function build(): RequestConfiguration - { - return new RequestConfiguration( - $this->includeQueryInPath, - $this->body, - $this->headers, - $this->includeHeaders, - $this->excludeHeaders, - $this->unmaskHeaders - ); - } -} diff --git a/src/Logging/ResponseLoggingConfigurationBuilder.php b/src/Logging/ResponseLoggingConfigurationBuilder.php deleted file mode 100644 index 17080d7..0000000 --- a/src/Logging/ResponseLoggingConfigurationBuilder.php +++ /dev/null @@ -1,84 +0,0 @@ -body = $body; - return $this; - } - - public function headers(bool $headers): self - { - $this->headers = $headers; - return $this; - } - - public function includeHeaders(string ...$includeHeaders): self - { - $this->includeHeaders = $includeHeaders; - return $this; - } - - public function excludeHeaders(string ...$excludeHeaders): self - { - $this->excludeHeaders = $excludeHeaders; - return $this; - } - - public function unmaskHeaders(string ...$unmaskHeaders): self - { - $this->unmaskHeaders = $unmaskHeaders; - return $this; - } - - public function getConfiguration(): array - { - return [ - 'body' => $this->body, - 'headers' => $this->headers, - 'includeHeaders' => CoreHelper::clone($this->includeHeaders), - 'excludeHeaders' => CoreHelper::clone($this->excludeHeaders), - 'unmaskHeaders' => CoreHelper::clone($this->unmaskHeaders) - ]; - } - - public function build(): ResponseConfiguration - { - return new ResponseConfiguration( - $this->body, - $this->headers, - $this->includeHeaders, - $this->excludeHeaders, - $this->unmaskHeaders - ); - } -} diff --git a/src/Models/ACHDebitResponse.php b/src/Models/ACHDebitResponse.php deleted file mode 100644 index f8b50f6..0000000 --- a/src/Models/ACHDebitResponse.php +++ /dev/null @@ -1,63 +0,0 @@ -verificationStatus; - } - - /** - * Sets Verification Status. - * The ach debit verification status. - * - * @maps verification_status - */ - public function setVerificationStatus(?string $verificationStatus): void - { - $this->verificationStatus = $verificationStatus; - } - - /** - * 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->verificationStatus)) { - $json['verification_status'] = $this->verificationStatus; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/AVSCode.php b/src/Models/AVSCode.php deleted file mode 100644 index 05fe688..0000000 --- a/src/Models/AVSCode.php +++ /dev/null @@ -1,114 +0,0 @@ -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; - } - - /** - * 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->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/Address.php b/src/Models/Address.php deleted file mode 100644 index 8090405..0000000 --- a/src/Models/Address.php +++ /dev/null @@ -1,231 +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: - */ - 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: - * - * @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; - } - - /** - * 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; - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/AddressDetails.php b/src/Models/AddressDetails.php deleted file mode 100644 index aabe1d7..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: - */ - 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: - * - * @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; - } - - /** - * 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 deleted file mode 100644 index c448125..0000000 --- a/src/Models/AmountBreakdown.php +++ /dev/null @@ -1,232 +0,0 @@ -itemTotal; - } - - /** - * Sets Item Total. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps item_total - */ - public function setItemTotal(?Money $itemTotal): void - { - $this->itemTotal = $itemTotal; - } - - /** - * Returns Shipping. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getShipping(): ?Money - { - return $this->shipping; - } - - /** - * Sets Shipping. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps shipping - */ - public function setShipping(?Money $shipping): void - { - $this->shipping = $shipping; - } - - /** - * Returns Handling. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getHandling(): ?Money - { - return $this->handling; - } - - /** - * Sets Handling. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps handling - */ - public function setHandling(?Money $handling): void - { - $this->handling = $handling; - } - - /** - * Returns Tax Total. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getTaxTotal(): ?Money - { - return $this->taxTotal; - } - - /** - * Sets Tax Total. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps tax_total - */ - public function setTaxTotal(?Money $taxTotal): void - { - $this->taxTotal = $taxTotal; - } - - /** - * Returns Insurance. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getInsurance(): ?Money - { - return $this->insurance; - } - - /** - * Sets Insurance. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps insurance - */ - public function setInsurance(?Money $insurance): void - { - $this->insurance = $insurance; - } - - /** - * Returns Shipping Discount. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getShippingDiscount(): ?Money - { - return $this->shippingDiscount; - } - - /** - * Sets Shipping Discount. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps shipping_discount - */ - public function setShippingDiscount(?Money $shippingDiscount): void - { - $this->shippingDiscount = $shippingDiscount; - } - - /** - * Returns Discount. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getDiscount(): ?Money - { - return $this->discount; - } - - /** - * Sets Discount. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps discount - */ - public function setDiscount(?Money $discount): void - { - $this->discount = $discount; - } - - /** - * 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->itemTotal)) { - $json['item_total'] = $this->itemTotal; - } - if (isset($this->shipping)) { - $json['shipping'] = $this->shipping; - } - if (isset($this->handling)) { - $json['handling'] = $this->handling; - } - if (isset($this->taxTotal)) { - $json['tax_total'] = $this->taxTotal; - } - if (isset($this->insurance)) { - $json['insurance'] = $this->insurance; - } - if (isset($this->shippingDiscount)) { - $json['shipping_discount'] = $this->shippingDiscount; - } - if (isset($this->discount)) { - $json['discount'] = $this->discount; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/AmountWithBreakdown.php b/src/Models/AmountWithBreakdown.php deleted file mode 100644 index 217aa5e..0000000 --- a/src/Models/AmountWithBreakdown.php +++ /dev/null @@ -1,142 +0,0 @@ -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. - */ -class AmountWithBreakdown implements \JsonSerializable -{ - /** - * @var string - */ - private $currencyCode; - - /** - * @var string - */ - private $value; - - /** - * @var AmountBreakdown|null - */ - private $breakdown; - - /** - * @param string $currencyCode - * @param string $value - */ - public function __construct(string $currencyCode, string $value) - { - $this->currencyCode = $currencyCode; - $this->value = $value; - } - - /** - * Returns Currency Code. - * The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies - * the currency. - */ - public function getCurrencyCode(): string - { - return $this->currencyCode; - } - - /** - * Sets Currency Code. - * The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies - * the currency. - * - * @required - * @maps currency_code - */ - public function setCurrencyCode(string $currencyCode): void - { - $this->currencyCode = $currencyCode; - } - - /** - * Returns Value. - * The value, which might be:For the required number of decimal places for a currency code, see [Currency - * Codes](/api/rest/reference/currency-codes/). - */ - public function getValue(): string - { - return $this->value; - } - - /** - * Sets Value. - * The value, which might be:For the required number of decimal places for a currency code, see [Currency - * Codes](/api/rest/reference/currency-codes/). - * - * @required - * @maps value - */ - public function setValue(string $value): void - { - $this->value = $value; - } - - /** - * Returns Breakdown. - * The breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, - * shipping, handling, insurance, and discounts, if any. - */ - public function getBreakdown(): ?AmountBreakdown - { - return $this->breakdown; - } - - /** - * Sets Breakdown. - * The breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, - * shipping, handling, insurance, and discounts, if any. - * - * @maps breakdown - */ - public function setBreakdown(?AmountBreakdown $breakdown): void - { - $this->breakdown = $breakdown; - } - - /** - * 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['currency_code'] = $this->currencyCode; - $json['value'] = $this->value; - if (isset($this->breakdown)) { - $json['breakdown'] = $this->breakdown; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/ApplePayAttributes.php b/src/Models/ApplePayAttributes.php deleted file mode 100644 index 050eb28..0000000 --- a/src/Models/ApplePayAttributes.php +++ /dev/null @@ -1,93 +0,0 @@ -customer; - } - - /** - * Sets Customer. - * The details about a customer in PayPal's system of record. - * - * @maps customer - */ - public function setCustomer(?CustomerInformation $customer): void - { - $this->customer = $customer; - } - - /** - * Returns Vault. - * Base vaulting specification. The object can be extended for specific use cases within each - * payment_source that supports vaulting. - */ - public function getVault(): ?VaultInstruction - { - return $this->vault; - } - - /** - * Sets Vault. - * Base vaulting specification. The object can be extended for specific use cases within each - * payment_source that supports vaulting. - * - * @maps vault - */ - public function setVault(?VaultInstruction $vault): void - { - $this->vault = $vault; - } - - /** - * 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; - } - if (isset($this->vault)) { - $json['vault'] = $this->vault; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/ApplePayAttributesResponse.php b/src/Models/ApplePayAttributesResponse.php deleted file mode 100644 index 5289bd8..0000000 --- a/src/Models/ApplePayAttributesResponse.php +++ /dev/null @@ -1,63 +0,0 @@ -vault; - } - - /** - * Sets Vault. - * The details about a saved payment source. - * - * @maps vault - */ - public function setVault(?VaultResponse $vault): void - { - $this->vault = $vault; - } - - /** - * 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->vault)) { - $json['vault'] = $this->vault; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/ApplePayCard.php b/src/Models/ApplePayCard.php deleted file mode 100644 index 730ca01..0000000 --- a/src/Models/ApplePayCard.php +++ /dev/null @@ -1,181 +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 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 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 Billing 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 getBillingAddress(): ?Address - { - return $this->billingAddress; - } - - /** - * Sets Billing 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). - * - * @maps billing_address - */ - public function setBillingAddress(?Address $billingAddress): void - { - $this->billingAddress = $billingAddress; - } - - /** - * 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->type)) { - $json['type'] = CardType::checkValue($this->type); - } - if (isset($this->brand)) { - $json['brand'] = CardBrand::checkValue($this->brand); - } - if (isset($this->billingAddress)) { - $json['billing_address'] = $this->billingAddress; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/ApplePayCardResponse.php b/src/Models/ApplePayCardResponse.php deleted file mode 100644 index 47d17e8..0000000 --- a/src/Models/ApplePayCardResponse.php +++ /dev/null @@ -1,391 +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 Available Networks. - * Array of brands or networks associated with the card. - * - * @return string[]|null - */ - public function getAvailableNetworks(): ?array - { - return $this->availableNetworks; - } - - /** - * Sets Available Networks. - * Array of brands or networks associated with the card. - * - * @maps available_networks - * - * @param string[]|null $availableNetworks - */ - public function setAvailableNetworks(?array $availableNetworks): void - { - $this->availableNetworks = $availableNetworks; - } - - /** - * 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 Authentication Result. - * Results of Authentication such as 3D Secure. - */ - public function getAuthenticationResult(): ?AuthenticationResponse - { - return $this->authenticationResult; - } - - /** - * Sets Authentication Result. - * Results of Authentication such as 3D Secure. - * - * @maps authentication_result - */ - public function setAuthenticationResult(?AuthenticationResponse $authenticationResult): void - { - $this->authenticationResult = $authenticationResult; - } - - /** - * Returns Attributes. - * Additional attributes associated with the use of this card. - */ - public function getAttributes(): ?CardAttributesResponse - { - return $this->attributes; - } - - /** - * Sets Attributes. - * Additional attributes associated with the use of this card. - * - * @maps attributes - */ - public function setAttributes(?CardAttributesResponse $attributes): void - { - $this->attributes = $attributes; - } - - /** - * Returns From Request. - * Representation of card details as received in the request. - */ - public function getFromRequest(): ?CardFromRequest - { - return $this->fromRequest; - } - - /** - * Sets From Request. - * Representation of card details as received in the request. - * - * @maps from_request - */ - public function setFromRequest(?CardFromRequest $fromRequest): void - { - $this->fromRequest = $fromRequest; - } - - /** - * 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 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 Billing 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 getBillingAddress(): ?Address - { - return $this->billingAddress; - } - - /** - * Sets Billing 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). - * - * @maps billing_address - */ - public function setBillingAddress(?Address $billingAddress): void - { - $this->billingAddress = $billingAddress; - } - - /** - * 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 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 [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 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 - */ - public function setCountryCode(?string $countryCode): void - { - $this->countryCode = $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->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->availableNetworks)) { - $json['available_networks'] = CardBrand::checkValue($this->availableNetworks); - } - if (isset($this->type)) { - $json['type'] = CardType::checkValue($this->type); - } - if (isset($this->authenticationResult)) { - $json['authentication_result'] = $this->authenticationResult; - } - if (isset($this->attributes)) { - $json['attributes'] = $this->attributes; - } - if (isset($this->fromRequest)) { - $json['from_request'] = $this->fromRequest; - } - if (isset($this->expiry)) { - $json['expiry'] = $this->expiry; - } - if (isset($this->binDetails)) { - $json['bin_details'] = $this->binDetails; - } - if (isset($this->billingAddress)) { - $json['billing_address'] = $this->billingAddress; - } - if (isset($this->countryCode)) { - $json['country_code'] = $this->countryCode; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/ApplePayDecryptedTokenData.php b/src/Models/ApplePayDecryptedTokenData.php deleted file mode 100644 index bbe73d9..0000000 --- a/src/Models/ApplePayDecryptedTokenData.php +++ /dev/null @@ -1,186 +0,0 @@ -tokenizedCard = $tokenizedCard; - } - - /** - * Returns Transaction Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getTransactionAmount(): ?Money - { - return $this->transactionAmount; - } - - /** - * Sets Transaction Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps transaction_amount - */ - public function setTransactionAmount(?Money $transactionAmount): void - { - $this->transactionAmount = $transactionAmount; - } - - /** - * Returns Tokenized Card. - * The payment card to use to fund a payment. Can be a credit or debit card. - */ - public function getTokenizedCard(): ApplePayTokenizedCard - { - return $this->tokenizedCard; - } - - /** - * Sets Tokenized Card. - * The payment card to use to fund a payment. Can be a credit or debit card. - * - * @required - * @maps tokenized_card - */ - public function setTokenizedCard(ApplePayTokenizedCard $tokenizedCard): void - { - $this->tokenizedCard = $tokenizedCard; - } - - /** - * Returns Device Manufacturer Id. - * Apple Pay Hex-encoded device manufacturer identifier. The pattern is defined by an external party - * and supports Unicode. - */ - public function getDeviceManufacturerId(): ?string - { - return $this->deviceManufacturerId; - } - - /** - * Sets Device Manufacturer Id. - * Apple Pay Hex-encoded device manufacturer identifier. The pattern is defined by an external party - * and supports Unicode. - * - * @maps device_manufacturer_id - */ - public function setDeviceManufacturerId(?string $deviceManufacturerId): void - { - $this->deviceManufacturerId = $deviceManufacturerId; - } - - /** - * Returns Payment Data Type. - * Indicates the type of payment data passed, in case of Non China the payment data is 3DSECURE and for - * China it is EMV. - */ - public function getPaymentDataType(): ?string - { - return $this->paymentDataType; - } - - /** - * Sets Payment Data Type. - * Indicates the type of payment data passed, in case of Non China the payment data is 3DSECURE and for - * China it is EMV. - * - * @maps payment_data_type - */ - public function setPaymentDataType(?string $paymentDataType): void - { - $this->paymentDataType = $paymentDataType; - } - - /** - * Returns Payment Data. - * Information about the decrypted apple pay payment data for the token like cryptogram, eci indicator. - */ - public function getPaymentData(): ?ApplePayPaymentData - { - return $this->paymentData; - } - - /** - * Sets Payment Data. - * Information about the decrypted apple pay payment data for the token like cryptogram, eci indicator. - * - * @maps payment_data - */ - public function setPaymentData(?ApplePayPaymentData $paymentData): void - { - $this->paymentData = $paymentData; - } - - /** - * 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->transactionAmount)) { - $json['transaction_amount'] = $this->transactionAmount; - } - $json['tokenized_card'] = $this->tokenizedCard; - if (isset($this->deviceManufacturerId)) { - $json['device_manufacturer_id'] = $this->deviceManufacturerId; - } - if (isset($this->paymentDataType)) { - $json['payment_data_type'] = ApplePayPaymentDataType::checkValue($this->paymentDataType); - } - if (isset($this->paymentData)) { - $json['payment_data'] = $this->paymentData; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/ApplePayPaymentData.php b/src/Models/ApplePayPaymentData.php deleted file mode 100644 index 9eab4d8..0000000 --- a/src/Models/ApplePayPaymentData.php +++ /dev/null @@ -1,153 +0,0 @@ -cryptogram; - } - - /** - * Sets Cryptogram. - * Online payment cryptogram, as defined by 3D Secure. The pattern is defined by an external party and - * supports Unicode. - * - * @maps cryptogram - */ - public function setCryptogram(?string $cryptogram): void - { - $this->cryptogram = $cryptogram; - } - - /** - * Returns Eci Indicator. - * ECI indicator, as defined by 3- Secure. The pattern is defined by an external party and supports - * Unicode. - */ - public function getEciIndicator(): ?string - { - return $this->eciIndicator; - } - - /** - * Sets Eci Indicator. - * ECI indicator, as defined by 3- Secure. The pattern is defined by an external party and supports - * Unicode. - * - * @maps eci_indicator - */ - public function setEciIndicator(?string $eciIndicator): void - { - $this->eciIndicator = $eciIndicator; - } - - /** - * Returns Emv Data. - * Encoded Apple Pay EMV Payment Structure used for payments in China. The pattern is defined by an - * external party and supports Unicode. - */ - public function getEmvData(): ?string - { - return $this->emvData; - } - - /** - * Sets Emv Data. - * Encoded Apple Pay EMV Payment Structure used for payments in China. The pattern is defined by an - * external party and supports Unicode. - * - * @maps emv_data - */ - public function setEmvData(?string $emvData): void - { - $this->emvData = $emvData; - } - - /** - * Returns Pin. - * Bank Key encrypted Apple Pay PIN. The pattern is defined by an external party and supports Unicode. - */ - public function getPin(): ?string - { - return $this->pin; - } - - /** - * Sets Pin. - * Bank Key encrypted Apple Pay PIN. The pattern is defined by an external party and supports Unicode. - * - * @maps pin - */ - public function setPin(?string $pin): void - { - $this->pin = $pin; - } - - /** - * 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->cryptogram)) { - $json['cryptogram'] = $this->cryptogram; - } - if (isset($this->eciIndicator)) { - $json['eci_indicator'] = $this->eciIndicator; - } - if (isset($this->emvData)) { - $json['emv_data'] = $this->emvData; - } - if (isset($this->pin)) { - $json['pin'] = $this->pin; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/ApplePayPaymentDataType.php b/src/Models/ApplePayPaymentDataType.php deleted file mode 100644 index 8007523..0000000 --- a/src/Models/ApplePayPaymentDataType.php +++ /dev/null @@ -1,46 +0,0 @@ -id; - } - - /** - * Sets Id. - * ApplePay transaction identifier, this will be the unique identifier for this transaction provided by - * Apple. The pattern is defined by an external party and supports Unicode. - * - * @maps id - */ - public function setId(?string $id): void - { - $this->id = $id; - } - - /** - * Returns Token. - * Encrypted ApplePay token, containing card information. This token would be base64encoded. The - * pattern is defined by an external party and supports Unicode. - */ - public function getToken(): ?string - { - return $this->token; - } - - /** - * Sets Token. - * Encrypted ApplePay token, containing card information. This token would be base64encoded. The - * pattern is defined by an external party and supports Unicode. - * - * @maps token - */ - public function setToken(?string $token): void - { - $this->token = $token; - } - - /** - * Returns Name. - * The full name representation like Mr J Smith. - */ - public function getName(): ?string - { - return $this->name; - } - - /** - * Sets Name. - * The full name representation like Mr J Smith. - * - * @maps name - */ - public function setName(?string $name): void - { - $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. - * int/rec/T-REC-E.164/en). - */ - public function getPhoneNumber(): ?PhoneNumber - { - 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(?PhoneNumber $phoneNumber): void - { - $this->phoneNumber = $phoneNumber; - } - - /** - * Returns Card. - * The Card from Apple Pay Wallet used to fund the payment. - */ - public function getCard(): ?ApplePayCardResponse - { - return $this->card; - } - - /** - * Sets Card. - * The Card from Apple Pay Wallet used to fund the payment. - * - * @maps card - */ - public function setCard(?ApplePayCardResponse $card): void - { - $this->card = $card; - } - - /** - * Returns Attributes. - * Additional attributes associated with the use of Apple Pay. - */ - public function getAttributes(): ?ApplePayAttributesResponse - { - return $this->attributes; - } - - /** - * Sets Attributes. - * Additional attributes associated with the use of Apple Pay. - * - * @maps attributes - */ - public function setAttributes(?ApplePayAttributesResponse $attributes): void - { - $this->attributes = $attributes; - } - - /** - * 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->token)) { - $json['token'] = $this->token; - } - if (isset($this->name)) { - $json['name'] = $this->name; - } - if (isset($this->emailAddress)) { - $json['email_address'] = $this->emailAddress; - } - if (isset($this->phoneNumber)) { - $json['phone_number'] = $this->phoneNumber; - } - if (isset($this->card)) { - $json['card'] = $this->card; - } - if (isset($this->attributes)) { - $json['attributes'] = $this->attributes; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/ApplePayPaymentToken.php b/src/Models/ApplePayPaymentToken.php deleted file mode 100644 index 1c6fa64..0000000 --- a/src/Models/ApplePayPaymentToken.php +++ /dev/null @@ -1,63 +0,0 @@ -card; - } - - /** - * Sets Card. - * The payment card to be used to fund a payment. Can be a credit or debit card. - * - * @maps card - */ - public function setCard(?ApplePayCard $card): void - { - $this->card = $card; - } - - /** - * 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->card)) { - $json['card'] = $this->card; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/ApplePayRequest.php b/src/Models/ApplePayRequest.php deleted file mode 100644 index 74fdd82..0000000 --- a/src/Models/ApplePayRequest.php +++ /dev/null @@ -1,285 +0,0 @@ -id; - } - - /** - * Sets Id. - * ApplePay transaction identifier, this will be the unique identifier for this transaction provided by - * Apple. The pattern is defined by an external party and supports Unicode. - * - * @maps id - */ - public function setId(?string $id): void - { - $this->id = $id; - } - - /** - * Returns Name. - * The full name representation like Mr J Smith. - */ - public function getName(): ?string - { - return $this->name; - } - - /** - * Sets Name. - * The full name representation like Mr J Smith. - * - * @maps name - */ - public function setName(?string $name): void - { - $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. - * int/rec/T-REC-E.164/en). - */ - public function getPhoneNumber(): ?PhoneNumber - { - 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(?PhoneNumber $phoneNumber): void - { - $this->phoneNumber = $phoneNumber; - } - - /** - * Returns Decrypted Token. - * Information about the Payment data obtained by decrypting Apple Pay token. - */ - public function getDecryptedToken(): ?ApplePayDecryptedTokenData - { - return $this->decryptedToken; - } - - /** - * Sets Decrypted Token. - * Information about the Payment data obtained by decrypting Apple Pay token. - * - * @maps decrypted_token - */ - public function setDecryptedToken(?ApplePayDecryptedTokenData $decryptedToken): void - { - $this->decryptedToken = $decryptedToken; - } - - /** - * 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: - *
- */ - 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: - *
- * - * @maps stored_credential - */ - public function setStoredCredential(?CardStoredCredential $storedCredential): void - { - $this->storedCredential = $storedCredential; - } - - /** - * Returns Vault Id. - * The PayPal-generated ID for the vaulted payment source. This ID should be stored on the merchant's - * server so the saved payment source can be used for future transactions. - */ - public function getVaultId(): ?string - { - return $this->vaultId; - } - - /** - * Sets Vault Id. - * The PayPal-generated ID for the vaulted payment source. This ID should be stored on the merchant's - * server so the saved payment source can be used for future transactions. - * - * @maps vault_id - */ - public function setVaultId(?string $vaultId): void - { - $this->vaultId = $vaultId; - } - - /** - * Returns Attributes. - * Additional attributes associated with apple pay. - */ - public function getAttributes(): ?ApplePayAttributes - { - return $this->attributes; - } - - /** - * Sets Attributes. - * Additional attributes associated with apple pay. - * - * @maps attributes - */ - public function setAttributes(?ApplePayAttributes $attributes): void - { - $this->attributes = $attributes; - } - - /** - * 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->name)) { - $json['name'] = $this->name; - } - if (isset($this->emailAddress)) { - $json['email_address'] = $this->emailAddress; - } - if (isset($this->phoneNumber)) { - $json['phone_number'] = $this->phoneNumber; - } - if (isset($this->decryptedToken)) { - $json['decrypted_token'] = $this->decryptedToken; - } - if (isset($this->storedCredential)) { - $json['stored_credential'] = $this->storedCredential; - } - if (isset($this->vaultId)) { - $json['vault_id'] = $this->vaultId; - } - if (isset($this->attributes)) { - $json['attributes'] = $this->attributes; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/ApplePayTokenizedCard.php b/src/Models/ApplePayTokenizedCard.php deleted file mode 100644 index da948aa..0000000 --- a/src/Models/ApplePayTokenizedCard.php +++ /dev/null @@ -1,239 +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 Number. - * The primary account number (PAN) for the payment card. - */ - public function getNumber(): ?string - { - return $this->number; - } - - /** - * Sets Number. - * The primary account number (PAN) for the payment card. - * - * @maps number - */ - public function setNumber(?string $number): void - { - $this->number = $number; - } - - /** - * 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 Card Type. - * The card network or brand. Applies to credit, debit, gift, and payment cards. - */ - public function getCardType(): ?string - { - return $this->cardType; - } - - /** - * Sets Card Type. - * The card network or brand. Applies to credit, debit, gift, and payment cards. - * - * @maps card_type - */ - public function setCardType(?string $cardType): void - { - $this->cardType = $cardType; - } - - /** - * 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 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 Billing 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 getBillingAddress(): ?Address - { - return $this->billingAddress; - } - - /** - * Sets Billing 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). - * - * @maps billing_address - */ - public function setBillingAddress(?Address $billingAddress): void - { - $this->billingAddress = $billingAddress; - } - - /** - * 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->number)) { - $json['number'] = $this->number; - } - if (isset($this->expiry)) { - $json['expiry'] = $this->expiry; - } - if (isset($this->cardType)) { - $json['card_type'] = CardBrand::checkValue($this->cardType); - } - if (isset($this->type)) { - $json['type'] = CardType::checkValue($this->type); - } - if (isset($this->brand)) { - $json['brand'] = CardBrand::checkValue($this->brand); - } - if (isset($this->billingAddress)) { - $json['billing_address'] = $this->billingAddress; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/AuthenticationResponse.php b/src/Models/AuthenticationResponse.php deleted file mode 100644 index 61b258f..0000000 --- a/src/Models/AuthenticationResponse.php +++ /dev/null @@ -1,91 +0,0 @@ -liabilityShift; - } - - /** - * Sets Liability Shift. - * Liability shift indicator. The outcome of the issuer's authentication. - * - * @maps liability_shift - */ - public function setLiabilityShift(?string $liabilityShift): void - { - $this->liabilityShift = $liabilityShift; - } - - /** - * Returns Three D Secure. - * Results of 3D Secure Authentication. - */ - public function getThreeDSecure(): ?ThreeDSecureAuthenticationResponse - { - return $this->threeDSecure; - } - - /** - * Sets Three D Secure. - * Results of 3D Secure Authentication. - * - * @maps three_d_secure - */ - public function setThreeDSecure(?ThreeDSecureAuthenticationResponse $threeDSecure): void - { - $this->threeDSecure = $threeDSecure; - } - - /** - * 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->liabilityShift)) { - $json['liability_shift'] = LiabilityShiftIndicator::checkValue($this->liabilityShift); - } - if (isset($this->threeDSecure)) { - $json['three_d_secure'] = $this->threeDSecure; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/Authorization.php b/src/Models/Authorization.php deleted file mode 100644 index 0d71004..0000000 --- a/src/Models/Authorization.php +++ /dev/null @@ -1,393 +0,0 @@ -status; - } - - /** - * Sets Status. - * The status for the authorized payment. - * - * @maps status - */ - public function setStatus(?string $status): void - { - $this->status = $status; - } - - /** - * Returns Status Details. - * The details of the authorized payment status. - */ - public function getStatusDetails(): ?AuthorizationStatusDetails - { - return $this->statusDetails; - } - - /** - * Sets Status Details. - * The details of the authorized payment status. - * - * @maps status_details - */ - public function setStatusDetails(?AuthorizationStatusDetails $statusDetails): void - { - $this->statusDetails = $statusDetails; - } - - /** - * Returns Id. - * The PayPal-generated ID for the authorized payment. - */ - public function getId(): ?string - { - return $this->id; - } - - /** - * Sets Id. - * The PayPal-generated ID for the authorized 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 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.
- */ - public function getExpirationTime(): ?string - { - return $this->expirationTime; - } - - /** - * 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.
- * - * @maps expiration_time - */ - public function setExpirationTime(?string $expirationTime): void - { - $this->expirationTime = $expirationTime; - } - - /** - * 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 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; - } - - /** - * 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'] = AuthorizationStatus::checkValue($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->expirationTime)) { - $json['expiration_time'] = $this->expirationTime; - } - if (isset($this->links)) { - $json['links'] = $this->links; - } - 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/AuthorizationIncompleteReason.php b/src/Models/AuthorizationIncompleteReason.php deleted file mode 100644 index 1089129..0000000 --- a/src/Models/AuthorizationIncompleteReason.php +++ /dev/null @@ -1,45 +0,0 @@ -reason; - } - - /** - * Sets Reason. - * The reason why the authorized status is `PENDING`. - * - * @maps reason - */ - public function setReason(?string $reason): void - { - $this->reason = $reason; - } - - /** - * 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->reason)) { - $json['reason'] = AuthorizationIncompleteReason::checkValue($this->reason); - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/AuthorizationStatusWithDetails.php b/src/Models/AuthorizationStatusWithDetails.php deleted file mode 100644 index 812ef9f..0000000 --- a/src/Models/AuthorizationStatusWithDetails.php +++ /dev/null @@ -1,91 +0,0 @@ -status; - } - - /** - * Sets Status. - * The status for the authorized payment. - * - * @maps status - */ - public function setStatus(?string $status): void - { - $this->status = $status; - } - - /** - * Returns Status Details. - * The details of the authorized payment status. - */ - public function getStatusDetails(): ?AuthorizationStatusDetails - { - return $this->statusDetails; - } - - /** - * Sets Status Details. - * The details of the authorized payment status. - * - * @maps status_details - */ - public function setStatusDetails(?AuthorizationStatusDetails $statusDetails): void - { - $this->statusDetails = $statusDetails; - } - - /** - * 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'] = AuthorizationStatus::checkValue($this->status); - } - if (isset($this->statusDetails)) { - $json['status_details'] = $this->statusDetails; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/AuthorizationWithAdditionalData.php b/src/Models/AuthorizationWithAdditionalData.php deleted file mode 100644 index cdadc47..0000000 --- a/src/Models/AuthorizationWithAdditionalData.php +++ /dev/null @@ -1,422 +0,0 @@ -status; - } - - /** - * Sets Status. - * The status for the authorized payment. - * - * @maps status - */ - public function setStatus(?string $status): void - { - $this->status = $status; - } - - /** - * Returns Status Details. - * The details of the authorized payment status. - */ - public function getStatusDetails(): ?AuthorizationStatusDetails - { - return $this->statusDetails; - } - - /** - * Sets Status Details. - * The details of the authorized payment status. - * - * @maps status_details - */ - public function setStatusDetails(?AuthorizationStatusDetails $statusDetails): void - { - $this->statusDetails = $statusDetails; - } - - /** - * Returns Id. - * The PayPal-generated ID for the authorized payment. - */ - public function getId(): ?string - { - return $this->id; - } - - /** - * Sets Id. - * The PayPal-generated ID for the authorized 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 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.
- */ - public function getExpirationTime(): ?string - { - return $this->expirationTime; - } - - /** - * 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.
- * - * @maps expiration_time - */ - public function setExpirationTime(?string $expirationTime): void - { - $this->expirationTime = $expirationTime; - } - - /** - * 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 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; - } - - /** - * Returns Processor Response. - * The processor response information for payment requests, such as direct credit card transactions. - */ - public function getProcessorResponse(): ?ProcessorResponse - { - 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(?ProcessorResponse $processorResponse): void - { - $this->processorResponse = $processorResponse; - } - - /** - * 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'] = AuthorizationStatus::checkValue($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->expirationTime)) { - $json['expiration_time'] = $this->expirationTime; - } - if (isset($this->links)) { - $json['links'] = $this->links; - } - if (isset($this->createTime)) { - $json['create_time'] = $this->createTime; - } - if (isset($this->updateTime)) { - $json['update_time'] = $this->updateTime; - } - if (isset($this->processorResponse)) { - $json['processor_response'] = $this->processorResponse; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/BLIKExperienceContext.php b/src/Models/BLIKExperienceContext.php deleted file mode 100644 index a4654a5..0000000 --- a/src/Models/BLIKExperienceContext.php +++ /dev/null @@ -1,247 +0,0 @@ -brandName; - } - - /** - * Sets Brand Name. - * 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. - * - * @maps brand_name - */ - public function setBrandName(?string $brandName): void - { - $this->brandName = $brandName; - } - - /** - * Returns Locale. - * 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/). - */ - public function getLocale(): ?string - { - return $this->locale; - } - - /** - * Sets Locale. - * 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/). - * - * @maps locale - */ - public function setLocale(?string $locale): void - { - $this->locale = $locale; - } - - /** - * Returns Shipping Preference. - * The location from which the shipping address is derived. - */ - public function getShippingPreference(): ?string - { - return $this->shippingPreference; - } - - /** - * Sets Shipping Preference. - * The location from which the shipping address is derived. - * - * @maps shipping_preference - */ - public function setShippingPreference(?string $shippingPreference): void - { - $this->shippingPreference = $shippingPreference; - } - - /** - * Returns Return Url. - * Describes the URL. - */ - public function getReturnUrl(): ?string - { - return $this->returnUrl; - } - - /** - * Sets Return Url. - * Describes the URL. - * - * @maps return_url - */ - public function setReturnUrl(?string $returnUrl): void - { - $this->returnUrl = $returnUrl; - } - - /** - * Returns Cancel Url. - * Describes the URL. - */ - public function getCancelUrl(): ?string - { - return $this->cancelUrl; - } - - /** - * Sets Cancel Url. - * Describes the URL. - * - * @maps cancel_url - */ - public function setCancelUrl(?string $cancelUrl): void - { - $this->cancelUrl = $cancelUrl; - } - - /** - * Returns Consumer Ip. - * 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. - */ - public function getConsumerIp(): ?string - { - return $this->consumerIp; - } - - /** - * Sets Consumer Ip. - * 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 consumer_ip - */ - public function setConsumerIp(?string $consumerIp): void - { - $this->consumerIp = $consumerIp; - } - - /** - * Returns Consumer User Agent. - * The payer's User Agent. For example, Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0). - */ - public function getConsumerUserAgent(): ?string - { - return $this->consumerUserAgent; - } - - /** - * Sets Consumer User Agent. - * The payer's User Agent. For example, Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0). - * - * @maps consumer_user_agent - */ - public function setConsumerUserAgent(?string $consumerUserAgent): void - { - $this->consumerUserAgent = $consumerUserAgent; - } - - /** - * 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->brandName)) { - $json['brand_name'] = $this->brandName; - } - if (isset($this->locale)) { - $json['locale'] = $this->locale; - } - if (isset($this->shippingPreference)) { - $json['shipping_preference'] = ShippingPreference::checkValue($this->shippingPreference); - } - if (isset($this->returnUrl)) { - $json['return_url'] = $this->returnUrl; - } - if (isset($this->cancelUrl)) { - $json['cancel_url'] = $this->cancelUrl; - } - if (isset($this->consumerIp)) { - $json['consumer_ip'] = $this->consumerIp; - } - if (isset($this->consumerUserAgent)) { - $json['consumer_user_agent'] = $this->consumerUserAgent; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/BLIKLevel0PaymentObject.php b/src/Models/BLIKLevel0PaymentObject.php deleted file mode 100644 index 88e20c9..0000000 --- a/src/Models/BLIKLevel0PaymentObject.php +++ /dev/null @@ -1,70 +0,0 @@ -authCode = $authCode; - } - - /** - * Returns Auth Code. - * The 6-digit code used to authenticate a consumer within BLIK. - */ - public function getAuthCode(): string - { - return $this->authCode; - } - - /** - * Sets Auth Code. - * The 6-digit code used to authenticate a consumer within BLIK. - * - * @required - * @maps auth_code - */ - public function setAuthCode(string $authCode): void - { - $this->authCode = $authCode; - } - - /** - * 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['auth_code'] = $this->authCode; - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/BLIKOneClickPaymentObject.php b/src/Models/BLIKOneClickPaymentObject.php deleted file mode 100644 index 043c350..0000000 --- a/src/Models/BLIKOneClickPaymentObject.php +++ /dev/null @@ -1,65 +0,0 @@ -consumerReference; - } - - /** - * Sets Consumer Reference. - * The merchant generated, unique reference serving as a primary identifier for accounts connected - * between Blik and a merchant. - * - * @maps consumer_reference - */ - public function setConsumerReference(?string $consumerReference): void - { - $this->consumerReference = $consumerReference; - } - - /** - * 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->consumerReference)) { - $json['consumer_reference'] = $this->consumerReference; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/BLIKOneClickPaymentRequest.php b/src/Models/BLIKOneClickPaymentRequest.php deleted file mode 100644 index 7d93883..0000000 --- a/src/Models/BLIKOneClickPaymentRequest.php +++ /dev/null @@ -1,160 +0,0 @@ -consumerReference = $consumerReference; - } - - /** - * Returns Auth Code. - * The 6-digit code used to authenticate a consumer within BLIK. - */ - public function getAuthCode(): ?string - { - return $this->authCode; - } - - /** - * Sets Auth Code. - * The 6-digit code used to authenticate a consumer within BLIK. - * - * @maps auth_code - */ - public function setAuthCode(?string $authCode): void - { - $this->authCode = $authCode; - } - - /** - * Returns Consumer Reference. - * The merchant generated, unique reference serving as a primary identifier for accounts connected - * between Blik and a merchant. - */ - public function getConsumerReference(): string - { - return $this->consumerReference; - } - - /** - * Sets Consumer Reference. - * The merchant generated, unique reference serving as a primary identifier for accounts connected - * between Blik and a merchant. - * - * @required - * @maps consumer_reference - */ - public function setConsumerReference(string $consumerReference): void - { - $this->consumerReference = $consumerReference; - } - - /** - * Returns Alias Label. - * A bank defined identifier used as a display name to allow the payer to differentiate between - * multiple registered bank accounts. - */ - public function getAliasLabel(): ?string - { - return $this->aliasLabel; - } - - /** - * Sets Alias Label. - * A bank defined identifier used as a display name to allow the payer to differentiate between - * multiple registered bank accounts. - * - * @maps alias_label - */ - public function setAliasLabel(?string $aliasLabel): void - { - $this->aliasLabel = $aliasLabel; - } - - /** - * Returns Alias Key. - * A Blik-defined identifier for a specific Blik-enabled bank account that is associated with a given - * merchant. Used only in conjunction with a Consumer Reference. - */ - public function getAliasKey(): ?string - { - return $this->aliasKey; - } - - /** - * Sets Alias Key. - * A Blik-defined identifier for a specific Blik-enabled bank account that is associated with a given - * merchant. Used only in conjunction with a Consumer Reference. - * - * @maps alias_key - */ - public function setAliasKey(?string $aliasKey): void - { - $this->aliasKey = $aliasKey; - } - - /** - * 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->authCode)) { - $json['auth_code'] = $this->authCode; - } - $json['consumer_reference'] = $this->consumerReference; - if (isset($this->aliasLabel)) { - $json['alias_label'] = $this->aliasLabel; - } - if (isset($this->aliasKey)) { - $json['alias_key'] = $this->aliasKey; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/BLIKPaymentObject.php b/src/Models/BLIKPaymentObject.php deleted file mode 100644 index b49bb6d..0000000 --- a/src/Models/BLIKPaymentObject.php +++ /dev/null @@ -1,161 +0,0 @@ -name; - } - - /** - * Sets Name. - * The full name representation like Mr J Smith. - * - * @maps name - */ - public function setName(?string $name): void - { - $this->name = $name; - } - - /** - * 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 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 [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 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 - */ - public function setCountryCode(?string $countryCode): void - { - $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 One Click. - * Information used to pay using BLIK one-click flow. - */ - public function getOneClick(): ?BLIKOneClickPaymentObject - { - return $this->oneClick; - } - - /** - * Sets One Click. - * Information used to pay using BLIK one-click flow. - * - * @maps one_click - */ - public function setOneClick(?BLIKOneClickPaymentObject $oneClick): void - { - $this->oneClick = $oneClick; - } - - /** - * 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->countryCode)) { - $json['country_code'] = $this->countryCode; - } - if (isset($this->email)) { - $json['email'] = $this->email; - } - if (isset($this->oneClick)) { - $json['one_click'] = $this->oneClick; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/BLIKPaymentRequest.php b/src/Models/BLIKPaymentRequest.php deleted file mode 100644 index 8874c4a..0000000 --- a/src/Models/BLIKPaymentRequest.php +++ /dev/null @@ -1,225 +0,0 @@ -name = $name; - $this->countryCode = $countryCode; - } - - /** - * Returns Name. - * The full name representation like Mr J Smith. - */ - public function getName(): string - { - return $this->name; - } - - /** - * Sets Name. - * The full name representation like Mr J Smith. - * - * @required - * @maps name - */ - public function setName(string $name): void - { - $this->name = $name; - } - - /** - * 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 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 [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 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; - } - - /** - * 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 Experience Context. - * Customizes the payer experience during the approval process for the BLIK payment. - */ - public function getExperienceContext(): ?BLIKExperienceContext - { - return $this->experienceContext; - } - - /** - * Sets Experience Context. - * Customizes the payer experience during the approval process for the BLIK payment. - * - * @maps experience_context - */ - public function setExperienceContext(?BLIKExperienceContext $experienceContext): void - { - $this->experienceContext = $experienceContext; - } - - /** - * Returns Level 0. - * Information used to pay using BLIK level_0 flow. - */ - public function getLevel0(): ?BLIKLevel0PaymentObject - { - return $this->level0; - } - - /** - * Sets Level 0. - * Information used to pay using BLIK level_0 flow. - * - * @maps level_0 - */ - public function setLevel0(?BLIKLevel0PaymentObject $level0): void - { - $this->level0 = $level0; - } - - /** - * Returns One Click. - * Information used to pay using BLIK one-click flow. - */ - public function getOneClick(): ?BLIKOneClickPaymentRequest - { - return $this->oneClick; - } - - /** - * Sets One Click. - * Information used to pay using BLIK one-click flow. - * - * @maps one_click - */ - public function setOneClick(?BLIKOneClickPaymentRequest $oneClick): void - { - $this->oneClick = $oneClick; - } - - /** - * 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; - $json['country_code'] = $this->countryCode; - if (isset($this->email)) { - $json['email'] = $this->email; - } - if (isset($this->experienceContext)) { - $json['experience_context'] = $this->experienceContext; - } - if (isset($this->level0)) { - $json['level_0'] = $this->level0; - } - if (isset($this->oneClick)) { - $json['one_click'] = $this->oneClick; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/BancontactPaymentObject.php b/src/Models/BancontactPaymentObject.php deleted file mode 100644 index 83832c9..0000000 --- a/src/Models/BancontactPaymentObject.php +++ /dev/null @@ -1,185 +0,0 @@ -name; - } - - /** - * Sets Name. - * The full name representation like Mr J Smith. - * - * @maps name - */ - public function setName(?string $name): void - { - $this->name = $name; - } - - /** - * 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 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 [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 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 - */ - public function setCountryCode(?string $countryCode): void - { - $this->countryCode = $countryCode; - } - - /** - * Returns Bic. - * The business identification code (BIC). In payments systems, a BIC is used to identify a specific - * business, most commonly a bank. - */ - public function getBic(): ?string - { - return $this->bic; - } - - /** - * Sets Bic. - * The business identification code (BIC). In payments systems, a BIC is used to identify a specific - * business, most commonly a bank. - * - * @maps bic - */ - public function setBic(?string $bic): void - { - $this->bic = $bic; - } - - /** - * Returns Iban Last Chars. - * The last characters of the IBAN used to pay. - */ - public function getIbanLastChars(): ?string - { - return $this->ibanLastChars; - } - - /** - * Sets Iban Last Chars. - * The last characters of the IBAN used to pay. - * - * @maps iban_last_chars - */ - public function setIbanLastChars(?string $ibanLastChars): void - { - $this->ibanLastChars = $ibanLastChars; - } - - /** - * Returns Card Last Digits. - * The last digits of the card used to fund the Bancontact payment. - */ - public function getCardLastDigits(): ?string - { - return $this->cardLastDigits; - } - - /** - * Sets Card Last Digits. - * The last digits of the card used to fund the Bancontact payment. - * - * @maps card_last_digits - */ - public function setCardLastDigits(?string $cardLastDigits): void - { - $this->cardLastDigits = $cardLastDigits; - } - - /** - * 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->countryCode)) { - $json['country_code'] = $this->countryCode; - } - if (isset($this->bic)) { - $json['bic'] = $this->bic; - } - if (isset($this->ibanLastChars)) { - $json['iban_last_chars'] = $this->ibanLastChars; - } - if (isset($this->cardLastDigits)) { - $json['card_last_digits'] = $this->cardLastDigits; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/BancontactPaymentRequest.php b/src/Models/BancontactPaymentRequest.php deleted file mode 100644 index 8b39fdc..0000000 --- a/src/Models/BancontactPaymentRequest.php +++ /dev/null @@ -1,135 +0,0 @@ -name = $name; - $this->countryCode = $countryCode; - } - - /** - * Returns Name. - * The full name representation like Mr J Smith. - */ - public function getName(): string - { - return $this->name; - } - - /** - * Sets Name. - * The full name representation like Mr J Smith. - * - * @required - * @maps name - */ - public function setName(string $name): void - { - $this->name = $name; - } - - /** - * 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 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 [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 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; - } - - /** - * Returns Experience Context. - * Customizes the payer experience during the approval process for the payment. - */ - public function getExperienceContext(): ?ExperienceContext - { - return $this->experienceContext; - } - - /** - * Sets Experience Context. - * Customizes the payer experience during the approval process for the payment. - * - * @maps experience_context - */ - public function setExperienceContext(?ExperienceContext $experienceContext): void - { - $this->experienceContext = $experienceContext; - } - - /** - * 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; - $json['country_code'] = $this->countryCode; - if (isset($this->experienceContext)) { - $json['experience_context'] = $this->experienceContext; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/BankPaymentToken.php b/src/Models/BankPaymentToken.php deleted file mode 100644 index d3ef619..0000000 --- a/src/Models/BankPaymentToken.php +++ /dev/null @@ -1,89 +0,0 @@ -achDebit; - } - - /** - * Sets Ach Debit. - * A Resource representing a response of vaulted a ACH Debit Account. - * - * @maps ach_debit - */ - public function setAchDebit(?ACHDebitResponse $achDebit): void - { - $this->achDebit = $achDebit; - } - - /** - * Returns Sepa Debit. - */ - public function getSepaDebit(): ?SEPADebitResponse - { - return $this->sepaDebit; - } - - /** - * Sets Sepa Debit. - * - * @maps sepa_debit - */ - public function setSepaDebit(?SEPADebitResponse $sepaDebit): void - { - $this->sepaDebit = $sepaDebit; - } - - /** - * 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->achDebit)) { - $json['ach_debit'] = $this->achDebit; - } - if (isset($this->sepaDebit)) { - $json['sepa_debit'] = $this->sepaDebit; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/BinDetails.php b/src/Models/BinDetails.php deleted file mode 100644 index 51a0ce2..0000000 --- a/src/Models/BinDetails.php +++ /dev/null @@ -1,163 +0,0 @@ -bin; - } - - /** - * Sets Bin. - * The Bank Identification Number (BIN) signifies the number that is being used to identify the - * granular level details (except the PII information) of the card. - * - * @maps bin - */ - public function setBin(?string $bin): void - { - $this->bin = $bin; - } - - /** - * Returns Issuing Bank. - * The issuer of the card instrument. - */ - public function getIssuingBank(): ?string - { - return $this->issuingBank; - } - - /** - * Sets Issuing Bank. - * The issuer of the card instrument. - * - * @maps issuing_bank - */ - public function setIssuingBank(?string $issuingBank): void - { - $this->issuingBank = $issuingBank; - } - - /** - * Returns Bin 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 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 - { - return $this->binCountryCode; - } - - /** - * Sets Bin 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 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 - */ - public function setBinCountryCode(?string $binCountryCode): void - { - $this->binCountryCode = $binCountryCode; - } - - /** - * Returns Products. - * The type of card product assigned to the BIN by the issuer. These values are defined by the issuer - * and may change over time. Some examples include: PREPAID_GIFT, CONSUMER, CORPORATE. - * - * @return string[]|null - */ - public function getProducts(): ?array - { - return $this->products; - } - - /** - * Sets Products. - * The type of card product assigned to the BIN by the issuer. These values are defined by the issuer - * and may change over time. Some examples include: PREPAID_GIFT, CONSUMER, CORPORATE. - * - * @maps products - * - * @param string[]|null $products - */ - public function setProducts(?array $products): void - { - $this->products = $products; - } - - /** - * 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->bin)) { - $json['bin'] = $this->bin; - } - if (isset($this->issuingBank)) { - $json['issuing_bank'] = $this->issuingBank; - } - if (isset($this->binCountryCode)) { - $json['bin_country_code'] = $this->binCountryCode; - } - if (isset($this->products)) { - $json['products'] = $this->products; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/Builders/ACHDebitResponseBuilder.php b/src/Models/Builders/ACHDebitResponseBuilder.php deleted file mode 100644 index df4781a..0000000 --- a/src/Models/Builders/ACHDebitResponseBuilder.php +++ /dev/null @@ -1,57 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new achdebit response Builder object. - */ - public static function init(): self - { - return new self(new ACHDebitResponse()); - } - - /** - * Sets verification status field. - */ - public function verificationStatus(?string $value): self - { - $this->instance->setVerificationStatus($value); - return $this; - } - - /** - * Initializes a new achdebit response object. - */ - public function build(): ACHDebitResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/ActivityTimestampsBuilder.php b/src/Models/Builders/ActivityTimestampsBuilder.php deleted file mode 100644 index deddeeb..0000000 --- a/src/Models/Builders/ActivityTimestampsBuilder.php +++ /dev/null @@ -1,66 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new activity timestamps Builder object. - */ - public static function init(): self - { - return new self(new ActivityTimestamps()); - } - - /** - * Sets create time field. - */ - public function createTime(?string $value): self - { - $this->instance->setCreateTime($value); - return $this; - } - - /** - * Sets update time field. - */ - public function updateTime(?string $value): self - { - $this->instance->setUpdateTime($value); - return $this; - } - - /** - * Initializes a new activity timestamps object. - */ - public function build(): ActivityTimestamps - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/AddressBuilder.php b/src/Models/Builders/AddressBuilder.php deleted file mode 100644 index fe6c235..0000000 --- a/src/Models/Builders/AddressBuilder.php +++ /dev/null @@ -1,93 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new address Builder object. - */ - public static function init(string $countryCode): self - { - return new self(new Address($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; - } - - /** - * Initializes a new address object. - */ - public function build(): Address - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/AddressDetailsBuilder.php b/src/Models/Builders/AddressDetailsBuilder.php deleted file mode 100644 index 702d5c3..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 deleted file mode 100644 index 8f66b3b..0000000 --- a/src/Models/Builders/AmountBreakdownBuilder.php +++ /dev/null @@ -1,112 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new amount breakdown Builder object. - */ - public static function init(): self - { - return new self(new AmountBreakdown()); - } - - /** - * Sets item total field. - */ - public function itemTotal(?Money $value): self - { - $this->instance->setItemTotal($value); - return $this; - } - - /** - * Sets shipping field. - */ - public function shipping(?Money $value): self - { - $this->instance->setShipping($value); - return $this; - } - - /** - * Sets handling field. - */ - public function handling(?Money $value): self - { - $this->instance->setHandling($value); - return $this; - } - - /** - * Sets tax total field. - */ - public function taxTotal(?Money $value): self - { - $this->instance->setTaxTotal($value); - return $this; - } - - /** - * Sets insurance field. - */ - public function insurance(?Money $value): self - { - $this->instance->setInsurance($value); - return $this; - } - - /** - * Sets shipping discount field. - */ - public function shippingDiscount(?Money $value): self - { - $this->instance->setShippingDiscount($value); - return $this; - } - - /** - * Sets discount field. - */ - public function discount(?Money $value): self - { - $this->instance->setDiscount($value); - return $this; - } - - /** - * Initializes a new amount breakdown object. - */ - public function build(): AmountBreakdown - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/AmountWithBreakdownBuilder.php b/src/Models/Builders/AmountWithBreakdownBuilder.php deleted file mode 100644 index 0a55df6..0000000 --- a/src/Models/Builders/AmountWithBreakdownBuilder.php +++ /dev/null @@ -1,58 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new amount with breakdown Builder object. - */ - public static function init(string $currencyCode, string $value): self - { - return new self(new AmountWithBreakdown($currencyCode, $value)); - } - - /** - * Sets breakdown field. - */ - public function breakdown(?AmountBreakdown $value): self - { - $this->instance->setBreakdown($value); - return $this; - } - - /** - * Initializes a new amount with breakdown object. - */ - public function build(): AmountWithBreakdown - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/ApplePayAttributesBuilder.php b/src/Models/Builders/ApplePayAttributesBuilder.php deleted file mode 100644 index 837011b..0000000 --- a/src/Models/Builders/ApplePayAttributesBuilder.php +++ /dev/null @@ -1,68 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new apple pay attributes Builder object. - */ - public static function init(): self - { - return new self(new ApplePayAttributes()); - } - - /** - * Sets customer field. - */ - public function customer(?CustomerInformation $value): self - { - $this->instance->setCustomer($value); - return $this; - } - - /** - * Sets vault field. - */ - public function vault(?VaultInstruction $value): self - { - $this->instance->setVault($value); - return $this; - } - - /** - * Initializes a new apple pay attributes object. - */ - public function build(): ApplePayAttributes - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/ApplePayAttributesResponseBuilder.php b/src/Models/Builders/ApplePayAttributesResponseBuilder.php deleted file mode 100644 index be10372..0000000 --- a/src/Models/Builders/ApplePayAttributesResponseBuilder.php +++ /dev/null @@ -1,58 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new apple pay attributes response Builder object. - */ - public static function init(): self - { - return new self(new ApplePayAttributesResponse()); - } - - /** - * Sets vault field. - */ - public function vault(?VaultResponse $value): self - { - $this->instance->setVault($value); - return $this; - } - - /** - * Initializes a new apple pay attributes response object. - */ - public function build(): ApplePayAttributesResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/ApplePayCardBuilder.php b/src/Models/Builders/ApplePayCardBuilder.php deleted file mode 100644 index 053b7aa..0000000 --- a/src/Models/Builders/ApplePayCardBuilder.php +++ /dev/null @@ -1,94 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new apple pay card Builder object. - */ - public static function init(): self - { - return new self(new ApplePayCard()); - } - - /** - * 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 type field. - */ - public function type(?string $value): self - { - $this->instance->setType($value); - return $this; - } - - /** - * Sets brand field. - */ - public function brand(?string $value): self - { - $this->instance->setBrand($value); - return $this; - } - - /** - * Sets billing address field. - */ - public function billingAddress(?Address $value): self - { - $this->instance->setBillingAddress($value); - return $this; - } - - /** - * Initializes a new apple pay card object. - */ - public function build(): ApplePayCard - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/ApplePayCardResponseBuilder.php b/src/Models/Builders/ApplePayCardResponseBuilder.php deleted file mode 100644 index 88db5e0..0000000 --- a/src/Models/Builders/ApplePayCardResponseBuilder.php +++ /dev/null @@ -1,161 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new apple pay card response Builder object. - */ - public static function init(): self - { - return new self(new ApplePayCardResponse()); - } - - /** - * 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 available networks field. - */ - public function availableNetworks(?array $value): self - { - $this->instance->setAvailableNetworks($value); - return $this; - } - - /** - * Sets type field. - */ - public function type(?string $value): self - { - $this->instance->setType($value); - return $this; - } - - /** - * Sets authentication result field. - */ - public function authenticationResult(?AuthenticationResponse $value): self - { - $this->instance->setAuthenticationResult($value); - return $this; - } - - /** - * Sets attributes field. - */ - public function attributes(?CardAttributesResponse $value): self - { - $this->instance->setAttributes($value); - return $this; - } - - /** - * Sets from request field. - */ - public function fromRequest(?CardFromRequest $value): self - { - $this->instance->setFromRequest($value); - return $this; - } - - /** - * Sets expiry field. - */ - public function expiry(?string $value): self - { - $this->instance->setExpiry($value); - return $this; - } - - /** - * Sets bin details field. - */ - public function binDetails(?BinDetails $value): self - { - $this->instance->setBinDetails($value); - return $this; - } - - /** - * Sets billing address field. - */ - public function billingAddress(?Address $value): self - { - $this->instance->setBillingAddress($value); - return $this; - } - - /** - * Sets country code field. - */ - public function countryCode(?string $value): self - { - $this->instance->setCountryCode($value); - return $this; - } - - /** - * Initializes a new apple pay card response object. - */ - public function build(): ApplePayCardResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/ApplePayDecryptedTokenDataBuilder.php b/src/Models/Builders/ApplePayDecryptedTokenDataBuilder.php deleted file mode 100644 index ff1cb03..0000000 --- a/src/Models/Builders/ApplePayDecryptedTokenDataBuilder.php +++ /dev/null @@ -1,87 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new apple pay decrypted token data Builder object. - */ - public static function init(ApplePayTokenizedCard $tokenizedCard): self - { - return new self(new ApplePayDecryptedTokenData($tokenizedCard)); - } - - /** - * Sets transaction amount field. - */ - public function transactionAmount(?Money $value): self - { - $this->instance->setTransactionAmount($value); - return $this; - } - - /** - * Sets device manufacturer id field. - */ - public function deviceManufacturerId(?string $value): self - { - $this->instance->setDeviceManufacturerId($value); - return $this; - } - - /** - * Sets payment data type field. - */ - public function paymentDataType(?string $value): self - { - $this->instance->setPaymentDataType($value); - return $this; - } - - /** - * Sets payment data field. - */ - public function paymentData(?ApplePayPaymentData $value): self - { - $this->instance->setPaymentData($value); - return $this; - } - - /** - * Initializes a new apple pay decrypted token data object. - */ - public function build(): ApplePayDecryptedTokenData - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/ApplePayPaymentDataBuilder.php b/src/Models/Builders/ApplePayPaymentDataBuilder.php deleted file mode 100644 index 595694f..0000000 --- a/src/Models/Builders/ApplePayPaymentDataBuilder.php +++ /dev/null @@ -1,84 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new apple pay payment data Builder object. - */ - public static function init(): self - { - return new self(new ApplePayPaymentData()); - } - - /** - * Sets cryptogram field. - */ - public function cryptogram(?string $value): self - { - $this->instance->setCryptogram($value); - return $this; - } - - /** - * Sets eci indicator field. - */ - public function eciIndicator(?string $value): self - { - $this->instance->setEciIndicator($value); - return $this; - } - - /** - * Sets emv data field. - */ - public function emvData(?string $value): self - { - $this->instance->setEmvData($value); - return $this; - } - - /** - * Sets pin field. - */ - public function pin(?string $value): self - { - $this->instance->setPin($value); - return $this; - } - - /** - * Initializes a new apple pay payment data object. - */ - public function build(): ApplePayPaymentData - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/ApplePayPaymentObjectBuilder.php b/src/Models/Builders/ApplePayPaymentObjectBuilder.php deleted file mode 100644 index f5196d6..0000000 --- a/src/Models/Builders/ApplePayPaymentObjectBuilder.php +++ /dev/null @@ -1,114 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new apple pay payment object Builder object. - */ - public static function init(): self - { - return new self(new ApplePayPaymentObject()); - } - - /** - * Sets id field. - */ - public function id(?string $value): self - { - $this->instance->setId($value); - return $this; - } - - /** - * Sets token field. - */ - public function token(?string $value): self - { - $this->instance->setToken($value); - return $this; - } - - /** - * Sets name field. - */ - public function name(?string $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets email address field. - */ - public function emailAddress(?string $value): self - { - $this->instance->setEmailAddress($value); - return $this; - } - - /** - * Sets phone number field. - */ - public function phoneNumber(?PhoneNumber $value): self - { - $this->instance->setPhoneNumber($value); - return $this; - } - - /** - * Sets card field. - */ - public function card(?ApplePayCardResponse $value): self - { - $this->instance->setCard($value); - return $this; - } - - /** - * Sets attributes field. - */ - public function attributes(?ApplePayAttributesResponse $value): self - { - $this->instance->setAttributes($value); - return $this; - } - - /** - * Initializes a new apple pay payment object object. - */ - public function build(): ApplePayPaymentObject - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/ApplePayPaymentTokenBuilder.php b/src/Models/Builders/ApplePayPaymentTokenBuilder.php deleted file mode 100644 index ee3550c..0000000 --- a/src/Models/Builders/ApplePayPaymentTokenBuilder.php +++ /dev/null @@ -1,58 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new apple pay payment token Builder object. - */ - public static function init(): self - { - return new self(new ApplePayPaymentToken()); - } - - /** - * Sets card field. - */ - public function card(?ApplePayCard $value): self - { - $this->instance->setCard($value); - return $this; - } - - /** - * Initializes a new apple pay payment token object. - */ - public function build(): ApplePayPaymentToken - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/ApplePayRequestBuilder.php b/src/Models/Builders/ApplePayRequestBuilder.php deleted file mode 100644 index 77f1b64..0000000 --- a/src/Models/Builders/ApplePayRequestBuilder.php +++ /dev/null @@ -1,124 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new apple pay request Builder object. - */ - public static function init(): self - { - return new self(new ApplePayRequest()); - } - - /** - * Sets id field. - */ - public function id(?string $value): self - { - $this->instance->setId($value); - return $this; - } - - /** - * Sets name field. - */ - public function name(?string $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets email address field. - */ - public function emailAddress(?string $value): self - { - $this->instance->setEmailAddress($value); - return $this; - } - - /** - * Sets phone number field. - */ - public function phoneNumber(?PhoneNumber $value): self - { - $this->instance->setPhoneNumber($value); - return $this; - } - - /** - * Sets decrypted token field. - */ - public function decryptedToken(?ApplePayDecryptedTokenData $value): self - { - $this->instance->setDecryptedToken($value); - return $this; - } - - /** - * Sets stored credential field. - */ - public function storedCredential(?CardStoredCredential $value): self - { - $this->instance->setStoredCredential($value); - return $this; - } - - /** - * Sets vault id field. - */ - public function vaultId(?string $value): self - { - $this->instance->setVaultId($value); - return $this; - } - - /** - * Sets attributes field. - */ - public function attributes(?ApplePayAttributes $value): self - { - $this->instance->setAttributes($value); - return $this; - } - - /** - * Initializes a new apple pay request object. - */ - public function build(): ApplePayRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/ApplePayTokenizedCardBuilder.php b/src/Models/Builders/ApplePayTokenizedCardBuilder.php deleted file mode 100644 index c12586b..0000000 --- a/src/Models/Builders/ApplePayTokenizedCardBuilder.php +++ /dev/null @@ -1,112 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new apple pay tokenized card Builder object. - */ - public static function init(): self - { - return new self(new ApplePayTokenizedCard()); - } - - /** - * Sets name field. - */ - public function name(?string $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets number field. - */ - public function number(?string $value): self - { - $this->instance->setNumber($value); - return $this; - } - - /** - * Sets expiry field. - */ - public function expiry(?string $value): self - { - $this->instance->setExpiry($value); - return $this; - } - - /** - * Sets card type field. - */ - public function cardType(?string $value): self - { - $this->instance->setCardType($value); - return $this; - } - - /** - * Sets type field. - */ - public function type(?string $value): self - { - $this->instance->setType($value); - return $this; - } - - /** - * Sets brand field. - */ - public function brand(?string $value): self - { - $this->instance->setBrand($value); - return $this; - } - - /** - * Sets billing address field. - */ - public function billingAddress(?Address $value): self - { - $this->instance->setBillingAddress($value); - return $this; - } - - /** - * Initializes a new apple pay tokenized card object. - */ - public function build(): ApplePayTokenizedCard - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/AuthenticationResponseBuilder.php b/src/Models/Builders/AuthenticationResponseBuilder.php deleted file mode 100644 index 1cc95bb..0000000 --- a/src/Models/Builders/AuthenticationResponseBuilder.php +++ /dev/null @@ -1,67 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new authentication response Builder object. - */ - public static function init(): self - { - return new self(new AuthenticationResponse()); - } - - /** - * Sets liability shift field. - */ - public function liabilityShift(?string $value): self - { - $this->instance->setLiabilityShift($value); - return $this; - } - - /** - * Sets three d secure field. - */ - public function threeDSecure(?ThreeDSecureAuthenticationResponse $value): self - { - $this->instance->setThreeDSecure($value); - return $this; - } - - /** - * Initializes a new authentication response object. - */ - public function build(): AuthenticationResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/AuthorizationBuilder.php b/src/Models/Builders/AuthorizationBuilder.php deleted file mode 100644 index 4be00c9..0000000 --- a/src/Models/Builders/AuthorizationBuilder.php +++ /dev/null @@ -1,160 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new authorization Builder object. - */ - public static function init(): self - { - return new self(new Authorization()); - } - - /** - * Sets status field. - */ - public function status(?string $value): self - { - $this->instance->setStatus($value); - return $this; - } - - /** - * Sets status details field. - */ - public function statusDetails(?AuthorizationStatusDetails $value): self - { - $this->instance->setStatusDetails($value); - return $this; - } - - /** - * Sets id field. - */ - public function id(?string $value): self - { - $this->instance->setId($value); - return $this; - } - - /** - * Sets amount field. - */ - public function amount(?Money $value): self - { - $this->instance->setAmount($value); - return $this; - } - - /** - * Sets invoice id field. - */ - public function invoiceId(?string $value): self - { - $this->instance->setInvoiceId($value); - return $this; - } - - /** - * Sets custom id field. - */ - public function customId(?string $value): self - { - $this->instance->setCustomId($value); - return $this; - } - - /** - * Sets network transaction reference field. - */ - public function networkTransactionReference(?NetworkTransactionReference $value): self - { - $this->instance->setNetworkTransactionReference($value); - return $this; - } - - /** - * Sets seller protection field. - */ - public function sellerProtection(?SellerProtection $value): self - { - $this->instance->setSellerProtection($value); - return $this; - } - - /** - * Sets expiration time field. - */ - public function expirationTime(?string $value): self - { - $this->instance->setExpirationTime($value); - return $this; - } - - /** - * Sets links field. - */ - public function links(?array $value): self - { - $this->instance->setLinks($value); - return $this; - } - - /** - * Sets create time field. - */ - public function createTime(?string $value): self - { - $this->instance->setCreateTime($value); - return $this; - } - - /** - * Sets update time field. - */ - public function updateTime(?string $value): self - { - $this->instance->setUpdateTime($value); - return $this; - } - - /** - * Initializes a new authorization object. - */ - public function build(): Authorization - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/AuthorizationStatusDetailsBuilder.php b/src/Models/Builders/AuthorizationStatusDetailsBuilder.php deleted file mode 100644 index 6b9e99f..0000000 --- a/src/Models/Builders/AuthorizationStatusDetailsBuilder.php +++ /dev/null @@ -1,57 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new authorization status details Builder object. - */ - public static function init(): self - { - return new self(new AuthorizationStatusDetails()); - } - - /** - * Sets reason field. - */ - public function reason(?string $value): self - { - $this->instance->setReason($value); - return $this; - } - - /** - * Initializes a new authorization status details object. - */ - public function build(): AuthorizationStatusDetails - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/AuthorizationStatusWithDetailsBuilder.php b/src/Models/Builders/AuthorizationStatusWithDetailsBuilder.php deleted file mode 100644 index 271dd4d..0000000 --- a/src/Models/Builders/AuthorizationStatusWithDetailsBuilder.php +++ /dev/null @@ -1,67 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new authorization status with details Builder object. - */ - public static function init(): self - { - return new self(new AuthorizationStatusWithDetails()); - } - - /** - * Sets status field. - */ - public function status(?string $value): self - { - $this->instance->setStatus($value); - return $this; - } - - /** - * Sets status details field. - */ - public function statusDetails(?AuthorizationStatusDetails $value): self - { - $this->instance->setStatusDetails($value); - return $this; - } - - /** - * Initializes a new authorization status with details object. - */ - public function build(): AuthorizationStatusWithDetails - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/AuthorizationWithAdditionalDataBuilder.php b/src/Models/Builders/AuthorizationWithAdditionalDataBuilder.php deleted file mode 100644 index 6883ff5..0000000 --- a/src/Models/Builders/AuthorizationWithAdditionalDataBuilder.php +++ /dev/null @@ -1,170 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new authorization with additional data Builder object. - */ - public static function init(): self - { - return new self(new AuthorizationWithAdditionalData()); - } - - /** - * Sets status field. - */ - public function status(?string $value): self - { - $this->instance->setStatus($value); - return $this; - } - - /** - * Sets status details field. - */ - public function statusDetails(?AuthorizationStatusDetails $value): self - { - $this->instance->setStatusDetails($value); - return $this; - } - - /** - * Sets id field. - */ - public function id(?string $value): self - { - $this->instance->setId($value); - return $this; - } - - /** - * Sets amount field. - */ - public function amount(?Money $value): self - { - $this->instance->setAmount($value); - return $this; - } - - /** - * Sets invoice id field. - */ - public function invoiceId(?string $value): self - { - $this->instance->setInvoiceId($value); - return $this; - } - - /** - * Sets custom id field. - */ - public function customId(?string $value): self - { - $this->instance->setCustomId($value); - return $this; - } - - /** - * Sets network transaction reference field. - */ - public function networkTransactionReference(?NetworkTransactionReference $value): self - { - $this->instance->setNetworkTransactionReference($value); - return $this; - } - - /** - * Sets seller protection field. - */ - public function sellerProtection(?SellerProtection $value): self - { - $this->instance->setSellerProtection($value); - return $this; - } - - /** - * Sets expiration time field. - */ - public function expirationTime(?string $value): self - { - $this->instance->setExpirationTime($value); - return $this; - } - - /** - * Sets links field. - */ - public function links(?array $value): self - { - $this->instance->setLinks($value); - return $this; - } - - /** - * Sets create time field. - */ - public function createTime(?string $value): self - { - $this->instance->setCreateTime($value); - return $this; - } - - /** - * Sets update time field. - */ - public function updateTime(?string $value): self - { - $this->instance->setUpdateTime($value); - return $this; - } - - /** - * Sets processor response field. - */ - public function processorResponse(?ProcessorResponse $value): self - { - $this->instance->setProcessorResponse($value); - return $this; - } - - /** - * Initializes a new authorization with additional data object. - */ - public function build(): AuthorizationWithAdditionalData - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/BLIKExperienceContextBuilder.php b/src/Models/Builders/BLIKExperienceContextBuilder.php deleted file mode 100644 index 9d8f062..0000000 --- a/src/Models/Builders/BLIKExperienceContextBuilder.php +++ /dev/null @@ -1,111 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new blikexperience context Builder object. - */ - public static function init(): self - { - return new self(new BLIKExperienceContext()); - } - - /** - * Sets brand name field. - */ - public function brandName(?string $value): self - { - $this->instance->setBrandName($value); - return $this; - } - - /** - * Sets locale field. - */ - public function locale(?string $value): self - { - $this->instance->setLocale($value); - return $this; - } - - /** - * Sets shipping preference field. - */ - public function shippingPreference(?string $value): self - { - $this->instance->setShippingPreference($value); - return $this; - } - - /** - * Sets return url field. - */ - public function returnUrl(?string $value): self - { - $this->instance->setReturnUrl($value); - return $this; - } - - /** - * Sets cancel url field. - */ - public function cancelUrl(?string $value): self - { - $this->instance->setCancelUrl($value); - return $this; - } - - /** - * Sets consumer ip field. - */ - public function consumerIp(?string $value): self - { - $this->instance->setConsumerIp($value); - return $this; - } - - /** - * Sets consumer user agent field. - */ - public function consumerUserAgent(?string $value): self - { - $this->instance->setConsumerUserAgent($value); - return $this; - } - - /** - * Initializes a new blikexperience context object. - */ - public function build(): BLIKExperienceContext - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/BLIKLevel0PaymentObjectBuilder.php b/src/Models/Builders/BLIKLevel0PaymentObjectBuilder.php deleted file mode 100644 index aecb308..0000000 --- a/src/Models/Builders/BLIKLevel0PaymentObjectBuilder.php +++ /dev/null @@ -1,48 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new bliklevel 0 payment object Builder object. - */ - public static function init(string $authCode): self - { - return new self(new BLIKLevel0PaymentObject($authCode)); - } - - /** - * Initializes a new bliklevel 0 payment object object. - */ - public function build(): BLIKLevel0PaymentObject - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/BLIKOneClickPaymentObjectBuilder.php b/src/Models/Builders/BLIKOneClickPaymentObjectBuilder.php deleted file mode 100644 index 4c5f939..0000000 --- a/src/Models/Builders/BLIKOneClickPaymentObjectBuilder.php +++ /dev/null @@ -1,57 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new blikone click payment object Builder object. - */ - public static function init(): self - { - return new self(new BLIKOneClickPaymentObject()); - } - - /** - * Sets consumer reference field. - */ - public function consumerReference(?string $value): self - { - $this->instance->setConsumerReference($value); - return $this; - } - - /** - * Initializes a new blikone click payment object object. - */ - public function build(): BLIKOneClickPaymentObject - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/BLIKOneClickPaymentRequestBuilder.php b/src/Models/Builders/BLIKOneClickPaymentRequestBuilder.php deleted file mode 100644 index f1b7d59..0000000 --- a/src/Models/Builders/BLIKOneClickPaymentRequestBuilder.php +++ /dev/null @@ -1,75 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new blikone click payment request Builder object. - */ - public static function init(string $consumerReference): self - { - return new self(new BLIKOneClickPaymentRequest($consumerReference)); - } - - /** - * Sets auth code field. - */ - public function authCode(?string $value): self - { - $this->instance->setAuthCode($value); - return $this; - } - - /** - * Sets alias label field. - */ - public function aliasLabel(?string $value): self - { - $this->instance->setAliasLabel($value); - return $this; - } - - /** - * Sets alias key field. - */ - public function aliasKey(?string $value): self - { - $this->instance->setAliasKey($value); - return $this; - } - - /** - * Initializes a new blikone click payment request object. - */ - public function build(): BLIKOneClickPaymentRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/BLIKPaymentObjectBuilder.php b/src/Models/Builders/BLIKPaymentObjectBuilder.php deleted file mode 100644 index b4ae5f0..0000000 --- a/src/Models/Builders/BLIKPaymentObjectBuilder.php +++ /dev/null @@ -1,85 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new blikpayment object Builder object. - */ - public static function init(): self - { - return new self(new BLIKPaymentObject()); - } - - /** - * Sets name field. - */ - public function name(?string $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets country code field. - */ - public function countryCode(?string $value): self - { - $this->instance->setCountryCode($value); - return $this; - } - - /** - * Sets email field. - */ - public function email(?string $value): self - { - $this->instance->setEmail($value); - return $this; - } - - /** - * Sets one click field. - */ - public function oneClick(?BLIKOneClickPaymentObject $value): self - { - $this->instance->setOneClick($value); - return $this; - } - - /** - * Initializes a new blikpayment object object. - */ - public function build(): BLIKPaymentObject - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/BLIKPaymentRequestBuilder.php b/src/Models/Builders/BLIKPaymentRequestBuilder.php deleted file mode 100644 index e267abd..0000000 --- a/src/Models/Builders/BLIKPaymentRequestBuilder.php +++ /dev/null @@ -1,87 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new blikpayment request Builder object. - */ - public static function init(string $name, string $countryCode): self - { - return new self(new BLIKPaymentRequest($name, $countryCode)); - } - - /** - * Sets email field. - */ - public function email(?string $value): self - { - $this->instance->setEmail($value); - return $this; - } - - /** - * Sets experience context field. - */ - public function experienceContext(?BLIKExperienceContext $value): self - { - $this->instance->setExperienceContext($value); - return $this; - } - - /** - * Sets level 0 field. - */ - public function level0(?BLIKLevel0PaymentObject $value): self - { - $this->instance->setLevel0($value); - return $this; - } - - /** - * Sets one click field. - */ - public function oneClick(?BLIKOneClickPaymentRequest $value): self - { - $this->instance->setOneClick($value); - return $this; - } - - /** - * Initializes a new blikpayment request object. - */ - public function build(): BLIKPaymentRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/BancontactPaymentObjectBuilder.php b/src/Models/Builders/BancontactPaymentObjectBuilder.php deleted file mode 100644 index 16ca9ff..0000000 --- a/src/Models/Builders/BancontactPaymentObjectBuilder.php +++ /dev/null @@ -1,93 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new bancontact payment object Builder object. - */ - public static function init(): self - { - return new self(new BancontactPaymentObject()); - } - - /** - * Sets name field. - */ - public function name(?string $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets country code field. - */ - public function countryCode(?string $value): self - { - $this->instance->setCountryCode($value); - return $this; - } - - /** - * Sets bic field. - */ - public function bic(?string $value): self - { - $this->instance->setBic($value); - return $this; - } - - /** - * Sets iban last chars field. - */ - public function ibanLastChars(?string $value): self - { - $this->instance->setIbanLastChars($value); - return $this; - } - - /** - * Sets card last digits field. - */ - public function cardLastDigits(?string $value): self - { - $this->instance->setCardLastDigits($value); - return $this; - } - - /** - * Initializes a new bancontact payment object object. - */ - public function build(): BancontactPaymentObject - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/BancontactPaymentRequestBuilder.php b/src/Models/Builders/BancontactPaymentRequestBuilder.php deleted file mode 100644 index 054def8..0000000 --- a/src/Models/Builders/BancontactPaymentRequestBuilder.php +++ /dev/null @@ -1,58 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new bancontact payment request Builder object. - */ - public static function init(string $name, string $countryCode): self - { - return new self(new BancontactPaymentRequest($name, $countryCode)); - } - - /** - * Sets experience context field. - */ - public function experienceContext(?ExperienceContext $value): self - { - $this->instance->setExperienceContext($value); - return $this; - } - - /** - * Initializes a new bancontact payment request object. - */ - public function build(): BancontactPaymentRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/BankPaymentTokenBuilder.php b/src/Models/Builders/BankPaymentTokenBuilder.php deleted file mode 100644 index 4884774..0000000 --- a/src/Models/Builders/BankPaymentTokenBuilder.php +++ /dev/null @@ -1,68 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new bank payment token Builder object. - */ - public static function init(): self - { - return new self(new BankPaymentToken()); - } - - /** - * Sets ach debit field. - */ - public function achDebit(?ACHDebitResponse $value): self - { - $this->instance->setAchDebit($value); - return $this; - } - - /** - * Sets sepa debit field. - */ - public function sepaDebit(?SEPADebitResponse $value): self - { - $this->instance->setSepaDebit($value); - return $this; - } - - /** - * Initializes a new bank payment token object. - */ - public function build(): BankPaymentToken - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/BinDetailsBuilder.php b/src/Models/Builders/BinDetailsBuilder.php deleted file mode 100644 index 60c93d0..0000000 --- a/src/Models/Builders/BinDetailsBuilder.php +++ /dev/null @@ -1,84 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new bin details Builder object. - */ - public static function init(): self - { - return new self(new BinDetails()); - } - - /** - * Sets bin field. - */ - public function bin(?string $value): self - { - $this->instance->setBin($value); - return $this; - } - - /** - * Sets issuing bank field. - */ - public function issuingBank(?string $value): self - { - $this->instance->setIssuingBank($value); - return $this; - } - - /** - * Sets bin country code field. - */ - public function binCountryCode(?string $value): self - { - $this->instance->setBinCountryCode($value); - return $this; - } - - /** - * Sets products field. - */ - public function products(?array $value): self - { - $this->instance->setProducts($value); - return $this; - } - - /** - * Initializes a new bin details object. - */ - public function build(): BinDetails - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/CaptureBuilder.php b/src/Models/Builders/CaptureBuilder.php deleted file mode 100644 index 104f545..0000000 --- a/src/Models/Builders/CaptureBuilder.php +++ /dev/null @@ -1,189 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new capture Builder object. - */ - public static function init(): self - { - return new self(new Capture()); - } - - /** - * Sets status field. - */ - public function status(?string $value): self - { - $this->instance->setStatus($value); - return $this; - } - - /** - * Sets status details field. - */ - public function statusDetails(?CaptureStatusDetails $value): self - { - $this->instance->setStatusDetails($value); - return $this; - } - - /** - * Sets id field. - */ - public function id(?string $value): self - { - $this->instance->setId($value); - return $this; - } - - /** - * Sets amount field. - */ - public function amount(?Money $value): self - { - $this->instance->setAmount($value); - return $this; - } - - /** - * Sets invoice id field. - */ - public function invoiceId(?string $value): self - { - $this->instance->setInvoiceId($value); - return $this; - } - - /** - * Sets custom id field. - */ - public function customId(?string $value): self - { - $this->instance->setCustomId($value); - return $this; - } - - /** - * Sets network transaction reference field. - */ - public function networkTransactionReference(?NetworkTransactionReference $value): self - { - $this->instance->setNetworkTransactionReference($value); - return $this; - } - - /** - * Sets seller protection field. - */ - public function sellerProtection(?SellerProtection $value): self - { - $this->instance->setSellerProtection($value); - return $this; - } - - /** - * Sets final capture field. - */ - public function finalCapture(?bool $value): self - { - $this->instance->setFinalCapture($value); - return $this; - } - - /** - * Sets seller receivable breakdown field. - */ - public function sellerReceivableBreakdown(?SellerReceivableBreakdown $value): self - { - $this->instance->setSellerReceivableBreakdown($value); - return $this; - } - - /** - * Sets disbursement mode field. - */ - public function disbursementMode(?string $value): self - { - $this->instance->setDisbursementMode($value); - return $this; - } - - /** - * Sets links field. - */ - public function links(?array $value): self - { - $this->instance->setLinks($value); - return $this; - } - - /** - * Sets processor response field. - */ - public function processorResponse(?ProcessorResponse $value): self - { - $this->instance->setProcessorResponse($value); - return $this; - } - - /** - * Sets create time field. - */ - public function createTime(?string $value): self - { - $this->instance->setCreateTime($value); - return $this; - } - - /** - * Sets update time field. - */ - public function updateTime(?string $value): self - { - $this->instance->setUpdateTime($value); - return $this; - } - - /** - * Initializes a new capture object. - */ - public function build(): Capture - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/CapturePaymentInstructionBuilder.php b/src/Models/Builders/CapturePaymentInstructionBuilder.php deleted file mode 100644 index b92fd2d..0000000 --- a/src/Models/Builders/CapturePaymentInstructionBuilder.php +++ /dev/null @@ -1,75 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new capture payment instruction Builder object. - */ - public static function init(): self - { - return new self(new CapturePaymentInstruction()); - } - - /** - * Sets platform fees field. - */ - public function platformFees(?array $value): self - { - $this->instance->setPlatformFees($value); - return $this; - } - - /** - * Sets disbursement mode field. - */ - public function disbursementMode(?string $value): self - { - $this->instance->setDisbursementMode($value); - return $this; - } - - /** - * Sets payee receivable fx rate id field. - */ - public function payeeReceivableFxRateId(?string $value): self - { - $this->instance->setPayeeReceivableFxRateId($value); - return $this; - } - - /** - * Initializes a new capture payment instruction object. - */ - public function build(): CapturePaymentInstruction - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/CaptureRequestBuilder.php b/src/Models/Builders/CaptureRequestBuilder.php deleted file mode 100644 index e9b3272..0000000 --- a/src/Models/Builders/CaptureRequestBuilder.php +++ /dev/null @@ -1,104 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new capture request Builder object. - */ - public static function init(): self - { - return new self(new CaptureRequest()); - } - - /** - * Sets invoice id field. - */ - public function invoiceId(?string $value): self - { - $this->instance->setInvoiceId($value); - return $this; - } - - /** - * Sets note to payer field. - */ - public function noteToPayer(?string $value): self - { - $this->instance->setNoteToPayer($value); - return $this; - } - - /** - * Sets amount field. - */ - public function amount(?Money $value): self - { - $this->instance->setAmount($value); - return $this; - } - - /** - * Sets final capture field. - */ - public function finalCapture(?bool $value): self - { - $this->instance->setFinalCapture($value); - return $this; - } - - /** - * Sets payment instruction field. - */ - public function paymentInstruction(?CapturePaymentInstruction $value): self - { - $this->instance->setPaymentInstruction($value); - return $this; - } - - /** - * Sets soft descriptor field. - */ - public function softDescriptor(?string $value): self - { - $this->instance->setSoftDescriptor($value); - return $this; - } - - /** - * Initializes a new capture request object. - */ - public function build(): CaptureRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/CaptureStatusDetailsBuilder.php b/src/Models/Builders/CaptureStatusDetailsBuilder.php deleted file mode 100644 index 15efed9..0000000 --- a/src/Models/Builders/CaptureStatusDetailsBuilder.php +++ /dev/null @@ -1,57 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new capture status details Builder object. - */ - public static function init(): self - { - return new self(new CaptureStatusDetails()); - } - - /** - * Sets reason field. - */ - public function reason(?string $value): self - { - $this->instance->setReason($value); - return $this; - } - - /** - * Initializes a new capture status details object. - */ - public function build(): CaptureStatusDetails - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/CaptureStatusWithDetailsBuilder.php b/src/Models/Builders/CaptureStatusWithDetailsBuilder.php deleted file mode 100644 index d2d1f1c..0000000 --- a/src/Models/Builders/CaptureStatusWithDetailsBuilder.php +++ /dev/null @@ -1,67 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new capture status with details Builder object. - */ - public static function init(): self - { - return new self(new CaptureStatusWithDetails()); - } - - /** - * Sets status field. - */ - public function status(?string $value): self - { - $this->instance->setStatus($value); - return $this; - } - - /** - * Sets status details field. - */ - public function statusDetails(?CaptureStatusDetails $value): self - { - $this->instance->setStatusDetails($value); - return $this; - } - - /** - * Initializes a new capture status with details object. - */ - public function build(): CaptureStatusWithDetails - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/CapturedPaymentBuilder.php b/src/Models/Builders/CapturedPaymentBuilder.php deleted file mode 100644 index 78744e8..0000000 --- a/src/Models/Builders/CapturedPaymentBuilder.php +++ /dev/null @@ -1,209 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new captured payment Builder object. - */ - public static function init(): self - { - return new self(new CapturedPayment()); - } - - /** - * Sets status field. - */ - public function status(?string $value): self - { - $this->instance->setStatus($value); - return $this; - } - - /** - * Sets status details field. - */ - public function statusDetails(?CaptureStatusDetails $value): self - { - $this->instance->setStatusDetails($value); - return $this; - } - - /** - * Sets id field. - */ - public function id(?string $value): self - { - $this->instance->setId($value); - return $this; - } - - /** - * Sets amount field. - */ - public function amount(?Money $value): self - { - $this->instance->setAmount($value); - return $this; - } - - /** - * Sets invoice id field. - */ - public function invoiceId(?string $value): self - { - $this->instance->setInvoiceId($value); - return $this; - } - - /** - * Sets custom id field. - */ - public function customId(?string $value): self - { - $this->instance->setCustomId($value); - return $this; - } - - /** - * Sets network transaction reference field. - */ - public function networkTransactionReference(?NetworkTransactionReference $value): self - { - $this->instance->setNetworkTransactionReference($value); - return $this; - } - - /** - * Sets seller protection field. - */ - public function sellerProtection(?SellerProtection $value): self - { - $this->instance->setSellerProtection($value); - return $this; - } - - /** - * Sets final capture field. - */ - public function finalCapture(?bool $value): self - { - $this->instance->setFinalCapture($value); - return $this; - } - - /** - * Sets seller receivable breakdown field. - */ - public function sellerReceivableBreakdown(?SellerReceivableBreakdown $value): self - { - $this->instance->setSellerReceivableBreakdown($value); - return $this; - } - - /** - * Sets disbursement mode field. - */ - public function disbursementMode(?string $value): self - { - $this->instance->setDisbursementMode($value); - return $this; - } - - /** - * Sets links field. - */ - public function links(?array $value): self - { - $this->instance->setLinks($value); - return $this; - } - - /** - * Sets processor response field. - */ - public function processorResponse(?ProcessorResponse $value): self - { - $this->instance->setProcessorResponse($value); - return $this; - } - - /** - * Sets create time field. - */ - public function createTime(?string $value): self - { - $this->instance->setCreateTime($value); - return $this; - } - - /** - * Sets update time field. - */ - public function updateTime(?string $value): self - { - $this->instance->setUpdateTime($value); - return $this; - } - - /** - * Sets supplementary data field. - */ - public function supplementaryData(?PaymentSupplementaryData $value): self - { - $this->instance->setSupplementaryData($value); - return $this; - } - - /** - * Sets payee field. - */ - public function payee(?Payee $value): self - { - $this->instance->setPayee($value); - return $this; - } - - /** - * Initializes a new captured payment object. - */ - public function build(): CapturedPayment - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/CardAttributesBuilder.php b/src/Models/Builders/CardAttributesBuilder.php deleted file mode 100644 index 69115de..0000000 --- a/src/Models/Builders/CardAttributesBuilder.php +++ /dev/null @@ -1,78 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new card attributes Builder object. - */ - public static function init(): self - { - return new self(new CardAttributes()); - } - - /** - * Sets customer field. - */ - public function customer(?CustomerInformation $value): self - { - $this->instance->setCustomer($value); - return $this; - } - - /** - * Sets vault field. - */ - public function vault(?VaultInstructionBase $value): self - { - $this->instance->setVault($value); - return $this; - } - - /** - * Sets verification field. - */ - public function verification(?CardVerification $value): self - { - $this->instance->setVerification($value); - return $this; - } - - /** - * Initializes a new card attributes object. - */ - public function build(): CardAttributes - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/CardAttributesResponseBuilder.php b/src/Models/Builders/CardAttributesResponseBuilder.php deleted file mode 100644 index a31db14..0000000 --- a/src/Models/Builders/CardAttributesResponseBuilder.php +++ /dev/null @@ -1,58 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new card attributes response Builder object. - */ - public static function init(): self - { - return new self(new CardAttributesResponse()); - } - - /** - * Sets vault field. - */ - public function vault(?VaultResponse $value): self - { - $this->instance->setVault($value); - return $this; - } - - /** - * Initializes a new card attributes response object. - */ - public function build(): CardAttributesResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/CardExperienceContextBuilder.php b/src/Models/Builders/CardExperienceContextBuilder.php deleted file mode 100644 index 58b5361..0000000 --- a/src/Models/Builders/CardExperienceContextBuilder.php +++ /dev/null @@ -1,66 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new card experience context Builder object. - */ - public static function init(): self - { - return new self(new CardExperienceContext()); - } - - /** - * Sets return url field. - */ - public function returnUrl(?string $value): self - { - $this->instance->setReturnUrl($value); - return $this; - } - - /** - * Sets cancel url field. - */ - public function cancelUrl(?string $value): self - { - $this->instance->setCancelUrl($value); - return $this; - } - - /** - * Initializes a new card experience context object. - */ - public function build(): CardExperienceContext - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/CardFromRequestBuilder.php b/src/Models/Builders/CardFromRequestBuilder.php deleted file mode 100644 index a9f834f..0000000 --- a/src/Models/Builders/CardFromRequestBuilder.php +++ /dev/null @@ -1,66 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new card from request Builder object. - */ - public static function init(): self - { - return new self(new CardFromRequest()); - } - - /** - * Sets expiry field. - */ - public function expiry(?string $value): self - { - $this->instance->setExpiry($value); - return $this; - } - - /** - * Sets last digits field. - */ - public function lastDigits(?string $value): self - { - $this->instance->setLastDigits($value); - return $this; - } - - /** - * Initializes a new card from request object. - */ - public function build(): CardFromRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/CardPaymentTokenBuilder.php b/src/Models/Builders/CardPaymentTokenBuilder.php deleted file mode 100644 index 362bd23..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(?AuthenticationResponse $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/CardRequestBuilder.php b/src/Models/Builders/CardRequestBuilder.php deleted file mode 100644 index 0a4f3d6..0000000 --- a/src/Models/Builders/CardRequestBuilder.php +++ /dev/null @@ -1,143 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new card request Builder object. - */ - public static function init(): self - { - return new self(new CardRequest()); - } - - /** - * Sets name field. - */ - public function name(?string $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets number field. - */ - public function number(?string $value): self - { - $this->instance->setNumber($value); - return $this; - } - - /** - * Sets expiry field. - */ - public function expiry(?string $value): self - { - $this->instance->setExpiry($value); - return $this; - } - - /** - * Sets security code field. - */ - public function securityCode(?string $value): self - { - $this->instance->setSecurityCode($value); - return $this; - } - - /** - * Sets billing address field. - */ - public function billingAddress(?Address $value): self - { - $this->instance->setBillingAddress($value); - return $this; - } - - /** - * Sets attributes field. - */ - public function attributes(?CardAttributes $value): self - { - $this->instance->setAttributes($value); - return $this; - } - - /** - * Sets vault id field. - */ - public function vaultId(?string $value): self - { - $this->instance->setVaultId($value); - return $this; - } - - /** - * Sets stored credential field. - */ - public function storedCredential(?CardStoredCredential $value): self - { - $this->instance->setStoredCredential($value); - return $this; - } - - /** - * Sets network token field. - */ - public function networkToken(?NetworkToken $value): self - { - $this->instance->setNetworkToken($value); - return $this; - } - - /** - * Sets experience context field. - */ - public function experienceContext(?CardExperienceContext $value): self - { - $this->instance->setExperienceContext($value); - return $this; - } - - /** - * Initializes a new card request object. - */ - public function build(): CardRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/CardResponseBuilder.php b/src/Models/Builders/CardResponseBuilder.php deleted file mode 100644 index c928c12..0000000 --- a/src/Models/Builders/CardResponseBuilder.php +++ /dev/null @@ -1,142 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new card response Builder object. - */ - public static function init(): self - { - return new self(new CardResponse()); - } - - /** - * 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 available networks field. - */ - public function availableNetworks(?array $value): self - { - $this->instance->setAvailableNetworks($value); - return $this; - } - - /** - * Sets type field. - */ - public function type(?string $value): self - { - $this->instance->setType($value); - return $this; - } - - /** - * Sets authentication result field. - */ - public function authenticationResult(?AuthenticationResponse $value): self - { - $this->instance->setAuthenticationResult($value); - return $this; - } - - /** - * Sets attributes field. - */ - public function attributes(?CardAttributesResponse $value): self - { - $this->instance->setAttributes($value); - return $this; - } - - /** - * Sets from request field. - */ - public function fromRequest(?CardFromRequest $value): self - { - $this->instance->setFromRequest($value); - return $this; - } - - /** - * Sets expiry field. - */ - public function expiry(?string $value): self - { - $this->instance->setExpiry($value); - return $this; - } - - /** - * Sets bin details field. - */ - public function binDetails(?BinDetails $value): self - { - $this->instance->setBinDetails($value); - return $this; - } - - /** - * Initializes a new card response object. - */ - public function build(): CardResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/CardResponseEntityBuilder.php b/src/Models/Builders/CardResponseEntityBuilder.php deleted file mode 100644 index c68eb96..0000000 --- a/src/Models/Builders/CardResponseEntityBuilder.php +++ /dev/null @@ -1,152 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new card response entity Builder object. - */ - public static function init(): self - { - return new self(new CardResponseEntity()); - } - - /** - * 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(?AuthenticationResponse $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; - } - - /** - * Initializes a new card response entity object. - */ - public function build(): CardResponseEntity - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/CardStoredCredentialBuilder.php b/src/Models/Builders/CardStoredCredentialBuilder.php deleted file mode 100644 index 8b8458c..0000000 --- a/src/Models/Builders/CardStoredCredentialBuilder.php +++ /dev/null @@ -1,67 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new card stored credential Builder object. - */ - public static function init(string $paymentInitiator, string $paymentType): self - { - return new self(new CardStoredCredential($paymentInitiator, $paymentType)); - } - - /** - * Sets usage field. - */ - public function usage(?string $value): self - { - $this->instance->setUsage($value); - return $this; - } - - /** - * Sets previous network transaction reference field. - */ - public function previousNetworkTransactionReference(?NetworkTransactionReference $value): self - { - $this->instance->setPreviousNetworkTransactionReference($value); - return $this; - } - - /** - * Initializes a new card stored credential object. - */ - public function build(): CardStoredCredential - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/CardSupplementaryDataBuilder.php b/src/Models/Builders/CardSupplementaryDataBuilder.php deleted file mode 100644 index 725afe3..0000000 --- a/src/Models/Builders/CardSupplementaryDataBuilder.php +++ /dev/null @@ -1,68 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new card supplementary data Builder object. - */ - public static function init(): self - { - return new self(new CardSupplementaryData()); - } - - /** - * Sets level 2 field. - */ - public function level2(?Level2CardProcessingData $value): self - { - $this->instance->setLevel2($value); - return $this; - } - - /** - * Sets level 3 field. - */ - public function level3(?Level3CardProcessingData $value): self - { - $this->instance->setLevel3($value); - return $this; - } - - /** - * Initializes a new card supplementary data object. - */ - public function build(): CardSupplementaryData - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/CardVerificationBuilder.php b/src/Models/Builders/CardVerificationBuilder.php deleted file mode 100644 index 8a439fd..0000000 --- a/src/Models/Builders/CardVerificationBuilder.php +++ /dev/null @@ -1,57 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new card verification Builder object. - */ - public static function init(): self - { - return new self(new CardVerification()); - } - - /** - * Sets method field. - */ - public function method(?string $value): self - { - $this->instance->setMethod($value); - return $this; - } - - /** - * Initializes a new card verification object. - */ - public function build(): CardVerification - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/CardVerificationDetailsBuilder.php b/src/Models/Builders/CardVerificationDetailsBuilder.php deleted file mode 100644 index 7b406b7..0000000 --- a/src/Models/Builders/CardVerificationDetailsBuilder.php +++ /dev/null @@ -1,104 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new card verification details Builder object. - */ - public static function init(): self - { - return new self(new CardVerificationDetails()); - } - - /** - * Sets network transaction id field. - */ - public function networkTransactionId(?string $value): self - { - $this->instance->setNetworkTransactionId($value); - return $this; - } - - /** - * Sets date field. - */ - public function date(?string $value): self - { - $this->instance->setDate($value); - return $this; - } - - /** - * Sets network field. - */ - public function network(?string $value): self - { - $this->instance->setNetwork($value); - return $this; - } - - /** - * Sets time field. - */ - public function time(?string $value): self - { - $this->instance->setTime($value); - return $this; - } - - /** - * Sets amount field. - */ - public function amount(?Money $value): self - { - $this->instance->setAmount($value); - return $this; - } - - /** - * Sets processor response field. - */ - public function processorResponse(?CardVerificationProcessorResponse $value): self - { - $this->instance->setProcessorResponse($value); - return $this; - } - - /** - * Initializes a new card verification details object. - */ - public function build(): CardVerificationDetails - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/CardVerificationProcessorResponseBuilder.php b/src/Models/Builders/CardVerificationProcessorResponseBuilder.php deleted file mode 100644 index d98ce68..0000000 --- a/src/Models/Builders/CardVerificationProcessorResponseBuilder.php +++ /dev/null @@ -1,66 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new card verification processor response Builder object. - */ - public static function init(): self - { - return new self(new CardVerificationProcessorResponse()); - } - - /** - * Sets avs code field. - */ - public function avsCode(?string $value): self - { - $this->instance->setAvsCode($value); - return $this; - } - - /** - * Sets cvv code field. - */ - public function cvvCode(?string $value): self - { - $this->instance->setCvvCode($value); - return $this; - } - - /** - * Initializes a new card verification processor response object. - */ - public function build(): CardVerificationProcessorResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/CobrandedCardBuilder.php b/src/Models/Builders/CobrandedCardBuilder.php deleted file mode 100644 index e5fc1b3..0000000 --- a/src/Models/Builders/CobrandedCardBuilder.php +++ /dev/null @@ -1,77 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new cobranded card Builder object. - */ - public static function init(): self - { - return new self(new CobrandedCard()); - } - - /** - * Sets labels field. - */ - public function labels(?array $value): self - { - $this->instance->setLabels($value); - return $this; - } - - /** - * Sets payee field. - */ - public function payee(?PayeeBase $value): self - { - $this->instance->setPayee($value); - return $this; - } - - /** - * Sets amount field. - */ - public function amount(?Money $value): self - { - $this->instance->setAmount($value); - return $this; - } - - /** - * Initializes a new cobranded card object. - */ - public function build(): CobrandedCard - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/ConfirmOrderRequestBuilder.php b/src/Models/Builders/ConfirmOrderRequestBuilder.php deleted file mode 100644 index ff9724e..0000000 --- a/src/Models/Builders/ConfirmOrderRequestBuilder.php +++ /dev/null @@ -1,68 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new confirm order request Builder object. - */ - public static function init(PaymentSource $paymentSource): self - { - return new self(new ConfirmOrderRequest($paymentSource)); - } - - /** - * Sets processing instruction field. - */ - public function processingInstruction(?string $value): self - { - $this->instance->setProcessingInstruction($value); - return $this; - } - - /** - * Sets application context field. - */ - public function applicationContext(?OrderConfirmApplicationContext $value): self - { - $this->instance->setApplicationContext($value); - return $this; - } - - /** - * Initializes a new confirm order request object. - */ - public function build(): ConfirmOrderRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/CustomerInformationBuilder.php b/src/Models/Builders/CustomerInformationBuilder.php deleted file mode 100644 index 3b40c49..0000000 --- a/src/Models/Builders/CustomerInformationBuilder.php +++ /dev/null @@ -1,76 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new customer information Builder object. - */ - public static function init(): self - { - return new self(new CustomerInformation()); - } - - /** - * Sets id field. - */ - public function id(?string $value): self - { - $this->instance->setId($value); - return $this; - } - - /** - * Sets email address field. - */ - public function emailAddress(?string $value): self - { - $this->instance->setEmailAddress($value); - return $this; - } - - /** - * Sets phone field. - */ - public function phone(?PhoneWithType $value): self - { - $this->instance->setPhone($value); - return $this; - } - - /** - * Initializes a new customer information object. - */ - public function build(): CustomerInformation - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/CustomerRequestBuilder.php b/src/Models/Builders/CustomerRequestBuilder.php deleted file mode 100644 index c67d160..0000000 --- a/src/Models/Builders/CustomerRequestBuilder.php +++ /dev/null @@ -1,66 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new customer request Builder object. - */ - public static function init(): self - { - return new self(new CustomerRequest()); - } - - /** - * Sets id field. - */ - public function id(?string $value): self - { - $this->instance->setId($value); - return $this; - } - - /** - * Sets merchant customer id field. - */ - public function merchantCustomerId(?string $value): self - { - $this->instance->setMerchantCustomerId($value); - return $this; - } - - /** - * Initializes a new customer request object. - */ - public function build(): CustomerRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/CustomerVaultPaymentTokensResponseBuilder.php b/src/Models/Builders/CustomerVaultPaymentTokensResponseBuilder.php deleted file mode 100644 index 5a7018f..0000000 --- a/src/Models/Builders/CustomerVaultPaymentTokensResponseBuilder.php +++ /dev/null @@ -1,94 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new customer vault payment tokens response Builder object. - */ - public static function init(): self - { - return new self(new CustomerVaultPaymentTokensResponse()); - } - - /** - * Sets total items field. - */ - public function totalItems(?int $value): self - { - $this->instance->setTotalItems($value); - return $this; - } - - /** - * Sets total pages field. - */ - public function totalPages(?int $value): self - { - $this->instance->setTotalPages($value); - return $this; - } - - /** - * Sets customer field. - */ - public function customer(?CustomerRequest $value): self - { - $this->instance->setCustomer($value); - return $this; - } - - /** - * Sets payment tokens field. - */ - public function paymentTokens(?array $value): self - { - $this->instance->setPaymentTokens($value); - return $this; - } - - /** - * Sets links field. - */ - public function links(?array $value): self - { - $this->instance->setLinks($value); - return $this; - } - - /** - * Initializes a new customer vault payment tokens response object. - */ - public function build(): CustomerVaultPaymentTokensResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/EPSPaymentObjectBuilder.php b/src/Models/Builders/EPSPaymentObjectBuilder.php deleted file mode 100644 index 5c9571c..0000000 --- a/src/Models/Builders/EPSPaymentObjectBuilder.php +++ /dev/null @@ -1,75 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new epspayment object Builder object. - */ - public static function init(): self - { - return new self(new EPSPaymentObject()); - } - - /** - * Sets name field. - */ - public function name(?string $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets country code field. - */ - public function countryCode(?string $value): self - { - $this->instance->setCountryCode($value); - return $this; - } - - /** - * Sets bic field. - */ - public function bic(?string $value): self - { - $this->instance->setBic($value); - return $this; - } - - /** - * Initializes a new epspayment object object. - */ - public function build(): EPSPaymentObject - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/EPSPaymentRequestBuilder.php b/src/Models/Builders/EPSPaymentRequestBuilder.php deleted file mode 100644 index 7ee2148..0000000 --- a/src/Models/Builders/EPSPaymentRequestBuilder.php +++ /dev/null @@ -1,58 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new epspayment request Builder object. - */ - public static function init(string $name, string $countryCode): self - { - return new self(new EPSPaymentRequest($name, $countryCode)); - } - - /** - * Sets experience context field. - */ - public function experienceContext(?ExperienceContext $value): self - { - $this->instance->setExperienceContext($value); - return $this; - } - - /** - * Initializes a new epspayment request object. - */ - public function build(): EPSPaymentRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/ErrorDetailsBuilder.php b/src/Models/Builders/ErrorDetailsBuilder.php deleted file mode 100644 index 8f94aa0..0000000 --- a/src/Models/Builders/ErrorDetailsBuilder.php +++ /dev/null @@ -1,93 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new error details Builder object. - */ - public static function init(string $issue): self - { - return new self(new ErrorDetails($issue)); - } - - /** - * Sets field field. - */ - public function field(?string $value): self - { - $this->instance->setField($value); - return $this; - } - - /** - * Sets value field. - */ - public function value(?string $value): self - { - $this->instance->setValue($value); - return $this; - } - - /** - * Sets location field. - */ - public function location(?string $value): self - { - $this->instance->setLocation($value); - return $this; - } - - /** - * Sets links field. - */ - public function links(?array $value): self - { - $this->instance->setLinks($value); - return $this; - } - - /** - * Sets description field. - */ - public function description(?string $value): self - { - $this->instance->setDescription($value); - return $this; - } - - /** - * Initializes a new error details object. - */ - public function build(): ErrorDetails - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/ExchangeRateBuilder.php b/src/Models/Builders/ExchangeRateBuilder.php deleted file mode 100644 index 98222b9..0000000 --- a/src/Models/Builders/ExchangeRateBuilder.php +++ /dev/null @@ -1,75 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new exchange rate Builder object. - */ - public static function init(): self - { - return new self(new ExchangeRate()); - } - - /** - * Sets source currency field. - */ - public function sourceCurrency(?string $value): self - { - $this->instance->setSourceCurrency($value); - return $this; - } - - /** - * Sets target currency field. - */ - public function targetCurrency(?string $value): self - { - $this->instance->setTargetCurrency($value); - return $this; - } - - /** - * Sets value field. - */ - public function value(?string $value): self - { - $this->instance->setValue($value); - return $this; - } - - /** - * Initializes a new exchange rate object. - */ - public function build(): ExchangeRate - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/ExperienceContextBuilder.php b/src/Models/Builders/ExperienceContextBuilder.php deleted file mode 100644 index c67fe88..0000000 --- a/src/Models/Builders/ExperienceContextBuilder.php +++ /dev/null @@ -1,93 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new experience context Builder object. - */ - public static function init(): self - { - return new self(new ExperienceContext()); - } - - /** - * Sets brand name field. - */ - public function brandName(?string $value): self - { - $this->instance->setBrandName($value); - return $this; - } - - /** - * Sets locale field. - */ - public function locale(?string $value): self - { - $this->instance->setLocale($value); - return $this; - } - - /** - * Sets shipping preference field. - */ - public function shippingPreference(?string $value): self - { - $this->instance->setShippingPreference($value); - return $this; - } - - /** - * Sets return url field. - */ - public function returnUrl(?string $value): self - { - $this->instance->setReturnUrl($value); - return $this; - } - - /** - * Sets cancel url field. - */ - public function cancelUrl(?string $value): self - { - $this->instance->setCancelUrl($value); - return $this; - } - - /** - * Initializes a new experience context object. - */ - public function build(): ExperienceContext - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/GiropayPaymentObjectBuilder.php b/src/Models/Builders/GiropayPaymentObjectBuilder.php deleted file mode 100644 index 38c2a43..0000000 --- a/src/Models/Builders/GiropayPaymentObjectBuilder.php +++ /dev/null @@ -1,75 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new giropay payment object Builder object. - */ - public static function init(): self - { - return new self(new GiropayPaymentObject()); - } - - /** - * Sets name field. - */ - public function name(?string $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets country code field. - */ - public function countryCode(?string $value): self - { - $this->instance->setCountryCode($value); - return $this; - } - - /** - * Sets bic field. - */ - public function bic(?string $value): self - { - $this->instance->setBic($value); - return $this; - } - - /** - * Initializes a new giropay payment object object. - */ - public function build(): GiropayPaymentObject - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/GiropayPaymentRequestBuilder.php b/src/Models/Builders/GiropayPaymentRequestBuilder.php deleted file mode 100644 index bccbd09..0000000 --- a/src/Models/Builders/GiropayPaymentRequestBuilder.php +++ /dev/null @@ -1,58 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new giropay payment request Builder object. - */ - public static function init(string $name, string $countryCode): self - { - return new self(new GiropayPaymentRequest($name, $countryCode)); - } - - /** - * Sets experience context field. - */ - public function experienceContext(?ExperienceContext $value): self - { - $this->instance->setExperienceContext($value); - return $this; - } - - /** - * Initializes a new giropay payment request object. - */ - public function build(): GiropayPaymentRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/GooglePayCardAttributesBuilder.php b/src/Models/Builders/GooglePayCardAttributesBuilder.php deleted file mode 100644 index c32aef6..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/GooglePayCardResponseBuilder.php b/src/Models/Builders/GooglePayCardResponseBuilder.php deleted file mode 100644 index f3f58fe..0000000 --- a/src/Models/Builders/GooglePayCardResponseBuilder.php +++ /dev/null @@ -1,104 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new google pay card response Builder object. - */ - public static function init(): self - { - return new self(new GooglePayCardResponse()); - } - - /** - * 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 type field. - */ - public function type(?string $value): self - { - $this->instance->setType($value); - return $this; - } - - /** - * Sets brand field. - */ - public function brand(?string $value): self - { - $this->instance->setBrand($value); - return $this; - } - - /** - * Sets billing address field. - */ - public function billingAddress(?Address $value): self - { - $this->instance->setBillingAddress($value); - return $this; - } - - /** - * Sets authentication result field. - */ - public function authenticationResult(?AuthenticationResponse $value): self - { - $this->instance->setAuthenticationResult($value); - return $this; - } - - /** - * Initializes a new google pay card response object. - */ - public function build(): GooglePayCardResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/GooglePayDecryptedTokenDataBuilder.php b/src/Models/Builders/GooglePayDecryptedTokenDataBuilder.php deleted file mode 100644 index 0dd9e21..0000000 --- a/src/Models/Builders/GooglePayDecryptedTokenDataBuilder.php +++ /dev/null @@ -1,84 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new google pay decrypted token data Builder object. - */ - public static function init(string $paymentMethod, string $authenticationMethod): self - { - return new self(new GooglePayDecryptedTokenData($paymentMethod, $authenticationMethod)); - } - - /** - * Sets message id field. - */ - public function messageId(?string $value): self - { - $this->instance->setMessageId($value); - return $this; - } - - /** - * Sets message expiration field. - */ - public function messageExpiration(?string $value): self - { - $this->instance->setMessageExpiration($value); - return $this; - } - - /** - * Sets cryptogram field. - */ - public function cryptogram(?string $value): self - { - $this->instance->setCryptogram($value); - return $this; - } - - /** - * Sets eci indicator field. - */ - public function eciIndicator(?string $value): self - { - $this->instance->setEciIndicator($value); - return $this; - } - - /** - * Initializes a new google pay decrypted token data object. - */ - public function build(): GooglePayDecryptedTokenData - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/GooglePayRequestBuilder.php b/src/Models/Builders/GooglePayRequestBuilder.php deleted file mode 100644 index ed3a8e5..0000000 --- a/src/Models/Builders/GooglePayRequestBuilder.php +++ /dev/null @@ -1,114 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new google pay request Builder object. - */ - public static function init(): self - { - return new self(new GooglePayRequest()); - } - - /** - * Sets name field. - */ - public function name(?string $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets email address field. - */ - public function emailAddress(?string $value): self - { - $this->instance->setEmailAddress($value); - return $this; - } - - /** - * Sets phone number field. - */ - public function phoneNumber(?PhoneNumberWithCountryCode $value): self - { - $this->instance->setPhoneNumber($value); - return $this; - } - - /** - * Sets card field. - */ - public function card($value): self - { - $this->instance->setCard($value); - return $this; - } - - /** - * Sets decrypted token field. - */ - public function decryptedToken(?GooglePayDecryptedTokenData $value): self - { - $this->instance->setDecryptedToken($value); - return $this; - } - - /** - * Sets assurance details field. - */ - public function assuranceDetails($value): self - { - $this->instance->setAssuranceDetails($value); - return $this; - } - - /** - * Sets attributes field. - */ - public function attributes(?GooglePayCardAttributes $value): self - { - $this->instance->setAttributes($value); - return $this; - } - - /** - * Initializes a new google pay request object. - */ - public function build(): GooglePayRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/GooglePayWalletResponseBuilder.php b/src/Models/Builders/GooglePayWalletResponseBuilder.php deleted file mode 100644 index 8a0866c..0000000 --- a/src/Models/Builders/GooglePayWalletResponseBuilder.php +++ /dev/null @@ -1,86 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new google pay wallet response Builder object. - */ - public static function init(): self - { - return new self(new GooglePayWalletResponse()); - } - - /** - * Sets name field. - */ - public function name(?string $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets email address field. - */ - public function emailAddress(?string $value): self - { - $this->instance->setEmailAddress($value); - return $this; - } - - /** - * Sets phone number field. - */ - public function phoneNumber(?PhoneNumberWithCountryCode $value): self - { - $this->instance->setPhoneNumber($value); - return $this; - } - - /** - * Sets card field. - */ - public function card(?GooglePayCardResponse $value): self - { - $this->instance->setCard($value); - return $this; - } - - /** - * Initializes a new google pay wallet response object. - */ - public function build(): GooglePayWalletResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/IDEALPaymentObjectBuilder.php b/src/Models/Builders/IDEALPaymentObjectBuilder.php deleted file mode 100644 index 245068b..0000000 --- a/src/Models/Builders/IDEALPaymentObjectBuilder.php +++ /dev/null @@ -1,84 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new idealpayment object Builder object. - */ - public static function init(): self - { - return new self(new IDEALPaymentObject()); - } - - /** - * Sets name field. - */ - public function name(?string $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets country code field. - */ - public function countryCode(?string $value): self - { - $this->instance->setCountryCode($value); - return $this; - } - - /** - * Sets bic field. - */ - public function bic(?string $value): self - { - $this->instance->setBic($value); - return $this; - } - - /** - * Sets iban last chars field. - */ - public function ibanLastChars(?string $value): self - { - $this->instance->setIbanLastChars($value); - return $this; - } - - /** - * Initializes a new idealpayment object object. - */ - public function build(): IDEALPaymentObject - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/IDEALPaymentRequestBuilder.php b/src/Models/Builders/IDEALPaymentRequestBuilder.php deleted file mode 100644 index 587d459..0000000 --- a/src/Models/Builders/IDEALPaymentRequestBuilder.php +++ /dev/null @@ -1,67 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new idealpayment request Builder object. - */ - public static function init(string $name, string $countryCode): self - { - return new self(new IDEALPaymentRequest($name, $countryCode)); - } - - /** - * Sets bic field. - */ - public function bic(?string $value): self - { - $this->instance->setBic($value); - return $this; - } - - /** - * Sets experience context field. - */ - public function experienceContext(?ExperienceContext $value): self - { - $this->instance->setExperienceContext($value); - return $this; - } - - /** - * Initializes a new idealpayment request object. - */ - public function build(): IDEALPaymentRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/ItemBuilder.php b/src/Models/Builders/ItemBuilder.php deleted file mode 100644 index 3140400..0000000 --- a/src/Models/Builders/ItemBuilder.php +++ /dev/null @@ -1,113 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new item Builder object. - */ - public static function init(string $name, Money $unitAmount, string $quantity): self - { - return new self(new Item($name, $unitAmount, $quantity)); - } - - /** - * Sets tax field. - */ - public function tax(?Money $value): self - { - $this->instance->setTax($value); - return $this; - } - - /** - * Sets description field. - */ - public function description(?string $value): self - { - $this->instance->setDescription($value); - return $this; - } - - /** - * Sets sku field. - */ - public function sku(?string $value): self - { - $this->instance->setSku($value); - return $this; - } - - /** - * Sets url field. - */ - public function url(?string $value): self - { - $this->instance->setUrl($value); - return $this; - } - - /** - * Sets category field. - */ - public function category(?string $value): self - { - $this->instance->setCategory($value); - return $this; - } - - /** - * Sets image url field. - */ - public function imageUrl(?string $value): self - { - $this->instance->setImageUrl($value); - return $this; - } - - /** - * Sets upc field. - */ - public function upc(?UniversalProductCode $value): self - { - $this->instance->setUpc($value); - return $this; - } - - /** - * Initializes a new item object. - */ - public function build(): Item - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/Level2CardProcessingDataBuilder.php b/src/Models/Builders/Level2CardProcessingDataBuilder.php deleted file mode 100644 index 1ee6244..0000000 --- a/src/Models/Builders/Level2CardProcessingDataBuilder.php +++ /dev/null @@ -1,67 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new level 2 card processing data Builder object. - */ - public static function init(): self - { - return new self(new Level2CardProcessingData()); - } - - /** - * Sets invoice id field. - */ - public function invoiceId(?string $value): self - { - $this->instance->setInvoiceId($value); - return $this; - } - - /** - * Sets tax total field. - */ - public function taxTotal(?Money $value): self - { - $this->instance->setTaxTotal($value); - return $this; - } - - /** - * Initializes a new level 2 card processing data object. - */ - public function build(): Level2CardProcessingData - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/Level3CardProcessingDataBuilder.php b/src/Models/Builders/Level3CardProcessingDataBuilder.php deleted file mode 100644 index 73ed963..0000000 --- a/src/Models/Builders/Level3CardProcessingDataBuilder.php +++ /dev/null @@ -1,104 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new level 3 card processing data Builder object. - */ - public static function init(): self - { - return new self(new Level3CardProcessingData()); - } - - /** - * Sets shipping amount field. - */ - public function shippingAmount(?Money $value): self - { - $this->instance->setShippingAmount($value); - return $this; - } - - /** - * Sets duty amount field. - */ - public function dutyAmount(?Money $value): self - { - $this->instance->setDutyAmount($value); - return $this; - } - - /** - * Sets discount amount field. - */ - public function discountAmount(?Money $value): self - { - $this->instance->setDiscountAmount($value); - return $this; - } - - /** - * Sets shipping address field. - */ - public function shippingAddress(?Address $value): self - { - $this->instance->setShippingAddress($value); - return $this; - } - - /** - * Sets ships from postal code field. - */ - public function shipsFromPostalCode(?string $value): self - { - $this->instance->setShipsFromPostalCode($value); - return $this; - } - - /** - * Sets line items field. - */ - public function lineItems(?array $value): self - { - $this->instance->setLineItems($value); - return $this; - } - - /** - * Initializes a new level 3 card processing data object. - */ - public function build(): Level3CardProcessingData - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/LineItemBuilder.php b/src/Models/Builders/LineItemBuilder.php deleted file mode 100644 index f78abf1..0000000 --- a/src/Models/Builders/LineItemBuilder.php +++ /dev/null @@ -1,140 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new line item Builder object. - */ - public static function init(string $name, Money $unitAmount, string $quantity): self - { - return new self(new LineItem($name, $unitAmount, $quantity)); - } - - /** - * Sets tax field. - */ - public function tax(?Money $value): self - { - $this->instance->setTax($value); - return $this; - } - - /** - * Sets description field. - */ - public function description(?string $value): self - { - $this->instance->setDescription($value); - return $this; - } - - /** - * Sets sku field. - */ - public function sku(?string $value): self - { - $this->instance->setSku($value); - return $this; - } - - /** - * Sets url field. - */ - public function url(?string $value): self - { - $this->instance->setUrl($value); - return $this; - } - - /** - * Sets image url field. - */ - public function imageUrl(?string $value): self - { - $this->instance->setImageUrl($value); - return $this; - } - - /** - * Sets upc field. - */ - public function upc(?UniversalProductCode $value): self - { - $this->instance->setUpc($value); - return $this; - } - - /** - * Sets commodity code field. - */ - public function commodityCode(?string $value): self - { - $this->instance->setCommodityCode($value); - return $this; - } - - /** - * Sets discount amount field. - */ - public function discountAmount(?Money $value): self - { - $this->instance->setDiscountAmount($value); - return $this; - } - - /** - * Sets total amount field. - */ - public function totalAmount(?Money $value): self - { - $this->instance->setTotalAmount($value); - return $this; - } - - /** - * Sets unit of measure field. - */ - public function unitOfMeasure(?string $value): self - { - $this->instance->setUnitOfMeasure($value); - return $this; - } - - /** - * Initializes a new line item object. - */ - public function build(): LineItem - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/LinkDescriptionBuilder.php b/src/Models/Builders/LinkDescriptionBuilder.php deleted file mode 100644 index 7cdb17f..0000000 --- a/src/Models/Builders/LinkDescriptionBuilder.php +++ /dev/null @@ -1,57 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new link description Builder object. - */ - public static function init(string $href, string $rel): self - { - return new self(new LinkDescription($href, $rel)); - } - - /** - * Sets method field. - */ - public function method(?string $value): self - { - $this->instance->setMethod($value); - return $this; - } - - /** - * Initializes a new link description object. - */ - public function build(): LinkDescription - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/MoneyBuilder.php b/src/Models/Builders/MoneyBuilder.php deleted file mode 100644 index 4c0c243..0000000 --- a/src/Models/Builders/MoneyBuilder.php +++ /dev/null @@ -1,48 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new money Builder object. - */ - public static function init(string $currencyCode, string $value): self - { - return new self(new Money($currencyCode, $value)); - } - - /** - * Initializes a new money object. - */ - public function build(): Money - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/MyBankPaymentObjectBuilder.php b/src/Models/Builders/MyBankPaymentObjectBuilder.php deleted file mode 100644 index 98eae64..0000000 --- a/src/Models/Builders/MyBankPaymentObjectBuilder.php +++ /dev/null @@ -1,84 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new my bank payment object Builder object. - */ - public static function init(): self - { - return new self(new MyBankPaymentObject()); - } - - /** - * Sets name field. - */ - public function name(?string $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets country code field. - */ - public function countryCode(?string $value): self - { - $this->instance->setCountryCode($value); - return $this; - } - - /** - * Sets bic field. - */ - public function bic(?string $value): self - { - $this->instance->setBic($value); - return $this; - } - - /** - * Sets iban last chars field. - */ - public function ibanLastChars(?string $value): self - { - $this->instance->setIbanLastChars($value); - return $this; - } - - /** - * Initializes a new my bank payment object object. - */ - public function build(): MyBankPaymentObject - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/MyBankPaymentRequestBuilder.php b/src/Models/Builders/MyBankPaymentRequestBuilder.php deleted file mode 100644 index 1f68993..0000000 --- a/src/Models/Builders/MyBankPaymentRequestBuilder.php +++ /dev/null @@ -1,58 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new my bank payment request Builder object. - */ - public static function init(string $name, string $countryCode): self - { - return new self(new MyBankPaymentRequest($name, $countryCode)); - } - - /** - * Sets experience context field. - */ - public function experienceContext(?ExperienceContext $value): self - { - $this->instance->setExperienceContext($value); - return $this; - } - - /** - * Initializes a new my bank payment request object. - */ - public function build(): MyBankPaymentRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/NameBuilder.php b/src/Models/Builders/NameBuilder.php deleted file mode 100644 index e9c7f89..0000000 --- a/src/Models/Builders/NameBuilder.php +++ /dev/null @@ -1,66 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new name Builder object. - */ - public static function init(): self - { - return new self(new Name()); - } - - /** - * Sets given name field. - */ - public function givenName(?string $value): self - { - $this->instance->setGivenName($value); - return $this; - } - - /** - * Sets surname field. - */ - public function surname(?string $value): self - { - $this->instance->setSurname($value); - return $this; - } - - /** - * Initializes a new name object. - */ - public function build(): Name - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/NetAmountBreakdownItemBuilder.php b/src/Models/Builders/NetAmountBreakdownItemBuilder.php deleted file mode 100644 index 596aa2c..0000000 --- a/src/Models/Builders/NetAmountBreakdownItemBuilder.php +++ /dev/null @@ -1,77 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new net amount breakdown item Builder object. - */ - public static function init(): self - { - return new self(new NetAmountBreakdownItem()); - } - - /** - * Sets payable amount field. - */ - public function payableAmount(?Money $value): self - { - $this->instance->setPayableAmount($value); - return $this; - } - - /** - * Sets converted amount field. - */ - public function convertedAmount(?Money $value): self - { - $this->instance->setConvertedAmount($value); - return $this; - } - - /** - * Sets exchange rate field. - */ - public function exchangeRate(?ExchangeRate $value): self - { - $this->instance->setExchangeRate($value); - return $this; - } - - /** - * Initializes a new net amount breakdown item object. - */ - public function build(): NetAmountBreakdownItem - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/NetworkTokenBuilder.php b/src/Models/Builders/NetworkTokenBuilder.php deleted file mode 100644 index a79a457..0000000 --- a/src/Models/Builders/NetworkTokenBuilder.php +++ /dev/null @@ -1,75 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new network token Builder object. - */ - public static function init(string $number, string $expiry): self - { - return new self(new NetworkToken($number, $expiry)); - } - - /** - * Sets cryptogram field. - */ - public function cryptogram(?string $value): self - { - $this->instance->setCryptogram($value); - return $this; - } - - /** - * Sets eci flag field. - */ - public function eciFlag(?string $value): self - { - $this->instance->setEciFlag($value); - return $this; - } - - /** - * Sets token requestor id field. - */ - public function tokenRequestorId(?string $value): self - { - $this->instance->setTokenRequestorId($value); - return $this; - } - - /** - * Initializes a new network token object. - */ - public function build(): NetworkToken - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/NetworkTransactionReferenceBuilder.php b/src/Models/Builders/NetworkTransactionReferenceBuilder.php deleted file mode 100644 index b1eb601..0000000 --- a/src/Models/Builders/NetworkTransactionReferenceBuilder.php +++ /dev/null @@ -1,75 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new network transaction reference Builder object. - */ - public static function init(string $id): self - { - return new self(new NetworkTransactionReference($id)); - } - - /** - * Sets date field. - */ - public function date(?string $value): self - { - $this->instance->setDate($value); - return $this; - } - - /** - * Sets network field. - */ - public function network(?string $value): self - { - $this->instance->setNetwork($value); - return $this; - } - - /** - * Sets acquirer reference number field. - */ - public function acquirerReferenceNumber(?string $value): self - { - $this->instance->setAcquirerReferenceNumber($value); - return $this; - } - - /** - * Initializes a new network transaction reference object. - */ - public function build(): NetworkTransactionReference - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/NetworkTransactionReferenceEntityBuilder.php b/src/Models/Builders/NetworkTransactionReferenceEntityBuilder.php deleted file mode 100644 index 610fd0c..0000000 --- a/src/Models/Builders/NetworkTransactionReferenceEntityBuilder.php +++ /dev/null @@ -1,75 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new network transaction reference entity Builder object. - */ - public static function init(string $id): self - { - return new self(new NetworkTransactionReferenceEntity($id)); - } - - /** - * Sets date field. - */ - public function date(?string $value): self - { - $this->instance->setDate($value); - return $this; - } - - /** - * Sets network field. - */ - public function network(?string $value): self - { - $this->instance->setNetwork($value); - return $this; - } - - /** - * Sets time field. - */ - public function time(?string $value): self - { - $this->instance->setTime($value); - return $this; - } - - /** - * Initializes a new network transaction reference entity object. - */ - public function build(): NetworkTransactionReferenceEntity - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/OAuthTokenBuilder.php b/src/Models/Builders/OAuthTokenBuilder.php deleted file mode 100644 index cca5ad4..0000000 --- a/src/Models/Builders/OAuthTokenBuilder.php +++ /dev/null @@ -1,93 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new oauth token Builder object. - */ - public static function init(string $accessToken, string $tokenType): self - { - return new self(new OAuthToken($accessToken, $tokenType)); - } - - /** - * Sets expires in field. - */ - public function expiresIn(?int $value): self - { - $this->instance->setExpiresIn($value); - return $this; - } - - /** - * Sets scope field. - */ - public function scope(?string $value): self - { - $this->instance->setScope($value); - return $this; - } - - /** - * Sets expiry field. - */ - public function expiry(?int $value): self - { - $this->instance->setExpiry($value); - return $this; - } - - /** - * Sets refresh token field. - */ - public function refreshToken(?string $value): self - { - $this->instance->setRefreshToken($value); - return $this; - } - - /** - * Sets id token field. - */ - public function idToken(?string $value): self - { - $this->instance->setIdToken($value); - return $this; - } - - /** - * Initializes a new oauth token object. - */ - public function build(): OAuthToken - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/OrderApplicationContextBuilder.php b/src/Models/Builders/OrderApplicationContextBuilder.php deleted file mode 100644 index d52a5a0..0000000 --- a/src/Models/Builders/OrderApplicationContextBuilder.php +++ /dev/null @@ -1,131 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new order application context Builder object. - */ - public static function init(): self - { - return new self(new OrderApplicationContext()); - } - - /** - * Sets brand name field. - */ - public function brandName(?string $value): self - { - $this->instance->setBrandName($value); - return $this; - } - - /** - * Sets locale field. - */ - public function locale(?string $value): self - { - $this->instance->setLocale($value); - return $this; - } - - /** - * Sets landing page field. - */ - public function landingPage(?string $value): self - { - $this->instance->setLandingPage($value); - return $this; - } - - /** - * Sets shipping preference field. - */ - public function shippingPreference(?string $value): self - { - $this->instance->setShippingPreference($value); - return $this; - } - - /** - * Sets user action field. - */ - public function userAction(?string $value): self - { - $this->instance->setUserAction($value); - return $this; - } - - /** - * Sets payment method field. - */ - public function paymentMethod(?PaymentMethodPreference $value): self - { - $this->instance->setPaymentMethod($value); - return $this; - } - - /** - * Sets return url field. - */ - public function returnUrl(?string $value): self - { - $this->instance->setReturnUrl($value); - return $this; - } - - /** - * Sets cancel url field. - */ - public function cancelUrl(?string $value): self - { - $this->instance->setCancelUrl($value); - return $this; - } - - /** - * Sets stored payment source field. - */ - public function storedPaymentSource(?StoredPaymentSource $value): self - { - $this->instance->setStoredPaymentSource($value); - return $this; - } - - /** - * Initializes a new order application context object. - */ - public function build(): OrderApplicationContext - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/OrderAuthorizeRequestBuilder.php b/src/Models/Builders/OrderAuthorizeRequestBuilder.php deleted file mode 100644 index aa62a0e..0000000 --- a/src/Models/Builders/OrderAuthorizeRequestBuilder.php +++ /dev/null @@ -1,58 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new order authorize request Builder object. - */ - public static function init(): self - { - return new self(new OrderAuthorizeRequest()); - } - - /** - * Sets payment source field. - */ - public function paymentSource(?OrderAuthorizeRequestPaymentSource $value): self - { - $this->instance->setPaymentSource($value); - return $this; - } - - /** - * Initializes a new order authorize request object. - */ - public function build(): OrderAuthorizeRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/OrderAuthorizeRequestPaymentSourceBuilder.php b/src/Models/Builders/OrderAuthorizeRequestPaymentSourceBuilder.php deleted file mode 100644 index ef84597..0000000 --- a/src/Models/Builders/OrderAuthorizeRequestPaymentSourceBuilder.php +++ /dev/null @@ -1,108 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new order authorize request payment source Builder object. - */ - public static function init(): self - { - return new self(new OrderAuthorizeRequestPaymentSource()); - } - - /** - * Sets card field. - */ - public function card(?CardRequest $value): self - { - $this->instance->setCard($value); - return $this; - } - - /** - * Sets token field. - */ - public function token(?Token $value): self - { - $this->instance->setToken($value); - return $this; - } - - /** - * Sets paypal field. - */ - public function paypal(?PayPalWallet $value): self - { - $this->instance->setPaypal($value); - return $this; - } - - /** - * Sets apple pay field. - */ - public function applePay(?ApplePayRequest $value): self - { - $this->instance->setApplePay($value); - return $this; - } - - /** - * Sets google pay field. - */ - public function googlePay(?GooglePayRequest $value): self - { - $this->instance->setGooglePay($value); - return $this; - } - - /** - * Sets venmo field. - */ - public function venmo(?VenmoWalletRequest $value): self - { - $this->instance->setVenmo($value); - return $this; - } - - /** - * Initializes a new order authorize request payment source object. - */ - public function build(): OrderAuthorizeRequestPaymentSource - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/OrderAuthorizeResponseBuilder.php b/src/Models/Builders/OrderAuthorizeResponseBuilder.php deleted file mode 100644 index 57526d9..0000000 --- a/src/Models/Builders/OrderAuthorizeResponseBuilder.php +++ /dev/null @@ -1,140 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new order authorize response Builder object. - */ - public static function init(): self - { - return new self(new OrderAuthorizeResponse()); - } - - /** - * Sets create time field. - */ - public function createTime(?string $value): self - { - $this->instance->setCreateTime($value); - return $this; - } - - /** - * Sets update time field. - */ - public function updateTime(?string $value): self - { - $this->instance->setUpdateTime($value); - return $this; - } - - /** - * Sets id field. - */ - public function id(?string $value): self - { - $this->instance->setId($value); - return $this; - } - - /** - * Sets payment source field. - */ - public function paymentSource(?OrderAuthorizeResponsePaymentSource $value): self - { - $this->instance->setPaymentSource($value); - return $this; - } - - /** - * Sets intent field. - */ - public function intent(?string $value): self - { - $this->instance->setIntent($value); - return $this; - } - - /** - * Sets processing instruction field. - */ - public function processingInstruction(?string $value): self - { - $this->instance->setProcessingInstruction($value); - return $this; - } - - /** - * Sets payer field. - */ - public function payer(?Payer $value): self - { - $this->instance->setPayer($value); - return $this; - } - - /** - * Sets purchase units field. - */ - public function purchaseUnits(?array $value): self - { - $this->instance->setPurchaseUnits($value); - return $this; - } - - /** - * Sets status field. - */ - public function status(?string $value): self - { - $this->instance->setStatus($value); - return $this; - } - - /** - * Sets links field. - */ - public function links(?array $value): self - { - $this->instance->setLinks($value); - return $this; - } - - /** - * Initializes a new order authorize response object. - */ - public function build(): OrderAuthorizeResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/OrderAuthorizeResponsePaymentSourceBuilder.php b/src/Models/Builders/OrderAuthorizeResponsePaymentSourceBuilder.php deleted file mode 100644 index 4823609..0000000 --- a/src/Models/Builders/OrderAuthorizeResponsePaymentSourceBuilder.php +++ /dev/null @@ -1,98 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new order authorize response payment source Builder object. - */ - public static function init(): self - { - return new self(new OrderAuthorizeResponsePaymentSource()); - } - - /** - * Sets card field. - */ - public function card(?CardResponse $value): self - { - $this->instance->setCard($value); - return $this; - } - - /** - * Sets paypal field. - */ - public function paypal(?PayPalWalletResponse $value): self - { - $this->instance->setPaypal($value); - return $this; - } - - /** - * Sets apple pay field. - */ - public function applePay(?ApplePayPaymentObject $value): self - { - $this->instance->setApplePay($value); - return $this; - } - - /** - * Sets google pay field. - */ - public function googlePay(?GooglePayWalletResponse $value): self - { - $this->instance->setGooglePay($value); - return $this; - } - - /** - * Sets venmo field. - */ - public function venmo(?VenmoWalletResponse $value): self - { - $this->instance->setVenmo($value); - return $this; - } - - /** - * Initializes a new order authorize response payment source object. - */ - public function build(): OrderAuthorizeResponsePaymentSource - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/OrderBuilder.php b/src/Models/Builders/OrderBuilder.php deleted file mode 100644 index 68ba27b..0000000 --- a/src/Models/Builders/OrderBuilder.php +++ /dev/null @@ -1,140 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new order Builder object. - */ - public static function init(): self - { - return new self(new Order()); - } - - /** - * Sets create time field. - */ - public function createTime(?string $value): self - { - $this->instance->setCreateTime($value); - return $this; - } - - /** - * Sets update time field. - */ - public function updateTime(?string $value): self - { - $this->instance->setUpdateTime($value); - return $this; - } - - /** - * Sets id field. - */ - public function id(?string $value): self - { - $this->instance->setId($value); - return $this; - } - - /** - * Sets payment source field. - */ - public function paymentSource(?PaymentSourceResponse $value): self - { - $this->instance->setPaymentSource($value); - return $this; - } - - /** - * Sets intent field. - */ - public function intent(?string $value): self - { - $this->instance->setIntent($value); - return $this; - } - - /** - * Sets processing instruction field. - */ - public function processingInstruction(?string $value): self - { - $this->instance->setProcessingInstruction($value); - return $this; - } - - /** - * Sets payer field. - */ - public function payer(?Payer $value): self - { - $this->instance->setPayer($value); - return $this; - } - - /** - * Sets purchase units field. - */ - public function purchaseUnits(?array $value): self - { - $this->instance->setPurchaseUnits($value); - return $this; - } - - /** - * Sets status field. - */ - public function status(?string $value): self - { - $this->instance->setStatus($value); - return $this; - } - - /** - * Sets links field. - */ - public function links(?array $value): self - { - $this->instance->setLinks($value); - return $this; - } - - /** - * Initializes a new order object. - */ - public function build(): Order - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/OrderCaptureRequestBuilder.php b/src/Models/Builders/OrderCaptureRequestBuilder.php deleted file mode 100644 index a4df57b..0000000 --- a/src/Models/Builders/OrderCaptureRequestBuilder.php +++ /dev/null @@ -1,58 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new order capture request Builder object. - */ - public static function init(): self - { - return new self(new OrderCaptureRequest()); - } - - /** - * Sets payment source field. - */ - public function paymentSource(?OrderCaptureRequestPaymentSource $value): self - { - $this->instance->setPaymentSource($value); - return $this; - } - - /** - * Initializes a new order capture request object. - */ - public function build(): OrderCaptureRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/OrderCaptureRequestPaymentSourceBuilder.php b/src/Models/Builders/OrderCaptureRequestPaymentSourceBuilder.php deleted file mode 100644 index 914e88a..0000000 --- a/src/Models/Builders/OrderCaptureRequestPaymentSourceBuilder.php +++ /dev/null @@ -1,108 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new order capture request payment source Builder object. - */ - public static function init(): self - { - return new self(new OrderCaptureRequestPaymentSource()); - } - - /** - * Sets card field. - */ - public function card(?CardRequest $value): self - { - $this->instance->setCard($value); - return $this; - } - - /** - * Sets token field. - */ - public function token(?Token $value): self - { - $this->instance->setToken($value); - return $this; - } - - /** - * Sets paypal field. - */ - public function paypal(?PayPalWallet $value): self - { - $this->instance->setPaypal($value); - return $this; - } - - /** - * Sets apple pay field. - */ - public function applePay(?ApplePayRequest $value): self - { - $this->instance->setApplePay($value); - return $this; - } - - /** - * Sets google pay field. - */ - public function googlePay(?GooglePayRequest $value): self - { - $this->instance->setGooglePay($value); - return $this; - } - - /** - * Sets venmo field. - */ - public function venmo(?VenmoWalletRequest $value): self - { - $this->instance->setVenmo($value); - return $this; - } - - /** - * Initializes a new order capture request payment source object. - */ - public function build(): OrderCaptureRequestPaymentSource - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/OrderConfirmApplicationContextBuilder.php b/src/Models/Builders/OrderConfirmApplicationContextBuilder.php deleted file mode 100644 index 6bd848a..0000000 --- a/src/Models/Builders/OrderConfirmApplicationContextBuilder.php +++ /dev/null @@ -1,94 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new order confirm application context Builder object. - */ - public static function init(): self - { - return new self(new OrderConfirmApplicationContext()); - } - - /** - * Sets brand name field. - */ - public function brandName(?string $value): self - { - $this->instance->setBrandName($value); - return $this; - } - - /** - * Sets locale field. - */ - public function locale(?string $value): self - { - $this->instance->setLocale($value); - return $this; - } - - /** - * Sets return url field. - */ - public function returnUrl(?string $value): self - { - $this->instance->setReturnUrl($value); - return $this; - } - - /** - * Sets cancel url field. - */ - public function cancelUrl(?string $value): self - { - $this->instance->setCancelUrl($value); - return $this; - } - - /** - * Sets stored payment source field. - */ - public function storedPaymentSource(?StoredPaymentSource $value): self - { - $this->instance->setStoredPaymentSource($value); - return $this; - } - - /** - * Initializes a new order confirm application context object. - */ - public function build(): OrderConfirmApplicationContext - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/OrderRequestBuilder.php b/src/Models/Builders/OrderRequestBuilder.php deleted file mode 100644 index edd7bf5..0000000 --- a/src/Models/Builders/OrderRequestBuilder.php +++ /dev/null @@ -1,78 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new order request Builder object. - */ - public static function init(string $intent, array $purchaseUnits): self - { - return new self(new OrderRequest($intent, $purchaseUnits)); - } - - /** - * Sets payer field. - */ - public function payer(?Payer $value): self - { - $this->instance->setPayer($value); - return $this; - } - - /** - * Sets payment source field. - */ - public function paymentSource(?PaymentSource $value): self - { - $this->instance->setPaymentSource($value); - return $this; - } - - /** - * Sets application context field. - */ - public function applicationContext(?OrderApplicationContext $value): self - { - $this->instance->setApplicationContext($value); - return $this; - } - - /** - * Initializes a new order request object. - */ - public function build(): OrderRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/OrderTrackerItemBuilder.php b/src/Models/Builders/OrderTrackerItemBuilder.php deleted file mode 100644 index eabd897..0000000 --- a/src/Models/Builders/OrderTrackerItemBuilder.php +++ /dev/null @@ -1,103 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new order tracker item Builder object. - */ - public static function init(): self - { - return new self(new OrderTrackerItem()); - } - - /** - * Sets name field. - */ - public function name(?string $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets quantity field. - */ - public function quantity(?string $value): self - { - $this->instance->setQuantity($value); - return $this; - } - - /** - * Sets sku field. - */ - public function sku(?string $value): self - { - $this->instance->setSku($value); - return $this; - } - - /** - * Sets url field. - */ - public function url(?string $value): self - { - $this->instance->setUrl($value); - return $this; - } - - /** - * Sets image url field. - */ - public function imageUrl(?string $value): self - { - $this->instance->setImageUrl($value); - return $this; - } - - /** - * Sets upc field. - */ - public function upc(?UniversalProductCode $value): self - { - $this->instance->setUpc($value); - return $this; - } - - /** - * Initializes a new order tracker item object. - */ - public function build(): OrderTrackerItem - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/OrderTrackerRequestBuilder.php b/src/Models/Builders/OrderTrackerRequestBuilder.php deleted file mode 100644 index 78ed0b2..0000000 --- a/src/Models/Builders/OrderTrackerRequestBuilder.php +++ /dev/null @@ -1,93 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new order tracker request Builder object. - */ - public static function init(string $captureId): self - { - return new self(new OrderTrackerRequest($captureId)); - } - - /** - * Sets tracking number field. - */ - public function trackingNumber(?string $value): self - { - $this->instance->setTrackingNumber($value); - return $this; - } - - /** - * Sets carrier field. - */ - public function carrier(?string $value): self - { - $this->instance->setCarrier($value); - return $this; - } - - /** - * Sets carrier name other field. - */ - public function carrierNameOther(?string $value): self - { - $this->instance->setCarrierNameOther($value); - return $this; - } - - /** - * Sets notify payer field. - */ - public function notifyPayer(?bool $value): self - { - $this->instance->setNotifyPayer($value); - return $this; - } - - /** - * Sets items field. - */ - public function items(?array $value): self - { - $this->instance->setItems($value); - return $this; - } - - /** - * Initializes a new order tracker request object. - */ - public function build(): OrderTrackerRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/OrderTrackerResponseBuilder.php b/src/Models/Builders/OrderTrackerResponseBuilder.php deleted file mode 100644 index 9eba000..0000000 --- a/src/Models/Builders/OrderTrackerResponseBuilder.php +++ /dev/null @@ -1,102 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new order tracker response Builder object. - */ - public static function init(): self - { - return new self(new OrderTrackerResponse()); - } - - /** - * Sets id field. - */ - public function id(?string $value): self - { - $this->instance->setId($value); - return $this; - } - - /** - * Sets status field. - */ - public function status(?string $value): self - { - $this->instance->setStatus($value); - return $this; - } - - /** - * Sets items field. - */ - public function items(?array $value): self - { - $this->instance->setItems($value); - return $this; - } - - /** - * Sets links field. - */ - public function links(?array $value): self - { - $this->instance->setLinks($value); - return $this; - } - - /** - * Sets create time field. - */ - public function createTime(?string $value): self - { - $this->instance->setCreateTime($value); - return $this; - } - - /** - * Sets update time field. - */ - public function updateTime(?string $value): self - { - $this->instance->setUpdateTime($value); - return $this; - } - - /** - * Initializes a new order tracker response object. - */ - public function build(): OrderTrackerResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/P24PaymentObjectBuilder.php b/src/Models/Builders/P24PaymentObjectBuilder.php deleted file mode 100644 index 5b8c476..0000000 --- a/src/Models/Builders/P24PaymentObjectBuilder.php +++ /dev/null @@ -1,102 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new p24 payment object Builder object. - */ - public static function init(): self - { - return new self(new P24PaymentObject()); - } - - /** - * Sets name field. - */ - public function name(?string $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets email field. - */ - public function email(?string $value): self - { - $this->instance->setEmail($value); - return $this; - } - - /** - * Sets country code field. - */ - public function countryCode(?string $value): self - { - $this->instance->setCountryCode($value); - return $this; - } - - /** - * Sets payment descriptor field. - */ - public function paymentDescriptor(?string $value): self - { - $this->instance->setPaymentDescriptor($value); - return $this; - } - - /** - * Sets method id field. - */ - public function methodId(?string $value): self - { - $this->instance->setMethodId($value); - return $this; - } - - /** - * Sets method description field. - */ - public function methodDescription(?string $value): self - { - $this->instance->setMethodDescription($value); - return $this; - } - - /** - * Initializes a new p24 payment object object. - */ - public function build(): P24PaymentObject - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/P24PaymentRequestBuilder.php b/src/Models/Builders/P24PaymentRequestBuilder.php deleted file mode 100644 index 07c2e23..0000000 --- a/src/Models/Builders/P24PaymentRequestBuilder.php +++ /dev/null @@ -1,58 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new p24 payment request Builder object. - */ - public static function init(string $name, string $email, string $countryCode): self - { - return new self(new P24PaymentRequest($name, $email, $countryCode)); - } - - /** - * Sets experience context field. - */ - public function experienceContext(?ExperienceContext $value): self - { - $this->instance->setExperienceContext($value); - return $this; - } - - /** - * Initializes a new p24 payment request object. - */ - public function build(): P24PaymentRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PatchBuilder.php b/src/Models/Builders/PatchBuilder.php deleted file mode 100644 index ba587b1..0000000 --- a/src/Models/Builders/PatchBuilder.php +++ /dev/null @@ -1,75 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new patch Builder object. - */ - public static function init(string $op): self - { - return new self(new Patch($op)); - } - - /** - * Sets path field. - */ - public function path(?string $value): self - { - $this->instance->setPath($value); - return $this; - } - - /** - * Sets value field. - */ - public function value($value): self - { - $this->instance->setValue($value); - return $this; - } - - /** - * Sets from field. - */ - public function from(?string $value): self - { - $this->instance->setFrom($value); - return $this; - } - - /** - * Initializes a new patch object. - */ - public function build(): Patch - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PayPalPaymentTokenBuilder.php b/src/Models/Builders/PayPalPaymentTokenBuilder.php deleted file mode 100644 index 90f1243..0000000 --- a/src/Models/Builders/PayPalPaymentTokenBuilder.php +++ /dev/null @@ -1,161 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new pay pal payment token Builder object. - */ - public static function init(): self - { - return new self(new PayPalPaymentToken()); - } - - /** - * Sets description field. - */ - public function description(?string $value): self - { - $this->instance->setDescription($value); - return $this; - } - - /** - * Sets shipping field. - */ - public function shipping(?VaultedDigitalWalletShippingDetails $value): self - { - $this->instance->setShipping($value); - return $this; - } - - /** - * Sets permit multiple payment tokens field. - */ - public function permitMultiplePaymentTokens(?bool $value): self - { - $this->instance->setPermitMultiplePaymentTokens($value); - return $this; - } - - /** - * Sets usage type field. - */ - public function usageType(?string $value): self - { - $this->instance->setUsageType($value); - return $this; - } - - /** - * Sets customer type field. - */ - public function customerType(?string $value): self - { - $this->instance->setCustomerType($value); - return $this; - } - - /** - * Sets email address field. - */ - public function emailAddress(?string $value): self - { - $this->instance->setEmailAddress($value); - return $this; - } - - /** - * Sets payer id field. - */ - public function payerId(?string $value): self - { - $this->instance->setPayerId($value); - return $this; - } - - /** - * Sets name field. - */ - public function name(?Name $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets phone field. - */ - public function phone(?PhoneWithType $value): self - { - $this->instance->setPhone($value); - return $this; - } - - /** - * Sets address field. - */ - public function address(?Address $value): self - { - $this->instance->setAddress($value); - return $this; - } - - /** - * Sets account id field. - */ - public function accountId(?string $value): self - { - $this->instance->setAccountId($value); - return $this; - } - - /** - * Sets phone number field. - */ - public function phoneNumber(?Phone $value): self - { - $this->instance->setPhoneNumber($value); - return $this; - } - - /** - * Initializes a new pay pal payment token object. - */ - public function build(): PayPalPaymentToken - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PayPalWalletAttributesBuilder.php b/src/Models/Builders/PayPalWalletAttributesBuilder.php deleted file mode 100644 index 01119e7..0000000 --- a/src/Models/Builders/PayPalWalletAttributesBuilder.php +++ /dev/null @@ -1,68 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new pay pal wallet attributes Builder object. - */ - public static function init(): self - { - return new self(new PayPalWalletAttributes()); - } - - /** - * Sets customer field. - */ - public function customer(?PayPalWalletCustomerRequest $value): self - { - $this->instance->setCustomer($value); - return $this; - } - - /** - * Sets vault field. - */ - public function vault(?PayPalWalletVaultInstruction $value): self - { - $this->instance->setVault($value); - return $this; - } - - /** - * Initializes a new pay pal wallet attributes object. - */ - public function build(): PayPalWalletAttributes - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PayPalWalletAttributesResponseBuilder.php b/src/Models/Builders/PayPalWalletAttributesResponseBuilder.php deleted file mode 100644 index f8a0efc..0000000 --- a/src/Models/Builders/PayPalWalletAttributesResponseBuilder.php +++ /dev/null @@ -1,67 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new pay pal wallet attributes response Builder object. - */ - public static function init(): self - { - return new self(new PayPalWalletAttributesResponse()); - } - - /** - * Sets vault field. - */ - public function vault(?PayPalWalletVaultResponse $value): self - { - $this->instance->setVault($value); - return $this; - } - - /** - * Sets cobranded cards field. - */ - public function cobrandedCards(?array $value): self - { - $this->instance->setCobrandedCards($value); - return $this; - } - - /** - * Initializes a new pay pal wallet attributes response object. - */ - public function build(): PayPalWalletAttributesResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PayPalWalletBuilder.php b/src/Models/Builders/PayPalWalletBuilder.php deleted file mode 100644 index df25c84..0000000 --- a/src/Models/Builders/PayPalWalletBuilder.php +++ /dev/null @@ -1,144 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new pay pal wallet Builder object. - */ - public static function init(): self - { - return new self(new PayPalWallet()); - } - - /** - * Sets vault id field. - */ - public function vaultId(?string $value): self - { - $this->instance->setVaultId($value); - return $this; - } - - /** - * Sets email address field. - */ - public function emailAddress(?string $value): self - { - $this->instance->setEmailAddress($value); - return $this; - } - - /** - * Sets name field. - */ - public function name(?Name $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets phone field. - */ - public function phone(?PhoneWithType $value): self - { - $this->instance->setPhone($value); - return $this; - } - - /** - * Sets birth date field. - */ - public function birthDate(?string $value): self - { - $this->instance->setBirthDate($value); - return $this; - } - - /** - * Sets tax info field. - */ - public function taxInfo(?TaxInfo $value): self - { - $this->instance->setTaxInfo($value); - return $this; - } - - /** - * Sets address field. - */ - public function address(?Address $value): self - { - $this->instance->setAddress($value); - return $this; - } - - /** - * Sets attributes field. - */ - public function attributes(?PayPalWalletAttributes $value): self - { - $this->instance->setAttributes($value); - return $this; - } - - /** - * Sets experience context field. - */ - public function experienceContext(?PayPalWalletExperienceContext $value): self - { - $this->instance->setExperienceContext($value); - return $this; - } - - /** - * Sets billing agreement id field. - */ - public function billingAgreementId(?string $value): self - { - $this->instance->setBillingAgreementId($value); - return $this; - } - - /** - * Initializes a new pay pal wallet object. - */ - public function build(): PayPalWallet - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PayPalWalletCustomerBuilder.php b/src/Models/Builders/PayPalWalletCustomerBuilder.php deleted file mode 100644 index 2f6ba22..0000000 --- a/src/Models/Builders/PayPalWalletCustomerBuilder.php +++ /dev/null @@ -1,85 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new pay pal wallet customer Builder object. - */ - public static function init(): self - { - return new self(new PayPalWalletCustomer()); - } - - /** - * Sets id field. - */ - public function id(?string $value): self - { - $this->instance->setId($value); - return $this; - } - - /** - * Sets email address field. - */ - public function emailAddress(?string $value): self - { - $this->instance->setEmailAddress($value); - return $this; - } - - /** - * Sets phone field. - */ - public function phone(?PhoneWithType $value): self - { - $this->instance->setPhone($value); - return $this; - } - - /** - * Sets merchant customer id field. - */ - public function merchantCustomerId(?string $value): self - { - $this->instance->setMerchantCustomerId($value); - return $this; - } - - /** - * Initializes a new pay pal wallet customer object. - */ - public function build(): PayPalWalletCustomer - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PayPalWalletCustomerRequestBuilder.php b/src/Models/Builders/PayPalWalletCustomerRequestBuilder.php deleted file mode 100644 index 8e2cc40..0000000 --- a/src/Models/Builders/PayPalWalletCustomerRequestBuilder.php +++ /dev/null @@ -1,85 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new pay pal wallet customer request Builder object. - */ - public static function init(): self - { - return new self(new PayPalWalletCustomerRequest()); - } - - /** - * Sets id field. - */ - public function id(?string $value): self - { - $this->instance->setId($value); - return $this; - } - - /** - * Sets email address field. - */ - public function emailAddress(?string $value): self - { - $this->instance->setEmailAddress($value); - return $this; - } - - /** - * Sets phone field. - */ - public function phone(?PhoneWithType $value): self - { - $this->instance->setPhone($value); - return $this; - } - - /** - * Sets merchant customer id field. - */ - public function merchantCustomerId(?string $value): self - { - $this->instance->setMerchantCustomerId($value); - return $this; - } - - /** - * Initializes a new pay pal wallet customer request object. - */ - public function build(): PayPalWalletCustomerRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PayPalWalletExperienceContextBuilder.php b/src/Models/Builders/PayPalWalletExperienceContextBuilder.php deleted file mode 100644 index dfb3e80..0000000 --- a/src/Models/Builders/PayPalWalletExperienceContextBuilder.php +++ /dev/null @@ -1,120 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new pay pal wallet experience context Builder object. - */ - public static function init(): self - { - return new self(new PayPalWalletExperienceContext()); - } - - /** - * Sets brand name field. - */ - public function brandName(?string $value): self - { - $this->instance->setBrandName($value); - return $this; - } - - /** - * Sets locale field. - */ - public function locale(?string $value): self - { - $this->instance->setLocale($value); - return $this; - } - - /** - * Sets shipping preference field. - */ - public function shippingPreference(?string $value): self - { - $this->instance->setShippingPreference($value); - return $this; - } - - /** - * Sets return url field. - */ - public function returnUrl(?string $value): self - { - $this->instance->setReturnUrl($value); - return $this; - } - - /** - * Sets cancel url field. - */ - public function cancelUrl(?string $value): self - { - $this->instance->setCancelUrl($value); - return $this; - } - - /** - * Sets landing page field. - */ - public function landingPage(?string $value): self - { - $this->instance->setLandingPage($value); - return $this; - } - - /** - * Sets user action field. - */ - public function userAction(?string $value): self - { - $this->instance->setUserAction($value); - return $this; - } - - /** - * Sets payment method preference field. - */ - public function paymentMethodPreference(?string $value): self - { - $this->instance->setPaymentMethodPreference($value); - return $this; - } - - /** - * Initializes a new pay pal wallet experience context object. - */ - public function build(): PayPalWalletExperienceContext - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PayPalWalletResponseBuilder.php b/src/Models/Builders/PayPalWalletResponseBuilder.php deleted file mode 100644 index 54002b7..0000000 --- a/src/Models/Builders/PayPalWalletResponseBuilder.php +++ /dev/null @@ -1,143 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new pay pal wallet response Builder object. - */ - public static function init(): self - { - return new self(new PayPalWalletResponse()); - } - - /** - * Sets email address field. - */ - public function emailAddress(?string $value): self - { - $this->instance->setEmailAddress($value); - return $this; - } - - /** - * Sets account id field. - */ - public function accountId(?string $value): self - { - $this->instance->setAccountId($value); - return $this; - } - - /** - * Sets account status field. - */ - public function accountStatus(?string $value): self - { - $this->instance->setAccountStatus($value); - return $this; - } - - /** - * Sets name field. - */ - public function name(?Name $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets phone type field. - */ - public function phoneType(?string $value): self - { - $this->instance->setPhoneType($value); - return $this; - } - - /** - * Sets phone number field. - */ - public function phoneNumber(?PhoneNumber $value): self - { - $this->instance->setPhoneNumber($value); - return $this; - } - - /** - * Sets birth date field. - */ - public function birthDate(?string $value): self - { - $this->instance->setBirthDate($value); - return $this; - } - - /** - * Sets tax info field. - */ - public function taxInfo(?TaxInfo $value): self - { - $this->instance->setTaxInfo($value); - return $this; - } - - /** - * Sets address field. - */ - public function address(?Address $value): self - { - $this->instance->setAddress($value); - return $this; - } - - /** - * Sets attributes field. - */ - public function attributes(?PayPalWalletAttributesResponse $value): self - { - $this->instance->setAttributes($value); - return $this; - } - - /** - * Initializes a new pay pal wallet response object. - */ - public function build(): PayPalWalletResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PayPalWalletVaultInstructionBuilder.php b/src/Models/Builders/PayPalWalletVaultInstructionBuilder.php deleted file mode 100644 index 9b770a7..0000000 --- a/src/Models/Builders/PayPalWalletVaultInstructionBuilder.php +++ /dev/null @@ -1,93 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new pay pal wallet vault instruction Builder object. - */ - public static function init(string $usageType): self - { - return new self(new PayPalWalletVaultInstruction($usageType)); - } - - /** - * Sets store in vault field. - */ - public function storeInVault(?string $value): self - { - $this->instance->setStoreInVault($value); - return $this; - } - - /** - * Sets description field. - */ - public function description(?string $value): self - { - $this->instance->setDescription($value); - return $this; - } - - /** - * Sets usage pattern field. - */ - public function usagePattern(?string $value): self - { - $this->instance->setUsagePattern($value); - return $this; - } - - /** - * Sets customer type field. - */ - public function customerType(?string $value): self - { - $this->instance->setCustomerType($value); - return $this; - } - - /** - * Sets permit multiple payment tokens field. - */ - public function permitMultiplePaymentTokens(?bool $value): self - { - $this->instance->setPermitMultiplePaymentTokens($value); - return $this; - } - - /** - * Initializes a new pay pal wallet vault instruction object. - */ - public function build(): PayPalWalletVaultInstruction - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PayPalWalletVaultResponseBuilder.php b/src/Models/Builders/PayPalWalletVaultResponseBuilder.php deleted file mode 100644 index 517a388..0000000 --- a/src/Models/Builders/PayPalWalletVaultResponseBuilder.php +++ /dev/null @@ -1,85 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new pay pal wallet vault response Builder object. - */ - public static function init(): self - { - return new self(new PayPalWalletVaultResponse()); - } - - /** - * Sets id field. - */ - public function id(?string $value): self - { - $this->instance->setId($value); - return $this; - } - - /** - * Sets status field. - */ - public function status(?string $value): self - { - $this->instance->setStatus($value); - return $this; - } - - /** - * Sets links field. - */ - public function links(?array $value): self - { - $this->instance->setLinks($value); - return $this; - } - - /** - * Sets customer field. - */ - public function customer(?PayPalWalletCustomer $value): self - { - $this->instance->setCustomer($value); - return $this; - } - - /** - * Initializes a new pay pal wallet vault response object. - */ - public function build(): PayPalWalletVaultResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PayeeBaseBuilder.php b/src/Models/Builders/PayeeBaseBuilder.php deleted file mode 100644 index ba278c8..0000000 --- a/src/Models/Builders/PayeeBaseBuilder.php +++ /dev/null @@ -1,66 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new payee base Builder object. - */ - public static function init(): self - { - return new self(new PayeeBase()); - } - - /** - * 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 base object. - */ - public function build(): PayeeBase - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PayeeBuilder.php b/src/Models/Builders/PayeeBuilder.php deleted file mode 100644 index 9622ac1..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 deleted file mode 100644 index 9071c69..0000000 --- a/src/Models/Builders/PayerBaseBuilder.php +++ /dev/null @@ -1,66 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new payer base Builder object. - */ - public static function init(): self - { - return new self(new PayerBase()); - } - - /** - * Sets email address field. - */ - public function emailAddress(?string $value): self - { - $this->instance->setEmailAddress($value); - return $this; - } - - /** - * Sets payer id field. - */ - public function payerId(?string $value): self - { - $this->instance->setPayerId($value); - return $this; - } - - /** - * Initializes a new payer base object. - */ - public function build(): PayerBase - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PayerBuilder.php b/src/Models/Builders/PayerBuilder.php deleted file mode 100644 index 6ea4dd1..0000000 --- a/src/Models/Builders/PayerBuilder.php +++ /dev/null @@ -1,115 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new payer Builder object. - */ - public static function init(): self - { - return new self(new Payer()); - } - - /** - * Sets email address field. - */ - public function emailAddress(?string $value): self - { - $this->instance->setEmailAddress($value); - return $this; - } - - /** - * Sets payer id field. - */ - public function payerId(?string $value): self - { - $this->instance->setPayerId($value); - return $this; - } - - /** - * Sets name field. - */ - public function name(?Name $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets phone field. - */ - public function phone(?PhoneWithType $value): self - { - $this->instance->setPhone($value); - return $this; - } - - /** - * Sets birth date field. - */ - public function birthDate(?string $value): self - { - $this->instance->setBirthDate($value); - return $this; - } - - /** - * Sets tax info field. - */ - public function taxInfo(?TaxInfo $value): self - { - $this->instance->setTaxInfo($value); - return $this; - } - - /** - * Sets address field. - */ - public function address(?Address $value): self - { - $this->instance->setAddress($value); - return $this; - } - - /** - * Initializes a new payer object. - */ - public function build(): Payer - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PaymentAuthorizationBuilder.php b/src/Models/Builders/PaymentAuthorizationBuilder.php deleted file mode 100644 index f28fd24..0000000 --- a/src/Models/Builders/PaymentAuthorizationBuilder.php +++ /dev/null @@ -1,180 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new payment authorization Builder object. - */ - public static function init(): self - { - return new self(new PaymentAuthorization()); - } - - /** - * Sets status field. - */ - public function status(?string $value): self - { - $this->instance->setStatus($value); - return $this; - } - - /** - * Sets status details field. - */ - public function statusDetails(?AuthorizationStatusDetails $value): self - { - $this->instance->setStatusDetails($value); - return $this; - } - - /** - * Sets id field. - */ - public function id(?string $value): self - { - $this->instance->setId($value); - return $this; - } - - /** - * Sets amount field. - */ - public function amount(?Money $value): self - { - $this->instance->setAmount($value); - return $this; - } - - /** - * Sets invoice id field. - */ - public function invoiceId(?string $value): self - { - $this->instance->setInvoiceId($value); - return $this; - } - - /** - * Sets custom id field. - */ - public function customId(?string $value): self - { - $this->instance->setCustomId($value); - return $this; - } - - /** - * Sets network transaction reference field. - */ - public function networkTransactionReference(?NetworkTransactionReference $value): self - { - $this->instance->setNetworkTransactionReference($value); - return $this; - } - - /** - * Sets seller protection field. - */ - public function sellerProtection(?SellerProtection $value): self - { - $this->instance->setSellerProtection($value); - return $this; - } - - /** - * Sets expiration time field. - */ - public function expirationTime(?string $value): self - { - $this->instance->setExpirationTime($value); - return $this; - } - - /** - * Sets links field. - */ - public function links(?array $value): self - { - $this->instance->setLinks($value); - return $this; - } - - /** - * Sets create time field. - */ - public function createTime(?string $value): self - { - $this->instance->setCreateTime($value); - return $this; - } - - /** - * Sets update time field. - */ - public function updateTime(?string $value): self - { - $this->instance->setUpdateTime($value); - return $this; - } - - /** - * Sets supplementary data field. - */ - public function supplementaryData(?PaymentSupplementaryData $value): self - { - $this->instance->setSupplementaryData($value); - return $this; - } - - /** - * Sets payee field. - */ - public function payee(?Payee $value): self - { - $this->instance->setPayee($value); - return $this; - } - - /** - * Initializes a new payment authorization object. - */ - public function build(): PaymentAuthorization - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PaymentCollectionBuilder.php b/src/Models/Builders/PaymentCollectionBuilder.php deleted file mode 100644 index 9c105d9..0000000 --- a/src/Models/Builders/PaymentCollectionBuilder.php +++ /dev/null @@ -1,75 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new payment collection Builder object. - */ - public static function init(): self - { - return new self(new PaymentCollection()); - } - - /** - * Sets authorizations field. - */ - public function authorizations(?array $value): self - { - $this->instance->setAuthorizations($value); - return $this; - } - - /** - * Sets captures field. - */ - public function captures(?array $value): self - { - $this->instance->setCaptures($value); - return $this; - } - - /** - * Sets refunds field. - */ - public function refunds(?array $value): self - { - $this->instance->setRefunds($value); - return $this; - } - - /** - * Initializes a new payment collection object. - */ - public function build(): PaymentCollection - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PaymentInstructionBuilder.php b/src/Models/Builders/PaymentInstructionBuilder.php deleted file mode 100644 index 609ee94..0000000 --- a/src/Models/Builders/PaymentInstructionBuilder.php +++ /dev/null @@ -1,84 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new payment instruction Builder object. - */ - public static function init(): self - { - return new self(new PaymentInstruction()); - } - - /** - * Sets platform fees field. - */ - public function platformFees(?array $value): self - { - $this->instance->setPlatformFees($value); - return $this; - } - - /** - * Sets disbursement mode field. - */ - public function disbursementMode(?string $value): self - { - $this->instance->setDisbursementMode($value); - return $this; - } - - /** - * Sets payee pricing tier id field. - */ - public function payeePricingTierId(?string $value): self - { - $this->instance->setPayeePricingTierId($value); - return $this; - } - - /** - * Sets payee receivable fx rate id field. - */ - public function payeeReceivableFxRateId(?string $value): self - { - $this->instance->setPayeeReceivableFxRateId($value); - return $this; - } - - /** - * Initializes a new payment instruction object. - */ - public function build(): PaymentInstruction - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PaymentMethodPreferenceBuilder.php b/src/Models/Builders/PaymentMethodPreferenceBuilder.php deleted file mode 100644 index 4ef9796..0000000 --- a/src/Models/Builders/PaymentMethodPreferenceBuilder.php +++ /dev/null @@ -1,66 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new payment method preference Builder object. - */ - public static function init(): self - { - return new self(new PaymentMethodPreference()); - } - - /** - * Sets payee preferred field. - */ - public function payeePreferred(?string $value): self - { - $this->instance->setPayeePreferred($value); - return $this; - } - - /** - * Sets standard entry class code field. - */ - public function standardEntryClassCode(?string $value): self - { - $this->instance->setStandardEntryClassCode($value); - return $this; - } - - /** - * Initializes a new payment method preference object. - */ - public function build(): PaymentMethodPreference - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PaymentSourceBuilder.php b/src/Models/Builders/PaymentSourceBuilder.php deleted file mode 100644 index 5f182a7..0000000 --- a/src/Models/Builders/PaymentSourceBuilder.php +++ /dev/null @@ -1,198 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new payment source Builder object. - */ - public static function init(): self - { - return new self(new PaymentSource()); - } - - /** - * Sets card field. - */ - public function card(?CardRequest $value): self - { - $this->instance->setCard($value); - return $this; - } - - /** - * Sets token field. - */ - public function token(?Token $value): self - { - $this->instance->setToken($value); - return $this; - } - - /** - * Sets paypal field. - */ - public function paypal(?PayPalWallet $value): self - { - $this->instance->setPaypal($value); - return $this; - } - - /** - * Sets bancontact field. - */ - public function bancontact(?BancontactPaymentRequest $value): self - { - $this->instance->setBancontact($value); - return $this; - } - - /** - * Sets blik field. - */ - public function blik(?BLIKPaymentRequest $value): self - { - $this->instance->setBlik($value); - return $this; - } - - /** - * Sets eps field. - */ - public function eps(?EPSPaymentRequest $value): self - { - $this->instance->setEps($value); - return $this; - } - - /** - * Sets giropay field. - */ - public function giropay(?GiropayPaymentRequest $value): self - { - $this->instance->setGiropay($value); - return $this; - } - - /** - * Sets ideal field. - */ - public function ideal(?IDEALPaymentRequest $value): self - { - $this->instance->setIdeal($value); - return $this; - } - - /** - * Sets mybank field. - */ - public function mybank(?MyBankPaymentRequest $value): self - { - $this->instance->setMybank($value); - return $this; - } - - /** - * Sets p 24 field. - */ - public function p24(?P24PaymentRequest $value): self - { - $this->instance->setP24($value); - return $this; - } - - /** - * Sets sofort field. - */ - public function sofort(?SofortPaymentRequest $value): self - { - $this->instance->setSofort($value); - return $this; - } - - /** - * Sets trustly field. - */ - public function trustly(?TrustlyPaymentRequest $value): self - { - $this->instance->setTrustly($value); - return $this; - } - - /** - * Sets apple pay field. - */ - public function applePay(?ApplePayRequest $value): self - { - $this->instance->setApplePay($value); - return $this; - } - - /** - * Sets google pay field. - */ - public function googlePay(?GooglePayRequest $value): self - { - $this->instance->setGooglePay($value); - return $this; - } - - /** - * Sets venmo field. - */ - public function venmo(?VenmoWalletRequest $value): self - { - $this->instance->setVenmo($value); - return $this; - } - - /** - * Initializes a new payment source object. - */ - public function build(): PaymentSource - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PaymentSourceResponseBuilder.php b/src/Models/Builders/PaymentSourceResponseBuilder.php deleted file mode 100644 index 2dafc19..0000000 --- a/src/Models/Builders/PaymentSourceResponseBuilder.php +++ /dev/null @@ -1,188 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new payment source response Builder object. - */ - public static function init(): self - { - return new self(new PaymentSourceResponse()); - } - - /** - * Sets card field. - */ - public function card(?CardResponse $value): self - { - $this->instance->setCard($value); - return $this; - } - - /** - * Sets paypal field. - */ - public function paypal(?PayPalWalletResponse $value): self - { - $this->instance->setPaypal($value); - return $this; - } - - /** - * Sets bancontact field. - */ - public function bancontact(?BancontactPaymentObject $value): self - { - $this->instance->setBancontact($value); - return $this; - } - - /** - * Sets blik field. - */ - public function blik(?BLIKPaymentObject $value): self - { - $this->instance->setBlik($value); - return $this; - } - - /** - * Sets eps field. - */ - public function eps(?EPSPaymentObject $value): self - { - $this->instance->setEps($value); - return $this; - } - - /** - * Sets giropay field. - */ - public function giropay(?GiropayPaymentObject $value): self - { - $this->instance->setGiropay($value); - return $this; - } - - /** - * Sets ideal field. - */ - public function ideal(?IDEALPaymentObject $value): self - { - $this->instance->setIdeal($value); - return $this; - } - - /** - * Sets mybank field. - */ - public function mybank(?MyBankPaymentObject $value): self - { - $this->instance->setMybank($value); - return $this; - } - - /** - * Sets p 24 field. - */ - public function p24(?P24PaymentObject $value): self - { - $this->instance->setP24($value); - return $this; - } - - /** - * Sets sofort field. - */ - public function sofort(?SofortPaymentObject $value): self - { - $this->instance->setSofort($value); - return $this; - } - - /** - * Sets trustly field. - */ - public function trustly(?TrustlyPaymentObject $value): self - { - $this->instance->setTrustly($value); - return $this; - } - - /** - * Sets apple pay field. - */ - public function applePay(?ApplePayPaymentObject $value): self - { - $this->instance->setApplePay($value); - return $this; - } - - /** - * Sets google pay field. - */ - public function googlePay(?GooglePayWalletResponse $value): self - { - $this->instance->setGooglePay($value); - return $this; - } - - /** - * Sets venmo field. - */ - public function venmo(?VenmoWalletResponse $value): self - { - $this->instance->setVenmo($value); - return $this; - } - - /** - * Initializes a new payment source response object. - */ - public function build(): PaymentSourceResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PaymentSupplementaryDataBuilder.php b/src/Models/Builders/PaymentSupplementaryDataBuilder.php deleted file mode 100644 index 8c9400b..0000000 --- a/src/Models/Builders/PaymentSupplementaryDataBuilder.php +++ /dev/null @@ -1,58 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new payment supplementary data Builder object. - */ - public static function init(): self - { - return new self(new PaymentSupplementaryData()); - } - - /** - * Sets related ids field. - */ - public function relatedIds(?RelatedIdentifiers $value): self - { - $this->instance->setRelatedIds($value); - return $this; - } - - /** - * Initializes a new payment supplementary data object. - */ - public function build(): PaymentSupplementaryData - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PaymentTokenRequestBuilder.php b/src/Models/Builders/PaymentTokenRequestBuilder.php deleted file mode 100644 index 50ca45e..0000000 --- a/src/Models/Builders/PaymentTokenRequestBuilder.php +++ /dev/null @@ -1,59 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new payment token request Builder object. - */ - public static function init(PaymentTokenRequestPaymentSource $paymentSource): self - { - return new self(new PaymentTokenRequest($paymentSource)); - } - - /** - * Sets customer field. - */ - public function customer(?CustomerRequest $value): self - { - $this->instance->setCustomer($value); - return $this; - } - - /** - * Initializes a new payment token request object. - */ - public function build(): PaymentTokenRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PaymentTokenRequestCardBuilder.php b/src/Models/Builders/PaymentTokenRequestCardBuilder.php deleted file mode 100644 index 25cc7bc..0000000 --- a/src/Models/Builders/PaymentTokenRequestCardBuilder.php +++ /dev/null @@ -1,121 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new payment token request card Builder object. - */ - public static function init(): self - { - return new self(new PaymentTokenRequestCard()); - } - - /** - * Sets name field. - */ - public function name(?string $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets number field. - */ - public function number(?string $value): self - { - $this->instance->setNumber($value); - return $this; - } - - /** - * Sets expiry field. - */ - public function expiry(?string $value): self - { - $this->instance->setExpiry($value); - return $this; - } - - /** - * Sets security code field. - */ - public function securityCode(?string $value): self - { - $this->instance->setSecurityCode($value); - return $this; - } - - /** - * Sets type field. - */ - public function type(?string $value): self - { - $this->instance->setType($value); - return $this; - } - - /** - * Sets brand field. - */ - public function brand(?string $value): self - { - $this->instance->setBrand($value); - return $this; - } - - /** - * Sets billing address field. - */ - public function billingAddress(?Address $value): self - { - $this->instance->setBillingAddress($value); - return $this; - } - - /** - * Sets network transaction reference field. - */ - public function networkTransactionReference($value): self - { - $this->instance->setNetworkTransactionReference($value); - return $this; - } - - /** - * Initializes a new payment token request card object. - */ - public function build(): PaymentTokenRequestCard - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PaymentTokenRequestPaymentSourceBuilder.php b/src/Models/Builders/PaymentTokenRequestPaymentSourceBuilder.php deleted file mode 100644 index 782c714..0000000 --- a/src/Models/Builders/PaymentTokenRequestPaymentSourceBuilder.php +++ /dev/null @@ -1,68 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new payment token request payment source Builder object. - */ - public static function init(): self - { - return new self(new PaymentTokenRequestPaymentSource()); - } - - /** - * Sets card field. - */ - public function card(?PaymentTokenRequestCard $value): self - { - $this->instance->setCard($value); - return $this; - } - - /** - * Sets token field. - */ - public function token(?VaultTokenRequest $value): self - { - $this->instance->setToken($value); - return $this; - } - - /** - * Initializes a new payment token request payment source object. - */ - public function build(): PaymentTokenRequestPaymentSource - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PaymentTokenResponseBuilder.php b/src/Models/Builders/PaymentTokenResponseBuilder.php deleted file mode 100644 index ce2d08d..0000000 --- a/src/Models/Builders/PaymentTokenResponseBuilder.php +++ /dev/null @@ -1,86 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new payment token response Builder object. - */ - public static function init(): self - { - return new self(new PaymentTokenResponse()); - } - - /** - * Sets id field. - */ - public function id(?string $value): self - { - $this->instance->setId($value); - return $this; - } - - /** - * Sets customer field. - */ - public function customer(?CustomerRequest $value): self - { - $this->instance->setCustomer($value); - return $this; - } - - /** - * Sets payment source field. - */ - public function paymentSource(?PaymentTokenResponsePaymentSource $value): self - { - $this->instance->setPaymentSource($value); - return $this; - } - - /** - * Sets links field. - */ - public function links(?array $value): self - { - $this->instance->setLinks($value); - return $this; - } - - /** - * Initializes a new payment token response object. - */ - public function build(): PaymentTokenResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PaymentTokenResponsePaymentSourceBuilder.php b/src/Models/Builders/PaymentTokenResponsePaymentSourceBuilder.php deleted file mode 100644 index 8bd8da1..0000000 --- a/src/Models/Builders/PaymentTokenResponsePaymentSourceBuilder.php +++ /dev/null @@ -1,98 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new payment token response payment source Builder object. - */ - public static function init(): self - { - return new self(new PaymentTokenResponsePaymentSource()); - } - - /** - * Sets card field. - */ - public function card(?CardPaymentToken $value): self - { - $this->instance->setCard($value); - return $this; - } - - /** - * Sets paypal field. - */ - public function paypal(?PayPalPaymentToken $value): self - { - $this->instance->setPaypal($value); - return $this; - } - - /** - * Sets venmo field. - */ - public function venmo(?VenmoPaymentToken $value): self - { - $this->instance->setVenmo($value); - return $this; - } - - /** - * Sets apple pay field. - */ - public function applePay(?ApplePayPaymentToken $value): self - { - $this->instance->setApplePay($value); - return $this; - } - - /** - * Sets bank field. - */ - public function bank(?BankPaymentToken $value): self - { - $this->instance->setBank($value); - return $this; - } - - /** - * Initializes a new payment token response payment source object. - */ - public function build(): PaymentTokenResponsePaymentSource - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PhoneBuilder.php b/src/Models/Builders/PhoneBuilder.php deleted file mode 100644 index cfebe9d..0000000 --- a/src/Models/Builders/PhoneBuilder.php +++ /dev/null @@ -1,57 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new phone Builder object. - */ - public static function init(string $countryCode, string $nationalNumber): self - { - return new self(new Phone($countryCode, $nationalNumber)); - } - - /** - * Sets extension number field. - */ - public function extensionNumber(?string $value): self - { - $this->instance->setExtensionNumber($value); - return $this; - } - - /** - * Initializes a new phone object. - */ - public function build(): Phone - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PhoneNumberBuilder.php b/src/Models/Builders/PhoneNumberBuilder.php deleted file mode 100644 index 7bed028..0000000 --- a/src/Models/Builders/PhoneNumberBuilder.php +++ /dev/null @@ -1,48 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new phone number Builder object. - */ - public static function init(string $nationalNumber): self - { - return new self(new PhoneNumber($nationalNumber)); - } - - /** - * Initializes a new phone number object. - */ - public function build(): PhoneNumber - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PhoneNumberWithCountryCodeBuilder.php b/src/Models/Builders/PhoneNumberWithCountryCodeBuilder.php deleted file mode 100644 index c52fef6..0000000 --- a/src/Models/Builders/PhoneNumberWithCountryCodeBuilder.php +++ /dev/null @@ -1,48 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new phone number with country code Builder object. - */ - public static function init(string $countryCode, string $nationalNumber): self - { - return new self(new PhoneNumberWithCountryCode($countryCode, $nationalNumber)); - } - - /** - * Initializes a new phone number with country code object. - */ - public function build(): PhoneNumberWithCountryCode - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PhoneWithTypeBuilder.php b/src/Models/Builders/PhoneWithTypeBuilder.php deleted file mode 100644 index 2d31831..0000000 --- a/src/Models/Builders/PhoneWithTypeBuilder.php +++ /dev/null @@ -1,58 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new phone with type Builder object. - */ - public static function init(PhoneNumber $phoneNumber): self - { - return new self(new PhoneWithType($phoneNumber)); - } - - /** - * Sets phone type field. - */ - public function phoneType(?string $value): self - { - $this->instance->setPhoneType($value); - return $this; - } - - /** - * Initializes a new phone with type object. - */ - public function build(): PhoneWithType - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PlatformFeeBuilder.php b/src/Models/Builders/PlatformFeeBuilder.php deleted file mode 100644 index 64d1220..0000000 --- a/src/Models/Builders/PlatformFeeBuilder.php +++ /dev/null @@ -1,59 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new platform fee Builder object. - */ - public static function init(Money $amount): self - { - return new self(new PlatformFee($amount)); - } - - /** - * Sets payee field. - */ - public function payee(?PayeeBase $value): self - { - $this->instance->setPayee($value); - return $this; - } - - /** - * Initializes a new platform fee object. - */ - public function build(): PlatformFee - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/ProcessorResponseBuilder.php b/src/Models/Builders/ProcessorResponseBuilder.php deleted file mode 100644 index 1729d0e..0000000 --- a/src/Models/Builders/ProcessorResponseBuilder.php +++ /dev/null @@ -1,84 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new processor response Builder object. - */ - public static function init(): self - { - return new self(new ProcessorResponse()); - } - - /** - * Sets avs code field. - */ - public function avsCode(?string $value): self - { - $this->instance->setAvsCode($value); - return $this; - } - - /** - * Sets cvv code field. - */ - public function cvvCode(?string $value): self - { - $this->instance->setCvvCode($value); - return $this; - } - - /** - * Sets response code field. - */ - public function responseCode(?string $value): self - { - $this->instance->setResponseCode($value); - return $this; - } - - /** - * Sets payment advice code field. - */ - public function paymentAdviceCode(?string $value): self - { - $this->instance->setPaymentAdviceCode($value); - return $this; - } - - /** - * Initializes a new processor response object. - */ - public function build(): ProcessorResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PurchaseUnitBuilder.php b/src/Models/Builders/PurchaseUnitBuilder.php deleted file mode 100644 index 6c22f9d..0000000 --- a/src/Models/Builders/PurchaseUnitBuilder.php +++ /dev/null @@ -1,171 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new purchase unit Builder object. - */ - public static function init(): self - { - return new self(new PurchaseUnit()); - } - - /** - * Sets reference id field. - */ - public function referenceId(?string $value): self - { - $this->instance->setReferenceId($value); - return $this; - } - - /** - * Sets amount field. - */ - public function amount(?AmountWithBreakdown $value): self - { - $this->instance->setAmount($value); - return $this; - } - - /** - * Sets payee field. - */ - public function payee(?Payee $value): self - { - $this->instance->setPayee($value); - return $this; - } - - /** - * Sets payment instruction field. - */ - public function paymentInstruction(?PaymentInstruction $value): self - { - $this->instance->setPaymentInstruction($value); - return $this; - } - - /** - * Sets description field. - */ - public function description(?string $value): self - { - $this->instance->setDescription($value); - return $this; - } - - /** - * Sets custom id field. - */ - public function customId(?string $value): self - { - $this->instance->setCustomId($value); - return $this; - } - - /** - * Sets invoice id field. - */ - public function invoiceId(?string $value): self - { - $this->instance->setInvoiceId($value); - return $this; - } - - /** - * Sets id field. - */ - public function id(?string $value): self - { - $this->instance->setId($value); - return $this; - } - - /** - * Sets soft descriptor field. - */ - public function softDescriptor(?string $value): self - { - $this->instance->setSoftDescriptor($value); - return $this; - } - - /** - * Sets items field. - */ - public function items(?array $value): self - { - $this->instance->setItems($value); - return $this; - } - - /** - * Sets shipping field. - */ - public function shipping(?ShippingWithTrackingDetails $value): self - { - $this->instance->setShipping($value); - return $this; - } - - /** - * Sets supplementary data field. - */ - public function supplementaryData(?SupplementaryData $value): self - { - $this->instance->setSupplementaryData($value); - return $this; - } - - /** - * Sets payments field. - */ - public function payments(?PaymentCollection $value): self - { - $this->instance->setPayments($value); - return $this; - } - - /** - * Initializes a new purchase unit object. - */ - public function build(): PurchaseUnit - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/PurchaseUnitRequestBuilder.php b/src/Models/Builders/PurchaseUnitRequestBuilder.php deleted file mode 100644 index 0c470a8..0000000 --- a/src/Models/Builders/PurchaseUnitRequestBuilder.php +++ /dev/null @@ -1,143 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new purchase unit request Builder object. - */ - public static function init(AmountWithBreakdown $amount): self - { - return new self(new PurchaseUnitRequest($amount)); - } - - /** - * Sets reference id field. - */ - public function referenceId(?string $value): self - { - $this->instance->setReferenceId($value); - return $this; - } - - /** - * Sets payee field. - */ - public function payee(?Payee $value): self - { - $this->instance->setPayee($value); - return $this; - } - - /** - * Sets payment instruction field. - */ - public function paymentInstruction(?PaymentInstruction $value): self - { - $this->instance->setPaymentInstruction($value); - return $this; - } - - /** - * Sets description field. - */ - public function description(?string $value): self - { - $this->instance->setDescription($value); - return $this; - } - - /** - * Sets custom id field. - */ - public function customId(?string $value): self - { - $this->instance->setCustomId($value); - return $this; - } - - /** - * Sets invoice id field. - */ - public function invoiceId(?string $value): self - { - $this->instance->setInvoiceId($value); - return $this; - } - - /** - * Sets soft descriptor field. - */ - public function softDescriptor(?string $value): self - { - $this->instance->setSoftDescriptor($value); - return $this; - } - - /** - * Sets items field. - */ - public function items(?array $value): self - { - $this->instance->setItems($value); - return $this; - } - - /** - * Sets shipping field. - */ - public function shipping(?ShippingDetails $value): self - { - $this->instance->setShipping($value); - return $this; - } - - /** - * Sets supplementary data field. - */ - public function supplementaryData(?SupplementaryData $value): self - { - $this->instance->setSupplementaryData($value); - return $this; - } - - /** - * Initializes a new purchase unit request object. - */ - public function build(): PurchaseUnitRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/ReauthorizeRequestBuilder.php b/src/Models/Builders/ReauthorizeRequestBuilder.php deleted file mode 100644 index 7636884..0000000 --- a/src/Models/Builders/ReauthorizeRequestBuilder.php +++ /dev/null @@ -1,58 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new reauthorize request Builder object. - */ - public static function init(): self - { - return new self(new ReauthorizeRequest()); - } - - /** - * Sets amount field. - */ - public function amount(?Money $value): self - { - $this->instance->setAmount($value); - return $this; - } - - /** - * Initializes a new reauthorize request object. - */ - public function build(): ReauthorizeRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/RefundBuilder.php b/src/Models/Builders/RefundBuilder.php deleted file mode 100644 index 6e76374..0000000 --- a/src/Models/Builders/RefundBuilder.php +++ /dev/null @@ -1,169 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new refund Builder object. - */ - public static function init(): self - { - return new self(new Refund()); - } - - /** - * Sets status field. - */ - public function status(?string $value): self - { - $this->instance->setStatus($value); - return $this; - } - - /** - * Sets status details field. - */ - public function statusDetails(?RefundStatusDetails $value): self - { - $this->instance->setStatusDetails($value); - return $this; - } - - /** - * Sets id field. - */ - public function id(?string $value): self - { - $this->instance->setId($value); - return $this; - } - - /** - * Sets amount field. - */ - public function amount(?Money $value): self - { - $this->instance->setAmount($value); - return $this; - } - - /** - * Sets invoice id field. - */ - public function invoiceId(?string $value): self - { - $this->instance->setInvoiceId($value); - return $this; - } - - /** - * Sets custom id field. - */ - public function customId(?string $value): self - { - $this->instance->setCustomId($value); - return $this; - } - - /** - * Sets acquirer reference number field. - */ - public function acquirerReferenceNumber(?string $value): self - { - $this->instance->setAcquirerReferenceNumber($value); - return $this; - } - - /** - * Sets note to payer field. - */ - public function noteToPayer(?string $value): self - { - $this->instance->setNoteToPayer($value); - return $this; - } - - /** - * Sets seller payable breakdown field. - */ - public function sellerPayableBreakdown(?SellerPayableBreakdown $value): self - { - $this->instance->setSellerPayableBreakdown($value); - return $this; - } - - /** - * Sets payer field. - */ - public function payer(?PayeeBase $value): self - { - $this->instance->setPayer($value); - return $this; - } - - /** - * Sets links field. - */ - public function links(?array $value): self - { - $this->instance->setLinks($value); - return $this; - } - - /** - * Sets create time field. - */ - public function createTime(?string $value): self - { - $this->instance->setCreateTime($value); - return $this; - } - - /** - * Sets update time field. - */ - public function updateTime(?string $value): self - { - $this->instance->setUpdateTime($value); - return $this; - } - - /** - * Initializes a new refund object. - */ - public function build(): Refund - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/RefundPaymentInstructionBuilder.php b/src/Models/Builders/RefundPaymentInstructionBuilder.php deleted file mode 100644 index 22482ed..0000000 --- a/src/Models/Builders/RefundPaymentInstructionBuilder.php +++ /dev/null @@ -1,57 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new refund payment instruction Builder object. - */ - public static function init(): self - { - return new self(new RefundPaymentInstruction()); - } - - /** - * Sets platform fees field. - */ - public function platformFees(?array $value): self - { - $this->instance->setPlatformFees($value); - return $this; - } - - /** - * Initializes a new refund payment instruction object. - */ - public function build(): RefundPaymentInstruction - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/RefundPlatformFeeBuilder.php b/src/Models/Builders/RefundPlatformFeeBuilder.php deleted file mode 100644 index 6e9ddc1..0000000 --- a/src/Models/Builders/RefundPlatformFeeBuilder.php +++ /dev/null @@ -1,49 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new refund platform fee Builder object. - */ - public static function init(Money $amount): self - { - return new self(new RefundPlatformFee($amount)); - } - - /** - * Initializes a new refund platform fee object. - */ - public function build(): RefundPlatformFee - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/RefundRequestBuilder.php b/src/Models/Builders/RefundRequestBuilder.php deleted file mode 100644 index 4b15750..0000000 --- a/src/Models/Builders/RefundRequestBuilder.php +++ /dev/null @@ -1,95 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new refund request Builder object. - */ - public static function init(): self - { - return new self(new RefundRequest()); - } - - /** - * Sets amount field. - */ - public function amount(?Money $value): self - { - $this->instance->setAmount($value); - return $this; - } - - /** - * Sets custom id field. - */ - public function customId(?string $value): self - { - $this->instance->setCustomId($value); - return $this; - } - - /** - * Sets invoice id field. - */ - public function invoiceId(?string $value): self - { - $this->instance->setInvoiceId($value); - return $this; - } - - /** - * Sets note to payer field. - */ - public function noteToPayer(?string $value): self - { - $this->instance->setNoteToPayer($value); - return $this; - } - - /** - * Sets payment instruction field. - */ - public function paymentInstruction(?RefundPaymentInstruction $value): self - { - $this->instance->setPaymentInstruction($value); - return $this; - } - - /** - * Initializes a new refund request object. - */ - public function build(): RefundRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/RefundStatusDetailsBuilder.php b/src/Models/Builders/RefundStatusDetailsBuilder.php deleted file mode 100644 index f244606..0000000 --- a/src/Models/Builders/RefundStatusDetailsBuilder.php +++ /dev/null @@ -1,57 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new refund status details Builder object. - */ - public static function init(): self - { - return new self(new RefundStatusDetails()); - } - - /** - * Sets reason field. - */ - public function reason(?string $value): self - { - $this->instance->setReason($value); - return $this; - } - - /** - * Initializes a new refund status details object. - */ - public function build(): RefundStatusDetails - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/RefundStatusWithDetailsBuilder.php b/src/Models/Builders/RefundStatusWithDetailsBuilder.php deleted file mode 100644 index 8124729..0000000 --- a/src/Models/Builders/RefundStatusWithDetailsBuilder.php +++ /dev/null @@ -1,67 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new refund status with details Builder object. - */ - public static function init(): self - { - return new self(new RefundStatusWithDetails()); - } - - /** - * Sets status field. - */ - public function status(?string $value): self - { - $this->instance->setStatus($value); - return $this; - } - - /** - * Sets status details field. - */ - public function statusDetails(?RefundStatusDetails $value): self - { - $this->instance->setStatusDetails($value); - return $this; - } - - /** - * Initializes a new refund status with details object. - */ - public function build(): RefundStatusWithDetails - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/RelatedIdentifiersBuilder.php b/src/Models/Builders/RelatedIdentifiersBuilder.php deleted file mode 100644 index 9d4d86a..0000000 --- a/src/Models/Builders/RelatedIdentifiersBuilder.php +++ /dev/null @@ -1,75 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new related identifiers Builder object. - */ - public static function init(): self - { - return new self(new RelatedIdentifiers()); - } - - /** - * Sets order id field. - */ - public function orderId(?string $value): self - { - $this->instance->setOrderId($value); - return $this; - } - - /** - * Sets authorization id field. - */ - public function authorizationId(?string $value): self - { - $this->instance->setAuthorizationId($value); - return $this; - } - - /** - * Sets capture id field. - */ - public function captureId(?string $value): self - { - $this->instance->setCaptureId($value); - return $this; - } - - /** - * Initializes a new related identifiers object. - */ - public function build(): RelatedIdentifiers - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/SEPADebitAuthorizationDetailsBuilder.php b/src/Models/Builders/SEPADebitAuthorizationDetailsBuilder.php deleted file mode 100644 index ec5ca92..0000000 --- a/src/Models/Builders/SEPADebitAuthorizationDetailsBuilder.php +++ /dev/null @@ -1,57 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new sepadebit authorization details Builder object. - */ - public static function init(): self - { - return new self(new SEPADebitAuthorizationDetails()); - } - - /** - * Sets status field. - */ - public function status(?string $value): self - { - $this->instance->setStatus($value); - return $this; - } - - /** - * Initializes a new sepadebit authorization details object. - */ - public function build(): SEPADebitAuthorizationDetails - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/SEPADebitResponseBuilder.php b/src/Models/Builders/SEPADebitResponseBuilder.php deleted file mode 100644 index 853713a..0000000 --- a/src/Models/Builders/SEPADebitResponseBuilder.php +++ /dev/null @@ -1,86 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new sepadebit response Builder object. - */ - public static function init(): self - { - return new self(new SEPADebitResponse()); - } - - /** - * Sets iban last chars field. - */ - public function ibanLastChars(?string $value): self - { - $this->instance->setIbanLastChars($value); - return $this; - } - - /** - * Sets account holder name field. - */ - public function accountHolderName($value): self - { - $this->instance->setAccountHolderName($value); - return $this; - } - - /** - * Sets billing address field. - */ - public function billingAddress(?Address $value): self - { - $this->instance->setBillingAddress($value); - return $this; - } - - /** - * Sets authorization details field. - */ - public function authorizationDetails(?SEPADebitAuthorizationDetails $value): self - { - $this->instance->setAuthorizationDetails($value); - return $this; - } - - /** - * Initializes a new sepadebit response object. - */ - public function build(): SEPADebitResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/SellerPayableBreakdownBuilder.php b/src/Models/Builders/SellerPayableBreakdownBuilder.php deleted file mode 100644 index 1fc1759..0000000 --- a/src/Models/Builders/SellerPayableBreakdownBuilder.php +++ /dev/null @@ -1,121 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new seller payable breakdown Builder object. - */ - public static function init(): self - { - return new self(new SellerPayableBreakdown()); - } - - /** - * Sets gross amount field. - */ - public function grossAmount(?Money $value): self - { - $this->instance->setGrossAmount($value); - return $this; - } - - /** - * Sets paypal fee field. - */ - public function paypalFee(?Money $value): self - { - $this->instance->setPaypalFee($value); - return $this; - } - - /** - * Sets paypal fee in receivable currency field. - */ - public function paypalFeeInReceivableCurrency(?Money $value): self - { - $this->instance->setPaypalFeeInReceivableCurrency($value); - return $this; - } - - /** - * Sets net amount field. - */ - public function netAmount(?Money $value): self - { - $this->instance->setNetAmount($value); - return $this; - } - - /** - * Sets net amount in receivable currency field. - */ - public function netAmountInReceivableCurrency(?Money $value): self - { - $this->instance->setNetAmountInReceivableCurrency($value); - return $this; - } - - /** - * Sets platform fees field. - */ - public function platformFees(?array $value): self - { - $this->instance->setPlatformFees($value); - return $this; - } - - /** - * Sets net amount breakdown field. - */ - public function netAmountBreakdown(?array $value): self - { - $this->instance->setNetAmountBreakdown($value); - return $this; - } - - /** - * Sets total refunded amount field. - */ - public function totalRefundedAmount(?Money $value): self - { - $this->instance->setTotalRefundedAmount($value); - return $this; - } - - /** - * Initializes a new seller payable breakdown object. - */ - public function build(): SellerPayableBreakdown - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/SellerProtectionBuilder.php b/src/Models/Builders/SellerProtectionBuilder.php deleted file mode 100644 index ce0e8b0..0000000 --- a/src/Models/Builders/SellerProtectionBuilder.php +++ /dev/null @@ -1,66 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new seller protection Builder object. - */ - public static function init(): self - { - return new self(new SellerProtection()); - } - - /** - * Sets status field. - */ - public function status(?string $value): self - { - $this->instance->setStatus($value); - return $this; - } - - /** - * Sets dispute categories field. - */ - public function disputeCategories(?array $value): self - { - $this->instance->setDisputeCategories($value); - return $this; - } - - /** - * Initializes a new seller protection object. - */ - public function build(): SellerProtection - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/SellerReceivableBreakdownBuilder.php b/src/Models/Builders/SellerReceivableBreakdownBuilder.php deleted file mode 100644 index 182a289..0000000 --- a/src/Models/Builders/SellerReceivableBreakdownBuilder.php +++ /dev/null @@ -1,104 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new seller receivable breakdown Builder object. - */ - public static function init(Money $grossAmount): self - { - return new self(new SellerReceivableBreakdown($grossAmount)); - } - - /** - * Sets paypal fee field. - */ - public function paypalFee(?Money $value): self - { - $this->instance->setPaypalFee($value); - return $this; - } - - /** - * Sets paypal fee in receivable currency field. - */ - public function paypalFeeInReceivableCurrency(?Money $value): self - { - $this->instance->setPaypalFeeInReceivableCurrency($value); - return $this; - } - - /** - * Sets net amount field. - */ - public function netAmount(?Money $value): self - { - $this->instance->setNetAmount($value); - return $this; - } - - /** - * Sets receivable amount field. - */ - public function receivableAmount(?Money $value): self - { - $this->instance->setReceivableAmount($value); - return $this; - } - - /** - * Sets exchange rate field. - */ - public function exchangeRate(?ExchangeRate $value): self - { - $this->instance->setExchangeRate($value); - return $this; - } - - /** - * Sets platform fees field. - */ - public function platformFees(?array $value): self - { - $this->instance->setPlatformFees($value); - return $this; - } - - /** - * Initializes a new seller receivable breakdown object. - */ - public function build(): SellerReceivableBreakdown - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/SetupTokenCardExperienceContextBuilder.php b/src/Models/Builders/SetupTokenCardExperienceContextBuilder.php deleted file mode 100644 index 964815a..0000000 --- a/src/Models/Builders/SetupTokenCardExperienceContextBuilder.php +++ /dev/null @@ -1,93 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new setup token card experience context Builder object. - */ - public static function init(): self - { - return new self(new SetupTokenCardExperienceContext()); - } - - /** - * Sets brand name field. - */ - public function brandName(?string $value): self - { - $this->instance->setBrandName($value); - return $this; - } - - /** - * Sets locale field. - */ - public function locale(?string $value): self - { - $this->instance->setLocale($value); - return $this; - } - - /** - * Sets return url field. - */ - public function returnUrl(?string $value): self - { - $this->instance->setReturnUrl($value); - return $this; - } - - /** - * Sets cancel url field. - */ - public function cancelUrl(?string $value): self - { - $this->instance->setCancelUrl($value); - return $this; - } - - /** - * Sets vault instruction field. - */ - public function vaultInstruction(?string $value): self - { - $this->instance->setVaultInstruction($value); - return $this; - } - - /** - * Initializes a new setup token card experience context object. - */ - public function build(): SetupTokenCardExperienceContext - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/SetupTokenRequestBuilder.php b/src/Models/Builders/SetupTokenRequestBuilder.php deleted file mode 100644 index fa64c90..0000000 --- a/src/Models/Builders/SetupTokenRequestBuilder.php +++ /dev/null @@ -1,59 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new setup token request Builder object. - */ - public static function init(SetupTokenRequestPaymentSource $paymentSource): self - { - return new self(new SetupTokenRequest($paymentSource)); - } - - /** - * Sets customer field. - */ - public function customer(?CustomerRequest $value): self - { - $this->instance->setCustomer($value); - return $this; - } - - /** - * Initializes a new setup token request object. - */ - public function build(): SetupTokenRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/SetupTokenRequestCardBuilder.php b/src/Models/Builders/SetupTokenRequestCardBuilder.php deleted file mode 100644 index 4316a8f..0000000 --- a/src/Models/Builders/SetupTokenRequestCardBuilder.php +++ /dev/null @@ -1,140 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new setup token request card Builder object. - */ - public static function init(): self - { - return new self(new SetupTokenRequestCard()); - } - - /** - * Sets name field. - */ - public function name(?string $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets number field. - */ - public function number(?string $value): self - { - $this->instance->setNumber($value); - return $this; - } - - /** - * Sets expiry field. - */ - public function expiry(?string $value): self - { - $this->instance->setExpiry($value); - return $this; - } - - /** - * Sets security code field. - */ - public function securityCode(?string $value): self - { - $this->instance->setSecurityCode($value); - return $this; - } - - /** - * Sets type field. - */ - public function type(?string $value): self - { - $this->instance->setType($value); - return $this; - } - - /** - * Sets brand field. - */ - public function brand(?string $value): self - { - $this->instance->setBrand($value); - return $this; - } - - /** - * Sets billing address field. - */ - public function billingAddress(?Address $value): self - { - $this->instance->setBillingAddress($value); - return $this; - } - - /** - * Sets verification method field. - */ - public function verificationMethod(?string $value): self - { - $this->instance->setVerificationMethod($value); - return $this; - } - - /** - * Sets experience context field. - */ - public function experienceContext(?SetupTokenCardExperienceContext $value): self - { - $this->instance->setExperienceContext($value); - return $this; - } - - /** - * Sets network transaction reference field. - */ - public function networkTransactionReference($value): self - { - $this->instance->setNetworkTransactionReference($value); - return $this; - } - - /** - * Initializes a new setup token request card object. - */ - public function build(): SetupTokenRequestCard - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/SetupTokenRequestPaymentSourceBuilder.php b/src/Models/Builders/SetupTokenRequestPaymentSourceBuilder.php deleted file mode 100644 index 13481d8..0000000 --- a/src/Models/Builders/SetupTokenRequestPaymentSourceBuilder.php +++ /dev/null @@ -1,88 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new setup token request payment source Builder object. - */ - public static function init(): self - { - return new self(new SetupTokenRequestPaymentSource()); - } - - /** - * Sets card field. - */ - public function card(?SetupTokenRequestCard $value): self - { - $this->instance->setCard($value); - return $this; - } - - /** - * Sets paypal field. - */ - public function paypal(?VaultPayPalWalletRequest $value): self - { - $this->instance->setPaypal($value); - return $this; - } - - /** - * Sets venmo field. - */ - public function venmo(?VaultVenmoRequest $value): self - { - $this->instance->setVenmo($value); - return $this; - } - - /** - * Sets token field. - */ - public function token(?VaultTokenRequest $value): self - { - $this->instance->setToken($value); - return $this; - } - - /** - * Initializes a new setup token request payment source object. - */ - public function build(): SetupTokenRequestPaymentSource - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/SetupTokenResponseBuilder.php b/src/Models/Builders/SetupTokenResponseBuilder.php deleted file mode 100644 index 03d6ead..0000000 --- a/src/Models/Builders/SetupTokenResponseBuilder.php +++ /dev/null @@ -1,104 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new setup token response Builder object. - */ - public static function init(): self - { - return new self(new SetupTokenResponse()); - } - - /** - * Sets id field. - */ - public function id(?string $value): self - { - $this->instance->setId($value); - return $this; - } - - /** - * Sets ordinal field. - */ - public function ordinal(?int $value): self - { - $this->instance->setOrdinal($value); - return $this; - } - - /** - * Sets customer field. - */ - public function customer(?CustomerRequest $value): self - { - $this->instance->setCustomer($value); - return $this; - } - - /** - * Sets status field. - */ - public function status(?string $value): self - { - $this->instance->setStatus($value); - return $this; - } - - /** - * Sets payment source field. - */ - public function paymentSource(?SetupTokenResponsePaymentSource $value): self - { - $this->instance->setPaymentSource($value); - return $this; - } - - /** - * Sets links field. - */ - public function links(?array $value): self - { - $this->instance->setLinks($value); - return $this; - } - - /** - * Initializes a new setup token response object. - */ - public function build(): SetupTokenResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/SetupTokenResponseCardBuilder.php b/src/Models/Builders/SetupTokenResponseCardBuilder.php deleted file mode 100644 index c1ec253..0000000 --- a/src/Models/Builders/SetupTokenResponseCardBuilder.php +++ /dev/null @@ -1,152 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new setup token response card Builder object. - */ - public static function init(): self - { - return new self(new SetupTokenResponseCard()); - } - - /** - * 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(?AuthenticationResponse $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; - } - - /** - * Initializes a new setup token response card object. - */ - public function build(): SetupTokenResponseCard - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/SetupTokenResponsePaymentSourceBuilder.php b/src/Models/Builders/SetupTokenResponsePaymentSourceBuilder.php deleted file mode 100644 index d9c906c..0000000 --- a/src/Models/Builders/SetupTokenResponsePaymentSourceBuilder.php +++ /dev/null @@ -1,78 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new setup token response payment source Builder object. - */ - public static function init(): self - { - return new self(new SetupTokenResponsePaymentSource()); - } - - /** - * Sets card field. - */ - public function card(?SetupTokenResponseCard $value): self - { - $this->instance->setCard($value); - return $this; - } - - /** - * Sets paypal field. - */ - public function paypal(?PayPalPaymentToken $value): self - { - $this->instance->setPaypal($value); - return $this; - } - - /** - * Sets venmo field. - */ - public function venmo(?VenmoPaymentToken $value): self - { - $this->instance->setVenmo($value); - return $this; - } - - /** - * Initializes a new setup token response payment source object. - */ - public function build(): SetupTokenResponsePaymentSource - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/ShippingDetailsBuilder.php b/src/Models/Builders/ShippingDetailsBuilder.php deleted file mode 100644 index ce3afb4..0000000 --- a/src/Models/Builders/ShippingDetailsBuilder.php +++ /dev/null @@ -1,86 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new shipping details Builder object. - */ - public static function init(): self - { - return new self(new ShippingDetails()); - } - - /** - * Sets name field. - */ - public function name(?ShippingName $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets type field. - */ - public function type(?string $value): self - { - $this->instance->setType($value); - return $this; - } - - /** - * Sets options field. - */ - public function options(?array $value): self - { - $this->instance->setOptions($value); - return $this; - } - - /** - * Sets address field. - */ - public function address(?Address $value): self - { - $this->instance->setAddress($value); - return $this; - } - - /** - * Initializes a new shipping details object. - */ - public function build(): ShippingDetails - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/ShippingNameBuilder.php b/src/Models/Builders/ShippingNameBuilder.php deleted file mode 100644 index 74bbfef..0000000 --- a/src/Models/Builders/ShippingNameBuilder.php +++ /dev/null @@ -1,57 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new shipping name Builder object. - */ - public static function init(): self - { - return new self(new ShippingName()); - } - - /** - * Sets full name field. - */ - public function fullName(?string $value): self - { - $this->instance->setFullName($value); - return $this; - } - - /** - * Initializes a new shipping name object. - */ - public function build(): ShippingName - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/ShippingOptionBuilder.php b/src/Models/Builders/ShippingOptionBuilder.php deleted file mode 100644 index 01d3236..0000000 --- a/src/Models/Builders/ShippingOptionBuilder.php +++ /dev/null @@ -1,67 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new shipping option Builder object. - */ - public static function init(string $id, string $label, bool $selected): self - { - return new self(new ShippingOption($id, $label, $selected)); - } - - /** - * Sets type field. - */ - public function type(?string $value): self - { - $this->instance->setType($value); - return $this; - } - - /** - * Sets amount field. - */ - public function amount(?Money $value): self - { - $this->instance->setAmount($value); - return $this; - } - - /** - * Initializes a new shipping option object. - */ - public function build(): ShippingOption - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/ShippingWithTrackingDetailsBuilder.php b/src/Models/Builders/ShippingWithTrackingDetailsBuilder.php deleted file mode 100644 index a943335..0000000 --- a/src/Models/Builders/ShippingWithTrackingDetailsBuilder.php +++ /dev/null @@ -1,95 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new shipping with tracking details Builder object. - */ - public static function init(): self - { - return new self(new ShippingWithTrackingDetails()); - } - - /** - * Sets name field. - */ - public function name(?ShippingName $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets type field. - */ - public function type(?string $value): self - { - $this->instance->setType($value); - return $this; - } - - /** - * Sets options field. - */ - public function options(?array $value): self - { - $this->instance->setOptions($value); - return $this; - } - - /** - * Sets address field. - */ - public function address(?Address $value): self - { - $this->instance->setAddress($value); - return $this; - } - - /** - * Sets trackers field. - */ - public function trackers(?array $value): self - { - $this->instance->setTrackers($value); - return $this; - } - - /** - * Initializes a new shipping with tracking details object. - */ - public function build(): ShippingWithTrackingDetails - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/SofortPaymentObjectBuilder.php b/src/Models/Builders/SofortPaymentObjectBuilder.php deleted file mode 100644 index 07fc057..0000000 --- a/src/Models/Builders/SofortPaymentObjectBuilder.php +++ /dev/null @@ -1,84 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new sofort payment object Builder object. - */ - public static function init(): self - { - return new self(new SofortPaymentObject()); - } - - /** - * Sets name field. - */ - public function name(?string $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets country code field. - */ - public function countryCode(?string $value): self - { - $this->instance->setCountryCode($value); - return $this; - } - - /** - * Sets bic field. - */ - public function bic(?string $value): self - { - $this->instance->setBic($value); - return $this; - } - - /** - * Sets iban last chars field. - */ - public function ibanLastChars(?string $value): self - { - $this->instance->setIbanLastChars($value); - return $this; - } - - /** - * Initializes a new sofort payment object object. - */ - public function build(): SofortPaymentObject - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/SofortPaymentRequestBuilder.php b/src/Models/Builders/SofortPaymentRequestBuilder.php deleted file mode 100644 index 21f4baa..0000000 --- a/src/Models/Builders/SofortPaymentRequestBuilder.php +++ /dev/null @@ -1,58 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new sofort payment request Builder object. - */ - public static function init(string $name, string $countryCode): self - { - return new self(new SofortPaymentRequest($name, $countryCode)); - } - - /** - * Sets experience context field. - */ - public function experienceContext(?ExperienceContext $value): self - { - $this->instance->setExperienceContext($value); - return $this; - } - - /** - * Initializes a new sofort payment request object. - */ - public function build(): SofortPaymentRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/StoredPaymentSourceBuilder.php b/src/Models/Builders/StoredPaymentSourceBuilder.php deleted file mode 100644 index 1812b56..0000000 --- a/src/Models/Builders/StoredPaymentSourceBuilder.php +++ /dev/null @@ -1,67 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new stored payment source Builder object. - */ - public static function init(string $paymentInitiator, string $paymentType): self - { - return new self(new StoredPaymentSource($paymentInitiator, $paymentType)); - } - - /** - * Sets usage field. - */ - public function usage(?string $value): self - { - $this->instance->setUsage($value); - return $this; - } - - /** - * Sets previous network transaction reference field. - */ - public function previousNetworkTransactionReference(?NetworkTransactionReference $value): self - { - $this->instance->setPreviousNetworkTransactionReference($value); - return $this; - } - - /** - * Initializes a new stored payment source object. - */ - public function build(): StoredPaymentSource - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/SupplementaryDataBuilder.php b/src/Models/Builders/SupplementaryDataBuilder.php deleted file mode 100644 index f1670cf..0000000 --- a/src/Models/Builders/SupplementaryDataBuilder.php +++ /dev/null @@ -1,58 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new supplementary data Builder object. - */ - public static function init(): self - { - return new self(new SupplementaryData()); - } - - /** - * Sets card field. - */ - public function card(?CardSupplementaryData $value): self - { - $this->instance->setCard($value); - return $this; - } - - /** - * Initializes a new supplementary data object. - */ - public function build(): SupplementaryData - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/SupplementaryPurchaseDataBuilder.php b/src/Models/Builders/SupplementaryPurchaseDataBuilder.php deleted file mode 100644 index 2d13521..0000000 --- a/src/Models/Builders/SupplementaryPurchaseDataBuilder.php +++ /dev/null @@ -1,66 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new supplementary purchase data Builder object. - */ - public static function init(): self - { - return new self(new SupplementaryPurchaseData()); - } - - /** - * Sets invoice id field. - */ - public function invoiceId(?string $value): self - { - $this->instance->setInvoiceId($value); - return $this; - } - - /** - * Sets note to payer field. - */ - public function noteToPayer(?string $value): self - { - $this->instance->setNoteToPayer($value); - return $this; - } - - /** - * Initializes a new supplementary purchase data object. - */ - public function build(): SupplementaryPurchaseData - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/TaxInfoBuilder.php b/src/Models/Builders/TaxInfoBuilder.php deleted file mode 100644 index 14b78ca..0000000 --- a/src/Models/Builders/TaxInfoBuilder.php +++ /dev/null @@ -1,48 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new tax info Builder object. - */ - public static function init(string $taxId, string $taxIdType): self - { - return new self(new TaxInfo($taxId, $taxIdType)); - } - - /** - * Initializes a new tax info object. - */ - public function build(): TaxInfo - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/ThreeDSecureAuthenticationResponseBuilder.php b/src/Models/Builders/ThreeDSecureAuthenticationResponseBuilder.php deleted file mode 100644 index 426e8e1..0000000 --- a/src/Models/Builders/ThreeDSecureAuthenticationResponseBuilder.php +++ /dev/null @@ -1,66 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new three dsecure authentication response Builder object. - */ - public static function init(): self - { - return new self(new ThreeDSecureAuthenticationResponse()); - } - - /** - * Sets authentication status field. - */ - public function authenticationStatus(?string $value): self - { - $this->instance->setAuthenticationStatus($value); - return $this; - } - - /** - * Sets enrollment status field. - */ - public function enrollmentStatus(?string $value): self - { - $this->instance->setEnrollmentStatus($value); - return $this; - } - - /** - * Initializes a new three dsecure authentication response object. - */ - public function build(): ThreeDSecureAuthenticationResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/TokenBuilder.php b/src/Models/Builders/TokenBuilder.php deleted file mode 100644 index 07ce736..0000000 --- a/src/Models/Builders/TokenBuilder.php +++ /dev/null @@ -1,48 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new token Builder object. - */ - public static function init(string $id, string $type): self - { - return new self(new Token($id, $type)); - } - - /** - * Initializes a new token object. - */ - public function build(): Token - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/TrustlyPaymentObjectBuilder.php b/src/Models/Builders/TrustlyPaymentObjectBuilder.php deleted file mode 100644 index 2bc6710..0000000 --- a/src/Models/Builders/TrustlyPaymentObjectBuilder.php +++ /dev/null @@ -1,84 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new trustly payment object Builder object. - */ - public static function init(): self - { - return new self(new TrustlyPaymentObject()); - } - - /** - * Sets name field. - */ - public function name(?string $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets country code field. - */ - public function countryCode(?string $value): self - { - $this->instance->setCountryCode($value); - return $this; - } - - /** - * Sets bic field. - */ - public function bic(?string $value): self - { - $this->instance->setBic($value); - return $this; - } - - /** - * Sets iban last chars field. - */ - public function ibanLastChars(?string $value): self - { - $this->instance->setIbanLastChars($value); - return $this; - } - - /** - * Initializes a new trustly payment object object. - */ - public function build(): TrustlyPaymentObject - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/TrustlyPaymentRequestBuilder.php b/src/Models/Builders/TrustlyPaymentRequestBuilder.php deleted file mode 100644 index 45b5bda..0000000 --- a/src/Models/Builders/TrustlyPaymentRequestBuilder.php +++ /dev/null @@ -1,58 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new trustly payment request Builder object. - */ - public static function init(string $name, string $countryCode): self - { - return new self(new TrustlyPaymentRequest($name, $countryCode)); - } - - /** - * Sets experience context field. - */ - public function experienceContext(?ExperienceContext $value): self - { - $this->instance->setExperienceContext($value); - return $this; - } - - /** - * Initializes a new trustly payment request object. - */ - public function build(): TrustlyPaymentRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/UniversalProductCodeBuilder.php b/src/Models/Builders/UniversalProductCodeBuilder.php deleted file mode 100644 index ed698c3..0000000 --- a/src/Models/Builders/UniversalProductCodeBuilder.php +++ /dev/null @@ -1,48 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new universal product code Builder object. - */ - public static function init(string $type, string $code): self - { - return new self(new UniversalProductCode($type, $code)); - } - - /** - * Initializes a new universal product code object. - */ - public function build(): UniversalProductCode - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/VaultCustomerBuilder.php b/src/Models/Builders/VaultCustomerBuilder.php deleted file mode 100644 index bc979bc..0000000 --- a/src/Models/Builders/VaultCustomerBuilder.php +++ /dev/null @@ -1,57 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new vault customer Builder object. - */ - public static function init(): self - { - return new self(new VaultCustomer()); - } - - /** - * Sets id field. - */ - public function id(?string $value): self - { - $this->instance->setId($value); - return $this; - } - - /** - * Initializes a new vault customer object. - */ - public function build(): VaultCustomer - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/VaultExperienceContextBuilder.php b/src/Models/Builders/VaultExperienceContextBuilder.php deleted file mode 100644 index 5056c1d..0000000 --- a/src/Models/Builders/VaultExperienceContextBuilder.php +++ /dev/null @@ -1,102 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new vault experience context Builder object. - */ - public static function init(): self - { - return new self(new VaultExperienceContext()); - } - - /** - * Sets brand name field. - */ - public function brandName(?string $value): self - { - $this->instance->setBrandName($value); - return $this; - } - - /** - * Sets locale field. - */ - public function locale(?string $value): self - { - $this->instance->setLocale($value); - return $this; - } - - /** - * Sets return url field. - */ - public function returnUrl(?string $value): self - { - $this->instance->setReturnUrl($value); - return $this; - } - - /** - * Sets cancel url field. - */ - public function cancelUrl(?string $value): self - { - $this->instance->setCancelUrl($value); - return $this; - } - - /** - * Sets shipping preference field. - */ - public function shippingPreference(?string $value): self - { - $this->instance->setShippingPreference($value); - return $this; - } - - /** - * Sets vault instruction field. - */ - public function vaultInstruction(?string $value): self - { - $this->instance->setVaultInstruction($value); - return $this; - } - - /** - * Initializes a new vault experience context object. - */ - public function build(): VaultExperienceContext - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/VaultInstructionBaseBuilder.php b/src/Models/Builders/VaultInstructionBaseBuilder.php deleted file mode 100644 index 882bc11..0000000 --- a/src/Models/Builders/VaultInstructionBaseBuilder.php +++ /dev/null @@ -1,57 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new vault instruction base Builder object. - */ - public static function init(): self - { - return new self(new VaultInstructionBase()); - } - - /** - * Sets store in vault field. - */ - public function storeInVault(?string $value): self - { - $this->instance->setStoreInVault($value); - return $this; - } - - /** - * Initializes a new vault instruction base object. - */ - public function build(): VaultInstructionBase - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/VaultInstructionBuilder.php b/src/Models/Builders/VaultInstructionBuilder.php deleted file mode 100644 index 4f6d3f4..0000000 --- a/src/Models/Builders/VaultInstructionBuilder.php +++ /dev/null @@ -1,48 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new vault instruction Builder object. - */ - public static function init(string $storeInVault): self - { - return new self(new VaultInstruction($storeInVault)); - } - - /** - * Initializes a new vault instruction object. - */ - public function build(): VaultInstruction - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/VaultPayPalWalletRequestBuilder.php b/src/Models/Builders/VaultPayPalWalletRequestBuilder.php deleted file mode 100644 index 547fa6f..0000000 --- a/src/Models/Builders/VaultPayPalWalletRequestBuilder.php +++ /dev/null @@ -1,104 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new vault pay pal wallet request Builder object. - */ - public static function init(): self - { - return new self(new VaultPayPalWalletRequest()); - } - - /** - * Sets description field. - */ - public function description(?string $value): self - { - $this->instance->setDescription($value); - return $this; - } - - /** - * Sets shipping field. - */ - public function shipping(?VaultedDigitalWalletShippingDetails $value): self - { - $this->instance->setShipping($value); - return $this; - } - - /** - * Sets permit multiple payment tokens field. - */ - public function permitMultiplePaymentTokens(?bool $value): self - { - $this->instance->setPermitMultiplePaymentTokens($value); - return $this; - } - - /** - * Sets usage type field. - */ - public function usageType(?string $value): self - { - $this->instance->setUsageType($value); - return $this; - } - - /** - * Sets customer type field. - */ - public function customerType(?string $value): self - { - $this->instance->setCustomerType($value); - return $this; - } - - /** - * Sets experience context field. - */ - public function experienceContext(?VaultExperienceContext $value): self - { - $this->instance->setExperienceContext($value); - return $this; - } - - /** - * Initializes a new vault pay pal wallet request object. - */ - public function build(): VaultPayPalWalletRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/VaultResponseBuilder.php b/src/Models/Builders/VaultResponseBuilder.php deleted file mode 100644 index b49ad3b..0000000 --- a/src/Models/Builders/VaultResponseBuilder.php +++ /dev/null @@ -1,85 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new vault response Builder object. - */ - public static function init(): self - { - return new self(new VaultResponse()); - } - - /** - * Sets id field. - */ - public function id(?string $value): self - { - $this->instance->setId($value); - return $this; - } - - /** - * Sets status field. - */ - public function status(?string $value): self - { - $this->instance->setStatus($value); - return $this; - } - - /** - * Sets customer field. - */ - public function customer(?VaultCustomer $value): self - { - $this->instance->setCustomer($value); - return $this; - } - - /** - * Sets links field. - */ - public function links(?array $value): self - { - $this->instance->setLinks($value); - return $this; - } - - /** - * Initializes a new vault response object. - */ - public function build(): VaultResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/VaultSEPADebitResponseBuilder.php b/src/Models/Builders/VaultSEPADebitResponseBuilder.php deleted file mode 100644 index 621abcc..0000000 --- a/src/Models/Builders/VaultSEPADebitResponseBuilder.php +++ /dev/null @@ -1,76 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new vault sepadebit response Builder object. - */ - public static function init(): self - { - return new self(new VaultSEPADebitResponse()); - } - - /** - * Sets iban last chars field. - */ - public function ibanLastChars(?string $value): self - { - $this->instance->setIbanLastChars($value); - return $this; - } - - /** - * Sets account holder name field. - */ - public function accountHolderName($value): self - { - $this->instance->setAccountHolderName($value); - return $this; - } - - /** - * Sets billing address field. - */ - public function billingAddress(?Address $value): self - { - $this->instance->setBillingAddress($value); - return $this; - } - - /** - * Initializes a new vault sepadebit response object. - */ - public function build(): VaultSEPADebitResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/VaultTokenRequestBuilder.php b/src/Models/Builders/VaultTokenRequestBuilder.php deleted file mode 100644 index 50b6c16..0000000 --- a/src/Models/Builders/VaultTokenRequestBuilder.php +++ /dev/null @@ -1,48 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new vault token request Builder object. - */ - public static function init(string $id, string $type): self - { - return new self(new VaultTokenRequest($id, $type)); - } - - /** - * Initializes a new vault token request object. - */ - public function build(): VaultTokenRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/VaultVenmoExperienceContextBuilder.php b/src/Models/Builders/VaultVenmoExperienceContextBuilder.php deleted file mode 100644 index 79cffd7..0000000 --- a/src/Models/Builders/VaultVenmoExperienceContextBuilder.php +++ /dev/null @@ -1,75 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new vault venmo experience context Builder object. - */ - public static function init(): self - { - return new self(new VaultVenmoExperienceContext()); - } - - /** - * Sets brand name field. - */ - public function brandName(?string $value): self - { - $this->instance->setBrandName($value); - return $this; - } - - /** - * Sets shipping preference field. - */ - public function shippingPreference(?string $value): self - { - $this->instance->setShippingPreference($value); - return $this; - } - - /** - * Sets vault instruction field. - */ - public function vaultInstruction(?string $value): self - { - $this->instance->setVaultInstruction($value); - return $this; - } - - /** - * Initializes a new vault venmo experience context object. - */ - public function build(): VaultVenmoExperienceContext - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/VaultVenmoRequestBuilder.php b/src/Models/Builders/VaultVenmoRequestBuilder.php deleted file mode 100644 index cc593d9..0000000 --- a/src/Models/Builders/VaultVenmoRequestBuilder.php +++ /dev/null @@ -1,104 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new vault venmo request Builder object. - */ - public static function init(): self - { - return new self(new VaultVenmoRequest()); - } - - /** - * Sets description field. - */ - public function description(?string $value): self - { - $this->instance->setDescription($value); - return $this; - } - - /** - * Sets shipping field. - */ - public function shipping(?VaultedDigitalWalletShippingDetails $value): self - { - $this->instance->setShipping($value); - return $this; - } - - /** - * Sets permit multiple payment tokens field. - */ - public function permitMultiplePaymentTokens(?bool $value): self - { - $this->instance->setPermitMultiplePaymentTokens($value); - return $this; - } - - /** - * Sets usage type field. - */ - public function usageType(?string $value): self - { - $this->instance->setUsageType($value); - return $this; - } - - /** - * Sets customer type field. - */ - public function customerType(?string $value): self - { - $this->instance->setCustomerType($value); - return $this; - } - - /** - * Sets experience context field. - */ - public function experienceContext(?VaultVenmoExperienceContext $value): self - { - $this->instance->setExperienceContext($value); - return $this; - } - - /** - * Initializes a new vault venmo request object. - */ - public function build(): VaultVenmoRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/VaultedDigitalWalletBuilder.php b/src/Models/Builders/VaultedDigitalWalletBuilder.php deleted file mode 100644 index 1faf9a6..0000000 --- a/src/Models/Builders/VaultedDigitalWalletBuilder.php +++ /dev/null @@ -1,94 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new vaulted digital wallet Builder object. - */ - public static function init(): self - { - return new self(new VaultedDigitalWallet()); - } - - /** - * Sets description field. - */ - public function description(?string $value): self - { - $this->instance->setDescription($value); - return $this; - } - - /** - * Sets shipping field. - */ - public function shipping(?VaultedDigitalWalletShippingDetails $value): self - { - $this->instance->setShipping($value); - return $this; - } - - /** - * Sets permit multiple payment tokens field. - */ - public function permitMultiplePaymentTokens(?bool $value): self - { - $this->instance->setPermitMultiplePaymentTokens($value); - return $this; - } - - /** - * Sets usage type field. - */ - public function usageType(?string $value): self - { - $this->instance->setUsageType($value); - return $this; - } - - /** - * Sets customer type field. - */ - public function customerType(?string $value): self - { - $this->instance->setCustomerType($value); - return $this; - } - - /** - * Initializes a new vaulted digital wallet object. - */ - public function build(): VaultedDigitalWallet - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/VaultedDigitalWalletShippingDetailsBuilder.php b/src/Models/Builders/VaultedDigitalWalletShippingDetailsBuilder.php deleted file mode 100644 index 2339708..0000000 --- a/src/Models/Builders/VaultedDigitalWalletShippingDetailsBuilder.php +++ /dev/null @@ -1,77 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new vaulted digital wallet shipping details Builder object. - */ - public static function init(): self - { - return new self(new VaultedDigitalWalletShippingDetails()); - } - - /** - * Sets name field. - */ - public function name(?ShippingName $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets type field. - */ - public function type(?string $value): self - { - $this->instance->setType($value); - return $this; - } - - /** - * Sets address field. - */ - public function address(?Address $value): self - { - $this->instance->setAddress($value); - return $this; - } - - /** - * Initializes a new vaulted digital wallet shipping details object. - */ - public function build(): VaultedDigitalWalletShippingDetails - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/VenmoPaymentTokenBuilder.php b/src/Models/Builders/VenmoPaymentTokenBuilder.php deleted file mode 100644 index f6f9020..0000000 --- a/src/Models/Builders/VenmoPaymentTokenBuilder.php +++ /dev/null @@ -1,151 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new venmo payment token Builder object. - */ - public static function init(): self - { - return new self(new VenmoPaymentToken()); - } - - /** - * Sets description field. - */ - public function description(?string $value): self - { - $this->instance->setDescription($value); - return $this; - } - - /** - * Sets shipping field. - */ - public function shipping(?VaultedDigitalWalletShippingDetails $value): self - { - $this->instance->setShipping($value); - return $this; - } - - /** - * Sets permit multiple payment tokens field. - */ - public function permitMultiplePaymentTokens(?bool $value): self - { - $this->instance->setPermitMultiplePaymentTokens($value); - return $this; - } - - /** - * Sets usage type field. - */ - public function usageType(?string $value): self - { - $this->instance->setUsageType($value); - return $this; - } - - /** - * Sets customer type field. - */ - public function customerType(?string $value): self - { - $this->instance->setCustomerType($value); - return $this; - } - - /** - * Sets email address field. - */ - public function emailAddress(?string $value): self - { - $this->instance->setEmailAddress($value); - return $this; - } - - /** - * Sets payer id field. - */ - public function payerId(?string $value): self - { - $this->instance->setPayerId($value); - return $this; - } - - /** - * Sets name field. - */ - public function name(?Name $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets phone field. - */ - public function phone(?PhoneWithType $value): self - { - $this->instance->setPhone($value); - return $this; - } - - /** - * Sets address field. - */ - public function address(?Address $value): self - { - $this->instance->setAddress($value); - return $this; - } - - /** - * Sets user name field. - */ - public function userName(?string $value): self - { - $this->instance->setUserName($value); - return $this; - } - - /** - * Initializes a new venmo payment token object. - */ - public function build(): VenmoPaymentToken - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/VenmoWalletAdditionalAttributesBuilder.php b/src/Models/Builders/VenmoWalletAdditionalAttributesBuilder.php deleted file mode 100644 index 1a53a85..0000000 --- a/src/Models/Builders/VenmoWalletAdditionalAttributesBuilder.php +++ /dev/null @@ -1,68 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new venmo wallet additional attributes Builder object. - */ - public static function init(): self - { - return new self(new VenmoWalletAdditionalAttributes()); - } - - /** - * Sets customer field. - */ - public function customer(?VenmoWalletCustomerInformation $value): self - { - $this->instance->setCustomer($value); - return $this; - } - - /** - * Sets vault field. - */ - public function vault(?VenmoWalletVaultAttributes $value): self - { - $this->instance->setVault($value); - return $this; - } - - /** - * Initializes a new venmo wallet additional attributes object. - */ - public function build(): VenmoWalletAdditionalAttributes - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/VenmoWalletAttributesResponseBuilder.php b/src/Models/Builders/VenmoWalletAttributesResponseBuilder.php deleted file mode 100644 index 72cefa7..0000000 --- a/src/Models/Builders/VenmoWalletAttributesResponseBuilder.php +++ /dev/null @@ -1,58 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new venmo wallet attributes response Builder object. - */ - public static function init(): self - { - return new self(new VenmoWalletAttributesResponse()); - } - - /** - * Sets vault field. - */ - public function vault(?VaultResponse $value): self - { - $this->instance->setVault($value); - return $this; - } - - /** - * Initializes a new venmo wallet attributes response object. - */ - public function build(): VenmoWalletAttributesResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/VenmoWalletCustomerInformationBuilder.php b/src/Models/Builders/VenmoWalletCustomerInformationBuilder.php deleted file mode 100644 index f364754..0000000 --- a/src/Models/Builders/VenmoWalletCustomerInformationBuilder.php +++ /dev/null @@ -1,66 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new venmo wallet customer information Builder object. - */ - public static function init(): self - { - return new self(new VenmoWalletCustomerInformation()); - } - - /** - * Sets id field. - */ - public function id(?string $value): self - { - $this->instance->setId($value); - return $this; - } - - /** - * Sets email address field. - */ - public function emailAddress(?string $value): self - { - $this->instance->setEmailAddress($value); - return $this; - } - - /** - * Initializes a new venmo wallet customer information object. - */ - public function build(): VenmoWalletCustomerInformation - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/VenmoWalletExperienceContextBuilder.php b/src/Models/Builders/VenmoWalletExperienceContextBuilder.php deleted file mode 100644 index f7a9132..0000000 --- a/src/Models/Builders/VenmoWalletExperienceContextBuilder.php +++ /dev/null @@ -1,66 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new venmo wallet experience context Builder object. - */ - public static function init(): self - { - return new self(new VenmoWalletExperienceContext()); - } - - /** - * Sets brand name field. - */ - public function brandName(?string $value): self - { - $this->instance->setBrandName($value); - return $this; - } - - /** - * Sets shipping preference field. - */ - public function shippingPreference(?string $value): self - { - $this->instance->setShippingPreference($value); - return $this; - } - - /** - * Initializes a new venmo wallet experience context object. - */ - public function build(): VenmoWalletExperienceContext - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/VenmoWalletRequestBuilder.php b/src/Models/Builders/VenmoWalletRequestBuilder.php deleted file mode 100644 index 19238c5..0000000 --- a/src/Models/Builders/VenmoWalletRequestBuilder.php +++ /dev/null @@ -1,86 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new venmo wallet request Builder object. - */ - public static function init(): self - { - return new self(new VenmoWalletRequest()); - } - - /** - * Sets vault id field. - */ - public function vaultId(?string $value): self - { - $this->instance->setVaultId($value); - return $this; - } - - /** - * Sets email address field. - */ - public function emailAddress(?string $value): self - { - $this->instance->setEmailAddress($value); - return $this; - } - - /** - * Sets experience context field. - */ - public function experienceContext(?VenmoWalletExperienceContext $value): self - { - $this->instance->setExperienceContext($value); - return $this; - } - - /** - * Sets attributes field. - */ - public function attributes(?VenmoWalletAdditionalAttributes $value): self - { - $this->instance->setAttributes($value); - return $this; - } - - /** - * Initializes a new venmo wallet request object. - */ - public function build(): VenmoWalletRequest - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/VenmoWalletResponseBuilder.php b/src/Models/Builders/VenmoWalletResponseBuilder.php deleted file mode 100644 index 6018586..0000000 --- a/src/Models/Builders/VenmoWalletResponseBuilder.php +++ /dev/null @@ -1,115 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new venmo wallet response Builder object. - */ - public static function init(): self - { - return new self(new VenmoWalletResponse()); - } - - /** - * Sets email address field. - */ - public function emailAddress(?string $value): self - { - $this->instance->setEmailAddress($value); - return $this; - } - - /** - * Sets account id field. - */ - public function accountId(?string $value): self - { - $this->instance->setAccountId($value); - return $this; - } - - /** - * Sets user name field. - */ - public function userName(?string $value): self - { - $this->instance->setUserName($value); - return $this; - } - - /** - * Sets name field. - */ - public function name(?Name $value): self - { - $this->instance->setName($value); - return $this; - } - - /** - * Sets phone number field. - */ - public function phoneNumber(?PhoneNumber $value): self - { - $this->instance->setPhoneNumber($value); - return $this; - } - - /** - * Sets address field. - */ - public function address(?Address $value): self - { - $this->instance->setAddress($value); - return $this; - } - - /** - * Sets attributes field. - */ - public function attributes(?VenmoWalletAttributesResponse $value): self - { - $this->instance->setAttributes($value); - return $this; - } - - /** - * Initializes a new venmo wallet response object. - */ - public function build(): VenmoWalletResponse - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/Builders/VenmoWalletVaultAttributesBuilder.php b/src/Models/Builders/VenmoWalletVaultAttributesBuilder.php deleted file mode 100644 index 498027f..0000000 --- a/src/Models/Builders/VenmoWalletVaultAttributesBuilder.php +++ /dev/null @@ -1,84 +0,0 @@ -instance = $instance; - } - - /** - * Initializes a new venmo wallet vault attributes Builder object. - */ - public static function init(string $storeInVault, string $usageType): self - { - return new self(new VenmoWalletVaultAttributes($storeInVault, $usageType)); - } - - /** - * Sets description field. - */ - public function description(?string $value): self - { - $this->instance->setDescription($value); - return $this; - } - - /** - * Sets usage pattern field. - */ - public function usagePattern(?string $value): self - { - $this->instance->setUsagePattern($value); - return $this; - } - - /** - * Sets customer type field. - */ - public function customerType(?string $value): self - { - $this->instance->setCustomerType($value); - return $this; - } - - /** - * Sets permit multiple payment tokens field. - */ - public function permitMultiplePaymentTokens(?bool $value): self - { - $this->instance->setPermitMultiplePaymentTokens($value); - return $this; - } - - /** - * Initializes a new venmo wallet vault attributes object. - */ - public function build(): VenmoWalletVaultAttributes - { - return CoreHelper::clone($this->instance); - } -} diff --git a/src/Models/CVVCode.php b/src/Models/CVVCode.php deleted file mode 100644 index 8255b6b..0000000 --- a/src/Models/CVVCode.php +++ /dev/null @@ -1,84 +0,0 @@ -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(): ?ProcessorResponse - { - 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(?ProcessorResponse $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; - } - - /** - * 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'] = CaptureStatus::checkValue($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'] = DisbursementMode::checkValue($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/CaptureIncompleteReason.php b/src/Models/CaptureIncompleteReason.php deleted file mode 100644 index 9f7c64d..0000000 --- a/src/Models/CaptureIncompleteReason.php +++ /dev/null @@ -1,78 +0,0 @@ -platformFees; - } - - /** - * Sets Platform Fees. - * An array of platform or partner fees, commissions, or brokerage fees that associated with the - * captured payment. - * - * @maps platform_fees - * - * @param PlatformFee[]|null $platformFees - */ - public function setPlatformFees(?array $platformFees): void - { - $this->platformFees = $platformFees; - } - - /** - * 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 Payee Receivable Fx Rate Id. - * FX identifier generated returned by PayPal to be used for payment processing in order to honor FX - * rate (for eligible integrations) to be used when amount is settled/received into the payee account. - */ - public function getPayeeReceivableFxRateId(): ?string - { - return $this->payeeReceivableFxRateId; - } - - /** - * Sets Payee Receivable Fx Rate Id. - * FX identifier generated returned by PayPal to be used for payment processing in order to honor FX - * rate (for eligible integrations) to be used when amount is settled/received into the payee account. - * - * @maps payee_receivable_fx_rate_id - */ - public function setPayeeReceivableFxRateId(?string $payeeReceivableFxRateId): void - { - $this->payeeReceivableFxRateId = $payeeReceivableFxRateId; - } - - /** - * 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->platformFees)) { - $json['platform_fees'] = $this->platformFees; - } - if (isset($this->disbursementMode)) { - $json['disbursement_mode'] = DisbursementMode::checkValue($this->disbursementMode); - } - if (isset($this->payeeReceivableFxRateId)) { - $json['payee_receivable_fx_rate_id'] = $this->payeeReceivableFxRateId; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/CaptureRequest.php b/src/Models/CaptureRequest.php deleted file mode 100644 index 1742d27..0000000 --- a/src/Models/CaptureRequest.php +++ /dev/null @@ -1,210 +0,0 @@ -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 Note to Payer. - * An informational note about this settlement. Appears in both the payer's transaction history and the - * emails that the payer receives. - */ - public function getNoteToPayer(): ?string - { - return $this->noteToPayer; - } - - /** - * Sets Note to Payer. - * An informational note about this settlement. Appears in both the payer's transaction history and the - * emails that the payer receives. - * - * @maps note_to_payer - */ - public function setNoteToPayer(?string $noteToPayer): void - { - $this->noteToPayer = $noteToPayer; - } - - /** - * 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 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 Payment Instruction. - * Any additional payment instructions to be consider during payment processing. This processing - * instruction is applicable for Capturing an order or Authorizing an Order. - */ - public function getPaymentInstruction(): ?CapturePaymentInstruction - { - return $this->paymentInstruction; - } - - /** - * Sets Payment Instruction. - * Any additional payment instructions to be consider during payment processing. This processing - * instruction is applicable for Capturing an order or Authorizing an Order. - * - * @maps payment_instruction - */ - public function setPaymentInstruction(?CapturePaymentInstruction $paymentInstruction): void - { - $this->paymentInstruction = $paymentInstruction; - } - - /** - * Returns Soft Descriptor. - * The payment descriptor on the payer's account statement. - */ - public function getSoftDescriptor(): ?string - { - return $this->softDescriptor; - } - - /** - * Sets Soft Descriptor. - * The payment descriptor on the payer's account statement. - * - * @maps soft_descriptor - */ - public function setSoftDescriptor(?string $softDescriptor): void - { - $this->softDescriptor = $softDescriptor; - } - - /** - * 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->invoiceId)) { - $json['invoice_id'] = $this->invoiceId; - } - if (isset($this->noteToPayer)) { - $json['note_to_payer'] = $this->noteToPayer; - } - if (isset($this->amount)) { - $json['amount'] = $this->amount; - } - if (isset($this->finalCapture)) { - $json['final_capture'] = $this->finalCapture; - } - if (isset($this->paymentInstruction)) { - $json['payment_instruction'] = $this->paymentInstruction; - } - if (isset($this->softDescriptor)) { - $json['soft_descriptor'] = $this->softDescriptor; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/CaptureStatus.php b/src/Models/CaptureStatus.php deleted file mode 100644 index 4efe0d3..0000000 --- a/src/Models/CaptureStatus.php +++ /dev/null @@ -1,54 +0,0 @@ -reason; - } - - /** - * Sets Reason. - * The reason why the captured payment status is `PENDING` or `DENIED`. - * - * @maps reason - */ - public function setReason(?string $reason): void - { - $this->reason = $reason; - } - - /** - * 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->reason)) { - $json['reason'] = CaptureIncompleteReason::checkValue($this->reason); - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/CaptureStatusWithDetails.php b/src/Models/CaptureStatusWithDetails.php deleted file mode 100644 index af70b51..0000000 --- a/src/Models/CaptureStatusWithDetails.php +++ /dev/null @@ -1,91 +0,0 @@ -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; - } - - /** - * 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'] = CaptureStatus::checkValue($this->status); - } - if (isset($this->statusDetails)) { - $json['status_details'] = $this->statusDetails; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/CapturedPayment.php b/src/Models/CapturedPayment.php deleted file mode 100644 index 01fa4bf..0000000 --- a/src/Models/CapturedPayment.php +++ /dev/null @@ -1,537 +0,0 @@ -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(): ?ProcessorResponse - { - 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(?ProcessorResponse $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; - } - - /** - * Returns Supplementary Data. - * The supplementary data. - */ - public function getSupplementaryData(): ?PaymentSupplementaryData - { - return $this->supplementaryData; - } - - /** - * Sets Supplementary Data. - * The supplementary data. - * - * @maps supplementary_data - */ - public function setSupplementaryData(?PaymentSupplementaryData $supplementaryData): void - { - $this->supplementaryData = $supplementaryData; - } - - /** - * Returns Payee. - * 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 - { - return $this->payee; - } - - /** - * Sets Payee. - * The details for the merchant who receives the funds and fulfills the order. The merchant is also - * known as the payee. - * - * @maps payee - */ - public function setPayee(?Payee $payee): void - { - $this->payee = $payee; - } - - /** - * 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'] = CaptureStatus::checkValue($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'] = DisbursementMode::checkValue($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; - } - if (isset($this->supplementaryData)) { - $json['supplementary_data'] = $this->supplementaryData; - } - if (isset($this->payee)) { - $json['payee'] = $this->payee; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/CardAttributes.php b/src/Models/CardAttributes.php deleted file mode 100644 index 052fa94..0000000 --- a/src/Models/CardAttributes.php +++ /dev/null @@ -1,123 +0,0 @@ -customer; - } - - /** - * Sets Customer. - * The details about a customer in PayPal's system of record. - * - * @maps customer - */ - public function setCustomer(?CustomerInformation $customer): void - { - $this->customer = $customer; - } - - /** - * Returns Vault. - * Basic vault instruction specification that can be extended by specific payment sources that supports - * vaulting. - */ - public function getVault(): ?VaultInstructionBase - { - return $this->vault; - } - - /** - * Sets Vault. - * Basic vault instruction specification that can be extended by specific payment sources that supports - * vaulting. - * - * @maps vault - */ - public function setVault(?VaultInstructionBase $vault): void - { - $this->vault = $vault; - } - - /** - * Returns Verification. - * The API caller can opt in to verify the card through PayPal offered verification services (e.g. - * Smart Dollar Auth, 3DS). - */ - public function getVerification(): ?CardVerification - { - return $this->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->customer)) { - $json['customer'] = $this->customer; - } - if (isset($this->vault)) { - $json['vault'] = $this->vault; - } - if (isset($this->verification)) { - $json['verification'] = $this->verification; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/CardAttributesResponse.php b/src/Models/CardAttributesResponse.php deleted file mode 100644 index 634ff05..0000000 --- a/src/Models/CardAttributesResponse.php +++ /dev/null @@ -1,63 +0,0 @@ -vault; - } - - /** - * Sets Vault. - * The details about a saved payment source. - * - * @maps vault - */ - public function setVault(?VaultResponse $vault): void - { - $this->vault = $vault; - } - - /** - * 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->vault)) { - $json['vault'] = $this->vault; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/CardBrand.php b/src/Models/CardBrand.php deleted file mode 100644 index a7172d1..0000000 --- a/src/Models/CardBrand.php +++ /dev/null @@ -1,114 +0,0 @@ -returnUrl; - } - - /** - * Sets Return Url. - * Describes the URL. - * - * @maps return_url - */ - public function setReturnUrl(?string $returnUrl): void - { - $this->returnUrl = $returnUrl; - } - - /** - * Returns Cancel Url. - * Describes the URL. - */ - public function getCancelUrl(): ?string - { - return $this->cancelUrl; - } - - /** - * Sets Cancel Url. - * Describes the URL. - * - * @maps cancel_url - */ - public function setCancelUrl(?string $cancelUrl): void - { - $this->cancelUrl = $cancelUrl; - } - - /** - * 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->returnUrl)) { - $json['return_url'] = $this->returnUrl; - } - if (isset($this->cancelUrl)) { - $json['cancel_url'] = $this->cancelUrl; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/CardFromRequest.php b/src/Models/CardFromRequest.php deleted file mode 100644 index c8d219e..0000000 --- a/src/Models/CardFromRequest.php +++ /dev/null @@ -1,93 +0,0 @@ -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 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; - } - - /** - * 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->expiry)) { - $json['expiry'] = $this->expiry; - } - if (isset($this->lastDigits)) { - $json['last_digits'] = $this->lastDigits; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/CardPaymentToken.php b/src/Models/CardPaymentToken.php deleted file mode 100644 index 4bee8a8..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(): ?AuthenticationResponse - { - return $this->authenticationResult; - } - - /** - * Sets Authentication Result. - * Results of Authentication such as 3D Secure. - * - * @maps authentication_result - */ - public function setAuthenticationResult(?AuthenticationResponse $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/CardRequest.php b/src/Models/CardRequest.php deleted file mode 100644 index a17f859..0000000 --- a/src/Models/CardRequest.php +++ /dev/null @@ -1,346 +0,0 @@ -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 -{ - /** - * @var string|null - */ - private $name; - - /** - * @var string|null - */ - private $number; - - /** - * @var string|null - */ - private $expiry; - - /** - * @var string|null - */ - private $securityCode; - - /** - * @var Address|null - */ - private $billingAddress; - - /** - * @var CardAttributes|null - */ - private $attributes; - - /** - * @var string|null - */ - private $vaultId; - - /** - * @var CardStoredCredential|null - */ - private $storedCredential; - - /** - * @var NetworkToken|null - */ - private $networkToken; - - /** - * @var CardExperienceContext|null - */ - private $experienceContext; - - /** - * Returns Name. - * The card holder's name as it appears on the card. - */ - public function getName(): ?string - { - return $this->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 Number. - * The primary account number (PAN) for the payment card. - */ - public function getNumber(): ?string - { - return $this->number; - } - - /** - * Sets Number. - * The primary account number (PAN) for the payment card. - * - * @maps number - */ - public function setNumber(?string $number): void - { - $this->number = $number; - } - - /** - * 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 Security Code. - * 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`. - */ - public function getSecurityCode(): ?string - { - return $this->securityCode; - } - - /** - * Sets Security Code. - * 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`. - * - * @maps security_code - */ - public function setSecurityCode(?string $securityCode): void - { - $this->securityCode = $securityCode; - } - - /** - * Returns Billing 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 getBillingAddress(): ?Address - { - return $this->billingAddress; - } - - /** - * Sets Billing 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). - * - * @maps billing_address - */ - public function setBillingAddress(?Address $billingAddress): void - { - $this->billingAddress = $billingAddress; - } - - /** - * Returns Attributes. - * Additional attributes associated with the use of this card. - */ - public function getAttributes(): ?CardAttributes - { - return $this->attributes; - } - - /** - * Sets Attributes. - * Additional attributes associated with the use of this card. - * - * @maps attributes - */ - public function setAttributes(?CardAttributes $attributes): void - { - $this->attributes = $attributes; - } - - /** - * Returns Vault Id. - * The PayPal-generated ID for the vaulted payment source. This ID should be stored on the merchant's - * server so the saved payment source can be used for future transactions. - */ - public function getVaultId(): ?string - { - return $this->vaultId; - } - - /** - * Sets Vault Id. - * The PayPal-generated ID for the vaulted payment source. This ID should be stored on the merchant's - * server so the saved payment source can be used for future transactions. - * - * @maps vault_id - */ - public function setVaultId(?string $vaultId): void - { - $this->vaultId = $vaultId; - } - - /** - * 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: - *
- */ - 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: - *
- * - * @maps stored_credential - */ - public function setStoredCredential(?CardStoredCredential $storedCredential): void - { - $this->storedCredential = $storedCredential; - } - - /** - * Returns Network Token. - * The Third Party Network token used to fund a payment. - */ - public function getNetworkToken(): ?NetworkToken - { - return $this->networkToken; - } - - /** - * Sets Network Token. - * The Third Party Network token used to fund a payment. - * - * @maps network_token - */ - public function setNetworkToken(?NetworkToken $networkToken): void - { - $this->networkToken = $networkToken; - } - - /** - * Returns Experience Context. - * Customizes the payer experience during the 3DS Approval for payment. - */ - public function getExperienceContext(): ?CardExperienceContext - { - return $this->experienceContext; - } - - /** - * Sets Experience Context. - * Customizes the payer experience during the 3DS Approval for payment. - * - * @maps experience_context - */ - public function setExperienceContext(?CardExperienceContext $experienceContext): void - { - $this->experienceContext = $experienceContext; - } - - /** - * 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->number)) { - $json['number'] = $this->number; - } - if (isset($this->expiry)) { - $json['expiry'] = $this->expiry; - } - if (isset($this->securityCode)) { - $json['security_code'] = $this->securityCode; - } - if (isset($this->billingAddress)) { - $json['billing_address'] = $this->billingAddress; - } - if (isset($this->attributes)) { - $json['attributes'] = $this->attributes; - } - if (isset($this->vaultId)) { - $json['vault_id'] = $this->vaultId; - } - if (isset($this->storedCredential)) { - $json['stored_credential'] = $this->storedCredential; - } - if (isset($this->networkToken)) { - $json['network_token'] = $this->networkToken; - } - if (isset($this->experienceContext)) { - $json['experience_context'] = $this->experienceContext; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/CardResponse.php b/src/Models/CardResponse.php deleted file mode 100644 index e57f216..0000000 --- a/src/Models/CardResponse.php +++ /dev/null @@ -1,321 +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 Available Networks. - * Array of brands or networks associated with the card. - * - * @return string[]|null - */ - public function getAvailableNetworks(): ?array - { - return $this->availableNetworks; - } - - /** - * Sets Available Networks. - * Array of brands or networks associated with the card. - * - * @maps available_networks - * - * @param string[]|null $availableNetworks - */ - public function setAvailableNetworks(?array $availableNetworks): void - { - $this->availableNetworks = $availableNetworks; - } - - /** - * 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 Authentication Result. - * Results of Authentication such as 3D Secure. - */ - public function getAuthenticationResult(): ?AuthenticationResponse - { - return $this->authenticationResult; - } - - /** - * Sets Authentication Result. - * Results of Authentication such as 3D Secure. - * - * @maps authentication_result - */ - public function setAuthenticationResult(?AuthenticationResponse $authenticationResult): void - { - $this->authenticationResult = $authenticationResult; - } - - /** - * Returns Attributes. - * Additional attributes associated with the use of this card. - */ - public function getAttributes(): ?CardAttributesResponse - { - return $this->attributes; - } - - /** - * Sets Attributes. - * Additional attributes associated with the use of this card. - * - * @maps attributes - */ - public function setAttributes(?CardAttributesResponse $attributes): void - { - $this->attributes = $attributes; - } - - /** - * Returns From Request. - * Representation of card details as received in the request. - */ - public function getFromRequest(): ?CardFromRequest - { - return $this->fromRequest; - } - - /** - * Sets From Request. - * Representation of card details as received in the request. - * - * @maps from_request - */ - public function setFromRequest(?CardFromRequest $fromRequest): void - { - $this->fromRequest = $fromRequest; - } - - /** - * 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 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; - } - - /** - * 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->availableNetworks)) { - $json['available_networks'] = CardBrand::checkValue($this->availableNetworks); - } - if (isset($this->type)) { - $json['type'] = CardType::checkValue($this->type); - } - if (isset($this->authenticationResult)) { - $json['authentication_result'] = $this->authenticationResult; - } - if (isset($this->attributes)) { - $json['attributes'] = $this->attributes; - } - if (isset($this->fromRequest)) { - $json['from_request'] = $this->fromRequest; - } - if (isset($this->expiry)) { - $json['expiry'] = $this->expiry; - } - if (isset($this->binDetails)) { - $json['bin_details'] = $this->binDetails; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/CardResponseEntity.php b/src/Models/CardResponseEntity.php deleted file mode 100644 index 38975d6..0000000 --- a/src/Models/CardResponseEntity.php +++ /dev/null @@ -1,346 +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(): ?AuthenticationResponse - { - return $this->authenticationResult; - } - - /** - * Sets Authentication Result. - * Results of Authentication such as 3D Secure. - * - * @maps authentication_result - */ - public function setAuthenticationResult(?AuthenticationResponse $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; - } - - /** - * 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); - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/CardStoredCredential.php b/src/Models/CardStoredCredential.php deleted file mode 100644 index 78f48f0..0000000 --- a/src/Models/CardStoredCredential.php +++ /dev/null @@ -1,168 +0,0 @@ -Parameter compatibility: - *
- */ -class CardStoredCredential implements \JsonSerializable -{ - /** - * @var string - */ - private $paymentInitiator; - - /** - * @var string - */ - private $paymentType; - - /** - * @var string|null - */ - private $usage = StoredPaymentSourceUsageType::DERIVED; - - /** - * @var NetworkTransactionReference|null - */ - private $previousNetworkTransactionReference; - - /** - * @param string $paymentInitiator - * @param string $paymentType - */ - public function __construct(string $paymentInitiator, string $paymentType) - { - $this->paymentInitiator = $paymentInitiator; - $this->paymentType = $paymentType; - } - - /** - * 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 Payment Type. - * Indicates the type of the stored payment_source payment. - */ - public function getPaymentType(): string - { - return $this->paymentType; - } - - /** - * Sets Payment Type. - * Indicates the type of the stored payment_source payment. - * - * @required - * @maps payment_type - */ - public function setPaymentType(string $paymentType): void - { - $this->paymentType = $paymentType; - } - - /** - * 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; - } - - /** - * Returns Previous Network Transaction Reference. - * Reference values used by the card network to identify a transaction. - */ - public function getPreviousNetworkTransactionReference(): ?NetworkTransactionReference - { - return $this->previousNetworkTransactionReference; - } - - /** - * Sets Previous Network Transaction Reference. - * Reference values used by the card network to identify a transaction. - * - * @maps previous_network_transaction_reference - */ - public function setPreviousNetworkTransactionReference( - ?NetworkTransactionReference $previousNetworkTransactionReference - ): void { - $this->previousNetworkTransactionReference = $previousNetworkTransactionReference; - } - - /** - * 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'] = PaymentInitiator::checkValue($this->paymentInitiator); - $json['payment_type'] = - StoredPaymentSourcePaymentType::checkValue( - $this->paymentType - ); - if (isset($this->usage)) { - $json['usage'] = StoredPaymentSourceUsageType::checkValue($this->usage); - } - if (isset($this->previousNetworkTransactionReference)) { - $json['previous_network_transaction_reference'] = $this->previousNetworkTransactionReference; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/CardSupplementaryData.php b/src/Models/CardSupplementaryData.php deleted file mode 100644 index 8f00f42..0000000 --- a/src/Models/CardSupplementaryData.php +++ /dev/null @@ -1,102 +0,0 @@ -checkout or multiparty checkout. - */ -class CardSupplementaryData implements \JsonSerializable -{ - /** - * @var Level2CardProcessingData|null - */ - private $level2; - - /** - * @var Level3CardProcessingData|null - */ - private $level3; - - /** - * Returns Level 2. - * The level 2 card processing data collections. If your merchant account has been configured for Level - * 2 processing this field will be passed to the processor on your behalf. Please contact your PayPal - * Technical Account Manager to define level 2 data for your business. - */ - public function getLevel2(): ?Level2CardProcessingData - { - return $this->level2; - } - - /** - * Sets Level 2. - * The level 2 card processing data collections. If your merchant account has been configured for Level - * 2 processing this field will be passed to the processor on your behalf. Please contact your PayPal - * Technical Account Manager to define level 2 data for your business. - * - * @maps level_2 - */ - public function setLevel2(?Level2CardProcessingData $level2): void - { - $this->level2 = $level2; - } - - /** - * Returns Level 3. - * The level 3 card processing data collections, If your merchant account has been configured for Level - * 3 processing this field will be passed to the processor on your behalf. Please contact your PayPal - * Technical Account Manager to define level 3 data for your business. - */ - public function getLevel3(): ?Level3CardProcessingData - { - return $this->level3; - } - - /** - * Sets Level 3. - * The level 3 card processing data collections, If your merchant account has been configured for Level - * 3 processing this field will be passed to the processor on your behalf. Please contact your PayPal - * Technical Account Manager to define level 3 data for your business. - * - * @maps level_3 - */ - public function setLevel3(?Level3CardProcessingData $level3): void - { - $this->level3 = $level3; - } - - /** - * 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->level2)) { - $json['level_2'] = $this->level2; - } - if (isset($this->level3)) { - $json['level_3'] = $this->level3; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/CardType.php b/src/Models/CardType.php deleted file mode 100644 index 59cd646..0000000 --- a/src/Models/CardType.php +++ /dev/null @@ -1,51 +0,0 @@ -method; - } - - /** - * Sets Method. - * The method used for card verification. - * - * @maps method - */ - public function setMethod(?string $method): void - { - $this->method = $method; - } - - /** - * 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->method)) { - $json['method'] = CardVerificationMethod::checkValue($this->method); - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/CardVerificationDetails.php b/src/Models/CardVerificationDetails.php deleted file mode 100644 index d25ba34..0000000 --- a/src/Models/CardVerificationDetails.php +++ /dev/null @@ -1,211 +0,0 @@ -networkTransactionId; - } - - /** - * Sets Network Transaction Id. - * Transaction Identifier as given by the network to indicate a previously executed CIT authorization. - * Only present when authorization is successful for a verification. - * - * @maps network_transaction_id - */ - public function setNetworkTransactionId(?string $networkTransactionId): void - { - $this->networkTransactionId = $networkTransactionId; - } - - /** - * Returns Date. - * The date that the transaction was authorized by the scheme. This field may not be returned for all - * networks. MasterCard refers to this field as "BankNet reference date". - */ - public function getDate(): ?string - { - return $this->date; - } - - /** - * Sets Date. - * The date that the transaction was authorized by the scheme. This field may not be returned for all - * networks. MasterCard refers to this field as "BankNet reference date". - * - * @maps date - */ - public function setDate(?string $date): void - { - $this->date = $date; - } - - /** - * Returns Network. - * The card network or brand. Applies to credit, debit, gift, and payment cards. - */ - public function getNetwork(): ?string - { - return $this->network; - } - - /** - * Sets Network. - * The card network or brand. Applies to credit, debit, gift, and payment cards. - * - * @maps network - */ - public function setNetwork(?string $network): void - { - $this->network = $network; - } - - /** - * 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.
Note: - * The regular expression provides guidance but does not reject all invalid dates.
- */ - public function getTime(): ?string - { - return $this->time; - } - - /** - * 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.
- * - * @maps time - */ - public function setTime(?string $time): void - { - $this->time = $time; - } - - /** - * 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 Processor Response. - * The processor response information for payment requests, such as direct credit card transactions. - */ - public function getProcessorResponse(): ?CardVerificationProcessorResponse - { - 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(?CardVerificationProcessorResponse $processorResponse): void - { - $this->processorResponse = $processorResponse; - } - - /** - * 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->networkTransactionId)) { - $json['network_transaction_id'] = $this->networkTransactionId; - } - if (isset($this->date)) { - $json['date'] = $this->date; - } - if (isset($this->network)) { - $json['network'] = CardBrand::checkValue($this->network); - } - if (isset($this->time)) { - $json['time'] = $this->time; - } - if (isset($this->amount)) { - $json['amount'] = $this->amount; - } - if (isset($this->processorResponse)) { - $json['processor_response'] = $this->processorResponse; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/CardVerificationMethod.php b/src/Models/CardVerificationMethod.php deleted file mode 100644 index ce0ae32..0000000 --- a/src/Models/CardVerificationMethod.php +++ /dev/null @@ -1,49 +0,0 @@ -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; - } - - /** - * 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'] = AVSCode::checkValue($this->avsCode); - } - if (isset($this->cvvCode)) { - $json['cvv_code'] = CVVCode::checkValue($this->cvvCode); - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/CheckoutPaymentIntent.php b/src/Models/CheckoutPaymentIntent.php deleted file mode 100644 index 9f627ad..0000000 --- a/src/Models/CheckoutPaymentIntent.php +++ /dev/null @@ -1,46 +0,0 @@ -labels; - } - - /** - * Sets Labels. - * Array of labels for the cobranded card. - * - * @maps labels - * - * @param string[]|null $labels - */ - public function setLabels(?array $labels): void - { - $this->labels = $labels; - } - - /** - * Returns Payee. - * The details for the merchant who receives the funds and fulfills the order. The merchant is also - * known as the payee. - */ - public function getPayee(): ?PayeeBase - { - return $this->payee; - } - - /** - * Sets Payee. - * The details for the merchant who receives the funds and fulfills the order. The merchant is also - * known as the payee. - * - * @maps payee - */ - public function setPayee(?PayeeBase $payee): void - { - $this->payee = $payee; - } - - /** - * 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; - } - - /** - * 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->labels)) { - $json['labels'] = $this->labels; - } - if (isset($this->payee)) { - $json['payee'] = $this->payee; - } - if (isset($this->amount)) { - $json['amount'] = $this->amount; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/ConfirmOrderRequest.php b/src/Models/ConfirmOrderRequest.php deleted file mode 100644 index f8810d6..0000000 --- a/src/Models/ConfirmOrderRequest.php +++ /dev/null @@ -1,126 +0,0 @@ -paymentSource = $paymentSource; - } - - /** - * Returns Payment Source. - * The payment source definition. - */ - public function getPaymentSource(): PaymentSource - { - return $this->paymentSource; - } - - /** - * Sets Payment Source. - * The payment source definition. - * - * @required - * @maps payment_source - */ - public function setPaymentSource(PaymentSource $paymentSource): void - { - $this->paymentSource = $paymentSource; - } - - /** - * Returns Processing Instruction. - * The instruction to process an order. - */ - public function getProcessingInstruction(): ?string - { - return $this->processingInstruction; - } - - /** - * Sets Processing Instruction. - * The instruction to process an order. - * - * @maps processing_instruction - */ - public function setProcessingInstruction(?string $processingInstruction): void - { - $this->processingInstruction = $processingInstruction; - } - - /** - * Returns Application Context. - * Customizes the payer confirmation experience. - */ - public function getApplicationContext(): ?OrderConfirmApplicationContext - { - return $this->applicationContext; - } - - /** - * Sets Application Context. - * Customizes the payer confirmation experience. - * - * @maps application_context - */ - public function setApplicationContext(?OrderConfirmApplicationContext $applicationContext): void - { - $this->applicationContext = $applicationContext; - } - - /** - * 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_source'] = $this->paymentSource; - if (isset($this->processingInstruction)) { - $json['processing_instruction'] = ProcessingInstruction::checkValue($this->processingInstruction); - } - if (isset($this->applicationContext)) { - $json['application_context'] = $this->applicationContext; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/CustomerInformation.php b/src/Models/CustomerInformation.php deleted file mode 100644 index 83e8323..0000000 --- a/src/Models/CustomerInformation.php +++ /dev/null @@ -1,125 +0,0 @@ -id; - } - - /** - * Sets Id. - * The unique ID for a customer generated by PayPal. - * - * @maps id - */ - public function setId(?string $id): void - { - $this->id = $id; - } - - /** - * 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. - * The phone information. - */ - public function getPhone(): ?PhoneWithType - { - return $this->phone; - } - - /** - * Sets Phone. - * The phone information. - * - * @maps phone - */ - public function setPhone(?PhoneWithType $phone): void - { - $this->phone = $phone; - } - - /** - * 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->emailAddress)) { - $json['email_address'] = $this->emailAddress; - } - if (isset($this->phone)) { - $json['phone'] = $this->phone; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/CustomerRequest.php b/src/Models/CustomerRequest.php deleted file mode 100644 index e83e95c..0000000 --- a/src/Models/CustomerRequest.php +++ /dev/null @@ -1,95 +0,0 @@ -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; - } - - /** - * 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 deleted file mode 100644 index 0ac3a21..0000000 --- a/src/Models/CustomerVaultPaymentTokensResponse.php +++ /dev/null @@ -1,181 +0,0 @@ -totalItems; - } - - /** - * Sets Total Items. - * Total number of items. - * - * @maps total_items - */ - public function setTotalItems(?int $totalItems): void - { - $this->totalItems = $totalItems; - } - - /** - * Returns Total Pages. - * Total number of pages. - */ - public function getTotalPages(): ?int - { - return $this->totalPages; - } - - /** - * Sets Total Pages. - * Total number of pages. - * - * @maps total_pages - */ - public function setTotalPages(?int $totalPages): void - { - $this->totalPages = $totalPages; - } - - /** - * Returns Customer. - * Customer in merchant's or partner's system of records. - */ - public function getCustomer(): ?CustomerRequest - { - return $this->customer; - } - - /** - * Sets Customer. - * Customer in merchant's or partner's system of records. - * - * @maps customer - */ - public function setCustomer(?CustomerRequest $customer): void - { - $this->customer = $customer; - } - - /** - * Returns Payment Tokens. - * - * @return PaymentTokenResponse[]|null - */ - public function getPaymentTokens(): ?array - { - return $this->paymentTokens; - } - - /** - * Sets Payment Tokens. - * - * @maps payment_tokens - * - * @param PaymentTokenResponse[]|null $paymentTokens - */ - public function setPaymentTokens(?array $paymentTokens): void - { - $this->paymentTokens = $paymentTokens; - } - - /** - * Returns Links. - * An array of related [HATEOAS links](/api/rest/responses/#hateoas). - * - * @return LinkDescription[]|null - */ - public function getLinks(): ?array - { - return $this->links; - } - - /** - * Sets Links. - * An array of related [HATEOAS links](/api/rest/responses/#hateoas). - * - * @maps links - * - * @param LinkDescription[]|null $links - */ - public function setLinks(?array $links): void - { - $this->links = $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->totalItems)) { - $json['total_items'] = $this->totalItems; - } - if (isset($this->totalPages)) { - $json['total_pages'] = $this->totalPages; - } - if (isset($this->customer)) { - $json['customer'] = $this->customer; - } - if (isset($this->paymentTokens)) { - $json['payment_tokens'] = $this->paymentTokens; - } - if (isset($this->links)) { - $json['links'] = $this->links; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/DisbursementMode.php b/src/Models/DisbursementMode.php deleted file mode 100644 index dfb534e..0000000 --- a/src/Models/DisbursementMode.php +++ /dev/null @@ -1,45 +0,0 @@ -name; - } - - /** - * Sets Name. - * The full name representation like Mr J Smith. - * - * @maps name - */ - public function setName(?string $name): void - { - $this->name = $name; - } - - /** - * 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 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 [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 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 - */ - public function setCountryCode(?string $countryCode): void - { - $this->countryCode = $countryCode; - } - - /** - * Returns Bic. - * The business identification code (BIC). In payments systems, a BIC is used to identify a specific - * business, most commonly a bank. - */ - public function getBic(): ?string - { - return $this->bic; - } - - /** - * Sets Bic. - * The business identification code (BIC). In payments systems, a BIC is used to identify a specific - * business, most commonly a bank. - * - * @maps bic - */ - public function setBic(?string $bic): void - { - $this->bic = $bic; - } - - /** - * 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->countryCode)) { - $json['country_code'] = $this->countryCode; - } - if (isset($this->bic)) { - $json['bic'] = $this->bic; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/EPSPaymentRequest.php b/src/Models/EPSPaymentRequest.php deleted file mode 100644 index 2b81374..0000000 --- a/src/Models/EPSPaymentRequest.php +++ /dev/null @@ -1,135 +0,0 @@ -name = $name; - $this->countryCode = $countryCode; - } - - /** - * Returns Name. - * The full name representation like Mr J Smith. - */ - public function getName(): string - { - return $this->name; - } - - /** - * Sets Name. - * The full name representation like Mr J Smith. - * - * @required - * @maps name - */ - public function setName(string $name): void - { - $this->name = $name; - } - - /** - * 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 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 [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 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; - } - - /** - * Returns Experience Context. - * Customizes the payer experience during the approval process for the payment. - */ - public function getExperienceContext(): ?ExperienceContext - { - return $this->experienceContext; - } - - /** - * Sets Experience Context. - * Customizes the payer experience during the approval process for the payment. - * - * @maps experience_context - */ - public function setExperienceContext(?ExperienceContext $experienceContext): void - { - $this->experienceContext = $experienceContext; - } - - /** - * 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; - $json['country_code'] = $this->countryCode; - if (isset($this->experienceContext)) { - $json['experience_context'] = $this->experienceContext; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/EnrollmentStatus.php b/src/Models/EnrollmentStatus.php deleted file mode 100644 index 2a7b580..0000000 --- a/src/Models/EnrollmentStatus.php +++ /dev/null @@ -1,49 +0,0 @@ -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 Location. - * The location of the field that caused the error. Value is `body`, `path`, or `query`. - */ - public function getLocation(): ?string - { - return $this->location; - } - - /** - * Sets Location. - * The location of the field that caused the error. Value is `body`, `path`, or `query`. - * - * @maps location - */ - public function setLocation(?string $location): void - { - $this->location = $location; - } - - /** - * 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; - } - - /** - * Returns Links. - * An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links) that are either - * relevant to the issue by providing additional information or offering potential resolutions. - * - * @return LinkDescription[]|null - */ - public function getLinks(): ?array - { - return $this->links; - } - - /** - * Sets Links. - * An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links) that are either - * relevant to the issue by providing additional information or offering potential resolutions. - * - * @maps links - * - * @param LinkDescription[]|null $links - */ - public function setLinks(?array $links): void - { - $this->links = $links; - } - - /** - * Returns Description. - * The human-readable description for an issue. The description can change over the lifetime of an API, - * so clients must not depend on this value. - */ - public function getDescription(): ?string - { - return $this->description; - } - - /** - * Sets Description. - * The human-readable description for an issue. The description can change over the lifetime of an API, - * so clients must not depend on this value. - * - * @maps description - */ - public function setDescription(?string $description): void - { - $this->description = $description; - } - - /** - * 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; - } - if (isset($this->location)) { - $json['location'] = $this->location; - } - $json['issue'] = $this->issue; - if (isset($this->links)) { - $json['links'] = $this->links; - } - if (isset($this->description)) { - $json['description'] = $this->description; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/ExchangeRate.php b/src/Models/ExchangeRate.php deleted file mode 100644 index 2b413af..0000000 --- a/src/Models/ExchangeRate.php +++ /dev/null @@ -1,125 +0,0 @@ -sourceCurrency; - } - - /** - * Sets Source Currency. - * The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies - * the currency. - * - * @maps source_currency - */ - public function setSourceCurrency(?string $sourceCurrency): void - { - $this->sourceCurrency = $sourceCurrency; - } - - /** - * Returns Target Currency. - * The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies - * the currency. - */ - public function getTargetCurrency(): ?string - { - return $this->targetCurrency; - } - - /** - * Sets Target Currency. - * The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies - * the currency. - * - * @maps target_currency - */ - public function setTargetCurrency(?string $targetCurrency): void - { - $this->targetCurrency = $targetCurrency; - } - - /** - * Returns Value. - * The target currency amount. Equivalent to one unit of the source currency. Formatted as integer or - * decimal value with one to 15 digits to the right of the decimal point. - */ - public function getValue(): ?string - { - return $this->value; - } - - /** - * Sets Value. - * The target currency amount. Equivalent to one unit of the source currency. Formatted as integer or - * decimal value with one to 15 digits to the right of the decimal point. - * - * @maps value - */ - public function setValue(?string $value): void - { - $this->value = $value; - } - - /** - * 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->sourceCurrency)) { - $json['source_currency'] = $this->sourceCurrency; - } - if (isset($this->targetCurrency)) { - $json['target_currency'] = $this->targetCurrency; - } - if (isset($this->value)) { - $json['value'] = $this->value; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/ExperienceContext.php b/src/Models/ExperienceContext.php deleted file mode 100644 index c471ff2..0000000 --- a/src/Models/ExperienceContext.php +++ /dev/null @@ -1,187 +0,0 @@ -brandName; - } - - /** - * Sets Brand Name. - * 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. - * - * @maps brand_name - */ - public function setBrandName(?string $brandName): void - { - $this->brandName = $brandName; - } - - /** - * Returns Locale. - * 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/). - */ - public function getLocale(): ?string - { - return $this->locale; - } - - /** - * Sets Locale. - * 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/). - * - * @maps locale - */ - public function setLocale(?string $locale): void - { - $this->locale = $locale; - } - - /** - * Returns Shipping Preference. - * The location from which the shipping address is derived. - */ - public function getShippingPreference(): ?string - { - return $this->shippingPreference; - } - - /** - * Sets Shipping Preference. - * The location from which the shipping address is derived. - * - * @maps shipping_preference - */ - public function setShippingPreference(?string $shippingPreference): void - { - $this->shippingPreference = $shippingPreference; - } - - /** - * Returns Return Url. - * Describes the URL. - */ - public function getReturnUrl(): ?string - { - return $this->returnUrl; - } - - /** - * Sets Return Url. - * Describes the URL. - * - * @maps return_url - */ - public function setReturnUrl(?string $returnUrl): void - { - $this->returnUrl = $returnUrl; - } - - /** - * Returns Cancel Url. - * Describes the URL. - */ - public function getCancelUrl(): ?string - { - return $this->cancelUrl; - } - - /** - * Sets Cancel Url. - * Describes the URL. - * - * @maps cancel_url - */ - public function setCancelUrl(?string $cancelUrl): void - { - $this->cancelUrl = $cancelUrl; - } - - /** - * 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->brandName)) { - $json['brand_name'] = $this->brandName; - } - if (isset($this->locale)) { - $json['locale'] = $this->locale; - } - if (isset($this->shippingPreference)) { - $json['shipping_preference'] = ShippingPreference::checkValue($this->shippingPreference); - } - if (isset($this->returnUrl)) { - $json['return_url'] = $this->returnUrl; - } - if (isset($this->cancelUrl)) { - $json['cancel_url'] = $this->cancelUrl; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/FullfillmentType.php b/src/Models/FullfillmentType.php deleted file mode 100644 index 9cab1cc..0000000 --- a/src/Models/FullfillmentType.php +++ /dev/null @@ -1,51 +0,0 @@ -name; - } - - /** - * Sets Name. - * The full name representation like Mr J Smith. - * - * @maps name - */ - public function setName(?string $name): void - { - $this->name = $name; - } - - /** - * 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 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 [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 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 - */ - public function setCountryCode(?string $countryCode): void - { - $this->countryCode = $countryCode; - } - - /** - * Returns Bic. - * The business identification code (BIC). In payments systems, a BIC is used to identify a specific - * business, most commonly a bank. - */ - public function getBic(): ?string - { - return $this->bic; - } - - /** - * Sets Bic. - * The business identification code (BIC). In payments systems, a BIC is used to identify a specific - * business, most commonly a bank. - * - * @maps bic - */ - public function setBic(?string $bic): void - { - $this->bic = $bic; - } - - /** - * 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->countryCode)) { - $json['country_code'] = $this->countryCode; - } - if (isset($this->bic)) { - $json['bic'] = $this->bic; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/GiropayPaymentRequest.php b/src/Models/GiropayPaymentRequest.php deleted file mode 100644 index 1a04ca7..0000000 --- a/src/Models/GiropayPaymentRequest.php +++ /dev/null @@ -1,135 +0,0 @@ -name = $name; - $this->countryCode = $countryCode; - } - - /** - * Returns Name. - * The full name representation like Mr J Smith. - */ - public function getName(): string - { - return $this->name; - } - - /** - * Sets Name. - * The full name representation like Mr J Smith. - * - * @required - * @maps name - */ - public function setName(string $name): void - { - $this->name = $name; - } - - /** - * 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 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 [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 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; - } - - /** - * Returns Experience Context. - * Customizes the payer experience during the approval process for the payment. - */ - public function getExperienceContext(): ?ExperienceContext - { - return $this->experienceContext; - } - - /** - * Sets Experience Context. - * Customizes the payer experience during the approval process for the payment. - * - * @maps experience_context - */ - public function setExperienceContext(?ExperienceContext $experienceContext): void - { - $this->experienceContext = $experienceContext; - } - - /** - * 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; - $json['country_code'] = $this->countryCode; - if (isset($this->experienceContext)) { - $json['experience_context'] = $this->experienceContext; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/GooglePayAuthenticationMethod.php b/src/Models/GooglePayAuthenticationMethod.php deleted file mode 100644 index 713abb2..0000000 --- a/src/Models/GooglePayAuthenticationMethod.php +++ /dev/null @@ -1,45 +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 deleted file mode 100644 index 4a7c4b9..0000000 --- a/src/Models/GooglePayCardResponse.php +++ /dev/null @@ -1,209 +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 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 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 Billing 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 getBillingAddress(): ?Address - { - return $this->billingAddress; - } - - /** - * Sets Billing 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). - * - * @maps billing_address - */ - public function setBillingAddress(?Address $billingAddress): void - { - $this->billingAddress = $billingAddress; - } - - /** - * Returns Authentication Result. - * Results of Authentication such as 3D Secure. - */ - public function getAuthenticationResult(): ?AuthenticationResponse - { - return $this->authenticationResult; - } - - /** - * Sets Authentication Result. - * Results of Authentication such as 3D Secure. - * - * @maps authentication_result - */ - public function setAuthenticationResult(?AuthenticationResponse $authenticationResult): void - { - $this->authenticationResult = $authenticationResult; - } - - /** - * 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->type)) { - $json['type'] = CardType::checkValue($this->type); - } - if (isset($this->brand)) { - $json['brand'] = CardBrand::checkValue($this->brand); - } - if (isset($this->billingAddress)) { - $json['billing_address'] = $this->billingAddress; - } - if (isset($this->authenticationResult)) { - $json['authentication_result'] = $this->authenticationResult; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/GooglePayDecryptedTokenData.php b/src/Models/GooglePayDecryptedTokenData.php deleted file mode 100644 index 42b60d8..0000000 --- a/src/Models/GooglePayDecryptedTokenData.php +++ /dev/null @@ -1,218 +0,0 @@ -paymentMethod = $paymentMethod; - $this->authenticationMethod = $authenticationMethod; - } - - /** - * Returns Message Id. - * A unique ID that identifies the message in case it needs to be revoked or located at a later time. - */ - public function getMessageId(): ?string - { - return $this->messageId; - } - - /** - * Sets Message Id. - * A unique ID that identifies the message in case it needs to be revoked or located at a later time. - * - * @maps message_id - */ - public function setMessageId(?string $messageId): void - { - $this->messageId = $messageId; - } - - /** - * Returns Message Expiration. - * Date and time at which the message expires as UTC milliseconds since epoch. Integrators should - * reject any message that's expired. - */ - public function getMessageExpiration(): ?string - { - return $this->messageExpiration; - } - - /** - * Sets Message Expiration. - * Date and time at which the message expires as UTC milliseconds since epoch. Integrators should - * reject any message that's expired. - * - * @maps message_expiration - */ - public function setMessageExpiration(?string $messageExpiration): void - { - $this->messageExpiration = $messageExpiration; - } - - /** - * Returns Payment Method. - * The type of the payment credential. Currently, only CARD is supported. - */ - public function getPaymentMethod(): string - { - return $this->paymentMethod; - } - - /** - * Sets Payment Method. - * The type of the payment credential. Currently, only CARD is supported. - * - * @required - * @maps payment_method - */ - public function setPaymentMethod(string $paymentMethod): void - { - $this->paymentMethod = $paymentMethod; - } - - /** - * Returns Authentication Method. - * Authentication Method which is used for the card transaction. - */ - public function getAuthenticationMethod(): string - { - return $this->authenticationMethod; - } - - /** - * Sets Authentication Method. - * Authentication Method which is used for the card transaction. - * - * @required - * @maps authentication_method - */ - public function setAuthenticationMethod(string $authenticationMethod): void - { - $this->authenticationMethod = $authenticationMethod; - } - - /** - * Returns Cryptogram. - * Base-64 cryptographic identifier used by card schemes to validate the token verification result. - * This is a conditionally required field if authentication_method is CRYPTOGRAM_3DS. - */ - public function getCryptogram(): ?string - { - return $this->cryptogram; - } - - /** - * Sets Cryptogram. - * Base-64 cryptographic identifier used by card schemes to validate the token verification result. - * This is a conditionally required field if authentication_method is CRYPTOGRAM_3DS. - * - * @maps cryptogram - */ - public function setCryptogram(?string $cryptogram): void - { - $this->cryptogram = $cryptogram; - } - - /** - * Returns Eci Indicator. - * Electronic Commerce Indicator may not always be present. It is only returned for tokens on the Visa - * card network. This value is passed through in the payment authorization request. - */ - public function getEciIndicator(): ?string - { - return $this->eciIndicator; - } - - /** - * Sets Eci Indicator. - * Electronic Commerce Indicator may not always be present. It is only returned for tokens on the Visa - * card network. This value is passed through in the payment authorization request. - * - * @maps eci_indicator - */ - public function setEciIndicator(?string $eciIndicator): void - { - $this->eciIndicator = $eciIndicator; - } - - /** - * 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->messageId)) { - $json['message_id'] = $this->messageId; - } - if (isset($this->messageExpiration)) { - $json['message_expiration'] = $this->messageExpiration; - } - $json['payment_method'] = GooglePayPaymentMethod::checkValue($this->paymentMethod); - $json['authentication_method'] = GooglePayAuthenticationMethod::checkValue($this->authenticationMethod); - if (isset($this->cryptogram)) { - $json['cryptogram'] = $this->cryptogram; - } - if (isset($this->eciIndicator)) { - $json['eci_indicator'] = $this->eciIndicator; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/GooglePayPaymentMethod.php b/src/Models/GooglePayPaymentMethod.php deleted file mode 100644 index 622a9d8..0000000 --- a/src/Models/GooglePayPaymentMethod.php +++ /dev/null @@ -1,43 +0,0 @@ -name; - } - - /** - * Sets Name. - * The full name representation like Mr J Smith. - * - * @maps name - */ - public function setName(?string $name): void - { - $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. - * 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 Card. - * The payment card information. - * - * @return mixed - */ - public function getCard() - { - return $this->card; - } - - /** - * Sets Card. - * The payment card information. - * - * @maps card - * - * @param mixed $card - */ - public function setCard($card): void - { - $this->card = $card; - } - - /** - * Returns Decrypted Token. - * Details shared by Google for the merchant to be shared with PayPal. This is required to process the - * transaction using the Google Pay payment method. - */ - public function getDecryptedToken(): ?GooglePayDecryptedTokenData - { - return $this->decryptedToken; - } - - /** - * Sets Decrypted Token. - * Details shared by Google for the merchant to be shared with PayPal. This is required to process the - * transaction using the Google Pay payment method. - * - * @maps decrypted_token - */ - public function setDecryptedToken(?GooglePayDecryptedTokenData $decryptedToken): void - { - $this->decryptedToken = $decryptedToken; - } - - /** - * Returns Assurance Details. - * - * @return mixed - */ - public function getAssuranceDetails() - { - return $this->assuranceDetails; - } - - /** - * Sets Assurance Details. - * - * @maps assurance_details - * - * @param mixed $assuranceDetails - */ - public function setAssuranceDetails($assuranceDetails): void - { - $this->assuranceDetails = $assuranceDetails; - } - - /** - * 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. - * - * @maps attributes - */ - public function setAttributes(?GooglePayCardAttributes $attributes): void - { - $this->attributes = $attributes; - } - - /** - * 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->emailAddress)) { - $json['email_address'] = $this->emailAddress; - } - if (isset($this->phoneNumber)) { - $json['phone_number'] = $this->phoneNumber; - } - if (isset($this->card)) { - $json['card'] = $this->card; - } - if (isset($this->decryptedToken)) { - $json['decrypted_token'] = $this->decryptedToken; - } - 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/GooglePayWalletResponse.php b/src/Models/GooglePayWalletResponse.php deleted file mode 100644 index 624ee4a..0000000 --- a/src/Models/GooglePayWalletResponse.php +++ /dev/null @@ -1,155 +0,0 @@ -name; - } - - /** - * Sets Name. - * The full name representation like Mr J Smith. - * - * @maps name - */ - public function setName(?string $name): void - { - $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. - * 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 Card. - * The payment card to use to fund a Google Pay payment response. Can be a credit or debit card. - */ - public function getCard(): ?GooglePayCardResponse - { - return $this->card; - } - - /** - * Sets Card. - * The payment card to use to fund a Google Pay payment response. Can be a credit or debit card. - * - * @maps card - */ - public function setCard(?GooglePayCardResponse $card): void - { - $this->card = $card; - } - - /** - * 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->emailAddress)) { - $json['email_address'] = $this->emailAddress; - } - if (isset($this->phoneNumber)) { - $json['phone_number'] = $this->phoneNumber; - } - if (isset($this->card)) { - $json['card'] = $this->card; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/IDEALPaymentObject.php b/src/Models/IDEALPaymentObject.php deleted file mode 100644 index ed554a0..0000000 --- a/src/Models/IDEALPaymentObject.php +++ /dev/null @@ -1,157 +0,0 @@ -name; - } - - /** - * Sets Name. - * The full name representation like Mr J Smith. - * - * @maps name - */ - public function setName(?string $name): void - { - $this->name = $name; - } - - /** - * 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 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 [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 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 - */ - public function setCountryCode(?string $countryCode): void - { - $this->countryCode = $countryCode; - } - - /** - * Returns Bic. - * The business identification code (BIC). In payments systems, a BIC is used to identify a specific - * business, most commonly a bank. - */ - public function getBic(): ?string - { - return $this->bic; - } - - /** - * Sets Bic. - * The business identification code (BIC). In payments systems, a BIC is used to identify a specific - * business, most commonly a bank. - * - * @maps bic - */ - public function setBic(?string $bic): void - { - $this->bic = $bic; - } - - /** - * Returns Iban Last Chars. - * The last characters of the IBAN used to pay. - */ - public function getIbanLastChars(): ?string - { - return $this->ibanLastChars; - } - - /** - * Sets Iban Last Chars. - * The last characters of the IBAN used to pay. - * - * @maps iban_last_chars - */ - public function setIbanLastChars(?string $ibanLastChars): void - { - $this->ibanLastChars = $ibanLastChars; - } - - /** - * 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->countryCode)) { - $json['country_code'] = $this->countryCode; - } - if (isset($this->bic)) { - $json['bic'] = $this->bic; - } - if (isset($this->ibanLastChars)) { - $json['iban_last_chars'] = $this->ibanLastChars; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/IDEALPaymentRequest.php b/src/Models/IDEALPaymentRequest.php deleted file mode 100644 index 9b283e7..0000000 --- a/src/Models/IDEALPaymentRequest.php +++ /dev/null @@ -1,165 +0,0 @@ -name = $name; - $this->countryCode = $countryCode; - } - - /** - * Returns Name. - * The full name representation like Mr J Smith. - */ - public function getName(): string - { - return $this->name; - } - - /** - * Sets Name. - * The full name representation like Mr J Smith. - * - * @required - * @maps name - */ - public function setName(string $name): void - { - $this->name = $name; - } - - /** - * 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 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 [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 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; - } - - /** - * Returns Bic. - * The business identification code (BIC). In payments systems, a BIC is used to identify a specific - * business, most commonly a bank. - */ - public function getBic(): ?string - { - return $this->bic; - } - - /** - * Sets Bic. - * The business identification code (BIC). In payments systems, a BIC is used to identify a specific - * business, most commonly a bank. - * - * @maps bic - */ - public function setBic(?string $bic): void - { - $this->bic = $bic; - } - - /** - * Returns Experience Context. - * Customizes the payer experience during the approval process for the payment. - */ - public function getExperienceContext(): ?ExperienceContext - { - return $this->experienceContext; - } - - /** - * Sets Experience Context. - * Customizes the payer experience during the approval process for the payment. - * - * @maps experience_context - */ - public function setExperienceContext(?ExperienceContext $experienceContext): void - { - $this->experienceContext = $experienceContext; - } - - /** - * 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; - $json['country_code'] = $this->countryCode; - if (isset($this->bic)) { - $json['bic'] = $this->bic; - } - if (isset($this->experienceContext)) { - $json['experience_context'] = $this->experienceContext; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/InstrumentAuthorizationStatus.php b/src/Models/InstrumentAuthorizationStatus.php deleted file mode 100644 index fa48380..0000000 --- a/src/Models/InstrumentAuthorizationStatus.php +++ /dev/null @@ -1,61 +0,0 @@ -name = $name; - $this->unitAmount = $unitAmount; - $this->quantity = $quantity; - } - - /** - * Returns Name. - * The item name or title. - */ - public function getName(): string - { - return $this->name; - } - - /** - * Sets Name. - * The item name or title. - * - * @required - * @maps name - */ - public function setName(string $name): void - { - $this->name = $name; - } - - /** - * Returns Unit Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getUnitAmount(): Money - { - return $this->unitAmount; - } - - /** - * Sets Unit Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @required - * @maps unit_amount - */ - public function setUnitAmount(Money $unitAmount): void - { - $this->unitAmount = $unitAmount; - } - - /** - * Returns Tax. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getTax(): ?Money - { - return $this->tax; - } - - /** - * Sets Tax. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps tax - */ - public function setTax(?Money $tax): void - { - $this->tax = $tax; - } - - /** - * Returns Quantity. - * The item quantity. Must be a whole number. - */ - public function getQuantity(): string - { - return $this->quantity; - } - - /** - * Sets Quantity. - * The item quantity. Must be a whole number. - * - * @required - * @maps quantity - */ - public function setQuantity(string $quantity): void - { - $this->quantity = $quantity; - } - - /** - * Returns Description. - * The detailed item description. - */ - public function getDescription(): ?string - { - return $this->description; - } - - /** - * Sets Description. - * The detailed item description. - * - * @maps description - */ - public function setDescription(?string $description): void - { - $this->description = $description; - } - - /** - * Returns Sku. - * The stock keeping unit (SKU) for the item. - */ - public function getSku(): ?string - { - return $this->sku; - } - - /** - * Sets Sku. - * The stock keeping unit (SKU) for the item. - * - * @maps sku - */ - public function setSku(?string $sku): void - { - $this->sku = $sku; - } - - /** - * Returns Url. - * The URL to the item being purchased. Visible to buyer and used in buyer experiences. - */ - public function getUrl(): ?string - { - return $this->url; - } - - /** - * Sets Url. - * The URL to the item being purchased. Visible to buyer and used in buyer experiences. - * - * @maps url - */ - public function setUrl(?string $url): void - { - $this->url = $url; - } - - /** - * Returns Category. - * The item category type. - */ - public function getCategory(): ?string - { - return $this->category; - } - - /** - * Sets Category. - * The item category type. - * - * @maps category - */ - public function setCategory(?string $category): void - { - $this->category = $category; - } - - /** - * Returns Image Url. - * The URL of the item's image. File type and size restrictions apply. An image that violates these - * restrictions will not be honored. - */ - public function getImageUrl(): ?string - { - return $this->imageUrl; - } - - /** - * Sets Image Url. - * The URL of the item's image. File type and size restrictions apply. An image that violates these - * restrictions will not be honored. - * - * @maps image_url - */ - public function setImageUrl(?string $imageUrl): void - { - $this->imageUrl = $imageUrl; - } - - /** - * Returns Upc. - * The Universal Product Code of the item. - */ - public function getUpc(): ?UniversalProductCode - { - return $this->upc; - } - - /** - * Sets Upc. - * The Universal Product Code of the item. - * - * @maps upc - */ - public function setUpc(?UniversalProductCode $upc): void - { - $this->upc = $upc; - } - - /** - * 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; - $json['unit_amount'] = $this->unitAmount; - if (isset($this->tax)) { - $json['tax'] = $this->tax; - } - $json['quantity'] = $this->quantity; - if (isset($this->description)) { - $json['description'] = $this->description; - } - if (isset($this->sku)) { - $json['sku'] = $this->sku; - } - if (isset($this->url)) { - $json['url'] = $this->url; - } - if (isset($this->category)) { - $json['category'] = ItemCategory::checkValue($this->category); - } - if (isset($this->imageUrl)) { - $json['image_url'] = $this->imageUrl; - } - if (isset($this->upc)) { - $json['upc'] = $this->upc; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/ItemCategory.php b/src/Models/ItemCategory.php deleted file mode 100644 index 74132fc..0000000 --- a/src/Models/ItemCategory.php +++ /dev/null @@ -1,47 +0,0 @@ -invoiceId; - } - - /** - * Sets Invoice Id. - * Use this field to pass a purchase identification value of up to 12 ASCII characters for AIB and 17 - * ASCII characters for all other processors. - * - * @maps invoice_id - */ - public function setInvoiceId(?string $invoiceId): void - { - $this->invoiceId = $invoiceId; - } - - /** - * Returns Tax Total. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getTaxTotal(): ?Money - { - return $this->taxTotal; - } - - /** - * Sets Tax Total. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps tax_total - */ - public function setTaxTotal(?Money $taxTotal): void - { - $this->taxTotal = $taxTotal; - } - - /** - * 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->invoiceId)) { - $json['invoice_id'] = $this->invoiceId; - } - if (isset($this->taxTotal)) { - $json['tax_total'] = $this->taxTotal; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/Level3CardProcessingData.php b/src/Models/Level3CardProcessingData.php deleted file mode 100644 index 7f87b87..0000000 --- a/src/Models/Level3CardProcessingData.php +++ /dev/null @@ -1,217 +0,0 @@ -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 Duty Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getDutyAmount(): ?Money - { - return $this->dutyAmount; - } - - /** - * Sets Duty Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps duty_amount - */ - public function setDutyAmount(?Money $dutyAmount): void - { - $this->dutyAmount = $dutyAmount; - } - - /** - * Returns Discount Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getDiscountAmount(): ?Money - { - return $this->discountAmount; - } - - /** - * Sets Discount Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps discount_amount - */ - public function setDiscountAmount(?Money $discountAmount): void - { - $this->discountAmount = $discountAmount; - } - - /** - * 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(): ?Address - { - 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). - * - * @maps shipping_address - */ - public function setShippingAddress(?Address $shippingAddress): void - { - $this->shippingAddress = $shippingAddress; - } - - /** - * Returns Ships From Postal Code. - * Use this field to specify the postal code of the shipping location. - */ - public function getShipsFromPostalCode(): ?string - { - return $this->shipsFromPostalCode; - } - - /** - * Sets Ships From Postal Code. - * Use this field to specify the postal code of the shipping location. - * - * @maps ships_from_postal_code - */ - public function setShipsFromPostalCode(?string $shipsFromPostalCode): void - { - $this->shipsFromPostalCode = $shipsFromPostalCode; - } - - /** - * Returns Line Items. - * A list of the items that were purchased with this payment. If your merchant account has been - * configured for Level 3 processing this field will be passed to the processor on your behalf. - * - * @return LineItem[]|null - */ - public function getLineItems(): ?array - { - return $this->lineItems; - } - - /** - * Sets Line Items. - * A list of the items that were purchased with this payment. If your merchant account has been - * configured for Level 3 processing this field will be passed to the processor on your behalf. - * - * @maps line_items - * - * @param LineItem[]|null $lineItems - */ - public function setLineItems(?array $lineItems): void - { - $this->lineItems = $lineItems; - } - - /** - * 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->shippingAmount)) { - $json['shipping_amount'] = $this->shippingAmount; - } - if (isset($this->dutyAmount)) { - $json['duty_amount'] = $this->dutyAmount; - } - if (isset($this->discountAmount)) { - $json['discount_amount'] = $this->discountAmount; - } - if (isset($this->shippingAddress)) { - $json['shipping_address'] = $this->shippingAddress; - } - if (isset($this->shipsFromPostalCode)) { - $json['ships_from_postal_code'] = $this->shipsFromPostalCode; - } - if (isset($this->lineItems)) { - $json['line_items'] = $this->lineItems; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/LiabilityShiftIndicator.php b/src/Models/LiabilityShiftIndicator.php deleted file mode 100644 index 107eda8..0000000 --- a/src/Models/LiabilityShiftIndicator.php +++ /dev/null @@ -1,47 +0,0 @@ -name = $name; - $this->unitAmount = $unitAmount; - $this->quantity = $quantity; - } - - /** - * Returns Name. - * The item name or title. - */ - public function getName(): string - { - return $this->name; - } - - /** - * Sets Name. - * The item name or title. - * - * @required - * @maps name - */ - public function setName(string $name): void - { - $this->name = $name; - } - - /** - * Returns Unit Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getUnitAmount(): Money - { - return $this->unitAmount; - } - - /** - * Sets Unit Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @required - * @maps unit_amount - */ - public function setUnitAmount(Money $unitAmount): void - { - $this->unitAmount = $unitAmount; - } - - /** - * Returns Tax. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getTax(): ?Money - { - return $this->tax; - } - - /** - * Sets Tax. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps tax - */ - public function setTax(?Money $tax): void - { - $this->tax = $tax; - } - - /** - * Returns Quantity. - * The item quantity. Must be a whole number. - */ - public function getQuantity(): string - { - return $this->quantity; - } - - /** - * Sets Quantity. - * The item quantity. Must be a whole number. - * - * @required - * @maps quantity - */ - public function setQuantity(string $quantity): void - { - $this->quantity = $quantity; - } - - /** - * Returns Description. - * The detailed item description. - */ - public function getDescription(): ?string - { - return $this->description; - } - - /** - * Sets Description. - * The detailed item description. - * - * @maps description - */ - public function setDescription(?string $description): void - { - $this->description = $description; - } - - /** - * Returns Sku. - * The stock keeping unit (SKU) for the item. - */ - public function getSku(): ?string - { - return $this->sku; - } - - /** - * Sets Sku. - * The stock keeping unit (SKU) for the item. - * - * @maps sku - */ - public function setSku(?string $sku): void - { - $this->sku = $sku; - } - - /** - * Returns Url. - * The URL to the item being purchased. Visible to buyer and used in buyer experiences. - */ - public function getUrl(): ?string - { - return $this->url; - } - - /** - * Sets Url. - * The URL to the item being purchased. Visible to buyer and used in buyer experiences. - * - * @maps url - */ - public function setUrl(?string $url): void - { - $this->url = $url; - } - - /** - * Returns Image Url. - * The URL of the item's image. File type and size restrictions apply. An image that violates these - * restrictions will not be honored. - */ - public function getImageUrl(): ?string - { - return $this->imageUrl; - } - - /** - * Sets Image Url. - * The URL of the item's image. File type and size restrictions apply. An image that violates these - * restrictions will not be honored. - * - * @maps image_url - */ - public function setImageUrl(?string $imageUrl): void - { - $this->imageUrl = $imageUrl; - } - - /** - * Returns Upc. - * The Universal Product Code of the item. - */ - public function getUpc(): ?UniversalProductCode - { - return $this->upc; - } - - /** - * Sets Upc. - * The Universal Product Code of the item. - * - * @maps upc - */ - public function setUpc(?UniversalProductCode $upc): void - { - $this->upc = $upc; - } - - /** - * Returns Commodity Code. - * Code used to classify items purchased and track the total amount spent across various categories of - * products and services. Different corporate purchasing organizations may use different standards, but - * the United Nations Standard Products and Services Code (UNSPSC) is frequently used. - */ - public function getCommodityCode(): ?string - { - return $this->commodityCode; - } - - /** - * Sets Commodity Code. - * Code used to classify items purchased and track the total amount spent across various categories of - * products and services. Different corporate purchasing organizations may use different standards, but - * the United Nations Standard Products and Services Code (UNSPSC) is frequently used. - * - * @maps commodity_code - */ - public function setCommodityCode(?string $commodityCode): void - { - $this->commodityCode = $commodityCode; - } - - /** - * Returns Discount Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getDiscountAmount(): ?Money - { - return $this->discountAmount; - } - - /** - * Sets Discount Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps discount_amount - */ - public function setDiscountAmount(?Money $discountAmount): void - { - $this->discountAmount = $discountAmount; - } - - /** - * 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. - * - * @maps total_amount - */ - public function setTotalAmount(?Money $totalAmount): void - { - $this->totalAmount = $totalAmount; - } - - /** - * Returns Unit of Measure. - * Unit of measure is a standard used to express the magnitude of a quantity in international trade. - * Most commonly used (but not limited to) examples are: Acre (ACR), Ampere (AMP), Centigram (CGM), - * Centimetre (CMT), Cubic inch (INQ), Cubic metre (MTQ), Fluid ounce (OZA), Foot (FOT), Hour (HUR), - * Item (ITM), Kilogram (KGM), Kilometre (KMT), Kilowatt (KWT), Liquid gallon (GLL), Liter (LTR), - * Pounds (LBS), Square foot (FTK). - */ - public function getUnitOfMeasure(): ?string - { - return $this->unitOfMeasure; - } - - /** - * Sets Unit of Measure. - * Unit of measure is a standard used to express the magnitude of a quantity in international trade. - * Most commonly used (but not limited to) examples are: Acre (ACR), Ampere (AMP), Centigram (CGM), - * Centimetre (CMT), Cubic inch (INQ), Cubic metre (MTQ), Fluid ounce (OZA), Foot (FOT), Hour (HUR), - * Item (ITM), Kilogram (KGM), Kilometre (KMT), Kilowatt (KWT), Liquid gallon (GLL), Liter (LTR), - * Pounds (LBS), Square foot (FTK). - * - * @maps unit_of_measure - */ - public function setUnitOfMeasure(?string $unitOfMeasure): void - { - $this->unitOfMeasure = $unitOfMeasure; - } - - /** - * 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; - $json['unit_amount'] = $this->unitAmount; - if (isset($this->tax)) { - $json['tax'] = $this->tax; - } - $json['quantity'] = $this->quantity; - if (isset($this->description)) { - $json['description'] = $this->description; - } - if (isset($this->sku)) { - $json['sku'] = $this->sku; - } - if (isset($this->url)) { - $json['url'] = $this->url; - } - if (isset($this->imageUrl)) { - $json['image_url'] = $this->imageUrl; - } - if (isset($this->upc)) { - $json['upc'] = $this->upc; - } - if (isset($this->commodityCode)) { - $json['commodity_code'] = $this->commodityCode; - } - if (isset($this->discountAmount)) { - $json['discount_amount'] = $this->discountAmount; - } - if (isset($this->totalAmount)) { - $json['total_amount'] = $this->totalAmount; - } - if (isset($this->unitOfMeasure)) { - $json['unit_of_measure'] = $this->unitOfMeasure; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/LinkDescription.php b/src/Models/LinkDescription.php deleted file mode 100644 index 8de9dab..0000000 --- a/src/Models/LinkDescription.php +++ /dev/null @@ -1,137 +0,0 @@ -href = $href; - $this->rel = $rel; - } - - /** - * Returns Href. - * The complete target URL. To make the related call, combine the method with this [URI Template- - * formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and - * `)` characters. The `href` is the key HATEOAS component that links a completed call with a - * subsequent call. - */ - public function getHref(): string - { - return $this->href; - } - - /** - * Sets Href. - * The complete target URL. To make the related call, combine the method with this [URI Template- - * formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and - * `)` characters. The `href` is the key HATEOAS component that links a completed call with a - * subsequent call. - * - * @required - * @maps href - */ - public function setHref(string $href): void - { - $this->href = $href; - } - - /** - * Returns Rel. - * The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a - * link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana. - * org/assignments/link-relations/link-relations.xhtml). - */ - public function getRel(): string - { - return $this->rel; - } - - /** - * Sets Rel. - * The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a - * link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana. - * org/assignments/link-relations/link-relations.xhtml). - * - * @required - * @maps rel - */ - public function setRel(string $rel): void - { - $this->rel = $rel; - } - - /** - * Returns Method. - * The HTTP method required to make the related call. - */ - public function getMethod(): ?string - { - return $this->method; - } - - /** - * Sets Method. - * The HTTP method required to make the related call. - * - * @maps method - */ - public function setMethod(?string $method): void - { - $this->method = $method; - } - - /** - * 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['href'] = $this->href; - $json['rel'] = $this->rel; - if (isset($this->method)) { - $json['method'] = LinkHTTPMethod::checkValue($this->method); - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/LinkHTTPMethod.php b/src/Models/LinkHTTPMethod.php deleted file mode 100644 index b439bba..0000000 --- a/src/Models/LinkHTTPMethod.php +++ /dev/null @@ -1,58 +0,0 @@ -currencyCode = $currencyCode; - $this->value = $value; - } - - /** - * Returns Currency Code. - * The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies - * the currency. - */ - public function getCurrencyCode(): string - { - return $this->currencyCode; - } - - /** - * Sets Currency Code. - * The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies - * the currency. - * - * @required - * @maps currency_code - */ - public function setCurrencyCode(string $currencyCode): void - { - $this->currencyCode = $currencyCode; - } - - /** - * Returns Value. - * The value, which might be:For the required number of decimal places for a currency code, see [Currency - * Codes](/api/rest/reference/currency-codes/). - */ - public function getValue(): string - { - return $this->value; - } - - /** - * Sets Value. - * The value, which might be:For the required number of decimal places for a currency code, see [Currency - * Codes](/api/rest/reference/currency-codes/). - * - * @required - * @maps value - */ - public function setValue(string $value): void - { - $this->value = $value; - } - - /** - * 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['currency_code'] = $this->currencyCode; - $json['value'] = $this->value; - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/MyBankPaymentObject.php b/src/Models/MyBankPaymentObject.php deleted file mode 100644 index 34f4e4d..0000000 --- a/src/Models/MyBankPaymentObject.php +++ /dev/null @@ -1,157 +0,0 @@ -name; - } - - /** - * Sets Name. - * The full name representation like Mr J Smith. - * - * @maps name - */ - public function setName(?string $name): void - { - $this->name = $name; - } - - /** - * 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 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 [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 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 - */ - public function setCountryCode(?string $countryCode): void - { - $this->countryCode = $countryCode; - } - - /** - * Returns Bic. - * The business identification code (BIC). In payments systems, a BIC is used to identify a specific - * business, most commonly a bank. - */ - public function getBic(): ?string - { - return $this->bic; - } - - /** - * Sets Bic. - * The business identification code (BIC). In payments systems, a BIC is used to identify a specific - * business, most commonly a bank. - * - * @maps bic - */ - public function setBic(?string $bic): void - { - $this->bic = $bic; - } - - /** - * Returns Iban Last Chars. - * The last characters of the IBAN used to pay. - */ - public function getIbanLastChars(): ?string - { - return $this->ibanLastChars; - } - - /** - * Sets Iban Last Chars. - * The last characters of the IBAN used to pay. - * - * @maps iban_last_chars - */ - public function setIbanLastChars(?string $ibanLastChars): void - { - $this->ibanLastChars = $ibanLastChars; - } - - /** - * 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->countryCode)) { - $json['country_code'] = $this->countryCode; - } - if (isset($this->bic)) { - $json['bic'] = $this->bic; - } - if (isset($this->ibanLastChars)) { - $json['iban_last_chars'] = $this->ibanLastChars; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/MyBankPaymentRequest.php b/src/Models/MyBankPaymentRequest.php deleted file mode 100644 index d5b23b2..0000000 --- a/src/Models/MyBankPaymentRequest.php +++ /dev/null @@ -1,135 +0,0 @@ -name = $name; - $this->countryCode = $countryCode; - } - - /** - * Returns Name. - * The full name representation like Mr J Smith. - */ - public function getName(): string - { - return $this->name; - } - - /** - * Sets Name. - * The full name representation like Mr J Smith. - * - * @required - * @maps name - */ - public function setName(string $name): void - { - $this->name = $name; - } - - /** - * 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 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 [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 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; - } - - /** - * Returns Experience Context. - * Customizes the payer experience during the approval process for the payment. - */ - public function getExperienceContext(): ?ExperienceContext - { - return $this->experienceContext; - } - - /** - * Sets Experience Context. - * Customizes the payer experience during the approval process for the payment. - * - * @maps experience_context - */ - public function setExperienceContext(?ExperienceContext $experienceContext): void - { - $this->experienceContext = $experienceContext; - } - - /** - * 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; - $json['country_code'] = $this->countryCode; - if (isset($this->experienceContext)) { - $json['experience_context'] = $this->experienceContext; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/Name.php b/src/Models/Name.php deleted file mode 100644 index 128cd83..0000000 --- a/src/Models/Name.php +++ /dev/null @@ -1,95 +0,0 @@ -givenName; - } - - /** - * Sets Given Name. - * When the party is a person, the party's given, or first, name. - * - * @maps given_name - */ - public function setGivenName(?string $givenName): void - { - $this->givenName = $givenName; - } - - /** - * Returns Surname. - * When the party is a person, the party's surname or family name. Also known as the last name. - * Required when the party is a person. Use also to store multiple surnames including the matronymic, - * or mother's, surname. - */ - public function getSurname(): ?string - { - return $this->surname; - } - - /** - * Sets Surname. - * When the party is a person, the party's surname or family name. Also known as the last name. - * Required when the party is a person. Use also to store multiple surnames including the matronymic, - * or mother's, surname. - * - * @maps surname - */ - public function setSurname(?string $surname): void - { - $this->surname = $surname; - } - - /** - * 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->givenName)) { - $json['given_name'] = $this->givenName; - } - if (isset($this->surname)) { - $json['surname'] = $this->surname; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/NetAmountBreakdownItem.php b/src/Models/NetAmountBreakdownItem.php deleted file mode 100644 index 6fef1bf..0000000 --- a/src/Models/NetAmountBreakdownItem.php +++ /dev/null @@ -1,120 +0,0 @@ -payableAmount; - } - - /** - * Sets Payable Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps payable_amount - */ - public function setPayableAmount(?Money $payableAmount): void - { - $this->payableAmount = $payableAmount; - } - - /** - * Returns Converted Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getConvertedAmount(): ?Money - { - return $this->convertedAmount; - } - - /** - * Sets Converted Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps converted_amount - */ - public function setConvertedAmount(?Money $convertedAmount): void - { - $this->convertedAmount = $convertedAmount; - } - - /** - * Returns Exchange Rate. - * The exchange rate that determines the amount to convert from one currency to another currency. - */ - public function getExchangeRate(): ?ExchangeRate - { - return $this->exchangeRate; - } - - /** - * Sets Exchange Rate. - * The exchange rate that determines the amount to convert from one currency to another currency. - * - * @maps exchange_rate - */ - public function setExchangeRate(?ExchangeRate $exchangeRate): void - { - $this->exchangeRate = $exchangeRate; - } - - /** - * 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->payableAmount)) { - $json['payable_amount'] = $this->payableAmount; - } - if (isset($this->convertedAmount)) { - $json['converted_amount'] = $this->convertedAmount; - } - if (isset($this->exchangeRate)) { - $json['exchange_rate'] = $this->exchangeRate; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/NetworkToken.php b/src/Models/NetworkToken.php deleted file mode 100644 index 4ff905c..0000000 --- a/src/Models/NetworkToken.php +++ /dev/null @@ -1,195 +0,0 @@ -number = $number; - $this->expiry = $expiry; - } - - /** - * Returns Number. - * Third party network token number. - */ - public function getNumber(): string - { - return $this->number; - } - - /** - * Sets Number. - * Third party network token number. - * - * @required - * @maps number - */ - public function setNumber(string $number): void - { - $this->number = $number; - } - - /** - * 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). - * - * @required - * @maps expiry - */ - public function setExpiry(string $expiry): void - { - $this->expiry = $expiry; - } - - /** - * Returns Cryptogram. - * An Encrypted one-time use value that's sent along with Network Token. This field is not required to - * be present for recurring transactions. - */ - public function getCryptogram(): ?string - { - return $this->cryptogram; - } - - /** - * Sets Cryptogram. - * An Encrypted one-time use value that's sent along with Network Token. This field is not required to - * be present for recurring transactions. - * - * @maps cryptogram - */ - public function setCryptogram(?string $cryptogram): void - { - $this->cryptogram = $cryptogram; - } - - /** - * Returns Eci Flag. - * 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 - * the Gateway/Processor. - */ - public function getEciFlag(): ?string - { - return $this->eciFlag; - } - - /** - * Sets Eci Flag. - * 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 - * the Gateway/Processor. - * - * @maps eci_flag - */ - public function setEciFlag(?string $eciFlag): void - { - $this->eciFlag = $eciFlag; - } - - /** - * Returns Token Requestor Id. - * A TRID, or a Token Requestor ID, is an identifier used by merchants to request network tokens from - * card networks. A TRID is a precursor to obtaining a network token for a credit card primary account - * number (PAN), and will aid in enabling secure card on file (COF) payments and reducing fraud. - */ - public function getTokenRequestorId(): ?string - { - return $this->tokenRequestorId; - } - - /** - * Sets Token Requestor Id. - * A TRID, or a Token Requestor ID, is an identifier used by merchants to request network tokens from - * card networks. A TRID is a precursor to obtaining a network token for a credit card primary account - * number (PAN), and will aid in enabling secure card on file (COF) payments and reducing fraud. - * - * @maps token_requestor_id - */ - public function setTokenRequestorId(?string $tokenRequestorId): void - { - $this->tokenRequestorId = $tokenRequestorId; - } - - /** - * 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['number'] = $this->number; - $json['expiry'] = $this->expiry; - if (isset($this->cryptogram)) { - $json['cryptogram'] = $this->cryptogram; - } - if (isset($this->eciFlag)) { - $json['eci_flag'] = ECIFlag::checkValue($this->eciFlag); - } - if (isset($this->tokenRequestorId)) { - $json['token_requestor_id'] = $this->tokenRequestorId; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/NetworkTransactionReference.php b/src/Models/NetworkTransactionReference.php deleted file mode 100644 index 0c8e422..0000000 --- a/src/Models/NetworkTransactionReference.php +++ /dev/null @@ -1,164 +0,0 @@ -id = $id; - } - - /** - * Returns Id. - * Transaction reference id returned by the scheme. For Visa and Amex, this is the "Tran id" field in - * response. For MasterCard, this is the "BankNet reference id" field in response. For Discover, this - * is the "NRID" field in response. The pattern we expect for this field from Visa/Amex/CB/Discover is - * numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric with special character -. - */ - public function getId(): string - { - return $this->id; - } - - /** - * Sets Id. - * Transaction reference id returned by the scheme. For Visa and Amex, this is the "Tran id" field in - * response. For MasterCard, this is the "BankNet reference id" field in response. For Discover, this - * is the "NRID" field in response. The pattern we expect for this field from Visa/Amex/CB/Discover is - * numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric with special character -. - * - * @required - * @maps id - */ - public function setId(string $id): void - { - $this->id = $id; - } - - /** - * Returns Date. - * The date that the transaction was authorized by the scheme. This field may not be returned for all - * networks. MasterCard refers to this field as "BankNet reference date. - */ - public function getDate(): ?string - { - return $this->date; - } - - /** - * Sets Date. - * The date that the transaction was authorized by the scheme. This field may not be returned for all - * networks. MasterCard refers to this field as "BankNet reference date. - * - * @maps date - */ - public function setDate(?string $date): void - { - $this->date = $date; - } - - /** - * Returns Network. - * The card network or brand. Applies to credit, debit, gift, and payment cards. - */ - public function getNetwork(): ?string - { - return $this->network; - } - - /** - * Sets Network. - * The card network or brand. Applies to credit, debit, gift, and payment cards. - * - * @maps network - */ - public function setNetwork(?string $network): void - { - $this->network = $network; - } - - /** - * Returns Acquirer Reference Number. - * Reference ID issued for the card transaction. This ID can be used to track the transaction across - * processors, card brands and issuing banks. - */ - public function getAcquirerReferenceNumber(): ?string - { - return $this->acquirerReferenceNumber; - } - - /** - * Sets Acquirer Reference Number. - * Reference ID issued for the card transaction. This ID can be used to track the transaction across - * processors, card brands and issuing banks. - * - * @maps acquirer_reference_number - */ - public function setAcquirerReferenceNumber(?string $acquirerReferenceNumber): void - { - $this->acquirerReferenceNumber = $acquirerReferenceNumber; - } - - /** - * 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; - if (isset($this->date)) { - $json['date'] = $this->date; - } - if (isset($this->network)) { - $json['network'] = CardBrand::checkValue($this->network); - } - if (isset($this->acquirerReferenceNumber)) { - $json['acquirer_reference_number'] = $this->acquirerReferenceNumber; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/NetworkTransactionReferenceEntity.php b/src/Models/NetworkTransactionReferenceEntity.php deleted file mode 100644 index 645591d..0000000 --- a/src/Models/NetworkTransactionReferenceEntity.php +++ /dev/null @@ -1,166 +0,0 @@ -id = $id; - } - - /** - * Returns Id. - * Transaction reference id returned by the scheme. For Visa and Amex, this is the "Tran id" field in - * response. For MasterCard, this is the "BankNet reference id" field in response. For Discover, this - * is the "NRID" field in response. The pattern we expect for this field from Visa/Amex/CB/Discover is - * numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric with special character -. - */ - public function getId(): string - { - return $this->id; - } - - /** - * Sets Id. - * Transaction reference id returned by the scheme. For Visa and Amex, this is the "Tran id" field in - * response. For MasterCard, this is the "BankNet reference id" field in response. For Discover, this - * is the "NRID" field in response. The pattern we expect for this field from Visa/Amex/CB/Discover is - * numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric with special character -. - * - * @required - * @maps id - */ - public function setId(string $id): void - { - $this->id = $id; - } - - /** - * Returns Date. - * The date that the transaction was authorized by the scheme. This field may not be returned for all - * networks. MasterCard refers to this field as "BankNet reference date. - */ - public function getDate(): ?string - { - return $this->date; - } - - /** - * Sets Date. - * The date that the transaction was authorized by the scheme. This field may not be returned for all - * networks. MasterCard refers to this field as "BankNet reference date. - * - * @maps date - */ - public function setDate(?string $date): void - { - $this->date = $date; - } - - /** - * Returns Network. - * The card network or brand. Applies to credit, debit, gift, and payment cards. - */ - public function getNetwork(): ?string - { - return $this->network; - } - - /** - * Sets Network. - * The card network or brand. Applies to credit, debit, gift, and payment cards. - * - * @maps network - */ - public function setNetwork(?string $network): void - { - $this->network = $network; - } - - /** - * 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.
Note: - * The regular expression provides guidance but does not reject all invalid dates.
- */ - public function getTime(): ?string - { - return $this->time; - } - - /** - * 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.
- * - * @maps time - */ - public function setTime(?string $time): void - { - $this->time = $time; - } - - /** - * 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; - if (isset($this->date)) { - $json['date'] = $this->date; - } - if (isset($this->network)) { - $json['network'] = CardBrand::checkValue($this->network); - } - if (isset($this->time)) { - $json['time'] = $this->time; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/OAuthProviderError.php b/src/Models/OAuthProviderError.php deleted file mode 100644 index a45e59d..0000000 --- a/src/Models/OAuthProviderError.php +++ /dev/null @@ -1,84 +0,0 @@ -accessToken = $accessToken; - $this->tokenType = $tokenType; - } - - /** - * Returns Access Token. - * Access token - */ - public function getAccessToken(): string - { - return $this->accessToken; - } - - /** - * Sets Access Token. - * Access token - * - * @required - * @maps access_token - */ - public function setAccessToken(string $accessToken): void - { - $this->accessToken = $accessToken; - } - - /** - * Returns Token Type. - * Type of access token - */ - public function getTokenType(): string - { - return $this->tokenType; - } - - /** - * Sets Token Type. - * Type of access token - * - * @required - * @maps token_type - */ - public function setTokenType(string $tokenType): void - { - $this->tokenType = $tokenType; - } - - /** - * Returns Expires In. - * Time in seconds before the access token expires - */ - public function getExpiresIn(): ?int - { - return $this->expiresIn; - } - - /** - * Sets Expires In. - * Time in seconds before the access token expires - * - * @maps expires_in - */ - public function setExpiresIn(?int $expiresIn): void - { - $this->expiresIn = $expiresIn; - } - - /** - * Returns Scope. - * List of scopes granted - * This is a space-delimited list of strings. - */ - public function getScope(): ?string - { - return $this->scope; - } - - /** - * Sets Scope. - * List of scopes granted - * This is a space-delimited list of strings. - * - * @maps scope - */ - public function setScope(?string $scope): void - { - $this->scope = $scope; - } - - /** - * Returns Expiry. - * Time of token expiry as unix timestamp (UTC) - */ - public function getExpiry(): ?int - { - return $this->expiry; - } - - /** - * Sets Expiry. - * Time of token expiry as unix timestamp (UTC) - * - * @maps expiry - */ - public function setExpiry(?int $expiry): void - { - $this->expiry = $expiry; - } - - /** - * Returns Refresh Token. - * Refresh token - * Used to get a new access token when it expires. - */ - public function getRefreshToken(): ?string - { - return $this->refreshToken; - } - - /** - * Sets Refresh Token. - * Refresh token - * Used to get a new access token when it expires. - * - * @maps refresh_token - */ - public function setRefreshToken(?string $refreshToken): void - { - $this->refreshToken = $refreshToken; - } - - /** - * Returns Id Token. - * An ID token response type is of JSON Web Token (JWT) that contains claims about the identity of the - * authenticated user. - */ - public function getIdToken(): ?string - { - return $this->idToken; - } - - /** - * Sets Id Token. - * An ID token response type is of JSON Web Token (JWT) that contains claims about the identity of the - * authenticated user. - * - * @maps id_token - */ - public function setIdToken(?string $idToken): void - { - $this->idToken = $idToken; - } - - /** - * 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['access_token'] = $this->accessToken; - $json['token_type'] = $this->tokenType; - if (isset($this->expiresIn)) { - $json['expires_in'] = $this->expiresIn; - } - if (isset($this->scope)) { - $json['scope'] = $this->scope; - } - if (isset($this->expiry)) { - $json['expiry'] = $this->expiry; - } - if (isset($this->refreshToken)) { - $json['refresh_token'] = $this->refreshToken; - } - if (isset($this->idToken)) { - $json['id_token'] = $this->idToken; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/Order.php b/src/Models/Order.php deleted file mode 100644 index 296761e..0000000 --- a/src/Models/Order.php +++ /dev/null @@ -1,349 +0,0 @@ -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; - } - - /** - * 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 Payment Source. - * The payment source used to fund the payment. - */ - public function getPaymentSource(): ?PaymentSourceResponse - { - return $this->paymentSource; - } - - /** - * Sets Payment Source. - * The payment source used to fund the payment. - * - * @maps payment_source - */ - public function setPaymentSource(?PaymentSourceResponse $paymentSource): void - { - $this->paymentSource = $paymentSource; - } - - /** - * Returns Intent. - * The intent to either capture payment immediately or authorize a payment for an order after order - * creation. - */ - public function getIntent(): ?string - { - return $this->intent; - } - - /** - * Sets Intent. - * The intent to either capture payment immediately or authorize a payment for an order after order - * creation. - * - * @maps intent - */ - public function setIntent(?string $intent): void - { - $this->intent = $intent; - } - - /** - * Returns Processing Instruction. - * The instruction to process an order. - */ - public function getProcessingInstruction(): ?string - { - return $this->processingInstruction; - } - - /** - * Sets Processing Instruction. - * The instruction to process an order. - * - * @maps processing_instruction - */ - public function setProcessingInstruction(?string $processingInstruction): void - { - $this->processingInstruction = $processingInstruction; - } - - /** - * Returns Payer. - */ - public function getPayer(): ?Payer - { - return $this->payer; - } - - /** - * Sets Payer. - * - * @maps payer - */ - public function setPayer(?Payer $payer): void - { - $this->payer = $payer; - } - - /** - * Returns Purchase Units. - * An array of purchase units. Each purchase unit establishes a contract between a customer and - * merchant. Each purchase unit represents either a full or partial order that the customer intends to - * purchase from the merchant. - * - * @return PurchaseUnit[]|null - */ - public function getPurchaseUnits(): ?array - { - return $this->purchaseUnits; - } - - /** - * Sets Purchase Units. - * An array of purchase units. Each purchase unit establishes a contract between a customer and - * merchant. Each purchase unit represents either a full or partial order that the customer intends to - * purchase from the merchant. - * - * @maps purchase_units - * - * @param PurchaseUnit[]|null $purchaseUnits - */ - public function setPurchaseUnits(?array $purchaseUnits): void - { - $this->purchaseUnits = $purchaseUnits; - } - - /** - * Returns Status. - * The order status. - */ - public function getStatus(): ?string - { - return $this->status; - } - - /** - * Sets Status. - * The order status. - * - * @maps status - */ - public function setStatus(?string $status): void - { - $this->status = $status; - } - - /** - * Returns Links. - * An array of request-related HATEOAS links. To complete payer approval, use the `approve` link to - * redirect the payer. The API caller has 3 hours (default setting, this which can be changed by your - * account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, - * to redirect your payer. Once redirected, the API caller has 3 hours for the payer to approve the - * order and either authorize or capture the order. If you are not using the PayPal JavaScript SDK to - * initiate PayPal Checkout (in context) ensure that you include `application_context.return_url` is - * specified or you will get "We're sorry, Things don't appear to be working at the moment" after the - * payer approves the payment. - * - * @return LinkDescription[]|null - */ - public function getLinks(): ?array - { - return $this->links; - } - - /** - * Sets Links. - * An array of request-related HATEOAS links. To complete payer approval, use the `approve` link to - * redirect the payer. The API caller has 3 hours (default setting, this which can be changed by your - * account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, - * to redirect your payer. Once redirected, the API caller has 3 hours for the payer to approve the - * order and either authorize or capture the order. If you are not using the PayPal JavaScript SDK to - * initiate PayPal Checkout (in context) ensure that you include `application_context.return_url` is - * specified or you will get "We're sorry, Things don't appear to be working at the moment" after the - * payer approves the payment. - * - * @maps links - * - * @param LinkDescription[]|null $links - */ - public function setLinks(?array $links): void - { - $this->links = $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->createTime)) { - $json['create_time'] = $this->createTime; - } - if (isset($this->updateTime)) { - $json['update_time'] = $this->updateTime; - } - if (isset($this->id)) { - $json['id'] = $this->id; - } - if (isset($this->paymentSource)) { - $json['payment_source'] = $this->paymentSource; - } - if (isset($this->intent)) { - $json['intent'] = CheckoutPaymentIntent::checkValue($this->intent); - } - if (isset($this->processingInstruction)) { - $json['processing_instruction'] = ProcessingInstruction::checkValue($this->processingInstruction); - } - if (isset($this->payer)) { - $json['payer'] = $this->payer; - } - if (isset($this->purchaseUnits)) { - $json['purchase_units'] = $this->purchaseUnits; - } - if (isset($this->status)) { - $json['status'] = OrderStatus::checkValue($this->status); - } - if (isset($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 deleted file mode 100644 index aa41cd1..0000000 --- a/src/Models/OrderApplicationContext.php +++ /dev/null @@ -1,369 +0,0 @@ -Note: Partners and Marketplaces might configure brand_name - * and shipping_preference during partner account setup, which overrides the request - * values. - */ -class OrderApplicationContext implements \JsonSerializable -{ - /** - * @var string|null - */ - private $brandName; - - /** - * @var string|null - */ - private $locale; - - /** - * @var string|null - */ - private $landingPage = OrderApplicationContextLandingPage::NO_PREFERENCE; - - /** - * @var string|null - */ - private $shippingPreference = OrderApplicationContextShippingPreference::GET_FROM_FILE; - - /** - * @var string|null - */ - private $userAction = OrderApplicationContextUserAction::CONTINUE_; - - /** - * @var PaymentMethodPreference|null - */ - private $paymentMethod; - - /** - * @var string|null - */ - private $returnUrl; - - /** - * @var string|null - */ - private $cancelUrl; - - /** - * @var StoredPaymentSource|null - */ - private $storedPaymentSource; - - /** - * Returns Brand Name. - * 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. - */ - public function getBrandName(): ?string - { - return $this->brandName; - } - - /** - * Sets Brand Name. - * 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. - * - * @maps brand_name - */ - public function setBrandName(?string $brandName): void - { - $this->brandName = $brandName; - } - - /** - * Returns Locale. - * 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/). - */ - public function getLocale(): ?string - { - return $this->locale; - } - - /** - * Sets Locale. - * 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/). - * - * @maps locale - */ - public function setLocale(?string $locale): void - { - $this->locale = $locale; - } - - /** - * Returns Landing Page. - * DEPRECATED. DEPRECATED. The type of landing page to show on the PayPal site for customer checkout. - * 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.landing_page`). - * Please specify this field in the `experience_context` object instead of the `application_context` - * object. - */ - public function getLandingPage(): ?string - { - return $this->landingPage; - } - - /** - * Sets Landing Page. - * DEPRECATED. DEPRECATED. The type of landing page to show on the PayPal site for customer checkout. - * 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.landing_page`). - * Please specify this field in the `experience_context` object instead of the `application_context` - * object. - * - * @maps landing_page - */ - public function setLandingPage(?string $landingPage): void - { - $this->landingPage = $landingPage; - } - - /** - * Returns Shipping Preference. - * DEPRECATED. DEPRECATED. The shipping preference:. 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. - * shipping_preference`). Please specify this field in the `experience_context` object instead of the - * `application_context` object. - */ - public function getShippingPreference(): ?string - { - return $this->shippingPreference; - } - - /** - * Sets Shipping Preference. - * DEPRECATED. DEPRECATED. The shipping preference:. 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. - * shipping_preference`). Please specify this field in the `experience_context` object instead of the - * `application_context` object. - * - * @maps shipping_preference - */ - public function setShippingPreference(?string $shippingPreference): void - { - $this->shippingPreference = $shippingPreference; - } - - /** - * Returns User Action. - * DEPRECATED. Configures a Continue or Pay Now checkout flow. 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.user_action`). - * Please specify this field in the `experience_context` object instead of the `application_context` - * object. - */ - public function getUserAction(): ?string - { - return $this->userAction; - } - - /** - * Sets User Action. - * DEPRECATED. Configures a Continue or Pay Now checkout flow. 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.user_action`). - * Please specify this field in the `experience_context` object instead of the `application_context` - * object. - * - * @maps user_action - */ - public function setUserAction(?string $userAction): void - { - $this->userAction = $userAction; - } - - /** - * Returns Payment Method. - * The customer and merchant payment preferences. - */ - public function getPaymentMethod(): ?PaymentMethodPreference - { - return $this->paymentMethod; - } - - /** - * Sets Payment Method. - * The customer and merchant payment preferences. - * - * @maps payment_method - */ - public function setPaymentMethod(?PaymentMethodPreference $paymentMethod): void - { - $this->paymentMethod = $paymentMethod; - } - - /** - * Returns Return Url. - * DEPRECATED. The URL where the customer is redirected after the customer approves the payment. 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.return_url`). - * Please specify this field in the `experience_context` object instead of the `application_context` - * object. - */ - public function getReturnUrl(): ?string - { - return $this->returnUrl; - } - - /** - * Sets Return Url. - * DEPRECATED. The URL where the customer is redirected after the customer approves the payment. 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.return_url`). - * Please specify this field in the `experience_context` object instead of the `application_context` - * object. - * - * @maps return_url - */ - public function setReturnUrl(?string $returnUrl): void - { - $this->returnUrl = $returnUrl; - } - - /** - * Returns Cancel Url. - * DEPRECATED. The URL where the customer is redirected after the customer cancels the payment. 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.cancel_url`). - * Please specify this field in the `experience_context` object instead of the `application_context` - * object. - */ - public function getCancelUrl(): ?string - { - return $this->cancelUrl; - } - - /** - * Sets Cancel Url. - * DEPRECATED. The URL where the customer is redirected after the customer cancels the payment. 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.cancel_url`). - * Please specify this field in the `experience_context` object instead of the `application_context` - * object. - * - * @maps cancel_url - */ - public function setCancelUrl(?string $cancelUrl): void - { - $this->cancelUrl = $cancelUrl; - } - - /** - * 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).
Parameter - * compatibility:
- */ - public function getStoredPaymentSource(): ?StoredPaymentSource - { - return $this->storedPaymentSource; - } - - /** - * Sets 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).
Parameter - * compatibility:
- * - * @maps stored_payment_source - */ - public function setStoredPaymentSource(?StoredPaymentSource $storedPaymentSource): void - { - $this->storedPaymentSource = $storedPaymentSource; - } - - /** - * 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->brandName)) { - $json['brand_name'] = $this->brandName; - } - if (isset($this->locale)) { - $json['locale'] = $this->locale; - } - if (isset($this->landingPage)) { - $json['landing_page'] = OrderApplicationContextLandingPage::checkValue($this->landingPage); - } - if (isset($this->shippingPreference)) { - $json['shipping_preference'] = - OrderApplicationContextShippingPreference::checkValue( - $this->shippingPreference - ); - } - if (isset($this->userAction)) { - $json['user_action'] = OrderApplicationContextUserAction::checkValue($this->userAction); - } - if (isset($this->paymentMethod)) { - $json['payment_method'] = $this->paymentMethod; - } - if (isset($this->returnUrl)) { - $json['return_url'] = $this->returnUrl; - } - if (isset($this->cancelUrl)) { - $json['cancel_url'] = $this->cancelUrl; - } - if (isset($this->storedPaymentSource)) { - $json['stored_payment_source'] = $this->storedPaymentSource; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/OrderApplicationContextLandingPage.php b/src/Models/OrderApplicationContextLandingPage.php deleted file mode 100644 index b893a40..0000000 --- a/src/Models/OrderApplicationContextLandingPage.php +++ /dev/null @@ -1,51 +0,0 @@ -
  • Displays the shipping address to the - * customer.
  • Enables the customer to choose an address on the PayPal site.
  • Restricts - * the customer from changing the address during the payment-approval process.
    • . 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. - * shipping_preference`). Please specify this field in the `experience_context` object instead of the - * `application_context` object. - */ -class OrderApplicationContextShippingPreference -{ - public const GET_FROM_FILE = 'GET_FROM_FILE'; - - 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 - */ - 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 OrderApplicationContextShippingPreference."); - } -} diff --git a/src/Models/OrderApplicationContextUserAction.php b/src/Models/OrderApplicationContextUserAction.php deleted file mode 100644 index 5d5c641..0000000 --- a/src/Models/OrderApplicationContextUserAction.php +++ /dev/null @@ -1,49 +0,0 @@ -Continue or Pay Now checkout flow. 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.user_action`). - * Please specify this field in the `experience_context` object instead of the `application_context` - * object. - */ -class OrderApplicationContextUserAction -{ - 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 - */ - 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 OrderApplicationContextUserAction."); - } -} diff --git a/src/Models/OrderAuthorizeRequest.php b/src/Models/OrderAuthorizeRequest.php deleted file mode 100644 index 5c15abb..0000000 --- a/src/Models/OrderAuthorizeRequest.php +++ /dev/null @@ -1,63 +0,0 @@ -paymentSource; - } - - /** - * Sets Payment Source. - * The payment source definition. - * - * @maps payment_source - */ - public function setPaymentSource(?OrderAuthorizeRequestPaymentSource $paymentSource): void - { - $this->paymentSource = $paymentSource; - } - - /** - * 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->paymentSource)) { - $json['payment_source'] = $this->paymentSource; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/OrderAuthorizeRequestPaymentSource.php b/src/Models/OrderAuthorizeRequestPaymentSource.php deleted file mode 100644 index 38eaeeb..0000000 --- a/src/Models/OrderAuthorizeRequestPaymentSource.php +++ /dev/null @@ -1,213 +0,0 @@ -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 - { - return $this->card; - } - - /** - * Sets 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. - *
    *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 - */ - public function setCard(?CardRequest $card): void - { - $this->card = $card; - } - - /** - * Returns Token. - * The tokenized payment source to fund a payment. - */ - public function getToken(): ?Token - { - return $this->token; - } - - /** - * Sets Token. - * The tokenized payment source to fund a payment. - * - * @maps token - */ - public function setToken(?Token $token): void - { - $this->token = $token; - } - - /** - * Returns Paypal. - * A resource that identifies a PayPal Wallet is used for payment. - */ - public function getPaypal(): ?PayPalWallet - { - return $this->paypal; - } - - /** - * Sets Paypal. - * A resource that identifies a PayPal Wallet is used for payment. - * - * @maps paypal - */ - public function setPaypal(?PayPalWallet $paypal): void - { - $this->paypal = $paypal; - } - - /** - * Returns Apple Pay. - * Information needed to pay using ApplePay. - */ - public function getApplePay(): ?ApplePayRequest - { - return $this->applePay; - } - - /** - * Sets Apple Pay. - * Information needed to pay using ApplePay. - * - * @maps apple_pay - */ - public function setApplePay(?ApplePayRequest $applePay): void - { - $this->applePay = $applePay; - } - - /** - * Returns Google Pay. - * Information needed to pay using Google Pay. - */ - public function getGooglePay(): ?GooglePayRequest - { - return $this->googlePay; - } - - /** - * Sets Google Pay. - * Information needed to pay using Google Pay. - * - * @maps google_pay - */ - public function setGooglePay(?GooglePayRequest $googlePay): void - { - $this->googlePay = $googlePay; - } - - /** - * Returns Venmo. - * Information needed to pay using Venmo. - */ - public function getVenmo(): ?VenmoWalletRequest - { - return $this->venmo; - } - - /** - * Sets Venmo. - * Information needed to pay using Venmo. - * - * @maps venmo - */ - public function setVenmo(?VenmoWalletRequest $venmo): void - { - $this->venmo = $venmo; - } - - /** - * 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->card)) { - $json['card'] = $this->card; - } - if (isset($this->token)) { - $json['token'] = $this->token; - } - if (isset($this->paypal)) { - $json['paypal'] = $this->paypal; - } - if (isset($this->applePay)) { - $json['apple_pay'] = $this->applePay; - } - if (isset($this->googlePay)) { - $json['google_pay'] = $this->googlePay; - } - if (isset($this->venmo)) { - $json['venmo'] = $this->venmo; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/OrderAuthorizeResponse.php b/src/Models/OrderAuthorizeResponse.php deleted file mode 100644 index cb7d83c..0000000 --- a/src/Models/OrderAuthorizeResponse.php +++ /dev/null @@ -1,334 +0,0 @@ -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; - } - - /** - * 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 Payment Source. - * The payment source used to fund the payment. - */ - public function getPaymentSource(): ?OrderAuthorizeResponsePaymentSource - { - return $this->paymentSource; - } - - /** - * Sets Payment Source. - * The payment source used to fund the payment. - * - * @maps payment_source - */ - public function setPaymentSource(?OrderAuthorizeResponsePaymentSource $paymentSource): void - { - $this->paymentSource = $paymentSource; - } - - /** - * Returns Intent. - * The intent to either capture payment immediately or authorize a payment for an order after order - * creation. - */ - public function getIntent(): ?string - { - return $this->intent; - } - - /** - * Sets Intent. - * The intent to either capture payment immediately or authorize a payment for an order after order - * creation. - * - * @maps intent - */ - public function setIntent(?string $intent): void - { - $this->intent = $intent; - } - - /** - * Returns Processing Instruction. - * The instruction to process an order. - */ - public function getProcessingInstruction(): ?string - { - return $this->processingInstruction; - } - - /** - * Sets Processing Instruction. - * The instruction to process an order. - * - * @maps processing_instruction - */ - public function setProcessingInstruction(?string $processingInstruction): void - { - $this->processingInstruction = $processingInstruction; - } - - /** - * Returns Payer. - */ - public function getPayer(): ?Payer - { - return $this->payer; - } - - /** - * Sets Payer. - * - * @maps payer - */ - public function setPayer(?Payer $payer): void - { - $this->payer = $payer; - } - - /** - * Returns Purchase Units. - * An array of purchase units. Each purchase unit establishes a contract between a customer and - * merchant. Each purchase unit represents either a full or partial order that the customer intends to - * purchase from the merchant. - * - * @return PurchaseUnit[]|null - */ - public function getPurchaseUnits(): ?array - { - return $this->purchaseUnits; - } - - /** - * Sets Purchase Units. - * An array of purchase units. Each purchase unit establishes a contract between a customer and - * merchant. Each purchase unit represents either a full or partial order that the customer intends to - * purchase from the merchant. - * - * @maps purchase_units - * - * @param PurchaseUnit[]|null $purchaseUnits - */ - public function setPurchaseUnits(?array $purchaseUnits): void - { - $this->purchaseUnits = $purchaseUnits; - } - - /** - * Returns Status. - * The order status. - */ - public function getStatus(): ?string - { - return $this->status; - } - - /** - * Sets Status. - * The order status. - * - * @maps status - */ - public function setStatus(?string $status): void - { - $this->status = $status; - } - - /** - * Returns Links. - * An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links) that are either - * relevant to the issue by providing additional information or offering potential resolutions. - * - * @return LinkDescription[]|null - */ - public function getLinks(): ?array - { - return $this->links; - } - - /** - * Sets Links. - * An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links) that are either - * relevant to the issue by providing additional information or offering potential resolutions. - * - * @maps links - * - * @param LinkDescription[]|null $links - */ - public function setLinks(?array $links): void - { - $this->links = $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->createTime)) { - $json['create_time'] = $this->createTime; - } - if (isset($this->updateTime)) { - $json['update_time'] = $this->updateTime; - } - if (isset($this->id)) { - $json['id'] = $this->id; - } - if (isset($this->paymentSource)) { - $json['payment_source'] = $this->paymentSource; - } - if (isset($this->intent)) { - $json['intent'] = CheckoutPaymentIntent::checkValue($this->intent); - } - if (isset($this->processingInstruction)) { - $json['processing_instruction'] = ProcessingInstruction::checkValue($this->processingInstruction); - } - if (isset($this->payer)) { - $json['payer'] = $this->payer; - } - if (isset($this->purchaseUnits)) { - $json['purchase_units'] = $this->purchaseUnits; - } - if (isset($this->status)) { - $json['status'] = OrderStatus::checkValue($this->status); - } - if (isset($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 deleted file mode 100644 index 3faa177..0000000 --- a/src/Models/OrderAuthorizeResponsePaymentSource.php +++ /dev/null @@ -1,175 +0,0 @@ -card; - } - - /** - * Sets Card. - * The payment card to use to fund a payment. Card can be a credit or debit card. - * - * @maps card - */ - public function setCard(?CardResponse $card): void - { - $this->card = $card; - } - - /** - * Returns Paypal. - * The PayPal Wallet response. - */ - public function getPaypal(): ?PayPalWalletResponse - { - return $this->paypal; - } - - /** - * Sets Paypal. - * The PayPal Wallet response. - * - * @maps paypal - */ - public function setPaypal(?PayPalWalletResponse $paypal): void - { - $this->paypal = $paypal; - } - - /** - * Returns Apple Pay. - * Information needed to pay using ApplePay. - */ - public function getApplePay(): ?ApplePayPaymentObject - { - return $this->applePay; - } - - /** - * Sets Apple Pay. - * Information needed to pay using ApplePay. - * - * @maps apple_pay - */ - public function setApplePay(?ApplePayPaymentObject $applePay): void - { - $this->applePay = $applePay; - } - - /** - * Returns Google Pay. - * Google Pay Wallet payment data. - */ - public function getGooglePay(): ?GooglePayWalletResponse - { - return $this->googlePay; - } - - /** - * Sets Google Pay. - * Google Pay Wallet payment data. - * - * @maps google_pay - */ - public function setGooglePay(?GooglePayWalletResponse $googlePay): void - { - $this->googlePay = $googlePay; - } - - /** - * Returns Venmo. - * Venmo wallet response. - */ - public function getVenmo(): ?VenmoWalletResponse - { - return $this->venmo; - } - - /** - * Sets Venmo. - * Venmo wallet response. - * - * @maps venmo - */ - public function setVenmo(?VenmoWalletResponse $venmo): void - { - $this->venmo = $venmo; - } - - /** - * 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->card)) { - $json['card'] = $this->card; - } - if (isset($this->paypal)) { - $json['paypal'] = $this->paypal; - } - if (isset($this->applePay)) { - $json['apple_pay'] = $this->applePay; - } - if (isset($this->googlePay)) { - $json['google_pay'] = $this->googlePay; - } - if (isset($this->venmo)) { - $json['venmo'] = $this->venmo; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/OrderCaptureRequest.php b/src/Models/OrderCaptureRequest.php deleted file mode 100644 index 17eb040..0000000 --- a/src/Models/OrderCaptureRequest.php +++ /dev/null @@ -1,63 +0,0 @@ -paymentSource; - } - - /** - * Sets Payment Source. - * The payment source definition. - * - * @maps payment_source - */ - public function setPaymentSource(?OrderCaptureRequestPaymentSource $paymentSource): void - { - $this->paymentSource = $paymentSource; - } - - /** - * 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->paymentSource)) { - $json['payment_source'] = $this->paymentSource; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/OrderCaptureRequestPaymentSource.php b/src/Models/OrderCaptureRequestPaymentSource.php deleted file mode 100644 index b8a30ce..0000000 --- a/src/Models/OrderCaptureRequestPaymentSource.php +++ /dev/null @@ -1,213 +0,0 @@ -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 - { - return $this->card; - } - - /** - * Sets 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. - *
    *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 - */ - public function setCard(?CardRequest $card): void - { - $this->card = $card; - } - - /** - * Returns Token. - * The tokenized payment source to fund a payment. - */ - public function getToken(): ?Token - { - return $this->token; - } - - /** - * Sets Token. - * The tokenized payment source to fund a payment. - * - * @maps token - */ - public function setToken(?Token $token): void - { - $this->token = $token; - } - - /** - * Returns Paypal. - * A resource that identifies a PayPal Wallet is used for payment. - */ - public function getPaypal(): ?PayPalWallet - { - return $this->paypal; - } - - /** - * Sets Paypal. - * A resource that identifies a PayPal Wallet is used for payment. - * - * @maps paypal - */ - public function setPaypal(?PayPalWallet $paypal): void - { - $this->paypal = $paypal; - } - - /** - * Returns Apple Pay. - * Information needed to pay using ApplePay. - */ - public function getApplePay(): ?ApplePayRequest - { - return $this->applePay; - } - - /** - * Sets Apple Pay. - * Information needed to pay using ApplePay. - * - * @maps apple_pay - */ - public function setApplePay(?ApplePayRequest $applePay): void - { - $this->applePay = $applePay; - } - - /** - * Returns Google Pay. - * Information needed to pay using Google Pay. - */ - public function getGooglePay(): ?GooglePayRequest - { - return $this->googlePay; - } - - /** - * Sets Google Pay. - * Information needed to pay using Google Pay. - * - * @maps google_pay - */ - public function setGooglePay(?GooglePayRequest $googlePay): void - { - $this->googlePay = $googlePay; - } - - /** - * Returns Venmo. - * Information needed to pay using Venmo. - */ - public function getVenmo(): ?VenmoWalletRequest - { - return $this->venmo; - } - - /** - * Sets Venmo. - * Information needed to pay using Venmo. - * - * @maps venmo - */ - public function setVenmo(?VenmoWalletRequest $venmo): void - { - $this->venmo = $venmo; - } - - /** - * 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->card)) { - $json['card'] = $this->card; - } - if (isset($this->token)) { - $json['token'] = $this->token; - } - if (isset($this->paypal)) { - $json['paypal'] = $this->paypal; - } - if (isset($this->applePay)) { - $json['apple_pay'] = $this->applePay; - } - if (isset($this->googlePay)) { - $json['google_pay'] = $this->googlePay; - } - if (isset($this->venmo)) { - $json['venmo'] = $this->venmo; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/OrderConfirmApplicationContext.php b/src/Models/OrderConfirmApplicationContext.php deleted file mode 100644 index b43ad04..0000000 --- a/src/Models/OrderConfirmApplicationContext.php +++ /dev/null @@ -1,199 +0,0 @@ -brandName; - } - - /** - * Sets Brand Name. - * Label to present to your payer as part of the PayPal hosted web experience. - * - * @maps brand_name - */ - public function setBrandName(?string $brandName): void - { - $this->brandName = $brandName; - } - - /** - * Returns Locale. - * 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/). - */ - public function getLocale(): ?string - { - return $this->locale; - } - - /** - * Sets Locale. - * 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/). - * - * @maps locale - */ - public function setLocale(?string $locale): void - { - $this->locale = $locale; - } - - /** - * Returns Return Url. - * The URL where the customer is redirected after the customer approves the payment. - */ - public function getReturnUrl(): ?string - { - return $this->returnUrl; - } - - /** - * Sets Return Url. - * The URL where the customer is redirected after the customer approves the payment. - * - * @maps return_url - */ - public function setReturnUrl(?string $returnUrl): void - { - $this->returnUrl = $returnUrl; - } - - /** - * Returns Cancel Url. - * The URL where the customer is redirected after the customer cancels the payment. - */ - public function getCancelUrl(): ?string - { - return $this->cancelUrl; - } - - /** - * Sets Cancel Url. - * The URL where the customer is redirected after the customer cancels the payment. - * - * @maps cancel_url - */ - public function setCancelUrl(?string $cancelUrl): void - { - $this->cancelUrl = $cancelUrl; - } - - /** - * 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).
    Parameter - * compatibility:
    - */ - public function getStoredPaymentSource(): ?StoredPaymentSource - { - return $this->storedPaymentSource; - } - - /** - * Sets 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).
    Parameter - * compatibility:
    - * - * @maps stored_payment_source - */ - public function setStoredPaymentSource(?StoredPaymentSource $storedPaymentSource): void - { - $this->storedPaymentSource = $storedPaymentSource; - } - - /** - * 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->brandName)) { - $json['brand_name'] = $this->brandName; - } - if (isset($this->locale)) { - $json['locale'] = $this->locale; - } - if (isset($this->returnUrl)) { - $json['return_url'] = $this->returnUrl; - } - if (isset($this->cancelUrl)) { - $json['cancel_url'] = $this->cancelUrl; - } - if (isset($this->storedPaymentSource)) { - $json['stored_payment_source'] = $this->storedPaymentSource; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/OrderRequest.php b/src/Models/OrderRequest.php deleted file mode 100644 index b28c68a..0000000 --- a/src/Models/OrderRequest.php +++ /dev/null @@ -1,197 +0,0 @@ -intent = $intent; - $this->purchaseUnits = $purchaseUnits; - } - - /** - * Returns Intent. - * The intent to either capture payment immediately or authorize a payment for an order after order - * creation. - */ - public function getIntent(): string - { - return $this->intent; - } - - /** - * Sets Intent. - * The intent to either capture payment immediately or authorize a payment for an order after order - * creation. - * - * @required - * @maps intent - */ - public function setIntent(string $intent): void - { - $this->intent = $intent; - } - - /** - * Returns Payer. - */ - public function getPayer(): ?Payer - { - return $this->payer; - } - - /** - * Sets Payer. - * - * @maps payer - */ - public function setPayer(?Payer $payer): void - { - $this->payer = $payer; - } - - /** - * Returns Purchase Units. - * An array of purchase units. 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. 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; - } - - /** - * Returns Payment Source. - * The payment source definition. - */ - public function getPaymentSource(): ?PaymentSource - { - return $this->paymentSource; - } - - /** - * Sets Payment Source. - * The payment source definition. - * - * @maps payment_source - */ - public function setPaymentSource(?PaymentSource $paymentSource): void - { - $this->paymentSource = $paymentSource; - } - - /** - * Returns Application Context. - * 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 - { - return $this->applicationContext; - } - - /** - * Sets Application Context. - * 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 - */ - public function setApplicationContext(?OrderApplicationContext $applicationContext): void - { - $this->applicationContext = $applicationContext; - } - - /** - * 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['intent'] = CheckoutPaymentIntent::checkValue($this->intent); - if (isset($this->payer)) { - $json['payer'] = $this->payer; - } - $json['purchase_units'] = $this->purchaseUnits; - if (isset($this->paymentSource)) { - $json['payment_source'] = $this->paymentSource; - } - if (isset($this->applicationContext)) { - $json['application_context'] = $this->applicationContext; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/OrderStatus.php b/src/Models/OrderStatus.php deleted file mode 100644 index d24bf87..0000000 --- a/src/Models/OrderStatus.php +++ /dev/null @@ -1,54 +0,0 @@ -name; - } - - /** - * Sets Name. - * The item name or title. - * - * @maps name - */ - public function setName(?string $name): void - { - $this->name = $name; - } - - /** - * Returns Quantity. - * The item quantity. Must be a whole number. - */ - public function getQuantity(): ?string - { - return $this->quantity; - } - - /** - * Sets Quantity. - * The item quantity. Must be a whole number. - * - * @maps quantity - */ - public function setQuantity(?string $quantity): void - { - $this->quantity = $quantity; - } - - /** - * Returns Sku. - * The stock keeping unit (SKU) for the item. This can contain unicode characters. - */ - public function getSku(): ?string - { - return $this->sku; - } - - /** - * Sets Sku. - * The stock keeping unit (SKU) for the item. This can contain unicode characters. - * - * @maps sku - */ - public function setSku(?string $sku): void - { - $this->sku = $sku; - } - - /** - * Returns Url. - * The URL to the item being purchased. Visible to buyer and used in buyer experiences. - */ - public function getUrl(): ?string - { - return $this->url; - } - - /** - * Sets Url. - * The URL to the item being purchased. Visible to buyer and used in buyer experiences. - * - * @maps url - */ - public function setUrl(?string $url): void - { - $this->url = $url; - } - - /** - * Returns Image Url. - * The URL of the item's image. File type and size restrictions apply. An image that violates these - * restrictions will not be honored. - */ - public function getImageUrl(): ?string - { - return $this->imageUrl; - } - - /** - * Sets Image Url. - * The URL of the item's image. File type and size restrictions apply. An image that violates these - * restrictions will not be honored. - * - * @maps image_url - */ - public function setImageUrl(?string $imageUrl): void - { - $this->imageUrl = $imageUrl; - } - - /** - * Returns Upc. - * The Universal Product Code of the item. - */ - public function getUpc(): ?UniversalProductCode - { - return $this->upc; - } - - /** - * Sets Upc. - * The Universal Product Code of the item. - * - * @maps upc - */ - public function setUpc(?UniversalProductCode $upc): void - { - $this->upc = $upc; - } - - /** - * 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->quantity)) { - $json['quantity'] = $this->quantity; - } - if (isset($this->sku)) { - $json['sku'] = $this->sku; - } - if (isset($this->url)) { - $json['url'] = $this->url; - } - if (isset($this->imageUrl)) { - $json['image_url'] = $this->imageUrl; - } - if (isset($this->upc)) { - $json['upc'] = $this->upc; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/OrderTrackerRequest.php b/src/Models/OrderTrackerRequest.php deleted file mode 100644 index fb59eb1..0000000 --- a/src/Models/OrderTrackerRequest.php +++ /dev/null @@ -1,228 +0,0 @@ -captureId = $captureId; - } - - /** - * Returns Tracking Number. - * The tracking number for the shipment. This property supports Unicode. - */ - public function getTrackingNumber(): ?string - { - return $this->trackingNumber; - } - - /** - * Sets Tracking Number. - * The tracking number for the shipment. This property supports Unicode. - * - * @maps tracking_number - */ - public function setTrackingNumber(?string $trackingNumber): void - { - $this->trackingNumber = $trackingNumber; - } - - /** - * Returns Carrier. - * 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. - */ - public function getCarrier(): ?string - { - return $this->carrier; - } - - /** - * Sets Carrier. - * 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. - * - * @maps carrier - */ - public function setCarrier(?string $carrier): void - { - $this->carrier = $carrier; - } - - /** - * Returns Carrier Name Other. - * The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER. - * This property supports Unicode. - */ - public function getCarrierNameOther(): ?string - { - return $this->carrierNameOther; - } - - /** - * Sets Carrier Name Other. - * The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER. - * This property supports Unicode. - * - * @maps carrier_name_other - */ - public function setCarrierNameOther(?string $carrierNameOther): void - { - $this->carrierNameOther = $carrierNameOther; - } - - /** - * Returns Capture Id. - * The PayPal capture ID. - */ - public function getCaptureId(): string - { - return $this->captureId; - } - - /** - * Sets Capture Id. - * The PayPal capture ID. - * - * @required - * @maps capture_id - */ - public function setCaptureId(string $captureId): void - { - $this->captureId = $captureId; - } - - /** - * 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. - */ - public function getNotifyPayer(): ?bool - { - return $this->notifyPayer; - } - - /** - * 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. - * - * @maps notify_payer - */ - public function setNotifyPayer(?bool $notifyPayer): void - { - $this->notifyPayer = $notifyPayer; - } - - /** - * Returns Items. - * An array of details of items in the shipment. - * - * @return OrderTrackerItem[]|null - */ - public function getItems(): ?array - { - return $this->items; - } - - /** - * Sets Items. - * An array of details of items in the shipment. - * - * @maps items - * - * @param OrderTrackerItem[]|null $items - */ - public function setItems(?array $items): void - { - $this->items = $items; - } - - /** - * 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->trackingNumber)) { - $json['tracking_number'] = $this->trackingNumber; - } - if (isset($this->carrier)) { - $json['carrier'] = ShipmentCarrier::checkValue($this->carrier); - } - if (isset($this->carrierNameOther)) { - $json['carrier_name_other'] = $this->carrierNameOther; - } - $json['capture_id'] = $this->captureId; - if (isset($this->notifyPayer)) { - $json['notify_payer'] = $this->notifyPayer; - } - if (isset($this->items)) { - $json['items'] = $this->items; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/OrderTrackerResponse.php b/src/Models/OrderTrackerResponse.php deleted file mode 100644 index 395ec97..0000000 --- a/src/Models/OrderTrackerResponse.php +++ /dev/null @@ -1,219 +0,0 @@ -id; - } - - /** - * Sets Id. - * The tracker id. - * - * @maps id - */ - public function setId(?string $id): void - { - $this->id = $id; - } - - /** - * Returns Status. - * The status of the item shipment. - */ - public function getStatus(): ?string - { - return $this->status; - } - - /** - * Sets Status. - * The status of the item shipment. - * - * @maps status - */ - public function setStatus(?string $status): void - { - $this->status = $status; - } - - /** - * Returns Items. - * An array of details of items in the shipment. - * - * @return OrderTrackerItem[]|null - */ - public function getItems(): ?array - { - return $this->items; - } - - /** - * Sets Items. - * An array of details of items in the shipment. - * - * @maps items - * - * @param OrderTrackerItem[]|null $items - */ - public function setItems(?array $items): void - { - $this->items = $items; - } - - /** - * Returns Links. - * An array of request-related HATEOAS links. - * - * @return LinkDescription[]|null - */ - public function getLinks(): ?array - { - return $this->links; - } - - /** - * Sets Links. - * An array of request-related HATEOAS links. - * - * @maps links - * - * @param LinkDescription[]|null $links - */ - public function setLinks(?array $links): void - { - $this->links = $links; - } - - /** - * 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; - } - - /** - * 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->status)) { - $json['status'] = OrderTrackerStatus::checkValue($this->status); - } - if (isset($this->items)) { - $json['items'] = $this->items; - } - if (isset($this->links)) { - $json['links'] = $this->links; - } - 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/OrderTrackerStatus.php b/src/Models/OrderTrackerStatus.php deleted file mode 100644 index 76f5203..0000000 --- a/src/Models/OrderTrackerStatus.php +++ /dev/null @@ -1,45 +0,0 @@ -name; - } - - /** - * Sets Name. - * The full name representation like Mr J Smith. - * - * @maps name - */ - public function setName(?string $name): void - { - $this->name = $name; - } - - /** - * 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 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 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 [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 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 - */ - public function setCountryCode(?string $countryCode): void - { - $this->countryCode = $countryCode; - } - - /** - * Returns Payment Descriptor. - * P24 generated payment description. - */ - public function getPaymentDescriptor(): ?string - { - return $this->paymentDescriptor; - } - - /** - * Sets Payment Descriptor. - * P24 generated payment description. - * - * @maps payment_descriptor - */ - public function setPaymentDescriptor(?string $paymentDescriptor): void - { - $this->paymentDescriptor = $paymentDescriptor; - } - - /** - * Returns Method Id. - * Numeric identifier of the payment scheme or bank used for the payment. - */ - public function getMethodId(): ?string - { - return $this->methodId; - } - - /** - * Sets Method Id. - * Numeric identifier of the payment scheme or bank used for the payment. - * - * @maps method_id - */ - public function setMethodId(?string $methodId): void - { - $this->methodId = $methodId; - } - - /** - * Returns Method Description. - * Friendly name of the payment scheme or bank used for the payment. - */ - public function getMethodDescription(): ?string - { - return $this->methodDescription; - } - - /** - * Sets Method Description. - * Friendly name of the payment scheme or bank used for the payment. - * - * @maps method_description - */ - public function setMethodDescription(?string $methodDescription): void - { - $this->methodDescription = $methodDescription; - } - - /** - * 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->email)) { - $json['email'] = $this->email; - } - if (isset($this->countryCode)) { - $json['country_code'] = $this->countryCode; - } - if (isset($this->paymentDescriptor)) { - $json['payment_descriptor'] = $this->paymentDescriptor; - } - if (isset($this->methodId)) { - $json['method_id'] = $this->methodId; - } - if (isset($this->methodDescription)) { - $json['method_description'] = $this->methodDescription; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/P24PaymentRequest.php b/src/Models/P24PaymentRequest.php deleted file mode 100644 index 0a72b36..0000000 --- a/src/Models/P24PaymentRequest.php +++ /dev/null @@ -1,170 +0,0 @@ -name = $name; - $this->email = $email; - $this->countryCode = $countryCode; - } - - /** - * Returns Name. - * The full name representation like Mr J Smith. - */ - public function getName(): string - { - return $this->name; - } - - /** - * Sets Name. - * The full name representation like Mr J Smith. - * - * @required - * @maps name - */ - public function setName(string $name): void - { - $this->name = $name; - } - - /** - * 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 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 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 [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 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; - } - - /** - * Returns Experience Context. - * Customizes the payer experience during the approval process for the payment. - */ - public function getExperienceContext(): ?ExperienceContext - { - return $this->experienceContext; - } - - /** - * Sets Experience Context. - * Customizes the payer experience during the approval process for the payment. - * - * @maps experience_context - */ - public function setExperienceContext(?ExperienceContext $experienceContext): void - { - $this->experienceContext = $experienceContext; - } - - /** - * 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; - $json['email'] = $this->email; - $json['country_code'] = $this->countryCode; - if (isset($this->experienceContext)) { - $json['experience_context'] = $this->experienceContext; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PAResStatus.php b/src/Models/PAResStatus.php deleted file mode 100644 index d6df0c3..0000000 --- a/src/Models/PAResStatus.php +++ /dev/null @@ -1,57 +0,0 @@ -op = $op; - } - - /** - * Returns Op. - * The operation. - */ - public function getOp(): string - { - return $this->op; - } - - /** - * Sets Op. - * The operation. - * - * @required - * @maps op - */ - public function setOp(string $op): void - { - $this->op = $op; - } - - /** - * Returns Path. - * The JSON Pointer to the target document location - * at which to complete the operation. - */ - public function getPath(): ?string - { - return $this->path; - } - - /** - * Sets Path. - * The JSON Pointer to the target document location - * at which to complete the operation. - * - * @maps path - */ - public function setPath(?string $path): void - { - $this->path = $path; - } - - /** - * Returns 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. - * - * @return mixed - */ - public function getValue() - { - return $this->value; - } - - /** - * 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. - * - * @maps value - * - * @param mixed $value - */ - public function setValue($value): void - { - $this->value = $value; - } - - /** - * Returns From. - * The JSON Pointer to the target document location - * from which to move the value. Required for the move operation. - */ - public function getFrom(): ?string - { - return $this->from; - } - - /** - * Sets From. - * The JSON Pointer to the target document location - * from which to move the value. Required for the move operation. - * - * @maps from - */ - public function setFrom(?string $from): void - { - $this->from = $from; - } - - /** - * 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['op'] = PatchOp::checkValue($this->op); - if (isset($this->path)) { - $json['path'] = $this->path; - } - if (isset($this->value)) { - $json['value'] = $this->value; - } - if (isset($this->from)) { - $json['from'] = $this->from; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PatchOp.php b/src/Models/PatchOp.php deleted file mode 100644 index 504afec..0000000 --- a/src/Models/PatchOp.php +++ /dev/null @@ -1,53 +0,0 @@ -Continue or Pay Now checkout flow. - */ -class PayPalExperienceUserAction -{ - 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 - */ - 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."); - } -} diff --git a/src/Models/PayPalPaymentToken.php b/src/Models/PayPalPaymentToken.php deleted file mode 100644 index df5d729..0000000 --- a/src/Models/PayPalPaymentToken.php +++ /dev/null @@ -1,396 +0,0 @@ -description; - } - - /** - * Sets Description. - * The description displayed to the consumer on the approval flow for a digital wallet, as well as on - * the merchant view of the payment token management experience. exp: PayPal.com. - * - * @maps description - */ - public function setDescription(?string $description): void - { - $this->description = $description; - } - - /** - * Returns Shipping. - * The shipping details. - */ - public function getShipping(): ?VaultedDigitalWalletShippingDetails - { - return $this->shipping; - } - - /** - * Sets Shipping. - * The shipping details. - * - * @maps shipping - */ - public function setShipping(?VaultedDigitalWalletShippingDetails $shipping): void - { - $this->shipping = $shipping; - } - - /** - * Returns Permit Multiple Payment Tokens. - * Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the - * customer has not logged in at merchant/platform. The payment token thus generated, can then also be - * used to create the customer account at merchant/platform. Use this also when multiple payment tokens - * are required for the same payer, different customer at merchant/platform. This helps to identify - * customers distinctly even though they may share the same PayPal account. This only applies to PayPal - * payment source. - */ - public function getPermitMultiplePaymentTokens(): ?bool - { - return $this->permitMultiplePaymentTokens; - } - - /** - * Sets Permit Multiple Payment Tokens. - * Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the - * customer has not logged in at merchant/platform. The payment token thus generated, can then also be - * used to create the customer account at merchant/platform. Use this also when multiple payment tokens - * are required for the same payer, different customer at merchant/platform. This helps to identify - * customers distinctly even though they may share the same PayPal account. This only applies to PayPal - * payment source. - * - * @maps permit_multiple_payment_tokens - */ - public function setPermitMultiplePaymentTokens(?bool $permitMultiplePaymentTokens): void - { - $this->permitMultiplePaymentTokens = $permitMultiplePaymentTokens; - } - - /** - * Returns Usage Type. - * The usage type associated with a digital wallet payment token. - */ - public function getUsageType(): ?string - { - return $this->usageType; - } - - /** - * Sets Usage Type. - * The usage type associated with a digital wallet payment token. - * - * @maps usage_type - */ - public function setUsageType(?string $usageType): void - { - $this->usageType = $usageType; - } - - /** - * Returns Customer Type. - * 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. - */ - public function getCustomerType(): ?string - { - return $this->customerType; - } - - /** - * Sets Customer Type. - * 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. - * - * @maps customer_type - */ - public function setCustomerType(?string $customerType): void - { - $this->customerType = $customerType; - } - - /** - * 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 Payer Id. - * The account identifier for a PayPal account. - */ - public function getPayerId(): ?string - { - return $this->payerId; - } - - /** - * Sets Payer Id. - * The account identifier for a PayPal account. - * - * @maps payer_id - */ - public function setPayerId(?string $payerId): void - { - $this->payerId = $payerId; - } - - /** - * 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 Phone. - * The phone information. - */ - public function getPhone(): ?PhoneWithType - { - return $this->phone; - } - - /** - * Sets Phone. - * The phone information. - * - * @maps phone - */ - public function setPhone(?PhoneWithType $phone): void - { - $this->phone = $phone; - } - - /** - * Returns 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 getAddress(): ?Address - { - return $this->address; - } - - /** - * Sets 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). - * - * @maps address - */ - public function setAddress(?Address $address): void - { - $this->address = $address; - } - - /** - * Returns Account Id. - * The account identifier for a PayPal account. - */ - public function getAccountId(): ?string - { - return $this->accountId; - } - - /** - * Sets Account Id. - * The account identifier for a PayPal account. - * - * @maps account_id - */ - public function setAccountId(?string $accountId): void - { - $this->accountId = $accountId; - } - - /** - * 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->description)) { - $json['description'] = $this->description; - } - if (isset($this->shipping)) { - $json['shipping'] = $this->shipping; - } - if (isset($this->permitMultiplePaymentTokens)) { - $json['permit_multiple_payment_tokens'] = $this->permitMultiplePaymentTokens; - } - if (isset($this->usageType)) { - $json['usage_type'] = $this->usageType; - } - if (isset($this->customerType)) { - $json['customer_type'] = $this->customerType; - } - if (isset($this->emailAddress)) { - $json['email_address'] = $this->emailAddress; - } - if (isset($this->payerId)) { - $json['payer_id'] = $this->payerId; - } - if (isset($this->name)) { - $json['name'] = $this->name; - } - if (isset($this->phone)) { - $json['phone'] = $this->phone; - } - if (isset($this->address)) { - $json['address'] = $this->address; - } - if (isset($this->accountId)) { - $json['account_id'] = $this->accountId; - } - if (isset($this->phoneNumber)) { - $json['phone_number'] = $this->phoneNumber; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PayPalPaymentTokenCustomerType.php b/src/Models/PayPalPaymentTokenCustomerType.php deleted file mode 100644 index a5ee999..0000000 --- a/src/Models/PayPalPaymentTokenCustomerType.php +++ /dev/null @@ -1,46 +0,0 @@ -vaultId; - } - - /** - * Sets Vault Id. - * The PayPal-generated ID for the vaulted payment source. This ID should be stored on the merchant's - * server so the saved payment source can be used for future transactions. - * - * @maps vault_id - */ - public function setVaultId(?string $vaultId): void - { - $this->vaultId = $vaultId; - } - - /** - * 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 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 Phone. - * The phone information. - */ - public function getPhone(): ?PhoneWithType - { - return $this->phone; - } - - /** - * Sets Phone. - * The phone information. - * - * @maps phone - */ - public function setPhone(?PhoneWithType $phone): void - { - $this->phone = $phone; - } - - /** - * Returns Birth 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 getBirthDate(): ?string - { - return $this->birthDate; - } - - /** - * Sets Birth 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 birth_date - */ - public function setBirthDate(?string $birthDate): void - { - $this->birthDate = $birthDate; - } - - /** - * Returns Tax Info. - * The tax ID of the customer. The customer is also known as the payer. Both `tax_id` and `tax_id_type` - * are required. - */ - public function getTaxInfo(): ?TaxInfo - { - return $this->taxInfo; - } - - /** - * Sets Tax Info. - * The tax ID of the customer. The customer is also known as the payer. Both `tax_id` and `tax_id_type` - * are required. - * - * @maps tax_info - */ - public function setTaxInfo(?TaxInfo $taxInfo): void - { - $this->taxInfo = $taxInfo; - } - - /** - * Returns 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 getAddress(): ?Address - { - return $this->address; - } - - /** - * Sets 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). - * - * @maps address - */ - public function setAddress(?Address $address): void - { - $this->address = $address; - } - - /** - * Returns Attributes. - * Additional attributes associated with the use of this PayPal Wallet. - */ - public function getAttributes(): ?PayPalWalletAttributes - { - return $this->attributes; - } - - /** - * Sets Attributes. - * Additional attributes associated with the use of this PayPal Wallet. - * - * @maps attributes - */ - public function setAttributes(?PayPalWalletAttributes $attributes): void - { - $this->attributes = $attributes; - } - - /** - * Returns Experience Context. - * 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 - { - return $this->experienceContext; - } - - /** - * Sets Experience Context. - * 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 - */ - public function setExperienceContext(?PayPalWalletExperienceContext $experienceContext): void - { - $this->experienceContext = $experienceContext; - } - - /** - * Returns Billing Agreement Id. - * The PayPal billing agreement ID. References an approved recurring payment for goods or services. - */ - public function getBillingAgreementId(): ?string - { - return $this->billingAgreementId; - } - - /** - * Sets Billing Agreement Id. - * The PayPal billing agreement ID. References an approved recurring payment for goods or services. - * - * @maps billing_agreement_id - */ - public function setBillingAgreementId(?string $billingAgreementId): void - { - $this->billingAgreementId = $billingAgreementId; - } - - /** - * 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->vaultId)) { - $json['vault_id'] = $this->vaultId; - } - if (isset($this->emailAddress)) { - $json['email_address'] = $this->emailAddress; - } - if (isset($this->name)) { - $json['name'] = $this->name; - } - if (isset($this->phone)) { - $json['phone'] = $this->phone; - } - if (isset($this->birthDate)) { - $json['birth_date'] = $this->birthDate; - } - if (isset($this->taxInfo)) { - $json['tax_info'] = $this->taxInfo; - } - if (isset($this->address)) { - $json['address'] = $this->address; - } - if (isset($this->attributes)) { - $json['attributes'] = $this->attributes; - } - if (isset($this->experienceContext)) { - $json['experience_context'] = $this->experienceContext; - } - if (isset($this->billingAgreementId)) { - $json['billing_agreement_id'] = $this->billingAgreementId; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PayPalWalletAccountVerificationStatus.php b/src/Models/PayPalWalletAccountVerificationStatus.php deleted file mode 100644 index d14c93c..0000000 --- a/src/Models/PayPalWalletAccountVerificationStatus.php +++ /dev/null @@ -1,46 +0,0 @@ -customer; - } - - /** - * Sets Customer. - * - * @maps customer - */ - public function setCustomer(?PayPalWalletCustomerRequest $customer): void - { - $this->customer = $customer; - } - - /** - * Returns Vault. - */ - public function getVault(): ?PayPalWalletVaultInstruction - { - return $this->vault; - } - - /** - * Sets Vault. - * - * @maps vault - */ - public function setVault(?PayPalWalletVaultInstruction $vault): void - { - $this->vault = $vault; - } - - /** - * 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; - } - if (isset($this->vault)) { - $json['vault'] = $this->vault; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PayPalWalletAttributesResponse.php b/src/Models/PayPalWalletAttributesResponse.php deleted file mode 100644 index 6e250de..0000000 --- a/src/Models/PayPalWalletAttributesResponse.php +++ /dev/null @@ -1,97 +0,0 @@ -vault; - } - - /** - * Sets Vault. - * The details about a saved PayPal Wallet payment source. - * - * @maps vault - */ - public function setVault(?PayPalWalletVaultResponse $vault): void - { - $this->vault = $vault; - } - - /** - * Returns Cobranded Cards. - * An array of merchant cobranded cards used by buyer to complete an order. This array will be present - * if a merchant has onboarded their cobranded card with PayPal and provided corresponding label(s). - * - * @return CobrandedCard[]|null - */ - public function getCobrandedCards(): ?array - { - return $this->cobrandedCards; - } - - /** - * Sets Cobranded Cards. - * An array of merchant cobranded cards used by buyer to complete an order. This array will be present - * if a merchant has onboarded their cobranded card with PayPal and provided corresponding label(s). - * - * @maps cobranded_cards - * - * @param CobrandedCard[]|null $cobrandedCards - */ - public function setCobrandedCards(?array $cobrandedCards): void - { - $this->cobrandedCards = $cobrandedCards; - } - - /** - * 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->vault)) { - $json['vault'] = $this->vault; - } - if (isset($this->cobrandedCards)) { - $json['cobranded_cards'] = $this->cobrandedCards; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PayPalWalletCustomer.php b/src/Models/PayPalWalletCustomer.php deleted file mode 100644 index 6f9d9d1..0000000 --- a/src/Models/PayPalWalletCustomer.php +++ /dev/null @@ -1,157 +0,0 @@ -id; - } - - /** - * Sets Id. - * The unique ID for a customer generated by PayPal. - * - * @maps id - */ - public function setId(?string $id): void - { - $this->id = $id; - } - - /** - * 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. - * The phone information. - */ - public function getPhone(): ?PhoneWithType - { - return $this->phone; - } - - /** - * Sets Phone. - * The phone information. - * - * @maps phone - */ - public function setPhone(?PhoneWithType $phone): void - { - $this->phone = $phone; - } - - /** - * 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; - } - - /** - * 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->emailAddress)) { - $json['email_address'] = $this->emailAddress; - } - if (isset($this->phone)) { - $json['phone'] = $this->phone; - } - if (isset($this->merchantCustomerId)) { - $json['merchant_customer_id'] = $this->merchantCustomerId; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PayPalWalletCustomerRequest.php b/src/Models/PayPalWalletCustomerRequest.php deleted file mode 100644 index 1d004a0..0000000 --- a/src/Models/PayPalWalletCustomerRequest.php +++ /dev/null @@ -1,154 +0,0 @@ -id; - } - - /** - * Sets Id. - * The unique ID for a customer generated by PayPal. - * - * @maps id - */ - public function setId(?string $id): void - { - $this->id = $id; - } - - /** - * 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. - * The phone information. - */ - public function getPhone(): ?PhoneWithType - { - return $this->phone; - } - - /** - * Sets Phone. - * The phone information. - * - * @maps phone - */ - public function setPhone(?PhoneWithType $phone): void - { - $this->phone = $phone; - } - - /** - * 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; - } - - /** - * 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->emailAddress)) { - $json['email_address'] = $this->emailAddress; - } - if (isset($this->phone)) { - $json['phone'] = $this->phone; - } - if (isset($this->merchantCustomerId)) { - $json['merchant_customer_id'] = $this->merchantCustomerId; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PayPalWalletExperienceContext.php b/src/Models/PayPalWalletExperienceContext.php deleted file mode 100644 index e8bc12c..0000000 --- a/src/Models/PayPalWalletExperienceContext.php +++ /dev/null @@ -1,277 +0,0 @@ -Note: Partners and Marketplaces might configure brand_name - * and shipping_preference during partner account setup, which overrides the request - * values. - */ -class PayPalWalletExperienceContext implements \JsonSerializable -{ - /** - * @var string|null - */ - private $brandName; - - /** - * @var string|null - */ - private $locale; - - /** - * @var string|null - */ - private $shippingPreference = ShippingPreference::GET_FROM_FILE; - - /** - * @var string|null - */ - private $returnUrl; - - /** - * @var string|null - */ - private $cancelUrl; - - /** - * @var string|null - */ - private $landingPage = PayPalExperienceLandingPage::NO_PREFERENCE; - - /** - * @var string|null - */ - private $userAction = PayPalExperienceUserAction::CONTINUE_; - - /** - * @var string|null - */ - private $paymentMethodPreference = PayeePaymentMethodPreference::UNRESTRICTED; - - /** - * Returns Brand Name. - * 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. - */ - public function getBrandName(): ?string - { - return $this->brandName; - } - - /** - * Sets Brand Name. - * 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. - * - * @maps brand_name - */ - public function setBrandName(?string $brandName): void - { - $this->brandName = $brandName; - } - - /** - * Returns Locale. - * 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/). - */ - public function getLocale(): ?string - { - return $this->locale; - } - - /** - * Sets Locale. - * 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/). - * - * @maps locale - */ - public function setLocale(?string $locale): void - { - $this->locale = $locale; - } - - /** - * Returns Shipping Preference. - * The location from which the shipping address is derived. - */ - public function getShippingPreference(): ?string - { - return $this->shippingPreference; - } - - /** - * Sets Shipping Preference. - * The location from which the shipping address is derived. - * - * @maps shipping_preference - */ - public function setShippingPreference(?string $shippingPreference): void - { - $this->shippingPreference = $shippingPreference; - } - - /** - * Returns Return Url. - * Describes the URL. - */ - public function getReturnUrl(): ?string - { - return $this->returnUrl; - } - - /** - * Sets Return Url. - * Describes the URL. - * - * @maps return_url - */ - public function setReturnUrl(?string $returnUrl): void - { - $this->returnUrl = $returnUrl; - } - - /** - * Returns Cancel Url. - * Describes the URL. - */ - public function getCancelUrl(): ?string - { - return $this->cancelUrl; - } - - /** - * Sets Cancel Url. - * Describes the URL. - * - * @maps cancel_url - */ - public function setCancelUrl(?string $cancelUrl): void - { - $this->cancelUrl = $cancelUrl; - } - - /** - * Returns Landing Page. - * The type of landing page to show on the PayPal site for customer checkout. - */ - public function getLandingPage(): ?string - { - return $this->landingPage; - } - - /** - * Sets Landing Page. - * The type of landing page to show on the PayPal site for customer checkout. - * - * @maps landing_page - */ - public function setLandingPage(?string $landingPage): void - { - $this->landingPage = $landingPage; - } - - /** - * Returns User Action. - * Configures a Continue or Pay Now checkout flow. - */ - public function getUserAction(): ?string - { - return $this->userAction; - } - - /** - * Sets User Action. - * Configures a Continue or Pay Now checkout flow. - * - * @maps user_action - */ - public function setUserAction(?string $userAction): void - { - $this->userAction = $userAction; - } - - /** - * Returns Payment Method Preference. - * The merchant-preferred payment methods. - */ - public function getPaymentMethodPreference(): ?string - { - return $this->paymentMethodPreference; - } - - /** - * Sets Payment Method Preference. - * The merchant-preferred payment methods. - * - * @maps payment_method_preference - */ - public function setPaymentMethodPreference(?string $paymentMethodPreference): void - { - $this->paymentMethodPreference = $paymentMethodPreference; - } - - /** - * 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->brandName)) { - $json['brand_name'] = $this->brandName; - } - if (isset($this->locale)) { - $json['locale'] = $this->locale; - } - if (isset($this->shippingPreference)) { - $json['shipping_preference'] = ShippingPreference::checkValue($this->shippingPreference); - } - if (isset($this->returnUrl)) { - $json['return_url'] = $this->returnUrl; - } - if (isset($this->cancelUrl)) { - $json['cancel_url'] = $this->cancelUrl; - } - if (isset($this->landingPage)) { - $json['landing_page'] = PayPalExperienceLandingPage::checkValue($this->landingPage); - } - if (isset($this->userAction)) { - $json['user_action'] = PayPalExperienceUserAction::checkValue($this->userAction); - } - if (isset($this->paymentMethodPreference)) { - $json['payment_method_preference'] = - PayeePaymentMethodPreference::checkValue( - $this->paymentMethodPreference - ); - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PayPalWalletResponse.php b/src/Models/PayPalWalletResponse.php deleted file mode 100644 index c926a42..0000000 --- a/src/Models/PayPalWalletResponse.php +++ /dev/null @@ -1,345 +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 @ 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 Account Id. - * The PayPal payer ID, which is a masked version of the PayPal account number intended for use with - * third parties. The account number is reversibly encrypted and a proprietary variant of Base32 is - * used to encode the result. - */ - public function getAccountId(): ?string - { - return $this->accountId; - } - - /** - * Sets Account Id. - * The PayPal payer ID, which is a masked version of the PayPal account number intended for use with - * third parties. The account number is reversibly encrypted and a proprietary variant of Base32 is - * used to encode the result. - * - * @maps account_id - */ - public function setAccountId(?string $accountId): void - { - $this->accountId = $accountId; - } - - /** - * Returns Account Status. - * The account status indicates whether the buyer has verified the financial details associated with - * their PayPal account. - */ - public function getAccountStatus(): ?string - { - return $this->accountStatus; - } - - /** - * Sets Account Status. - * The account status indicates whether the buyer has verified the financial details associated with - * their PayPal account. - * - * @maps account_status - */ - public function setAccountStatus(?string $accountStatus): void - { - $this->accountStatus = $accountStatus; - } - - /** - * 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 Phone Type. - * The phone type. - */ - public function getPhoneType(): ?string - { - return $this->phoneType; - } - - /** - * Sets Phone Type. - * The phone type. - * - * @maps phone_type - */ - public function setPhoneType(?string $phoneType): void - { - $this->phoneType = $phoneType; - } - - /** - * 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(): ?PhoneNumber - { - 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(?PhoneNumber $phoneNumber): void - { - $this->phoneNumber = $phoneNumber; - } - - /** - * Returns Birth 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 getBirthDate(): ?string - { - return $this->birthDate; - } - - /** - * Sets Birth 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 birth_date - */ - public function setBirthDate(?string $birthDate): void - { - $this->birthDate = $birthDate; - } - - /** - * Returns Tax Info. - * The tax ID of the customer. The customer is also known as the payer. Both `tax_id` and `tax_id_type` - * are required. - */ - public function getTaxInfo(): ?TaxInfo - { - return $this->taxInfo; - } - - /** - * Sets Tax Info. - * The tax ID of the customer. The customer is also known as the payer. Both `tax_id` and `tax_id_type` - * are required. - * - * @maps tax_info - */ - public function setTaxInfo(?TaxInfo $taxInfo): void - { - $this->taxInfo = $taxInfo; - } - - /** - * Returns 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 getAddress(): ?Address - { - return $this->address; - } - - /** - * Sets 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). - * - * @maps address - */ - public function setAddress(?Address $address): void - { - $this->address = $address; - } - - /** - * Returns Attributes. - * Additional attributes associated with the use of a PayPal Wallet. - */ - public function getAttributes(): ?PayPalWalletAttributesResponse - { - return $this->attributes; - } - - /** - * Sets Attributes. - * Additional attributes associated with the use of a PayPal Wallet. - * - * @maps attributes - */ - public function setAttributes(?PayPalWalletAttributesResponse $attributes): void - { - $this->attributes = $attributes; - } - - /** - * 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->accountId)) { - $json['account_id'] = $this->accountId; - } - if (isset($this->accountStatus)) { - $json['account_status'] = PayPalWalletAccountVerificationStatus::checkValue($this->accountStatus); - } - if (isset($this->name)) { - $json['name'] = $this->name; - } - if (isset($this->phoneType)) { - $json['phone_type'] = PhoneType::checkValue($this->phoneType); - } - if (isset($this->phoneNumber)) { - $json['phone_number'] = $this->phoneNumber; - } - if (isset($this->birthDate)) { - $json['birth_date'] = $this->birthDate; - } - if (isset($this->taxInfo)) { - $json['tax_info'] = $this->taxInfo; - } - if (isset($this->address)) { - $json['address'] = $this->address; - } - if (isset($this->attributes)) { - $json['attributes'] = $this->attributes; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PayPalWalletVaultInstruction.php b/src/Models/PayPalWalletVaultInstruction.php deleted file mode 100644 index a535712..0000000 --- a/src/Models/PayPalWalletVaultInstruction.php +++ /dev/null @@ -1,221 +0,0 @@ -usageType = $usageType; - } - - /** - * Returns Store in Vault. - * Defines how and when the payment source gets vaulted. - */ - public function getStoreInVault(): ?string - { - return $this->storeInVault; - } - - /** - * Sets Store in Vault. - * Defines how and when the payment source gets vaulted. - * - * @maps store_in_vault - */ - public function setStoreInVault(?string $storeInVault): void - { - $this->storeInVault = $storeInVault; - } - - /** - * Returns Description. - * The description displayed to PayPal consumer on the approval flow for PayPal, as well as on the - * PayPal payment token management experience on PayPal.com. - */ - public function getDescription(): ?string - { - return $this->description; - } - - /** - * Sets Description. - * The description displayed to PayPal consumer on the approval flow for PayPal, as well as on the - * PayPal payment token management experience on PayPal.com. - * - * @maps description - */ - public function setDescription(?string $description): void - { - $this->description = $description; - } - - /** - * 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 Type. - * The usage type associated with the PayPal payment token. - */ - public function getUsageType(): string - { - return $this->usageType; - } - - /** - * Sets Usage Type. - * The usage type associated with the PayPal payment token. - * - * @required - * @maps usage_type - */ - public function setUsageType(string $usageType): void - { - $this->usageType = $usageType; - } - - /** - * Returns Customer Type. - * 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. - */ - public function getCustomerType(): ?string - { - return $this->customerType; - } - - /** - * Sets Customer Type. - * 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. - * - * @maps customer_type - */ - public function setCustomerType(?string $customerType): void - { - $this->customerType = $customerType; - } - - /** - * Returns Permit Multiple Payment Tokens. - * Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the - * customer has not logged in at merchant/platform. The payment token thus generated, can then also be - * used to create the customer account at merchant/platform. Use this also when multiple payment tokens - * are required for the same payer, different customer at merchant/platform. This helps to identify - * customers distinctly even though they may share the same PayPal account. This only applies to PayPal - * payment source. - */ - public function getPermitMultiplePaymentTokens(): ?bool - { - return $this->permitMultiplePaymentTokens; - } - - /** - * Sets Permit Multiple Payment Tokens. - * Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the - * customer has not logged in at merchant/platform. The payment token thus generated, can then also be - * used to create the customer account at merchant/platform. Use this also when multiple payment tokens - * are required for the same payer, different customer at merchant/platform. This helps to identify - * customers distinctly even though they may share the same PayPal account. This only applies to PayPal - * payment source. - * - * @maps permit_multiple_payment_tokens - */ - public function setPermitMultiplePaymentTokens(?bool $permitMultiplePaymentTokens): void - { - $this->permitMultiplePaymentTokens = $permitMultiplePaymentTokens; - } - - /** - * 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->storeInVault)) { - $json['store_in_vault'] = StoreInVaultInstruction::checkValue($this->storeInVault); - } - if (isset($this->description)) { - $json['description'] = $this->description; - } - if (isset($this->usagePattern)) { - $json['usage_pattern'] = PayPalPaymentTokenUsagePattern::checkValue($this->usagePattern); - } - $json['usage_type'] = PayPalPaymentTokenUsageType::checkValue($this->usageType); - if (isset($this->customerType)) { - $json['customer_type'] = PayPalPaymentTokenCustomerType::checkValue($this->customerType); - } - if (isset($this->permitMultiplePaymentTokens)) { - $json['permit_multiple_payment_tokens'] = $this->permitMultiplePaymentTokens; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PayPalWalletVaultResponse.php b/src/Models/PayPalWalletVaultResponse.php deleted file mode 100644 index 9e302ab..0000000 --- a/src/Models/PayPalWalletVaultResponse.php +++ /dev/null @@ -1,151 +0,0 @@ -id; - } - - /** - * Sets Id. - * The PayPal-generated ID for the saved payment source. - * - * @maps id - */ - public function setId(?string $id): void - { - $this->id = $id; - } - - /** - * Returns Status. - * The vault status. - */ - public function getStatus(): ?string - { - return $this->status; - } - - /** - * Sets Status. - * The vault status. - * - * @maps status - */ - public function setStatus(?string $status): void - { - $this->status = $status; - } - - /** - * Returns Links. - * An array of request-related HATEOAS links. - * - * @return LinkDescription[]|null - */ - public function getLinks(): ?array - { - return $this->links; - } - - /** - * Sets Links. - * An array of request-related HATEOAS links. - * - * @maps links - * - * @param LinkDescription[]|null $links - */ - public function setLinks(?array $links): void - { - $this->links = $links; - } - - /** - * Returns Customer. - * The details about a customer in PayPal's system of record. - */ - public function getCustomer(): ?PayPalWalletCustomer - { - return $this->customer; - } - - /** - * Sets Customer. - * The details about a customer in PayPal's system of record. - * - * @maps customer - */ - public function setCustomer(?PayPalWalletCustomer $customer): void - { - $this->customer = $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->id)) { - $json['id'] = $this->id; - } - if (isset($this->status)) { - $json['status'] = PayPalWalletVaultStatus::checkValue($this->status); - } - if (isset($this->links)) { - $json['links'] = $this->links; - } - if (isset($this->customer)) { - $json['customer'] = $this->customer; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PayPalWalletVaultStatus.php b/src/Models/PayPalWalletVaultStatus.php deleted file mode 100644 index 05cb2da..0000000 --- a/src/Models/PayPalWalletVaultStatus.php +++ /dev/null @@ -1,47 +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 @ 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 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 deleted file mode 100644 index 40d1ea9..0000000 --- a/src/Models/PayeeBase.php +++ /dev/null @@ -1,98 +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 @ 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 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/PayeePaymentMethodPreference.php b/src/Models/PayeePaymentMethodPreference.php deleted file mode 100644 index d85d522..0000000 --- a/src/Models/PayeePaymentMethodPreference.php +++ /dev/null @@ -1,45 +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 @ 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 Payer Id. - * The account identifier for a PayPal account. - */ - public function getPayerId(): ?string - { - return $this->payerId; - } - - /** - * Sets Payer Id. - * The account identifier for a PayPal account. - * - * @maps payer_id - */ - public function setPayerId(?string $payerId): void - { - $this->payerId = $payerId; - } - - /** - * 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 Phone. - * The phone information. - */ - public function getPhone(): ?PhoneWithType - { - return $this->phone; - } - - /** - * Sets Phone. - * The phone information. - * - * @maps phone - */ - public function setPhone(?PhoneWithType $phone): void - { - $this->phone = $phone; - } - - /** - * Returns Birth 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 getBirthDate(): ?string - { - return $this->birthDate; - } - - /** - * Sets Birth 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 birth_date - */ - public function setBirthDate(?string $birthDate): void - { - $this->birthDate = $birthDate; - } - - /** - * Returns Tax Info. - * The tax ID of the customer. The customer is also known as the payer. Both `tax_id` and `tax_id_type` - * are required. - */ - public function getTaxInfo(): ?TaxInfo - { - return $this->taxInfo; - } - - /** - * Sets Tax Info. - * The tax ID of the customer. The customer is also known as the payer. Both `tax_id` and `tax_id_type` - * are required. - * - * @maps tax_info - */ - public function setTaxInfo(?TaxInfo $taxInfo): void - { - $this->taxInfo = $taxInfo; - } - - /** - * Returns 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 getAddress(): ?Address - { - return $this->address; - } - - /** - * Sets 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). - * - * @maps address - */ - public function setAddress(?Address $address): void - { - $this->address = $address; - } - - /** - * 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->payerId)) { - $json['payer_id'] = $this->payerId; - } - if (isset($this->name)) { - $json['name'] = $this->name; - } - if (isset($this->phone)) { - $json['phone'] = $this->phone; - } - if (isset($this->birthDate)) { - $json['birth_date'] = $this->birthDate; - } - if (isset($this->taxInfo)) { - $json['tax_info'] = $this->taxInfo; - } - if (isset($this->address)) { - $json['address'] = $this->address; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PayerBase.php b/src/Models/PayerBase.php deleted file mode 100644 index 7dba294..0000000 --- a/src/Models/PayerBase.php +++ /dev/null @@ -1,97 +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 @ 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 Payer Id. - * The account identifier for a PayPal account. - */ - public function getPayerId(): ?string - { - return $this->payerId; - } - - /** - * Sets Payer Id. - * The account identifier for a PayPal account. - * - * @maps payer_id - */ - public function setPayerId(?string $payerId): void - { - $this->payerId = $payerId; - } - - /** - * 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->payerId)) { - $json['payer_id'] = $this->payerId; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PaymentAdviceCode.php b/src/Models/PaymentAdviceCode.php deleted file mode 100644 index 694e848..0000000 --- a/src/Models/PaymentAdviceCode.php +++ /dev/null @@ -1,50 +0,0 @@ -status; - } - - /** - * Sets Status. - * The status for the authorized payment. - * - * @maps status - */ - public function setStatus(?string $status): void - { - $this->status = $status; - } - - /** - * Returns Status Details. - * The details of the authorized payment status. - */ - public function getStatusDetails(): ?AuthorizationStatusDetails - { - return $this->statusDetails; - } - - /** - * Sets Status Details. - * The details of the authorized payment status. - * - * @maps status_details - */ - public function setStatusDetails(?AuthorizationStatusDetails $statusDetails): void - { - $this->statusDetails = $statusDetails; - } - - /** - * Returns Id. - * The PayPal-generated ID for the authorized payment. - */ - public function getId(): ?string - { - return $this->id; - } - - /** - * Sets Id. - * The PayPal-generated ID for the authorized 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 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.
    - */ - public function getExpirationTime(): ?string - { - return $this->expirationTime; - } - - /** - * 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.
    - * - * @maps expiration_time - */ - public function setExpirationTime(?string $expirationTime): void - { - $this->expirationTime = $expirationTime; - } - - /** - * 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 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; - } - - /** - * Returns Supplementary Data. - * The supplementary data. - */ - public function getSupplementaryData(): ?PaymentSupplementaryData - { - return $this->supplementaryData; - } - - /** - * Sets Supplementary Data. - * The supplementary data. - * - * @maps supplementary_data - */ - public function setSupplementaryData(?PaymentSupplementaryData $supplementaryData): void - { - $this->supplementaryData = $supplementaryData; - } - - /** - * Returns Payee. - * 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 - { - return $this->payee; - } - - /** - * Sets Payee. - * The details for the merchant who receives the funds and fulfills the order. The merchant is also - * known as the payee. - * - * @maps payee - */ - public function setPayee(?Payee $payee): void - { - $this->payee = $payee; - } - - /** - * 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'] = AuthorizationStatus::checkValue($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->expirationTime)) { - $json['expiration_time'] = $this->expirationTime; - } - if (isset($this->links)) { - $json['links'] = $this->links; - } - if (isset($this->createTime)) { - $json['create_time'] = $this->createTime; - } - if (isset($this->updateTime)) { - $json['update_time'] = $this->updateTime; - } - if (isset($this->supplementaryData)) { - $json['supplementary_data'] = $this->supplementaryData; - } - if (isset($this->payee)) { - $json['payee'] = $this->payee; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PaymentCollection.php b/src/Models/PaymentCollection.php deleted file mode 100644 index 0b76d70..0000000 --- a/src/Models/PaymentCollection.php +++ /dev/null @@ -1,136 +0,0 @@ -authorizations; - } - - /** - * Sets Authorizations. - * An array of authorized payments for a purchase unit. A purchase unit can have zero or more - * authorized payments. - * - * @maps authorizations - * - * @param AuthorizationWithAdditionalData[]|null $authorizations - */ - public function setAuthorizations(?array $authorizations): void - { - $this->authorizations = $authorizations; - } - - /** - * Returns Captures. - * An array of captured payments for a purchase unit. A purchase unit can have zero or more captured - * payments. - * - * @return Capture[]|null - */ - public function getCaptures(): ?array - { - return $this->captures; - } - - /** - * Sets Captures. - * An array of captured payments for a purchase unit. A purchase unit can have zero or more captured - * payments. - * - * @maps captures - * - * @param Capture[]|null $captures - */ - public function setCaptures(?array $captures): void - { - $this->captures = $captures; - } - - /** - * Returns Refunds. - * An array of refunds for a purchase unit. A purchase unit can have zero or more refunds. - * - * @return Refund[]|null - */ - public function getRefunds(): ?array - { - return $this->refunds; - } - - /** - * Sets Refunds. - * An array of refunds for a purchase unit. A purchase unit can have zero or more refunds. - * - * @maps refunds - * - * @param Refund[]|null $refunds - */ - public function setRefunds(?array $refunds): void - { - $this->refunds = $refunds; - } - - /** - * 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->authorizations)) { - $json['authorizations'] = $this->authorizations; - } - if (isset($this->captures)) { - $json['captures'] = $this->captures; - } - if (isset($this->refunds)) { - $json['refunds'] = $this->refunds; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PaymentInitiator.php b/src/Models/PaymentInitiator.php deleted file mode 100644 index 9bf4612..0000000 --- a/src/Models/PaymentInitiator.php +++ /dev/null @@ -1,45 +0,0 @@ -platformFees; - } - - /** - * Sets Platform Fees. - * An array of various fees, commissions, tips, or donations. This field is only applicable to - * merchants that been enabled for PayPal Complete Payments Platform for Marketplaces and Platforms - * capability. - * - * @maps platform_fees - * - * @param PlatformFee[]|null $platformFees - */ - public function setPlatformFees(?array $platformFees): void - { - $this->platformFees = $platformFees; - } - - /** - * 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 Payee Pricing Tier Id. - * This field is only enabled for selected merchants/partners to use and provides the ability to - * trigger a specific pricing rate/plan for a payment transaction. The list of eligible - * 'payee_pricing_tier_id' would be provided to you by your Account Manager. Specifying values other - * than the one provided to you by your account manager would result in an error. - */ - public function getPayeePricingTierId(): ?string - { - return $this->payeePricingTierId; - } - - /** - * Sets Payee Pricing Tier Id. - * This field is only enabled for selected merchants/partners to use and provides the ability to - * trigger a specific pricing rate/plan for a payment transaction. The list of eligible - * 'payee_pricing_tier_id' would be provided to you by your Account Manager. Specifying values other - * than the one provided to you by your account manager would result in an error. - * - * @maps payee_pricing_tier_id - */ - public function setPayeePricingTierId(?string $payeePricingTierId): void - { - $this->payeePricingTierId = $payeePricingTierId; - } - - /** - * Returns Payee Receivable Fx Rate Id. - * FX identifier generated returned by PayPal to be used for payment processing in order to honor FX - * rate (for eligible integrations) to be used when amount is settled/received into the payee account. - */ - public function getPayeeReceivableFxRateId(): ?string - { - return $this->payeeReceivableFxRateId; - } - - /** - * Sets Payee Receivable Fx Rate Id. - * FX identifier generated returned by PayPal to be used for payment processing in order to honor FX - * rate (for eligible integrations) to be used when amount is settled/received into the payee account. - * - * @maps payee_receivable_fx_rate_id - */ - public function setPayeeReceivableFxRateId(?string $payeeReceivableFxRateId): void - { - $this->payeeReceivableFxRateId = $payeeReceivableFxRateId; - } - - /** - * 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->platformFees)) { - $json['platform_fees'] = $this->platformFees; - } - if (isset($this->disbursementMode)) { - $json['disbursement_mode'] = DisbursementMode::checkValue($this->disbursementMode); - } - if (isset($this->payeePricingTierId)) { - $json['payee_pricing_tier_id'] = $this->payeePricingTierId; - } - if (isset($this->payeeReceivableFxRateId)) { - $json['payee_receivable_fx_rate_id'] = $this->payeeReceivableFxRateId; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PaymentMethodPreference.php b/src/Models/PaymentMethodPreference.php deleted file mode 100644 index 4d7b756..0000000 --- a/src/Models/PaymentMethodPreference.php +++ /dev/null @@ -1,101 +0,0 @@ -payeePreferred; - } - - /** - * Sets Payee Preferred. - * The merchant-preferred payment methods. - * - * @maps payee_preferred - */ - public function setPayeePreferred(?string $payeePreferred): void - { - $this->payeePreferred = $payeePreferred; - } - - /** - * Returns Standard Entry Class Code. - * 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 - * compliant, you’ll need to make sure that you retain a compliant authorization for each transaction - * that you originate to the ACH Network using this API. ACH transactions are categorized (using SEC - * codes) by how you capture authorization from the Receiver (the person whose bank account is being - * debited or credited). PayPal supports the following SEC codes. - */ - public function getStandardEntryClassCode(): ?string - { - return $this->standardEntryClassCode; - } - - /** - * Sets Standard Entry Class Code. - * 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 - * compliant, you’ll need to make sure that you retain a compliant authorization for each transaction - * that you originate to the ACH Network using this API. ACH transactions are categorized (using SEC - * codes) by how you capture authorization from the Receiver (the person whose bank account is being - * debited or credited). PayPal supports the following SEC codes. - * - * @maps standard_entry_class_code - */ - public function setStandardEntryClassCode(?string $standardEntryClassCode): void - { - $this->standardEntryClassCode = $standardEntryClassCode; - } - - /** - * 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->payeePreferred)) { - $json['payee_preferred'] = PayeePaymentMethodPreference::checkValue($this->payeePreferred); - } - if (isset($this->standardEntryClassCode)) { - $json['standard_entry_class_code'] = StandardEntryClassCode::checkValue($this->standardEntryClassCode); - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PaymentSource.php b/src/Models/PaymentSource.php deleted file mode 100644 index 0aede23..0000000 --- a/src/Models/PaymentSource.php +++ /dev/null @@ -1,465 +0,0 @@ -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 - { - return $this->card; - } - - /** - * Sets 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. - *
    *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 - */ - public function setCard(?CardRequest $card): void - { - $this->card = $card; - } - - /** - * Returns Token. - * The tokenized payment source to fund a payment. - */ - public function getToken(): ?Token - { - return $this->token; - } - - /** - * Sets Token. - * The tokenized payment source to fund a payment. - * - * @maps token - */ - public function setToken(?Token $token): void - { - $this->token = $token; - } - - /** - * Returns Paypal. - * A resource that identifies a PayPal Wallet is used for payment. - */ - public function getPaypal(): ?PayPalWallet - { - return $this->paypal; - } - - /** - * Sets Paypal. - * A resource that identifies a PayPal Wallet is used for payment. - * - * @maps paypal - */ - public function setPaypal(?PayPalWallet $paypal): void - { - $this->paypal = $paypal; - } - - /** - * Returns Bancontact. - * Information needed to pay using Bancontact. - */ - public function getBancontact(): ?BancontactPaymentRequest - { - return $this->bancontact; - } - - /** - * Sets Bancontact. - * Information needed to pay using Bancontact. - * - * @maps bancontact - */ - public function setBancontact(?BancontactPaymentRequest $bancontact): void - { - $this->bancontact = $bancontact; - } - - /** - * Returns Blik. - * Information needed to pay using BLIK. - */ - public function getBlik(): ?BLIKPaymentRequest - { - return $this->blik; - } - - /** - * Sets Blik. - * Information needed to pay using BLIK. - * - * @maps blik - */ - public function setBlik(?BLIKPaymentRequest $blik): void - { - $this->blik = $blik; - } - - /** - * Returns Eps. - * Information needed to pay using eps. - */ - public function getEps(): ?EPSPaymentRequest - { - return $this->eps; - } - - /** - * Sets Eps. - * Information needed to pay using eps. - * - * @maps eps - */ - public function setEps(?EPSPaymentRequest $eps): void - { - $this->eps = $eps; - } - - /** - * Returns Giropay. - * Information needed to pay using giropay. - */ - public function getGiropay(): ?GiropayPaymentRequest - { - return $this->giropay; - } - - /** - * Sets Giropay. - * Information needed to pay using giropay. - * - * @maps giropay - */ - public function setGiropay(?GiropayPaymentRequest $giropay): void - { - $this->giropay = $giropay; - } - - /** - * Returns Ideal. - * Information needed to pay using iDEAL. - */ - public function getIdeal(): ?IDEALPaymentRequest - { - return $this->ideal; - } - - /** - * Sets Ideal. - * Information needed to pay using iDEAL. - * - * @maps ideal - */ - public function setIdeal(?IDEALPaymentRequest $ideal): void - { - $this->ideal = $ideal; - } - - /** - * Returns Mybank. - * Information needed to pay using MyBank. - */ - public function getMybank(): ?MyBankPaymentRequest - { - return $this->mybank; - } - - /** - * Sets Mybank. - * Information needed to pay using MyBank. - * - * @maps mybank - */ - public function setMybank(?MyBankPaymentRequest $mybank): void - { - $this->mybank = $mybank; - } - - /** - * Returns P 24. - * Information needed to pay using P24 (Przelewy24). - */ - public function getP24(): ?P24PaymentRequest - { - return $this->p24; - } - - /** - * Sets P 24. - * Information needed to pay using P24 (Przelewy24). - * - * @maps p24 - */ - public function setP24(?P24PaymentRequest $p24): void - { - $this->p24 = $p24; - } - - /** - * Returns Sofort. - * Information needed to pay using Sofort. - */ - public function getSofort(): ?SofortPaymentRequest - { - return $this->sofort; - } - - /** - * Sets Sofort. - * Information needed to pay using Sofort. - * - * @maps sofort - */ - public function setSofort(?SofortPaymentRequest $sofort): void - { - $this->sofort = $sofort; - } - - /** - * Returns Trustly. - * Information needed to pay using Trustly. - */ - public function getTrustly(): ?TrustlyPaymentRequest - { - return $this->trustly; - } - - /** - * Sets Trustly. - * Information needed to pay using Trustly. - * - * @maps trustly - */ - public function setTrustly(?TrustlyPaymentRequest $trustly): void - { - $this->trustly = $trustly; - } - - /** - * Returns Apple Pay. - * Information needed to pay using ApplePay. - */ - public function getApplePay(): ?ApplePayRequest - { - return $this->applePay; - } - - /** - * Sets Apple Pay. - * Information needed to pay using ApplePay. - * - * @maps apple_pay - */ - public function setApplePay(?ApplePayRequest $applePay): void - { - $this->applePay = $applePay; - } - - /** - * Returns Google Pay. - * Information needed to pay using Google Pay. - */ - public function getGooglePay(): ?GooglePayRequest - { - return $this->googlePay; - } - - /** - * Sets Google Pay. - * Information needed to pay using Google Pay. - * - * @maps google_pay - */ - public function setGooglePay(?GooglePayRequest $googlePay): void - { - $this->googlePay = $googlePay; - } - - /** - * Returns Venmo. - * Information needed to pay using Venmo. - */ - public function getVenmo(): ?VenmoWalletRequest - { - return $this->venmo; - } - - /** - * Sets Venmo. - * Information needed to pay using Venmo. - * - * @maps venmo - */ - public function setVenmo(?VenmoWalletRequest $venmo): void - { - $this->venmo = $venmo; - } - - /** - * 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->card)) { - $json['card'] = $this->card; - } - if (isset($this->token)) { - $json['token'] = $this->token; - } - if (isset($this->paypal)) { - $json['paypal'] = $this->paypal; - } - if (isset($this->bancontact)) { - $json['bancontact'] = $this->bancontact; - } - if (isset($this->blik)) { - $json['blik'] = $this->blik; - } - if (isset($this->eps)) { - $json['eps'] = $this->eps; - } - if (isset($this->giropay)) { - $json['giropay'] = $this->giropay; - } - if (isset($this->ideal)) { - $json['ideal'] = $this->ideal; - } - if (isset($this->mybank)) { - $json['mybank'] = $this->mybank; - } - if (isset($this->p24)) { - $json['p24'] = $this->p24; - } - if (isset($this->sofort)) { - $json['sofort'] = $this->sofort; - } - if (isset($this->trustly)) { - $json['trustly'] = $this->trustly; - } - if (isset($this->applePay)) { - $json['apple_pay'] = $this->applePay; - } - if (isset($this->googlePay)) { - $json['google_pay'] = $this->googlePay; - } - if (isset($this->venmo)) { - $json['venmo'] = $this->venmo; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PaymentSourceResponse.php b/src/Models/PaymentSourceResponse.php deleted file mode 100644 index 4b8bfa7..0000000 --- a/src/Models/PaymentSourceResponse.php +++ /dev/null @@ -1,427 +0,0 @@ -card; - } - - /** - * Sets Card. - * The payment card to use to fund a payment. Card can be a credit or debit card. - * - * @maps card - */ - public function setCard(?CardResponse $card): void - { - $this->card = $card; - } - - /** - * Returns Paypal. - * The PayPal Wallet response. - */ - public function getPaypal(): ?PayPalWalletResponse - { - return $this->paypal; - } - - /** - * Sets Paypal. - * The PayPal Wallet response. - * - * @maps paypal - */ - public function setPaypal(?PayPalWalletResponse $paypal): void - { - $this->paypal = $paypal; - } - - /** - * Returns Bancontact. - * Information used to pay Bancontact. - */ - public function getBancontact(): ?BancontactPaymentObject - { - return $this->bancontact; - } - - /** - * Sets Bancontact. - * Information used to pay Bancontact. - * - * @maps bancontact - */ - public function setBancontact(?BancontactPaymentObject $bancontact): void - { - $this->bancontact = $bancontact; - } - - /** - * Returns Blik. - * Information used to pay using BLIK. - */ - public function getBlik(): ?BLIKPaymentObject - { - return $this->blik; - } - - /** - * Sets Blik. - * Information used to pay using BLIK. - * - * @maps blik - */ - public function setBlik(?BLIKPaymentObject $blik): void - { - $this->blik = $blik; - } - - /** - * Returns Eps. - * Information used to pay using eps. - */ - public function getEps(): ?EPSPaymentObject - { - return $this->eps; - } - - /** - * Sets Eps. - * Information used to pay using eps. - * - * @maps eps - */ - public function setEps(?EPSPaymentObject $eps): void - { - $this->eps = $eps; - } - - /** - * Returns Giropay. - * Information needed to pay using giropay. - */ - public function getGiropay(): ?GiropayPaymentObject - { - return $this->giropay; - } - - /** - * Sets Giropay. - * Information needed to pay using giropay. - * - * @maps giropay - */ - public function setGiropay(?GiropayPaymentObject $giropay): void - { - $this->giropay = $giropay; - } - - /** - * Returns Ideal. - * Information used to pay using iDEAL. - */ - public function getIdeal(): ?IDEALPaymentObject - { - return $this->ideal; - } - - /** - * Sets Ideal. - * Information used to pay using iDEAL. - * - * @maps ideal - */ - public function setIdeal(?IDEALPaymentObject $ideal): void - { - $this->ideal = $ideal; - } - - /** - * Returns Mybank. - * Information used to pay using MyBank. - */ - public function getMybank(): ?MyBankPaymentObject - { - return $this->mybank; - } - - /** - * Sets Mybank. - * Information used to pay using MyBank. - * - * @maps mybank - */ - public function setMybank(?MyBankPaymentObject $mybank): void - { - $this->mybank = $mybank; - } - - /** - * Returns P 24. - * Information used to pay using P24(Przelewy24). - */ - public function getP24(): ?P24PaymentObject - { - return $this->p24; - } - - /** - * Sets P 24. - * Information used to pay using P24(Przelewy24). - * - * @maps p24 - */ - public function setP24(?P24PaymentObject $p24): void - { - $this->p24 = $p24; - } - - /** - * Returns Sofort. - * Information used to pay using Sofort. - */ - public function getSofort(): ?SofortPaymentObject - { - return $this->sofort; - } - - /** - * Sets Sofort. - * Information used to pay using Sofort. - * - * @maps sofort - */ - public function setSofort(?SofortPaymentObject $sofort): void - { - $this->sofort = $sofort; - } - - /** - * Returns Trustly. - * Information needed to pay using Trustly. - */ - public function getTrustly(): ?TrustlyPaymentObject - { - return $this->trustly; - } - - /** - * Sets Trustly. - * Information needed to pay using Trustly. - * - * @maps trustly - */ - public function setTrustly(?TrustlyPaymentObject $trustly): void - { - $this->trustly = $trustly; - } - - /** - * Returns Apple Pay. - * Information needed to pay using ApplePay. - */ - public function getApplePay(): ?ApplePayPaymentObject - { - return $this->applePay; - } - - /** - * Sets Apple Pay. - * Information needed to pay using ApplePay. - * - * @maps apple_pay - */ - public function setApplePay(?ApplePayPaymentObject $applePay): void - { - $this->applePay = $applePay; - } - - /** - * Returns Google Pay. - * Google Pay Wallet payment data. - */ - public function getGooglePay(): ?GooglePayWalletResponse - { - return $this->googlePay; - } - - /** - * Sets Google Pay. - * Google Pay Wallet payment data. - * - * @maps google_pay - */ - public function setGooglePay(?GooglePayWalletResponse $googlePay): void - { - $this->googlePay = $googlePay; - } - - /** - * Returns Venmo. - * Venmo wallet response. - */ - public function getVenmo(): ?VenmoWalletResponse - { - return $this->venmo; - } - - /** - * Sets Venmo. - * Venmo wallet response. - * - * @maps venmo - */ - public function setVenmo(?VenmoWalletResponse $venmo): void - { - $this->venmo = $venmo; - } - - /** - * 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->card)) { - $json['card'] = $this->card; - } - if (isset($this->paypal)) { - $json['paypal'] = $this->paypal; - } - if (isset($this->bancontact)) { - $json['bancontact'] = $this->bancontact; - } - if (isset($this->blik)) { - $json['blik'] = $this->blik; - } - if (isset($this->eps)) { - $json['eps'] = $this->eps; - } - if (isset($this->giropay)) { - $json['giropay'] = $this->giropay; - } - if (isset($this->ideal)) { - $json['ideal'] = $this->ideal; - } - if (isset($this->mybank)) { - $json['mybank'] = $this->mybank; - } - if (isset($this->p24)) { - $json['p24'] = $this->p24; - } - if (isset($this->sofort)) { - $json['sofort'] = $this->sofort; - } - if (isset($this->trustly)) { - $json['trustly'] = $this->trustly; - } - if (isset($this->applePay)) { - $json['apple_pay'] = $this->applePay; - } - if (isset($this->googlePay)) { - $json['google_pay'] = $this->googlePay; - } - if (isset($this->venmo)) { - $json['venmo'] = $this->venmo; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PaymentSupplementaryData.php b/src/Models/PaymentSupplementaryData.php deleted file mode 100644 index 3025097..0000000 --- a/src/Models/PaymentSupplementaryData.php +++ /dev/null @@ -1,63 +0,0 @@ -relatedIds; - } - - /** - * Sets Related Ids. - * Identifiers related to a specific resource. - * - * @maps related_ids - */ - public function setRelatedIds(?RelatedIdentifiers $relatedIds): void - { - $this->relatedIds = $relatedIds; - } - - /** - * 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->relatedIds)) { - $json['related_ids'] = $this->relatedIds; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PaymentTokenRequest.php b/src/Models/PaymentTokenRequest.php deleted file mode 100644 index f376ea3..0000000 --- a/src/Models/PaymentTokenRequest.php +++ /dev/null @@ -1,98 +0,0 @@ -paymentSource = $paymentSource; - } - - /** - * Returns Customer. - * Customer in merchant's or partner's system of records. - */ - public function getCustomer(): ?CustomerRequest - { - return $this->customer; - } - - /** - * Sets Customer. - * Customer in merchant's or partner's system of records. - * - * @maps customer - */ - public function setCustomer(?CustomerRequest $customer): void - { - $this->customer = $customer; - } - - /** - * Returns Payment Source. - * The payment method to vault with the instrument details. - */ - public function getPaymentSource(): PaymentTokenRequestPaymentSource - { - return $this->paymentSource; - } - - /** - * Sets Payment Source. - * The payment method to vault with the instrument details. - * - * @required - * @maps payment_source - */ - public function setPaymentSource(PaymentTokenRequestPaymentSource $paymentSource): void - { - $this->paymentSource = $paymentSource; - } - - /** - * 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; - } - $json['payment_source'] = $this->paymentSource; - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PaymentTokenRequestCard.php b/src/Models/PaymentTokenRequestCard.php deleted file mode 100644 index d1b165d..0000000 --- a/src/Models/PaymentTokenRequestCard.php +++ /dev/null @@ -1,271 +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 Number. - * The primary account number (PAN) for the payment card. - */ - public function getNumber(): ?string - { - return $this->number; - } - - /** - * Sets Number. - * The primary account number (PAN) for the payment card. - * - * @maps number - */ - public function setNumber(?string $number): void - { - $this->number = $number; - } - - /** - * 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 Security Code. - * 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`. - */ - public function getSecurityCode(): ?string - { - return $this->securityCode; - } - - /** - * Sets Security Code. - * 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`. - * - * @maps security_code - */ - public function setSecurityCode(?string $securityCode): void - { - $this->securityCode = $securityCode; - } - - /** - * 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 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 Billing 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 getBillingAddress(): ?Address - { - return $this->billingAddress; - } - - /** - * Sets Billing 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). - * - * @maps billing_address - */ - public function setBillingAddress(?Address $billingAddress): void - { - $this->billingAddress = $billingAddress; - } - - /** - * Returns Network Transaction Reference. - * - * @return mixed - */ - public function getNetworkTransactionReference() - { - return $this->networkTransactionReference; - } - - /** - * Sets Network Transaction Reference. - * - * @maps network_transaction_reference - * - * @param mixed $networkTransactionReference - */ - public function setNetworkTransactionReference($networkTransactionReference): void - { - $this->networkTransactionReference = $networkTransactionReference; - } - - /** - * 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->number)) { - $json['number'] = $this->number; - } - if (isset($this->expiry)) { - $json['expiry'] = $this->expiry; - } - if (isset($this->securityCode)) { - $json['security_code'] = $this->securityCode; - } - if (isset($this->type)) { - $json['type'] = CardType::checkValue($this->type); - } - if (isset($this->brand)) { - $json['brand'] = CardBrand::checkValue($this->brand); - } - if (isset($this->billingAddress)) { - $json['billing_address'] = $this->billingAddress; - } - if (isset($this->networkTransactionReference)) { - $json['network_transaction_reference'] = $this->networkTransactionReference; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PaymentTokenRequestPaymentSource.php b/src/Models/PaymentTokenRequestPaymentSource.php deleted file mode 100644 index 7b184d0..0000000 --- a/src/Models/PaymentTokenRequestPaymentSource.php +++ /dev/null @@ -1,91 +0,0 @@ -card; - } - - /** - * Sets Card. - * A Resource representing a request to vault a Card. - * - * @maps card - */ - public function setCard(?PaymentTokenRequestCard $card): void - { - $this->card = $card; - } - - /** - * Returns Token. - * The Tokenized Payment Source representing a Request to Vault a Token. - */ - public function getToken(): ?VaultTokenRequest - { - return $this->token; - } - - /** - * Sets Token. - * The Tokenized Payment Source representing a Request to Vault a Token. - * - * @maps token - */ - public function setToken(?VaultTokenRequest $token): void - { - $this->token = $token; - } - - /** - * 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->card)) { - $json['card'] = $this->card; - } - if (isset($this->token)) { - $json['token'] = $this->token; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PaymentTokenResponse.php b/src/Models/PaymentTokenResponse.php deleted file mode 100644 index 457e991..0000000 --- a/src/Models/PaymentTokenResponse.php +++ /dev/null @@ -1,151 +0,0 @@ -id; - } - - /** - * Sets Id. - * The PayPal-generated ID for the vault token. - * - * @maps id - */ - public function setId(?string $id): void - { - $this->id = $id; - } - - /** - * Returns Customer. - * Customer in merchant's or partner's system of records. - */ - public function getCustomer(): ?CustomerRequest - { - return $this->customer; - } - - /** - * Sets Customer. - * Customer in merchant's or partner's system of records. - * - * @maps customer - */ - public function setCustomer(?CustomerRequest $customer): void - { - $this->customer = $customer; - } - - /** - * Returns Payment Source. - * The vaulted payment method details. - */ - public function getPaymentSource(): ?PaymentTokenResponsePaymentSource - { - return $this->paymentSource; - } - - /** - * Sets Payment Source. - * The vaulted payment method details. - * - * @maps payment_source - */ - public function setPaymentSource(?PaymentTokenResponsePaymentSource $paymentSource): void - { - $this->paymentSource = $paymentSource; - } - - /** - * Returns Links. - * An array of related [HATEOAS links](/api/rest/responses/#hateoas). - * - * @return LinkDescription[]|null - */ - public function getLinks(): ?array - { - return $this->links; - } - - /** - * Sets Links. - * An array of related [HATEOAS links](/api/rest/responses/#hateoas). - * - * @maps links - * - * @param LinkDescription[]|null $links - */ - public function setLinks(?array $links): void - { - $this->links = $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->customer)) { - $json['customer'] = $this->customer; - } - if (isset($this->paymentSource)) { - $json['payment_source'] = $this->paymentSource; - } - if (isset($this->links)) { - $json['links'] = $this->links; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PaymentTokenResponsePaymentSource.php b/src/Models/PaymentTokenResponsePaymentSource.php deleted file mode 100644 index 355766d..0000000 --- a/src/Models/PaymentTokenResponsePaymentSource.php +++ /dev/null @@ -1,171 +0,0 @@ -card; - } - - /** - * Sets Card. - * Full representation of a Card Payment Token including network token. - * - * @maps card - */ - public function setCard(?CardPaymentToken $card): void - { - $this->card = $card; - } - - /** - * Returns Paypal. - */ - public function getPaypal(): ?PayPalPaymentToken - { - return $this->paypal; - } - - /** - * Sets Paypal. - * - * @maps paypal - */ - public function setPaypal(?PayPalPaymentToken $paypal): void - { - $this->paypal = $paypal; - } - - /** - * Returns Venmo. - */ - public function getVenmo(): ?VenmoPaymentToken - { - return $this->venmo; - } - - /** - * Sets Venmo. - * - * @maps venmo - */ - public function setVenmo(?VenmoPaymentToken $venmo): void - { - $this->venmo = $venmo; - } - - /** - * Returns Apple Pay. - * A resource representing a response for Apple Pay. - */ - public function getApplePay(): ?ApplePayPaymentToken - { - return $this->applePay; - } - - /** - * Sets Apple Pay. - * A resource representing a response for Apple Pay. - * - * @maps apple_pay - */ - public function setApplePay(?ApplePayPaymentToken $applePay): void - { - $this->applePay = $applePay; - } - - /** - * Returns Bank. - * Full representation of a Bank Payment Token. - */ - public function getBank(): ?BankPaymentToken - { - return $this->bank; - } - - /** - * Sets Bank. - * Full representation of a Bank Payment Token. - * - * @maps bank - */ - public function setBank(?BankPaymentToken $bank): void - { - $this->bank = $bank; - } - - /** - * 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->card)) { - $json['card'] = $this->card; - } - if (isset($this->paypal)) { - $json['paypal'] = $this->paypal; - } - if (isset($this->venmo)) { - $json['venmo'] = $this->venmo; - } - if (isset($this->applePay)) { - $json['apple_pay'] = $this->applePay; - } - if (isset($this->bank)) { - $json['bank'] = $this->bank; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/Phone.php b/src/Models/Phone.php deleted file mode 100644 index 60f1d6a..0000000 --- a/src/Models/Phone.php +++ /dev/null @@ -1,140 +0,0 @@ -countryCode = $countryCode; - $this->nationalNumber = $nationalNumber; - } - - /** - * Returns Country Code. - * The country calling code (CC), in its canonical international [E.164 numbering plan format](https: - * //www.itu.int/rec/T-REC-E.164/en). The combined length of the CC and the national number must not be - * greater than 15 digits. The national number consists of a national destination code (NDC) and - * subscriber number (SN). - */ - public function getCountryCode(): string - { - return $this->countryCode; - } - - /** - * Sets Country Code. - * The country calling code (CC), in its canonical international [E.164 numbering plan format](https: - * //www.itu.int/rec/T-REC-E.164/en). The combined length of the CC and the national number must not be - * greater than 15 digits. The national number consists of a national destination code (NDC) and - * subscriber number (SN). - * - * @required - * @maps country_code - */ - public function setCountryCode(string $countryCode): void - { - $this->countryCode = $countryCode; - } - - /** - * Returns National Number. - * The national number, in its canonical international [E.164 numbering plan format](https://www.itu. - * int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national - * number must not be greater than 15 digits. The national number consists of a national destination - * code (NDC) and subscriber number (SN). - */ - public function getNationalNumber(): string - { - return $this->nationalNumber; - } - - /** - * Sets National Number. - * The national number, in its canonical international [E.164 numbering plan format](https://www.itu. - * int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national - * number must not be greater than 15 digits. The national number consists of a national destination - * code (NDC) and subscriber number (SN). - * - * @required - * @maps national_number - */ - public function setNationalNumber(string $nationalNumber): void - { - $this->nationalNumber = $nationalNumber; - } - - /** - * Returns Extension Number. - * The extension number. - */ - public function getExtensionNumber(): ?string - { - return $this->extensionNumber; - } - - /** - * Sets Extension Number. - * The extension number. - * - * @maps extension_number - */ - public function setExtensionNumber(?string $extensionNumber): void - { - $this->extensionNumber = $extensionNumber; - } - - /** - * 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['country_code'] = $this->countryCode; - $json['national_number'] = $this->nationalNumber; - if (isset($this->extensionNumber)) { - $json['extension_number'] = $this->extensionNumber; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PhoneNumber.php b/src/Models/PhoneNumber.php deleted file mode 100644 index 4a971b4..0000000 --- a/src/Models/PhoneNumber.php +++ /dev/null @@ -1,77 +0,0 @@ -nationalNumber = $nationalNumber; - } - - /** - * Returns National Number. - * The national number, in its canonical international [E.164 numbering plan format](https://www.itu. - * int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national - * number must not be greater than 15 digits. The national number consists of a national destination - * code (NDC) and subscriber number (SN). - */ - public function getNationalNumber(): string - { - return $this->nationalNumber; - } - - /** - * Sets National Number. - * The national number, in its canonical international [E.164 numbering plan format](https://www.itu. - * int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national - * number must not be greater than 15 digits. The national number consists of a national destination - * code (NDC) and subscriber number (SN). - * - * @required - * @maps national_number - */ - public function setNationalNumber(string $nationalNumber): void - { - $this->nationalNumber = $nationalNumber; - } - - /** - * 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['national_number'] = $this->nationalNumber; - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PhoneNumberWithCountryCode.php b/src/Models/PhoneNumberWithCountryCode.php deleted file mode 100644 index d7b5cb8..0000000 --- a/src/Models/PhoneNumberWithCountryCode.php +++ /dev/null @@ -1,112 +0,0 @@ -countryCode = $countryCode; - $this->nationalNumber = $nationalNumber; - } - - /** - * Returns Country Code. - * The country calling code (CC), in its canonical international [E.164 numbering plan format](https: - * //www.itu.int/rec/T-REC-E.164/en). The combined length of the CC and the national number must not be - * greater than 15 digits. The national number consists of a national destination code (NDC) and - * subscriber number (SN). - */ - public function getCountryCode(): string - { - return $this->countryCode; - } - - /** - * Sets Country Code. - * The country calling code (CC), in its canonical international [E.164 numbering plan format](https: - * //www.itu.int/rec/T-REC-E.164/en). The combined length of the CC and the national number must not be - * greater than 15 digits. The national number consists of a national destination code (NDC) and - * subscriber number (SN). - * - * @required - * @maps country_code - */ - public function setCountryCode(string $countryCode): void - { - $this->countryCode = $countryCode; - } - - /** - * Returns National Number. - * The national number, in its canonical international [E.164 numbering plan format](https://www.itu. - * int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national - * number must not be greater than 15 digits. The national number consists of a national destination - * code (NDC) and subscriber number (SN). - */ - public function getNationalNumber(): string - { - return $this->nationalNumber; - } - - /** - * Sets National Number. - * The national number, in its canonical international [E.164 numbering plan format](https://www.itu. - * int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national - * number must not be greater than 15 digits. The national number consists of a national destination - * code (NDC) and subscriber number (SN). - * - * @required - * @maps national_number - */ - public function setNationalNumber(string $nationalNumber): void - { - $this->nationalNumber = $nationalNumber; - } - - /** - * 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['country_code'] = $this->countryCode; - $json['national_number'] = $this->nationalNumber; - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PhoneType.php b/src/Models/PhoneType.php deleted file mode 100644 index f9c1c1e..0000000 --- a/src/Models/PhoneType.php +++ /dev/null @@ -1,51 +0,0 @@ -phoneNumber = $phoneNumber; - } - - /** - * Returns Phone Type. - * The phone type. - */ - public function getPhoneType(): ?string - { - return $this->phoneType; - } - - /** - * Sets Phone Type. - * The phone type. - * - * @maps phone_type - */ - public function setPhoneType(?string $phoneType): void - { - $this->phoneType = $phoneType; - } - - /** - * 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(): PhoneNumber - { - 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). - * - * @required - * @maps phone_number - */ - public function setPhoneNumber(PhoneNumber $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->phoneType)) { - $json['phone_type'] = PhoneType::checkValue($this->phoneType); - } - $json['phone_number'] = $this->phoneNumber; - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PlatformFee.php b/src/Models/PlatformFee.php deleted file mode 100644 index 5566494..0000000 --- a/src/Models/PlatformFee.php +++ /dev/null @@ -1,102 +0,0 @@ -amount = $amount; - } - - /** - * 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. - * - * @required - * @maps amount - */ - public function setAmount(Money $amount): void - { - $this->amount = $amount; - } - - /** - * Returns Payee. - * The details for the merchant who receives the funds and fulfills the order. The merchant is also - * known as the payee. - */ - public function getPayee(): ?PayeeBase - { - return $this->payee; - } - - /** - * Sets Payee. - * The details for the merchant who receives the funds and fulfills the order. The merchant is also - * known as the payee. - * - * @maps payee - */ - public function setPayee(?PayeeBase $payee): void - { - $this->payee = $payee; - } - - /** - * 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['amount'] = $this->amount; - if (isset($this->payee)) { - $json['payee'] = $this->payee; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/ProcessingInstruction.php b/src/Models/ProcessingInstruction.php deleted file mode 100644 index e9087c9..0000000 --- a/src/Models/ProcessingInstruction.php +++ /dev/null @@ -1,45 +0,0 @@ -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; - } - - /** - * 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'] = AVSCode::checkValue($this->avsCode); - } - if (isset($this->cvvCode)) { - $json['cvv_code'] = CVVCode::checkValue($this->cvvCode); - } - if (isset($this->responseCode)) { - $json['response_code'] = ProcessorResponseCode::checkValue($this->responseCode); - } - if (isset($this->paymentAdviceCode)) { - $json['payment_advice_code'] = PaymentAdviceCode::checkValue($this->paymentAdviceCode); - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/ProcessorResponseCode.php b/src/Models/ProcessorResponseCode.php deleted file mode 100644 index 80dee27..0000000 --- a/src/Models/ProcessorResponseCode.php +++ /dev/null @@ -1,504 +0,0 @@ -Note: If there are - * multiple purchase units, reference_id is required for each purchase unit. - */ - public function getReferenceId(): ?string - { - return $this->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 Payee. - * The merchant who receives the funds and fulfills the order. The merchant is also known as the payee. - */ - public function getPayee(): ?Payee - { - return $this->payee; - } - - /** - * Sets Payee. - * The merchant who receives the funds and fulfills the order. The merchant is also known as the payee. - * - * @maps payee - */ - public function setPayee(?Payee $payee): void - { - $this->payee = $payee; - } - - /** - * Returns Payment Instruction. - * Any additional payment instructions to be consider during payment processing. This processing - * instruction is applicable for Capturing an order or Authorizing an Order. - */ - public function getPaymentInstruction(): ?PaymentInstruction - { - return $this->paymentInstruction; - } - - /** - * Sets Payment Instruction. - * Any additional payment instructions to be consider during payment processing. This processing - * instruction is applicable for Capturing an order or Authorizing an Order. - * - * @maps payment_instruction - */ - public function setPaymentInstruction(?PaymentInstruction $paymentInstruction): void - { - $this->paymentInstruction = $paymentInstruction; - } - - /** - * Returns Description. - * The purchase description. - */ - public function getDescription(): ?string - { - return $this->description; - } - - /** - * Sets Description. - * The purchase description. - * - * @maps description - */ - public function setDescription(?string $description): void - { - $this->description = $description; - } - - /** - * 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 Invoice Id. - * The API caller-provided external invoice ID for this order. - */ - public function getInvoiceId(): ?string - { - return $this->invoiceId; - } - - /** - * Sets Invoice Id. - * The API caller-provided external invoice ID for this order. - * - * @maps invoice_id - */ - public function setInvoiceId(?string $invoiceId): void - { - $this->invoiceId = $invoiceId; - } - - /** - * Returns Id. - * 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. - */ - public function getId(): ?string - { - return $this->id; - } - - /** - * Sets Id. - * 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. - * - * @maps id - */ - public function setId(?string $id): void - { - $this->id = $id; - } - - /** - * 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.

    The soft descriptor supports the following ASCII characters: - * For Wallet payments marketplace integrations:
    For unbranded payments (Direct Card) - * marketplace integrations, use a combination of the seller name and phone number. - */ - public function getSoftDescriptor(): ?string - { - return $this->softDescriptor; - } - - /** - * Sets 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.

    The soft descriptor supports the following ASCII characters: - * For Wallet payments marketplace integrations:
    For unbranded payments (Direct Card) - * marketplace integrations, use a combination of the seller name and phone number. - * - * @maps soft_descriptor - */ - public function setSoftDescriptor(?string $softDescriptor): void - { - $this->softDescriptor = $softDescriptor; - } - - /** - * Returns Items. - * An array of items that the customer purchases from the merchant. - * - * @return Item[]|null - */ - public function getItems(): ?array - { - return $this->items; - } - - /** - * Sets Items. - * An array of items that the customer purchases from the merchant. - * - * @maps items - * - * @param Item[]|null $items - */ - public function setItems(?array $items): void - { - $this->items = $items; - } - - /** - * Returns Shipping. - * The order shipping details. - */ - public function getShipping(): ?ShippingWithTrackingDetails - { - return $this->shipping; - } - - /** - * Sets Shipping. - * The order shipping details. - * - * @maps shipping - */ - public function setShipping(?ShippingWithTrackingDetails $shipping): void - { - $this->shipping = $shipping; - } - - /** - * Returns Supplementary Data. - * Supplementary data about a payment. This object passes information that can be used to improve risk - * assessments and processing costs, for example, by providing Level 2 and Level 3 payment data. - */ - public function getSupplementaryData(): ?SupplementaryData - { - return $this->supplementaryData; - } - - /** - * Sets Supplementary Data. - * Supplementary data about a payment. This object passes information that can be used to improve risk - * assessments and processing costs, for example, by providing Level 2 and Level 3 payment data. - * - * @maps supplementary_data - */ - public function setSupplementaryData(?SupplementaryData $supplementaryData): void - { - $this->supplementaryData = $supplementaryData; - } - - /** - * Returns Payments. - * The collection of payments, or transactions, for a purchase unit in an order. For example, - * authorized payments, captured payments, and refunds. - */ - public function getPayments(): ?PaymentCollection - { - return $this->payments; - } - - /** - * Sets Payments. - * The collection of payments, or transactions, for a purchase unit in an order. For example, - * authorized payments, captured payments, and refunds. - * - * @maps payments - */ - public function setPayments(?PaymentCollection $payments): void - { - $this->payments = $payments; - } - - /** - * 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->payee)) { - $json['payee'] = $this->payee; - } - if (isset($this->paymentInstruction)) { - $json['payment_instruction'] = $this->paymentInstruction; - } - if (isset($this->description)) { - $json['description'] = $this->description; - } - if (isset($this->customId)) { - $json['custom_id'] = $this->customId; - } - if (isset($this->invoiceId)) { - $json['invoice_id'] = $this->invoiceId; - } - if (isset($this->id)) { - $json['id'] = $this->id; - } - if (isset($this->softDescriptor)) { - $json['soft_descriptor'] = $this->softDescriptor; - } - if (isset($this->items)) { - $json['items'] = $this->items; - } - if (isset($this->shipping)) { - $json['shipping'] = $this->shipping; - } - if (isset($this->supplementaryData)) { - $json['supplementary_data'] = $this->supplementaryData; - } - if (isset($this->payments)) { - $json['payments'] = $this->payments; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/PurchaseUnitRequest.php b/src/Models/PurchaseUnitRequest.php deleted file mode 100644 index a9e6d0c..0000000 --- a/src/Models/PurchaseUnitRequest.php +++ /dev/null @@ -1,404 +0,0 @@ -amount = $amount; - } - - /** - * 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`. - */ - public function getReferenceId(): ?string - { - return $this->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`. - * - * @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. - * - * @required - * @maps amount - */ - public function setAmount(AmountWithBreakdown $amount): void - { - $this->amount = $amount; - } - - /** - * Returns Payee. - * The merchant who receives the funds and fulfills the order. The merchant is also known as the payee. - */ - public function getPayee(): ?Payee - { - return $this->payee; - } - - /** - * Sets Payee. - * The merchant who receives the funds and fulfills the order. The merchant is also known as the payee. - * - * @maps payee - */ - public function setPayee(?Payee $payee): void - { - $this->payee = $payee; - } - - /** - * Returns Payment Instruction. - * Any additional payment instructions to be consider during payment processing. This processing - * instruction is applicable for Capturing an order or Authorizing an Order. - */ - public function getPaymentInstruction(): ?PaymentInstruction - { - return $this->paymentInstruction; - } - - /** - * Sets Payment Instruction. - * Any additional payment instructions to be consider during payment processing. This processing - * instruction is applicable for Capturing an order or Authorizing an Order. - * - * @maps payment_instruction - */ - public function setPaymentInstruction(?PaymentInstruction $paymentInstruction): void - { - $this->paymentInstruction = $paymentInstruction; - } - - /** - * Returns Description. - * The purchase description. The maximum length of the character is dependent on the type of characters - * used. The character length is specified assuming a US ASCII character. Depending on type of - * character; (e.g. accented character, Japanese characters) the number of characters that that can be - * specified as input might not equal the permissible max length. - */ - public function getDescription(): ?string - { - return $this->description; - } - - /** - * Sets Description. - * The purchase description. The maximum length of the character is dependent on the type of characters - * used. The character length is specified assuming a US ASCII character. Depending on type of - * character; (e.g. accented character, Japanese characters) the number of characters that that can be - * specified as input might not equal the permissible max length. - * - * @maps description - */ - public function setDescription(?string $description): void - { - $this->description = $description; - } - - /** - * Returns Custom Id. - * The API caller-provided external ID. Used to reconcile client transactions with PayPal transactions. - * Appears in transaction and settlement reports but is not visible to the payer. - */ - public function getCustomId(): ?string - { - return $this->customId; - } - - /** - * Sets Custom Id. - * The API caller-provided external ID. Used to reconcile client transactions with PayPal transactions. - * Appears in transaction and settlement reports but is not visible to the payer. - * - * @maps custom_id - */ - public function setCustomId(?string $customId): void - { - $this->customId = $customId; - } - - /** - * 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 Soft Descriptor. - * The soft descriptor is the dynamic text used to construct the statement descriptor that appears on a - * 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:Then, the statement descriptor on the card is - * PAYPAL * Janes Gift 80. - */ - public function getSoftDescriptor(): ?string - { - return $this->softDescriptor; - } - - /** - * Sets Soft Descriptor. - * The soft descriptor is the dynamic text used to construct the statement descriptor that appears on a - * 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:Then, the statement descriptor on the card is - * PAYPAL * Janes Gift 80. - * - * @maps soft_descriptor - */ - public function setSoftDescriptor(?string $softDescriptor): void - { - $this->softDescriptor = $softDescriptor; - } - - /** - * Returns Items. - * An array of items that the customer purchases from the merchant. - * - * @return Item[]|null - */ - public function getItems(): ?array - { - return $this->items; - } - - /** - * Sets Items. - * An array of items that the customer purchases from the merchant. - * - * @maps items - * - * @param Item[]|null $items - */ - public function setItems(?array $items): void - { - $this->items = $items; - } - - /** - * Returns Shipping. - * The shipping details. - */ - public function getShipping(): ?ShippingDetails - { - return $this->shipping; - } - - /** - * Sets Shipping. - * The shipping details. - * - * @maps shipping - */ - public function setShipping(?ShippingDetails $shipping): void - { - $this->shipping = $shipping; - } - - /** - * Returns Supplementary Data. - * Supplementary data about a payment. This object passes information that can be used to improve risk - * assessments and processing costs, for example, by providing Level 2 and Level 3 payment data. - */ - public function getSupplementaryData(): ?SupplementaryData - { - return $this->supplementaryData; - } - - /** - * Sets Supplementary Data. - * Supplementary data about a payment. This object passes information that can be used to improve risk - * assessments and processing costs, for example, by providing Level 2 and Level 3 payment data. - * - * @maps supplementary_data - */ - public function setSupplementaryData(?SupplementaryData $supplementaryData): void - { - $this->supplementaryData = $supplementaryData; - } - - /** - * 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; - } - $json['amount'] = $this->amount; - if (isset($this->payee)) { - $json['payee'] = $this->payee; - } - if (isset($this->paymentInstruction)) { - $json['payment_instruction'] = $this->paymentInstruction; - } - if (isset($this->description)) { - $json['description'] = $this->description; - } - if (isset($this->customId)) { - $json['custom_id'] = $this->customId; - } - if (isset($this->invoiceId)) { - $json['invoice_id'] = $this->invoiceId; - } - if (isset($this->softDescriptor)) { - $json['soft_descriptor'] = $this->softDescriptor; - } - if (isset($this->items)) { - $json['items'] = $this->items; - } - if (isset($this->shipping)) { - $json['shipping'] = $this->shipping; - } - if (isset($this->supplementaryData)) { - $json['supplementary_data'] = $this->supplementaryData; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/ReauthorizeRequest.php b/src/Models/ReauthorizeRequest.php deleted file mode 100644 index bd41c95..0000000 --- a/src/Models/ReauthorizeRequest.php +++ /dev/null @@ -1,71 +0,0 @@ -
    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 -{ - /** - * @var Money|null - */ - private $amount; - - /** - * 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; - } - - /** - * 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->amount)) { - $json['amount'] = $this->amount; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/Refund.php b/src/Models/Refund.php deleted file mode 100644 index c044ad4..0000000 --- a/src/Models/Refund.php +++ /dev/null @@ -1,421 +0,0 @@ -status; - } - - /** - * Sets Status. - * The status of the refund. - * - * @maps status - */ - public function setStatus(?string $status): void - { - $this->status = $status; - } - - /** - * Returns Status Details. - * The details of the refund status. - */ - public function getStatusDetails(): ?RefundStatusDetails - { - return $this->statusDetails; - } - - /** - * Sets Status Details. - * The details of the refund status. - * - * @maps status_details - */ - public function setStatusDetails(?RefundStatusDetails $statusDetails): void - { - $this->statusDetails = $statusDetails; - } - - /** - * Returns Id. - * The PayPal-generated ID for the refund. - */ - public function getId(): ?string - { - return $this->id; - } - - /** - * Sets Id. - * The PayPal-generated ID for the refund. - * - * @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 Acquirer Reference Number. - * Reference ID issued for the card transaction. This ID can be used to track the transaction across - * processors, card brands and issuing banks. - */ - public function getAcquirerReferenceNumber(): ?string - { - return $this->acquirerReferenceNumber; - } - - /** - * Sets Acquirer Reference Number. - * Reference ID issued for the card transaction. This ID can be used to track the transaction across - * processors, card brands and issuing banks. - * - * @maps acquirer_reference_number - */ - public function setAcquirerReferenceNumber(?string $acquirerReferenceNumber): void - { - $this->acquirerReferenceNumber = $acquirerReferenceNumber; - } - - /** - * Returns Note to Payer. - * The reason for the refund. Appears in both the payer's transaction history and the emails that the - * payer receives. - */ - public function getNoteToPayer(): ?string - { - return $this->noteToPayer; - } - - /** - * Sets Note to Payer. - * The reason for the refund. Appears in both the payer's transaction history and the emails that the - * payer receives. - * - * @maps note_to_payer - */ - public function setNoteToPayer(?string $noteToPayer): void - { - $this->noteToPayer = $noteToPayer; - } - - /** - * Returns Seller Payable Breakdown. - * The breakdown of the refund. - */ - public function getSellerPayableBreakdown(): ?SellerPayableBreakdown - { - return $this->sellerPayableBreakdown; - } - - /** - * Sets Seller Payable Breakdown. - * The breakdown of the refund. - * - * @maps seller_payable_breakdown - */ - public function setSellerPayableBreakdown(?SellerPayableBreakdown $sellerPayableBreakdown): void - { - $this->sellerPayableBreakdown = $sellerPayableBreakdown; - } - - /** - * Returns Payer. - * The details for the merchant who receives the funds and fulfills the order. The merchant is also - * known as the payee. - */ - public function getPayer(): ?PayeeBase - { - return $this->payer; - } - - /** - * Sets Payer. - * The details for the merchant who receives the funds and fulfills the order. The merchant is also - * known as the payee. - * - * @maps payer - */ - public function setPayer(?PayeeBase $payer): void - { - $this->payer = $payer; - } - - /** - * 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 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; - } - - /** - * 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'] = RefundStatus::checkValue($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->acquirerReferenceNumber)) { - $json['acquirer_reference_number'] = $this->acquirerReferenceNumber; - } - if (isset($this->noteToPayer)) { - $json['note_to_payer'] = $this->noteToPayer; - } - if (isset($this->sellerPayableBreakdown)) { - $json['seller_payable_breakdown'] = $this->sellerPayableBreakdown; - } - if (isset($this->payer)) { - $json['payer'] = $this->payer; - } - if (isset($this->links)) { - $json['links'] = $this->links; - } - 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/RefundIncompleteReason.php b/src/Models/RefundIncompleteReason.php deleted file mode 100644 index cbcc594..0000000 --- a/src/Models/RefundIncompleteReason.php +++ /dev/null @@ -1,43 +0,0 @@ -platformFees; - } - - /** - * Sets Platform Fees. - * Specifies the amount that the API caller will contribute to the refund being processed. The amount - * needs to be lower than platform_fees amount originally captured or the amount that is remaining if - * multiple refunds have been processed. This field is only applicable to merchants that have been - * enabled for PayPal Commerce Platform for Marketplaces and Platforms capability. Please speak to your - * account manager if you want to use this capability. - * - * @maps platform_fees - * - * @param RefundPlatformFee[]|null $platformFees - */ - public function setPlatformFees(?array $platformFees): void - { - $this->platformFees = $platformFees; - } - - /** - * 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->platformFees)) { - $json['platform_fees'] = $this->platformFees; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/RefundPlatformFee.php b/src/Models/RefundPlatformFee.php deleted file mode 100644 index b143d32..0000000 --- a/src/Models/RefundPlatformFee.php +++ /dev/null @@ -1,72 +0,0 @@ -amount = $amount; - } - - /** - * 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. - * - * @required - * @maps amount - */ - public function setAmount(Money $amount): void - { - $this->amount = $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['amount'] = $this->amount; - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/RefundRequest.php b/src/Models/RefundRequest.php deleted file mode 100644 index af79b99..0000000 --- a/src/Models/RefundRequest.php +++ /dev/null @@ -1,188 +0,0 @@ -amount object in the request body. - */ -class RefundRequest implements \JsonSerializable -{ - /** - * @var Money|null - */ - private $amount; - - /** - * @var string|null - */ - private $customId; - - /** - * @var string|null - */ - private $invoiceId; - - /** - * @var string|null - */ - private $noteToPayer; - - /** - * @var RefundPaymentInstruction|null - */ - private $paymentInstruction; - - /** - * 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 Custom Id. - * The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal - * transactions. Appears in transaction and settlement reports. The pattern is defined by an external - * party and supports Unicode. - */ - 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. The pattern is defined by an external - * party and supports Unicode. - * - * @maps custom_id - */ - public function setCustomId(?string $customId): void - { - $this->customId = $customId; - } - - /** - * Returns Invoice Id. - * The API caller-provided external invoice ID for this order. The pattern is defined by an external - * party and supports Unicode. - */ - public function getInvoiceId(): ?string - { - return $this->invoiceId; - } - - /** - * Sets Invoice Id. - * The API caller-provided external invoice ID for this order. The pattern is defined by an external - * party and supports Unicode. - * - * @maps invoice_id - */ - public function setInvoiceId(?string $invoiceId): void - { - $this->invoiceId = $invoiceId; - } - - /** - * Returns Note to Payer. - * The reason for the refund. Appears in both the payer's transaction history and the emails that the - * payer receives. The pattern is defined by an external party and supports Unicode. - */ - public function getNoteToPayer(): ?string - { - return $this->noteToPayer; - } - - /** - * Sets Note to Payer. - * The reason for the refund. Appears in both the payer's transaction history and the emails that the - * payer receives. The pattern is defined by an external party and supports Unicode. - * - * @maps note_to_payer - */ - public function setNoteToPayer(?string $noteToPayer): void - { - $this->noteToPayer = $noteToPayer; - } - - /** - * Returns Payment Instruction. - * Any additional payments instructions during refund payment processing. This object is only - * applicable to merchants that have been enabled for PayPal Commerce Platform for Marketplaces and - * Platforms capability. Please speak to your account manager if you want to use this capability. - */ - public function getPaymentInstruction(): ?RefundPaymentInstruction - { - return $this->paymentInstruction; - } - - /** - * Sets Payment Instruction. - * Any additional payments instructions during refund payment processing. This object is only - * applicable to merchants that have been enabled for PayPal Commerce Platform for Marketplaces and - * Platforms capability. Please speak to your account manager if you want to use this capability. - * - * @maps payment_instruction - */ - public function setPaymentInstruction(?RefundPaymentInstruction $paymentInstruction): void - { - $this->paymentInstruction = $paymentInstruction; - } - - /** - * 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->amount)) { - $json['amount'] = $this->amount; - } - if (isset($this->customId)) { - $json['custom_id'] = $this->customId; - } - if (isset($this->invoiceId)) { - $json['invoice_id'] = $this->invoiceId; - } - if (isset($this->noteToPayer)) { - $json['note_to_payer'] = $this->noteToPayer; - } - if (isset($this->paymentInstruction)) { - $json['payment_instruction'] = $this->paymentInstruction; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/RefundStatus.php b/src/Models/RefundStatus.php deleted file mode 100644 index 6e27e2f..0000000 --- a/src/Models/RefundStatus.php +++ /dev/null @@ -1,49 +0,0 @@ -reason; - } - - /** - * Sets Reason. - * The reason why the refund has the `PENDING` or `FAILED` status. - * - * @maps reason - */ - public function setReason(?string $reason): void - { - $this->reason = $reason; - } - - /** - * 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->reason)) { - $json['reason'] = RefundIncompleteReason::checkValue($this->reason); - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/RefundStatusWithDetails.php b/src/Models/RefundStatusWithDetails.php deleted file mode 100644 index c6a2235..0000000 --- a/src/Models/RefundStatusWithDetails.php +++ /dev/null @@ -1,91 +0,0 @@ -status; - } - - /** - * Sets Status. - * The status of the refund. - * - * @maps status - */ - public function setStatus(?string $status): void - { - $this->status = $status; - } - - /** - * Returns Status Details. - * The details of the refund status. - */ - public function getStatusDetails(): ?RefundStatusDetails - { - return $this->statusDetails; - } - - /** - * Sets Status Details. - * The details of the refund status. - * - * @maps status_details - */ - public function setStatusDetails(?RefundStatusDetails $statusDetails): void - { - $this->statusDetails = $statusDetails; - } - - /** - * 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'] = RefundStatus::checkValue($this->status); - } - if (isset($this->statusDetails)) { - $json['status_details'] = $this->statusDetails; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/RelatedIdentifiers.php b/src/Models/RelatedIdentifiers.php deleted file mode 100644 index 9e265b3..0000000 --- a/src/Models/RelatedIdentifiers.php +++ /dev/null @@ -1,119 +0,0 @@ -orderId; - } - - /** - * Sets Order Id. - * Order ID related to the resource. - * - * @maps order_id - */ - public function setOrderId(?string $orderId): void - { - $this->orderId = $orderId; - } - - /** - * Returns Authorization Id. - * Authorization ID related to the resource. - */ - public function getAuthorizationId(): ?string - { - return $this->authorizationId; - } - - /** - * Sets Authorization Id. - * Authorization ID related to the resource. - * - * @maps authorization_id - */ - public function setAuthorizationId(?string $authorizationId): void - { - $this->authorizationId = $authorizationId; - } - - /** - * Returns Capture Id. - * Capture ID related to the resource. - */ - public function getCaptureId(): ?string - { - return $this->captureId; - } - - /** - * Sets Capture Id. - * Capture ID related to the resource. - * - * @maps capture_id - */ - public function setCaptureId(?string $captureId): void - { - $this->captureId = $captureId; - } - - /** - * 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->orderId)) { - $json['order_id'] = $this->orderId; - } - if (isset($this->authorizationId)) { - $json['authorization_id'] = $this->authorizationId; - } - if (isset($this->captureId)) { - $json['capture_id'] = $this->captureId; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/SEPADebitAuthorizationDetails.php b/src/Models/SEPADebitAuthorizationDetails.php deleted file mode 100644 index ba02351..0000000 --- a/src/Models/SEPADebitAuthorizationDetails.php +++ /dev/null @@ -1,63 +0,0 @@ -status; - } - - /** - * Sets Status. - * The authorization status of the wallet instrument. - * - * @maps status - */ - public function setStatus(?string $status): void - { - $this->status = $status; - } - - /** - * 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'] = InstrumentAuthorizationStatus::checkValue($this->status); - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/SEPADebitResponse.php b/src/Models/SEPADebitResponse.php deleted file mode 100644 index 1fb3389..0000000 --- a/src/Models/SEPADebitResponse.php +++ /dev/null @@ -1,152 +0,0 @@ -ibanLastChars; - } - - /** - * Sets Iban Last Chars. - * The last characters of the IBAN used to pay. - * - * @maps iban_last_chars - */ - public function setIbanLastChars(?string $ibanLastChars): void - { - $this->ibanLastChars = $ibanLastChars; - } - - /** - * Returns Account Holder Name. - * - * @return mixed - */ - public function getAccountHolderName() - { - return $this->accountHolderName; - } - - /** - * Sets Account Holder Name. - * - * @maps account_holder_name - * - * @param mixed $accountHolderName - */ - public function setAccountHolderName($accountHolderName): void - { - $this->accountHolderName = $accountHolderName; - } - - /** - * Returns Billing 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 getBillingAddress(): ?Address - { - return $this->billingAddress; - } - - /** - * Sets Billing 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). - * - * @maps billing_address - */ - public function setBillingAddress(?Address $billingAddress): void - { - $this->billingAddress = $billingAddress; - } - - /** - * Returns Authorization Details. - * Authorization details. - */ - public function getAuthorizationDetails(): ?SEPADebitAuthorizationDetails - { - return $this->authorizationDetails; - } - - /** - * Sets Authorization Details. - * Authorization details. - * - * @maps authorization_details - */ - public function setAuthorizationDetails(?SEPADebitAuthorizationDetails $authorizationDetails): void - { - $this->authorizationDetails = $authorizationDetails; - } - - /** - * 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->ibanLastChars)) { - $json['iban_last_chars'] = $this->ibanLastChars; - } - if (isset($this->accountHolderName)) { - $json['account_holder_name'] = $this->accountHolderName; - } - if (isset($this->billingAddress)) { - $json['billing_address'] = $this->billingAddress; - } - if (isset($this->authorizationDetails)) { - $json['authorization_details'] = $this->authorizationDetails; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/SellerPayableBreakdown.php b/src/Models/SellerPayableBreakdown.php deleted file mode 100644 index cfa067c..0000000 --- a/src/Models/SellerPayableBreakdown.php +++ /dev/null @@ -1,269 +0,0 @@ -grossAmount; - } - - /** - * Sets Gross Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps gross_amount - */ - public function setGrossAmount(?Money $grossAmount): void - { - $this->grossAmount = $grossAmount; - } - - /** - * Returns Paypal Fee. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getPaypalFee(): ?Money - { - return $this->paypalFee; - } - - /** - * Sets Paypal Fee. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps paypal_fee - */ - public function setPaypalFee(?Money $paypalFee): void - { - $this->paypalFee = $paypalFee; - } - - /** - * Returns Paypal Fee in Receivable Currency. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getPaypalFeeInReceivableCurrency(): ?Money - { - return $this->paypalFeeInReceivableCurrency; - } - - /** - * Sets Paypal Fee in Receivable Currency. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps paypal_fee_in_receivable_currency - */ - public function setPaypalFeeInReceivableCurrency(?Money $paypalFeeInReceivableCurrency): void - { - $this->paypalFeeInReceivableCurrency = $paypalFeeInReceivableCurrency; - } - - /** - * Returns Net Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getNetAmount(): ?Money - { - return $this->netAmount; - } - - /** - * Sets Net Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps net_amount - */ - public function setNetAmount(?Money $netAmount): void - { - $this->netAmount = $netAmount; - } - - /** - * Returns Net Amount in Receivable Currency. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getNetAmountInReceivableCurrency(): ?Money - { - return $this->netAmountInReceivableCurrency; - } - - /** - * Sets Net Amount in Receivable Currency. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps net_amount_in_receivable_currency - */ - public function setNetAmountInReceivableCurrency(?Money $netAmountInReceivableCurrency): void - { - $this->netAmountInReceivableCurrency = $netAmountInReceivableCurrency; - } - - /** - * Returns Platform Fees. - * An array of platform or partner fees, commissions, or brokerage fees for the refund. - * - * @return PlatformFee[]|null - */ - public function getPlatformFees(): ?array - { - return $this->platformFees; - } - - /** - * Sets Platform Fees. - * An array of platform or partner fees, commissions, or brokerage fees for the refund. - * - * @maps platform_fees - * - * @param PlatformFee[]|null $platformFees - */ - public function setPlatformFees(?array $platformFees): void - { - $this->platformFees = $platformFees; - } - - /** - * Returns Net Amount Breakdown. - * An array of breakdown values for the net amount. Returned when the currency of the refund is - * different from the currency of the PayPal account where the payee holds their funds. - * - * @return NetAmountBreakdownItem[]|null - */ - public function getNetAmountBreakdown(): ?array - { - return $this->netAmountBreakdown; - } - - /** - * Sets Net Amount Breakdown. - * An array of breakdown values for the net amount. Returned when the currency of the refund is - * different from the currency of the PayPal account where the payee holds their funds. - * - * @maps net_amount_breakdown - * - * @param NetAmountBreakdownItem[]|null $netAmountBreakdown - */ - public function setNetAmountBreakdown(?array $netAmountBreakdown): void - { - $this->netAmountBreakdown = $netAmountBreakdown; - } - - /** - * Returns Total Refunded Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getTotalRefundedAmount(): ?Money - { - return $this->totalRefundedAmount; - } - - /** - * Sets Total Refunded Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps total_refunded_amount - */ - public function setTotalRefundedAmount(?Money $totalRefundedAmount): void - { - $this->totalRefundedAmount = $totalRefundedAmount; - } - - /** - * 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->grossAmount)) { - $json['gross_amount'] = $this->grossAmount; - } - if (isset($this->paypalFee)) { - $json['paypal_fee'] = $this->paypalFee; - } - if (isset($this->paypalFeeInReceivableCurrency)) { - $json['paypal_fee_in_receivable_currency'] = $this->paypalFeeInReceivableCurrency; - } - if (isset($this->netAmount)) { - $json['net_amount'] = $this->netAmount; - } - if (isset($this->netAmountInReceivableCurrency)) { - $json['net_amount_in_receivable_currency'] = $this->netAmountInReceivableCurrency; - } - if (isset($this->platformFees)) { - $json['platform_fees'] = $this->platformFees; - } - if (isset($this->netAmountBreakdown)) { - $json['net_amount_breakdown'] = $this->netAmountBreakdown; - } - if (isset($this->totalRefundedAmount)) { - $json['total_refunded_amount'] = $this->totalRefundedAmount; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/SellerProtection.php b/src/Models/SellerProtection.php deleted file mode 100644 index 5af34b9..0000000 --- a/src/Models/SellerProtection.php +++ /dev/null @@ -1,98 +0,0 @@ -status; - } - - /** - * Sets Status. - * 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). - * - * @maps status - */ - public function setStatus(?string $status): void - { - $this->status = $status; - } - - /** - * Returns Dispute Categories. - * An array of conditions that are covered for the transaction. - * - * @return string[]|null - */ - public function getDisputeCategories(): ?array - { - return $this->disputeCategories; - } - - /** - * Sets Dispute Categories. - * An array of conditions that are covered for the transaction. - * - * @maps dispute_categories - * - * @param string[]|null $disputeCategories - */ - public function setDisputeCategories(?array $disputeCategories): void - { - $this->disputeCategories = $disputeCategories; - } - - /** - * 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'] = SellerProtectionStatus::checkValue($this->status); - } - if (isset($this->disputeCategories)) { - $json['dispute_categories'] = DisputeCategory::checkValue($this->disputeCategories); - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/SellerProtectionStatus.php b/src/Models/SellerProtectionStatus.php deleted file mode 100644 index f96a5f4..0000000 --- a/src/Models/SellerProtectionStatus.php +++ /dev/null @@ -1,48 +0,0 @@ -grossAmount = $grossAmount; - } - - /** - * Returns Gross Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getGrossAmount(): Money - { - return $this->grossAmount; - } - - /** - * Sets Gross Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @required - * @maps gross_amount - */ - public function setGrossAmount(Money $grossAmount): void - { - $this->grossAmount = $grossAmount; - } - - /** - * Returns Paypal Fee. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getPaypalFee(): ?Money - { - return $this->paypalFee; - } - - /** - * Sets Paypal Fee. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps paypal_fee - */ - public function setPaypalFee(?Money $paypalFee): void - { - $this->paypalFee = $paypalFee; - } - - /** - * Returns Paypal Fee in Receivable Currency. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getPaypalFeeInReceivableCurrency(): ?Money - { - return $this->paypalFeeInReceivableCurrency; - } - - /** - * Sets Paypal Fee in Receivable Currency. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps paypal_fee_in_receivable_currency - */ - public function setPaypalFeeInReceivableCurrency(?Money $paypalFeeInReceivableCurrency): void - { - $this->paypalFeeInReceivableCurrency = $paypalFeeInReceivableCurrency; - } - - /** - * Returns Net Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getNetAmount(): ?Money - { - return $this->netAmount; - } - - /** - * Sets Net Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps net_amount - */ - public function setNetAmount(?Money $netAmount): void - { - $this->netAmount = $netAmount; - } - - /** - * Returns Receivable Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - */ - public function getReceivableAmount(): ?Money - { - return $this->receivableAmount; - } - - /** - * Sets Receivable Amount. - * The currency and amount for a financial transaction, such as a balance or payment due. - * - * @maps receivable_amount - */ - public function setReceivableAmount(?Money $receivableAmount): void - { - $this->receivableAmount = $receivableAmount; - } - - /** - * Returns Exchange Rate. - * The exchange rate that determines the amount to convert from one currency to another currency. - */ - public function getExchangeRate(): ?ExchangeRate - { - return $this->exchangeRate; - } - - /** - * Sets Exchange Rate. - * The exchange rate that determines the amount to convert from one currency to another currency. - * - * @maps exchange_rate - */ - public function setExchangeRate(?ExchangeRate $exchangeRate): void - { - $this->exchangeRate = $exchangeRate; - } - - /** - * Returns Platform Fees. - * An array of platform or partner fees, commissions, or brokerage fees that associated with the - * captured payment. - * - * @return PlatformFee[]|null - */ - public function getPlatformFees(): ?array - { - return $this->platformFees; - } - - /** - * Sets Platform Fees. - * An array of platform or partner fees, commissions, or brokerage fees that associated with the - * captured payment. - * - * @maps platform_fees - * - * @param PlatformFee[]|null $platformFees - */ - public function setPlatformFees(?array $platformFees): void - { - $this->platformFees = $platformFees; - } - - /** - * 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['gross_amount'] = $this->grossAmount; - if (isset($this->paypalFee)) { - $json['paypal_fee'] = $this->paypalFee; - } - if (isset($this->paypalFeeInReceivableCurrency)) { - $json['paypal_fee_in_receivable_currency'] = $this->paypalFeeInReceivableCurrency; - } - if (isset($this->netAmount)) { - $json['net_amount'] = $this->netAmount; - } - if (isset($this->receivableAmount)) { - $json['receivable_amount'] = $this->receivableAmount; - } - if (isset($this->exchangeRate)) { - $json['exchange_rate'] = $this->exchangeRate; - } - if (isset($this->platformFees)) { - $json['platform_fees'] = $this->platformFees; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/SetupTokenCardExperienceContext.php b/src/Models/SetupTokenCardExperienceContext.php deleted file mode 100644 index 57babde..0000000 --- a/src/Models/SetupTokenCardExperienceContext.php +++ /dev/null @@ -1,191 +0,0 @@ -brandName; - } - - /** - * Sets Brand Name. - * 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. - * - * @maps brand_name - */ - public function setBrandName(?string $brandName): void - { - $this->brandName = $brandName; - } - - /** - * Returns Locale. - * 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/). - */ - public function getLocale(): ?string - { - return $this->locale; - } - - /** - * Sets Locale. - * 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/). - * - * @maps locale - */ - public function setLocale(?string $locale): void - { - $this->locale = $locale; - } - - /** - * Returns Return Url. - * The URL where the customer is redirected after customer approves leaves the flow. It is a required - * field for contingency flows like PayPal wallet, 3DS. - */ - public function getReturnUrl(): ?string - { - return $this->returnUrl; - } - - /** - * Sets Return Url. - * The URL where the customer is redirected after customer approves leaves the flow. It is a required - * field for contingency flows like PayPal wallet, 3DS. - * - * @maps return_url - */ - public function setReturnUrl(?string $returnUrl): void - { - $this->returnUrl = $returnUrl; - } - - /** - * Returns Cancel Url. - * The URL where the customer is redirected after customer cancels or leaves the flow. It is a required - * field for contingency flows like PayPal wallet, 3DS. - */ - public function getCancelUrl(): ?string - { - return $this->cancelUrl; - } - - /** - * Sets Cancel Url. - * The URL where the customer is redirected after customer cancels or leaves the flow. It is a required - * field for contingency flows like PayPal wallet, 3DS. - * - * @maps cancel_url - */ - public function setCancelUrl(?string $cancelUrl): void - { - $this->cancelUrl = $cancelUrl; - } - - /** - * Returns Vault Instruction. - * Vault Instruction on action to be performed after a successful payer approval. - */ - public function getVaultInstruction(): ?string - { - return $this->vaultInstruction; - } - - /** - * Sets Vault Instruction. - * Vault Instruction on action to be performed after a successful payer approval. - * - * @maps vault_instruction - */ - public function setVaultInstruction(?string $vaultInstruction): void - { - $this->vaultInstruction = $vaultInstruction; - } - - /** - * 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->brandName)) { - $json['brand_name'] = $this->brandName; - } - if (isset($this->locale)) { - $json['locale'] = $this->locale; - } - if (isset($this->returnUrl)) { - $json['return_url'] = $this->returnUrl; - } - if (isset($this->cancelUrl)) { - $json['cancel_url'] = $this->cancelUrl; - } - if (isset($this->vaultInstruction)) { - $json['vault_instruction'] = $this->vaultInstruction; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/SetupTokenRequest.php b/src/Models/SetupTokenRequest.php deleted file mode 100644 index 0b34858..0000000 --- a/src/Models/SetupTokenRequest.php +++ /dev/null @@ -1,98 +0,0 @@ -paymentSource = $paymentSource; - } - - /** - * Returns Customer. - * Customer in merchant's or partner's system of records. - */ - public function getCustomer(): ?CustomerRequest - { - return $this->customer; - } - - /** - * Sets Customer. - * Customer in merchant's or partner's system of records. - * - * @maps customer - */ - public function setCustomer(?CustomerRequest $customer): void - { - $this->customer = $customer; - } - - /** - * Returns Payment Source. - * The payment method to vault with the instrument details. - */ - public function getPaymentSource(): SetupTokenRequestPaymentSource - { - return $this->paymentSource; - } - - /** - * Sets Payment Source. - * The payment method to vault with the instrument details. - * - * @required - * @maps payment_source - */ - public function setPaymentSource(SetupTokenRequestPaymentSource $paymentSource): void - { - $this->paymentSource = $paymentSource; - } - - /** - * 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; - } - $json['payment_source'] = $this->paymentSource; - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/SetupTokenRequestCard.php b/src/Models/SetupTokenRequestCard.php deleted file mode 100644 index 9743544..0000000 --- a/src/Models/SetupTokenRequestCard.php +++ /dev/null @@ -1,327 +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 Number. - * The primary account number (PAN) for the payment card. - */ - public function getNumber(): ?string - { - return $this->number; - } - - /** - * Sets Number. - * The primary account number (PAN) for the payment card. - * - * @maps number - */ - public function setNumber(?string $number): void - { - $this->number = $number; - } - - /** - * 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 Security Code. - * 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`. - */ - public function getSecurityCode(): ?string - { - return $this->securityCode; - } - - /** - * Sets Security Code. - * 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`. - * - * @maps security_code - */ - public function setSecurityCode(?string $securityCode): void - { - $this->securityCode = $securityCode; - } - - /** - * 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 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 Billing 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 getBillingAddress(): ?Address - { - return $this->billingAddress; - } - - /** - * Sets Billing 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). - * - * @maps billing_address - */ - public function setBillingAddress(?Address $billingAddress): void - { - $this->billingAddress = $billingAddress; - } - - /** - * Returns Verification Method. - * The verification method of the card. - */ - public function getVerificationMethod(): ?string - { - return $this->verificationMethod; - } - - /** - * Sets Verification Method. - * The verification method of the card. - * - * @maps verification_method - */ - public function setVerificationMethod(?string $verificationMethod): void - { - $this->verificationMethod = $verificationMethod; - } - - /** - * Returns Experience Context. - * Customizes the Vault creation flow experience for your customers. - */ - public function getExperienceContext(): ?SetupTokenCardExperienceContext - { - return $this->experienceContext; - } - - /** - * Sets Experience Context. - * Customizes the Vault creation flow experience for your customers. - * - * @maps experience_context - */ - public function setExperienceContext(?SetupTokenCardExperienceContext $experienceContext): void - { - $this->experienceContext = $experienceContext; - } - - /** - * Returns Network Transaction Reference. - * - * @return mixed - */ - public function getNetworkTransactionReference() - { - return $this->networkTransactionReference; - } - - /** - * Sets Network Transaction Reference. - * - * @maps network_transaction_reference - * - * @param mixed $networkTransactionReference - */ - public function setNetworkTransactionReference($networkTransactionReference): void - { - $this->networkTransactionReference = $networkTransactionReference; - } - - /** - * 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->number)) { - $json['number'] = $this->number; - } - if (isset($this->expiry)) { - $json['expiry'] = $this->expiry; - } - if (isset($this->securityCode)) { - $json['security_code'] = $this->securityCode; - } - if (isset($this->type)) { - $json['type'] = CardType::checkValue($this->type); - } - if (isset($this->brand)) { - $json['brand'] = CardBrand::checkValue($this->brand); - } - if (isset($this->billingAddress)) { - $json['billing_address'] = $this->billingAddress; - } - if (isset($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; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/SetupTokenRequestPaymentSource.php b/src/Models/SetupTokenRequestPaymentSource.php deleted file mode 100644 index 1a6b8f7..0000000 --- a/src/Models/SetupTokenRequestPaymentSource.php +++ /dev/null @@ -1,145 +0,0 @@ -card; - } - - /** - * Sets Card. - * A Resource representing a request to vault a Card. - * - * @maps card - */ - public function setCard(?SetupTokenRequestCard $card): void - { - $this->card = $card; - } - - /** - * Returns Paypal. - * A resource representing a request to vault PayPal Wallet. - */ - public function getPaypal(): ?VaultPayPalWalletRequest - { - return $this->paypal; - } - - /** - * Sets Paypal. - * A resource representing a request to vault PayPal Wallet. - * - * @maps paypal - */ - public function setPaypal(?VaultPayPalWalletRequest $paypal): void - { - $this->paypal = $paypal; - } - - /** - * Returns Venmo. - */ - public function getVenmo(): ?VaultVenmoRequest - { - return $this->venmo; - } - - /** - * Sets Venmo. - * - * @maps venmo - */ - public function setVenmo(?VaultVenmoRequest $venmo): void - { - $this->venmo = $venmo; - } - - /** - * Returns Token. - * The Tokenized Payment Source representing a Request to Vault a Token. - */ - public function getToken(): ?VaultTokenRequest - { - return $this->token; - } - - /** - * Sets Token. - * The Tokenized Payment Source representing a Request to Vault a Token. - * - * @maps token - */ - public function setToken(?VaultTokenRequest $token): void - { - $this->token = $token; - } - - /** - * 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->card)) { - $json['card'] = $this->card; - } - if (isset($this->paypal)) { - $json['paypal'] = $this->paypal; - } - if (isset($this->venmo)) { - $json['venmo'] = $this->venmo; - } - if (isset($this->token)) { - $json['token'] = $this->token; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/SetupTokenResponse.php b/src/Models/SetupTokenResponse.php deleted file mode 100644 index eda88aa..0000000 --- a/src/Models/SetupTokenResponse.php +++ /dev/null @@ -1,207 +0,0 @@ -id; - } - - /** - * Sets Id. - * The PayPal-generated ID for the vault token. - * - * @maps id - */ - public function setId(?string $id): void - { - $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. - */ - public function getCustomer(): ?CustomerRequest - { - return $this->customer; - } - - /** - * Sets Customer. - * Customer in merchant's or partner's system of records. - * - * @maps customer - */ - public function setCustomer(?CustomerRequest $customer): void - { - $this->customer = $customer; - } - - /** - * Returns Status. - * The status of the payment token. - */ - public function getStatus(): ?string - { - return $this->status; - } - - /** - * Sets Status. - * The status of the payment token. - * - * @maps status - */ - public function setStatus(?string $status): void - { - $this->status = $status; - } - - /** - * Returns Payment Source. - * The setup payment method details. - */ - public function getPaymentSource(): ?SetupTokenResponsePaymentSource - { - return $this->paymentSource; - } - - /** - * Sets Payment Source. - * The setup payment method details. - * - * @maps payment_source - */ - public function setPaymentSource(?SetupTokenResponsePaymentSource $paymentSource): void - { - $this->paymentSource = $paymentSource; - } - - /** - * Returns Links. - * An array of related [HATEOAS links](/api/rest/responses/#hateoas). - * - * @return LinkDescription[]|null - */ - public function getLinks(): ?array - { - return $this->links; - } - - /** - * Sets Links. - * An array of related [HATEOAS links](/api/rest/responses/#hateoas). - * - * @maps links - * - * @param LinkDescription[]|null $links - */ - public function setLinks(?array $links): void - { - $this->links = $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->ordinal)) { - $json['ordinal'] = $this->ordinal; - } - if (isset($this->customer)) { - $json['customer'] = $this->customer; - } - if (isset($this->status)) { - $json['status'] = $this->status; - } - if (isset($this->paymentSource)) { - $json['payment_source'] = $this->paymentSource; - } - if (isset($this->links)) { - $json['links'] = $this->links; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/SetupTokenResponseCard.php b/src/Models/SetupTokenResponseCard.php deleted file mode 100644 index bac1b92..0000000 --- a/src/Models/SetupTokenResponseCard.php +++ /dev/null @@ -1,343 +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(): ?AuthenticationResponse - { - return $this->authenticationResult; - } - - /** - * Sets Authentication Result. - * Results of Authentication such as 3D Secure. - * - * @maps authentication_result - */ - public function setAuthenticationResult(?AuthenticationResponse $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; - } - - /** - * 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); - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/SetupTokenResponsePaymentSource.php b/src/Models/SetupTokenResponsePaymentSource.php deleted file mode 100644 index 200340d..0000000 --- a/src/Models/SetupTokenResponsePaymentSource.php +++ /dev/null @@ -1,113 +0,0 @@ -card; - } - - /** - * Sets Card. - * - * @maps card - */ - public function setCard(?SetupTokenResponseCard $card): void - { - $this->card = $card; - } - - /** - * Returns Paypal. - */ - public function getPaypal(): ?PayPalPaymentToken - { - return $this->paypal; - } - - /** - * Sets Paypal. - * - * @maps paypal - */ - public function setPaypal(?PayPalPaymentToken $paypal): void - { - $this->paypal = $paypal; - } - - /** - * Returns Venmo. - */ - public function getVenmo(): ?VenmoPaymentToken - { - return $this->venmo; - } - - /** - * Sets Venmo. - * - * @maps venmo - */ - public function setVenmo(?VenmoPaymentToken $venmo): void - { - $this->venmo = $venmo; - } - - /** - * 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->card)) { - $json['card'] = $this->card; - } - if (isset($this->paypal)) { - $json['paypal'] = $this->paypal; - } - if (isset($this->venmo)) { - $json['venmo'] = $this->venmo; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/ShipmentCarrier.php b/src/Models/ShipmentCarrier.php deleted file mode 100644 index b377a63..0000000 --- a/src/Models/ShipmentCarrier.php +++ /dev/null @@ -1,3875 +0,0 @@ -Carriers. - */ -class ShipmentCarrier -{ - public const DPD_RU = 'DPD_RU'; - - public const BG_BULGARIAN_POST = 'BG_BULGARIAN_POST'; - - public const KR_KOREA_POST = 'KR_KOREA_POST'; - - public const ZA_COURIERIT = 'ZA_COURIERIT'; - - public const FR_EXAPAQ = 'FR_EXAPAQ'; - - public const ARE_EMIRATES_POST = 'ARE_EMIRATES_POST'; - - public const GAC = 'GAC'; - - public const GEIS = 'GEIS'; - - public const SF_EX = 'SF_EX'; - - public const PAGO = 'PAGO'; - - public const MYHERMES = 'MYHERMES'; - - public const DIAMOND_EUROGISTICS = 'DIAMOND_EUROGISTICS'; - - public const CORPORATECOURIERS_WEBHOOK = 'CORPORATECOURIERS_WEBHOOK'; - - public const BOND = 'BOND'; - - public const OMNIPARCEL = 'OMNIPARCEL'; - - public const SK_POSTA = 'SK_POSTA'; - - public const PUROLATOR = 'PUROLATOR'; - - public const FETCHR_WEBHOOK = 'FETCHR_WEBHOOK'; - - public const THEDELIVERYGROUP = 'THEDELIVERYGROUP'; - - public const CELLO_SQUARE = 'CELLO_SQUARE'; - - public const TARRIVE = 'TARRIVE'; - - public const COLLIVERY = 'COLLIVERY'; - - public const MAINFREIGHT = 'MAINFREIGHT'; - - public const IND_FIRSTFLIGHT = 'IND_FIRSTFLIGHT'; - - public const ACSWORLDWIDE = 'ACSWORLDWIDE'; - - public const AMSTAN = 'AMSTAN'; - - public const OKAYPARCEL = 'OKAYPARCEL'; - - public const ENVIALIA_REFERENCE = 'ENVIALIA_REFERENCE'; - - public const SEUR_ES = 'SEUR_ES'; - - public const CONTINENTAL = 'CONTINENTAL'; - - public const FDSEXPRESS = 'FDSEXPRESS'; - - public const AMAZON_FBA_SWISHIP = 'AMAZON_FBA_SWISHIP'; - - public const WYNGS = 'WYNGS'; - - public const DHL_ACTIVE_TRACING = 'DHL_ACTIVE_TRACING'; - - public const ZYLLEM = 'ZYLLEM'; - - public const RUSTON = 'RUSTON'; - - public const XPOST = 'XPOST'; - - public const CORREOS_ES = 'CORREOS_ES'; - - public const DHL_FR = 'DHL_FR'; - - public const PAN_ASIA = 'PAN_ASIA'; - - public const BRT_IT = 'BRT_IT'; - - public const SRE_KOREA = 'SRE_KOREA'; - - public const SPEEDEE = 'SPEEDEE'; - - public const TNT_UK = 'TNT_UK'; - - public const VENIPAK = 'VENIPAK'; - - public const SHREENANDANCOURIER = 'SHREENANDANCOURIER'; - - public const CROSHOT = 'CROSHOT'; - - public const NIPOST_NG = 'NIPOST_NG'; - - public const EPST_GLBL = 'EPST_GLBL'; - - public const NEWGISTICS = 'NEWGISTICS'; - - public const POST_SLOVENIA = 'POST_SLOVENIA'; - - public const JERSEY_POST = 'JERSEY_POST'; - - public const BOMBINOEXP = 'BOMBINOEXP'; - - public const WMG = 'WMG'; - - public const XQ_EXPRESS = 'XQ_EXPRESS'; - - public const FURDECO = 'FURDECO'; - - public const LHT_EXPRESS = 'LHT_EXPRESS'; - - public const SOUTH_AFRICAN_POST_OFFICE = 'SOUTH_AFRICAN_POST_OFFICE'; - - public const SPOTON = 'SPOTON'; - - public const DIMERCO = 'DIMERCO'; - - public const CYPRUS_POST_CYP = 'CYPRUS_POST_CYP'; - - public const ABCUSTOM = 'ABCUSTOM'; - - public const IND_DELIVREE = 'IND_DELIVREE'; - - public const CN_BESTEXPRESS = 'CN_BESTEXPRESS'; - - public const DX_SFTP = 'DX_SFTP'; - - public const PICKUPP_MYS = 'PICKUPP_MYS'; - - public const FMX = 'FMX'; - - public const HELLMANN = 'HELLMANN'; - - public const SHIP_IT_ASIA = 'SHIP_IT_ASIA'; - - public const KERRY_ECOMMERCE = 'KERRY_ECOMMERCE'; - - public const FRETERAPIDO = 'FRETERAPIDO'; - - public const PITNEY_BOWES = 'PITNEY_BOWES'; - - public const XPRESSEN_DK = 'XPRESSEN_DK'; - - public const SEUR_SP_API = 'SEUR_SP_API'; - - public const DELIVERYONTIME = 'DELIVERYONTIME'; - - public const JINSUNG = 'JINSUNG'; - - public const TRANS_KARGO = 'TRANS_KARGO'; - - public const SWISHIP_DE = 'SWISHIP_DE'; - - public const IVOY_WEBHOOK = 'IVOY_WEBHOOK'; - - public const AIRMEE_WEBHOOK = 'AIRMEE_WEBHOOK'; - - public const DHL_BENELUX = 'DHL_BENELUX'; - - public const FIRSTMILE = 'FIRSTMILE'; - - public const FASTWAY_IR = 'FASTWAY_IR'; - - public const HH_EXP = 'HH_EXP'; - - public const MYS_MYPOST_ONLINE = 'MYS_MYPOST_ONLINE'; - - public const TNT_NL = 'TNT_NL'; - - public const TIPSA = 'TIPSA'; - - public const TAQBIN_MY = 'TAQBIN_MY'; - - public const KGMHUB = 'KGMHUB'; - - public const INTEXPRESS = 'INTEXPRESS'; - - public const OVERSE_EXP = 'OVERSE_EXP'; - - public const ONECLICK = 'ONECLICK'; - - public const ROADRUNNER_FREIGHT = 'ROADRUNNER_FREIGHT'; - - public const GLS_CROTIA = 'GLS_CROTIA'; - - public const MRW_FTP = 'MRW_FTP'; - - public const BLUEX = 'BLUEX'; - - public const DYLT = 'DYLT'; - - public const DPD_IR = 'DPD_IR'; - - public const SIN_GLBL = 'SIN_GLBL'; - - public const TUFFNELLS_REFERENCE = 'TUFFNELLS_REFERENCE'; - - public const CJPACKET = 'CJPACKET'; - - public const MILKMAN = 'MILKMAN'; - - public const ASIGNA = 'ASIGNA'; - - public const ONEWORLDEXPRESS = 'ONEWORLDEXPRESS'; - - public const ROYAL_MAIL = 'ROYAL_MAIL'; - - public const VIA_EXPRESS = 'VIA_EXPRESS'; - - public const TIGFREIGHT = 'TIGFREIGHT'; - - public const ZTO_EXPRESS = 'ZTO_EXPRESS'; - - public const TWO_GO = 'TWO_GO'; - - public const IML = 'IML'; - - public const INTEL_VALLEY = 'INTEL_VALLEY'; - - public const EFS = 'EFS'; - - public const UK_UK_MAIL = 'UK_UK_MAIL'; - - public const RAM = 'RAM'; - - public const ALLIEDEXPRESS = 'ALLIEDEXPRESS'; - - public const APC_OVERNIGHT = 'APC_OVERNIGHT'; - - public const SHIPPIT = 'SHIPPIT'; - - public const TFM = 'TFM'; - - public const M_XPRESS = 'M_XPRESS'; - - public const HDB_BOX = 'HDB_BOX'; - - public const CLEVY_LINKS = 'CLEVY_LINKS'; - - public const IBEONE = 'IBEONE'; - - public const FIEGE_NL = 'FIEGE_NL'; - - public const KWE_GLOBAL = 'KWE_GLOBAL'; - - public const CTC_EXPRESS = 'CTC_EXPRESS'; - - public const LAO_POST = 'LAO_POST'; - - public const AMAZON = 'AMAZON'; - - public const MORE_LINK = 'MORE_LINK'; - - public const JX = 'JX'; - - public const EASY_MAIL = 'EASY_MAIL'; - - public const ADUIEPYLE = 'ADUIEPYLE'; - - public const GB_PANTHER = 'GB_PANTHER'; - - public const EXPRESSSALE = 'EXPRESSSALE'; - - public const SG_DETRACK = 'SG_DETRACK'; - - public const TRUNKRS_WEBHOOK = 'TRUNKRS_WEBHOOK'; - - public const MATDESPATCH = 'MATDESPATCH'; - - public const DICOM = 'DICOM'; - - public const MBW = 'MBW'; - - public const KHM_CAMBODIA_POST = 'KHM_CAMBODIA_POST'; - - public const SINOTRANS = 'SINOTRANS'; - - public const BRT_IT_PARCELID = 'BRT_IT_PARCELID'; - - public const DHL_SUPPLY_CHAIN = 'DHL_SUPPLY_CHAIN'; - - public const DHL_PL = 'DHL_PL'; - - public const TOPYOU = 'TOPYOU'; - - public const PALEXPRESS = 'PALEXPRESS'; - - public const DHL_SG = 'DHL_SG'; - - public const CN_WEDO = 'CN_WEDO'; - - public const FULFILLME = 'FULFILLME'; - - public const DPD_DELISTRACK = 'DPD_DELISTRACK'; - - public const UPS_REFERENCE = 'UPS_REFERENCE'; - - public const CARIBOU = 'CARIBOU'; - - public const LOCUS_WEBHOOK = 'LOCUS_WEBHOOK'; - - public const DSV = 'DSV'; - - public const CN_GOFLY = 'CN_GOFLY'; - - public const P2P_TRC = 'P2P_TRC'; - - public const DIRECTPARCELS = 'DIRECTPARCELS'; - - public const NOVA_POSHTA_INT = 'NOVA_POSHTA_INT'; - - public const FEDEX_POLAND = 'FEDEX_POLAND'; - - public const CN_JCEX = 'CN_JCEX'; - - public const FAR_INTERNATIONAL = 'FAR_INTERNATIONAL'; - - public const IDEXPRESS = 'IDEXPRESS'; - - public const GANGBAO = 'GANGBAO'; - - public const NEWAY = 'NEWAY'; - - public const POSTNL_INT_3_S = 'POSTNL_INT_3_S'; - - public const RPX_ID = 'RPX_ID'; - - public const DESIGNERTRANSPORT_WEBHOOK = 'DESIGNERTRANSPORT_WEBHOOK'; - - public const GLS_SLOVEN = 'GLS_SLOVEN'; - - public const PARCELLED_IN = 'PARCELLED_IN'; - - public const GSI_EXPRESS = 'GSI_EXPRESS'; - - public const CON_WAY = 'CON_WAY'; - - public const BROUWER_TRANSPORT = 'BROUWER_TRANSPORT'; - - public const CPEX = 'CPEX'; - - public const ISRAEL_POST = 'ISRAEL_POST'; - - public const DTDC_IN = 'DTDC_IN'; - - public const PTT_POST = 'PTT_POST'; - - public const XDE_WEBHOOK = 'XDE_WEBHOOK'; - - public const TOLOS = 'TOLOS'; - - public const GIAO_HANG = 'GIAO_HANG'; - - public const GEODIS_ESPACE = 'GEODIS_ESPACE'; - - public const MAGYAR_HU = 'MAGYAR_HU'; - - public const DOORDASH_WEBHOOK = 'DOORDASH_WEBHOOK'; - - public const TIKI_ID = 'TIKI_ID'; - - public const CJ_HK_INTERNATIONAL = 'CJ_HK_INTERNATIONAL'; - - public const STAR_TRACK_EXPRESS = 'STAR_TRACK_EXPRESS'; - - public const HELTHJEM = 'HELTHJEM'; - - public const SFB2C = 'SFB2C'; - - public const FREIGHTQUOTE = 'FREIGHTQUOTE'; - - public const LANDMARK_GLOBAL_REFERENCE = 'LANDMARK_GLOBAL_REFERENCE'; - - public const PARCEL2GO = 'PARCEL2GO'; - - public const DELNEXT = 'DELNEXT'; - - public const RCL = 'RCL'; - - public const CGS_EXPRESS = 'CGS_EXPRESS'; - - public const HK_POST = 'HK_POST'; - - public const SAP_EXPRESS = 'SAP_EXPRESS'; - - public const PARCELPOST_SG = 'PARCELPOST_SG'; - - public const HERMES = 'HERMES'; - - public const IND_SAFEEXPRESS = 'IND_SAFEEXPRESS'; - - public const TOPHATTEREXPRESS = 'TOPHATTEREXPRESS'; - - public const MGLOBAL = 'MGLOBAL'; - - public const AVERITT = 'AVERITT'; - - public const LEADER = 'LEADER'; - - public const _2EBOX = '_2EBOX'; - - public const SG_SPEEDPOST = 'SG_SPEEDPOST'; - - public const DBSCHENKER_SE = 'DBSCHENKER_SE'; - - public const ISR_POST_DOMESTIC = 'ISR_POST_DOMESTIC'; - - public const BESTWAYPARCEL = 'BESTWAYPARCEL'; - - public const ASENDIA_DE = 'ASENDIA_DE'; - - public const NIGHTLINE_UK = 'NIGHTLINE_UK'; - - public const TAQBIN_SG = 'TAQBIN_SG'; - - public const TCK_EXPRESS = 'TCK_EXPRESS'; - - public const ENDEAVOUR_DELIVERY = 'ENDEAVOUR_DELIVERY'; - - public const NANJINGWOYUAN = 'NANJINGWOYUAN'; - - public const HEPPNER_FR = 'HEPPNER_FR'; - - public const EMPS_CN = 'EMPS_CN'; - - public const FONSEN = 'FONSEN'; - - public const PICKRR = 'PICKRR'; - - public const APC_OVERNIGHT_CONNUM = 'APC_OVERNIGHT_CONNUM'; - - public const STAR_TRACK_NEXT_FLIGHT = 'STAR_TRACK_NEXT_FLIGHT'; - - public const DAJIN = 'DAJIN'; - - public const UPS_FREIGHT = 'UPS_FREIGHT'; - - public const POSTA_PLUS = 'POSTA_PLUS'; - - public const CEVA = 'CEVA'; - - public const ANSERX = 'ANSERX'; - - public const JS_EXPRESS = 'JS_EXPRESS'; - - public const PADTF = 'PADTF'; - - public const UPS_MAIL_INNOVATIONS = 'UPS_MAIL_INNOVATIONS'; - - public const EZSHIP = 'EZSHIP'; - - public const SYPOST = 'SYPOST'; - - public const AMAZON_SHIP_MCF = 'AMAZON_SHIP_MCF'; - - public const YUSEN = 'YUSEN'; - - public const BRING = 'BRING'; - - public const SDA_IT = 'SDA_IT'; - - public const GBA = 'GBA'; - - public const NEWEGGEXPRESS = 'NEWEGGEXPRESS'; - - public const SPEEDCOURIERS_GR = 'SPEEDCOURIERS_GR'; - - public const FORRUN = 'FORRUN'; - - public const PICKUP = 'PICKUP'; - - public const ECMS = 'ECMS'; - - public const INTELIPOST = 'INTELIPOST'; - - public const FLASHEXPRESS = 'FLASHEXPRESS'; - - public const CN_STO = 'CN_STO'; - - public const SEKO_SFTP = 'SEKO_SFTP'; - - public const HOME_DELIVERY_SOLUTIONS = 'HOME_DELIVERY_SOLUTIONS'; - - public const DPD_HGRY = 'DPD_HGRY'; - - public const KERRYTTC_VN = 'KERRYTTC_VN'; - - public const JOYING_BOX = 'JOYING_BOX'; - - public const TOTAL_EXPRESS = 'TOTAL_EXPRESS'; - - public const ZJS_EXPRESS = 'ZJS_EXPRESS'; - - public const STARKEN = 'STARKEN'; - - public const DEMANDSHIP = 'DEMANDSHIP'; - - public const CN_DPEX = 'CN_DPEX'; - - public const AUPOST_CN = 'AUPOST_CN'; - - public const LOGISTERS = 'LOGISTERS'; - - public const GOGLOBALPOST = 'GOGLOBALPOST'; - - public const GLS_CZ = 'GLS_CZ'; - - public const PAACK_WEBHOOK = 'PAACK_WEBHOOK'; - - public const GRAB_WEBHOOK = 'GRAB_WEBHOOK'; - - public const PARCELPOINT = 'PARCELPOINT'; - - public const ICUMULUS = 'ICUMULUS'; - - public const DAIGLOBALTRACK = 'DAIGLOBALTRACK'; - - public const GLOBAL_IPARCEL = 'GLOBAL_IPARCEL'; - - public const YURTICI_KARGO = 'YURTICI_KARGO'; - - public const CN_PAYPAL_PACKAGE = 'CN_PAYPAL_PACKAGE'; - - public const PARCEL_2_POST = 'PARCEL_2_POST'; - - public const GLS_IT = 'GLS_IT'; - - public const PIL_LOGISTICS = 'PIL_LOGISTICS'; - - public const HEPPNER = 'HEPPNER'; - - public const GENERAL_OVERNIGHT = 'GENERAL_OVERNIGHT'; - - public const HAPPY2POINT = 'HAPPY2POINT'; - - public const CHITCHATS = 'CHITCHATS'; - - public const SMOOTH = 'SMOOTH'; - - public const CLE_LOGISTICS = 'CLE_LOGISTICS'; - - public const FIEGE = 'FIEGE'; - - public const MX_CARGO = 'MX_CARGO'; - - public const ZIINGFINALMILE = 'ZIINGFINALMILE'; - - public const DAYTON_FREIGHT = 'DAYTON_FREIGHT'; - - public const TCS = 'TCS'; - - public const AEX = 'AEX'; - - public const HERMES_DE = 'HERMES_DE'; - - public const ROUTIFIC_WEBHOOK = 'ROUTIFIC_WEBHOOK'; - - public const GLOBAVEND = 'GLOBAVEND'; - - public const CJ_LOGISTICS = 'CJ_LOGISTICS'; - - public const PALLET_NETWORK = 'PALLET_NETWORK'; - - public const RAF_PH = 'RAF_PH'; - - public const UK_XDP = 'UK_XDP'; - - public const PAPER_EXPRESS = 'PAPER_EXPRESS'; - - public const LA_POSTE_SUIVI = 'LA_POSTE_SUIVI'; - - public const PAQUETEXPRESS = 'PAQUETEXPRESS'; - - public const LIEFERY = 'LIEFERY'; - - public const STRECK_TRANSPORT = 'STRECK_TRANSPORT'; - - public const PONY_EXPRESS = 'PONY_EXPRESS'; - - public const ALWAYS_EXPRESS = 'ALWAYS_EXPRESS'; - - public const GBS_BROKER = 'GBS_BROKER'; - - public const CITYLINK_MY = 'CITYLINK_MY'; - - public const ALLJOY = 'ALLJOY'; - - public const YODEL = 'YODEL'; - - public const YODEL_DIR = 'YODEL_DIR'; - - public const STONE3PL = 'STONE3PL'; - - public const PARCELPAL_WEBHOOK = 'PARCELPAL_WEBHOOK'; - - public const DHL_ECOMERCE_ASA = 'DHL_ECOMERCE_ASA'; - - public const SIMPLYPOST = 'SIMPLYPOST'; - - public const KY_EXPRESS = 'KY_EXPRESS'; - - public const SHENZHEN = 'SHENZHEN'; - - public const US_LASERSHIP = 'US_LASERSHIP'; - - public const UC_EXPRE = 'UC_EXPRE'; - - public const DIDADI = 'DIDADI'; - - public const CJ_KR = 'CJ_KR'; - - public const DBSCHENKER_B2B = 'DBSCHENKER_B2B'; - - public const MXE = 'MXE'; - - public const CAE_DELIVERS = 'CAE_DELIVERS'; - - public const PFCEXPRESS = 'PFCEXPRESS'; - - public const WHISTL = 'WHISTL'; - - public const WEPOST = 'WEPOST'; - - public const DHL_PARCEL_ES = 'DHL_PARCEL_ES'; - - public const DDEXPRESS = 'DDEXPRESS'; - - public const ARAMEX_AU = 'ARAMEX_AU'; - - public const BNEED = 'BNEED'; - - public const HK_TGX = 'HK_TGX'; - - public const LATVIJAS_PASTS = 'LATVIJAS_PASTS'; - - public const VIAEUROPE = 'VIAEUROPE'; - - public const CORREO_UY = 'CORREO_UY'; - - public const CHRONOPOST_FR = 'CHRONOPOST_FR'; - - public const J_NET = 'J_NET'; - - public const _6LS = '_6LS'; - - public const BLR_BELPOST = 'BLR_BELPOST'; - - public const BIRDSYSTEM = 'BIRDSYSTEM'; - - public const DOBROPOST = 'DOBROPOST'; - - public const WAHANA_ID = 'WAHANA_ID'; - - public const WEASHIP = 'WEASHIP'; - - public const SONICTL = 'SONICTL'; - - public const KWT = 'KWT'; - - public const AFLLOG_FTP = 'AFLLOG_FTP'; - - public const SKYNET_WORLDWIDE = 'SKYNET_WORLDWIDE'; - - public const NOVA_POSHTA = 'NOVA_POSHTA'; - - public const SEINO = 'SEINO'; - - public const SZENDEX = 'SZENDEX'; - - public const BPOST_INT = 'BPOST_INT'; - - public const DBSCHENKER_SV = 'DBSCHENKER_SV'; - - public const AO_DEUTSCHLAND = 'AO_DEUTSCHLAND'; - - public const EU_FLEET_SOLUTIONS = 'EU_FLEET_SOLUTIONS'; - - public const PCFCORP = 'PCFCORP'; - - public const LINKBRIDGE = 'LINKBRIDGE'; - - public const PRIMAMULTICIPTA = 'PRIMAMULTICIPTA'; - - public const COUREX = 'COUREX'; - - public const ZAJIL_EXPRESS = 'ZAJIL_EXPRESS'; - - public const COLLECTCO = 'COLLECTCO'; - - public const JTEXPRESS = 'JTEXPRESS'; - - public const FEDEX_UK = 'FEDEX_UK'; - - public const USHIP = 'USHIP'; - - public const PIXSELL = 'PIXSELL'; - - public const SHIPTOR = 'SHIPTOR'; - - public const CDEK = 'CDEK'; - - public const VNM_VIETTELPOST = 'VNM_VIETTELPOST'; - - public const CJ_CENTURY = 'CJ_CENTURY'; - - public const GSO = 'GSO'; - - public const VIWO = 'VIWO'; - - public const SKYBOX = 'SKYBOX'; - - public const KERRYTJ = 'KERRYTJ'; - - public const NTLOGISTICS_VN = 'NTLOGISTICS_VN'; - - public const SDH_SCM = 'SDH_SCM'; - - public const ZINC = 'ZINC'; - - public const DPE_SOUTH_AFRC = 'DPE_SOUTH_AFRC'; - - public const CESKA_CZ = 'CESKA_CZ'; - - public const ACS_GR = 'ACS_GR'; - - public const DEALERSEND = 'DEALERSEND'; - - public const JOCOM = 'JOCOM'; - - public const CSE = 'CSE'; - - public const TFORCE_FINALMILE = 'TFORCE_FINALMILE'; - - public const SHIP_GATE = 'SHIP_GATE'; - - public const SHIPTER = 'SHIPTER'; - - public const NATIONAL_SAMEDAY = 'NATIONAL_SAMEDAY'; - - public const YUNEXPRESS = 'YUNEXPRESS'; - - public const CAINIAO = 'CAINIAO'; - - public const DMS_MATRIX = 'DMS_MATRIX'; - - public const DIRECTLOG = 'DIRECTLOG'; - - public const ASENDIA_US = 'ASENDIA_US'; - - public const _3JMSLOGISTICS = '_3JMSLOGISTICS'; - - public const LICCARDI_EXPRESS = 'LICCARDI_EXPRESS'; - - public const SKY_POSTAL = 'SKY_POSTAL'; - - public const CNWANGTONG = 'CNWANGTONG'; - - public const POSTNORD_LOGISTICS_DK = 'POSTNORD_LOGISTICS_DK'; - - public const LOGISTIKA = 'LOGISTIKA'; - - public const CELERITAS = 'CELERITAS'; - - public const PRESSIODE = 'PRESSIODE'; - - public const SHREE_MARUTI = 'SHREE_MARUTI'; - - public const LOGISTICSWORLDWIDE_HK = 'LOGISTICSWORLDWIDE_HK'; - - public const EFEX = 'EFEX'; - - public const LOTTE = 'LOTTE'; - - public const LONESTAR = 'LONESTAR'; - - public const APRISAEXPRESS = 'APRISAEXPRESS'; - - public const BEL_RS = 'BEL_RS'; - - public const OSM_WORLDWIDE = 'OSM_WORLDWIDE'; - - public const WESTGATE_GL = 'WESTGATE_GL'; - - public const FASTRACK = 'FASTRACK'; - - public const DTD_EXPR = 'DTD_EXPR'; - - public const ALFATREX = 'ALFATREX'; - - public const PROMEDDELIVERY = 'PROMEDDELIVERY'; - - public const THABIT_LOGISTICS = 'THABIT_LOGISTICS'; - - public const HCT_LOGISTICS = 'HCT_LOGISTICS'; - - public const CARRY_FLAP = 'CARRY_FLAP'; - - public const US_OLD_DOMINION = 'US_OLD_DOMINION'; - - public const ANICAM_BOX = 'ANICAM_BOX'; - - public const WANBEXPRESS = 'WANBEXPRESS'; - - public const AN_POST = 'AN_POST'; - - public const DPD_LOCAL = 'DPD_LOCAL'; - - public const STALLIONEXPRESS = 'STALLIONEXPRESS'; - - public const RAIDEREX = 'RAIDEREX'; - - public const SHOPFANS = 'SHOPFANS'; - - public const KYUNGDONG_PARCEL = 'KYUNGDONG_PARCEL'; - - public const CHAMPION_LOGISTICS = 'CHAMPION_LOGISTICS'; - - public const PICKUPP_SGP = 'PICKUPP_SGP'; - - public const MORNING_EXPRESS = 'MORNING_EXPRESS'; - - public const NACEX = 'NACEX'; - - public const THENILE_WEBHOOK = 'THENILE_WEBHOOK'; - - public const HOLISOL = 'HOLISOL'; - - public const LBCEXPRESS_FTP = 'LBCEXPRESS_FTP'; - - public const KURASI = 'KURASI'; - - public const USF_REDDAWAY = 'USF_REDDAWAY'; - - public const APG = 'APG'; - - public const CN_BOXC = 'CN_BOXC'; - - public const ECOSCOOTING = 'ECOSCOOTING'; - - public const MAINWAY = 'MAINWAY'; - - public const PAPERFLY = 'PAPERFLY'; - - public const HOUNDEXPRESS = 'HOUNDEXPRESS'; - - public const BOX_BERRY = 'BOX_BERRY'; - - public const EP_BOX = 'EP_BOX'; - - public const PLUS_LOG_UK = 'PLUS_LOG_UK'; - - public const FULFILLA = 'FULFILLA'; - - public const ASE = 'ASE'; - - public const MAIL_PLUS = 'MAIL_PLUS'; - - public const XPO_LOGISTICS = 'XPO_LOGISTICS'; - - public const WNDIRECT = 'WNDIRECT'; - - public const CLOUDWISH_ASIA = 'CLOUDWISH_ASIA'; - - public const ZELERIS = 'ZELERIS'; - - public const GIO_EXPRESS = 'GIO_EXPRESS'; - - public const OCS_WORLDWIDE = 'OCS_WORLDWIDE'; - - public const ARK_LOGISTICS = 'ARK_LOGISTICS'; - - public const AQUILINE = 'AQUILINE'; - - public const PILOT_FREIGHT = 'PILOT_FREIGHT'; - - public const QWINTRY = 'QWINTRY'; - - public const DANSKE_FRAGT = 'DANSKE_FRAGT'; - - public const CARRIERS = 'CARRIERS'; - - public const AIR_CANADA_GLOBAL = 'AIR_CANADA_GLOBAL'; - - public const PRESIDENT_TRANS = 'PRESIDENT_TRANS'; - - public const STEPFORWARDFS = 'STEPFORWARDFS'; - - public const SKYNET_UK = 'SKYNET_UK'; - - public const PITTOHIO = 'PITTOHIO'; - - public const CORREOS_EXPRESS = 'CORREOS_EXPRESS'; - - public const RL_US = 'RL_US'; - - public const MARA_XPRESS = 'MARA_XPRESS'; - - public const DESTINY = 'DESTINY'; - - public const UK_YODEL = 'UK_YODEL'; - - public const COMET_TECH = 'COMET_TECH'; - - public const DHL_PARCEL_RU = 'DHL_PARCEL_RU'; - - public const TNT_REFR = 'TNT_REFR'; - - public const SHREE_ANJANI_COURIER = 'SHREE_ANJANI_COURIER'; - - public const MIKROPAKKET_BE = 'MIKROPAKKET_BE'; - - public const ETS_EXPRESS = 'ETS_EXPRESS'; - - public const COLIS_PRIVE = 'COLIS_PRIVE'; - - public const CN_YUNDA = 'CN_YUNDA'; - - public const AAA_COOPER = 'AAA_COOPER'; - - public const ROCKET_PARCEL = 'ROCKET_PARCEL'; - - public const _360LION = '_360LION'; - - public const PANDU = 'PANDU'; - - public const PROFESSIONAL_COURIERS = 'PROFESSIONAL_COURIERS'; - - public const FLYTEXPRESS = 'FLYTEXPRESS'; - - public const LOGISTICSWORLDWIDE_MY = 'LOGISTICSWORLDWIDE_MY'; - - public const CORREOS_DE_ESPANA = 'CORREOS_DE_ESPANA'; - - public const IMX = 'IMX'; - - public const FOUR_PX_EXPRESS = 'FOUR_PX_EXPRESS'; - - public const XPRESSBEES = 'XPRESSBEES'; - - public const PICKUPP_VNM = 'PICKUPP_VNM'; - - public const STARTRACK_EXPRESS1 = 'STARTRACK_EXPRESS'; - - public const FR_COLISSIMO = 'FR_COLISSIMO'; - - public const NACEX_SPAIN_REFERENCE = 'NACEX_SPAIN_REFERENCE'; - - public const DHL_SUPPLY_CHAIN_AU = 'DHL_SUPPLY_CHAIN_AU'; - - public const ESHIPPING = 'ESHIPPING'; - - public const SHREETIRUPATI = 'SHREETIRUPATI'; - - public const HX_EXPRESS = 'HX_EXPRESS'; - - public const INDOPAKET = 'INDOPAKET'; - - public const CN_17POST = 'CN_17POST'; - - public const K1_EXPRESS = 'K1_EXPRESS'; - - public const CJ_GLS = 'CJ_GLS'; - - public const MYS_GDEX = 'MYS_GDEX'; - - public const NATIONEX = 'NATIONEX'; - - public const ANJUN = 'ANJUN'; - - public const FARGOOD = 'FARGOOD'; - - public const SMG_EXPRESS = 'SMG_EXPRESS'; - - public const RZYEXPRESS = 'RZYEXPRESS'; - - public const SEFL = 'SEFL'; - - public const TNT_CLICK_IT = 'TNT_CLICK_IT'; - - public const HDB = 'HDB'; - - public const HIPSHIPPER = 'HIPSHIPPER'; - - public const RPXLOGISTICS = 'RPXLOGISTICS'; - - public const KUEHNE = 'KUEHNE'; - - public const IT_NEXIVE = 'IT_NEXIVE'; - - public const PTS = 'PTS'; - - public const SWISS_POST_FTP = 'SWISS_POST_FTP'; - - public const FASTRK_SERV = 'FASTRK_SERV'; - - public const _4_72 = '_4_72'; - - public const US_YRC = 'US_YRC'; - - public const POSTNL_INTL_3S = 'POSTNL_INTL_3S'; - - public const ELIAN_POST = 'ELIAN_POST'; - - public const CUBYN = 'CUBYN'; - - public const SAU_SAUDI_POST = 'SAU_SAUDI_POST'; - - public const ABXEXPRESS_MY = 'ABXEXPRESS_MY'; - - public const HUAHAN_EXPRESS = 'HUAHAN_EXPRESS'; - - public const IND_JAYONEXPRESS = 'IND_JAYONEXPRESS'; - - public const ZES_EXPRESS = 'ZES_EXPRESS'; - - public const ZEPTO_EXPRESS = 'ZEPTO_EXPRESS'; - - public const SKYNET_ZA = 'SKYNET_ZA'; - - public const ZEEK_2_DOOR = 'ZEEK_2_DOOR'; - - public const BLINKLASTMILE = 'BLINKLASTMILE'; - - public const POSTA_UKR = 'POSTA_UKR'; - - public const CHROBINSON = 'CHROBINSON'; - - public const CN_POST56 = 'CN_POST56'; - - public const COURANT_PLUS = 'COURANT_PLUS'; - - public const SCUDEX_EXPRESS = 'SCUDEX_EXPRESS'; - - public const SHIPENTEGRA = 'SHIPENTEGRA'; - - public const B_TWO_C_EUROPE = 'B_TWO_C_EUROPE'; - - public const COPE = 'COPE'; - - public const IND_GATI = 'IND_GATI'; - - public const CN_WISHPOST = 'CN_WISHPOST'; - - public const NACEX_ES = 'NACEX_ES'; - - public const TAQBIN_HK = 'TAQBIN_HK'; - - public const GLOBALTRANZ = 'GLOBALTRANZ'; - - public const HKD = 'HKD'; - - public const BJSHOMEDELIVERY = 'BJSHOMEDELIVERY'; - - public const OMNIVA = 'OMNIVA'; - - public const SUTTON = 'SUTTON'; - - public const PANTHER_REFERENCE = 'PANTHER_REFERENCE'; - - public const SFCSERVICE = 'SFCSERVICE'; - - public const LTL = 'LTL'; - - public const PARKNPARCEL = 'PARKNPARCEL'; - - public const SPRING_GDS = 'SPRING_GDS'; - - public const ECEXPRESS = 'ECEXPRESS'; - - public const INTERPARCEL_AU = 'INTERPARCEL_AU'; - - public const AGILITY = 'AGILITY'; - - public const XL_EXPRESS = 'XL_EXPRESS'; - - public const ADERONLINE = 'ADERONLINE'; - - public const DIRECTCOURIERS = 'DIRECTCOURIERS'; - - public const PLANZER = 'PLANZER'; - - public const SENDING = 'SENDING'; - - public const NINJAVAN_WB = 'NINJAVAN_WB'; - - public const NATIONWIDE_MY = 'NATIONWIDE_MY'; - - public const SENDIT = 'SENDIT'; - - public const GB_ARROW = 'GB_ARROW'; - - public const IND_GOJAVAS = 'IND_GOJAVAS'; - - public const KPOST = 'KPOST'; - - public const DHL_FREIGHT = 'DHL_FREIGHT'; - - public const BLUECARE = 'BLUECARE'; - - public const JINDOUYUN = 'JINDOUYUN'; - - public const TRACKON = 'TRACKON'; - - public const GB_TUFFNELLS = 'GB_TUFFNELLS'; - - public const TRUMPCARD = 'TRUMPCARD'; - - public const ETOTAL = 'ETOTAL'; - - public const SFPLUS_WEBHOOK = 'SFPLUS_WEBHOOK'; - - public const SEKOLOGISTICS = 'SEKOLOGISTICS'; - - public const HERMES_2MANN_HANDLING = 'HERMES_2MANN_HANDLING'; - - public const DPD_LOCAL_REF = 'DPD_LOCAL_REF'; - - public const UDS = 'UDS'; - - public const ZA_SPECIALISED_FREIGHT = 'ZA_SPECIALISED_FREIGHT'; - - public const THA_KERRY = 'THA_KERRY'; - - public const PRT_INT_SEUR = 'PRT_INT_SEUR'; - - public const BRA_CORREIOS = 'BRA_CORREIOS'; - - public const NZ_NZ_POST = 'NZ_NZ_POST'; - - public const CN_EQUICK = 'CN_EQUICK'; - - public const MYS_EMS = 'MYS_EMS'; - - public const GB_NORSK = 'GB_NORSK'; - - public const ESP_MRW = 'ESP_MRW'; - - public const ESP_PACKLINK = 'ESP_PACKLINK'; - - public const KANGAROO_MY = 'KANGAROO_MY'; - - public const RPX = 'RPX'; - - public const XDP_UK_REFERENCE = 'XDP_UK_REFERENCE'; - - public const NINJAVAN_MY = 'NINJAVAN_MY'; - - public const ADICIONAL = 'ADICIONAL'; - - public const NINJAVAN_ID = 'NINJAVAN_ID'; - - public const ROADBULL = 'ROADBULL'; - - public const YAKIT = 'YAKIT'; - - public const MAILAMERICAS = 'MAILAMERICAS'; - - public const MIKROPAKKET = 'MIKROPAKKET'; - - public const DYNALOGIC = 'DYNALOGIC'; - - public const DHL_ES = 'DHL_ES'; - - public const DHL_PARCEL_NL = 'DHL_PARCEL_NL'; - - public const DHL_GLOBAL_MAIL_ASIA = 'DHL_GLOBAL_MAIL_ASIA'; - - public const DAWN_WING = 'DAWN_WING'; - - public const GENIKI_GR = 'GENIKI_GR'; - - public const HERMESWORLD_UK = 'HERMESWORLD_UK'; - - public const ALPHAFAST = 'ALPHAFAST'; - - public const BUYLOGIC = 'BUYLOGIC'; - - public const EKART = 'EKART'; - - public const MEX_SENDA = 'MEX_SENDA'; - - public const SFC_LOGISTICS = 'SFC_LOGISTICS'; - - public const POST_SERBIA = 'POST_SERBIA'; - - public const IND_DELHIVERY = 'IND_DELHIVERY'; - - public const DE_DPD_DELISTRACK = 'DE_DPD_DELISTRACK'; - - public const RPD2MAN = 'RPD2MAN'; - - public const CN_SF_EXPRESS = 'CN_SF_EXPRESS'; - - public const YANWEN = 'YANWEN'; - - public const MYS_SKYNET = 'MYS_SKYNET'; - - public const CORREOS_DE_MEXICO = 'CORREOS_DE_MEXICO'; - - public const CBL_LOGISTICA = 'CBL_LOGISTICA'; - - public const MEX_ESTAFETA = 'MEX_ESTAFETA'; - - public const AU_AUSTRIAN_POST = 'AU_AUSTRIAN_POST'; - - public const RINCOS = 'RINCOS'; - - public const NLD_DHL = 'NLD_DHL'; - - public const RUSSIAN_POST = 'RUSSIAN_POST'; - - public const COURIERS_PLEASE = 'COURIERS_PLEASE'; - - public const POSTNORD_LOGISTICS = 'POSTNORD_LOGISTICS'; - - public const FEDEX = 'FEDEX'; - - public const DPE_EXPRESS = 'DPE_EXPRESS'; - - public const DPD = 'DPD'; - - public const ADSONE = 'ADSONE'; - - public const IDN_JNE = 'IDN_JNE'; - - public const THECOURIERGUY = 'THECOURIERGUY'; - - public const CNEXPS = 'CNEXPS'; - - public const PRT_CHRONOPOST = 'PRT_CHRONOPOST'; - - public const LANDMARK_GLOBAL = 'LANDMARK_GLOBAL'; - - public const IT_DHL_ECOMMERCE = 'IT_DHL_ECOMMERCE'; - - public const ESP_NACEX = 'ESP_NACEX'; - - public const PRT_CTT = 'PRT_CTT'; - - public const BE_KIALA = 'BE_KIALA'; - - public const ASENDIA_UK = 'ASENDIA_UK'; - - public const GLOBAL_TNT = 'GLOBAL_TNT'; - - public const POSTUR_IS = 'POSTUR_IS'; - - public const EPARCEL_KR = 'EPARCEL_KR'; - - public const INPOST_PACZKOMATY = 'INPOST_PACZKOMATY'; - - public const IT_POSTE_ITALIA = 'IT_POSTE_ITALIA'; - - public const BE_BPOST = 'BE_BPOST'; - - public const PL_POCZTA_POLSKA = 'PL_POCZTA_POLSKA'; - - public const MYS_MYS_POST = 'MYS_MYS_POST'; - - public const SG_SG_POST = 'SG_SG_POST'; - - public const THA_THAILAND_POST = 'THA_THAILAND_POST'; - - public const LEXSHIP = 'LEXSHIP'; - - public const FASTWAY_NZ = 'FASTWAY_NZ'; - - public const DHL_AU = 'DHL_AU'; - - public const COSTMETICSNOW = 'COSTMETICSNOW'; - - public const PFLOGISTICS = 'PFLOGISTICS'; - - public const LOOMIS_EXPRESS = 'LOOMIS_EXPRESS'; - - public const GLS_ITALY = 'GLS_ITALY'; - - public const LINE = 'LINE'; - - public const GEL_EXPRESS = 'GEL_EXPRESS'; - - public const HUODULL = 'HUODULL'; - - public const NINJAVAN_SG = 'NINJAVAN_SG'; - - public const JANIO = 'JANIO'; - - public const AO_COURIER = 'AO_COURIER'; - - public const BRT_IT_SENDER_REF = 'BRT_IT_SENDER_REF'; - - public const SAILPOST = 'SAILPOST'; - - public const LALAMOVE = 'LALAMOVE'; - - public const NEWZEALAND_COURIERS = 'NEWZEALAND_COURIERS'; - - public const ETOMARS = 'ETOMARS'; - - public const VIRTRANSPORT = 'VIRTRANSPORT'; - - public const WIZMO = 'WIZMO'; - - public const PALLETWAYS = 'PALLETWAYS'; - - public const I_DIKA = 'I_DIKA'; - - public const CFL_LOGISTICS = 'CFL_LOGISTICS'; - - public const GEMWORLDWIDE = 'GEMWORLDWIDE'; - - public const GLOBAL_EXPRESS = 'GLOBAL_EXPRESS'; - - public const LOGISTYX_TRANSGROUP = 'LOGISTYX_TRANSGROUP'; - - public const WESTBANK_COURIER = 'WESTBANK_COURIER'; - - public const ARCO_SPEDIZIONI = 'ARCO_SPEDIZIONI'; - - public const YDH_EXPRESS = 'YDH_EXPRESS'; - - public const PARCELINKLOGISTICS = 'PARCELINKLOGISTICS'; - - public const CNDEXPRESS = 'CNDEXPRESS'; - - public const NOX_NIGHT_TIME_EXPRESS = 'NOX_NIGHT_TIME_EXPRESS'; - - public const AERONET = 'AERONET'; - - public const LTIANEXP = 'LTIANEXP'; - - public const INTEGRA2_FTP = 'INTEGRA2_FTP'; - - public const PARCELONE = 'PARCELONE'; - - public const NOX_NACHTEXPRESS = 'NOX_NACHTEXPRESS'; - - public const CN_CHINA_POST_EMS = 'CN_CHINA_POST_EMS'; - - public const CHUKOU1 = 'CHUKOU1'; - - public const GLS_SLOV = 'GLS_SLOV'; - - public const ORANGE_DS = 'ORANGE_DS'; - - public const JOOM_LOGIS = 'JOOM_LOGIS'; - - public const AUS_STARTRACK = 'AUS_STARTRACK'; - - public const DHL = 'DHL'; - - public const GB_APC = 'GB_APC'; - - public const BONDSCOURIERS = 'BONDSCOURIERS'; - - public const JPN_JAPAN_POST = 'JPN_JAPAN_POST'; - - public const USPS = 'USPS'; - - public const WINIT = 'WINIT'; - - public const ARG_OCA = 'ARG_OCA'; - - public const TW_TAIWAN_POST = 'TW_TAIWAN_POST'; - - public const DMM_NETWORK = 'DMM_NETWORK'; - - public const TNT = 'TNT'; - - public const BH_POSTA = 'BH_POSTA'; - - public const SWE_POSTNORD = 'SWE_POSTNORD'; - - public const CA_CANADA_POST = 'CA_CANADA_POST'; - - public const WISELOADS = 'WISELOADS'; - - public const ASENDIA_HK = 'ASENDIA_HK'; - - public const NLD_GLS = 'NLD_GLS'; - - public const MEX_REDPACK = 'MEX_REDPACK'; - - public const JET_SHIP = 'JET_SHIP'; - - public const DE_DHL_EXPRESS = 'DE_DHL_EXPRESS'; - - public const NINJAVAN_THAI = 'NINJAVAN_THAI'; - - public const RABEN_GROUP = 'RABEN_GROUP'; - - public const ESP_ASM = 'ESP_ASM'; - - public const HRV_HRVATSKA = 'HRV_HRVATSKA'; - - public const GLOBAL_ESTES = 'GLOBAL_ESTES'; - - public const LTU_LIETUVOS = 'LTU_LIETUVOS'; - - public const BEL_DHL = 'BEL_DHL'; - - public const AU_AU_POST = 'AU_AU_POST'; - - public const SPEEDEXCOURIER = 'SPEEDEXCOURIER'; - - public const FR_COLIS = 'FR_COLIS'; - - public const ARAMEX = 'ARAMEX'; - - public const DPEX = 'DPEX'; - - public const MYS_AIRPAK = 'MYS_AIRPAK'; - - public const CUCKOOEXPRESS = 'CUCKOOEXPRESS'; - - public const DPD_POLAND = 'DPD_POLAND'; - - public const NLD_POSTNL = 'NLD_POSTNL'; - - public const NIM_EXPRESS = 'NIM_EXPRESS'; - - public const QUANTIUM = 'QUANTIUM'; - - public const SENDLE = 'SENDLE'; - - public const ESP_REDUR = 'ESP_REDUR'; - - public const MATKAHUOLTO = 'MATKAHUOLTO'; - - public const CPACKET = 'CPACKET'; - - public const POSTI = 'POSTI'; - - public const HUNTER_EXPRESS = 'HUNTER_EXPRESS'; - - public const CHOIR_EXP = 'CHOIR_EXP'; - - public const LEGION_EXPRESS = 'LEGION_EXPRESS'; - - public const AUSTRIAN_POST_EXPRESS = 'AUSTRIAN_POST_EXPRESS'; - - public const GRUPO = 'GRUPO'; - - public const POSTA_RO = 'POSTA_RO'; - - public const INTERPARCEL_UK = 'INTERPARCEL_UK'; - - public const GLOBAL_ABF = 'GLOBAL_ABF'; - - public const POSTEN_NORGE = 'POSTEN_NORGE'; - - public const XPERT_DELIVERY = 'XPERT_DELIVERY'; - - public const DHL_REFR = 'DHL_REFR'; - - public const DHL_HK = 'DHL_HK'; - - public const SKYNET_UAE = 'SKYNET_UAE'; - - public const GOJEK = 'GOJEK'; - - public const YODEL_INTNL = 'YODEL_INTNL'; - - public const JANCO = 'JANCO'; - - public const YTO = 'YTO'; - - public const WISE_EXPRESS = 'WISE_EXPRESS'; - - public const JTEXPRESS_VN = 'JTEXPRESS_VN'; - - public const FEDEX_INTL_MLSERV = 'FEDEX_INTL_MLSERV'; - - public const VAMOX = 'VAMOX'; - - public const AMS_GRP = 'AMS_GRP'; - - public const DHL_JP = 'DHL_JP'; - - public const HRPARCEL = 'HRPARCEL'; - - public const GESWL = 'GESWL'; - - public const BLUESTAR = 'BLUESTAR'; - - public const CDEK_TR = 'CDEK_TR'; - - public const DESCARTES = 'DESCARTES'; - - public const DELTEC_UK = 'DELTEC_UK'; - - public const DTDC_EXPRESS = 'DTDC_EXPRESS'; - - public const TOURLINE = 'TOURLINE'; - - public const BH_WORLDWIDE = 'BH_WORLDWIDE'; - - public const OCS = 'OCS'; - - public const YINGNUO_LOGISTICS = 'YINGNUO_LOGISTICS'; - - public const UPS = 'UPS'; - - public const TOLL = 'TOLL'; - - public const PRT_SEUR = 'PRT_SEUR'; - - public const DTDC_AU = 'DTDC_AU'; - - public const THA_DYNAMIC_LOGISTICS = 'THA_DYNAMIC_LOGISTICS'; - - public const UBI_LOGISTICS = 'UBI_LOGISTICS'; - - public const FEDEX_CROSSBORDER = 'FEDEX_CROSSBORDER'; - - public const A1POST = 'A1POST'; - - public const TAZMANIAN_FREIGHT = 'TAZMANIAN_FREIGHT'; - - public const CJ_INT_MY = 'CJ_INT_MY'; - - public const SAIA_FREIGHT = 'SAIA_FREIGHT'; - - public const SG_QXPRESS = 'SG_QXPRESS'; - - public const NHANS_SOLUTIONS = 'NHANS_SOLUTIONS'; - - public const DPD_FR = 'DPD_FR'; - - public const COORDINADORA = 'COORDINADORA'; - - public const ANDREANI = 'ANDREANI'; - - public const DOORA = 'DOORA'; - - public const INTERPARCEL_NZ = 'INTERPARCEL_NZ'; - - public const PHL_JAMEXPRESS = 'PHL_JAMEXPRESS'; - - public const BEL_BELGIUM_POST = 'BEL_BELGIUM_POST'; - - public const US_APC = 'US_APC'; - - public const IDN_POS = 'IDN_POS'; - - public const FR_MONDIAL = 'FR_MONDIAL'; - - public const DE_DHL = 'DE_DHL'; - - public const HK_RPX = 'HK_RPX'; - - public const DHL_PIECEID = 'DHL_PIECEID'; - - public const VNPOST_EMS = 'VNPOST_EMS'; - - public const RRDONNELLEY = 'RRDONNELLEY'; - - public const DPD_DE = 'DPD_DE'; - - public const DELCART_IN = 'DELCART_IN'; - - public const IMEXGLOBALSOLUTIONS = 'IMEXGLOBALSOLUTIONS'; - - public const ACOMMERCE = 'ACOMMERCE'; - - public const EURODIS = 'EURODIS'; - - public const CANPAR = 'CANPAR'; - - public const GLS = 'GLS'; - - public const IND_ECOM = 'IND_ECOM'; - - public const ESP_ENVIALIA = 'ESP_ENVIALIA'; - - public const DHL_UK = 'DHL_UK'; - - public const SMSA_EXPRESS = 'SMSA_EXPRESS'; - - public const TNT_FR = 'TNT_FR'; - - public const DEX_I = 'DEX_I'; - - public const BUDBEE_WEBHOOK = 'BUDBEE_WEBHOOK'; - - public const COPA_COURIER = 'COPA_COURIER'; - - public const VNM_VIETNAM_POST = 'VNM_VIETNAM_POST'; - - public const DPD_HK = 'DPD_HK'; - - public const TOLL_NZ = 'TOLL_NZ'; - - public const ECHO_ = 'ECHO'; - - public const FEDEX_FR = 'FEDEX_FR'; - - public const BORDEREXPRESS = 'BORDEREXPRESS'; - - public const MAILPLUS_JPN = 'MAILPLUS_JPN'; - - public const TNT_UK_REFR = 'TNT_UK_REFR'; - - public const KEC = 'KEC'; - - public const DPD_RO = 'DPD_RO'; - - public const TNT_JP = 'TNT_JP'; - - public const TH_CJ = 'TH_CJ'; - - public const EC_CN = 'EC_CN'; - - public const FASTWAY_UK = 'FASTWAY_UK'; - - public const FASTWAY_US = 'FASTWAY_US'; - - public const GLS_DE = 'GLS_DE'; - - public const GLS_ES = 'GLS_ES'; - - public const GLS_FR = 'GLS_FR'; - - public const MONDIAL_BE = 'MONDIAL_BE'; - - public const SGT_IT = 'SGT_IT'; - - public const TNT_CN = 'TNT_CN'; - - public const TNT_DE = 'TNT_DE'; - - public const TNT_ES = 'TNT_ES'; - - public const TNT_PL = 'TNT_PL'; - - public const PARCELFORCE = 'PARCELFORCE'; - - public const SWISS_POST = 'SWISS_POST'; - - public const TOLL_IPEC = 'TOLL_IPEC'; - - public const AIR_21 = 'AIR_21'; - - public const AIRSPEED = 'AIRSPEED'; - - public const BERT = 'BERT'; - - public const BLUEDART = 'BLUEDART'; - - public const COLLECTPLUS = 'COLLECTPLUS'; - - public const COURIERPLUS = 'COURIERPLUS'; - - public const COURIER_POST = 'COURIER_POST'; - - public const DHL_GLOBAL_MAIL = 'DHL_GLOBAL_MAIL'; - - public const DPD_UK = 'DPD_UK'; - - public const DELTEC_DE = 'DELTEC_DE'; - - public const DEUTSCHE_DE = 'DEUTSCHE_DE'; - - public const DOTZOT = 'DOTZOT'; - - public const ELTA_GR = 'ELTA_GR'; - - public const EMS_CN = 'EMS_CN'; - - public const ECARGO = 'ECARGO'; - - public const ENSENDA = 'ENSENDA'; - - public const FERCAM_IT = 'FERCAM_IT'; - - public const FASTWAY_ZA = 'FASTWAY_ZA'; - - public const FASTWAY_AU = 'FASTWAY_AU'; - - public const FIRST_LOGISITCS = 'FIRST_LOGISITCS'; - - public const GEODIS = 'GEODIS'; - - public const GLOBEGISTICS = 'GLOBEGISTICS'; - - public const GREYHOUND = 'GREYHOUND'; - - public const JETSHIP_MY = 'JETSHIP_MY'; - - public const LION_PARCEL = 'LION_PARCEL'; - - public const AEROFLASH = 'AEROFLASH'; - - public const ONTRAC = 'ONTRAC'; - - public const SAGAWA = 'SAGAWA'; - - public const SIODEMKA = 'SIODEMKA'; - - public const STARTRACK = 'STARTRACK'; - - public const TNT_AU = 'TNT_AU'; - - public const TNT_IT = 'TNT_IT'; - - public const TRANSMISSION = 'TRANSMISSION'; - - public const YAMATO = 'YAMATO'; - - public const DHL_IT = 'DHL_IT'; - - public const DHL_AT = 'DHL_AT'; - - public const LOGISTICSWORLDWIDE_KR = 'LOGISTICSWORLDWIDE_KR'; - - public const GLS_SPAIN = 'GLS_SPAIN'; - - public const AMAZON_UK_API = 'AMAZON_UK_API'; - - public const DPD_FR_REFERENCE = 'DPD_FR_REFERENCE'; - - public const DHLPARCEL_UK = 'DHLPARCEL_UK'; - - public const MEGASAVE = 'MEGASAVE'; - - public const QUALITYPOST = 'QUALITYPOST'; - - public const IDS_LOGISTICS = 'IDS_LOGISTICS'; - - public const JOYINGBOX1 = 'JOYINGBOX'; - - public const PANTHER_ORDER_NUMBER = 'PANTHER_ORDER_NUMBER'; - - public const WATKINS_SHEPARD = 'WATKINS_SHEPARD'; - - public const FASTTRACK = 'FASTTRACK'; - - public const UP_EXPRESS = 'UP_EXPRESS'; - - public const ELOGISTICA = 'ELOGISTICA'; - - public const ECOURIER = 'ECOURIER'; - - public const CJ_PHILIPPINES = 'CJ_PHILIPPINES'; - - public const SPEEDEX = 'SPEEDEX'; - - public const ORANGECONNEX = 'ORANGECONNEX'; - - public const TECOR = 'TECOR'; - - public const SAEE = 'SAEE'; - - public const GLS_ITALY_FTP = 'GLS_ITALY_FTP'; - - public const DELIVERE = 'DELIVERE'; - - public const YYCOM = 'YYCOM'; - - public const ADICIONAL_PT = 'ADICIONAL_PT'; - - public const DKSH = 'DKSH'; - - public const NIPPON_EXPRESS_FTP = 'NIPPON_EXPRESS_FTP'; - - public const GOLS = 'GOLS'; - - public const FUJEXP = 'FUJEXP'; - - public const QTRACK = 'QTRACK'; - - public const OMLOGISTICS_API = 'OMLOGISTICS_API'; - - public const GDPHARM = 'GDPHARM'; - - public const MISUMI_CN = 'MISUMI_CN'; - - public const AIR_CANADA = 'AIR_CANADA'; - - public const CITY56_WEBHOOK = 'CITY56_WEBHOOK'; - - public const SAGAWA_API = 'SAGAWA_API'; - - public const KEDAEX = 'KEDAEX'; - - public const PGEON_API = 'PGEON_API'; - - public const WEWORLDEXPRESS = 'WEWORLDEXPRESS'; - - public const JT_LOGISTICS = 'JT_LOGISTICS'; - - public const TRUSK = 'TRUSK'; - - public const VIAXPRESS = 'VIAXPRESS'; - - public const DHL_SUPPLYCHAIN_ID = 'DHL_SUPPLYCHAIN_ID'; - - public const ZUELLIGPHARMA_SFTP = 'ZUELLIGPHARMA_SFTP'; - - public const MEEST = 'MEEST'; - - public const TOLL_PRIORITY = 'TOLL_PRIORITY'; - - public const MOTHERSHIP_API = 'MOTHERSHIP_API'; - - public const CAPITAL = 'CAPITAL'; - - public const EUROPAKET_API = 'EUROPAKET_API'; - - public const HFD = 'HFD'; - - public const TOURLINE_REFERENCE = 'TOURLINE_REFERENCE'; - - public const GIO_ECOURIER = 'GIO_ECOURIER'; - - public const CN_LOGISTICS = 'CN_LOGISTICS'; - - public const PANDION = 'PANDION'; - - public const BPOST_API = 'BPOST_API'; - - public const PASSPORTSHIPPING = 'PASSPORTSHIPPING'; - - public const PAKAJO = 'PAKAJO'; - - public const DACHSER = 'DACHSER'; - - public const YUSEN_SFTP = 'YUSEN_SFTP'; - - public const SHYPLITE = 'SHYPLITE'; - - public const XYY = 'XYY'; - - public const MWD = 'MWD'; - - public const FAXECARGO = 'FAXECARGO'; - - public const MAZET = 'MAZET'; - - public const FIRST_LOGISTICS_API = 'FIRST_LOGISTICS_API'; - - public const SPRINT_PACK = 'SPRINT_PACK'; - - public const HERMES_DE_FTP = 'HERMES_DE_FTP'; - - public const CONCISE = 'CONCISE'; - - public const KERRY_EXPRESS_TW_API = 'KERRY_EXPRESS_TW_API'; - - public const EWE = 'EWE'; - - public const FASTDESPATCH = 'FASTDESPATCH'; - - public const ABCUSTOM_SFTP = 'ABCUSTOM_SFTP'; - - public const CHAZKI = 'CHAZKI'; - - public const SHIPPIE = 'SHIPPIE'; - - public const GEODIS_API = 'GEODIS_API'; - - public const NAQEL_EXPRESS = 'NAQEL_EXPRESS'; - - public const PAPA_WEBHOOK = 'PAPA_WEBHOOK'; - - public const FORWARDAIR = 'FORWARDAIR'; - - public const DIALOGO_LOGISTICA_API = 'DIALOGO_LOGISTICA_API'; - - public const LALAMOVE_API = 'LALAMOVE_API'; - - public const TOMYDOOR = 'TOMYDOOR'; - - public const KRONOS_WEBHOOK = 'KRONOS_WEBHOOK'; - - public const JTCARGO = 'JTCARGO'; - - public const T_CAT = 'T_CAT'; - - public const CONCISE_WEBHOOK = 'CONCISE_WEBHOOK'; - - public const TELEPORT_WEBHOOK = 'TELEPORT_WEBHOOK'; - - public const CUSTOMCO_API = 'CUSTOMCO_API'; - - public const SPX_TH = 'SPX_TH'; - - public const BOLLORE_LOGISTICS = 'BOLLORE_LOGISTICS'; - - public const CLICKLINK_SFTP = 'CLICKLINK_SFTP'; - - public const M3LOGISTICS = 'M3LOGISTICS'; - - public const VNPOST_API = 'VNPOST_API'; - - public const AXLEHIRE_FTP = 'AXLEHIRE_FTP'; - - public const SHADOWFAX = 'SHADOWFAX'; - - public const MYHERMES_UK_API = 'MYHERMES_UK_API'; - - public const DAIICHI = 'DAIICHI'; - - public const MENSAJEROSURBANOS_API = 'MENSAJEROSURBANOS_API'; - - public const POLARSPEED = 'POLARSPEED'; - - public const IDEXPRESS_ID = 'IDEXPRESS_ID'; - - public const PAYO = 'PAYO'; - - public const WHISTL_SFTP = 'WHISTL_SFTP'; - - public const INTEX_DE = 'INTEX_DE'; - - public const TRANS2U = 'TRANS2U'; - - public const PRODUCTCAREGROUP_SFTP = 'PRODUCTCAREGROUP_SFTP'; - - public const BIGSMART = 'BIGSMART'; - - public const EXPEDITORS_API_REF = 'EXPEDITORS_API_REF'; - - public const AITWORLDWIDE_API = 'AITWORLDWIDE_API'; - - public const WORLDCOURIER = 'WORLDCOURIER'; - - public const QUIQUP = 'QUIQUP'; - - public const AGEDISS_SFTP = 'AGEDISS_SFTP'; - - public const ANDREANI_API = 'ANDREANI_API'; - - public const CRLEXPRESS = 'CRLEXPRESS'; - - public const SMARTCAT = 'SMARTCAT'; - - public const CROSSFLIGHT = 'CROSSFLIGHT'; - - public const PROCARRIER = 'PROCARRIER'; - - public const DHL_REFERENCE_API = 'DHL_REFERENCE_API'; - - public const SEINO_API = 'SEINO_API'; - - public const WSPEXPRESS = 'WSPEXPRESS'; - - public const KRONOS = 'KRONOS'; - - public const TOTAL_EXPRESS_API = 'TOTAL_EXPRESS_API'; - - public const PARCLL = 'PARCLL'; - - public const XPEDIGO = 'XPEDIGO'; - - public const STAR_TRACK_WEBHOOK = 'STAR_TRACK_WEBHOOK'; - - public const GPOST = 'GPOST'; - - public const UCS = 'UCS'; - - public const DMFGROUP = 'DMFGROUP'; - - public const COORDINADORA_API = 'COORDINADORA_API'; - - public const MARKEN = 'MARKEN'; - - public const NTL = 'NTL'; - - public const REDJEPAKKETJE = 'REDJEPAKKETJE'; - - public const ALLIED_EXPRESS_FTP = 'ALLIED_EXPRESS_FTP'; - - public const MONDIALRELAY_ES = 'MONDIALRELAY_ES'; - - public const NAEKO_FTP = 'NAEKO_FTP'; - - public const MHI = 'MHI'; - - public const SHIPPIFY = 'SHIPPIFY'; - - public const MALCA_AMIT_API = 'MALCA_AMIT_API'; - - public const JTEXPRESS_SG_API = 'JTEXPRESS_SG_API'; - - public const DACHSER_WEB = 'DACHSER_WEB'; - - public const FLIGHTLG = 'FLIGHTLG'; - - public const CAGO = 'CAGO'; - - public const COM1EXPRESS = 'COM1EXPRESS'; - - public const TONAMI_FTP = 'TONAMI_FTP'; - - public const PACKFLEET = 'PACKFLEET'; - - public const PUROLATOR_INTERNATIONAL = 'PUROLATOR_INTERNATIONAL'; - - public const WINESHIPPING_WEBHOOK = 'WINESHIPPING_WEBHOOK'; - - public const DHL_ES_SFTP = 'DHL_ES_SFTP'; - - public const PCHOME_API = 'PCHOME_API'; - - public const CESKAPOSTA_API = 'CESKAPOSTA_API'; - - public const GORUSH = 'GORUSH'; - - public const HOMERUNNER = 'HOMERUNNER'; - - public const AMAZON_ORDER = 'AMAZON_ORDER'; - - public const EFWNOW_API = 'EFWNOW_API'; - - public const CBL_LOGISTICA_API = 'CBL_LOGISTICA_API'; - - public const NIMBUSPOST = 'NIMBUSPOST'; - - public const LOGWIN_LOGISTICS = 'LOGWIN_LOGISTICS'; - - public const NOWLOG_API = 'NOWLOG_API'; - - public const DPD_NL = 'DPD_NL'; - - public const GODEPENDABLE = 'GODEPENDABLE'; - - public const ESDEX = 'ESDEX'; - - public const LOGISYSTEMS_SFTP = 'LOGISYSTEMS_SFTP'; - - public const EXPEDITORS = 'EXPEDITORS'; - - public const SNTGLOBAL_API = 'SNTGLOBAL_API'; - - public const SHIPX = 'SHIPX'; - - public const QINTL_API = 'QINTL_API'; - - public const PACKS = 'PACKS'; - - public const POSTNL_INTERNATIONAL = 'POSTNL_INTERNATIONAL'; - - public const AMAZON_EMAIL_PUSH = 'AMAZON_EMAIL_PUSH'; - - public const DHL_API = 'DHL_API'; - - public const SPX = 'SPX'; - - public const AXLEHIRE = 'AXLEHIRE'; - - public const ICSCOURIER = 'ICSCOURIER'; - - public const DIALOGO_LOGISTICA = 'DIALOGO_LOGISTICA'; - - public const SHUNBANG_EXPRESS = 'SHUNBANG_EXPRESS'; - - public const TCS_API = 'TCS_API'; - - public const SF_EXPRESS_CN = 'SF_EXPRESS_CN'; - - public const PACKETA = 'PACKETA'; - - public const SIC_TELIWAY = 'SIC_TELIWAY'; - - public const MONDIALRELAY_FR = 'MONDIALRELAY_FR'; - - public const INTIME_FTP = 'INTIME_FTP'; - - public const JD_EXPRESS = 'JD_EXPRESS'; - - public const FASTBOX = 'FASTBOX'; - - public const PATHEON = 'PATHEON'; - - public const INDIA_POST = 'INDIA_POST'; - - public const TIPSA_REF = 'TIPSA_REF'; - - public const ECOFREIGHT = 'ECOFREIGHT'; - - public const VOX = 'VOX'; - - public const DIRECTFREIGHT_AU_REF = 'DIRECTFREIGHT_AU_REF'; - - public const BESTTRANSPORT_SFTP = 'BESTTRANSPORT_SFTP'; - - public const AUSTRALIA_POST_API = 'AUSTRALIA_POST_API'; - - public const FRAGILEPAK_SFTP = 'FRAGILEPAK_SFTP'; - - public const FLIPXP = 'FLIPXP'; - - public const VALUE_WEBHOOK = 'VALUE_WEBHOOK'; - - public const DAESHIN = 'DAESHIN'; - - public const SHERPA = 'SHERPA'; - - public const MWD_API = 'MWD_API'; - - public const SMARTKARGO = 'SMARTKARGO'; - - public const DNJ_EXPRESS = 'DNJ_EXPRESS'; - - public const GOPEOPLE = 'GOPEOPLE'; - - public const MYSENDLE_API = 'MYSENDLE_API'; - - public const ARAMEX_API = 'ARAMEX_API'; - - public const PIDGE = 'PIDGE'; - - public const THAIPARCELS = 'THAIPARCELS'; - - public const PANTHER_REFERENCE_API = 'PANTHER_REFERENCE_API'; - - public const POSTAPLUS1 = 'POSTAPLUS'; - - public const BUFFALO = 'BUFFALO'; - - public const U_ENVIOS = 'U_ENVIOS'; - - public const ELITE_CO = 'ELITE_CO'; - - public const BARQEXP = 'BARQEXP'; - - public const ROCHE_INTERNAL_SFTP = 'ROCHE_INTERNAL_SFTP'; - - public const DBSCHENKER_ICELAND = 'DBSCHENKER_ICELAND'; - - public const TNT_FR_REFERENCE = 'TNT_FR_REFERENCE'; - - public const NEWGISTICSAPI = 'NEWGISTICSAPI'; - - public const GLOVO = 'GLOVO'; - - public const GWLOGIS_API = 'GWLOGIS_API'; - - public const SPREETAIL_API = 'SPREETAIL_API'; - - public const MOOVA = 'MOOVA'; - - public const PLYCONGROUP = 'PLYCONGROUP'; - - public const USPS_WEBHOOK = 'USPS_WEBHOOK'; - - public const REIMAGINEDELIVERY = 'REIMAGINEDELIVERY'; - - public const EDF_FTP = 'EDF_FTP'; - - public const DAO365 = 'DAO365'; - - public const BIOCAIR_FTP = 'BIOCAIR_FTP'; - - public const RANSA_WEBHOOK = 'RANSA_WEBHOOK'; - - public const SHIPXPRES = 'SHIPXPRES'; - - public const COURANT_PLUS_API = 'COURANT_PLUS_API'; - - public const SHIPA = 'SHIPA'; - - public const HOMELOGISTICS = 'HOMELOGISTICS'; - - public const DX = 'DX'; - - public const POSTE_ITALIANE_PACCOCELERE = 'POSTE_ITALIANE_PACCOCELERE'; - - public const TOLL_WEBHOOK = 'TOLL_WEBHOOK'; - - public const LCTBR_API = 'LCTBR_API'; - - public const DX_FREIGHT = 'DX_FREIGHT'; - - public const DHL_SFTP = 'DHL_SFTP'; - - public const SHIPROCKET = 'SHIPROCKET'; - - public const UBER_WEBHOOK = 'UBER_WEBHOOK'; - - public const STATOVERNIGHT = 'STATOVERNIGHT'; - - public const BURD = 'BURD'; - - public const FASTSHIP = 'FASTSHIP'; - - public const IBVENTURE_WEBHOOK = 'IBVENTURE_WEBHOOK'; - - public const GATI_KWE_API = 'GATI_KWE_API'; - - public const CRYOPDP_FTP = 'CRYOPDP_FTP'; - - public const HUBBED = 'HUBBED'; - - public const TIPSA_API = 'TIPSA_API'; - - public const ARASKARGO = 'ARASKARGO'; - - public const THIJS_NL = 'THIJS_NL'; - - public const ATSHEALTHCARE_REFERENCE = 'ATSHEALTHCARE_REFERENCE'; - - public const ENUM_99MINUTOS = '99MINUTOS'; - - public const HELLENIC_POST = 'HELLENIC_POST'; - - public const HSM_GLOBAL = 'HSM_GLOBAL'; - - public const MNX = 'MNX'; - - public const NMTRANSFER = 'NMTRANSFER'; - - public const LOGYSTO = 'LOGYSTO'; - - public const INDIA_POST_INT = 'INDIA_POST_INT'; - - public const AMAZON_FBA_SWISHIP_IN = 'AMAZON_FBA_SWISHIP_IN'; - - public const SRT_TRANSPORT = 'SRT_TRANSPORT'; - - public const BOMI = 'BOMI'; - - public const DELIVERR_SFTP = 'DELIVERR_SFTP'; - - public const HSDEXPRESS = 'HSDEXPRESS'; - - public const SIMPLETIRE_WEBHOOK = 'SIMPLETIRE_WEBHOOK'; - - public const HUNTER_EXPRESS_SFTP = 'HUNTER_EXPRESS_SFTP'; - - public const UPS_API = 'UPS_API'; - - public const WOOYOUNG_LOGISTICS_SFTP = 'WOOYOUNG_LOGISTICS_SFTP'; - - public const PHSE_API = 'PHSE_API'; - - public const WISH_EMAIL_PUSH = 'WISH_EMAIL_PUSH'; - - public const NORTHLINE = 'NORTHLINE'; - - public const MEDAFRICA = 'MEDAFRICA'; - - public const DPD_AT_SFTP = 'DPD_AT_SFTP'; - - public const ANTERAJA = 'ANTERAJA'; - - public const DHL_GLOBAL_FORWARDING_API = 'DHL_GLOBAL_FORWARDING_API'; - - public const LBCEXPRESS_API = 'LBCEXPRESS_API'; - - public const SIMSGLOBAL = 'SIMSGLOBAL'; - - public const CDLDELIVERS = 'CDLDELIVERS'; - - public const TYP = 'TYP'; - - public const TESTING_COURIER_WEBHOOK = 'TESTING_COURIER_WEBHOOK'; - - public const PANDAGO_API = 'PANDAGO_API'; - - public const ROYAL_MAIL_FTP = 'ROYAL_MAIL_FTP'; - - public const THUNDEREXPRESS = 'THUNDEREXPRESS'; - - public const SECRETLAB_WEBHOOK = 'SECRETLAB_WEBHOOK'; - - public const SETEL = 'SETEL'; - - public const JD_WORLDWIDE = 'JD_WORLDWIDE'; - - public const DPD_RU_API = 'DPD_RU_API'; - - public const ARGENTS_WEBHOOK = 'ARGENTS_WEBHOOK'; - - public const POSTONE = 'POSTONE'; - - public const TUSKLOGISTICS = 'TUSKLOGISTICS'; - - public const RHENUS_UK_API = 'RHENUS_UK_API'; - - public const TAQBIN_SG_API = 'TAQBIN_SG_API'; - - public const INNTRALOG_SFTP = 'INNTRALOG_SFTP'; - - public const DAYROSS = 'DAYROSS'; - - public const CORREOSEXPRESS_API = 'CORREOSEXPRESS_API'; - - public const INTERNATIONAL_SEUR_API = 'INTERNATIONAL_SEUR_API'; - - public const YODEL_API = 'YODEL_API'; - - public const HEROEXPRESS = 'HEROEXPRESS'; - - public const DHL_SUPPLYCHAIN_IN = 'DHL_SUPPLYCHAIN_IN'; - - public const URGENT_CARGUS = 'URGENT_CARGUS'; - - public const FRONTDOORCORP = 'FRONTDOORCORP'; - - public const JTEXPRESS_PH = 'JTEXPRESS_PH'; - - public const PARCELSTARS_WEBHOOK = 'PARCELSTARS_WEBHOOK'; - - public const DPD_SK_SFTP = 'DPD_SK_SFTP'; - - public const MOVIANTO = 'MOVIANTO'; - - public const OZEPARTS_SHIPPING = 'OZEPARTS_SHIPPING'; - - public const KARGOMKOLAY = 'KARGOMKOLAY'; - - public const TRUNKRS = 'TRUNKRS'; - - public const OMNIRPS_WEBHOOK = 'OMNIRPS_WEBHOOK'; - - public const CHILEXPRESS = 'CHILEXPRESS'; - - public const TESTING_COURIER = 'TESTING_COURIER'; - - public const JNE_API = 'JNE_API'; - - public const BJSHOMEDELIVERY_FTP = 'BJSHOMEDELIVERY_FTP'; - - public const DEXPRESS_WEBHOOK = 'DEXPRESS_WEBHOOK'; - - public const USPS_API = 'USPS_API'; - - public const TRANSVIRTUAL = 'TRANSVIRTUAL'; - - public const SOLISTICA_API = 'SOLISTICA_API'; - - public const CHIENVENTURE_WEBHOOK = 'CHIENVENTURE_WEBHOOK'; - - public const DPD_UK_SFTP = 'DPD_UK_SFTP'; - - public const INPOST_UK = 'INPOST_UK'; - - public const JAVIT = 'JAVIT'; - - public const ZTO_DOMESTIC = 'ZTO_DOMESTIC'; - - public const DHL_GT_API = 'DHL_GT_API'; - - public const CEVA_TRACKING = 'CEVA_TRACKING'; - - public const KOMON_EXPRESS = 'KOMON_EXPRESS'; - - public const EASTWESTCOURIER_FTP = 'EASTWESTCOURIER_FTP'; - - public const DANNIAO = 'DANNIAO'; - - public const SPECTRAN = 'SPECTRAN'; - - public const DELIVER_IT = 'DELIVER_IT'; - - public const RELAISCOLIS = 'RELAISCOLIS'; - - public const GLS_SPAIN_API = 'GLS_SPAIN_API'; - - public const POSTPLUS = 'POSTPLUS'; - - public const AIRTERRA = 'AIRTERRA'; - - public const GIO_ECOURIER_API = 'GIO_ECOURIER_API'; - - public const DPD_CH_SFTP = 'DPD_CH_SFTP'; - - public const FEDEX_API = 'FEDEX_API'; - - public const INTERSMARTTRANS = 'INTERSMARTTRANS'; - - public const HERMES_UK_SFTP = 'HERMES_UK_SFTP'; - - public const EXELOT_FTP = 'EXELOT_FTP'; - - public const DHL_PA_API = 'DHL_PA_API'; - - public const VIRTRANSPORT_SFTP = 'VIRTRANSPORT_SFTP'; - - public const WORLDNET = 'WORLDNET'; - - public const INSTABOX_WEBHOOK = 'INSTABOX_WEBHOOK'; - - public const KNG = 'KNG'; - - public const FLASHEXPRESS_WEBHOOK = 'FLASHEXPRESS_WEBHOOK'; - - public const MAGYAR_POSTA_API = 'MAGYAR_POSTA_API'; - - public const WESHIP_API = 'WESHIP_API'; - - public const OHI_WEBHOOK = 'OHI_WEBHOOK'; - - public const MUDITA = 'MUDITA'; - - public const BLUEDART_API = 'BLUEDART_API'; - - public const T_CAT_API = 'T_CAT_API'; - - public const ADS = 'ADS'; - - public const HERMES_IT = 'HERMES_IT'; - - public const FITZMARK_API = 'FITZMARK_API'; - - public const POSTI_API = 'POSTI_API'; - - public const SMSA_EXPRESS_WEBHOOK = 'SMSA_EXPRESS_WEBHOOK'; - - public const TAMERGROUP_WEBHOOK = 'TAMERGROUP_WEBHOOK'; - - public const LIVRAPIDE = 'LIVRAPIDE'; - - public const NIPPON_EXPRESS = 'NIPPON_EXPRESS'; - - public const BETTERTRUCKS = 'BETTERTRUCKS'; - - public const FAN = 'FAN'; - - public const PB_USPSFLATS_FTP = 'PB_USPSFLATS_FTP'; - - public const PARCELRIGHT = 'PARCELRIGHT'; - - public const ITHINKLOGISTICS = 'ITHINKLOGISTICS'; - - public const KERRY_EXPRESS_TH_WEBHOOK = 'KERRY_EXPRESS_TH_WEBHOOK'; - - public const ECOUTIER = 'ECOUTIER'; - - public const SHOWL = 'SHOWL'; - - public const BRT_IT_API = 'BRT_IT_API'; - - public const RIXONHK_API = 'RIXONHK_API'; - - public const DBSCHENKER_API = 'DBSCHENKER_API'; - - public const ILYANGLOGIS = 'ILYANGLOGIS'; - - public const MAIL_BOX_ETC = 'MAIL_BOX_ETC'; - - public const WESHIP = 'WESHIP'; - - public const DHL_GLOBAL_MAIL_API = 'DHL_GLOBAL_MAIL_API'; - - public const ACTIVOS24_API = 'ACTIVOS24_API'; - - public const ATSHEALTHCARE = 'ATSHEALTHCARE'; - - public const LUWJISTIK = 'LUWJISTIK'; - - public const GW_WORLD = 'GW_WORLD'; - - public const FAIRSENDEN_API = 'FAIRSENDEN_API'; - - public const SERVIP_WEBHOOK = 'SERVIP_WEBHOOK'; - - public const SWISHIP = 'SWISHIP'; - - public const TANET = 'TANET'; - - public const HOTSIN_CARGO = 'HOTSIN_CARGO'; - - public const DIREX = 'DIREX'; - - public const HUANTONG = 'HUANTONG'; - - public const IMILE_API = 'IMILE_API'; - - public const BDMNET = 'BDMNET'; - - public const AUEXPRESS = 'AUEXPRESS'; - - public const NYTLOGISTICS = 'NYTLOGISTICS'; - - public const DSV_REFERENCE = 'DSV_REFERENCE'; - - public const NOVOFARMA_WEBHOOK = 'NOVOFARMA_WEBHOOK'; - - public const AITWORLDWIDE_SFTP = 'AITWORLDWIDE_SFTP'; - - public const SHOPOLIVE = 'SHOPOLIVE'; - - public const FNF_ZA = 'FNF_ZA'; - - public const DHL_ECOMMERCE_GC = 'DHL_ECOMMERCE_GC'; - - public const FETCHR = 'FETCHR'; - - public const STARLINKS_API = 'STARLINKS_API'; - - public const YYEXPRESS = 'YYEXPRESS'; - - public const SERVIENTREGA = 'SERVIENTREGA'; - - public const HANJIN = 'HANJIN'; - - public const SPANISH_SEUR_FTP = 'SPANISH_SEUR_FTP'; - - public const DX_B2B_CONNUM = 'DX_B2B_CONNUM'; - - public const HELTHJEM_API = 'HELTHJEM_API'; - - public const INEXPOST = 'INEXPOST'; - - public const A2B_BA = 'A2B_BA'; - - public const RHENUS_GROUP = 'RHENUS_GROUP'; - - public const SBERLOGISTICS_RU = 'SBERLOGISTICS_RU'; - - public const MALCA_AMIT = 'MALCA_AMIT'; - - public const PPL = 'PPL'; - - public const OSM_WORLDWIDE_SFTP = 'OSM_WORLDWIDE_SFTP'; - - public const ACILOGISTIX = 'ACILOGISTIX'; - - public const OPTIMACOURIER = 'OPTIMACOURIER'; - - public const NOVA_POSHTA_API = 'NOVA_POSHTA_API'; - - public const LOGGI = 'LOGGI'; - - public const YIFAN = 'YIFAN'; - - public const MYDYNALOGIC = 'MYDYNALOGIC'; - - public const MORNINGLOBAL = 'MORNINGLOBAL'; - - public const CONCISE_API = 'CONCISE_API'; - - public const FXTRAN = 'FXTRAN'; - - public const DELIVERYOURPARCEL_ZA = 'DELIVERYOURPARCEL_ZA'; - - public const UPARCEL = 'UPARCEL'; - - public const MOBI_BR = 'MOBI_BR'; - - public const LOGINEXT_WEBHOOK = 'LOGINEXT_WEBHOOK'; - - public const EMS = 'EMS'; - - public const SPEEDY = 'SPEEDY'; - - 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 - ]; - - /** - * 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 ShipmentCarrier."); - } -} diff --git a/src/Models/ShippingDetails.php b/src/Models/ShippingDetails.php deleted file mode 100644 index b78b99d..0000000 --- a/src/Models/ShippingDetails.php +++ /dev/null @@ -1,161 +0,0 @@ -name; - } - - /** - * Sets Name. - * The name of the party. - * - * @maps name - */ - public function setName(?ShippingName $name): void - { - $this->name = $name; - } - - /** - * Returns Type. - * 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. - */ - public function getType(): ?string - { - return $this->type; - } - - /** - * Sets Type. - * 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. - * - * @maps type - */ - public function setType(?string $type): void - { - $this->type = $type; - } - - /** - * Returns 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 getOptions(): ?array - { - return $this->options; - } - - /** - * Sets Options. - * An array of shipping options that the payee or merchant offers to the payer to ship or pick up their - * items. - * - * @maps options - * - * @param ShippingOption[]|null $options - */ - public function setOptions(?array $options): void - { - $this->options = $options; - } - - /** - * Returns 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 getAddress(): ?Address - { - return $this->address; - } - - /** - * Sets 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). - * - * @maps address - */ - public function setAddress(?Address $address): void - { - $this->address = $address; - } - - /** - * 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->type)) { - $json['type'] = FullfillmentType::checkValue($this->type); - } - if (isset($this->options)) { - $json['options'] = $this->options; - } - if (isset($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 deleted file mode 100644 index 8bec39c..0000000 --- a/src/Models/ShippingName.php +++ /dev/null @@ -1,63 +0,0 @@ -fullName; - } - - /** - * Sets Full Name. - * When the party is a person, the party's full name. - * - * @maps full_name - */ - public function setFullName(?string $fullName): void - { - $this->fullName = $fullName; - } - - /** - * 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->fullName)) { - $json['full_name'] = $this->fullName; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/ShippingOption.php b/src/Models/ShippingOption.php deleted file mode 100644 index f9b9fc9..0000000 --- a/src/Models/ShippingOption.php +++ /dev/null @@ -1,196 +0,0 @@ -id = $id; - $this->label = $label; - $this->selected = $selected; - } - - /** - * 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; - } - - /** - * Returns Selected. - * If the API request sets `selected = true`, it represents the shipping option that the payee or - * merchant expects to be pre-selected for the payer when they first view the `shipping.options` in the - * PayPal Checkout experience. As part of the response if a `shipping.option` contains `selected=true`, - * it represents the shipping option that the payer selected during the course of checkout with PayPal. - * Only one `shipping.option` can be set to `selected=true`. - */ - public function getSelected(): bool - { - return $this->selected; - } - - /** - * Sets Selected. - * If the API request sets `selected = true`, it represents the shipping option that the payee or - * merchant expects to be pre-selected for the payer when they first view the `shipping.options` in the - * PayPal Checkout experience. As part of the response if a `shipping.option` contains `selected=true`, - * it represents the shipping option that the payer selected during the course of checkout with PayPal. - * Only one `shipping.option` can be set to `selected=true`. - * - * @required - * @maps selected - */ - public function setSelected(bool $selected): void - { - $this->selected = $selected; - } - - /** - * 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'] = ShippingType::checkValue($this->type); - } - if (isset($this->amount)) { - $json['amount'] = $this->amount; - } - $json['selected'] = $this->selected; - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/ShippingPreference.php b/src/Models/ShippingPreference.php deleted file mode 100644 index 9890525..0000000 --- a/src/Models/ShippingPreference.php +++ /dev/null @@ -1,47 +0,0 @@ -name; - } - - /** - * Sets Name. - * The name of the party. - * - * @maps name - */ - public function setName(?ShippingName $name): void - { - $this->name = $name; - } - - /** - * Returns Type. - * 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. - */ - public function getType(): ?string - { - return $this->type; - } - - /** - * Sets Type. - * 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. - * - * @maps type - */ - public function setType(?string $type): void - { - $this->type = $type; - } - - /** - * Returns 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 getOptions(): ?array - { - return $this->options; - } - - /** - * Sets Options. - * An array of shipping options that the payee or merchant offers to the payer to ship or pick up their - * items. - * - * @maps options - * - * @param ShippingOption[]|null $options - */ - public function setOptions(?array $options): void - { - $this->options = $options; - } - - /** - * Returns 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 getAddress(): ?Address - { - return $this->address; - } - - /** - * Sets 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). - * - * @maps address - */ - public function setAddress(?Address $address): void - { - $this->address = $address; - } - - /** - * Returns Trackers. - * An array of trackers for a transaction. - * - * @return OrderTrackerResponse[]|null - */ - public function getTrackers(): ?array - { - return $this->trackers; - } - - /** - * Sets Trackers. - * An array of trackers for a transaction. - * - * @maps trackers - * - * @param OrderTrackerResponse[]|null $trackers - */ - public function setTrackers(?array $trackers): void - { - $this->trackers = $trackers; - } - - /** - * 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->type)) { - $json['type'] = FullfillmentType::checkValue($this->type); - } - if (isset($this->options)) { - $json['options'] = $this->options; - } - if (isset($this->address)) { - $json['address'] = $this->address; - } - if (isset($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 deleted file mode 100644 index 9a42c69..0000000 --- a/src/Models/SofortPaymentObject.php +++ /dev/null @@ -1,157 +0,0 @@ -name; - } - - /** - * Sets Name. - * The full name representation like Mr J Smith. - * - * @maps name - */ - public function setName(?string $name): void - { - $this->name = $name; - } - - /** - * 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 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 [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 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 - */ - public function setCountryCode(?string $countryCode): void - { - $this->countryCode = $countryCode; - } - - /** - * Returns Bic. - * The business identification code (BIC). In payments systems, a BIC is used to identify a specific - * business, most commonly a bank. - */ - public function getBic(): ?string - { - return $this->bic; - } - - /** - * Sets Bic. - * The business identification code (BIC). In payments systems, a BIC is used to identify a specific - * business, most commonly a bank. - * - * @maps bic - */ - public function setBic(?string $bic): void - { - $this->bic = $bic; - } - - /** - * Returns Iban Last Chars. - * The last characters of the IBAN used to pay. - */ - public function getIbanLastChars(): ?string - { - return $this->ibanLastChars; - } - - /** - * Sets Iban Last Chars. - * The last characters of the IBAN used to pay. - * - * @maps iban_last_chars - */ - public function setIbanLastChars(?string $ibanLastChars): void - { - $this->ibanLastChars = $ibanLastChars; - } - - /** - * 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->countryCode)) { - $json['country_code'] = $this->countryCode; - } - if (isset($this->bic)) { - $json['bic'] = $this->bic; - } - if (isset($this->ibanLastChars)) { - $json['iban_last_chars'] = $this->ibanLastChars; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/SofortPaymentRequest.php b/src/Models/SofortPaymentRequest.php deleted file mode 100644 index 4eac603..0000000 --- a/src/Models/SofortPaymentRequest.php +++ /dev/null @@ -1,135 +0,0 @@ -name = $name; - $this->countryCode = $countryCode; - } - - /** - * Returns Name. - * The full name representation like Mr J Smith. - */ - public function getName(): string - { - return $this->name; - } - - /** - * Sets Name. - * The full name representation like Mr J Smith. - * - * @required - * @maps name - */ - public function setName(string $name): void - { - $this->name = $name; - } - - /** - * 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 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 [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 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; - } - - /** - * Returns Experience Context. - * Customizes the payer experience during the approval process for the payment. - */ - public function getExperienceContext(): ?ExperienceContext - { - return $this->experienceContext; - } - - /** - * Sets Experience Context. - * Customizes the payer experience during the approval process for the payment. - * - * @maps experience_context - */ - public function setExperienceContext(?ExperienceContext $experienceContext): void - { - $this->experienceContext = $experienceContext; - } - - /** - * 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; - $json['country_code'] = $this->countryCode; - if (isset($this->experienceContext)) { - $json['experience_context'] = $this->experienceContext; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/StandardEntryClassCode.php b/src/Models/StandardEntryClassCode.php deleted file mode 100644 index f0df468..0000000 --- a/src/Models/StandardEntryClassCode.php +++ /dev/null @@ -1,54 +0,0 @@ -Parameter - * compatibility:
    - */ -class StoredPaymentSource implements \JsonSerializable -{ - /** - * @var string - */ - private $paymentInitiator; - - /** - * @var string - */ - private $paymentType; - - /** - * @var string|null - */ - private $usage = StoredPaymentSourceUsageType::DERIVED; - - /** - * @var NetworkTransactionReference|null - */ - private $previousNetworkTransactionReference; - - /** - * @param string $paymentInitiator - * @param string $paymentType - */ - public function __construct(string $paymentInitiator, string $paymentType) - { - $this->paymentInitiator = $paymentInitiator; - $this->paymentType = $paymentType; - } - - /** - * 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 Payment Type. - * Indicates the type of the stored payment_source payment. - */ - public function getPaymentType(): string - { - return $this->paymentType; - } - - /** - * Sets Payment Type. - * Indicates the type of the stored payment_source payment. - * - * @required - * @maps payment_type - */ - public function setPaymentType(string $paymentType): void - { - $this->paymentType = $paymentType; - } - - /** - * 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; - } - - /** - * Returns Previous Network Transaction Reference. - * Reference values used by the card network to identify a transaction. - */ - public function getPreviousNetworkTransactionReference(): ?NetworkTransactionReference - { - return $this->previousNetworkTransactionReference; - } - - /** - * Sets Previous Network Transaction Reference. - * Reference values used by the card network to identify a transaction. - * - * @maps previous_network_transaction_reference - */ - public function setPreviousNetworkTransactionReference( - ?NetworkTransactionReference $previousNetworkTransactionReference - ): void { - $this->previousNetworkTransactionReference = $previousNetworkTransactionReference; - } - - /** - * 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'] = PaymentInitiator::checkValue($this->paymentInitiator); - $json['payment_type'] = - StoredPaymentSourcePaymentType::checkValue( - $this->paymentType - ); - if (isset($this->usage)) { - $json['usage'] = StoredPaymentSourceUsageType::checkValue($this->usage); - } - if (isset($this->previousNetworkTransactionReference)) { - $json['previous_network_transaction_reference'] = $this->previousNetworkTransactionReference; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/StoredPaymentSourcePaymentType.php b/src/Models/StoredPaymentSourcePaymentType.php deleted file mode 100644 index ee3f9f1..0000000 --- a/src/Models/StoredPaymentSourcePaymentType.php +++ /dev/null @@ -1,47 +0,0 @@ -checkout or multiparty checkout. - */ - public function getCard(): ?CardSupplementaryData - { - return $this->card; - } - - /** - * Sets Card. - * 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. - * - * @maps card - */ - public function setCard(?CardSupplementaryData $card): void - { - $this->card = $card; - } - - /** - * 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->card)) { - $json['card'] = $this->card; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/SupplementaryPurchaseData.php b/src/Models/SupplementaryPurchaseData.php deleted file mode 100644 index a85fbc2..0000000 --- a/src/Models/SupplementaryPurchaseData.php +++ /dev/null @@ -1,96 +0,0 @@ -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 Note to Payer. - * An informational note about this settlement. Appears in both the payer's transaction history and the - * emails that the payer receives. - */ - public function getNoteToPayer(): ?string - { - return $this->noteToPayer; - } - - /** - * Sets Note to Payer. - * An informational note about this settlement. Appears in both the payer's transaction history and the - * emails that the payer receives. - * - * @maps note_to_payer - */ - public function setNoteToPayer(?string $noteToPayer): void - { - $this->noteToPayer = $noteToPayer; - } - - /** - * 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->invoiceId)) { - $json['invoice_id'] = $this->invoiceId; - } - if (isset($this->noteToPayer)) { - $json['note_to_payer'] = $this->noteToPayer; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/TaxIdType.php b/src/Models/TaxIdType.php deleted file mode 100644 index 9b4c836..0000000 --- a/src/Models/TaxIdType.php +++ /dev/null @@ -1,45 +0,0 @@ -taxId = $taxId; - $this->taxIdType = $taxIdType; - } - - /** - * Returns Tax Id. - * The customer's tax ID value. - */ - public function getTaxId(): string - { - return $this->taxId; - } - - /** - * Sets Tax Id. - * The customer's tax ID value. - * - * @required - * @maps tax_id - */ - public function setTaxId(string $taxId): void - { - $this->taxId = $taxId; - } - - /** - * Returns Tax Id Type. - * The customer's tax ID type. - */ - public function getTaxIdType(): string - { - return $this->taxIdType; - } - - /** - * Sets Tax Id Type. - * The customer's tax ID type. - * - * @required - * @maps tax_id_type - */ - public function setTaxIdType(string $taxIdType): void - { - $this->taxIdType = $taxIdType; - } - - /** - * 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['tax_id'] = $this->taxId; - $json['tax_id_type'] = TaxIdType::checkValue($this->taxIdType); - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/ThreeDSecureAuthenticationResponse.php b/src/Models/ThreeDSecureAuthenticationResponse.php deleted file mode 100644 index e985b36..0000000 --- a/src/Models/ThreeDSecureAuthenticationResponse.php +++ /dev/null @@ -1,91 +0,0 @@ -authenticationStatus; - } - - /** - * Sets Authentication Status. - * Transactions status result identifier. The outcome of the issuer's authentication. - * - * @maps authentication_status - */ - public function setAuthenticationStatus(?string $authenticationStatus): void - { - $this->authenticationStatus = $authenticationStatus; - } - - /** - * Returns Enrollment Status. - * Status of Authentication eligibility. - */ - public function getEnrollmentStatus(): ?string - { - return $this->enrollmentStatus; - } - - /** - * Sets Enrollment Status. - * Status of Authentication eligibility. - * - * @maps enrollment_status - */ - public function setEnrollmentStatus(?string $enrollmentStatus): void - { - $this->enrollmentStatus = $enrollmentStatus; - } - - /** - * 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->authenticationStatus)) { - $json['authentication_status'] = PAResStatus::checkValue($this->authenticationStatus); - } - if (isset($this->enrollmentStatus)) { - $json['enrollment_status'] = EnrollmentStatus::checkValue($this->enrollmentStatus); - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/Token.php b/src/Models/Token.php deleted file mode 100644 index d39f3b7..0000000 --- a/src/Models/Token.php +++ /dev/null @@ -1,99 +0,0 @@ -id = $id; - $this->type = $type; - } - - /** - * Returns Id. - * The PayPal-generated ID for the token. - */ - public function getId(): string - { - return $this->id; - } - - /** - * Sets Id. - * The PayPal-generated ID for the token. - * - * @required - * @maps id - */ - public function setId(string $id): void - { - $this->id = $id; - } - - /** - * Returns Type. - * The tokenization method that generated the ID. - */ - public function getType(): string - { - return $this->type; - } - - /** - * Sets Type. - * The tokenization method that generated the ID. - * - * @required - * @maps type - */ - public function setType(string $type): void - { - $this->type = $type; - } - - /** - * 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['type'] = TokenType::checkValue($this->type); - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/TokenType.php b/src/Models/TokenType.php deleted file mode 100644 index f944522..0000000 --- a/src/Models/TokenType.php +++ /dev/null @@ -1,45 +0,0 @@ -name; - } - - /** - * Sets Name. - * The full name representation like Mr J Smith. - * - * @maps name - */ - public function setName(?string $name): void - { - $this->name = $name; - } - - /** - * 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 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 [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 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 - */ - public function setCountryCode(?string $countryCode): void - { - $this->countryCode = $countryCode; - } - - /** - * Returns Bic. - * The business identification code (BIC). In payments systems, a BIC is used to identify a specific - * business, most commonly a bank. - */ - public function getBic(): ?string - { - return $this->bic; - } - - /** - * Sets Bic. - * The business identification code (BIC). In payments systems, a BIC is used to identify a specific - * business, most commonly a bank. - * - * @maps bic - */ - public function setBic(?string $bic): void - { - $this->bic = $bic; - } - - /** - * Returns Iban Last Chars. - * The last characters of the IBAN used to pay. - */ - public function getIbanLastChars(): ?string - { - return $this->ibanLastChars; - } - - /** - * Sets Iban Last Chars. - * The last characters of the IBAN used to pay. - * - * @maps iban_last_chars - */ - public function setIbanLastChars(?string $ibanLastChars): void - { - $this->ibanLastChars = $ibanLastChars; - } - - /** - * 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->countryCode)) { - $json['country_code'] = $this->countryCode; - } - if (isset($this->bic)) { - $json['bic'] = $this->bic; - } - if (isset($this->ibanLastChars)) { - $json['iban_last_chars'] = $this->ibanLastChars; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/TrustlyPaymentRequest.php b/src/Models/TrustlyPaymentRequest.php deleted file mode 100644 index cd585a8..0000000 --- a/src/Models/TrustlyPaymentRequest.php +++ /dev/null @@ -1,135 +0,0 @@ -name = $name; - $this->countryCode = $countryCode; - } - - /** - * Returns Name. - * The full name representation like Mr J Smith. - */ - public function getName(): string - { - return $this->name; - } - - /** - * Sets Name. - * The full name representation like Mr J Smith. - * - * @required - * @maps name - */ - public function setName(string $name): void - { - $this->name = $name; - } - - /** - * 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 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 [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 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; - } - - /** - * Returns Experience Context. - * Customizes the payer experience during the approval process for the payment. - */ - public function getExperienceContext(): ?ExperienceContext - { - return $this->experienceContext; - } - - /** - * Sets Experience Context. - * Customizes the payer experience during the approval process for the payment. - * - * @maps experience_context - */ - public function setExperienceContext(?ExperienceContext $experienceContext): void - { - $this->experienceContext = $experienceContext; - } - - /** - * 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; - $json['country_code'] = $this->countryCode; - if (isset($this->experienceContext)) { - $json['experience_context'] = $this->experienceContext; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/UPCType.php b/src/Models/UPCType.php deleted file mode 100644 index 8867368..0000000 --- a/src/Models/UPCType.php +++ /dev/null @@ -1,55 +0,0 @@ -type = $type; - $this->code = $code; - } - - /** - * Returns Type. - * The Universal Product Code type. - */ - public function getType(): string - { - return $this->type; - } - - /** - * Sets Type. - * The Universal Product Code type. - * - * @required - * @maps type - */ - public function setType(string $type): void - { - $this->type = $type; - } - - /** - * Returns Code. - * The UPC product code of the item. - */ - public function getCode(): string - { - return $this->code; - } - - /** - * Sets Code. - * The UPC product code of the item. - * - * @required - * @maps code - */ - public function setCode(string $code): void - { - $this->code = $code; - } - - /** - * 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['type'] = UPCType::checkValue($this->type); - $json['code'] = $this->code; - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/VaultCustomer.php b/src/Models/VaultCustomer.php deleted file mode 100644 index af5f017..0000000 --- a/src/Models/VaultCustomer.php +++ /dev/null @@ -1,63 +0,0 @@ -id; - } - - /** - * Sets Id. - * The unique ID for a customer generated by PayPal. - * - * @maps id - */ - public function setId(?string $id): void - { - $this->id = $id; - } - - /** - * 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; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/VaultExperienceContext.php b/src/Models/VaultExperienceContext.php deleted file mode 100644 index 3889c07..0000000 --- a/src/Models/VaultExperienceContext.php +++ /dev/null @@ -1,219 +0,0 @@ -brandName; - } - - /** - * Sets Brand Name. - * 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. - * - * @maps brand_name - */ - public function setBrandName(?string $brandName): void - { - $this->brandName = $brandName; - } - - /** - * Returns Locale. - * 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/). - */ - public function getLocale(): ?string - { - return $this->locale; - } - - /** - * Sets Locale. - * 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/). - * - * @maps locale - */ - public function setLocale(?string $locale): void - { - $this->locale = $locale; - } - - /** - * Returns Return Url. - * The URL where the customer is redirected after customer approves leaves the flow. It is a required - * field for contingency flows like PayPal wallet, 3DS. - */ - public function getReturnUrl(): ?string - { - return $this->returnUrl; - } - - /** - * Sets Return Url. - * The URL where the customer is redirected after customer approves leaves the flow. It is a required - * field for contingency flows like PayPal wallet, 3DS. - * - * @maps return_url - */ - public function setReturnUrl(?string $returnUrl): void - { - $this->returnUrl = $returnUrl; - } - - /** - * Returns Cancel Url. - * The URL where the customer is redirected after customer cancels or leaves the flow. It is a required - * field for contingency flows like PayPal wallet, 3DS. - */ - public function getCancelUrl(): ?string - { - return $this->cancelUrl; - } - - /** - * Sets Cancel Url. - * The URL where the customer is redirected after customer cancels or leaves the flow. It is a required - * field for contingency flows like PayPal wallet, 3DS. - * - * @maps cancel_url - */ - public function setCancelUrl(?string $cancelUrl): void - { - $this->cancelUrl = $cancelUrl; - } - - /** - * Returns Shipping Preference. - * The shipping preference. This only applies to PayPal payment source. - */ - public function getShippingPreference(): ?string - { - return $this->shippingPreference; - } - - /** - * Sets Shipping Preference. - * The shipping preference. This only applies to PayPal payment source. - * - * @maps shipping_preference - */ - public function setShippingPreference(?string $shippingPreference): void - { - $this->shippingPreference = $shippingPreference; - } - - /** - * Returns Vault Instruction. - * Vault Instruction on action to be performed after a successful payer approval. - */ - public function getVaultInstruction(): ?string - { - return $this->vaultInstruction; - } - - /** - * Sets Vault Instruction. - * Vault Instruction on action to be performed after a successful payer approval. - * - * @maps vault_instruction - */ - public function setVaultInstruction(?string $vaultInstruction): void - { - $this->vaultInstruction = $vaultInstruction; - } - - /** - * 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->brandName)) { - $json['brand_name'] = $this->brandName; - } - if (isset($this->locale)) { - $json['locale'] = $this->locale; - } - if (isset($this->returnUrl)) { - $json['return_url'] = $this->returnUrl; - } - if (isset($this->cancelUrl)) { - $json['cancel_url'] = $this->cancelUrl; - } - if (isset($this->shippingPreference)) { - $json['shipping_preference'] = $this->shippingPreference; - } - if (isset($this->vaultInstruction)) { - $json['vault_instruction'] = $this->vaultInstruction; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/VaultInstruction.php b/src/Models/VaultInstruction.php deleted file mode 100644 index 034bdd3..0000000 --- a/src/Models/VaultInstruction.php +++ /dev/null @@ -1,71 +0,0 @@ -storeInVault = $storeInVault; - } - - /** - * Returns Store in Vault. - * Defines how and when the payment source gets vaulted. - */ - public function getStoreInVault(): string - { - return $this->storeInVault; - } - - /** - * Sets Store in Vault. - * Defines how and when the payment source gets vaulted. - * - * @required - * @maps store_in_vault - */ - public function setStoreInVault(string $storeInVault): void - { - $this->storeInVault = $storeInVault; - } - - /** - * 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['store_in_vault'] = StoreInVaultInstruction::checkValue($this->storeInVault); - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/VaultInstructionBase.php b/src/Models/VaultInstructionBase.php deleted file mode 100644 index fc22cca..0000000 --- a/src/Models/VaultInstructionBase.php +++ /dev/null @@ -1,64 +0,0 @@ -storeInVault; - } - - /** - * Sets Store in Vault. - * Defines how and when the payment source gets vaulted. - * - * @maps store_in_vault - */ - public function setStoreInVault(?string $storeInVault): void - { - $this->storeInVault = $storeInVault; - } - - /** - * 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->storeInVault)) { - $json['store_in_vault'] = StoreInVaultInstruction::checkValue($this->storeInVault); - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/VaultPayPalWalletRequest.php b/src/Models/VaultPayPalWalletRequest.php deleted file mode 100644 index 896a0e9..0000000 --- a/src/Models/VaultPayPalWalletRequest.php +++ /dev/null @@ -1,217 +0,0 @@ -description; - } - - /** - * Sets Description. - * The description displayed to the consumer on the approval flow for a digital wallet, as well as on - * the merchant view of the payment token management experience. exp: PayPal.com. - * - * @maps description - */ - public function setDescription(?string $description): void - { - $this->description = $description; - } - - /** - * Returns Shipping. - * The shipping details. - */ - public function getShipping(): ?VaultedDigitalWalletShippingDetails - { - return $this->shipping; - } - - /** - * Sets Shipping. - * The shipping details. - * - * @maps shipping - */ - public function setShipping(?VaultedDigitalWalletShippingDetails $shipping): void - { - $this->shipping = $shipping; - } - - /** - * Returns Permit Multiple Payment Tokens. - * Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the - * customer has not logged in at merchant/platform. The payment token thus generated, can then also be - * used to create the customer account at merchant/platform. Use this also when multiple payment tokens - * are required for the same payer, different customer at merchant/platform. This helps to identify - * customers distinctly even though they may share the same PayPal account. This only applies to PayPal - * payment source. - */ - public function getPermitMultiplePaymentTokens(): ?bool - { - return $this->permitMultiplePaymentTokens; - } - - /** - * Sets Permit Multiple Payment Tokens. - * Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the - * customer has not logged in at merchant/platform. The payment token thus generated, can then also be - * used to create the customer account at merchant/platform. Use this also when multiple payment tokens - * are required for the same payer, different customer at merchant/platform. This helps to identify - * customers distinctly even though they may share the same PayPal account. This only applies to PayPal - * payment source. - * - * @maps permit_multiple_payment_tokens - */ - public function setPermitMultiplePaymentTokens(?bool $permitMultiplePaymentTokens): void - { - $this->permitMultiplePaymentTokens = $permitMultiplePaymentTokens; - } - - /** - * Returns Usage Type. - * The usage type associated with a digital wallet payment token. - */ - public function getUsageType(): ?string - { - return $this->usageType; - } - - /** - * Sets Usage Type. - * The usage type associated with a digital wallet payment token. - * - * @maps usage_type - */ - public function setUsageType(?string $usageType): void - { - $this->usageType = $usageType; - } - - /** - * Returns Customer Type. - * 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. - */ - public function getCustomerType(): ?string - { - return $this->customerType; - } - - /** - * Sets Customer Type. - * 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. - * - * @maps customer_type - */ - public function setCustomerType(?string $customerType): void - { - $this->customerType = $customerType; - } - - /** - * Returns Experience Context. - * Customizes the Vault creation flow experience for your customers. - */ - public function getExperienceContext(): ?VaultExperienceContext - { - return $this->experienceContext; - } - - /** - * Sets Experience Context. - * Customizes the Vault creation flow experience for your customers. - * - * @maps experience_context - */ - public function setExperienceContext(?VaultExperienceContext $experienceContext): void - { - $this->experienceContext = $experienceContext; - } - - /** - * 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->description)) { - $json['description'] = $this->description; - } - if (isset($this->shipping)) { - $json['shipping'] = $this->shipping; - } - if (isset($this->permitMultiplePaymentTokens)) { - $json['permit_multiple_payment_tokens'] = $this->permitMultiplePaymentTokens; - } - if (isset($this->usageType)) { - $json['usage_type'] = $this->usageType; - } - if (isset($this->customerType)) { - $json['customer_type'] = $this->customerType; - } - if (isset($this->experienceContext)) { - $json['experience_context'] = $this->experienceContext; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/VaultResponse.php b/src/Models/VaultResponse.php deleted file mode 100644 index d4db436..0000000 --- a/src/Models/VaultResponse.php +++ /dev/null @@ -1,151 +0,0 @@ -id; - } - - /** - * Sets Id. - * The PayPal-generated ID for the saved payment source. - * - * @maps id - */ - public function setId(?string $id): void - { - $this->id = $id; - } - - /** - * Returns Status. - * The vault status. - */ - public function getStatus(): ?string - { - return $this->status; - } - - /** - * Sets Status. - * The vault status. - * - * @maps status - */ - public function setStatus(?string $status): void - { - $this->status = $status; - } - - /** - * Returns Customer. - * The details about a customer in PayPal's system of record. - */ - public function getCustomer(): ?VaultCustomer - { - return $this->customer; - } - - /** - * Sets Customer. - * The details about a customer in PayPal's system of record. - * - * @maps customer - */ - public function setCustomer(?VaultCustomer $customer): void - { - $this->customer = $customer; - } - - /** - * Returns Links. - * An array of request-related HATEOAS links. - * - * @return LinkDescription[]|null - */ - public function getLinks(): ?array - { - return $this->links; - } - - /** - * Sets Links. - * An array of request-related HATEOAS links. - * - * @maps links - * - * @param LinkDescription[]|null $links - */ - public function setLinks(?array $links): void - { - $this->links = $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->status)) { - $json['status'] = VaultStatus::checkValue($this->status); - } - if (isset($this->customer)) { - $json['customer'] = $this->customer; - } - if (isset($this->links)) { - $json['links'] = $this->links; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/VaultSEPADebitResponse.php b/src/Models/VaultSEPADebitResponse.php deleted file mode 100644 index fbe9639..0000000 --- a/src/Models/VaultSEPADebitResponse.php +++ /dev/null @@ -1,127 +0,0 @@ -ibanLastChars; - } - - /** - * Sets Iban Last Chars. - * The last characters of the IBAN used to pay. - * - * @maps iban_last_chars - */ - public function setIbanLastChars(?string $ibanLastChars): void - { - $this->ibanLastChars = $ibanLastChars; - } - - /** - * Returns Account Holder Name. - * - * @return mixed - */ - public function getAccountHolderName() - { - return $this->accountHolderName; - } - - /** - * Sets Account Holder Name. - * - * @maps account_holder_name - * - * @param mixed $accountHolderName - */ - public function setAccountHolderName($accountHolderName): void - { - $this->accountHolderName = $accountHolderName; - } - - /** - * Returns Billing 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 getBillingAddress(): ?Address - { - return $this->billingAddress; - } - - /** - * Sets Billing 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). - * - * @maps billing_address - */ - public function setBillingAddress(?Address $billingAddress): void - { - $this->billingAddress = $billingAddress; - } - - /** - * 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->ibanLastChars)) { - $json['iban_last_chars'] = $this->ibanLastChars; - } - if (isset($this->accountHolderName)) { - $json['account_holder_name'] = $this->accountHolderName; - } - if (isset($this->billingAddress)) { - $json['billing_address'] = $this->billingAddress; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/VaultStatus.php b/src/Models/VaultStatus.php deleted file mode 100644 index 3031d91..0000000 --- a/src/Models/VaultStatus.php +++ /dev/null @@ -1,47 +0,0 @@ -id = $id; - $this->type = $type; - } - - /** - * Returns Id. - * The PayPal-generated ID for the token. - */ - public function getId(): string - { - return $this->id; - } - - /** - * Sets Id. - * The PayPal-generated ID for the token. - * - * @required - * @maps id - */ - public function setId(string $id): void - { - $this->id = $id; - } - - /** - * Returns Type. - * The tokenization method that generated the ID. - */ - public function getType(): string - { - return $this->type; - } - - /** - * Sets Type. - * The tokenization method that generated the ID. - * - * @required - * @maps type - */ - public function setType(string $type): void - { - $this->type = $type; - } - - /** - * 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['type'] = TokenType::checkValue($this->type); - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/VaultVenmoExperienceContext.php b/src/Models/VaultVenmoExperienceContext.php deleted file mode 100644 index d32b3b8..0000000 --- a/src/Models/VaultVenmoExperienceContext.php +++ /dev/null @@ -1,121 +0,0 @@ -brandName; - } - - /** - * Sets Brand Name. - * 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. - * - * @maps brand_name - */ - public function setBrandName(?string $brandName): void - { - $this->brandName = $brandName; - } - - /** - * Returns Shipping Preference. - * The shipping preference. This only applies to PayPal payment source. - */ - public function getShippingPreference(): ?string - { - return $this->shippingPreference; - } - - /** - * Sets Shipping Preference. - * The shipping preference. This only applies to PayPal payment source. - * - * @maps shipping_preference - */ - public function setShippingPreference(?string $shippingPreference): void - { - $this->shippingPreference = $shippingPreference; - } - - /** - * Returns Vault Instruction. - * Vault Instruction on action to be performed after a successful payer approval. - */ - public function getVaultInstruction(): ?string - { - return $this->vaultInstruction; - } - - /** - * Sets Vault Instruction. - * Vault Instruction on action to be performed after a successful payer approval. - * - * @maps vault_instruction - */ - public function setVaultInstruction(?string $vaultInstruction): void - { - $this->vaultInstruction = $vaultInstruction; - } - - /** - * 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->brandName)) { - $json['brand_name'] = $this->brandName; - } - if (isset($this->shippingPreference)) { - $json['shipping_preference'] = $this->shippingPreference; - } - if (isset($this->vaultInstruction)) { - $json['vault_instruction'] = $this->vaultInstruction; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/VaultVenmoRequest.php b/src/Models/VaultVenmoRequest.php deleted file mode 100644 index adb2a8d..0000000 --- a/src/Models/VaultVenmoRequest.php +++ /dev/null @@ -1,214 +0,0 @@ -description; - } - - /** - * Sets Description. - * The description displayed to the consumer on the approval flow for a digital wallet, as well as on - * the merchant view of the payment token management experience. exp: PayPal.com. - * - * @maps description - */ - public function setDescription(?string $description): void - { - $this->description = $description; - } - - /** - * Returns Shipping. - * The shipping details. - */ - public function getShipping(): ?VaultedDigitalWalletShippingDetails - { - return $this->shipping; - } - - /** - * Sets Shipping. - * The shipping details. - * - * @maps shipping - */ - public function setShipping(?VaultedDigitalWalletShippingDetails $shipping): void - { - $this->shipping = $shipping; - } - - /** - * Returns Permit Multiple Payment Tokens. - * Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the - * customer has not logged in at merchant/platform. The payment token thus generated, can then also be - * used to create the customer account at merchant/platform. Use this also when multiple payment tokens - * are required for the same payer, different customer at merchant/platform. This helps to identify - * customers distinctly even though they may share the same PayPal account. This only applies to PayPal - * payment source. - */ - public function getPermitMultiplePaymentTokens(): ?bool - { - return $this->permitMultiplePaymentTokens; - } - - /** - * Sets Permit Multiple Payment Tokens. - * Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the - * customer has not logged in at merchant/platform. The payment token thus generated, can then also be - * used to create the customer account at merchant/platform. Use this also when multiple payment tokens - * are required for the same payer, different customer at merchant/platform. This helps to identify - * customers distinctly even though they may share the same PayPal account. This only applies to PayPal - * payment source. - * - * @maps permit_multiple_payment_tokens - */ - public function setPermitMultiplePaymentTokens(?bool $permitMultiplePaymentTokens): void - { - $this->permitMultiplePaymentTokens = $permitMultiplePaymentTokens; - } - - /** - * Returns Usage Type. - * The usage type associated with a digital wallet payment token. - */ - public function getUsageType(): ?string - { - return $this->usageType; - } - - /** - * Sets Usage Type. - * The usage type associated with a digital wallet payment token. - * - * @maps usage_type - */ - public function setUsageType(?string $usageType): void - { - $this->usageType = $usageType; - } - - /** - * Returns Customer Type. - * 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. - */ - public function getCustomerType(): ?string - { - return $this->customerType; - } - - /** - * Sets Customer Type. - * 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. - * - * @maps customer_type - */ - public function setCustomerType(?string $customerType): void - { - $this->customerType = $customerType; - } - - /** - * Returns Experience Context. - * Customizes the Vault creation flow experience for your customers. - */ - public function getExperienceContext(): ?VaultVenmoExperienceContext - { - return $this->experienceContext; - } - - /** - * Sets Experience Context. - * Customizes the Vault creation flow experience for your customers. - * - * @maps experience_context - */ - public function setExperienceContext(?VaultVenmoExperienceContext $experienceContext): void - { - $this->experienceContext = $experienceContext; - } - - /** - * 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->description)) { - $json['description'] = $this->description; - } - if (isset($this->shipping)) { - $json['shipping'] = $this->shipping; - } - if (isset($this->permitMultiplePaymentTokens)) { - $json['permit_multiple_payment_tokens'] = $this->permitMultiplePaymentTokens; - } - if (isset($this->usageType)) { - $json['usage_type'] = $this->usageType; - } - if (isset($this->customerType)) { - $json['customer_type'] = $this->customerType; - } - if (isset($this->experienceContext)) { - $json['experience_context'] = $this->experienceContext; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/VaultedDigitalWallet.php b/src/Models/VaultedDigitalWallet.php deleted file mode 100644 index 74b1a56..0000000 --- a/src/Models/VaultedDigitalWallet.php +++ /dev/null @@ -1,189 +0,0 @@ -description; - } - - /** - * Sets Description. - * The description displayed to the consumer on the approval flow for a digital wallet, as well as on - * the merchant view of the payment token management experience. exp: PayPal.com. - * - * @maps description - */ - public function setDescription(?string $description): void - { - $this->description = $description; - } - - /** - * Returns Shipping. - * The shipping details. - */ - public function getShipping(): ?VaultedDigitalWalletShippingDetails - { - return $this->shipping; - } - - /** - * Sets Shipping. - * The shipping details. - * - * @maps shipping - */ - public function setShipping(?VaultedDigitalWalletShippingDetails $shipping): void - { - $this->shipping = $shipping; - } - - /** - * Returns Permit Multiple Payment Tokens. - * Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the - * customer has not logged in at merchant/platform. The payment token thus generated, can then also be - * used to create the customer account at merchant/platform. Use this also when multiple payment tokens - * are required for the same payer, different customer at merchant/platform. This helps to identify - * customers distinctly even though they may share the same PayPal account. This only applies to PayPal - * payment source. - */ - public function getPermitMultiplePaymentTokens(): ?bool - { - return $this->permitMultiplePaymentTokens; - } - - /** - * Sets Permit Multiple Payment Tokens. - * Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the - * customer has not logged in at merchant/platform. The payment token thus generated, can then also be - * used to create the customer account at merchant/platform. Use this also when multiple payment tokens - * are required for the same payer, different customer at merchant/platform. This helps to identify - * customers distinctly even though they may share the same PayPal account. This only applies to PayPal - * payment source. - * - * @maps permit_multiple_payment_tokens - */ - public function setPermitMultiplePaymentTokens(?bool $permitMultiplePaymentTokens): void - { - $this->permitMultiplePaymentTokens = $permitMultiplePaymentTokens; - } - - /** - * Returns Usage Type. - * The usage type associated with a digital wallet payment token. - */ - public function getUsageType(): ?string - { - return $this->usageType; - } - - /** - * Sets Usage Type. - * The usage type associated with a digital wallet payment token. - * - * @maps usage_type - */ - public function setUsageType(?string $usageType): void - { - $this->usageType = $usageType; - } - - /** - * Returns Customer Type. - * 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. - */ - public function getCustomerType(): ?string - { - return $this->customerType; - } - - /** - * Sets Customer Type. - * 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. - * - * @maps customer_type - */ - public function setCustomerType(?string $customerType): void - { - $this->customerType = $customerType; - } - - /** - * 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->description)) { - $json['description'] = $this->description; - } - if (isset($this->shipping)) { - $json['shipping'] = $this->shipping; - } - if (isset($this->permitMultiplePaymentTokens)) { - $json['permit_multiple_payment_tokens'] = $this->permitMultiplePaymentTokens; - } - if (isset($this->usageType)) { - $json['usage_type'] = $this->usageType; - } - if (isset($this->customerType)) { - $json['customer_type'] = $this->customerType; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/VaultedDigitalWalletShippingDetails.php b/src/Models/VaultedDigitalWalletShippingDetails.php deleted file mode 100644 index ad1dec9..0000000 --- a/src/Models/VaultedDigitalWalletShippingDetails.php +++ /dev/null @@ -1,127 +0,0 @@ -name; - } - - /** - * Sets Name. - * The name of the party. - * - * @maps name - */ - public function setName(?ShippingName $name): void - { - $this->name = $name; - } - - /** - * Returns Type. - * 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. - */ - public function getType(): ?string - { - return $this->type; - } - - /** - * Sets Type. - * 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. - * - * @maps type - */ - public function setType(?string $type): void - { - $this->type = $type; - } - - /** - * Returns 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 getAddress(): ?Address - { - return $this->address; - } - - /** - * Sets 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). - * - * @maps address - */ - public function setAddress(?Address $address): void - { - $this->address = $address; - } - - /** - * 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->type)) { - $json['type'] = FullfillmentType::checkValue($this->type); - } - if (isset($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 deleted file mode 100644 index 351dc3e..0000000 --- a/src/Models/VenmoPaymentToken.php +++ /dev/null @@ -1,366 +0,0 @@ -description; - } - - /** - * Sets Description. - * The description displayed to the consumer on the approval flow for a digital wallet, as well as on - * the merchant view of the payment token management experience. exp: PayPal.com. - * - * @maps description - */ - public function setDescription(?string $description): void - { - $this->description = $description; - } - - /** - * Returns Shipping. - * The shipping details. - */ - public function getShipping(): ?VaultedDigitalWalletShippingDetails - { - return $this->shipping; - } - - /** - * Sets Shipping. - * The shipping details. - * - * @maps shipping - */ - public function setShipping(?VaultedDigitalWalletShippingDetails $shipping): void - { - $this->shipping = $shipping; - } - - /** - * Returns Permit Multiple Payment Tokens. - * Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the - * customer has not logged in at merchant/platform. The payment token thus generated, can then also be - * used to create the customer account at merchant/platform. Use this also when multiple payment tokens - * are required for the same payer, different customer at merchant/platform. This helps to identify - * customers distinctly even though they may share the same PayPal account. This only applies to PayPal - * payment source. - */ - public function getPermitMultiplePaymentTokens(): ?bool - { - return $this->permitMultiplePaymentTokens; - } - - /** - * Sets Permit Multiple Payment Tokens. - * Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the - * customer has not logged in at merchant/platform. The payment token thus generated, can then also be - * used to create the customer account at merchant/platform. Use this also when multiple payment tokens - * are required for the same payer, different customer at merchant/platform. This helps to identify - * customers distinctly even though they may share the same PayPal account. This only applies to PayPal - * payment source. - * - * @maps permit_multiple_payment_tokens - */ - public function setPermitMultiplePaymentTokens(?bool $permitMultiplePaymentTokens): void - { - $this->permitMultiplePaymentTokens = $permitMultiplePaymentTokens; - } - - /** - * Returns Usage Type. - * The usage type associated with a digital wallet payment token. - */ - public function getUsageType(): ?string - { - return $this->usageType; - } - - /** - * Sets Usage Type. - * The usage type associated with a digital wallet payment token. - * - * @maps usage_type - */ - public function setUsageType(?string $usageType): void - { - $this->usageType = $usageType; - } - - /** - * Returns Customer Type. - * 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. - */ - public function getCustomerType(): ?string - { - return $this->customerType; - } - - /** - * Sets Customer Type. - * 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. - * - * @maps customer_type - */ - public function setCustomerType(?string $customerType): void - { - $this->customerType = $customerType; - } - - /** - * 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 Payer Id. - * The account identifier for a PayPal account. - */ - public function getPayerId(): ?string - { - return $this->payerId; - } - - /** - * Sets Payer Id. - * The account identifier for a PayPal account. - * - * @maps payer_id - */ - public function setPayerId(?string $payerId): void - { - $this->payerId = $payerId; - } - - /** - * 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 Phone. - * The phone information. - */ - public function getPhone(): ?PhoneWithType - { - return $this->phone; - } - - /** - * Sets Phone. - * The phone information. - * - * @maps phone - */ - public function setPhone(?PhoneWithType $phone): void - { - $this->phone = $phone; - } - - /** - * Returns 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 getAddress(): ?Address - { - return $this->address; - } - - /** - * Sets 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). - * - * @maps address - */ - public function setAddress(?Address $address): void - { - $this->address = $address; - } - - /** - * Returns User Name. - * The Venmo username, as chosen by the user. - */ - public function getUserName(): ?string - { - return $this->userName; - } - - /** - * Sets User Name. - * The Venmo username, as chosen by the user. - * - * @maps user_name - */ - public function setUserName(?string $userName): void - { - $this->userName = $userName; - } - - /** - * 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->description)) { - $json['description'] = $this->description; - } - if (isset($this->shipping)) { - $json['shipping'] = $this->shipping; - } - if (isset($this->permitMultiplePaymentTokens)) { - $json['permit_multiple_payment_tokens'] = $this->permitMultiplePaymentTokens; - } - if (isset($this->usageType)) { - $json['usage_type'] = $this->usageType; - } - if (isset($this->customerType)) { - $json['customer_type'] = $this->customerType; - } - if (isset($this->emailAddress)) { - $json['email_address'] = $this->emailAddress; - } - if (isset($this->payerId)) { - $json['payer_id'] = $this->payerId; - } - if (isset($this->name)) { - $json['name'] = $this->name; - } - if (isset($this->phone)) { - $json['phone'] = $this->phone; - } - if (isset($this->address)) { - $json['address'] = $this->address; - } - if (isset($this->userName)) { - $json['user_name'] = $this->userName; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/VenmoPaymentTokenCustomerType.php b/src/Models/VenmoPaymentTokenCustomerType.php deleted file mode 100644 index c25c8a6..0000000 --- a/src/Models/VenmoPaymentTokenCustomerType.php +++ /dev/null @@ -1,46 +0,0 @@ -customer; - } - - /** - * Sets Customer. - * The details about a customer in PayPal's system of record. - * - * @maps customer - */ - public function setCustomer(?VenmoWalletCustomerInformation $customer): void - { - $this->customer = $customer; - } - - /** - * Returns Vault. - * Resource consolidating common request and response attirbutes for vaulting Venmo Wallet. - */ - public function getVault(): ?VenmoWalletVaultAttributes - { - return $this->vault; - } - - /** - * Sets Vault. - * Resource consolidating common request and response attirbutes for vaulting Venmo Wallet. - * - * @maps vault - */ - public function setVault(?VenmoWalletVaultAttributes $vault): void - { - $this->vault = $vault; - } - - /** - * 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; - } - if (isset($this->vault)) { - $json['vault'] = $this->vault; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/VenmoWalletAttributesResponse.php b/src/Models/VenmoWalletAttributesResponse.php deleted file mode 100644 index 56261c0..0000000 --- a/src/Models/VenmoWalletAttributesResponse.php +++ /dev/null @@ -1,63 +0,0 @@ -vault; - } - - /** - * Sets Vault. - * The details about a saved payment source. - * - * @maps vault - */ - public function setVault(?VaultResponse $vault): void - { - $this->vault = $vault; - } - - /** - * 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->vault)) { - $json['vault'] = $this->vault; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/VenmoWalletCustomerInformation.php b/src/Models/VenmoWalletCustomerInformation.php deleted file mode 100644 index 6bcb422..0000000 --- a/src/Models/VenmoWalletCustomerInformation.php +++ /dev/null @@ -1,97 +0,0 @@ -id; - } - - /** - * Sets Id. - * The unique ID for a customer generated by PayPal. - * - * @maps id - */ - public function setId(?string $id): void - { - $this->id = $id; - } - - /** - * 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; - } - - /** - * 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->emailAddress)) { - $json['email_address'] = $this->emailAddress; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/VenmoWalletExperienceContext.php b/src/Models/VenmoWalletExperienceContext.php deleted file mode 100644 index 2c25671..0000000 --- a/src/Models/VenmoWalletExperienceContext.php +++ /dev/null @@ -1,94 +0,0 @@ -Note: Partners and Marketplaces might configure - * shipping_preference during partner account setup, which overrides the request values. - * - */ -class VenmoWalletExperienceContext implements \JsonSerializable -{ - /** - * @var string|null - */ - private $brandName; - - /** - * @var string|null - */ - private $shippingPreference = ShippingPreference::GET_FROM_FILE; - - /** - * Returns Brand Name. - * The business name of the merchant. The pattern is defined by an external party and supports Unicode. - */ - public function getBrandName(): ?string - { - return $this->brandName; - } - - /** - * Sets Brand Name. - * The business name of the merchant. The pattern is defined by an external party and supports Unicode. - * - * @maps brand_name - */ - public function setBrandName(?string $brandName): void - { - $this->brandName = $brandName; - } - - /** - * Returns Shipping Preference. - * The location from which the shipping address is derived. - */ - public function getShippingPreference(): ?string - { - return $this->shippingPreference; - } - - /** - * Sets Shipping Preference. - * The location from which the shipping address is derived. - * - * @maps shipping_preference - */ - public function setShippingPreference(?string $shippingPreference): void - { - $this->shippingPreference = $shippingPreference; - } - - /** - * 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->brandName)) { - $json['brand_name'] = $this->brandName; - } - if (isset($this->shippingPreference)) { - $json['shipping_preference'] = ShippingPreference::checkValue($this->shippingPreference); - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/VenmoWalletRequest.php b/src/Models/VenmoWalletRequest.php deleted file mode 100644 index bf850fb..0000000 --- a/src/Models/VenmoWalletRequest.php +++ /dev/null @@ -1,161 +0,0 @@ -vaultId; - } - - /** - * Sets Vault Id. - * The PayPal-generated ID for the vaulted payment source. This ID should be stored on the merchant's - * server so the saved payment source can be used for future transactions. - * - * @maps vault_id - */ - public function setVaultId(?string $vaultId): void - { - $this->vaultId = $vaultId; - } - - /** - * 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 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. - *
    - */ - public function getExperienceContext(): ?VenmoWalletExperienceContext - { - return $this->experienceContext; - } - - /** - * 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. - *
    - * - * @maps experience_context - */ - public function setExperienceContext(?VenmoWalletExperienceContext $experienceContext): void - { - $this->experienceContext = $experienceContext; - } - - /** - * Returns Attributes. - * Additional attributes associated with the use of this Venmo Wallet. - */ - public function getAttributes(): ?VenmoWalletAdditionalAttributes - { - return $this->attributes; - } - - /** - * Sets Attributes. - * Additional attributes associated with the use of this Venmo Wallet. - * - * @maps attributes - */ - public function setAttributes(?VenmoWalletAdditionalAttributes $attributes): void - { - $this->attributes = $attributes; - } - - /** - * 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->vaultId)) { - $json['vault_id'] = $this->vaultId; - } - if (isset($this->emailAddress)) { - $json['email_address'] = $this->emailAddress; - } - if (isset($this->experienceContext)) { - $json['experience_context'] = $this->experienceContext; - } - if (isset($this->attributes)) { - $json['attributes'] = $this->attributes; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/VenmoWalletResponse.php b/src/Models/VenmoWalletResponse.php deleted file mode 100644 index 77f5e0a..0000000 --- a/src/Models/VenmoWalletResponse.php +++ /dev/null @@ -1,249 +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 @ 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 Account Id. - * The PayPal payer ID, which is a masked version of the PayPal account number intended for use with - * third parties. The account number is reversibly encrypted and a proprietary variant of Base32 is - * used to encode the result. - */ - public function getAccountId(): ?string - { - return $this->accountId; - } - - /** - * Sets Account Id. - * The PayPal payer ID, which is a masked version of the PayPal account number intended for use with - * third parties. The account number is reversibly encrypted and a proprietary variant of Base32 is - * used to encode the result. - * - * @maps account_id - */ - public function setAccountId(?string $accountId): void - { - $this->accountId = $accountId; - } - - /** - * Returns User Name. - * The Venmo user name chosen by the user, also know as a Venmo handle. - */ - public function getUserName(): ?string - { - return $this->userName; - } - - /** - * Sets User Name. - * The Venmo user name chosen by the user, also know as a Venmo handle. - * - * @maps user_name - */ - public function setUserName(?string $userName): void - { - $this->userName = $userName; - } - - /** - * 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 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(): ?PhoneNumber - { - 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(?PhoneNumber $phoneNumber): void - { - $this->phoneNumber = $phoneNumber; - } - - /** - * Returns 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 getAddress(): ?Address - { - return $this->address; - } - - /** - * Sets 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). - * - * @maps address - */ - public function setAddress(?Address $address): void - { - $this->address = $address; - } - - /** - * Returns Attributes. - * Additional attributes associated with the use of a Venmo Wallet. - */ - public function getAttributes(): ?VenmoWalletAttributesResponse - { - return $this->attributes; - } - - /** - * Sets Attributes. - * Additional attributes associated with the use of a Venmo Wallet. - * - * @maps attributes - */ - public function setAttributes(?VenmoWalletAttributesResponse $attributes): void - { - $this->attributes = $attributes; - } - - /** - * 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->accountId)) { - $json['account_id'] = $this->accountId; - } - if (isset($this->userName)) { - $json['user_name'] = $this->userName; - } - if (isset($this->name)) { - $json['name'] = $this->name; - } - if (isset($this->phoneNumber)) { - $json['phone_number'] = $this->phoneNumber; - } - if (isset($this->address)) { - $json['address'] = $this->address; - } - if (isset($this->attributes)) { - $json['attributes'] = $this->attributes; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/VenmoWalletVaultAttributes.php b/src/Models/VenmoWalletVaultAttributes.php deleted file mode 100644 index 931ddc0..0000000 --- a/src/Models/VenmoWalletVaultAttributes.php +++ /dev/null @@ -1,223 +0,0 @@ -storeInVault = $storeInVault; - $this->usageType = $usageType; - } - - /** - * Returns Store in Vault. - * Defines how and when the payment source gets vaulted. - */ - public function getStoreInVault(): string - { - return $this->storeInVault; - } - - /** - * Sets Store in Vault. - * Defines how and when the payment source gets vaulted. - * - * @required - * @maps store_in_vault - */ - public function setStoreInVault(string $storeInVault): void - { - $this->storeInVault = $storeInVault; - } - - /** - * Returns Description. - * The description displayed to Venmo consumer on the approval flow for Venmo, as well as on the Venmo - * payment token management experience on Venmo.com. - */ - public function getDescription(): ?string - { - return $this->description; - } - - /** - * Sets Description. - * The description displayed to Venmo consumer on the approval flow for Venmo, as well as on the Venmo - * payment token management experience on Venmo.com. - * - * @maps description - */ - public function setDescription(?string $description): void - { - $this->description = $description; - } - - /** - * 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 Type. - * The usage type associated with the Venmo payment token. - */ - public function getUsageType(): string - { - return $this->usageType; - } - - /** - * Sets Usage Type. - * The usage type associated with the Venmo payment token. - * - * @required - * @maps usage_type - */ - public function setUsageType(string $usageType): void - { - $this->usageType = $usageType; - } - - /** - * Returns Customer Type. - * 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. - */ - public function getCustomerType(): ?string - { - return $this->customerType; - } - - /** - * Sets Customer Type. - * 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. - * - * @maps customer_type - */ - public function setCustomerType(?string $customerType): void - { - $this->customerType = $customerType; - } - - /** - * Returns Permit Multiple Payment Tokens. - * Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the - * customer has not logged in at merchant/platform. The payment token thus generated, can then also be - * used to create the customer account at merchant/platform. Use this also when multiple payment tokens - * are required for the same payer, different customer at merchant/platform. This helps to identify - * customers distinctly even though they may share the same Venmo account. - */ - public function getPermitMultiplePaymentTokens(): ?bool - { - return $this->permitMultiplePaymentTokens; - } - - /** - * Sets Permit Multiple Payment Tokens. - * Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the - * customer has not logged in at merchant/platform. The payment token thus generated, can then also be - * used to create the customer account at merchant/platform. Use this also when multiple payment tokens - * are required for the same payer, different customer at merchant/platform. This helps to identify - * customers distinctly even though they may share the same Venmo account. - * - * @maps permit_multiple_payment_tokens - */ - public function setPermitMultiplePaymentTokens(?bool $permitMultiplePaymentTokens): void - { - $this->permitMultiplePaymentTokens = $permitMultiplePaymentTokens; - } - - /** - * 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['store_in_vault'] = StoreInVaultInstruction::checkValue($this->storeInVault); - if (isset($this->description)) { - $json['description'] = $this->description; - } - if (isset($this->usagePattern)) { - $json['usage_pattern'] = VenmoPaymentTokenUsagePattern::checkValue($this->usagePattern); - } - $json['usage_type'] = VenmoPaymentTokenUsageType::checkValue($this->usageType); - if (isset($this->customerType)) { - $json['customer_type'] = VenmoPaymentTokenCustomerType::checkValue($this->customerType); - } - if (isset($this->permitMultiplePaymentTokens)) { - $json['permit_multiple_payment_tokens'] = $this->permitMultiplePaymentTokens; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/PayPalRESTAPIsClient.php b/src/PayPalRESTAPIsClient.php deleted file mode 100644 index f28fbb0..0000000 --- a/src/PayPalRESTAPIsClient.php +++ /dev/null @@ -1,283 +0,0 @@ -config = array_merge(ConfigurationDefaults::_ALL, CoreHelper::clone($config)); - $this->clientCredentialsAuthManager = new ClientCredentialsAuthManager($this->config); - $loggingConfiguration = null; - if ($this->config['loggingConfiguration'] instanceof LoggingConfigurationBuilder) { - $this->loggingConfigurationBuilder = $this->config['loggingConfiguration']; - $loggingConfiguration = $this->loggingConfigurationBuilder->build(); - } - $this->client = ClientBuilder::init(new HttpClient(Configuration::init($this))) - ->converter(new CompatibilityConverter()) - ->jsonHelper(ApiHelper::getJsonHelper()) - ->apiCallback($this->config['httpCallback'] ?? null) - ->userAgent('PayPal REST API PHP SDK, Version: 2.16.0, on OS {os-info}') - ->serverUrls(self::ENVIRONMENT_MAP[$this->getEnvironment()], Server::DEFAULT_) - ->authManagers(['Oauth2' => $this->clientCredentialsAuthManager]) - ->loggingConfiguration($loggingConfiguration) - ->build(); - $this->clientCredentialsAuthManager->setClient($this->client); - } - - /** - * Create a builder with the current client's configurations. - * - * @return PayPalRESTAPIsClientBuilder PayPalRESTAPIsClientBuilder instance - */ - public function toBuilder(): PayPalRESTAPIsClientBuilder - { - $builder = PayPalRESTAPIsClientBuilder::init() - ->timeout($this->getTimeout()) - ->enableRetries($this->shouldEnableRetries()) - ->numberOfRetries($this->getNumberOfRetries()) - ->retryInterval($this->getRetryInterval()) - ->backOffFactor($this->getBackOffFactor()) - ->maximumRetryWaitTime($this->getMaximumRetryWaitTime()) - ->retryOnTimeout($this->shouldRetryOnTimeout()) - ->httpStatusCodesToRetry($this->getHttpStatusCodesToRetry()) - ->httpMethodsToRetry($this->getHttpMethodsToRetry()) - ->environment($this->getEnvironment()) - ->httpCallback($this->config['httpCallback'] ?? null); - - $clientCredentialsAuth = $this->getClientCredentialsAuthCredentialsBuilder(); - if ($clientCredentialsAuth != null) { - $builder->clientCredentialsAuthCredentials($clientCredentialsAuth); - } - $loggingConfigurationBuilder = $this->getLoggingConfigurationBuilder(); - if ($loggingConfigurationBuilder != null) { - $builder->loggingConfiguration($loggingConfigurationBuilder); - } - return $builder; - } - - public function getTimeout(): int - { - return $this->config['timeout'] ?? ConfigurationDefaults::TIMEOUT; - } - - public function shouldEnableRetries(): bool - { - return $this->config['enableRetries'] ?? ConfigurationDefaults::ENABLE_RETRIES; - } - - public function getNumberOfRetries(): int - { - return $this->config['numberOfRetries'] ?? ConfigurationDefaults::NUMBER_OF_RETRIES; - } - - public function getRetryInterval(): float - { - return $this->config['retryInterval'] ?? ConfigurationDefaults::RETRY_INTERVAL; - } - - public function getBackOffFactor(): float - { - return $this->config['backOffFactor'] ?? ConfigurationDefaults::BACK_OFF_FACTOR; - } - - public function getMaximumRetryWaitTime(): int - { - return $this->config['maximumRetryWaitTime'] ?? ConfigurationDefaults::MAXIMUM_RETRY_WAIT_TIME; - } - - public function shouldRetryOnTimeout(): bool - { - return $this->config['retryOnTimeout'] ?? ConfigurationDefaults::RETRY_ON_TIMEOUT; - } - - public function getHttpStatusCodesToRetry(): array - { - return $this->config['httpStatusCodesToRetry'] ?? ConfigurationDefaults::HTTP_STATUS_CODES_TO_RETRY; - } - - public function getHttpMethodsToRetry(): array - { - return $this->config['httpMethodsToRetry'] ?? ConfigurationDefaults::HTTP_METHODS_TO_RETRY; - } - - public function getEnvironment(): string - { - return $this->config['environment'] ?? ConfigurationDefaults::ENVIRONMENT; - } - - public function getClientCredentialsAuth(): ClientCredentialsAuth - { - return $this->clientCredentialsAuthManager; - } - - public function getClientCredentialsAuthCredentialsBuilder(): ?ClientCredentialsAuthCredentialsBuilder - { - if ( - empty($this->clientCredentialsAuthManager->getOAuthClientId()) && - empty($this->clientCredentialsAuthManager->getOAuthClientSecret()) - ) { - return null; - } - return ClientCredentialsAuthCredentialsBuilder::init( - $this->clientCredentialsAuthManager->getOAuthClientId(), - $this->clientCredentialsAuthManager->getOAuthClientSecret() - )->oAuthToken($this->clientCredentialsAuthManager->getOAuthToken()); - } - - public function getLoggingConfigurationBuilder(): ?LoggingConfigurationBuilder - { - if (is_null($this->loggingConfigurationBuilder)) { - return null; - } - $config = $this->loggingConfigurationBuilder->getConfiguration(); - return LoggingConfigurationBuilder::init() - ->level($config['level']) - ->logger($config['logger']) - ->maskSensitiveHeaders($config['maskSensitiveHeaders']) - ->requestConfiguration(RequestLoggingConfigurationBuilder::init() - ->includeQueryInPath($config['requestConfiguration']['includeQueryInPath']) - ->body($config['requestConfiguration']['body']) - ->headers($config['requestConfiguration']['headers']) - ->includeHeaders(...$config['requestConfiguration']['includeHeaders']) - ->excludeHeaders(...$config['requestConfiguration']['excludeHeaders']) - ->unmaskHeaders(...$config['requestConfiguration']['unmaskHeaders'])) - ->responseConfiguration(ResponseLoggingConfigurationBuilder::init() - ->body($config['responseConfiguration']['body']) - ->headers($config['responseConfiguration']['headers']) - ->includeHeaders(...$config['responseConfiguration']['includeHeaders']) - ->excludeHeaders(...$config['responseConfiguration']['excludeHeaders']) - ->unmaskHeaders(...$config['responseConfiguration']['unmaskHeaders'])); - } - - /** - * Get the client configuration as an associative array - * - * @see PayPalRESTAPIsClientBuilder::getConfiguration() - */ - public function getConfiguration(): array - { - return $this->toBuilder()->getConfiguration(); - } - - /** - * Clone this client and override given configuration options - * - * @see PayPalRESTAPIsClientBuilder::build() - */ - public function withConfiguration(array $config): self - { - return new self(array_merge($this->config, $config)); - } - - /** - * Get the base uri for a given server in the current environment. - * - * @param string $server Server name - * - * @return string Base URI - */ - public function getBaseUri(string $server = Server::DEFAULT_): string - { - return $this->client->getGlobalRequest($server)->getQueryUrl(); - } - - /** - * Returns Orders Controller - */ - public function getOrdersController(): OrdersController - { - if ($this->orders == null) { - $this->orders = new OrdersController($this->client); - } - return $this->orders; - } - - /** - * Returns Payments Controller - */ - public function getPaymentsController(): PaymentsController - { - if ($this->payments == null) { - $this->payments = new PaymentsController($this->client); - } - return $this->payments; - } - - /** - * Returns Vault Controller - */ - public function getVaultController(): VaultController - { - if ($this->vault == null) { - $this->vault = new VaultController($this->client); - } - return $this->vault; - } - - /** - * Returns O Auth Authorization Controller - */ - public function getOAuthAuthorizationController(): OAuthAuthorizationController - { - if ($this->oAuthAuthorization == null) { - $this->oAuthAuthorization = new OAuthAuthorizationController($this->client); - } - return $this->oAuthAuthorization; - } - - /** - * A map of all base urls used in different environments and servers - * - * @var array - */ - private const ENVIRONMENT_MAP = [ - Environment::PRODUCTION => [Server::DEFAULT_ => 'https://api-m.paypal.com'], - Environment::SANDBOX => [Server::DEFAULT_ => 'https://api-m.sandbox.paypal.com'] - ]; -} diff --git a/src/PayPalRESTAPIsClientBuilder.php b/src/PayPalRESTAPIsClientBuilder.php deleted file mode 100644 index 0f9cbed..0000000 --- a/src/PayPalRESTAPIsClientBuilder.php +++ /dev/null @@ -1,187 +0,0 @@ -config); - } - - public function timeout(int $timeout): self - { - $this->config['timeout'] = $timeout; - return $this; - } - - public function enableRetries(bool $enableRetries): self - { - $this->config['enableRetries'] = $enableRetries; - return $this; - } - - public function numberOfRetries(int $numberOfRetries): self - { - $this->config['numberOfRetries'] = $numberOfRetries; - return $this; - } - - public function retryInterval(float $retryInterval): self - { - $this->config['retryInterval'] = $retryInterval; - return $this; - } - - public function backOffFactor(float $backOffFactor): self - { - $this->config['backOffFactor'] = $backOffFactor; - return $this; - } - - public function maximumRetryWaitTime(int $maximumRetryWaitTime): self - { - $this->config['maximumRetryWaitTime'] = $maximumRetryWaitTime; - return $this; - } - - public function retryOnTimeout(bool $retryOnTimeout): self - { - $this->config['retryOnTimeout'] = $retryOnTimeout; - return $this; - } - - /** - * @param int[] $httpStatusCodesToRetry - * - * @return $this - */ - public function httpStatusCodesToRetry(array $httpStatusCodesToRetry): self - { - $this->config['httpStatusCodesToRetry'] = $httpStatusCodesToRetry; - return $this; - } - - /** - * @param string[] $httpMethodsToRetry - * - * @return $this - */ - public function httpMethodsToRetry(array $httpMethodsToRetry): self - { - $this->config['httpMethodsToRetry'] = $httpMethodsToRetry; - return $this; - } - - public function environment(string $environment): self - { - $this->config['environment'] = $environment; - return $this; - } - - /** - * @see PayPalRESTAPIsClientBuilder::clientCredentialsAuthCredentials - * - * @deprecated This builder setter is deprecated. Checkout the see also section for its - * alternate. - * - * @param string $oAuthClientId - * - * @return $this - */ - public function oAuthClientId(string $oAuthClientId): self - { - $this->config['oAuthClientId'] = $oAuthClientId; - return $this; - } - - /** - * @see PayPalRESTAPIsClientBuilder::clientCredentialsAuthCredentials - * - * @deprecated This builder setter is deprecated. Checkout the see also section for its - * alternate. - * - * @param string $oAuthClientSecret - * - * @return $this - */ - public function oAuthClientSecret(string $oAuthClientSecret): self - { - $this->config['oAuthClientSecret'] = $oAuthClientSecret; - return $this; - } - - /** - * @see PayPalRESTAPIsClientBuilder::clientCredentialsAuthCredentials - * - * @deprecated This builder setter is deprecated. Checkout the see also section for its - * alternate. - * - * @param OAuthToken|null $oAuthToken - * - * @return $this - */ - public function oAuthToken(?OAuthToken $oAuthToken): self - { - $this->config['oAuthToken'] = $oAuthToken; - return $this; - } - - public function clientCredentialsAuthCredentials( - ClientCredentialsAuthCredentialsBuilder $clientCredentialsAuth - ): self { - $this->config = array_merge($this->config, $clientCredentialsAuth->getConfiguration()); - return $this; - } - - public function httpCallback($httpCallback): self - { - if (!$httpCallback instanceof CoreCallback) { - return $this; - } - $this->config['httpCallback'] = $httpCallback; - return $this; - } - - public function loggingConfiguration(LoggingConfigurationBuilder $loggingConfiguration): self - { - $this->config['loggingConfiguration'] = $loggingConfiguration; - return $this; - } - - public function build(): PayPalRESTAPIsClient - { - return new PayPalRESTAPIsClient($this->config); - } -} diff --git a/src/Server.php b/src/Server.php deleted file mode 100644 index 18698cd..0000000 --- a/src/Server.php +++ /dev/null @@ -1,19 +0,0 @@ -createHttpResponse($response); - return new ApiException($message, $this->createHttpRequest($request), $response); - } - - public function createHttpContext(ContextInterface $context): HttpContext - { - return new HttpContext( - $this->createHttpRequest($context->getRequest()), - $this->createHttpResponse($context->getResponse()) - ); - } - - public function createHttpRequest(RequestInterface $request): HttpRequest - { - return new HttpRequest( - $request->getHttpMethod(), - $request->getHeaders(), - $request->getQueryUrl(), - $request->getParameters() - ); - } - - public function createHttpResponse(ResponseInterface $response): HttpResponse - { - return new HttpResponse($response->getStatusCode(), $response->getHeaders(), $response->getRawBody()); - } - - public function createApiResponse(ContextInterface $context, $deserializedBody): ApiResponse - { - return ApiResponse::createFromContext( - $context->getResponse()->getBody(), - $deserializedBody, - $this->createHttpContext($context) - ); - } - - public function createFileWrapper(string $realFilePath, ?string $mimeType, ?string $filename) - { - return null; - } -}