\"/purchase_units/@reference_id=='default'/{attribute-or-object}\". Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout.Note: For error handling and troubleshooting, see Orders v2 errors.Patchable attributes or objects:
| Attribute | Op | Notes |
|---|---|---|
intent | replace | |
payer | replace, add | Using replace op for payer will replace the whole payer object with the value sent in request. |
purchase_units | replace, add | |
purchase_units[].custom_id | replace, add, remove | |
purchase_units[].description | replace, add, remove | |
purchase_units[].payee.email | replace | |
purchase_units[].shipping.name | replace, add | |
purchase_units[].shipping.email_address | replace, add | |
purchase_units[].shipping.phone_number | replace, add | |
purchase_units[].shipping.options | replace, add | |
purchase_units[].shipping.address | replace, add | |
purchase_units[].shipping.type | replace, add | |
purchase_units[].soft_descriptor | replace, remove | |
purchase_units[].amount | replace | |
purchase_units[].items | replace, add, remove | |
purchase_units[].invoice_id | replace, add, remove | |
purchase_units[].payment_instruction | replace | |
purchase_units[].payment_instruction.disbursement_mode | replace | By default, disbursement_mode is INSTANT. |
purchase_units[].payment_instruction.payee_receivable_fx_rate_id | replace, add, remove | |
purchase_units[].payment_instruction.platform_fees | replace, add, remove | |
purchase_units[].supplementary_data.airline | replace, add, remove | |
purchase_units[].supplementary_data.card | replace, add, remove | |
application_context.client_configuration | replace, add |
\"/purchase_units/@reference_id=='default'/{attribute-or-object}\". Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout.Note: For error handling and troubleshooting, see Orders v2 errors.Patchable attributes or objects:
| Attribute | Op | Notes |
|---|---|---|
intent | replace | |
payer | replace, add | Using replace op for payer will replace the whole payer object with the value sent in request. |
purchase_units | replace, add | |
purchase_units[].custom_id | replace, add, remove | |
purchase_units[].description | replace, add, remove | |
purchase_units[].payee.email | replace | |
purchase_units[].shipping.name | replace, add | |
purchase_units[].shipping.email_address | replace, add | |
purchase_units[].shipping.phone_number | replace, add | |
purchase_units[].shipping.options | replace, add | |
purchase_units[].shipping.address | replace, add | |
purchase_units[].shipping.type | replace, add | |
purchase_units[].soft_descriptor | replace, remove | |
purchase_units[].amount | replace | |
purchase_units[].items | replace, add, remove | |
purchase_units[].invoice_id | replace, add, remove | |
purchase_units[].payment_instruction | replace | |
purchase_units[].payment_instruction.disbursement_mode | replace | By default, disbursement_mode is INSTANT. |
purchase_units[].payment_instruction.payee_receivable_fx_rate_id | replace, add, remove | |
purchase_units[].payment_instruction.platform_fees | replace, add, remove | |
purchase_units[].supplementary_data.airline | replace, add, remove | |
purchase_units[].supplementary_data.card | replace, add, remove | |
application_context.client_configuration | replace, add |
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: Up to 64 characters are + * allowed before and 255 characters are allowed after the*/ public function getEmailAddress(): ?string { @@ -227,9 +231,10 @@ class PaypalPaymentToken implements \JsonSerializable /** * 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. + * The internationalized email address.@sign. However, the generally + * accepted maximum length for an email address is 254 characters. The pattern verifies that an + * unquoted@sign exists.
Note: Up to 64 characters are + * allowed before and 255 characters are allowed after the* * @maps email_address */ diff --git a/src/Models/PaypalReferenceIdType.php b/src/Models/PaypalReferenceIdType.php new file mode 100644 index 0000000..fe26d18 --- /dev/null +++ b/src/Models/PaypalReferenceIdType.php @@ -0,0 +1,37 @@ +cancelUrl = $cancelUrl; } + /** + * Returns App Switch Context. + * Merchant provided details of the native app or mobile web browser to facilitate buyer's app switch + * to the PayPal consumer app. + */ + public function getAppSwitchContext(): ?AppSwitchContext + { + return $this->appSwitchContext; + } + + /** + * Sets App Switch Context. + * Merchant provided details of the native app or mobile web browser to facilitate buyer's app switch + * to the PayPal consumer app. + * + * @maps app_switch_context + */ + public function setAppSwitchContext(?AppSwitchContext $appSwitchContext): void + { + $this->appSwitchContext = $appSwitchContext; + } + /** * Returns Landing Page. * The type of landing page to show on the PayPal site for customer checkout. @@ -300,6 +327,7 @@ class PaypalWalletExperienceContext implements \JsonSerializable 'contactPreference' => $this->contactPreference, 'returnUrl' => $this->returnUrl, 'cancelUrl' => $this->cancelUrl, + 'appSwitchContext' => $this->appSwitchContext, 'landingPage' => $this->landingPage, 'userAction' => $this->userAction, 'paymentMethodPreference' => $this->paymentMethodPreference, @@ -338,6 +366,9 @@ class PaypalWalletExperienceContext implements \JsonSerializable if (isset($this->cancelUrl)) { $json['cancel_url'] = $this->cancelUrl; } + if (isset($this->appSwitchContext)) { + $json['app_switch_context'] = $this->appSwitchContext; + } if (isset($this->landingPage)) { $json['landing_page'] = $this->landingPage; } diff --git a/src/Models/PaypalWalletResponse.php b/src/Models/PaypalWalletResponse.php index 7d3e76a..634d1df 100644 --- a/src/Models/PaypalWalletResponse.php +++ b/src/Models/PaypalWalletResponse.php @@ -78,6 +78,11 @@ class PaypalWalletResponse implements \JsonSerializable */ private $storedCredential; + /** + * @var string|null + */ + private $experienceStatus; + /** * Returns Email Address. * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters @@ -348,6 +353,28 @@ class PaypalWalletResponse implements \JsonSerializable $this->storedCredential = $storedCredential; } + /** + * Returns Experience Status. + * This field indicates the status of PayPal's Checkout experience throughout the order lifecycle. The + * values reflect the current stage of the checkout process. + */ + public function getExperienceStatus(): ?string + { + return $this->experienceStatus; + } + + /** + * Sets Experience Status. + * This field indicates the status of PayPal's Checkout experience throughout the order lifecycle. The + * values reflect the current stage of the checkout process. + * + * @maps experience_status + */ + public function setExperienceStatus(?string $experienceStatus): void + { + $this->experienceStatus = $experienceStatus; + } + /** * Converts the PaypalWalletResponse object to a human-readable string representation. * @@ -369,7 +396,8 @@ class PaypalWalletResponse implements \JsonSerializable 'taxInfo' => $this->taxInfo, 'address' => $this->address, 'attributes' => $this->attributes, - 'storedCredential' => $this->storedCredential + 'storedCredential' => $this->storedCredential, + 'experienceStatus' => $this->experienceStatus ] ); } @@ -422,6 +450,9 @@ class PaypalWalletResponse implements \JsonSerializable if (isset($this->storedCredential)) { $json['stored_credential'] = $this->storedCredential; } + if (isset($this->experienceStatus)) { + $json['experience_status'] = $this->experienceStatus; + } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; } diff --git a/src/Models/PaypalWalletStoredCredential.php b/src/Models/PaypalWalletStoredCredential.php index 2cd172b..04cbb63 100644 --- a/src/Models/PaypalWalletStoredCredential.php +++ b/src/Models/PaypalWalletStoredCredential.php @@ -70,7 +70,8 @@ class PaypalWalletStoredCredential implements \JsonSerializable /** * Returns Charge Pattern. - * Expected business/pricing model for the billing agreement. + * DEPRECATED. Expected business/pricing model for the billing agreement, Please use usage_pattern + * instead. */ public function getChargePattern(): ?string { @@ -79,7 +80,8 @@ class PaypalWalletStoredCredential implements \JsonSerializable /** * Sets Charge Pattern. - * Expected business/pricing model for the billing agreement. + * DEPRECATED. Expected business/pricing model for the billing agreement, Please use usage_pattern + * instead. * * @maps charge_pattern */ diff --git a/src/Models/PaypalWalletVaultInstruction.php b/src/Models/PaypalWalletVaultInstruction.php index ae2681a..1bb1c43 100644 --- a/src/Models/PaypalWalletVaultInstruction.php +++ b/src/Models/PaypalWalletVaultInstruction.php @@ -13,13 +13,11 @@ namespace PaypalServerSdkLib\Models; use PaypalServerSdkLib\ApiHelper; use stdClass; +/** + * Resource consolidating common request and response attributes for vaulting PayPal Wallet. + */ class PaypalWalletVaultInstruction implements \JsonSerializable { - /** - * @var string|null - */ - private $storeInVault; - /** * @var string|null */ @@ -53,26 +51,6 @@ class PaypalWalletVaultInstruction implements \JsonSerializable $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. - * - * @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 @@ -198,7 +176,6 @@ class PaypalWalletVaultInstruction implements \JsonSerializable return ApiHelper::stringify( 'PaypalWalletVaultInstruction', [ - 'storeInVault' => $this->storeInVault, 'description' => $this->description, 'usagePattern' => $this->usagePattern, 'usageType' => $this->usageType, @@ -220,9 +197,6 @@ class PaypalWalletVaultInstruction implements \JsonSerializable public function jsonSerialize(bool $asArrayWhenEmpty = false) { $json = []; - if (isset($this->storeInVault)) { - $json['store_in_vault'] = $this->storeInVault; - } if (isset($this->description)) { $json['description'] = $this->description; } diff --git a/src/Models/PhoneNumber.php b/src/Models/PhoneNumber.php index 165d336..5acda65 100644 --- a/src/Models/PhoneNumber.php +++ b/src/Models/PhoneNumber.php @@ -15,7 +15,8 @@ use stdClass; /** * The phone number in its canonical international [E.164 numbering plan format](https://www.itu. - * int/rec/T-REC-E.164/en). + * int/rec/T-REC-E.164/en)., The phone number, in its canonical international [E.164 numbering plan + * format](https://www.itu.int/rec/T-REC-E.164/en). */ class PhoneNumber implements \JsonSerializable { diff --git a/src/Models/PhoneNumberWithCountryCode.php b/src/Models/PhoneNumberWithCountryCode.php index f5b76b3..176aa8b 100644 --- a/src/Models/PhoneNumberWithCountryCode.php +++ b/src/Models/PhoneNumberWithCountryCode.php @@ -16,7 +16,8 @@ use stdClass; /** * The phone number in its canonical international [E.164 numbering plan format](https://www.itu. * int/rec/T-REC-E.164/en)., The phone number, in its canonical international [E.164 numbering plan - * format](https://www.itu.int/rec/T-REC-E.164/en). + * format](https://www.itu.int/rec/T-REC-E.164/en)., The phone number, in its canonical international + * [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). */ class PhoneNumberWithCountryCode implements \JsonSerializable { diff --git a/src/Models/PhoneNumberWithOptionalCountryCode.php b/src/Models/PhoneNumberWithOptionalCountryCode.php new file mode 100644 index 0000000..0775a64 --- /dev/null +++ b/src/Models/PhoneNumberWithOptionalCountryCode.php @@ -0,0 +1,125 @@ +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). + * + * @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; + } + + /** + * Converts the PhoneNumberWithOptionalCountryCode object to a human-readable string representation. + * + * @return string The string representation of the PhoneNumberWithOptionalCountryCode object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PhoneNumberWithOptionalCountryCode', + ['countryCode' => $this->countryCode, 'nationalNumber' => $this->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 = []; + if (isset($this->countryCode)) { + $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 index 851dad8..0ce7b66 100644 --- a/src/Models/PhoneType.php +++ b/src/Models/PhoneType.php @@ -15,13 +15,28 @@ namespace PaypalServerSdkLib\Models; */ class PhoneType { + /** + * Fax number. + */ public const FAX = 'FAX'; + /** + * Home phone number. + */ public const HOME = 'HOME'; + /** + * Mobile phone number. + */ public const MOBILE = 'MOBILE'; + /** + * Other phone number. + */ public const OTHER = 'OTHER'; + /** + * Pager number. + */ public const PAGER = 'PAGER'; } diff --git a/src/Models/Plan.php b/src/Models/Plan.php index 2091380..2ea2c8e 100644 --- a/src/Models/Plan.php +++ b/src/Models/Plan.php @@ -23,11 +23,6 @@ class Plan implements \JsonSerializable */ private $billingCycles; - /** - * @var mixed - */ - private $product; - /** * @var OneTimeCharge */ @@ -75,30 +70,6 @@ class Plan implements \JsonSerializable $this->billingCycles = $billingCycles; } - /** - * Returns Product. - * Product details associated with any one-time product purchase. - * - * @return mixed - */ - public function getProduct() - { - return $this->product; - } - - /** - * Sets Product. - * Product details associated with any one-time product purchase. - * - * @maps product - * - * @param mixed $product - */ - public function setProduct($product): void - { - $this->product = $product; - } - /** * Returns One Time Charges. * The one-time charge info at the time of checkout. @@ -151,7 +122,6 @@ class Plan implements \JsonSerializable 'Plan', [ 'billingCycles' => $this->billingCycles, - 'product' => $this->product, 'oneTimeCharges' => $this->oneTimeCharges, 'name' => $this->name ] @@ -171,9 +141,6 @@ class Plan implements \JsonSerializable { $json = []; $json['billing_cycles'] = $this->billingCycles; - if (isset($this->product)) { - $json['product'] = $this->product; - } $json['one_time_charges'] = $this->oneTimeCharges; if (isset($this->name)) { $json['name'] = $this->name; diff --git a/src/Models/PlanCollection.php b/src/Models/PlanCollection.php new file mode 100644 index 0000000..869c313 --- /dev/null +++ b/src/Models/PlanCollection.php @@ -0,0 +1,174 @@ +plans; + } + + /** + * Sets Plans. + * An array of plans. + * + * @maps plans + * + * @param BillingPlan[]|null $plans + */ + public function setPlans(?array $plans): void + { + $this->plans = $plans; + } + + /** + * Returns Total Items. + * The total number of items. + */ + public function getTotalItems(): ?int + { + return $this->totalItems; + } + + /** + * Sets Total Items. + * The total number of items. + * + * @maps total_items + */ + public function setTotalItems(?int $totalItems): void + { + $this->totalItems = $totalItems; + } + + /** + * Returns Total Pages. + * The total number of pages. + */ + public function getTotalPages(): ?int + { + return $this->totalPages; + } + + /** + * Sets Total Pages. + * The total number of pages. + * + * @maps total_pages + */ + public function setTotalPages(?int $totalPages): void + { + $this->totalPages = $totalPages; + } + + /** + * Returns Links. + * An array of request-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 request-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; + } + + /** + * Converts the PlanCollection object to a human-readable string representation. + * + * @return string The string representation of the PlanCollection object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PlanCollection', + [ + 'plans' => $this->plans, + 'totalItems' => $this->totalItems, + 'totalPages' => $this->totalPages, + 'links' => $this->links + ] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + if (isset($this->plans)) { + $json['plans'] = $this->plans; + } + if (isset($this->totalItems)) { + $json['total_items'] = $this->totalItems; + } + if (isset($this->totalPages)) { + $json['total_pages'] = $this->totalPages; + } + if (isset($this->links)) { + $json['links'] = $this->links; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/PlanDetails.php b/src/Models/PlanDetails.php new file mode 100644 index 0000000..977153d --- /dev/null +++ b/src/Models/PlanDetails.php @@ -0,0 +1,288 @@ +productId; + } + + /** + * Sets Product Id. + * The ID for the product. + * + * @maps product_id + */ + public function setProductId(?string $productId): void + { + $this->productId = $productId; + } + + /** + * Returns Name. + * The plan name. + */ + public function getName(): ?string + { + return $this->name; + } + + /** + * Sets Name. + * The plan name. + * + * @maps name + */ + public function setName(?string $name): void + { + $this->name = $name; + } + + /** + * Returns Description. + * The detailed description of the plan. + */ + public function getDescription(): ?string + { + return $this->description; + } + + /** + * Sets Description. + * The detailed description of the plan. + * + * @maps description + */ + public function setDescription(?string $description): void + { + $this->description = $description; + } + + /** + * Returns Billing Cycles. + * An array of billing cycles for trial billing and regular billing. A plan can have at most two trial + * cycles and only one regular cycle. + * + * @return SubscriptionBillingCycle[]|null + */ + public function getBillingCycles(): ?array + { + return $this->billingCycles; + } + + /** + * Sets Billing Cycles. + * An array of billing cycles for trial billing and regular billing. A plan can have at most two trial + * cycles and only one regular cycle. + * + * @maps billing_cycles + * + * @param SubscriptionBillingCycle[]|null $billingCycles + */ + public function setBillingCycles(?array $billingCycles): void + { + $this->billingCycles = $billingCycles; + } + + /** + * Returns Payment Preferences. + * The payment preferences for a subscription. + */ + public function getPaymentPreferences(): ?PaymentPreferences + { + return $this->paymentPreferences; + } + + /** + * Sets Payment Preferences. + * The payment preferences for a subscription. + * + * @maps payment_preferences + */ + public function setPaymentPreferences(?PaymentPreferences $paymentPreferences): void + { + $this->paymentPreferences = $paymentPreferences; + } + + /** + * Returns Merchant Preferences. + * The merchant preferences for a subscription. + */ + public function getMerchantPreferences(): ?MerchantPreferences + { + return $this->merchantPreferences; + } + + /** + * Sets Merchant Preferences. + * The merchant preferences for a subscription. + * + * @maps merchant_preferences + */ + public function setMerchantPreferences(?MerchantPreferences $merchantPreferences): void + { + $this->merchantPreferences = $merchantPreferences; + } + + /** + * Returns Taxes. + * The tax details. + */ + public function getTaxes(): ?Taxes + { + return $this->taxes; + } + + /** + * Sets Taxes. + * The tax details. + * + * @maps taxes + */ + public function setTaxes(?Taxes $taxes): void + { + $this->taxes = $taxes; + } + + /** + * Returns Quantity Supported. + * Indicates whether you can subscribe to this plan by providing a quantity for the goods or service. + */ + public function getQuantitySupported(): ?bool + { + return $this->quantitySupported; + } + + /** + * Sets Quantity Supported. + * Indicates whether you can subscribe to this plan by providing a quantity for the goods or service. + * + * @maps quantity_supported + */ + public function setQuantitySupported(?bool $quantitySupported): void + { + $this->quantitySupported = $quantitySupported; + } + + /** + * Converts the PlanDetails object to a human-readable string representation. + * + * @return string The string representation of the PlanDetails object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PlanDetails', + [ + 'productId' => $this->productId, + 'name' => $this->name, + 'description' => $this->description, + 'billingCycles' => $this->billingCycles, + 'paymentPreferences' => $this->paymentPreferences, + 'merchantPreferences' => $this->merchantPreferences, + 'taxes' => $this->taxes, + 'quantitySupported' => $this->quantitySupported + ] + ); + } + + /** + * 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->productId)) { + $json['product_id'] = $this->productId; + } + if (isset($this->name)) { + $json['name'] = $this->name; + } + if (isset($this->description)) { + $json['description'] = $this->description; + } + if (isset($this->billingCycles)) { + $json['billing_cycles'] = $this->billingCycles; + } + if (isset($this->paymentPreferences)) { + $json['payment_preferences'] = $this->paymentPreferences; + } + if (isset($this->merchantPreferences)) { + $json['merchant_preferences'] = $this->merchantPreferences; + } + if (isset($this->taxes)) { + $json['taxes'] = $this->taxes; + } + if (isset($this->quantitySupported)) { + $json['quantity_supported'] = $this->quantitySupported; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/PlanOverride.php b/src/Models/PlanOverride.php new file mode 100644 index 0000000..4df629f --- /dev/null +++ b/src/Models/PlanOverride.php @@ -0,0 +1,144 @@ +billingCycles; + } + + /** + * Sets Billing Cycles. + * An array of billing cycles for trial billing and regular billing. The subscription billing cycle + * definition has to adhere to the plan billing cycle definition. + * + * @maps billing_cycles + * + * @param BillingCycleOverride[]|null $billingCycles + */ + public function setBillingCycles(?array $billingCycles): void + { + $this->billingCycles = $billingCycles; + } + + /** + * Returns Payment Preferences. + * The payment preferences to override at subscription level. + */ + public function getPaymentPreferences(): ?PaymentPreferencesOverride + { + return $this->paymentPreferences; + } + + /** + * Sets Payment Preferences. + * The payment preferences to override at subscription level. + * + * @maps payment_preferences + */ + public function setPaymentPreferences(?PaymentPreferencesOverride $paymentPreferences): void + { + $this->paymentPreferences = $paymentPreferences; + } + + /** + * Returns Taxes. + * The tax details. + */ + public function getTaxes(): ?TaxesOverride + { + return $this->taxes; + } + + /** + * Sets Taxes. + * The tax details. + * + * @maps taxes + */ + public function setTaxes(?TaxesOverride $taxes): void + { + $this->taxes = $taxes; + } + + /** + * Converts the PlanOverride object to a human-readable string representation. + * + * @return string The string representation of the PlanOverride object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PlanOverride', + [ + 'billingCycles' => $this->billingCycles, + 'paymentPreferences' => $this->paymentPreferences, + 'taxes' => $this->taxes + ] + ); + } + + /** + * 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->billingCycles)) { + $json['billing_cycles'] = $this->billingCycles; + } + if (isset($this->paymentPreferences)) { + $json['payment_preferences'] = $this->paymentPreferences; + } + if (isset($this->taxes)) { + $json['taxes'] = $this->taxes; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/PlanRequest.php b/src/Models/PlanRequest.php new file mode 100644 index 0000000..2587f2e --- /dev/null +++ b/src/Models/PlanRequest.php @@ -0,0 +1,331 @@ +productId = $productId; + $this->name = $name; + $this->billingCycles = $billingCycles; + $this->paymentPreferences = $paymentPreferences; + } + + /** + * Returns Product Id. + * The ID of the product created through Catalog Products API. + */ + public function getProductId(): string + { + return $this->productId; + } + + /** + * Sets Product Id. + * The ID of the product created through Catalog Products API. + * + * @required + * @maps product_id + */ + public function setProductId(string $productId): void + { + $this->productId = $productId; + } + + /** + * Returns Name. + * The plan name. + */ + public function getName(): string + { + return $this->name; + } + + /** + * Sets Name. + * The plan name. + * + * @required + * @maps name + */ + public function setName(string $name): void + { + $this->name = $name; + } + + /** + * Returns Status. + * The initial state of the plan. Allowed input values are CREATED and ACTIVE. + */ + public function getStatus(): ?string + { + return $this->status; + } + + /** + * Sets Status. + * The initial state of the plan. Allowed input values are CREATED and ACTIVE. + * + * @maps status + */ + public function setStatus(?string $status): void + { + $this->status = $status; + } + + /** + * Returns Description. + * The detailed description of the plan. + */ + public function getDescription(): ?string + { + return $this->description; + } + + /** + * Sets Description. + * The detailed description of the plan. + * + * @maps description + */ + public function setDescription(?string $description): void + { + $this->description = $description; + } + + /** + * Returns Billing Cycles. + * An array of billing cycles for trial billing and regular billing. A plan can have at most two trial + * cycles and only one regular cycle. + * + * @return SubscriptionBillingCycle[] + */ + public function getBillingCycles(): array + { + return $this->billingCycles; + } + + /** + * Sets Billing Cycles. + * An array of billing cycles for trial billing and regular billing. A plan can have at most two trial + * cycles and only one regular cycle. + * + * @required + * @maps billing_cycles + * + * @param SubscriptionBillingCycle[] $billingCycles + */ + public function setBillingCycles(array $billingCycles): void + { + $this->billingCycles = $billingCycles; + } + + /** + * Returns Payment Preferences. + * The payment preferences for a subscription. + */ + public function getPaymentPreferences(): PaymentPreferences + { + return $this->paymentPreferences; + } + + /** + * Sets Payment Preferences. + * The payment preferences for a subscription. + * + * @required + * @maps payment_preferences + */ + public function setPaymentPreferences(PaymentPreferences $paymentPreferences): void + { + $this->paymentPreferences = $paymentPreferences; + } + + /** + * Returns Merchant Preferences. + * The merchant preferences for a subscription. + */ + public function getMerchantPreferences(): ?MerchantPreferences + { + return $this->merchantPreferences; + } + + /** + * Sets Merchant Preferences. + * The merchant preferences for a subscription. + * + * @maps merchant_preferences + */ + public function setMerchantPreferences(?MerchantPreferences $merchantPreferences): void + { + $this->merchantPreferences = $merchantPreferences; + } + + /** + * Returns Taxes. + * The tax details. + */ + public function getTaxes(): ?Taxes + { + return $this->taxes; + } + + /** + * Sets Taxes. + * The tax details. + * + * @maps taxes + */ + public function setTaxes(?Taxes $taxes): void + { + $this->taxes = $taxes; + } + + /** + * Returns Quantity Supported. + * Indicates whether you can subscribe to this plan by providing a quantity for the goods or service. + */ + public function getQuantitySupported(): ?bool + { + return $this->quantitySupported; + } + + /** + * Sets Quantity Supported. + * Indicates whether you can subscribe to this plan by providing a quantity for the goods or service. + * + * @maps quantity_supported + */ + public function setQuantitySupported(?bool $quantitySupported): void + { + $this->quantitySupported = $quantitySupported; + } + + /** + * Converts the PlanRequest object to a human-readable string representation. + * + * @return string The string representation of the PlanRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PlanRequest', + [ + 'productId' => $this->productId, + 'name' => $this->name, + 'status' => $this->status, + 'description' => $this->description, + 'billingCycles' => $this->billingCycles, + 'paymentPreferences' => $this->paymentPreferences, + 'merchantPreferences' => $this->merchantPreferences, + 'taxes' => $this->taxes, + 'quantitySupported' => $this->quantitySupported + ] + ); + } + + /** + * 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['product_id'] = $this->productId; + $json['name'] = $this->name; + if (isset($this->status)) { + $json['status'] = $this->status; + } + if (isset($this->description)) { + $json['description'] = $this->description; + } + $json['billing_cycles'] = $this->billingCycles; + $json['payment_preferences'] = $this->paymentPreferences; + if (isset($this->merchantPreferences)) { + $json['merchant_preferences'] = $this->merchantPreferences; + } + if (isset($this->taxes)) { + $json['taxes'] = $this->taxes; + } + if (isset($this->quantitySupported)) { + $json['quantity_supported'] = $this->quantitySupported; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/PlanRequestStatus.php b/src/Models/PlanRequestStatus.php new file mode 100644 index 0000000..18326db --- /dev/null +++ b/src/Models/PlanRequestStatus.php @@ -0,0 +1,32 @@ +startingQuantity = $startingQuantity; + $this->amount = $amount; + } + + /** + * Returns Starting Quantity. + * The starting quantity for the tier. + */ + public function getStartingQuantity(): string + { + return $this->startingQuantity; + } + + /** + * Sets Starting Quantity. + * The starting quantity for the tier. + * + * @required + * @maps starting_quantity + */ + public function setStartingQuantity(string $startingQuantity): void + { + $this->startingQuantity = $startingQuantity; + } + + /** + * Returns Ending Quantity. + * The ending quantity for the tier. Optional for the last tier. + */ + public function getEndingQuantity(): ?string + { + return $this->endingQuantity; + } + + /** + * Sets Ending Quantity. + * The ending quantity for the tier. Optional for the last tier. + * + * @maps ending_quantity + */ + public function setEndingQuantity(?string $endingQuantity): void + { + $this->endingQuantity = $endingQuantity; + } + + /** + * 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; + } + + /** + * Converts the PricingTier object to a human-readable string representation. + * + * @return string The string representation of the PricingTier object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'PricingTier', + [ + 'startingQuantity' => $this->startingQuantity, + 'endingQuantity' => $this->endingQuantity, + 'amount' => $this->amount + ] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + $json['starting_quantity'] = $this->startingQuantity; + if (isset($this->endingQuantity)) { + $json['ending_quantity'] = $this->endingQuantity; + } + $json['amount'] = $this->amount; + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/PurchaseUnitRequest.php b/src/Models/PurchaseUnitRequest.php index 4e52f09..68e2d70 100644 --- a/src/Models/PurchaseUnitRequest.php +++ b/src/Models/PurchaseUnitRequest.php @@ -59,7 +59,7 @@ class PurchaseUnitRequest implements \JsonSerializable private $softDescriptor; /** - * @var Item[]|null + * @var ItemRequest[]|null */ private $items; @@ -178,10 +178,12 @@ class PurchaseUnitRequest implements \JsonSerializable /** * 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. + * This field supports up to 3,000 characters, but any content beyond 127 characters (including spaces) + * will be truncated. The 127 character limit is reflected in the response representation of this field. + * 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 { @@ -190,10 +192,12 @@ class PurchaseUnitRequest implements \JsonSerializable /** * 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. + * This field supports up to 3,000 characters, but any content beyond 127 characters (including spaces) + * will be truncated. The 127 character limit is reflected in the response representation of this field. + * 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 */ @@ -227,7 +231,10 @@ class PurchaseUnitRequest implements \JsonSerializable /** * 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. + * transaction history and the emails that the payer receives. invoice_id values are required to be + * unique within each merchant account by default. Although the uniqueness validation is configurable, + * disabling this behavior will remove the account's ability to use invoice_id in other APIs as an + * identifier. It is highly recommended to keep a unique invoice_id for each Order. */ public function getInvoiceId(): ?string { @@ -237,7 +244,10 @@ class PurchaseUnitRequest implements \JsonSerializable /** * 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. + * transaction history and the emails that the payer receives. invoice_id values are required to be + * unique within each merchant account by default. Although the uniqueness validation is configurable, + * disabling this behavior will remove the account's ability to use invoice_id in other APIs as an + * identifier. It is highly recommended to keep a unique invoice_id for each Order. * * @maps invoice_id */ @@ -248,6 +258,8 @@ class PurchaseUnitRequest implements \JsonSerializable /** * Returns Soft Descriptor. + * This field supports up to 127 characters, but any content beyond 22 characters (including spaces) + * will be truncated. The 22 character limit is reflected in the response representation of this field. * 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: @@ -265,6 +277,8 @@ class PurchaseUnitRequest implements \JsonSerializable /** * Sets Soft Descriptor. + * This field supports up to 127 characters, but any content beyond 22 characters (including spaces) + * will be truncated. The 22 character limit is reflected in the response representation of this field. * 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: @@ -286,7 +300,7 @@ class PurchaseUnitRequest implements \JsonSerializable * Returns Items. * An array of items that the customer purchases from the merchant. * - * @return Item[]|null + * @return ItemRequest[]|null */ public function getItems(): ?array { @@ -299,7 +313,7 @@ class PurchaseUnitRequest implements \JsonSerializable * * @maps items * - * @param Item[]|null $items + * @param ItemRequest[]|null $items */ public function setItems(?array $items): void { diff --git a/src/Models/ReasonCode.php b/src/Models/ReasonCode.php new file mode 100644 index 0000000..cc266e2 --- /dev/null +++ b/src/Models/ReasonCode.php @@ -0,0 +1,57 @@ +transactionDetails; + } + + /** + * Sets Transaction Details. + * An array of transaction detail objects. + * + * @maps transaction_details + * + * @param TransactionDetails[]|null $transactionDetails + */ + public function setTransactionDetails(?array $transactionDetails): void + { + $this->transactionDetails = $transactionDetails; + } + + /** + * Returns Account Number. + * The merchant account number. + */ + public function getAccountNumber(): ?string + { + return $this->accountNumber; + } + + /** + * Sets Account Number. + * The merchant account number. + * + * @maps account_number + */ + public function setAccountNumber(?string $accountNumber): void + { + $this->accountNumber = $accountNumber; + } + + /** + * Returns Start Date. + * 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 getStartDate(): ?string + { + return $this->startDate; + } + + /** + * Sets Start Date. + * 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 start_date + */ + public function setStartDate(?string $startDate): void + { + $this->startDate = $startDate; + } + + /** + * Returns End Date. + * 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 getEndDate(): ?string + { + return $this->endDate; + } + + /** + * Sets End Date. + * 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 end_date + */ + public function setEndDate(?string $endDate): void + { + $this->endDate = $endDate; + } + + /** + * Returns Last Refreshed Datetime. + * 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 getLastRefreshedDatetime(): ?string + { + return $this->lastRefreshedDatetime; + } + + /** + * Sets Last Refreshed Datetime. + * 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 last_refreshed_datetime + */ + public function setLastRefreshedDatetime(?string $lastRefreshedDatetime): void + { + $this->lastRefreshedDatetime = $lastRefreshedDatetime; + } + + /** + * Returns Page. + * A zero-relative index of transactions. + */ + public function getPage(): ?int + { + return $this->page; + } + + /** + * Sets Page. + * A zero-relative index of transactions. + * + * @maps page + */ + public function setPage(?int $page): void + { + $this->page = $page; + } + + /** + * Returns Total Items. + * The total number of transactions as an integer beginning with the specified `page` in the full + * result and not just in this response. + */ + public function getTotalItems(): ?int + { + return $this->totalItems; + } + + /** + * Sets Total Items. + * The total number of transactions as an integer beginning with the specified `page` in the full + * result and not just in this response. + * + * @maps total_items + */ + public function setTotalItems(?int $totalItems): void + { + $this->totalItems = $totalItems; + } + + /** + * Returns Total Pages. + * The total number of pages, as an `integer`, when the `total_items` is divided into pages of the + * specified `page_size`. + */ + public function getTotalPages(): ?int + { + return $this->totalPages; + } + + /** + * Sets Total Pages. + * The total number of pages, as an `integer`, when the `total_items` is divided into pages of the + * specified `page_size`. + * + * @maps total_pages + */ + public function setTotalPages(?int $totalPages): void + { + $this->totalPages = $totalPages; + } + + /** + * Returns Links. + * An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links). + * + * @return 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 LinkDescription[]|null $links + */ + public function setLinks(?array $links): void + { + $this->links = $links; + } + + /** + * Converts the SearchResponse object to a human-readable string representation. + * + * @return string The string representation of the SearchResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'SearchResponse', + [ + 'transactionDetails' => $this->transactionDetails, + 'accountNumber' => $this->accountNumber, + 'startDate' => $this->startDate, + 'endDate' => $this->endDate, + 'lastRefreshedDatetime' => $this->lastRefreshedDatetime, + 'page' => $this->page, + 'totalItems' => $this->totalItems, + 'totalPages' => $this->totalPages, + 'links' => $this->links + ] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + if (isset($this->transactionDetails)) { + $json['transaction_details'] = $this->transactionDetails; + } + if (isset($this->accountNumber)) { + $json['account_number'] = $this->accountNumber; + } + if (isset($this->startDate)) { + $json['start_date'] = $this->startDate; + } + if (isset($this->endDate)) { + $json['end_date'] = $this->endDate; + } + if (isset($this->lastRefreshedDatetime)) { + $json['last_refreshed_datetime'] = $this->lastRefreshedDatetime; + } + if (isset($this->page)) { + $json['page'] = $this->page; + } + if (isset($this->totalItems)) { + $json['total_items'] = $this->totalItems; + } + if (isset($this->totalPages)) { + $json['total_pages'] = $this->totalPages; + } + if (isset($this->links)) { + $json['links'] = $this->links; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/SepaDebitExperienceContext.php b/src/Models/SepaDebitExperienceContext.php new file mode 100644 index 0000000..a231a43 --- /dev/null +++ b/src/Models/SepaDebitExperienceContext.php @@ -0,0 +1,151 @@ +returnUrl = $returnUrl; + $this->cancelUrl = $cancelUrl; + } + + /** + * 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. + * Describes the URL. + */ + public function getReturnUrl(): string + { + return $this->returnUrl; + } + + /** + * Sets Return Url. + * Describes the URL. + * + * @required + * @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. + * + * @required + * @maps cancel_url + */ + public function setCancelUrl(string $cancelUrl): void + { + $this->cancelUrl = $cancelUrl; + } + + /** + * Converts the SepaDebitExperienceContext object to a human-readable string representation. + * + * @return string The string representation of the SepaDebitExperienceContext object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'SepaDebitExperienceContext', + ['locale' => $this->locale, 'returnUrl' => $this->returnUrl, 'cancelUrl' => $this->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->locale)) { + $json['locale'] = $this->locale; + } + $json['return_url'] = $this->returnUrl; + $json['cancel_url'] = $this->cancelUrl; + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/SepaDebitRequest.php b/src/Models/SepaDebitRequest.php new file mode 100644 index 0000000..f59dd26 --- /dev/null +++ b/src/Models/SepaDebitRequest.php @@ -0,0 +1,74 @@ +experienceContext; + } + + /** + * Sets Experience Context. + * Customizes the payer experience during the approval process for the SEPA Debit payment. + * + * @maps experience_context + */ + public function setExperienceContext(?SepaDebitExperienceContext $experienceContext): void + { + $this->experienceContext = $experienceContext; + } + + /** + * Converts the SepaDebitRequest object to a human-readable string representation. + * + * @return string The string representation of the SepaDebitRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify('SepaDebitRequest', ['experienceContext' => $this->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->experienceContext)) { + $json['experience_context'] = $this->experienceContext; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/SetupFeeFailureAction.php b/src/Models/SetupFeeFailureAction.php new file mode 100644 index 0000000..edd469d --- /dev/null +++ b/src/Models/SetupFeeFailureAction.php @@ -0,0 +1,27 @@ +experienceContext; } /** * Sets Experience Context. - * Customizes the Vault creation flow experience for your customers. + * A resource representing an experience context of vault a card. * * @maps experience_context */ - public function setExperienceContext(?SetupTokenCardExperienceContext $experienceContext): void + public function setExperienceContext(?VaultCardExperienceContext $experienceContext): void { $this->experienceContext = $experienceContext; } diff --git a/src/Models/SetupTokenRequestPaymentSource.php b/src/Models/SetupTokenRequestPaymentSource.php index a50faa8..3d9de23 100644 --- a/src/Models/SetupTokenRequestPaymentSource.php +++ b/src/Models/SetupTokenRequestPaymentSource.php @@ -33,11 +33,21 @@ class SetupTokenRequestPaymentSource implements \JsonSerializable */ private $venmo; + /** + * @var VaultApplePayRequest|null + */ + private $applePay; + /** * @var VaultTokenRequest|null */ private $token; + /** + * @var BankRequest|null + */ + private $bank; + /** * Returns Card. * A Resource representing a request to vault a Card. @@ -80,6 +90,7 @@ class SetupTokenRequestPaymentSource implements \JsonSerializable /** * Returns Venmo. + * A resource representing a request to vault Venmo. */ public function getVenmo(): ?VaultVenmoRequest { @@ -88,6 +99,7 @@ class SetupTokenRequestPaymentSource implements \JsonSerializable /** * Sets Venmo. + * A resource representing a request to vault Venmo. * * @maps venmo */ @@ -96,6 +108,26 @@ class SetupTokenRequestPaymentSource implements \JsonSerializable $this->venmo = $venmo; } + /** + * Returns Apple Pay. + * A resource representing a request to vault Apple Pay. + */ + public function getApplePay(): ?VaultApplePayRequest + { + return $this->applePay; + } + + /** + * Sets Apple Pay. + * A resource representing a request to vault Apple Pay. + * + * @maps apple_pay + */ + public function setApplePay(?VaultApplePayRequest $applePay): void + { + $this->applePay = $applePay; + } + /** * Returns Token. * The Tokenized Payment Source representing a Request to Vault a Token. @@ -116,6 +148,26 @@ class SetupTokenRequestPaymentSource implements \JsonSerializable $this->token = $token; } + /** + * Returns Bank. + * A Resource representing a request to vault a Bank used for ACH Debit. + */ + public function getBank(): ?BankRequest + { + return $this->bank; + } + + /** + * Sets Bank. + * A Resource representing a request to vault a Bank used for ACH Debit. + * + * @maps bank + */ + public function setBank(?BankRequest $bank): void + { + $this->bank = $bank; + } + /** * Converts the SetupTokenRequestPaymentSource object to a human-readable string representation. * @@ -125,7 +177,14 @@ class SetupTokenRequestPaymentSource implements \JsonSerializable { return ApiHelper::stringify( 'SetupTokenRequestPaymentSource', - ['card' => $this->card, 'paypal' => $this->paypal, 'venmo' => $this->venmo, 'token' => $this->token] + [ + 'card' => $this->card, + 'paypal' => $this->paypal, + 'venmo' => $this->venmo, + 'applePay' => $this->applePay, + 'token' => $this->token, + 'bank' => $this->bank + ] ); } @@ -142,16 +201,22 @@ class SetupTokenRequestPaymentSource implements \JsonSerializable { $json = []; if (isset($this->card)) { - $json['card'] = $this->card; + $json['card'] = $this->card; } if (isset($this->paypal)) { - $json['paypal'] = $this->paypal; + $json['paypal'] = $this->paypal; } if (isset($this->venmo)) { - $json['venmo'] = $this->venmo; + $json['venmo'] = $this->venmo; + } + if (isset($this->applePay)) { + $json['apple_pay'] = $this->applePay; } if (isset($this->token)) { - $json['token'] = $this->token; + $json['token'] = $this->token; + } + if (isset($this->bank)) { + $json['bank'] = $this->bank; } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; diff --git a/src/Models/SetupTokenResponse.php b/src/Models/SetupTokenResponse.php index 693eb3d..fd44e7f 100644 --- a/src/Models/SetupTokenResponse.php +++ b/src/Models/SetupTokenResponse.php @@ -45,7 +45,8 @@ class SetupTokenResponse implements \JsonSerializable /** * Returns Id. - * The PayPal-generated ID for the vault token. + * 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 getId(): ?string { @@ -54,7 +55,8 @@ class SetupTokenResponse implements \JsonSerializable /** * Sets Id. - * The PayPal-generated ID for the vault token. + * 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 id */ diff --git a/src/Models/SetupTokenResponsePaymentSource.php b/src/Models/SetupTokenResponsePaymentSource.php index d07cadc..789271d 100644 --- a/src/Models/SetupTokenResponsePaymentSource.php +++ b/src/Models/SetupTokenResponsePaymentSource.php @@ -53,6 +53,7 @@ class SetupTokenResponsePaymentSource implements \JsonSerializable /** * Returns Paypal. + * Full representation of a PayPal Payment Token. */ public function getPaypal(): ?PaypalPaymentToken { @@ -61,6 +62,7 @@ class SetupTokenResponsePaymentSource implements \JsonSerializable /** * Sets Paypal. + * Full representation of a PayPal Payment Token. * * @maps paypal */ @@ -71,6 +73,7 @@ class SetupTokenResponsePaymentSource implements \JsonSerializable /** * Returns Venmo. + * Full representation of a Venmo Payment Token. */ public function getVenmo(): ?VenmoPaymentToken { @@ -79,6 +82,7 @@ class SetupTokenResponsePaymentSource implements \JsonSerializable /** * Sets Venmo. + * Full representation of a Venmo Payment Token. * * @maps venmo */ diff --git a/src/Models/ShipmentCarrier.php b/src/Models/ShipmentCarrier.php index a4f6f96..ba38dcd 100644 --- a/src/Models/ShipmentCarrier.php +++ b/src/Models/ShipmentCarrier.php @@ -6898,4 +6898,184 @@ class ShipmentCarrier * Spedisci online. */ public const SPEDISCI = 'SPEDISCI'; + + /** + * Fourkites. + */ + public const FOURKITES = 'FOURKITES'; + + /** + * Etonas. + */ + public const ETONAS = 'ETONAS'; + + /** + * Fin Mile. + */ + public const FINMILE = 'FINMILE'; + + /** + * Uniuni. + */ + public const UNIUNI = 'UNIUNI'; + + /** + * Rodonaves. + */ + public const RODONAVES = 'RODONAVES'; + + /** + * Inpost Italy. + */ + public const INPOST_IT = 'INPOST_IT'; + + /** + * Tforce Freight. + */ + public const TFORCE_FREIGHT = 'TFORCE_FREIGHT'; + + /** + * Rich Mom. + */ + public const RICHMOM = 'RICHMOM'; + + /** + * Corriere Franco. + */ + public const FRANCO = 'FRANCO'; + + /** + * Ecparcel. + */ + public const ECPARCEL = 'ECPARCEL'; + + /** + * Fedex China. + */ + public const FEDEX_CHINA = 'FEDEX_CHINA'; + + /** + * Gofo Express. + */ + public const GOFO_EXPRESS = 'GOFO_EXPRESS'; + + /** + * Shipbob. + */ + public const SHIPBOB = 'SHIPBOB'; + + /** + * Jersey Post Group. + */ + public const JERSEYPOST_ATLAS = 'JERSEYPOST_ATLAS'; + + /** + * Coretrails. + */ + public const CORETRAILS = 'CORETRAILS'; + + /** + * Rhenus Logistics Italy. + */ + public const RHENUS_ITALY = 'RHENUS_ITALY'; + + /** + * Jadlog. + */ + public const JADLOG = 'JADLOG'; + + /** + * Jitsu. + */ + public const JITSU = 'JITSU'; + + /** + * Yanwen Express. + */ + public const YANWEN_EXPRESS = 'YANWEN_EXPRESS'; + + /** + * Dashlink. + */ + public const DASHLINK = 'DASHLINK'; + + /** + * Seino Super Express. + */ + public const SEINO_SUPER_EXPRESS = 'SEINO_SUPER_EXPRESS'; + + /** + * Floship. + */ + public const FLOSHIP = 'FLOSHIP'; + + /** + * Metro Supply Chain. + */ + public const METROSCG = 'METROSCG'; + + /** + * Sendparcel. + */ + public const SENDPARCEL = 'SENDPARCEL'; + + /** + * P2p. + */ + public const P2P = 'P2P'; + + /** + * Cn Express. + */ + public const CN_EXPRESS = 'CN_EXPRESS'; + + /** + * Cirro Track. + */ + public const CIRROTRACK = 'CIRROTRACK'; + + /** + * Land Logistics. + */ + public const LAND_LOGISTICS = 'LAND_LOGISTICS'; + + /** + * Veho. + */ + public const VEHO = 'VEHO'; + + /** + * Medline. + */ + public const MEDLINE = 'MEDLINE'; + + /** + * Vdtrack. + */ + public const VDTRACK = 'VDTRACK'; + + /** + * Sino Scm. + */ + public const SINO_SCM = 'SINO_SCM'; + + /** + * 3pe Express. + */ + public const ENUM_3PE_EXPRESS = '3PE_EXPRESS'; + + /** + * Swiftx. + */ + public const SWIFTX = 'SWIFTX'; + + /** + * Sfyd Express. + */ + public const SFYDEXPRESS = 'SFYDEXPRESS'; + + /** + * Toptrans. + */ + public const TOPTRANS = 'TOPTRANS'; } diff --git a/src/Models/ShippingInformation.php b/src/Models/ShippingInformation.php new file mode 100644 index 0000000..1e2f357 --- /dev/null +++ b/src/Models/ShippingInformation.php @@ -0,0 +1,170 @@ +name; + } + + /** + * Sets Name. + * The recipient's name. + * + * @maps name + */ + public function setName(?string $name): void + { + $this->name = $name; + } + + /** + * Returns Method. + * The shipping method that is associated with this order. + */ + public function getMethod(): ?string + { + return $this->method; + } + + /** + * Sets Method. + * The shipping method that is associated with this order. + * + * @maps method + */ + public function setMethod(?string $method): void + { + $this->method = $method; + } + + /** + * Returns Address. + * A simple postal address with coarse-grained fields. Do not use for an international address. Use for + * backward compatibility only. Does not contain phone. + */ + public function getAddress(): ?SimplePostalAddressCoarseGrained + { + return $this->address; + } + + /** + * Sets Address. + * A simple postal address with coarse-grained fields. Do not use for an international address. Use for + * backward compatibility only. Does not contain phone. + * + * @maps address + */ + public function setAddress(?SimplePostalAddressCoarseGrained $address): void + { + $this->address = $address; + } + + /** + * Returns Secondary Shipping Address. + * A simple postal address with coarse-grained fields. Do not use for an international address. Use for + * backward compatibility only. Does not contain phone. + */ + public function getSecondaryShippingAddress(): ?SimplePostalAddressCoarseGrained + { + return $this->secondaryShippingAddress; + } + + /** + * Sets Secondary Shipping Address. + * A simple postal address with coarse-grained fields. Do not use for an international address. Use for + * backward compatibility only. Does not contain phone. + * + * @maps secondary_shipping_address + */ + public function setSecondaryShippingAddress(?SimplePostalAddressCoarseGrained $secondaryShippingAddress): void + { + $this->secondaryShippingAddress = $secondaryShippingAddress; + } + + /** + * Converts the ShippingInformation object to a human-readable string representation. + * + * @return string The string representation of the ShippingInformation object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'ShippingInformation', + [ + 'name' => $this->name, + 'method' => $this->method, + 'address' => $this->address, + 'secondaryShippingAddress' => $this->secondaryShippingAddress + ] + ); + } + + /** + * 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->method)) { + $json['method'] = $this->method; + } + if (isset($this->address)) { + $json['address'] = $this->address; + } + if (isset($this->secondaryShippingAddress)) { + $json['secondary_shipping_address'] = $this->secondaryShippingAddress; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/ShippingOptionsPurchaseUnit.php b/src/Models/ShippingOptionsPurchaseUnit.php deleted file mode 100644 index dcf3cf2..0000000 --- a/src/Models/ShippingOptionsPurchaseUnit.php +++ /dev/null @@ -1,190 +0,0 @@ -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 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 Options. - * An array of shipping options that the payee or merchant offers to the payer to ship or pick up their - * items. - * - * @return ShippingOption[]|null - */ - public function getShippingOptions(): ?array - { - return $this->shippingOptions; - } - - /** - * Sets Shipping Options. - * An array of shipping options that the payee or merchant offers to the payer to ship or pick up their - * items. - * - * @maps shipping_options - * - * @param ShippingOption[]|null $shippingOptions - */ - public function setShippingOptions(?array $shippingOptions): void - { - $this->shippingOptions = $shippingOptions; - } - - /** - * Converts the ShippingOptionsPurchaseUnit object to a human-readable string representation. - * - * @return string The string representation of the ShippingOptionsPurchaseUnit object. - */ - public function __toString(): string - { - return ApiHelper::stringify( - 'ShippingOptionsPurchaseUnit', - [ - 'referenceId' => $this->referenceId, - 'amount' => $this->amount, - 'items' => $this->items, - 'shippingOptions' => $this->shippingOptions - ] - ); - } - - /** - * Encode this object to JSON - * - * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields - * are set. (default: false) - * - * @return array|stdClass - */ - #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) - public function jsonSerialize(bool $asArrayWhenEmpty = false) - { - $json = []; - if (isset($this->referenceId)) { - $json['reference_id'] = $this->referenceId; - } - if (isset($this->amount)) { - $json['amount'] = $this->amount; - } - if (isset($this->items)) { - $json['items'] = $this->items; - } - if (isset($this->shippingOptions)) { - $json['shipping_options'] = $this->shippingOptions; - } - - return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; - } -} diff --git a/src/Models/ShippingWithTrackingDetails.php b/src/Models/ShippingWithTrackingDetails.php index 025ada7..07f26d5 100644 --- a/src/Models/ShippingWithTrackingDetails.php +++ b/src/Models/ShippingWithTrackingDetails.php @@ -13,11 +13,13 @@ namespace PaypalServerSdkLib\Models; use PaypalServerSdkLib\ApiHelper; use stdClass; -/** - * The order shipping details. - */ class ShippingWithTrackingDetails implements \JsonSerializable { + /** + * @var OrderTrackerResponse[]|null + */ + private $trackers; + /** * @var ShippingName|null */ @@ -29,7 +31,7 @@ class ShippingWithTrackingDetails implements \JsonSerializable private $emailAddress; /** - * @var PhoneNumberWithCountryCode|null + * @var PhoneNumberWithOptionalCountryCode|null */ private $phoneNumber; @@ -49,9 +51,28 @@ class ShippingWithTrackingDetails implements \JsonSerializable private $address; /** - * @var OrderTrackerResponse[]|null + * Returns Trackers. + * An array of trackers for a transaction. + * + * @return OrderTrackerResponse[]|null */ - private $trackers; + 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; + } /** * Returns Name. @@ -102,7 +123,7 @@ class ShippingWithTrackingDetails implements \JsonSerializable * 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 + public function getPhoneNumber(): ?PhoneNumberWithOptionalCountryCode { return $this->phoneNumber; } @@ -114,7 +135,7 @@ class ShippingWithTrackingDetails implements \JsonSerializable * * @maps phone_number */ - public function setPhoneNumber(?PhoneNumberWithCountryCode $phoneNumber): void + public function setPhoneNumber(?PhoneNumberWithOptionalCountryCode $phoneNumber): void { $this->phoneNumber = $phoneNumber; } @@ -193,30 +214,6 @@ class ShippingWithTrackingDetails implements \JsonSerializable $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; - } - /** * Converts the ShippingWithTrackingDetails object to a human-readable string representation. * @@ -227,13 +224,13 @@ class ShippingWithTrackingDetails implements \JsonSerializable return ApiHelper::stringify( 'ShippingWithTrackingDetails', [ + 'trackers' => $this->trackers, 'name' => $this->name, 'emailAddress' => $this->emailAddress, 'phoneNumber' => $this->phoneNumber, 'type' => $this->type, 'options' => $this->options, - 'address' => $this->address, - 'trackers' => $this->trackers + 'address' => $this->address ] ); } @@ -250,6 +247,9 @@ class ShippingWithTrackingDetails implements \JsonSerializable public function jsonSerialize(bool $asArrayWhenEmpty = false) { $json = []; + if (isset($this->trackers)) { + $json['trackers'] = $this->trackers; + } if (isset($this->name)) { $json['name'] = $this->name; } @@ -268,9 +268,6 @@ class ShippingWithTrackingDetails implements \JsonSerializable 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/SimplePostalAddressCoarseGrained.php b/src/Models/SimplePostalAddressCoarseGrained.php new file mode 100644 index 0000000..95903e9 --- /dev/null +++ b/src/Models/SimplePostalAddressCoarseGrained.php @@ -0,0 +1,256 @@ +line1 = $line1; + $this->city = $city; + $this->countryCode = $countryCode; + } + + /** + * Returns Line 1. + * The first line of the address. For example, number or street. + */ + public function getLine1(): string + { + return $this->line1; + } + + /** + * Sets Line 1. + * The first line of the address. For example, number or street. + * + * @required + * @maps line1 + */ + public function setLine1(string $line1): void + { + $this->line1 = $line1; + } + + /** + * Returns Line 2. + * The second line of the address. For example, suite or apartment number. + */ + public function getLine2(): ?string + { + return $this->line2; + } + + /** + * Sets Line 2. + * The second line of the address. For example, suite or apartment number. + * + * @maps line2 + */ + public function setLine2(?string $line2): void + { + $this->line2 = $line2; + } + + /** + * Returns City. + * The city name. + */ + public function getCity(): string + { + return $this->city; + } + + /** + * Sets City. + * The city name. + * + * @required + * @maps city + */ + public function setCity(string $city): void + { + $this->city = $city; + } + + /** + * Returns State. + * The [code](/docs/api/reference/state-codes/) for a US state or the equivalent for other countries. + * Required for transactions if the address is in one of these countries: + * [Argentina](/docs/api/reference/state-codes/#argentina), [Brazil](/docs/api/reference/state- + * codes/#brazil), [Canada](/docs/api/reference/state-codes/#canada), [China](/docs/api/reference/state- + * codes/#china), [India](/docs/api/reference/state-codes/#india), [Italy](/docs/api/reference/state- + * codes/#italy), [Japan](/docs/api/reference/state-codes/#japan), [Mexico](/docs/api/reference/state- + * codes/#mexico), [Thailand](/docs/api/reference/state-codes/#thailand), or [United + * States](/docs/api/reference/state-codes/#usa). Maximum length is 40 single-byte characters. + */ + public function getState(): ?string + { + return $this->state; + } + + /** + * Sets State. + * The [code](/docs/api/reference/state-codes/) for a US state or the equivalent for other countries. + * Required for transactions if the address is in one of these countries: + * [Argentina](/docs/api/reference/state-codes/#argentina), [Brazil](/docs/api/reference/state- + * codes/#brazil), [Canada](/docs/api/reference/state-codes/#canada), [China](/docs/api/reference/state- + * codes/#china), [India](/docs/api/reference/state-codes/#india), [Italy](/docs/api/reference/state- + * codes/#italy), [Japan](/docs/api/reference/state-codes/#japan), [Mexico](/docs/api/reference/state- + * codes/#mexico), [Thailand](/docs/api/reference/state-codes/#thailand), or [United + * States](/docs/api/reference/state-codes/#usa). Maximum length is 40 single-byte characters. + * + * @maps state + */ + public function setState(?string $state): void + { + $this->state = $state; + } + + /** + * Returns Country Code. + * The [two-character ISO 3166-1 code](/docs/integration/direct/rest/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](/docs/integration/direct/rest/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 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; + } + + /** + * Converts the SimplePostalAddressCoarseGrained object to a human-readable string representation. + * + * @return string The string representation of the SimplePostalAddressCoarseGrained object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'SimplePostalAddressCoarseGrained', + [ + 'line1' => $this->line1, + 'line2' => $this->line2, + 'city' => $this->city, + 'state' => $this->state, + 'countryCode' => $this->countryCode, + 'postalCode' => $this->postalCode + ] + ); + } + + /** + * 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['line1'] = $this->line1; + if (isset($this->line2)) { + $json['line2'] = $this->line2; + } + $json['city'] = $this->city; + if (isset($this->state)) { + $json['state'] = $this->state; + } + $json['country_code'] = $this->countryCode; + if (isset($this->postalCode)) { + $json['postal_code'] = $this->postalCode; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/StoreInformation.php b/src/Models/StoreInformation.php new file mode 100644 index 0000000..a792ea3 --- /dev/null +++ b/src/Models/StoreInformation.php @@ -0,0 +1,105 @@ +storeId; + } + + /** + * Sets Store Id. + * The ID of a store for a merchant in the system of record. + * + * @maps store_id + */ + public function setStoreId(?string $storeId): void + { + $this->storeId = $storeId; + } + + /** + * Returns Terminal Id. + * The terminal ID for the checkout stand in a merchant store. + */ + public function getTerminalId(): ?string + { + return $this->terminalId; + } + + /** + * Sets Terminal Id. + * The terminal ID for the checkout stand in a merchant store. + * + * @maps terminal_id + */ + public function setTerminalId(?string $terminalId): void + { + $this->terminalId = $terminalId; + } + + /** + * Converts the StoreInformation object to a human-readable string representation. + * + * @return string The string representation of the StoreInformation object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'StoreInformation', + ['storeId' => $this->storeId, 'terminalId' => $this->terminalId] + ); + } + + /** + * 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->storeId)) { + $json['store_id'] = $this->storeId; + } + if (isset($this->terminalId)) { + $json['terminal_id'] = $this->terminalId; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/StoredPaymentSource.php b/src/Models/StoredPaymentSource.php index 502b905..ea51587 100644 --- a/src/Models/StoredPaymentSource.php +++ b/src/Models/StoredPaymentSource.php @@ -40,7 +40,7 @@ class StoredPaymentSource implements \JsonSerializable private $usage = StoredPaymentSourceUsageType::DERIVED; /** - * @var NetworkTransactionReference|null + * @var NetworkTransaction|null */ private $previousNetworkTransactionReference; @@ -122,7 +122,7 @@ class StoredPaymentSource implements \JsonSerializable * Returns Previous Network Transaction Reference. * Reference values used by the card network to identify a transaction. */ - public function getPreviousNetworkTransactionReference(): ?NetworkTransactionReference + public function getPreviousNetworkTransactionReference(): ?NetworkTransaction { return $this->previousNetworkTransactionReference; } @@ -134,7 +134,7 @@ class StoredPaymentSource implements \JsonSerializable * @maps previous_network_transaction_reference */ public function setPreviousNetworkTransactionReference( - ?NetworkTransactionReference $previousNetworkTransactionReference + ?NetworkTransaction $previousNetworkTransactionReference ): void { $this->previousNetworkTransactionReference = $previousNetworkTransactionReference; } diff --git a/src/Models/Subscriber.php b/src/Models/Subscriber.php new file mode 100644 index 0000000..725e5ce --- /dev/null +++ b/src/Models/Subscriber.php @@ -0,0 +1,137 @@ +name; + } + + /** + * Sets Name. + * The name of the party. + * + * @maps name + */ + public function setName(?Name $name): void + { + $this->name = $name; + } + + /** + * Returns Shipping Address. + * The shipping details. + */ + public function getShippingAddress(): ?ShippingDetails + { + return $this->shippingAddress; + } + + /** + * Sets Shipping Address. + * The shipping details. + * + * @maps shipping_address + */ + public function setShippingAddress(?ShippingDetails $shippingAddress): void + { + $this->shippingAddress = $shippingAddress; + } + + /** + * Returns Payment Source. + * The payment source used to fund the payment. + */ + public function getPaymentSource(): ?SubscriptionPaymentSourceResponse + { + return $this->paymentSource; + } + + /** + * Sets Payment Source. + * The payment source used to fund the payment. + * + * @maps payment_source + */ + public function setPaymentSource(?SubscriptionPaymentSourceResponse $paymentSource): void + { + $this->paymentSource = $paymentSource; + } + + /** + * Converts the Subscriber object to a human-readable string representation. + * + * @return string The string representation of the Subscriber object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'Subscriber', + [ + 'name' => $this->name, + 'shippingAddress' => $this->shippingAddress, + 'paymentSource' => $this->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->name)) { + $json['name'] = $this->name; + } + if (isset($this->shippingAddress)) { + $json['shipping_address'] = $this->shippingAddress; + } + if (isset($this->paymentSource)) { + $json['payment_source'] = $this->paymentSource; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/SubscriberRequest.php b/src/Models/SubscriberRequest.php new file mode 100644 index 0000000..eea093a --- /dev/null +++ b/src/Models/SubscriberRequest.php @@ -0,0 +1,170 @@ +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 Shipping Address. + * The shipping details. + */ + public function getShippingAddress(): ?ShippingDetails + { + return $this->shippingAddress; + } + + /** + * Sets Shipping Address. + * The shipping details. + * + * @maps shipping_address + */ + public function setShippingAddress(?ShippingDetails $shippingAddress): void + { + $this->shippingAddress = $shippingAddress; + } + + /** + * Returns Payment Source. + * The payment source definition. To be eligible to create subscription using debit or credit card, you + * will need to sign up here (https://www.paypal.com/bizsignup/entry/product/ppcp). Please note, its + * available only for non-3DS cards and for merchants in US and AU regions. + */ + public function getPaymentSource(): ?SubscriptionPaymentSource + { + return $this->paymentSource; + } + + /** + * Sets Payment Source. + * The payment source definition. To be eligible to create subscription using debit or credit card, you + * will need to sign up here (https://www.paypal.com/bizsignup/entry/product/ppcp). Please note, its + * available only for non-3DS cards and for merchants in US and AU regions. + * + * @maps payment_source + */ + public function setPaymentSource(?SubscriptionPaymentSource $paymentSource): void + { + $this->paymentSource = $paymentSource; + } + + /** + * Converts the SubscriberRequest object to a human-readable string representation. + * + * @return string The string representation of the SubscriberRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'SubscriberRequest', + [ + 'name' => $this->name, + 'phone' => $this->phone, + 'shippingAddress' => $this->shippingAddress, + 'paymentSource' => $this->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->name)) { + $json['name'] = $this->name; + } + if (isset($this->phone)) { + $json['phone'] = $this->phone; + } + if (isset($this->shippingAddress)) { + $json['shipping_address'] = $this->shippingAddress; + } + if (isset($this->paymentSource)) { + $json['payment_source'] = $this->paymentSource; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/Subscription.php b/src/Models/Subscription.php new file mode 100644 index 0000000..f62f2b4 --- /dev/null +++ b/src/Models/Subscription.php @@ -0,0 +1,445 @@ +id; + } + + /** + * Sets Id. + * The PayPal-generated ID for the subscription. + * + * @maps id + */ + public function setId(?string $id): void + { + $this->id = $id; + } + + /** + * Returns Plan Id. + * The ID of the plan. + */ + public function getPlanId(): ?string + { + return $this->planId; + } + + /** + * Sets Plan Id. + * The ID of the plan. + * + * @maps plan_id + */ + public function setPlanId(?string $planId): void + { + $this->planId = $planId; + } + + /** + * Returns Start 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 getStartTime(): ?string + { + return $this->startTime; + } + + /** + * Sets Start 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 start_time + */ + public function setStartTime(?string $startTime): void + { + $this->startTime = $startTime; + } + + /** + * Returns Quantity. + * The quantity of the product in the subscription. + */ + public function getQuantity(): ?string + { + return $this->quantity; + } + + /** + * Sets Quantity. + * The quantity of the product in the subscription. + * + * @maps quantity + */ + public function setQuantity(?string $quantity): void + { + $this->quantity = $quantity; + } + + /** + * Returns Shipping Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getShippingAmount(): ?Money + { + return $this->shippingAmount; + } + + /** + * Sets Shipping Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps shipping_amount + */ + public function setShippingAmount(?Money $shippingAmount): void + { + $this->shippingAmount = $shippingAmount; + } + + /** + * Returns Subscriber. + * The subscriber response information. + */ + public function getSubscriber(): ?Subscriber + { + return $this->subscriber; + } + + /** + * Sets Subscriber. + * The subscriber response information. + * + * @maps subscriber + */ + public function setSubscriber(?Subscriber $subscriber): void + { + $this->subscriber = $subscriber; + } + + /** + * Returns Billing Info. + * The billing details for the subscription. If the subscription was or is active, these fields are + * populated. + */ + public function getBillingInfo(): ?SubscriptionBillingInformation + { + return $this->billingInfo; + } + + /** + * Sets Billing Info. + * The billing details for the subscription. If the subscription was or is active, these fields are + * populated. + * + * @maps billing_info + */ + public function setBillingInfo(?SubscriptionBillingInformation $billingInfo): void + { + $this->billingInfo = $billingInfo; + } + + /** + * 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 Custom Id. + * The custom id for the subscription. Can be invoice id. + */ + public function getCustomId(): ?string + { + return $this->customId; + } + + /** + * Sets Custom Id. + * The custom id for the subscription. Can be invoice id. + * + * @maps custom_id + */ + public function setCustomId(?string $customId): void + { + $this->customId = $customId; + } + + /** + * Returns Plan Overridden. + * Indicates whether the subscription has overridden any plan attributes. + */ + public function getPlanOverridden(): ?bool + { + return $this->planOverridden; + } + + /** + * Sets Plan Overridden. + * Indicates whether the subscription has overridden any plan attributes. + * + * @maps plan_overridden + */ + public function setPlanOverridden(?bool $planOverridden): void + { + $this->planOverridden = $planOverridden; + } + + /** + * Returns Plan. + * The plan details. + */ + public function getPlan(): ?PlanDetails + { + return $this->plan; + } + + /** + * Sets Plan. + * The plan details. + * + * @maps plan + */ + public function setPlan(?PlanDetails $plan): void + { + $this->plan = $plan; + } + + /** + * Returns Links. + * An array of request-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 request-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; + } + + /** + * Converts the Subscription object to a human-readable string representation. + * + * @return string The string representation of the Subscription object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'Subscription', + [ + 'id' => $this->id, + 'planId' => $this->planId, + 'startTime' => $this->startTime, + 'quantity' => $this->quantity, + 'shippingAmount' => $this->shippingAmount, + 'subscriber' => $this->subscriber, + 'billingInfo' => $this->billingInfo, + 'createTime' => $this->createTime, + 'updateTime' => $this->updateTime, + 'customId' => $this->customId, + 'planOverridden' => $this->planOverridden, + 'plan' => $this->plan, + 'links' => $this->links + ] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + if (isset($this->id)) { + $json['id'] = $this->id; + } + if (isset($this->planId)) { + $json['plan_id'] = $this->planId; + } + if (isset($this->startTime)) { + $json['start_time'] = $this->startTime; + } + if (isset($this->quantity)) { + $json['quantity'] = $this->quantity; + } + if (isset($this->shippingAmount)) { + $json['shipping_amount'] = $this->shippingAmount; + } + if (isset($this->subscriber)) { + $json['subscriber'] = $this->subscriber; + } + if (isset($this->billingInfo)) { + $json['billing_info'] = $this->billingInfo; + } + if (isset($this->createTime)) { + $json['create_time'] = $this->createTime; + } + if (isset($this->updateTime)) { + $json['update_time'] = $this->updateTime; + } + if (isset($this->customId)) { + $json['custom_id'] = $this->customId; + } + if (isset($this->planOverridden)) { + $json['plan_overridden'] = $this->planOverridden; + } + if (isset($this->plan)) { + $json['plan'] = $this->plan; + } + if (isset($this->links)) { + $json['links'] = $this->links; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/SubscriptionAmountWithBreakdown.php b/src/Models/SubscriptionAmountWithBreakdown.php new file mode 100644 index 0000000..05b9b72 --- /dev/null +++ b/src/Models/SubscriptionAmountWithBreakdown.php @@ -0,0 +1,231 @@ +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 Total Item Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getTotalItemAmount(): ?Money + { + return $this->totalItemAmount; + } + + /** + * Sets Total Item Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps total_item_amount + */ + public function setTotalItemAmount(?Money $totalItemAmount): void + { + $this->totalItemAmount = $totalItemAmount; + } + + /** + * Returns Fee Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getFeeAmount(): ?Money + { + return $this->feeAmount; + } + + /** + * Sets Fee Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps fee_amount + */ + public function setFeeAmount(?Money $feeAmount): void + { + $this->feeAmount = $feeAmount; + } + + /** + * Returns Shipping Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getShippingAmount(): ?Money + { + return $this->shippingAmount; + } + + /** + * Sets Shipping Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps shipping_amount + */ + public function setShippingAmount(?Money $shippingAmount): void + { + $this->shippingAmount = $shippingAmount; + } + + /** + * Returns Tax Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getTaxAmount(): ?Money + { + return $this->taxAmount; + } + + /** + * Sets Tax Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps tax_amount + */ + public function setTaxAmount(?Money $taxAmount): void + { + $this->taxAmount = $taxAmount; + } + + /** + * 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; + } + + /** + * Converts the SubscriptionAmountWithBreakdown object to a human-readable string representation. + * + * @return string The string representation of the SubscriptionAmountWithBreakdown object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'SubscriptionAmountWithBreakdown', + [ + 'grossAmount' => $this->grossAmount, + 'totalItemAmount' => $this->totalItemAmount, + 'feeAmount' => $this->feeAmount, + 'shippingAmount' => $this->shippingAmount, + 'taxAmount' => $this->taxAmount, + 'netAmount' => $this->netAmount + ] + ); + } + + /** + * 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->totalItemAmount)) { + $json['total_item_amount'] = $this->totalItemAmount; + } + if (isset($this->feeAmount)) { + $json['fee_amount'] = $this->feeAmount; + } + if (isset($this->shippingAmount)) { + $json['shipping_amount'] = $this->shippingAmount; + } + if (isset($this->taxAmount)) { + $json['tax_amount'] = $this->taxAmount; + } + if (isset($this->netAmount)) { + $json['net_amount'] = $this->netAmount; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/SubscriptionApplicationContext.php b/src/Models/SubscriptionApplicationContext.php new file mode 100644 index 0000000..357efb3 --- /dev/null +++ b/src/Models/SubscriptionApplicationContext.php @@ -0,0 +1,266 @@ +returnUrl = $returnUrl; + $this->cancelUrl = $cancelUrl; + } + + /** + * Returns Brand Name. + * The label that overrides the business name in the PayPal account on the PayPal site. + */ + 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. + * + * @maps brand_name + */ + public function setBrandName(?string $brandName): void + { + $this->brandName = $brandName; + } + + /** + * Returns Locale. + * The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a + * five-character code. For example, `da-DK`, `he-IL`, `id-ID`, `ja-JP`, `no-NO`, `pt-BR`, `ru-RU`, `sv- + * SE`, `th-TH`, `zh-CN`, `zh-HK`, or `zh-TW`. + */ + public function getLocale(): ?string + { + return $this->locale; + } + + /** + * Sets Locale. + * The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a + * five-character code. For example, `da-DK`, `he-IL`, `id-ID`, `ja-JP`, `no-NO`, `pt-BR`, `ru-RU`, `sv- + * SE`, `th-TH`, `zh-CN`, `zh-HK`, or `zh-TW`. + * + * @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 User Action. + * Configures the label name to `Continue` or `Subscribe Now` for subscription consent experience. + */ + public function getUserAction(): ?string + { + return $this->userAction; + } + + /** + * Sets User Action. + * Configures the label name to `Continue` or `Subscribe Now` for subscription consent experience. + * + * @maps user_action + */ + public function setUserAction(?string $userAction): void + { + $this->userAction = $userAction; + } + + /** + * Returns Payment Method. + * The customer and merchant payment preferences. + */ + public function getPaymentMethod(): ?PaymentMethod + { + return $this->paymentMethod; + } + + /** + * Sets Payment Method. + * The customer and merchant payment preferences. + * + * @maps payment_method + */ + public function setPaymentMethod(?PaymentMethod $paymentMethod): void + { + $this->paymentMethod = $paymentMethod; + } + + /** + * 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. + * + * @required + * @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. + * + * @required + * @maps cancel_url + */ + public function setCancelUrl(string $cancelUrl): void + { + $this->cancelUrl = $cancelUrl; + } + + /** + * Converts the SubscriptionApplicationContext object to a human-readable string representation. + * + * @return string The string representation of the SubscriptionApplicationContext object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'SubscriptionApplicationContext', + [ + 'brandName' => $this->brandName, + 'locale' => $this->locale, + 'shippingPreference' => $this->shippingPreference, + 'userAction' => $this->userAction, + 'paymentMethod' => $this->paymentMethod, + 'returnUrl' => $this->returnUrl, + 'cancelUrl' => $this->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'] = $this->shippingPreference; + } + if (isset($this->userAction)) { + $json['user_action'] = $this->userAction; + } + if (isset($this->paymentMethod)) { + $json['payment_method'] = $this->paymentMethod; + } + $json['return_url'] = $this->returnUrl; + $json['cancel_url'] = $this->cancelUrl; + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/SubscriptionBillingCycle.php b/src/Models/SubscriptionBillingCycle.php new file mode 100644 index 0000000..3f2c46c --- /dev/null +++ b/src/Models/SubscriptionBillingCycle.php @@ -0,0 +1,216 @@ +frequency = $frequency; + $this->tenureType = $tenureType; + $this->sequence = $sequence; + } + + /** + * Returns Pricing Scheme. + * The pricing scheme details. + */ + public function getPricingScheme(): ?SubscriptionPricingScheme + { + return $this->pricingScheme; + } + + /** + * Sets Pricing Scheme. + * The pricing scheme details. + * + * @maps pricing_scheme + */ + public function setPricingScheme(?SubscriptionPricingScheme $pricingScheme): void + { + $this->pricingScheme = $pricingScheme; + } + + /** + * Returns Frequency. + * The frequency of the billing cycle. + */ + public function getFrequency(): Frequency + { + return $this->frequency; + } + + /** + * Sets Frequency. + * The frequency of the billing cycle. + * + * @required + * @maps frequency + */ + public function setFrequency(Frequency $frequency): void + { + $this->frequency = $frequency; + } + + /** + * Returns Tenure Type. + * The tenure type of the billing cycle. In case of a plan having trial cycle, only 2 trial cycles are + * allowed per plan. + */ + public function getTenureType(): string + { + return $this->tenureType; + } + + /** + * Sets Tenure Type. + * The tenure type of the billing cycle. In case of a plan having trial cycle, only 2 trial cycles are + * allowed per plan. + * + * @required + * @maps tenure_type + */ + public function setTenureType(string $tenureType): void + { + $this->tenureType = $tenureType; + } + + /** + * Returns Sequence. + * The order in which this cycle is to run among other billing cycles. For example, a trial billing + * cycle has a `sequence` of `1` while a regular billing cycle has a `sequence` of `2`, so that trial + * cycle runs before the regular cycle. + */ + public function getSequence(): int + { + return $this->sequence; + } + + /** + * Sets Sequence. + * The order in which this cycle is to run among other billing cycles. For example, a trial billing + * cycle has a `sequence` of `1` while a regular billing cycle has a `sequence` of `2`, so that trial + * cycle runs before the regular cycle. + * + * @required + * @maps sequence + */ + public function setSequence(int $sequence): void + { + $this->sequence = $sequence; + } + + /** + * Returns Total Cycles. + * The number of times this billing cycle gets executed. Trial billing cycles can only be executed a + * finite number of times (value between 1 and 999 for total_cycles). Regular billing cycles can be + * executed infinite times (value of 0 for total_cycles) or a finite number of times (value between 1 + * and 999 for total_cycles). + */ + public function getTotalCycles(): ?int + { + return $this->totalCycles; + } + + /** + * Sets Total Cycles. + * The number of times this billing cycle gets executed. Trial billing cycles can only be executed a + * finite number of times (value between 1 and 999 for total_cycles). Regular billing cycles can be + * executed infinite times (value of 0 for total_cycles) or a finite number of times (value between 1 + * and 999 for total_cycles). + * + * @maps total_cycles + */ + public function setTotalCycles(?int $totalCycles): void + { + $this->totalCycles = $totalCycles; + } + + /** + * Converts the SubscriptionBillingCycle object to a human-readable string representation. + * + * @return string The string representation of the SubscriptionBillingCycle object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'SubscriptionBillingCycle', + [ + 'pricingScheme' => $this->pricingScheme, + 'frequency' => $this->frequency, + 'tenureType' => $this->tenureType, + 'sequence' => $this->sequence, + 'totalCycles' => $this->totalCycles + ] + ); + } + + /** + * 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->pricingScheme)) { + $json['pricing_scheme'] = $this->pricingScheme; + } + $json['frequency'] = $this->frequency; + $json['tenure_type'] = $this->tenureType; + $json['sequence'] = $this->sequence; + if (isset($this->totalCycles)) { + $json['total_cycles'] = $this->totalCycles; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/SubscriptionBillingInformation.php b/src/Models/SubscriptionBillingInformation.php new file mode 100644 index 0000000..e243eca --- /dev/null +++ b/src/Models/SubscriptionBillingInformation.php @@ -0,0 +1,276 @@ +outstandingBalance = $outstandingBalance; + $this->failedPaymentsCount = $failedPaymentsCount; + } + + /** + * Returns Outstanding Balance. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getOutstandingBalance(): Money + { + return $this->outstandingBalance; + } + + /** + * Sets Outstanding Balance. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @required + * @maps outstanding_balance + */ + public function setOutstandingBalance(Money $outstandingBalance): void + { + $this->outstandingBalance = $outstandingBalance; + } + + /** + * Returns Cycle Executions. + * The trial and regular billing executions. + * + * @return CycleExecution[]|null + */ + public function getCycleExecutions(): ?array + { + return $this->cycleExecutions; + } + + /** + * Sets Cycle Executions. + * The trial and regular billing executions. + * + * @maps cycle_executions + * + * @param CycleExecution[]|null $cycleExecutions + */ + public function setCycleExecutions(?array $cycleExecutions): void + { + $this->cycleExecutions = $cycleExecutions; + } + + /** + * Returns Last Payment. + * The details for the last payment. + */ + public function getLastPayment(): ?LastPaymentDetails + { + return $this->lastPayment; + } + + /** + * Sets Last Payment. + * The details for the last payment. + * + * @maps last_payment + */ + public function setLastPayment(?LastPaymentDetails $lastPayment): void + { + $this->lastPayment = $lastPayment; + } + + /** + * Returns Next Billing 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 getNextBillingTime(): ?string + { + return $this->nextBillingTime; + } + + /** + * Sets Next Billing 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 next_billing_time + */ + public function setNextBillingTime(?string $nextBillingTime): void + { + $this->nextBillingTime = $nextBillingTime; + } + + /** + * Returns Final Payment 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 getFinalPaymentTime(): ?string + { + return $this->finalPaymentTime; + } + + /** + * Sets Final Payment 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 final_payment_time + */ + public function setFinalPaymentTime(?string $finalPaymentTime): void + { + $this->finalPaymentTime = $finalPaymentTime; + } + + /** + * Returns Failed Payments Count. + * The number of consecutive payment failures. Resets to `0` after a successful payment. If this + * reaches the `payment_failure_threshold` value, the subscription updates to the `SUSPENDED` state. + */ + public function getFailedPaymentsCount(): int + { + return $this->failedPaymentsCount; + } + + /** + * Sets Failed Payments Count. + * The number of consecutive payment failures. Resets to `0` after a successful payment. If this + * reaches the `payment_failure_threshold` value, the subscription updates to the `SUSPENDED` state. + * + * @required + * @maps failed_payments_count + */ + public function setFailedPaymentsCount(int $failedPaymentsCount): void + { + $this->failedPaymentsCount = $failedPaymentsCount; + } + + /** + * Returns Last Failed Payment. + * The details for the failed payment of the subscription. + */ + public function getLastFailedPayment(): ?FailedPaymentDetails + { + return $this->lastFailedPayment; + } + + /** + * Sets Last Failed Payment. + * The details for the failed payment of the subscription. + * + * @maps last_failed_payment + */ + public function setLastFailedPayment(?FailedPaymentDetails $lastFailedPayment): void + { + $this->lastFailedPayment = $lastFailedPayment; + } + + /** + * Converts the SubscriptionBillingInformation object to a human-readable string representation. + * + * @return string The string representation of the SubscriptionBillingInformation object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'SubscriptionBillingInformation', + [ + 'outstandingBalance' => $this->outstandingBalance, + 'cycleExecutions' => $this->cycleExecutions, + 'lastPayment' => $this->lastPayment, + 'nextBillingTime' => $this->nextBillingTime, + 'finalPaymentTime' => $this->finalPaymentTime, + 'failedPaymentsCount' => $this->failedPaymentsCount, + 'lastFailedPayment' => $this->lastFailedPayment + ] + ); + } + + /** + * 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['outstanding_balance'] = $this->outstandingBalance; + if (isset($this->cycleExecutions)) { + $json['cycle_executions'] = $this->cycleExecutions; + } + if (isset($this->lastPayment)) { + $json['last_payment'] = $this->lastPayment; + } + if (isset($this->nextBillingTime)) { + $json['next_billing_time'] = $this->nextBillingTime; + } + if (isset($this->finalPaymentTime)) { + $json['final_payment_time'] = $this->finalPaymentTime; + } + $json['failed_payments_count'] = $this->failedPaymentsCount; + if (isset($this->lastFailedPayment)) { + $json['last_failed_payment'] = $this->lastFailedPayment; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/SubscriptionCardRequest.php b/src/Models/SubscriptionCardRequest.php new file mode 100644 index 0000000..2fca8aa --- /dev/null +++ b/src/Models/SubscriptionCardRequest.php @@ -0,0 +1,292 @@ +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 Attributes. + * Additional attributes associated with the use of this card. + */ + public function getAttributes(): ?SubscriptionsCardAttributes + { + return $this->attributes; + } + + /** + * Sets Attributes. + * Additional attributes associated with the use of this card. + * + * @maps attributes + */ + public function setAttributes(?SubscriptionsCardAttributes $attributes): void + { + $this->attributes = $attributes; + } + + /** + * Converts the SubscriptionCardRequest object to a human-readable string representation. + * + * @return string The string representation of the SubscriptionCardRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'SubscriptionCardRequest', + [ + 'name' => $this->name, + 'number' => $this->number, + 'expiry' => $this->expiry, + 'securityCode' => $this->securityCode, + 'type' => $this->type, + 'brand' => $this->brand, + 'billingAddress' => $this->billingAddress, + 'attributes' => $this->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->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'] = $this->type; + } + if (isset($this->brand)) { + $json['brand'] = $this->brand; + } + if (isset($this->billingAddress)) { + $json['billing_address'] = $this->billingAddress; + } + if (isset($this->attributes)) { + $json['attributes'] = $this->attributes; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/SubscriptionCollection.php b/src/Models/SubscriptionCollection.php new file mode 100644 index 0000000..cfa4a49 --- /dev/null +++ b/src/Models/SubscriptionCollection.php @@ -0,0 +1,113 @@ +subscriptions; + } + + /** + * Sets Subscriptions. + * An array of subscriptions. + * + * @maps subscriptions + * + * @param Subscription[]|null $subscriptions + */ + public function setSubscriptions(?array $subscriptions): void + { + $this->subscriptions = $subscriptions; + } + + /** + * Returns Links. + * An array of request-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 request-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; + } + + /** + * Converts the SubscriptionCollection object to a human-readable string representation. + * + * @return string The string representation of the SubscriptionCollection object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'SubscriptionCollection', + ['subscriptions' => $this->subscriptions, 'links' => $this->links] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + if (isset($this->subscriptions)) { + $json['subscriptions'] = $this->subscriptions; + } + if (isset($this->links)) { + $json['links'] = $this->links; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/SubscriptionCustomerInformation.php b/src/Models/SubscriptionCustomerInformation.php new file mode 100644 index 0000000..4bba2f6 --- /dev/null +++ b/src/Models/SubscriptionCustomerInformation.php @@ -0,0 +1,137 @@ +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; + } + + /** + * Converts the SubscriptionCustomerInformation object to a human-readable string representation. + * + * @return string The string representation of the SubscriptionCustomerInformation object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'SubscriptionCustomerInformation', + ['id' => $this->id, 'emailAddress' => $this->emailAddress, 'phone' => $this->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/SubscriptionPatchApplicationContext.php b/src/Models/SubscriptionPatchApplicationContext.php new file mode 100644 index 0000000..0f32ab5 --- /dev/null +++ b/src/Models/SubscriptionPatchApplicationContext.php @@ -0,0 +1,237 @@ +returnUrl = $returnUrl; + $this->cancelUrl = $cancelUrl; + } + + /** + * Returns Brand Name. + * The label that overrides the business name in the PayPal account on the PayPal site. + */ + 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. + * + * @maps brand_name + */ + public function setBrandName(?string $brandName): void + { + $this->brandName = $brandName; + } + + /** + * Returns Locale. + * The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a + * five-character code. For example, `da-DK`, `he-IL`, `id-ID`, `ja-JP`, `no-NO`, `pt-BR`, `ru-RU`, `sv- + * SE`, `th-TH`, `zh-CN`, `zh-HK`, or `zh-TW`. + */ + public function getLocale(): ?string + { + return $this->locale; + } + + /** + * Sets Locale. + * The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a + * five-character code. For example, `da-DK`, `he-IL`, `id-ID`, `ja-JP`, `no-NO`, `pt-BR`, `ru-RU`, `sv- + * SE`, `th-TH`, `zh-CN`, `zh-HK`, or `zh-TW`. + * + * @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 Payment Method. + * The customer and merchant payment preferences. + */ + public function getPaymentMethod(): ?PaymentMethod + { + return $this->paymentMethod; + } + + /** + * Sets Payment Method. + * The customer and merchant payment preferences. + * + * @maps payment_method + */ + public function setPaymentMethod(?PaymentMethod $paymentMethod): void + { + $this->paymentMethod = $paymentMethod; + } + + /** + * 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. + * + * @required + * @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. + * + * @required + * @maps cancel_url + */ + public function setCancelUrl(string $cancelUrl): void + { + $this->cancelUrl = $cancelUrl; + } + + /** + * Converts the SubscriptionPatchApplicationContext object to a human-readable string representation. + * + * @return string The string representation of the SubscriptionPatchApplicationContext object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'SubscriptionPatchApplicationContext', + [ + 'brandName' => $this->brandName, + 'locale' => $this->locale, + 'shippingPreference' => $this->shippingPreference, + 'paymentMethod' => $this->paymentMethod, + 'returnUrl' => $this->returnUrl, + 'cancelUrl' => $this->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'] = $this->shippingPreference; + } + if (isset($this->paymentMethod)) { + $json['payment_method'] = $this->paymentMethod; + } + $json['return_url'] = $this->returnUrl; + $json['cancel_url'] = $this->cancelUrl; + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/SubscriptionPayerName.php b/src/Models/SubscriptionPayerName.php new file mode 100644 index 0000000..7f2c952 --- /dev/null +++ b/src/Models/SubscriptionPayerName.php @@ -0,0 +1,230 @@ +prefix; + } + + /** + * Sets Prefix. + * The prefix, or title, to the party's name. + * + * @maps prefix + */ + public function setPrefix(?string $prefix): void + { + $this->prefix = $prefix; + } + + /** + * Returns Given Name. + * When the party is a person, the party's given, or first, name. + */ + public function getGivenName(): ?string + { + return $this->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; + } + + /** + * Returns Middle Name. + * When the party is a person, the party's middle name. Use also to store multiple middle names + * including the patronymic, or father's, middle name. + */ + public function getMiddleName(): ?string + { + return $this->middleName; + } + + /** + * Sets Middle Name. + * When the party is a person, the party's middle name. Use also to store multiple middle names + * including the patronymic, or father's, middle name. + * + * @maps middle_name + */ + public function setMiddleName(?string $middleName): void + { + $this->middleName = $middleName; + } + + /** + * Returns Suffix. + * The suffix for the party's name. + */ + public function getSuffix(): ?string + { + return $this->suffix; + } + + /** + * Sets Suffix. + * The suffix for the party's name. + * + * @maps suffix + */ + public function setSuffix(?string $suffix): void + { + $this->suffix = $suffix; + } + + /** + * Returns Full Name. + * When the party is a person, the party's full name. + */ + public function getFullName(): ?string + { + return $this->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; + } + + /** + * Converts the SubscriptionPayerName object to a human-readable string representation. + * + * @return string The string representation of the SubscriptionPayerName object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'SubscriptionPayerName', + [ + 'prefix' => $this->prefix, + 'givenName' => $this->givenName, + 'surname' => $this->surname, + 'middleName' => $this->middleName, + 'suffix' => $this->suffix, + 'fullName' => $this->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->prefix)) { + $json['prefix'] = $this->prefix; + } + if (isset($this->givenName)) { + $json['given_name'] = $this->givenName; + } + if (isset($this->surname)) { + $json['surname'] = $this->surname; + } + if (isset($this->middleName)) { + $json['middle_name'] = $this->middleName; + } + if (isset($this->suffix)) { + $json['suffix'] = $this->suffix; + } + if (isset($this->fullName)) { + $json['full_name'] = $this->fullName; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/SubscriptionPaymentSource.php b/src/Models/SubscriptionPaymentSource.php new file mode 100644 index 0000000..8458ce9 --- /dev/null +++ b/src/Models/SubscriptionPaymentSource.php @@ -0,0 +1,76 @@ +card; + } + + /** + * Sets Card. + * The payment card to use to fund a payment. Can be a credit or debit card. + * + * @maps card + */ + public function setCard(?SubscriptionCardRequest $card): void + { + $this->card = $card; + } + + /** + * Converts the SubscriptionPaymentSource object to a human-readable string representation. + * + * @return string The string representation of the SubscriptionPaymentSource object. + */ + public function __toString(): string + { + return ApiHelper::stringify('SubscriptionPaymentSource', ['card' => $this->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/SubscriptionPaymentSourceResponse.php b/src/Models/SubscriptionPaymentSourceResponse.php new file mode 100644 index 0000000..c4e15ac --- /dev/null +++ b/src/Models/SubscriptionPaymentSourceResponse.php @@ -0,0 +1,74 @@ +card; + } + + /** + * Sets Card. + * The payment card used to fund the payment. Card can be a credit or debit card. + * + * @maps card + */ + public function setCard(?CardResponseWithBillingAddress $card): void + { + $this->card = $card; + } + + /** + * Converts the SubscriptionPaymentSourceResponse object to a human-readable string representation. + * + * @return string The string representation of the SubscriptionPaymentSourceResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify('SubscriptionPaymentSourceResponse', ['card' => $this->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/SubscriptionPlanStatus.php b/src/Models/SubscriptionPlanStatus.php new file mode 100644 index 0000000..fa8710f --- /dev/null +++ b/src/Models/SubscriptionPlanStatus.php @@ -0,0 +1,32 @@ +version; + } + + /** + * Sets Version. + * The version of the pricing scheme. + * + * @maps version + */ + public function setVersion(?int $version): void + { + $this->version = $version; + } + + /** + * Returns Fixed Price. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getFixedPrice(): ?Money + { + return $this->fixedPrice; + } + + /** + * Sets Fixed Price. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps fixed_price + */ + public function setFixedPrice(?Money $fixedPrice): void + { + $this->fixedPrice = $fixedPrice; + } + + /** + * Returns Pricing Model. + * The pricing model for tiered plan. The `tiers` parameter is required. + */ + public function getPricingModel(): ?string + { + return $this->pricingModel; + } + + /** + * Sets Pricing Model. + * The pricing model for tiered plan. The `tiers` parameter is required. + * + * @maps pricing_model + */ + public function setPricingModel(?string $pricingModel): void + { + $this->pricingModel = $pricingModel; + } + + /** + * Returns Tiers. + * An array of pricing tiers which are used for billing volume/tiered plans. pricing_model field has to + * be specified. + * + * @return PricingTier[]|null + */ + public function getTiers(): ?array + { + return $this->tiers; + } + + /** + * Sets Tiers. + * An array of pricing tiers which are used for billing volume/tiered plans. pricing_model field has to + * be specified. + * + * @maps tiers + * + * @param PricingTier[]|null $tiers + */ + public function setTiers(?array $tiers): void + { + $this->tiers = $tiers; + } + + /** + * Returns Create Time. + * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. + * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. + */ + public function getCreateTime(): ?string + { + return $this->createTime; + } + + /** + * Sets Create Time. + * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. + * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. + * + * @maps create_time + */ + public function setCreateTime(?string $createTime): void + { + $this->createTime = $createTime; + } + + /** + * Returns Update Time. + * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. + * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. + */ + public function getUpdateTime(): ?string + { + return $this->updateTime; + } + + /** + * Sets Update Time. + * The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5. + * 6). Seconds are required while fractional seconds are optional. Note: The regular expression + * provides guidance but does not reject all invalid dates. + * + * @maps update_time + */ + public function setUpdateTime(?string $updateTime): void + { + $this->updateTime = $updateTime; + } + + /** + * Converts the SubscriptionPricingScheme object to a human-readable string representation. + * + * @return string The string representation of the SubscriptionPricingScheme object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'SubscriptionPricingScheme', + [ + 'version' => $this->version, + 'fixedPrice' => $this->fixedPrice, + 'pricingModel' => $this->pricingModel, + 'tiers' => $this->tiers, + 'createTime' => $this->createTime, + 'updateTime' => $this->updateTime + ] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + if (isset($this->version)) { + $json['version'] = $this->version; + } + if (isset($this->fixedPrice)) { + $json['fixed_price'] = $this->fixedPrice; + } + if (isset($this->pricingModel)) { + $json['pricing_model'] = $this->pricingModel; + } + if (isset($this->tiers)) { + $json['tiers'] = $this->tiers; + } + 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/SubscriptionTransactionDetails.php b/src/Models/SubscriptionTransactionDetails.php new file mode 100644 index 0000000..b6abfb2 --- /dev/null +++ b/src/Models/SubscriptionTransactionDetails.php @@ -0,0 +1,241 @@ +id = $id; + $this->amountWithBreakdown = $amountWithBreakdown; + $this->time = $time; + } + + /** + * Returns Status. + * The status of the captured payment. + */ + public function getStatus(): ?string + { + return $this->status; + } + + /** + * Sets Status. + * The status of the captured payment. + * + * @maps status + */ + public function setStatus(?string $status): void + { + $this->status = $status; + } + + /** + * Returns Id. + * The PayPal-generated transaction ID. + */ + public function getId(): string + { + return $this->id; + } + + /** + * Sets Id. + * The PayPal-generated transaction ID. + * + * @required + * @maps id + */ + public function setId(string $id): void + { + $this->id = $id; + } + + /** + * Returns Amount With Breakdown. + * The breakdown details for the amount. Includes the gross, tax, fee, and shipping amounts. + */ + public function getAmountWithBreakdown(): SubscriptionAmountWithBreakdown + { + return $this->amountWithBreakdown; + } + + /** + * Sets Amount With Breakdown. + * The breakdown details for the amount. Includes the gross, tax, fee, and shipping amounts. + * + * @required + * @maps amount_with_breakdown + */ + public function setAmountWithBreakdown(SubscriptionAmountWithBreakdown $amountWithBreakdown): void + { + $this->amountWithBreakdown = $amountWithBreakdown; + } + + /** + * Returns Payer Name. + * The name of the party. + */ + public function getPayerName(): ?SubscriptionPayerName + { + return $this->payerName; + } + + /** + * Sets Payer Name. + * The name of the party. + * + * @maps payer_name + */ + public function setPayerName(?SubscriptionPayerName $payerName): void + { + $this->payerName = $payerName; + } + + /** + * Returns Payer 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 getPayerEmail(): ?string + { + return $this->payerEmail; + } + + /** + * Sets Payer 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 payer_email + */ + public function setPayerEmail(?string $payerEmail): void + { + $this->payerEmail = $payerEmail; + } + + /** + * 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. + * + * @required + * @maps time + */ + public function setTime(string $time): void + { + $this->time = $time; + } + + /** + * Converts the SubscriptionTransactionDetails object to a human-readable string representation. + * + * @return string The string representation of the SubscriptionTransactionDetails object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'SubscriptionTransactionDetails', + [ + 'status' => $this->status, + 'id' => $this->id, + 'amountWithBreakdown' => $this->amountWithBreakdown, + 'payerName' => $this->payerName, + 'payerEmail' => $this->payerEmail, + 'time' => $this->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 = []; + if (isset($this->status)) { + $json['status'] = $this->status; + } + $json['id'] = $this->id; + $json['amount_with_breakdown'] = $this->amountWithBreakdown; + if (isset($this->payerName)) { + $json['payer_name'] = $this->payerName; + } + if (isset($this->payerEmail)) { + $json['payer_email'] = $this->payerEmail; + } + $json['time'] = $this->time; + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/SubscriptionsCardAttributes.php b/src/Models/SubscriptionsCardAttributes.php new file mode 100644 index 0000000..65e67b8 --- /dev/null +++ b/src/Models/SubscriptionsCardAttributes.php @@ -0,0 +1,137 @@ +customer; + } + + /** + * Sets Customer. + * The details about a customer in PayPal's system of record. + * + * @maps customer + */ + public function setCustomer(?CardCustomer $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; + } + + /** + * Converts the SubscriptionsCardAttributes object to a human-readable string representation. + * + * @return string The string representation of the SubscriptionsCardAttributes object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'SubscriptionsCardAttributes', + ['customer' => $this->customer, 'vault' => $this->vault, 'verification' => $this->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/SubscriptionsCardBrand.php b/src/Models/SubscriptionsCardBrand.php new file mode 100644 index 0000000..d52d9d4 --- /dev/null +++ b/src/Models/SubscriptionsCardBrand.php @@ -0,0 +1,143 @@ +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; - } - - /** - * Converts the SupplementaryPurchaseData object to a human-readable string representation. - * - * @return string The string representation of the SupplementaryPurchaseData object. - */ - public function __toString(): string - { - return ApiHelper::stringify( - 'SupplementaryPurchaseData', - ['invoiceId' => $this->invoiceId, 'noteToPayer' => $this->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/SuspendSubscription.php b/src/Models/SuspendSubscription.php new file mode 100644 index 0000000..f19fa0a --- /dev/null +++ b/src/Models/SuspendSubscription.php @@ -0,0 +1,81 @@ +reason = $reason; + } + + /** + * Returns Reason. + * The reason for suspension of the Subscription. + */ + public function getReason(): string + { + return $this->reason; + } + + /** + * Sets Reason. + * The reason for suspension of the Subscription. + * + * @required + * @maps reason + */ + public function setReason(string $reason): void + { + $this->reason = $reason; + } + + /** + * Converts the SuspendSubscription object to a human-readable string representation. + * + * @return string The string representation of the SuspendSubscription object. + */ + public function __toString(): string + { + return ApiHelper::stringify('SuspendSubscription', ['reason' => $this->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 = []; + $json['reason'] = $this->reason; + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/TaxAmount.php b/src/Models/TaxAmount.php new file mode 100644 index 0000000..b20e1bb --- /dev/null +++ b/src/Models/TaxAmount.php @@ -0,0 +1,74 @@ +taxAmount; + } + + /** + * Sets Tax Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps tax_amount + */ + public function setTaxAmount(?Money $taxAmount): void + { + $this->taxAmount = $taxAmount; + } + + /** + * Converts the TaxAmount object to a human-readable string representation. + * + * @return string The string representation of the TaxAmount object. + */ + public function __toString(): string + { + return ApiHelper::stringify('TaxAmount', ['taxAmount' => $this->taxAmount]); + } + + /** + * 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->taxAmount)) { + $json['tax_amount'] = $this->taxAmount; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/Taxes.php b/src/Models/Taxes.php new file mode 100644 index 0000000..f53625d --- /dev/null +++ b/src/Models/Taxes.php @@ -0,0 +1,111 @@ +percentage = $percentage; + } + + /** + * Returns Percentage. + * The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate + * as `19.99`. + */ + public function getPercentage(): string + { + return $this->percentage; + } + + /** + * Sets Percentage. + * The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate + * as `19.99`. + * + * @required + * @maps percentage + */ + public function setPercentage(string $percentage): void + { + $this->percentage = $percentage; + } + + /** + * Returns Inclusive. + * Indicates whether the tax was already included in the billing amount. + */ + public function getInclusive(): ?bool + { + return $this->inclusive; + } + + /** + * Sets Inclusive. + * Indicates whether the tax was already included in the billing amount. + * + * @maps inclusive + */ + public function setInclusive(?bool $inclusive): void + { + $this->inclusive = $inclusive; + } + + /** + * Converts the Taxes object to a human-readable string representation. + * + * @return string The string representation of the Taxes object. + */ + public function __toString(): string + { + return ApiHelper::stringify('Taxes', ['percentage' => $this->percentage, 'inclusive' => $this->inclusive]); + } + + /** + * 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['percentage'] = $this->percentage; + if (isset($this->inclusive)) { + $json['inclusive'] = $this->inclusive; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/TaxesOverride.php b/src/Models/TaxesOverride.php new file mode 100644 index 0000000..c243939 --- /dev/null +++ b/src/Models/TaxesOverride.php @@ -0,0 +1,107 @@ +percentage; + } + + /** + * Sets Percentage. + * The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate + * as `19.99`. + * + * @maps percentage + */ + public function setPercentage(?string $percentage): void + { + $this->percentage = $percentage; + } + + /** + * Returns Inclusive. + * Indicates whether the tax was already included in the billing amount. + */ + public function getInclusive(): ?bool + { + return $this->inclusive; + } + + /** + * Sets Inclusive. + * Indicates whether the tax was already included in the billing amount. + * + * @maps inclusive + */ + public function setInclusive(?bool $inclusive): void + { + $this->inclusive = $inclusive; + } + + /** + * Converts the TaxesOverride object to a human-readable string representation. + * + * @return string The string representation of the TaxesOverride object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'TaxesOverride', + ['percentage' => $this->percentage, 'inclusive' => $this->inclusive] + ); + } + + /** + * 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->percentage)) { + $json['percentage'] = $this->percentage; + } + if (isset($this->inclusive)) { + $json['inclusive'] = $this->inclusive; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/TenureType.php b/src/Models/TenureType.php index 5454a91..aaf32cc 100644 --- a/src/Models/TenureType.php +++ b/src/Models/TenureType.php @@ -12,7 +12,8 @@ namespace PaypalServerSdkLib\Models; /** * The tenure type of the billing cycle identifies if the billing cycle is a trial(free or discounted) - * or regular billing cycle. + * or regular billing cycle., The tenure type of the billing cycle. In case of a plan having trial + * cycle, only 2 trial cycles are allowed per plan., The type of the billing cycle. */ class TenureType { diff --git a/src/Models/TransactionDetails.php b/src/Models/TransactionDetails.php new file mode 100644 index 0000000..0e79aaf --- /dev/null +++ b/src/Models/TransactionDetails.php @@ -0,0 +1,253 @@ +transactionInfo; + } + + /** + * Sets Transaction Info. + * The transaction information. + * + * @maps transaction_info + */ + public function setTransactionInfo(?TransactionInformation $transactionInfo): void + { + $this->transactionInfo = $transactionInfo; + } + + /** + * Returns Payer Info. + * The payer information. + */ + public function getPayerInfo(): ?PayerInformation + { + return $this->payerInfo; + } + + /** + * Sets Payer Info. + * The payer information. + * + * @maps payer_info + */ + public function setPayerInfo(?PayerInformation $payerInfo): void + { + $this->payerInfo = $payerInfo; + } + + /** + * Returns Shipping Info. + * The shipping information. + */ + public function getShippingInfo(): ?ShippingInformation + { + return $this->shippingInfo; + } + + /** + * Sets Shipping Info. + * The shipping information. + * + * @maps shipping_info + */ + public function setShippingInfo(?ShippingInformation $shippingInfo): void + { + $this->shippingInfo = $shippingInfo; + } + + /** + * Returns Cart Info. + * The cart information. + */ + public function getCartInfo(): ?CartInformation + { + return $this->cartInfo; + } + + /** + * Sets Cart Info. + * The cart information. + * + * @maps cart_info + */ + public function setCartInfo(?CartInformation $cartInfo): void + { + $this->cartInfo = $cartInfo; + } + + /** + * Returns Store Info. + * The store information. + */ + public function getStoreInfo(): ?StoreInformation + { + return $this->storeInfo; + } + + /** + * Sets Store Info. + * The store information. + * + * @maps store_info + */ + public function setStoreInfo(?StoreInformation $storeInfo): void + { + $this->storeInfo = $storeInfo; + } + + /** + * Returns Auction Info. + * The auction information. + */ + public function getAuctionInfo(): ?AuctionInformation + { + return $this->auctionInfo; + } + + /** + * Sets Auction Info. + * The auction information. + * + * @maps auction_info + */ + public function setAuctionInfo(?AuctionInformation $auctionInfo): void + { + $this->auctionInfo = $auctionInfo; + } + + /** + * Returns Incentive Info. + * The incentive details. + */ + public function getIncentiveInfo(): ?IncentiveInformation + { + return $this->incentiveInfo; + } + + /** + * Sets Incentive Info. + * The incentive details. + * + * @maps incentive_info + */ + public function setIncentiveInfo(?IncentiveInformation $incentiveInfo): void + { + $this->incentiveInfo = $incentiveInfo; + } + + /** + * Converts the TransactionDetails object to a human-readable string representation. + * + * @return string The string representation of the TransactionDetails object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'TransactionDetails', + [ + 'transactionInfo' => $this->transactionInfo, + 'payerInfo' => $this->payerInfo, + 'shippingInfo' => $this->shippingInfo, + 'cartInfo' => $this->cartInfo, + 'storeInfo' => $this->storeInfo, + 'auctionInfo' => $this->auctionInfo, + 'incentiveInfo' => $this->incentiveInfo + ] + ); + } + + /** + * 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->transactionInfo)) { + $json['transaction_info'] = $this->transactionInfo; + } + if (isset($this->payerInfo)) { + $json['payer_info'] = $this->payerInfo; + } + if (isset($this->shippingInfo)) { + $json['shipping_info'] = $this->shippingInfo; + } + if (isset($this->cartInfo)) { + $json['cart_info'] = $this->cartInfo; + } + if (isset($this->storeInfo)) { + $json['store_info'] = $this->storeInfo; + } + if (isset($this->auctionInfo)) { + $json['auction_info'] = $this->auctionInfo; + } + if (isset($this->incentiveInfo)) { + $json['incentive_info'] = $this->incentiveInfo; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/TransactionInformation.php b/src/Models/TransactionInformation.php new file mode 100644 index 0000000..2374437 --- /dev/null +++ b/src/Models/TransactionInformation.php @@ -0,0 +1,1090 @@ +paypalAccountId; + } + + /** + * Sets Paypal Account Id. + * The ID of the PayPal account of the counterparty. + * + * @maps paypal_account_id + */ + public function setPaypalAccountId(?string $paypalAccountId): void + { + $this->paypalAccountId = $paypalAccountId; + } + + /** + * Returns Transaction Id. + * The PayPal-generated transaction ID. + */ + public function getTransactionId(): ?string + { + return $this->transactionId; + } + + /** + * Sets Transaction Id. + * The PayPal-generated transaction ID. + * + * @maps transaction_id + */ + public function setTransactionId(?string $transactionId): void + { + $this->transactionId = $transactionId; + } + + /** + * Returns Paypal Reference Id. + * The PayPal-generated base ID. PayPal exclusive. Cannot be altered. Defined as a related, pre- + * existing transaction or event. + */ + public function getPaypalReferenceId(): ?string + { + return $this->paypalReferenceId; + } + + /** + * Sets Paypal Reference Id. + * The PayPal-generated base ID. PayPal exclusive. Cannot be altered. Defined as a related, pre- + * existing transaction or event. + * + * @maps paypal_reference_id + */ + public function setPaypalReferenceId(?string $paypalReferenceId): void + { + $this->paypalReferenceId = $paypalReferenceId; + } + + /** + * Returns Paypal Reference Id Type. + * The PayPal reference ID type. + */ + public function getPaypalReferenceIdType(): ?string + { + return $this->paypalReferenceIdType; + } + + /** + * Sets Paypal Reference Id Type. + * The PayPal reference ID type. + * + * @maps paypal_reference_id_type + */ + public function setPaypalReferenceIdType(?string $paypalReferenceIdType): void + { + $this->paypalReferenceIdType = $paypalReferenceIdType; + } + + /** + * Returns Transaction Event Code. + * A five-digit transaction event code that classifies the transaction type based on money movement and + * debit or credit. For example, T0001. See [Transaction event + * codes](/docs/integration/direct/transaction-search/transaction-event-codes/). + */ + public function getTransactionEventCode(): ?string + { + return $this->transactionEventCode; + } + + /** + * Sets Transaction Event Code. + * A five-digit transaction event code that classifies the transaction type based on money movement and + * debit or credit. For example, T0001. See [Transaction event + * codes](/docs/integration/direct/transaction-search/transaction-event-codes/). + * + * @maps transaction_event_code + */ + public function setTransactionEventCode(?string $transactionEventCode): void + { + $this->transactionEventCode = $transactionEventCode; + } + + /** + * Returns Transaction Initiation Date. + * 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 getTransactionInitiationDate(): ?string + { + return $this->transactionInitiationDate; + } + + /** + * Sets Transaction Initiation Date. + * 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 transaction_initiation_date + */ + public function setTransactionInitiationDate(?string $transactionInitiationDate): void + { + $this->transactionInitiationDate = $transactionInitiationDate; + } + + /** + * Returns Transaction Updated Date. + * 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 getTransactionUpdatedDate(): ?string + { + return $this->transactionUpdatedDate; + } + + /** + * Sets Transaction Updated Date. + * 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 transaction_updated_date + */ + public function setTransactionUpdatedDate(?string $transactionUpdatedDate): void + { + $this->transactionUpdatedDate = $transactionUpdatedDate; + } + + /** + * 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 Fee Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getFeeAmount(): ?Money + { + return $this->feeAmount; + } + + /** + * Sets Fee Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps fee_amount + */ + public function setFeeAmount(?Money $feeAmount): void + { + $this->feeAmount = $feeAmount; + } + + /** + * 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 Insurance Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getInsuranceAmount(): ?Money + { + return $this->insuranceAmount; + } + + /** + * Sets Insurance Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps insurance_amount + */ + public function setInsuranceAmount(?Money $insuranceAmount): void + { + $this->insuranceAmount = $insuranceAmount; + } + + /** + * Returns Sales Tax Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getSalesTaxAmount(): ?Money + { + return $this->salesTaxAmount; + } + + /** + * Sets Sales Tax Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps sales_tax_amount + */ + public function setSalesTaxAmount(?Money $salesTaxAmount): void + { + $this->salesTaxAmount = $salesTaxAmount; + } + + /** + * Returns Shipping Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getShippingAmount(): ?Money + { + return $this->shippingAmount; + } + + /** + * Sets Shipping Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps shipping_amount + */ + public function setShippingAmount(?Money $shippingAmount): void + { + $this->shippingAmount = $shippingAmount; + } + + /** + * Returns Shipping Discount Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getShippingDiscountAmount(): ?Money + { + return $this->shippingDiscountAmount; + } + + /** + * Sets Shipping Discount Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps shipping_discount_amount + */ + public function setShippingDiscountAmount(?Money $shippingDiscountAmount): void + { + $this->shippingDiscountAmount = $shippingDiscountAmount; + } + + /** + * Returns Shipping Tax Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getShippingTaxAmount(): ?Money + { + return $this->shippingTaxAmount; + } + + /** + * Sets Shipping Tax Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps shipping_tax_amount + */ + public function setShippingTaxAmount(?Money $shippingTaxAmount): void + { + $this->shippingTaxAmount = $shippingTaxAmount; + } + + /** + * Returns Other Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getOtherAmount(): ?Money + { + return $this->otherAmount; + } + + /** + * Sets Other Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps other_amount + */ + public function setOtherAmount(?Money $otherAmount): void + { + $this->otherAmount = $otherAmount; + } + + /** + * Returns Tip Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getTipAmount(): ?Money + { + return $this->tipAmount; + } + + /** + * Sets Tip Amount. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps tip_amount + */ + public function setTipAmount(?Money $tipAmount): void + { + $this->tipAmount = $tipAmount; + } + + /** + * Returns Transaction Status. + * A code that indicates the transaction status. Value is: Status code Description D PayPal or merchant + * rules denied the transaction. P The transaction is pending. The transaction was created but waits + * for another payment process to complete, such as an ACH transaction, before the status changes to S. + * S The transaction successfully completed without a denial and after any pending statuses. V A + * successful transaction was fully reversed and funds were refunded to the original sender. + */ + public function getTransactionStatus(): ?string + { + return $this->transactionStatus; + } + + /** + * Sets Transaction Status. + * A code that indicates the transaction status. Value is: Status code Description D PayPal or merchant + * rules denied the transaction. P The transaction is pending. The transaction was created but waits + * for another payment process to complete, such as an ACH transaction, before the status changes to S. + * S The transaction successfully completed without a denial and after any pending statuses. V A + * successful transaction was fully reversed and funds were refunded to the original sender. + * + * @maps transaction_status + */ + public function setTransactionStatus(?string $transactionStatus): void + { + $this->transactionStatus = $transactionStatus; + } + + /** + * Returns Transaction Subject. + * The subject of payment. The payer passes this value to the payee. The payer controls this data + * through the interface through which he or she sends the data. + */ + public function getTransactionSubject(): ?string + { + return $this->transactionSubject; + } + + /** + * Sets Transaction Subject. + * The subject of payment. The payer passes this value to the payee. The payer controls this data + * through the interface through which he or she sends the data. + * + * @maps transaction_subject + */ + public function setTransactionSubject(?string $transactionSubject): void + { + $this->transactionSubject = $transactionSubject; + } + + /** + * Returns Transaction Note. + * A special note that the payer passes to the payee. Might contain special customer requests, such as + * shipping instructions. + */ + public function getTransactionNote(): ?string + { + return $this->transactionNote; + } + + /** + * Sets Transaction Note. + * A special note that the payer passes to the payee. Might contain special customer requests, such as + * shipping instructions. + * + * @maps transaction_note + */ + public function setTransactionNote(?string $transactionNote): void + { + $this->transactionNote = $transactionNote; + } + + /** + * Returns Payment Tracking Id. + * The payment tracking ID, which is a unique ID that partners specify to either get information about + * a payment or request a refund. + */ + public function getPaymentTrackingId(): ?string + { + return $this->paymentTrackingId; + } + + /** + * Sets Payment Tracking Id. + * The payment tracking ID, which is a unique ID that partners specify to either get information about + * a payment or request a refund. + * + * @maps payment_tracking_id + */ + public function setPaymentTrackingId(?string $paymentTrackingId): void + { + $this->paymentTrackingId = $paymentTrackingId; + } + + /** + * Returns Bank Reference Id. + * The bank reference ID. The bank provides this value for an ACH transaction. + */ + public function getBankReferenceId(): ?string + { + return $this->bankReferenceId; + } + + /** + * Sets Bank Reference Id. + * The bank reference ID. The bank provides this value for an ACH transaction. + * + * @maps bank_reference_id + */ + public function setBankReferenceId(?string $bankReferenceId): void + { + $this->bankReferenceId = $bankReferenceId; + } + + /** + * Returns Ending Balance. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getEndingBalance(): ?Money + { + return $this->endingBalance; + } + + /** + * Sets Ending Balance. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps ending_balance + */ + public function setEndingBalance(?Money $endingBalance): void + { + $this->endingBalance = $endingBalance; + } + + /** + * Returns Available Balance. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getAvailableBalance(): ?Money + { + return $this->availableBalance; + } + + /** + * Sets Available Balance. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps available_balance + */ + public function setAvailableBalance(?Money $availableBalance): void + { + $this->availableBalance = $availableBalance; + } + + /** + * Returns Invoice Id. + * The invoice ID that is sent by the merchant with the transaction. Note: If an invoice ID was sent + * with the capture request, the value is reported. Otherwise, the invoice ID of the authorizing + * transaction is reported. + */ + public function getInvoiceId(): ?string + { + return $this->invoiceId; + } + + /** + * Sets Invoice Id. + * The invoice ID that is sent by the merchant with the transaction. Note: If an invoice ID was sent + * with the capture request, the value is reported. Otherwise, the invoice ID of the authorizing + * transaction is reported. + * + * @maps invoice_id + */ + public function setInvoiceId(?string $invoiceId): void + { + $this->invoiceId = $invoiceId; + } + + /** + * Returns Custom Field. + * The merchant-provided custom text. Note: Usually, this field includes the unique ID for payments + * made with MassPay type transaction. + */ + public function getCustomField(): ?string + { + return $this->customField; + } + + /** + * Sets Custom Field. + * The merchant-provided custom text. Note: Usually, this field includes the unique ID for payments + * made with MassPay type transaction. + * + * @maps custom_field + */ + public function setCustomField(?string $customField): void + { + $this->customField = $customField; + } + + /** + * Returns Protection Eligibility. + * Indicates whether the transaction is eligible for protection. Value is: 01. Eligible. 02. Not + * eligible 03. Partially eligible. + */ + public function getProtectionEligibility(): ?string + { + return $this->protectionEligibility; + } + + /** + * Sets Protection Eligibility. + * Indicates whether the transaction is eligible for protection. Value is: 01. Eligible. 02. Not + * eligible 03. Partially eligible. + * + * @maps protection_eligibility + */ + public function setProtectionEligibility(?string $protectionEligibility): void + { + $this->protectionEligibility = $protectionEligibility; + } + + /** + * Returns Credit Term. + * The credit term. The time span covered by the installment payments as expressed in the term length + * plus the length time unit code. + */ + public function getCreditTerm(): ?string + { + return $this->creditTerm; + } + + /** + * Sets Credit Term. + * The credit term. The time span covered by the installment payments as expressed in the term length + * plus the length time unit code. + * + * @maps credit_term + */ + public function setCreditTerm(?string $creditTerm): void + { + $this->creditTerm = $creditTerm; + } + + /** + * Returns Credit Transactional Fee. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getCreditTransactionalFee(): ?Money + { + return $this->creditTransactionalFee; + } + + /** + * Sets Credit Transactional Fee. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps credit_transactional_fee + */ + public function setCreditTransactionalFee(?Money $creditTransactionalFee): void + { + $this->creditTransactionalFee = $creditTransactionalFee; + } + + /** + * Returns Credit Promotional Fee. + * The currency and amount for a financial transaction, such as a balance or payment due. + */ + public function getCreditPromotionalFee(): ?Money + { + return $this->creditPromotionalFee; + } + + /** + * Sets Credit Promotional Fee. + * The currency and amount for a financial transaction, such as a balance or payment due. + * + * @maps credit_promotional_fee + */ + public function setCreditPromotionalFee(?Money $creditPromotionalFee): void + { + $this->creditPromotionalFee = $creditPromotionalFee; + } + + /** + * Returns Annual Percentage Rate. + * The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate + * as `19.99`. + */ + public function getAnnualPercentageRate(): ?string + { + return $this->annualPercentageRate; + } + + /** + * Sets Annual Percentage Rate. + * The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate + * as `19.99`. + * + * @maps annual_percentage_rate + */ + public function setAnnualPercentageRate(?string $annualPercentageRate): void + { + $this->annualPercentageRate = $annualPercentageRate; + } + + /** + * Returns Payment Method Type. + * The payment method that was used for a transaction. Value is PUI, installment, or mEFT. Note: + * Appears only for pay upon invoice (PUI), installment, and mEFT transactions. Merchants and partners + * in the EMEA region can use this attribute to note transactions that attract turn-over tax. + */ + public function getPaymentMethodType(): ?string + { + return $this->paymentMethodType; + } + + /** + * Sets Payment Method Type. + * The payment method that was used for a transaction. Value is PUI, installment, or mEFT. Note: + * Appears only for pay upon invoice (PUI), installment, and mEFT transactions. Merchants and partners + * in the EMEA region can use this attribute to note transactions that attract turn-over tax. + * + * @maps payment_method_type + */ + public function setPaymentMethodType(?string $paymentMethodType): void + { + $this->paymentMethodType = $paymentMethodType; + } + + /** + * Returns Instrument Type. + * A high-level classification of the type of financial instrument that was used to fund a payment. The + * pattern is not provided because the value is defined by an external party. E.g. PAYPAL, CREDIT_CARD, + * DEBIT_CARD, APPLE_PAY, BANK , VENMO ,Pay Upon Invoice, Pay Later or Alternative Payment Methods + * (APM). + */ + public function getInstrumentType(): ?string + { + return $this->instrumentType; + } + + /** + * Sets Instrument Type. + * A high-level classification of the type of financial instrument that was used to fund a payment. The + * pattern is not provided because the value is defined by an external party. E.g. PAYPAL, CREDIT_CARD, + * DEBIT_CARD, APPLE_PAY, BANK , VENMO ,Pay Upon Invoice, Pay Later or Alternative Payment Methods + * (APM). + * + * @maps instrument_type + */ + public function setInstrumentType(?string $instrumentType): void + { + $this->instrumentType = $instrumentType; + } + + /** + * Returns Instrument Sub Type. + * A finer-grained classification of the financial instrument that was used to fund a payment. For + * example, `Visa card` or a `Mastercard` for a credit card, BANKCARD ,DISCOVER etc. The pattern is not + * provided because the value is defined by an external party. + */ + public function getInstrumentSubType(): ?string + { + return $this->instrumentSubType; + } + + /** + * Sets Instrument Sub Type. + * A finer-grained classification of the financial instrument that was used to fund a payment. For + * example, `Visa card` or a `Mastercard` for a credit card, BANKCARD ,DISCOVER etc. The pattern is not + * provided because the value is defined by an external party. + * + * @maps instrument_sub_type + */ + public function setInstrumentSubType(?string $instrumentSubType): void + { + $this->instrumentSubType = $instrumentSubType; + } + + /** + * Converts the TransactionInformation object to a human-readable string representation. + * + * @return string The string representation of the TransactionInformation object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'TransactionInformation', + [ + 'paypalAccountId' => $this->paypalAccountId, + 'transactionId' => $this->transactionId, + 'paypalReferenceId' => $this->paypalReferenceId, + 'paypalReferenceIdType' => $this->paypalReferenceIdType, + 'transactionEventCode' => $this->transactionEventCode, + 'transactionInitiationDate' => $this->transactionInitiationDate, + 'transactionUpdatedDate' => $this->transactionUpdatedDate, + 'transactionAmount' => $this->transactionAmount, + 'feeAmount' => $this->feeAmount, + 'discountAmount' => $this->discountAmount, + 'insuranceAmount' => $this->insuranceAmount, + 'salesTaxAmount' => $this->salesTaxAmount, + 'shippingAmount' => $this->shippingAmount, + 'shippingDiscountAmount' => $this->shippingDiscountAmount, + 'shippingTaxAmount' => $this->shippingTaxAmount, + 'otherAmount' => $this->otherAmount, + 'tipAmount' => $this->tipAmount, + 'transactionStatus' => $this->transactionStatus, + 'transactionSubject' => $this->transactionSubject, + 'transactionNote' => $this->transactionNote, + 'paymentTrackingId' => $this->paymentTrackingId, + 'bankReferenceId' => $this->bankReferenceId, + 'endingBalance' => $this->endingBalance, + 'availableBalance' => $this->availableBalance, + 'invoiceId' => $this->invoiceId, + 'customField' => $this->customField, + 'protectionEligibility' => $this->protectionEligibility, + 'creditTerm' => $this->creditTerm, + 'creditTransactionalFee' => $this->creditTransactionalFee, + 'creditPromotionalFee' => $this->creditPromotionalFee, + 'annualPercentageRate' => $this->annualPercentageRate, + 'paymentMethodType' => $this->paymentMethodType, + 'instrumentType' => $this->instrumentType, + 'instrumentSubType' => $this->instrumentSubType + ] + ); + } + + /** + * 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->paypalAccountId)) { + $json['paypal_account_id'] = $this->paypalAccountId; + } + if (isset($this->transactionId)) { + $json['transaction_id'] = $this->transactionId; + } + if (isset($this->paypalReferenceId)) { + $json['paypal_reference_id'] = $this->paypalReferenceId; + } + if (isset($this->paypalReferenceIdType)) { + $json['paypal_reference_id_type'] = $this->paypalReferenceIdType; + } + if (isset($this->transactionEventCode)) { + $json['transaction_event_code'] = $this->transactionEventCode; + } + if (isset($this->transactionInitiationDate)) { + $json['transaction_initiation_date'] = $this->transactionInitiationDate; + } + if (isset($this->transactionUpdatedDate)) { + $json['transaction_updated_date'] = $this->transactionUpdatedDate; + } + if (isset($this->transactionAmount)) { + $json['transaction_amount'] = $this->transactionAmount; + } + if (isset($this->feeAmount)) { + $json['fee_amount'] = $this->feeAmount; + } + if (isset($this->discountAmount)) { + $json['discount_amount'] = $this->discountAmount; + } + if (isset($this->insuranceAmount)) { + $json['insurance_amount'] = $this->insuranceAmount; + } + if (isset($this->salesTaxAmount)) { + $json['sales_tax_amount'] = $this->salesTaxAmount; + } + if (isset($this->shippingAmount)) { + $json['shipping_amount'] = $this->shippingAmount; + } + if (isset($this->shippingDiscountAmount)) { + $json['shipping_discount_amount'] = $this->shippingDiscountAmount; + } + if (isset($this->shippingTaxAmount)) { + $json['shipping_tax_amount'] = $this->shippingTaxAmount; + } + if (isset($this->otherAmount)) { + $json['other_amount'] = $this->otherAmount; + } + if (isset($this->tipAmount)) { + $json['tip_amount'] = $this->tipAmount; + } + if (isset($this->transactionStatus)) { + $json['transaction_status'] = $this->transactionStatus; + } + if (isset($this->transactionSubject)) { + $json['transaction_subject'] = $this->transactionSubject; + } + if (isset($this->transactionNote)) { + $json['transaction_note'] = $this->transactionNote; + } + if (isset($this->paymentTrackingId)) { + $json['payment_tracking_id'] = $this->paymentTrackingId; + } + if (isset($this->bankReferenceId)) { + $json['bank_reference_id'] = $this->bankReferenceId; + } + if (isset($this->endingBalance)) { + $json['ending_balance'] = $this->endingBalance; + } + if (isset($this->availableBalance)) { + $json['available_balance'] = $this->availableBalance; + } + if (isset($this->invoiceId)) { + $json['invoice_id'] = $this->invoiceId; + } + if (isset($this->customField)) { + $json['custom_field'] = $this->customField; + } + if (isset($this->protectionEligibility)) { + $json['protection_eligibility'] = $this->protectionEligibility; + } + if (isset($this->creditTerm)) { + $json['credit_term'] = $this->creditTerm; + } + if (isset($this->creditTransactionalFee)) { + $json['credit_transactional_fee'] = $this->creditTransactionalFee; + } + if (isset($this->creditPromotionalFee)) { + $json['credit_promotional_fee'] = $this->creditPromotionalFee; + } + if (isset($this->annualPercentageRate)) { + $json['annual_percentage_rate'] = $this->annualPercentageRate; + } + if (isset($this->paymentMethodType)) { + $json['payment_method_type'] = $this->paymentMethodType; + } + if (isset($this->instrumentType)) { + $json['instrument_type'] = $this->instrumentType; + } + if (isset($this->instrumentSubType)) { + $json['instrument_sub_type'] = $this->instrumentSubType; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/OrderUpdateCallbackErrorResponseDetails.php b/src/Models/TransactionSearchErrorDetails.php similarity index 55% rename from src/Models/OrderUpdateCallbackErrorResponseDetails.php rename to src/Models/TransactionSearchErrorDetails.php index 8f28fff..569a80d 100644 --- a/src/Models/OrderUpdateCallbackErrorResponseDetails.php +++ b/src/Models/TransactionSearchErrorDetails.php @@ -16,7 +16,7 @@ use stdClass; /** * The error details. Required for client-side `4XX` errors. */ -class OrderUpdateCallbackErrorResponseDetails implements \JsonSerializable +class TransactionSearchErrorDetails implements \JsonSerializable { /** * @var string|null @@ -28,11 +28,21 @@ class OrderUpdateCallbackErrorResponseDetails implements \JsonSerializable */ private $value; + /** + * @var string|null + */ + private $location = 'body'; + /** * @var string */ private $issue; + /** + * @var string|null + */ + private $description; + /** * @param string $issue */ @@ -83,6 +93,26 @@ class OrderUpdateCallbackErrorResponseDetails implements \JsonSerializable $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. @@ -105,16 +135,43 @@ class OrderUpdateCallbackErrorResponseDetails implements \JsonSerializable } /** - * Converts the OrderUpdateCallbackErrorResponseDetails object to a human-readable string - * representation. + * 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. * - * @return string The string representation of the OrderUpdateCallbackErrorResponseDetails object. + * @maps description + */ + public function setDescription(?string $description): void + { + $this->description = $description; + } + + /** + * Converts the TransactionSearchErrorDetails object to a human-readable string representation. + * + * @return string The string representation of the TransactionSearchErrorDetails object. */ public function __toString(): string { return ApiHelper::stringify( - 'OrderUpdateCallbackErrorResponseDetails', - ['field' => $this->field, 'value' => $this->value, 'issue' => $this->issue] + 'TransactionSearchErrorDetails', + [ + 'field' => $this->field, + 'value' => $this->value, + 'location' => $this->location, + 'issue' => $this->issue, + 'description' => $this->description + ] ); } @@ -131,12 +188,18 @@ class OrderUpdateCallbackErrorResponseDetails implements \JsonSerializable { $json = []; if (isset($this->field)) { - $json['field'] = $this->field; + $json['field'] = $this->field; } if (isset($this->value)) { - $json['value'] = $this->value; + $json['value'] = $this->value; + } + if (isset($this->location)) { + $json['location'] = $this->location; + } + $json['issue'] = $this->issue; + if (isset($this->description)) { + $json['description'] = $this->description; } - $json['issue'] = $this->issue; return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; } diff --git a/src/Models/TransactionsList.php b/src/Models/TransactionsList.php new file mode 100644 index 0000000..b08f667 --- /dev/null +++ b/src/Models/TransactionsList.php @@ -0,0 +1,174 @@ +transactions; + } + + /** + * Sets Transactions. + * An array of transactions. + * + * @maps transactions + * + * @param SubscriptionTransactionDetails[]|null $transactions + */ + public function setTransactions(?array $transactions): void + { + $this->transactions = $transactions; + } + + /** + * Returns Total Items. + * The total number of items. + */ + public function getTotalItems(): ?int + { + return $this->totalItems; + } + + /** + * Sets Total Items. + * The total number of items. + * + * @maps total_items + */ + public function setTotalItems(?int $totalItems): void + { + $this->totalItems = $totalItems; + } + + /** + * Returns Total Pages. + * The total number of pages. + */ + public function getTotalPages(): ?int + { + return $this->totalPages; + } + + /** + * Sets Total Pages. + * The total number of pages. + * + * @maps total_pages + */ + public function setTotalPages(?int $totalPages): void + { + $this->totalPages = $totalPages; + } + + /** + * Returns Links. + * An array of request-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 request-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; + } + + /** + * Converts the TransactionsList object to a human-readable string representation. + * + * @return string The string representation of the TransactionsList object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'TransactionsList', + [ + 'transactions' => $this->transactions, + 'totalItems' => $this->totalItems, + 'totalPages' => $this->totalPages, + 'links' => $this->links + ] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + if (isset($this->transactions)) { + $json['transactions'] = $this->transactions; + } + if (isset($this->totalItems)) { + $json['total_items'] = $this->totalItems; + } + if (isset($this->totalPages)) { + $json['total_pages'] = $this->totalPages; + } + if (isset($this->links)) { + $json['links'] = $this->links; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/UpdatePricingScheme.php b/src/Models/UpdatePricingScheme.php new file mode 100644 index 0000000..a3c494c --- /dev/null +++ b/src/Models/UpdatePricingScheme.php @@ -0,0 +1,113 @@ +billingCycleSequence = $billingCycleSequence; + $this->pricingScheme = $pricingScheme; + } + + /** + * Returns Billing Cycle Sequence. + * The billing cycle sequence. + */ + public function getBillingCycleSequence(): int + { + return $this->billingCycleSequence; + } + + /** + * Sets Billing Cycle Sequence. + * The billing cycle sequence. + * + * @required + * @maps billing_cycle_sequence + */ + public function setBillingCycleSequence(int $billingCycleSequence): void + { + $this->billingCycleSequence = $billingCycleSequence; + } + + /** + * Returns Pricing Scheme. + * The pricing scheme details. + */ + public function getPricingScheme(): SubscriptionPricingScheme + { + return $this->pricingScheme; + } + + /** + * Sets Pricing Scheme. + * The pricing scheme details. + * + * @required + * @maps pricing_scheme + */ + public function setPricingScheme(SubscriptionPricingScheme $pricingScheme): void + { + $this->pricingScheme = $pricingScheme; + } + + /** + * Converts the UpdatePricingScheme object to a human-readable string representation. + * + * @return string The string representation of the UpdatePricingScheme object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'UpdatePricingScheme', + ['billingCycleSequence' => $this->billingCycleSequence, 'pricingScheme' => $this->pricingScheme] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + $json['billing_cycle_sequence'] = $this->billingCycleSequence; + $json['pricing_scheme'] = $this->pricingScheme; + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/UpdatePricingSchemesRequest.php b/src/Models/UpdatePricingSchemesRequest.php new file mode 100644 index 0000000..b464faf --- /dev/null +++ b/src/Models/UpdatePricingSchemesRequest.php @@ -0,0 +1,85 @@ +pricingSchemes = $pricingSchemes; + } + + /** + * Returns Pricing Schemes. + * An array of pricing schemes. + * + * @return UpdatePricingScheme[] + */ + public function getPricingSchemes(): array + { + return $this->pricingSchemes; + } + + /** + * Sets Pricing Schemes. + * An array of pricing schemes. + * + * @required + * @maps pricing_schemes + * + * @param UpdatePricingScheme[] $pricingSchemes + */ + public function setPricingSchemes(array $pricingSchemes): void + { + $this->pricingSchemes = $pricingSchemes; + } + + /** + * Converts the UpdatePricingSchemesRequest object to a human-readable string representation. + * + * @return string The string representation of the UpdatePricingSchemesRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify('UpdatePricingSchemesRequest', ['pricingSchemes' => $this->pricingSchemes]); + } + + /** + * 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['pricing_schemes'] = $this->pricingSchemes; + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/VaultApplePayRequest.php b/src/Models/VaultApplePayRequest.php new file mode 100644 index 0000000..076d77b --- /dev/null +++ b/src/Models/VaultApplePayRequest.php @@ -0,0 +1,102 @@ +token; + } + + /** + * Sets Token. + * Encrypted Apple Pay token, containing card information. This token would be base64 encoded. + * + * @maps token + */ + public function setToken(?string $token): void + { + $this->token = $token; + } + + /** + * Returns Card. + * The payment card to be used to fund a payment. Can be a credit or debit card. + */ + public function getCard(): ?ApplePayRequestCard + { + return $this->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(?ApplePayRequestCard $card): void + { + $this->card = $card; + } + + /** + * Converts the VaultApplePayRequest object to a human-readable string representation. + * + * @return string The string representation of the VaultApplePayRequest object. + */ + public function __toString(): string + { + return ApiHelper::stringify('VaultApplePayRequest', ['token' => $this->token, 'card' => $this->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->token)) { + $json['token'] = $this->token; + } + if (isset($this->card)) { + $json['card'] = $this->card; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/SetupTokenCardExperienceContext.php b/src/Models/VaultCardExperienceContext.php similarity index 80% rename from src/Models/SetupTokenCardExperienceContext.php rename to src/Models/VaultCardExperienceContext.php index 99ed247..355c8f2 100644 --- a/src/Models/SetupTokenCardExperienceContext.php +++ b/src/Models/VaultCardExperienceContext.php @@ -14,9 +14,9 @@ use PaypalServerSdkLib\ApiHelper; use stdClass; /** - * Customizes the Vault creation flow experience for your customers. + * A resource representing an experience context of vault a card. */ -class SetupTokenCardExperienceContext implements \JsonSerializable +class VaultCardExperienceContext implements \JsonSerializable { /** * @var string|null @@ -41,7 +41,12 @@ class SetupTokenCardExperienceContext implements \JsonSerializable /** * @var string|null */ - private $vaultInstruction = VaultInstructionAction::ON_CREATE_PAYMENT_TOKENS; + private $vaultInstruction; + + /** + * @var string|null + */ + private $userAction = VaultUserAction::CONTINUE_; /** * Returns Brand Name. @@ -141,7 +146,7 @@ class SetupTokenCardExperienceContext implements \JsonSerializable /** * Returns Vault Instruction. - * Vault Instruction on action to be performed after a successful payer approval. + * DEPRECATED. Vault Instruction on action to be performed after a successful payer approval. */ public function getVaultInstruction(): ?string { @@ -150,7 +155,7 @@ class SetupTokenCardExperienceContext implements \JsonSerializable /** * Sets Vault Instruction. - * Vault Instruction on action to be performed after a successful payer approval. + * DEPRECATED. Vault Instruction on action to be performed after a successful payer approval. * * @maps vault_instruction */ @@ -160,20 +165,41 @@ class SetupTokenCardExperienceContext implements \JsonSerializable } /** - * Converts the SetupTokenCardExperienceContext object to a human-readable string representation. + * Returns User Action. + * User Action on action to be performed after a successful payer approval. + */ + public function getUserAction(): ?string + { + return $this->userAction; + } + + /** + * Sets User Action. + * User Action on action to be performed after a successful payer approval. * - * @return string The string representation of the SetupTokenCardExperienceContext object. + * @maps user_action + */ + public function setUserAction(?string $userAction): void + { + $this->userAction = $userAction; + } + + /** + * Converts the VaultCardExperienceContext object to a human-readable string representation. + * + * @return string The string representation of the VaultCardExperienceContext object. */ public function __toString(): string { return ApiHelper::stringify( - 'SetupTokenCardExperienceContext', + 'VaultCardExperienceContext', [ 'brandName' => $this->brandName, 'locale' => $this->locale, 'returnUrl' => $this->returnUrl, 'cancelUrl' => $this->cancelUrl, - 'vaultInstruction' => $this->vaultInstruction + 'vaultInstruction' => $this->vaultInstruction, + 'userAction' => $this->userAction ] ); } @@ -205,6 +231,9 @@ class SetupTokenCardExperienceContext implements \JsonSerializable if (isset($this->vaultInstruction)) { $json['vault_instruction'] = $this->vaultInstruction; } + if (isset($this->userAction)) { + $json['user_action'] = $this->userAction; + } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; } diff --git a/src/Models/VaultExperienceContext.php b/src/Models/VaultExperienceContext.php index 748ce3c..b26ce85 100644 --- a/src/Models/VaultExperienceContext.php +++ b/src/Models/VaultExperienceContext.php @@ -41,12 +41,22 @@ class VaultExperienceContext implements \JsonSerializable /** * @var string|null */ - private $shippingPreference = OrderApplicationContextShippingPreference::GET_FROM_FILE; + private $shippingPreference = ExperienceContextShippingPreference::GET_FROM_FILE; /** * @var string|null */ - private $vaultInstruction = VaultInstructionAction::ON_CREATE_PAYMENT_TOKENS; + private $vaultInstruction; + + /** + * @var AppSwitchContext|null + */ + private $appSwitchContext; + + /** + * @var string|null + */ + private $userAction = VaultUserAction::CONTINUE_; /** * Returns Brand Name. @@ -166,7 +176,7 @@ class VaultExperienceContext implements \JsonSerializable /** * Returns Vault Instruction. - * Vault Instruction on action to be performed after a successful payer approval. + * DEPRECATED. Vault Instruction on action to be performed after a successful payer approval. */ public function getVaultInstruction(): ?string { @@ -175,7 +185,7 @@ class VaultExperienceContext implements \JsonSerializable /** * Sets Vault Instruction. - * Vault Instruction on action to be performed after a successful payer approval. + * DEPRECATED. Vault Instruction on action to be performed after a successful payer approval. * * @maps vault_instruction */ @@ -184,6 +194,48 @@ class VaultExperienceContext implements \JsonSerializable $this->vaultInstruction = $vaultInstruction; } + /** + * Returns App Switch Context. + * Merchant provided details of the native app or mobile web browser to facilitate buyer's app switch + * to the PayPal consumer app. + */ + public function getAppSwitchContext(): ?AppSwitchContext + { + return $this->appSwitchContext; + } + + /** + * Sets App Switch Context. + * Merchant provided details of the native app or mobile web browser to facilitate buyer's app switch + * to the PayPal consumer app. + * + * @maps app_switch_context + */ + public function setAppSwitchContext(?AppSwitchContext $appSwitchContext): void + { + $this->appSwitchContext = $appSwitchContext; + } + + /** + * Returns User Action. + * User Action on action to be performed after a successful payer approval. + */ + public function getUserAction(): ?string + { + return $this->userAction; + } + + /** + * Sets User Action. + * User Action on action to be performed after a successful payer approval. + * + * @maps user_action + */ + public function setUserAction(?string $userAction): void + { + $this->userAction = $userAction; + } + /** * Converts the VaultExperienceContext object to a human-readable string representation. * @@ -199,7 +251,9 @@ class VaultExperienceContext implements \JsonSerializable 'returnUrl' => $this->returnUrl, 'cancelUrl' => $this->cancelUrl, 'shippingPreference' => $this->shippingPreference, - 'vaultInstruction' => $this->vaultInstruction + 'vaultInstruction' => $this->vaultInstruction, + 'appSwitchContext' => $this->appSwitchContext, + 'userAction' => $this->userAction ] ); } @@ -234,6 +288,12 @@ class VaultExperienceContext implements \JsonSerializable if (isset($this->vaultInstruction)) { $json['vault_instruction'] = $this->vaultInstruction; } + if (isset($this->appSwitchContext)) { + $json['app_switch_context'] = $this->appSwitchContext; + } + if (isset($this->userAction)) { + $json['user_action'] = $this->userAction; + } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; } diff --git a/src/Models/VaultPaypalWalletRequest.php b/src/Models/VaultPaypalWalletRequest.php index f66554d..aeda4de 100644 --- a/src/Models/VaultPaypalWalletRequest.php +++ b/src/Models/VaultPaypalWalletRequest.php @@ -214,7 +214,7 @@ class VaultPaypalWalletRequest implements \JsonSerializable /** * Returns Experience Context. - * Customizes the Vault creation flow experience for your customers. + * A resource representing an experience context of vault PayPal Wallet. */ public function getExperienceContext(): ?VaultExperienceContext { @@ -223,7 +223,7 @@ class VaultPaypalWalletRequest implements \JsonSerializable /** * Sets Experience Context. - * Customizes the Vault creation flow experience for your customers. + * A resource representing an experience context of vault PayPal Wallet. * * @maps experience_context */ diff --git a/src/Models/VaultUserAction.php b/src/Models/VaultUserAction.php new file mode 100644 index 0000000..463ae47 --- /dev/null +++ b/src/Models/VaultUserAction.php @@ -0,0 +1,31 @@ +experienceContext; } /** * Sets Experience Context. - * Customizes the Vault creation flow experience for your customers. + * A resource representing an experience context of vault a venmo account. * * @maps experience_context */ - public function setExperienceContext(?VaultVenmoExperienceContext $experienceContext): void + public function setExperienceContext(?VenmoExperienceContext $experienceContext): void { $this->experienceContext = $experienceContext; } diff --git a/src/Models/VaultedDigitalWalletShippingDetails.php b/src/Models/VaultedDigitalWalletShippingDetails.php index 1433a9d..5403dea 100644 --- a/src/Models/VaultedDigitalWalletShippingDetails.php +++ b/src/Models/VaultedDigitalWalletShippingDetails.php @@ -23,6 +23,11 @@ class VaultedDigitalWalletShippingDetails implements \JsonSerializable */ private $name; + /** + * @var string|null + */ + private $emailAddress; + /** * @var PhoneNumberWithCountryCode|null */ @@ -58,6 +63,30 @@ class VaultedDigitalWalletShippingDetails implements \JsonSerializable $this->name = $name; } + /** + * Returns Email Address. + * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. + */ + public function getEmailAddress(): ?string + { + return $this->emailAddress; + } + + /** + * Sets Email Address. + * The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters + * are allowed after the @ sign. However, the generally accepted maximum length for an email address is + * 254 characters. The pattern verifies that an unquoted @ sign exists. + * + * @maps email_address + */ + public function setEmailAddress(?string $emailAddress): void + { + $this->emailAddress = $emailAddress; + } + /** * Returns Phone Number. * The phone number, in its canonical international [E.164 numbering plan format](https://www.itu. @@ -139,6 +168,7 @@ class VaultedDigitalWalletShippingDetails implements \JsonSerializable 'VaultedDigitalWalletShippingDetails', [ 'name' => $this->name, + 'emailAddress' => $this->emailAddress, 'phoneNumber' => $this->phoneNumber, 'type' => $this->type, 'address' => $this->address @@ -159,16 +189,19 @@ class VaultedDigitalWalletShippingDetails implements \JsonSerializable { $json = []; if (isset($this->name)) { - $json['name'] = $this->name; + $json['name'] = $this->name; + } + if (isset($this->emailAddress)) { + $json['email_address'] = $this->emailAddress; } if (isset($this->phoneNumber)) { - $json['phone_number'] = $this->phoneNumber; + $json['phone_number'] = $this->phoneNumber; } if (isset($this->type)) { - $json['type'] = $this->type; + $json['type'] = $this->type; } if (isset($this->address)) { - $json['address'] = $this->address; + $json['address'] = $this->address; } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; diff --git a/src/Models/VaultVenmoExperienceContext.php b/src/Models/VenmoExperienceContext.php similarity index 67% rename from src/Models/VaultVenmoExperienceContext.php rename to src/Models/VenmoExperienceContext.php index 1d62855..faf69c9 100644 --- a/src/Models/VaultVenmoExperienceContext.php +++ b/src/Models/VenmoExperienceContext.php @@ -14,9 +14,9 @@ use PaypalServerSdkLib\ApiHelper; use stdClass; /** - * Customizes the Vault creation flow experience for your customers. + * A resource representing an experience context of vault a venmo account. */ -class VaultVenmoExperienceContext implements \JsonSerializable +class VenmoExperienceContext implements \JsonSerializable { /** * @var string|null @@ -26,12 +26,17 @@ class VaultVenmoExperienceContext implements \JsonSerializable /** * @var string|null */ - private $shippingPreference = OrderApplicationContextShippingPreference::GET_FROM_FILE; + private $shippingPreference = ExperienceContextShippingPreference::GET_FROM_FILE; /** * @var string|null */ - private $vaultInstruction = VaultInstructionAction::ON_CREATE_PAYMENT_TOKENS; + private $vaultInstruction; + + /** + * @var string|null + */ + private $userAction = VaultUserAction::CONTINUE_; /** * Returns Brand Name. @@ -77,7 +82,7 @@ class VaultVenmoExperienceContext implements \JsonSerializable /** * Returns Vault Instruction. - * Vault Instruction on action to be performed after a successful payer approval. + * DEPRECATED. Vault Instruction on action to be performed after a successful payer approval. */ public function getVaultInstruction(): ?string { @@ -86,7 +91,7 @@ class VaultVenmoExperienceContext implements \JsonSerializable /** * Sets Vault Instruction. - * Vault Instruction on action to be performed after a successful payer approval. + * DEPRECATED. Vault Instruction on action to be performed after a successful payer approval. * * @maps vault_instruction */ @@ -96,18 +101,39 @@ class VaultVenmoExperienceContext implements \JsonSerializable } /** - * Converts the VaultVenmoExperienceContext object to a human-readable string representation. + * Returns User Action. + * User Action on action to be performed after a successful payer approval. + */ + public function getUserAction(): ?string + { + return $this->userAction; + } + + /** + * Sets User Action. + * User Action on action to be performed after a successful payer approval. * - * @return string The string representation of the VaultVenmoExperienceContext object. + * @maps user_action + */ + public function setUserAction(?string $userAction): void + { + $this->userAction = $userAction; + } + + /** + * Converts the VenmoExperienceContext object to a human-readable string representation. + * + * @return string The string representation of the VenmoExperienceContext object. */ public function __toString(): string { return ApiHelper::stringify( - 'VaultVenmoExperienceContext', + 'VenmoExperienceContext', [ 'brandName' => $this->brandName, 'shippingPreference' => $this->shippingPreference, - 'vaultInstruction' => $this->vaultInstruction + 'vaultInstruction' => $this->vaultInstruction, + 'userAction' => $this->userAction ] ); } @@ -133,6 +159,9 @@ class VaultVenmoExperienceContext implements \JsonSerializable if (isset($this->vaultInstruction)) { $json['vault_instruction'] = $this->vaultInstruction; } + if (isset($this->userAction)) { + $json['user_action'] = $this->userAction; + } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; } diff --git a/src/Models/VenmoPaymentToken.php b/src/Models/VenmoPaymentToken.php index eea8533..5cf4685 100644 --- a/src/Models/VenmoPaymentToken.php +++ b/src/Models/VenmoPaymentToken.php @@ -13,6 +13,9 @@ namespace PaypalServerSdkLib\Models; use PaypalServerSdkLib\ApiHelper; use stdClass; +/** + * Full representation of a Venmo Payment Token. + */ class VenmoPaymentToken implements \JsonSerializable { /** @@ -211,9 +214,10 @@ class VenmoPaymentToken implements \JsonSerializable /** * 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. + * The internationalized email address.@sign. However, the generally + * accepted maximum length for an email address is 254 characters. The pattern verifies that an + * unquoted@sign exists.
Note: Up to 64 characters are + * allowed before and 255 characters are allowed after the*/ public function getEmailAddress(): ?string { @@ -222,9 +226,10 @@ class VenmoPaymentToken implements \JsonSerializable /** * 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. + * The internationalized email address.@sign. However, the generally + * accepted maximum length for an email address is 254 characters. The pattern verifies that an + * unquoted@sign exists.
Note: Up to 64 characters are + * allowed before and 255 characters are allowed after the* * @maps email_address */ diff --git a/src/Models/VenmoVaultResponse.php b/src/Models/VenmoVaultResponse.php new file mode 100644 index 0000000..c8b6760 --- /dev/null +++ b/src/Models/VenmoVaultResponse.php @@ -0,0 +1,167 @@ +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. + * This object represents a merchant’s customer, allowing them to store contact details, and track all + * payments associated with the same customer. + */ + public function getCustomer(): ?CustomerInformation + { + return $this->customer; + } + + /** + * Sets Customer. + * This object represents a merchant’s customer, allowing them to store contact details, and track all + * payments associated with the same customer. + * + * @maps customer + */ + public function setCustomer(?CustomerInformation $customer): void + { + $this->customer = $customer; + } + + /** + * Converts the VenmoVaultResponse object to a human-readable string representation. + * + * @return string The string representation of the VenmoVaultResponse object. + */ + public function __toString(): string + { + return ApiHelper::stringify( + 'VenmoVaultResponse', + ['id' => $this->id, 'status' => $this->status, 'links' => $this->links, 'customer' => $this->customer] + ); + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + if (isset($this->id)) { + $json['id'] = $this->id; + } + if (isset($this->status)) { + $json['status'] = $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/VenmoVaultResponseStatus.php b/src/Models/VenmoVaultResponseStatus.php new file mode 100644 index 0000000..607c98c --- /dev/null +++ b/src/Models/VenmoVaultResponseStatus.php @@ -0,0 +1,35 @@ +vault; } /** * Sets Vault. - * The details about a saved payment source. + * The details about a saved venmo payment source. * * @maps vault */ - public function setVault(?VaultResponse $vault): void + public function setVault(?VenmoVaultResponse $vault): void { $this->vault = $vault; } diff --git a/src/Models/VenmoWalletExperienceContext.php b/src/Models/VenmoWalletExperienceContext.php index ef67722..e02a994 100644 --- a/src/Models/VenmoWalletExperienceContext.php +++ b/src/Models/VenmoWalletExperienceContext.php @@ -28,13 +28,18 @@ class VenmoWalletExperienceContext implements \JsonSerializable /** * @var string|null */ - private $shippingPreference = ShippingPreference::GET_FROM_FILE; + private $shippingPreference = VenmoWalletExperienceContextShippingPreference::GET_FROM_FILE; /** * @var CallbackConfiguration|null */ private $orderUpdateCallbackConfig; + /** + * @var string|null + */ + private $userAction = VenmoWalletExperienceContextUserAction::CONTINUE_; + /** * Returns Brand Name. * The business name of the merchant. The pattern is defined by an external party and supports Unicode. @@ -95,6 +100,26 @@ class VenmoWalletExperienceContext implements \JsonSerializable $this->orderUpdateCallbackConfig = $orderUpdateCallbackConfig; } + /** + * 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; + } + /** * Converts the VenmoWalletExperienceContext object to a human-readable string representation. * @@ -107,7 +132,8 @@ class VenmoWalletExperienceContext implements \JsonSerializable [ 'brandName' => $this->brandName, 'shippingPreference' => $this->shippingPreference, - 'orderUpdateCallbackConfig' => $this->orderUpdateCallbackConfig + 'orderUpdateCallbackConfig' => $this->orderUpdateCallbackConfig, + 'userAction' => $this->userAction ] ); } @@ -133,6 +159,9 @@ class VenmoWalletExperienceContext implements \JsonSerializable if (isset($this->orderUpdateCallbackConfig)) { $json['order_update_callback_config'] = $this->orderUpdateCallbackConfig; } + if (isset($this->userAction)) { + $json['user_action'] = $this->userAction; + } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; } diff --git a/src/Models/ShippingPreference.php b/src/Models/VenmoWalletExperienceContextShippingPreference.php similarity index 93% rename from src/Models/ShippingPreference.php rename to src/Models/VenmoWalletExperienceContextShippingPreference.php index c645c60..c57a5a6 100644 --- a/src/Models/ShippingPreference.php +++ b/src/Models/VenmoWalletExperienceContextShippingPreference.php @@ -13,7 +13,7 @@ namespace PaypalServerSdkLib\Models; /** * The location from which the shipping address is derived. */ -class ShippingPreference +class VenmoWalletExperienceContextShippingPreference { /** * Get the customer-provided shipping address on the PayPal site. diff --git a/src/Models/VenmoWalletExperienceContextUserAction.php b/src/Models/VenmoWalletExperienceContextUserAction.php new file mode 100644 index 0000000..cb01d80 --- /dev/null +++ b/src/Models/VenmoWalletExperienceContextUserAction.php @@ -0,0 +1,31 @@ +address = $address; } + /** + * Returns Return Flow. + * Merchant preference on how the buyer can navigate back to merchant website post approving the + * transaction on the Venmo App. + */ + public function getReturnFlow(): ?string + { + return $this->returnFlow; + } + + /** + * Sets Return Flow. + * Merchant preference on how the buyer can navigate back to merchant website post approving the + * transaction on the Venmo App. + * + * @maps return_flow + */ + public function setReturnFlow(?string $returnFlow): void + { + $this->returnFlow = $returnFlow; + } + /** * Returns Attributes. * Additional attributes associated with the use of a Venmo Wallet. @@ -225,6 +252,7 @@ class VenmoWalletResponse implements \JsonSerializable 'name' => $this->name, 'phoneNumber' => $this->phoneNumber, 'address' => $this->address, + 'returnFlow' => $this->returnFlow, 'attributes' => $this->attributes ] ); @@ -260,6 +288,9 @@ class VenmoWalletResponse implements \JsonSerializable if (isset($this->address)) { $json['address'] = $this->address; } + if (isset($this->returnFlow)) { + $json['return_flow'] = $this->returnFlow; + } if (isset($this->attributes)) { $json['attributes'] = $this->attributes; } diff --git a/src/PaypalServerSdkClient.php b/src/PaypalServerSdkClient.php index 09e7caf..cf7c601 100644 --- a/src/PaypalServerSdkClient.php +++ b/src/PaypalServerSdkClient.php @@ -17,6 +17,8 @@ use PaypalServerSdkLib\Authentication\ClientCredentialsAuthManager; use PaypalServerSdkLib\Controllers\OAuthAuthorizationController; use PaypalServerSdkLib\Controllers\OrdersController; use PaypalServerSdkLib\Controllers\PaymentsController; +use PaypalServerSdkLib\Controllers\SubscriptionsController; +use PaypalServerSdkLib\Controllers\TransactionSearchController; use PaypalServerSdkLib\Controllers\VaultController; use PaypalServerSdkLib\Logging\LoggingConfigurationBuilder; use PaypalServerSdkLib\Logging\RequestLoggingConfigurationBuilder; @@ -34,6 +36,10 @@ class PaypalServerSdkClient implements ConfigurationInterface private $vault; + private $transactionSearch; + + private $subscriptions; + private $oAuthAuthorization; private $clientCredentialsAuthManager; @@ -68,7 +74,7 @@ class PaypalServerSdkClient implements ConfigurationInterface ->converter(new CompatibilityConverter()) ->jsonHelper(ApiHelper::getJsonHelper()) ->apiCallback($this->config['httpCallback'] ?? null) - ->userAgent('PayPal REST API PHP SDK, Version: 1.1.0, on OS {os-info}') + ->userAgent('PayPal REST API PHP SDK, Version: 2.0.0, on OS {os-info}') ->serverUrls(self::ENVIRONMENT_MAP[$this->getEnvironment()], Server::DEFAULT_) ->authManagers(['Oauth2' => $this->clientCredentialsAuthManager]) ->loggingConfiguration($loggingConfiguration) @@ -279,6 +285,28 @@ class PaypalServerSdkClient implements ConfigurationInterface return $this->vault; } + /** + * Returns Transaction Search Controller + */ + public function getTransactionSearchController(): TransactionSearchController + { + if ($this->transactionSearch == null) { + $this->transactionSearch = new TransactionSearchController($this->client); + } + return $this->transactionSearch; + } + + /** + * Returns Subscriptions Controller + */ + public function getSubscriptionsController(): SubscriptionsController + { + if ($this->subscriptions == null) { + $this->subscriptions = new SubscriptionsController($this->client); + } + return $this->subscriptions; + } + /** * Returns O Auth Authorization Controller */ diff --git a/src/Proxy/ProxyConfigurationBuilder.php b/src/Proxy/ProxyConfigurationBuilder.php index af46a73..b29e623 100644 --- a/src/Proxy/ProxyConfigurationBuilder.php +++ b/src/Proxy/ProxyConfigurationBuilder.php @@ -2,6 +2,12 @@ declare(strict_types=1); +/* + * PaypalServerSdkLib + * + * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). + */ + namespace PaypalServerSdkLib\Proxy; use PaypalServerSdkLib\ConfigurationDefaults; @@ -63,7 +69,7 @@ class ProxyConfigurationBuilder /** * Set proxy authentication method */ - public function authMethod(string $authMethod): self + public function authMethod(int $authMethod): self { $this->authMethod = $authMethod; return $this; @@ -85,7 +91,7 @@ class ProxyConfigurationBuilder 'port' => $this->port, 'tunnel' => $this->tunnel, 'address' => $this->address, - 'auth' => ['user' => '$this->user', 'pass' => '$this->pass', 'method' => $this->authMethod] + 'auth' => ['user' => $this->user, 'pass' => $this->pass, 'method' => $this->authMethod] ]; } }@sign. However, the generally + * accepted maximum length for an email address is 254 characters. The pattern verifies that an + * unquoted@sign exists.