\"/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.
\"/purchase_units/@reference_id=='default'/{attribute-or-object}\
- ". Merchants and partners can add Level 2 and 3 data to
+ Creates an order. Merchants and partners can add Level 2 and 3 data to
payments to reduce risk and payment processing costs. For more
- information about processing payments, see
- checkout or multiparty checkout.Note: - For error handling and troubleshooting, see Orders v2 errors.Patchable attributes - or - objects:
| Attribute | Op | Notes< - /th> |
|---|---|---|
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[].sh
- ipping.name | replace, - add | |
purchase_units[].shipping.email_add
- ress | replace, - add | |
purchase_units[].shipping.phone_num
- ber | 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_instruc
- tion | replace | |
purchase_un
- its[].payment_instruction.disbursement_mode | replace | -By default, disbursement_mode is
- INSTANT. |
purchase_units[].payment_i
- nstruction.payee_receivable_fx_rate_id | replace, add, - remove | |
purchase_units[].payment_instruc
- tion.platform_fees | replace, add, - remove | |
purchase_units[].supplementary_d
- ata.airline | replace, add, - remove | |
purchase_units[].supplementary_d
- ata.card | replace, add, - remove | |
application_context.client_confi
- guration | 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< + /th> |
|---|---|---|
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[].sh
+ ipping.name | replace, + add | |
purchase_units[].shipping.email_add
+ ress | replace, + add | |
purchase_units[].shipping.phone_num
+ ber | 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_instruc
+ tion | replace | |
purchase_un
+ its[].payment_instruction.disbursement_mode | replace | +By default, disbursement_mode is
+ INSTANT. |
purchase_units[].payment_i
+ nstruction.payee_receivable_fx_rate_id | replace, add, + remove | |
purchase_units[].payment_instruc
+ tion.platform_fees | replace, add, + remove | |
purchase_units[].supplementary_d
+ ata.airline | replace, add, + remove | |
purchase_units[].supplementary_d
+ ata.card | replace, add, + remove | |
application_context.client_confi
+ guration | replace, add |
Note: Up to 64 characters are + allowed before and 255 characters are allowed after the +payer_id (str): The account identifier for a PayPal account. name (Name): The name of the party. phone (PhoneWithType): The phone information. diff --git a/paypalserversdk/models/paypal_reference_id_type.py b/paypalserversdk/models/paypal_reference_id_type.py new file mode 100644 index 0000000..0564c6f --- /dev/null +++ b/paypalserversdk/models/paypal_reference_id_type.py @@ -0,0 +1,31 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" + + +class PaypalReferenceIdType(object): + + """Implementation of the 'PayPal Reference Id Type' enum. + + The PayPal reference ID type. + + Attributes: + ODR: An order ID. + TXN: A transaction ID. + SUB: A subscription ID. + PAP: A pre-approved payment ID. + + """ + ODR = 'ODR' + + TXN = 'TXN' + + SUB = 'SUB' + + PAP = 'PAP' + diff --git a/paypalserversdk/models/paypal_wallet_attributes.py b/paypalserversdk/models/paypal_wallet_attributes.py index 6bd6508..c831312 100644 --- a/paypalserversdk/models/paypal_wallet_attributes.py +++ b/paypalserversdk/models/paypal_wallet_attributes.py @@ -20,8 +20,8 @@ class PaypalWalletAttributes(object): Attributes: customer (PaypalWalletCustomerRequest): The model property of type PaypalWalletCustomerRequest. - vault (PaypalWalletVaultInstruction): The model property of type - PaypalWalletVaultInstruction. + vault (PaypalWalletVaultInstruction): Resource consolidating common + request and response attributes for vaulting PayPal Wallet. """ diff --git a/paypalserversdk/models/paypal_wallet_experience_context.py b/paypalserversdk/models/paypal_wallet_experience_context.py index 9eb5e9f..4fceff4 100644 --- a/paypalserversdk/models/paypal_wallet_experience_context.py +++ b/paypalserversdk/models/paypal_wallet_experience_context.py @@ -7,6 +7,7 @@ https://www.apimatic.io ). """ from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.app_switch_context import AppSwitchContext from paypalserversdk.models.callback_configuration import CallbackConfiguration @@ -41,6 +42,9 @@ class PaypalWalletExperienceContext(object): number) on PayPal's checkout for easy merchant-buyer communication. return_url (str): Describes the URL. cancel_url (str): Describes the URL. + app_switch_context (AppSwitchContext): Merchant provided details of + the native app or mobile web browser to facilitate buyer's app + switch to the PayPal consumer app. landing_page (PaypalExperienceLandingPage): The type of landing page to show on the PayPal site for customer checkout. user_action (PaypalExperienceUserAction): Configures a Continue or Pay @@ -60,6 +64,7 @@ class PaypalWalletExperienceContext(object): "contact_preference": 'contact_preference', "return_url": 'return_url', "cancel_url": 'cancel_url', + "app_switch_context": 'app_switch_context', "landing_page": 'landing_page', "user_action": 'user_action', "payment_method_preference": 'payment_method_preference', @@ -73,6 +78,7 @@ class PaypalWalletExperienceContext(object): 'contact_preference', 'return_url', 'cancel_url', + 'app_switch_context', 'landing_page', 'user_action', 'payment_method_preference', @@ -86,6 +92,7 @@ def __init__(self, contact_preference='NO_CONTACT_INFO', return_url=APIHelper.SKIP, cancel_url=APIHelper.SKIP, + app_switch_context=APIHelper.SKIP, landing_page='NO_PREFERENCE', user_action='CONTINUE', payment_method_preference='UNRESTRICTED', @@ -103,6 +110,8 @@ def __init__(self, self.return_url = return_url if cancel_url is not APIHelper.SKIP: self.cancel_url = cancel_url + if app_switch_context is not APIHelper.SKIP: + self.app_switch_context = app_switch_context self.landing_page = landing_page self.user_action = user_action self.payment_method_preference = payment_method_preference @@ -134,6 +143,7 @@ def from_dictionary(cls, contact_preference = dictionary.get("contact_preference") if dictionary.get("contact_preference") else 'NO_CONTACT_INFO' return_url = dictionary.get("return_url") if dictionary.get("return_url") else APIHelper.SKIP cancel_url = dictionary.get("cancel_url") if dictionary.get("cancel_url") else APIHelper.SKIP + app_switch_context = AppSwitchContext.from_dictionary(dictionary.get('app_switch_context')) if 'app_switch_context' in dictionary.keys() else APIHelper.SKIP landing_page = dictionary.get("landing_page") if dictionary.get("landing_page") else 'NO_PREFERENCE' user_action = dictionary.get("user_action") if dictionary.get("user_action") else 'CONTINUE' payment_method_preference = dictionary.get("payment_method_preference") if dictionary.get("payment_method_preference") else 'UNRESTRICTED' @@ -145,6 +155,7 @@ def from_dictionary(cls, contact_preference, return_url, cancel_url, + app_switch_context, landing_page, user_action, payment_method_preference, @@ -158,6 +169,7 @@ def __repr__(self): f'contact_preference={(self.contact_preference if hasattr(self, "contact_preference") else None)!r}, ' f'return_url={(self.return_url if hasattr(self, "return_url") else None)!r}, ' f'cancel_url={(self.cancel_url if hasattr(self, "cancel_url") else None)!r}, ' + f'app_switch_context={(self.app_switch_context if hasattr(self, "app_switch_context") else None)!r}, ' f'landing_page={(self.landing_page if hasattr(self, "landing_page") else None)!r}, ' f'user_action={(self.user_action if hasattr(self, "user_action") else None)!r}, ' f'payment_method_preference={(self.payment_method_preference if hasattr(self, "payment_method_preference") else None)!r}, ' @@ -171,6 +183,7 @@ def __str__(self): f'contact_preference={(self.contact_preference if hasattr(self, "contact_preference") else None)!s}, ' f'return_url={(self.return_url if hasattr(self, "return_url") else None)!s}, ' f'cancel_url={(self.cancel_url if hasattr(self, "cancel_url") else None)!s}, ' + f'app_switch_context={(self.app_switch_context if hasattr(self, "app_switch_context") else None)!s}, ' f'landing_page={(self.landing_page if hasattr(self, "landing_page") else None)!s}, ' f'user_action={(self.user_action if hasattr(self, "user_action") else None)!s}, ' f'payment_method_preference={(self.payment_method_preference if hasattr(self, "payment_method_preference") else None)!s}, ' diff --git a/paypalserversdk/models/paypal_wallet_response.py b/paypalserversdk/models/paypal_wallet_response.py index 7b0a477..81c097d 100644 --- a/paypalserversdk/models/paypal_wallet_response.py +++ b/paypalserversdk/models/paypal_wallet_response.py @@ -62,6 +62,9 @@ class PaypalWalletResponse(object): details to process a payment using the PayPal wallet billing agreement or a vaulted payment method that has been stored or is intended to be stored. + experience_status (ExperienceStatus): This field indicates the status + of PayPal's Checkout experience throughout the order lifecycle. + The values reflect the current stage of the checkout process. """ @@ -78,7 +81,8 @@ class PaypalWalletResponse(object): "tax_info": 'tax_info', "address": 'address', "attributes": 'attributes', - "stored_credential": 'stored_credential' + "stored_credential": 'stored_credential', + "experience_status": 'experience_status' } _optionals = [ @@ -94,6 +98,7 @@ class PaypalWalletResponse(object): 'address', 'attributes', 'stored_credential', + 'experience_status', ] def __init__(self, @@ -108,7 +113,8 @@ def __init__(self, tax_info=APIHelper.SKIP, address=APIHelper.SKIP, attributes=APIHelper.SKIP, - stored_credential=APIHelper.SKIP): + stored_credential=APIHelper.SKIP, + experience_status=APIHelper.SKIP): """Constructor for the PaypalWalletResponse class""" # Initialize members of the class @@ -136,6 +142,8 @@ def __init__(self, self.attributes = attributes if stored_credential is not APIHelper.SKIP: self.stored_credential = stored_credential + if experience_status is not APIHelper.SKIP: + self.experience_status = experience_status @classmethod def from_dictionary(cls, @@ -168,6 +176,7 @@ def from_dictionary(cls, address = Address.from_dictionary(dictionary.get('address')) if 'address' in dictionary.keys() else APIHelper.SKIP attributes = PaypalWalletAttributesResponse.from_dictionary(dictionary.get('attributes')) if 'attributes' in dictionary.keys() else APIHelper.SKIP stored_credential = PaypalWalletStoredCredential.from_dictionary(dictionary.get('stored_credential')) if 'stored_credential' in dictionary.keys() else APIHelper.SKIP + experience_status = dictionary.get("experience_status") if dictionary.get("experience_status") else APIHelper.SKIP # Return an object of this model return cls(email_address, account_id, @@ -180,7 +189,8 @@ def from_dictionary(cls, tax_info, address, attributes, - stored_credential) + stored_credential, + experience_status) def __repr__(self): return (f'{self.__class__.__name__}(' @@ -195,7 +205,8 @@ def __repr__(self): f'tax_info={(self.tax_info if hasattr(self, "tax_info") else None)!r}, ' f'address={(self.address if hasattr(self, "address") else None)!r}, ' f'attributes={(self.attributes if hasattr(self, "attributes") else None)!r}, ' - f'stored_credential={(self.stored_credential if hasattr(self, "stored_credential") else None)!r})') + f'stored_credential={(self.stored_credential if hasattr(self, "stored_credential") else None)!r}, ' + f'experience_status={(self.experience_status if hasattr(self, "experience_status") else None)!r})') def __str__(self): return (f'{self.__class__.__name__}(' @@ -210,4 +221,5 @@ def __str__(self): f'tax_info={(self.tax_info if hasattr(self, "tax_info") else None)!s}, ' f'address={(self.address if hasattr(self, "address") else None)!s}, ' f'attributes={(self.attributes if hasattr(self, "attributes") else None)!s}, ' - f'stored_credential={(self.stored_credential if hasattr(self, "stored_credential") else None)!s})') + f'stored_credential={(self.stored_credential if hasattr(self, "stored_credential") else None)!s}, ' + f'experience_status={(self.experience_status if hasattr(self, "experience_status") else None)!s})') diff --git a/paypalserversdk/models/paypal_wallet_stored_credential.py b/paypalserversdk/models/paypal_wallet_stored_credential.py index 452b0c0..2aaab54 100644 --- a/paypalserversdk/models/paypal_wallet_stored_credential.py +++ b/paypalserversdk/models/paypal_wallet_stored_credential.py @@ -20,8 +20,8 @@ class PaypalWalletStoredCredential(object): Attributes: payment_initiator (PaymentInitiator): The person or party who initiated or triggered the payment. - charge_pattern (UsagePattern): Expected business/pricing model for the - billing agreement. + charge_pattern (UsagePattern): DEPRECATED. Expected business/pricing + model for the billing agreement, Please use usage_pattern instead. usage_pattern (UsagePattern): Expected business/pricing model for the billing agreement. usage (StoredPaymentSourceUsageType): Indicates if this is a `first` diff --git a/paypalserversdk/models/paypal_wallet_vault_instruction.py b/paypalserversdk/models/paypal_wallet_vault_instruction.py index 2473e86..651fe01 100644 --- a/paypalserversdk/models/paypal_wallet_vault_instruction.py +++ b/paypalserversdk/models/paypal_wallet_vault_instruction.py @@ -13,9 +13,10 @@ class PaypalWalletVaultInstruction(object): """Implementation of the 'PayPal Wallet Vault Instruction' model. + Resource consolidating common request and response attributes for vaulting + PayPal Wallet. + Attributes: - store_in_vault (StoreInVaultInstruction): Defines how and when the - payment source gets vaulted. description (str): The description displayed to PayPal consumer on the approval flow for PayPal, as well as on the PayPal payment token management experience on PayPal.com. @@ -42,7 +43,6 @@ class PaypalWalletVaultInstruction(object): # Create a mapping from Model property names to API property names _names = { "usage_type": 'usage_type', - "store_in_vault": 'store_in_vault', "description": 'description', "usage_pattern": 'usage_pattern', "customer_type": 'customer_type', @@ -50,7 +50,6 @@ class PaypalWalletVaultInstruction(object): } _optionals = [ - 'store_in_vault', 'description', 'usage_pattern', 'customer_type', @@ -59,7 +58,6 @@ class PaypalWalletVaultInstruction(object): def __init__(self, usage_type=None, - store_in_vault=APIHelper.SKIP, description=APIHelper.SKIP, usage_pattern=APIHelper.SKIP, customer_type='CONSUMER', @@ -67,8 +65,6 @@ def __init__(self, """Constructor for the PaypalWalletVaultInstruction class""" # Initialize members of the class - if store_in_vault is not APIHelper.SKIP: - self.store_in_vault = store_in_vault if description is not APIHelper.SKIP: self.description = description if usage_pattern is not APIHelper.SKIP: @@ -97,14 +93,12 @@ def from_dictionary(cls, # Extract variables from the dictionary usage_type = dictionary.get("usage_type") if dictionary.get("usage_type") else None - store_in_vault = dictionary.get("store_in_vault") if dictionary.get("store_in_vault") else APIHelper.SKIP description = dictionary.get("description") if dictionary.get("description") else APIHelper.SKIP usage_pattern = dictionary.get("usage_pattern") if dictionary.get("usage_pattern") else APIHelper.SKIP customer_type = dictionary.get("customer_type") if dictionary.get("customer_type") else 'CONSUMER' permit_multiple_payment_tokens = dictionary.get("permit_multiple_payment_tokens") if dictionary.get("permit_multiple_payment_tokens") else False # Return an object of this model return cls(usage_type, - store_in_vault, description, usage_pattern, customer_type, @@ -112,7 +106,6 @@ def from_dictionary(cls, def __repr__(self): return (f'{self.__class__.__name__}(' - f'store_in_vault={(self.store_in_vault if hasattr(self, "store_in_vault") else None)!r}, ' f'description={(self.description if hasattr(self, "description") else None)!r}, ' f'usage_pattern={(self.usage_pattern if hasattr(self, "usage_pattern") else None)!r}, ' f'usage_type={self.usage_type!r}, ' @@ -121,7 +114,6 @@ def __repr__(self): def __str__(self): return (f'{self.__class__.__name__}(' - f'store_in_vault={(self.store_in_vault if hasattr(self, "store_in_vault") else None)!s}, ' f'description={(self.description if hasattr(self, "description") else None)!s}, ' f'usage_pattern={(self.usage_pattern if hasattr(self, "usage_pattern") else None)!s}, ' f'usage_type={self.usage_type!s}, ' diff --git a/paypalserversdk/models/phone_number.py b/paypalserversdk/models/phone_number.py index b705da7..a9cfa1d 100644 --- a/paypalserversdk/models/phone_number.py +++ b/paypalserversdk/models/phone_number.py @@ -13,6 +13,8 @@ class PhoneNumber(object): """Implementation of the 'Phone Number' model. 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). Attributes: diff --git a/paypalserversdk/models/phone_number_with_country_code.py b/paypalserversdk/models/phone_number_with_country_code.py index 4cac5a5..23fe16e 100644 --- a/paypalserversdk/models/phone_number_with_country_code.py +++ b/paypalserversdk/models/phone_number_with_country_code.py @@ -15,6 +15,8 @@ class PhoneNumberWithCountryCode(object): 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)., The phone number, in its + canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). Attributes: diff --git a/paypalserversdk/models/phone_number_with_optional_country_code.py b/paypalserversdk/models/phone_number_with_optional_country_code.py new file mode 100644 index 0000000..6188f03 --- /dev/null +++ b/paypalserversdk/models/phone_number_with_optional_country_code.py @@ -0,0 +1,88 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper + + +class PhoneNumberWithOptionalCountryCode(object): + + """Implementation of the 'Phone Number With Optional Country Code' model. + + The phone number in its canonical international [E.164 numbering plan + format](https://www.itu.int/rec/T-REC-E.164/en). + + Attributes: + country_code (str): 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). + national_number (str): 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). + + """ + + # Create a mapping from Model property names to API property names + _names = { + "national_number": 'national_number', + "country_code": 'country_code' + } + + _optionals = [ + 'country_code', + ] + + def __init__(self, + national_number=None, + country_code=APIHelper.SKIP): + """Constructor for the PhoneNumberWithOptionalCountryCode class""" + + # Initialize members of the class + if country_code is not APIHelper.SKIP: + self.country_code = country_code + self.national_number = national_number + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + national_number = dictionary.get("national_number") if dictionary.get("national_number") else None + country_code = dictionary.get("country_code") if dictionary.get("country_code") else APIHelper.SKIP + # Return an object of this model + return cls(national_number, + country_code) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'country_code={(self.country_code if hasattr(self, "country_code") else None)!r}, ' + f'national_number={self.national_number!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'country_code={(self.country_code if hasattr(self, "country_code") else None)!s}, ' + f'national_number={self.national_number!s})') diff --git a/paypalserversdk/models/phone_type.py b/paypalserversdk/models/phone_type.py index 7b19b4b..b6b9833 100644 --- a/paypalserversdk/models/phone_type.py +++ b/paypalserversdk/models/phone_type.py @@ -15,11 +15,11 @@ class PhoneType(object): The phone type. Attributes: - FAX: The enum member of type str. - HOME: The enum member of type str. - MOBILE: The enum member of type str. - OTHER: The enum member of type str. - PAGER: The enum member of type str. + FAX: Fax number. + HOME: Home phone number. + MOBILE: Mobile phone number. + OTHER: Other phone number. + PAGER: Pager number. """ FAX = 'FAX' diff --git a/paypalserversdk/models/plan.py b/paypalserversdk/models/plan.py index 615938f..b493eac 100644 --- a/paypalserversdk/models/plan.py +++ b/paypalserversdk/models/plan.py @@ -22,8 +22,6 @@ class Plan(object): billing_cycles (List[BillingCycle]): 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. - product (Any): Product details associated with any one-time product - purchase. one_time_charges (OneTimeCharge): The one-time charge info at the time of checkout. name (str): Name of the recurring plan. @@ -34,26 +32,21 @@ class Plan(object): _names = { "billing_cycles": 'billing_cycles', "one_time_charges": 'one_time_charges', - "product": 'product', "name": 'name' } _optionals = [ - 'product', 'name', ] def __init__(self, billing_cycles=None, one_time_charges=None, - product=APIHelper.SKIP, name=APIHelper.SKIP): """Constructor for the Plan class""" # Initialize members of the class self.billing_cycles = billing_cycles - if product is not APIHelper.SKIP: - self.product = product self.one_time_charges = one_time_charges if name is not APIHelper.SKIP: self.name = name @@ -81,24 +74,20 @@ def from_dictionary(cls, if dictionary.get('billing_cycles') is not None: billing_cycles = [BillingCycle.from_dictionary(x) for x in dictionary.get('billing_cycles')] one_time_charges = OneTimeCharge.from_dictionary(dictionary.get('one_time_charges')) if dictionary.get('one_time_charges') else None - product = dictionary.get("product") if dictionary.get("product") else APIHelper.SKIP name = dictionary.get("name") if dictionary.get("name") else APIHelper.SKIP # Return an object of this model return cls(billing_cycles, one_time_charges, - product, name) def __repr__(self): return (f'{self.__class__.__name__}(' f'billing_cycles={self.billing_cycles!r}, ' - f'product={(self.product if hasattr(self, "product") else None)!r}, ' f'one_time_charges={self.one_time_charges!r}, ' f'name={(self.name if hasattr(self, "name") else None)!r})') def __str__(self): return (f'{self.__class__.__name__}(' f'billing_cycles={self.billing_cycles!s}, ' - f'product={(self.product if hasattr(self, "product") else None)!s}, ' f'one_time_charges={self.one_time_charges!s}, ' f'name={(self.name if hasattr(self, "name") else None)!s})') diff --git a/paypalserversdk/models/plan_collection.py b/paypalserversdk/models/plan_collection.py new file mode 100644 index 0000000..f4850b6 --- /dev/null +++ b/paypalserversdk/models/plan_collection.py @@ -0,0 +1,110 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.billing_plan import BillingPlan +from paypalserversdk.models.link_description import LinkDescription + + +class PlanCollection(object): + + """Implementation of the 'Plan Collection' model. + + The list of plans with details. + + Attributes: + plans (List[BillingPlan]): An array of plans. + total_items (int): The total number of items. + total_pages (int): The total number of pages. + links (List[LinkDescription]): An array of request-related [HATEOAS + links](/docs/api/reference/api-responses/#hateoas-links). + + """ + + # Create a mapping from Model property names to API property names + _names = { + "plans": 'plans', + "total_items": 'total_items', + "total_pages": 'total_pages', + "links": 'links' + } + + _optionals = [ + 'plans', + 'total_items', + 'total_pages', + 'links', + ] + + def __init__(self, + plans=APIHelper.SKIP, + total_items=APIHelper.SKIP, + total_pages=APIHelper.SKIP, + links=APIHelper.SKIP): + """Constructor for the PlanCollection class""" + + # Initialize members of the class + if plans is not APIHelper.SKIP: + self.plans = plans + if total_items is not APIHelper.SKIP: + self.total_items = total_items + if total_pages is not APIHelper.SKIP: + self.total_pages = total_pages + if links is not APIHelper.SKIP: + self.links = links + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + plans = None + if dictionary.get('plans') is not None: + plans = [BillingPlan.from_dictionary(x) for x in dictionary.get('plans')] + else: + plans = APIHelper.SKIP + total_items = dictionary.get("total_items") if dictionary.get("total_items") else APIHelper.SKIP + total_pages = dictionary.get("total_pages") if dictionary.get("total_pages") else APIHelper.SKIP + links = None + if dictionary.get('links') is not None: + links = [LinkDescription.from_dictionary(x) for x in dictionary.get('links')] + else: + links = APIHelper.SKIP + # Return an object of this model + return cls(plans, + total_items, + total_pages, + links) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'plans={(self.plans if hasattr(self, "plans") else None)!r}, ' + f'total_items={(self.total_items if hasattr(self, "total_items") else None)!r}, ' + f'total_pages={(self.total_pages if hasattr(self, "total_pages") else None)!r}, ' + f'links={(self.links if hasattr(self, "links") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'plans={(self.plans if hasattr(self, "plans") else None)!s}, ' + f'total_items={(self.total_items if hasattr(self, "total_items") else None)!s}, ' + f'total_pages={(self.total_pages if hasattr(self, "total_pages") else None)!s}, ' + f'links={(self.links if hasattr(self, "links") else None)!s})') diff --git a/paypalserversdk/models/plan_details.py b/paypalserversdk/models/plan_details.py new file mode 100644 index 0000000..873a7e5 --- /dev/null +++ b/paypalserversdk/models/plan_details.py @@ -0,0 +1,151 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.merchant_preferences import MerchantPreferences +from paypalserversdk.models.payment_preferences import PaymentPreferences +from paypalserversdk.models.subscription_billing_cycle import SubscriptionBillingCycle +from paypalserversdk.models.taxes import Taxes + + +class PlanDetails(object): + + """Implementation of the 'Plan Details' model. + + The plan details. + + Attributes: + product_id (str): The ID for the product. + name (str): The plan name. + description (str): The detailed description of the plan. + billing_cycles (List[SubscriptionBillingCycle]): 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. + payment_preferences (PaymentPreferences): The payment preferences for + a subscription. + merchant_preferences (MerchantPreferences): The merchant preferences + for a subscription. + taxes (Taxes): The tax details. + quantity_supported (bool): Indicates whether you can subscribe to this + plan by providing a quantity for the goods or service. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "product_id": 'product_id', + "name": 'name', + "description": 'description', + "billing_cycles": 'billing_cycles', + "payment_preferences": 'payment_preferences', + "merchant_preferences": 'merchant_preferences', + "taxes": 'taxes', + "quantity_supported": 'quantity_supported' + } + + _optionals = [ + 'product_id', + 'name', + 'description', + 'billing_cycles', + 'payment_preferences', + 'merchant_preferences', + 'taxes', + 'quantity_supported', + ] + + def __init__(self, + product_id=APIHelper.SKIP, + name=APIHelper.SKIP, + description=APIHelper.SKIP, + billing_cycles=APIHelper.SKIP, + payment_preferences=APIHelper.SKIP, + merchant_preferences=APIHelper.SKIP, + taxes=APIHelper.SKIP, + quantity_supported=False): + """Constructor for the PlanDetails class""" + + # Initialize members of the class + if product_id is not APIHelper.SKIP: + self.product_id = product_id + if name is not APIHelper.SKIP: + self.name = name + if description is not APIHelper.SKIP: + self.description = description + if billing_cycles is not APIHelper.SKIP: + self.billing_cycles = billing_cycles + if payment_preferences is not APIHelper.SKIP: + self.payment_preferences = payment_preferences + if merchant_preferences is not APIHelper.SKIP: + self.merchant_preferences = merchant_preferences + if taxes is not APIHelper.SKIP: + self.taxes = taxes + self.quantity_supported = quantity_supported + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + product_id = dictionary.get("product_id") if dictionary.get("product_id") else APIHelper.SKIP + name = dictionary.get("name") if dictionary.get("name") else APIHelper.SKIP + description = dictionary.get("description") if dictionary.get("description") else APIHelper.SKIP + billing_cycles = None + if dictionary.get('billing_cycles') is not None: + billing_cycles = [SubscriptionBillingCycle.from_dictionary(x) for x in dictionary.get('billing_cycles')] + else: + billing_cycles = APIHelper.SKIP + payment_preferences = PaymentPreferences.from_dictionary(dictionary.get('payment_preferences')) if 'payment_preferences' in dictionary.keys() else APIHelper.SKIP + merchant_preferences = MerchantPreferences.from_dictionary(dictionary.get('merchant_preferences')) if 'merchant_preferences' in dictionary.keys() else APIHelper.SKIP + taxes = Taxes.from_dictionary(dictionary.get('taxes')) if 'taxes' in dictionary.keys() else APIHelper.SKIP + quantity_supported = dictionary.get("quantity_supported") if dictionary.get("quantity_supported") else False + # Return an object of this model + return cls(product_id, + name, + description, + billing_cycles, + payment_preferences, + merchant_preferences, + taxes, + quantity_supported) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'product_id={(self.product_id if hasattr(self, "product_id") else None)!r}, ' + f'name={(self.name if hasattr(self, "name") else None)!r}, ' + f'description={(self.description if hasattr(self, "description") else None)!r}, ' + f'billing_cycles={(self.billing_cycles if hasattr(self, "billing_cycles") else None)!r}, ' + f'payment_preferences={(self.payment_preferences if hasattr(self, "payment_preferences") else None)!r}, ' + f'merchant_preferences={(self.merchant_preferences if hasattr(self, "merchant_preferences") else None)!r}, ' + f'taxes={(self.taxes if hasattr(self, "taxes") else None)!r}, ' + f'quantity_supported={(self.quantity_supported if hasattr(self, "quantity_supported") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'product_id={(self.product_id if hasattr(self, "product_id") else None)!s}, ' + f'name={(self.name if hasattr(self, "name") else None)!s}, ' + f'description={(self.description if hasattr(self, "description") else None)!s}, ' + f'billing_cycles={(self.billing_cycles if hasattr(self, "billing_cycles") else None)!s}, ' + f'payment_preferences={(self.payment_preferences if hasattr(self, "payment_preferences") else None)!s}, ' + f'merchant_preferences={(self.merchant_preferences if hasattr(self, "merchant_preferences") else None)!s}, ' + f'taxes={(self.taxes if hasattr(self, "taxes") else None)!s}, ' + f'quantity_supported={(self.quantity_supported if hasattr(self, "quantity_supported") else None)!s})') diff --git a/paypalserversdk/models/plan_override.py b/paypalserversdk/models/plan_override.py new file mode 100644 index 0000000..d27c0c5 --- /dev/null +++ b/paypalserversdk/models/plan_override.py @@ -0,0 +1,102 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.billing_cycle_override import BillingCycleOverride +from paypalserversdk.models.payment_preferences_override import PaymentPreferencesOverride +from paypalserversdk.models.taxes_override import TaxesOverride + + +class PlanOverride(object): + + """Implementation of the 'Plan Override' model. + + An inline plan object to customise the subscription. You can override plan + level default attributes by providing customised values for the + subscription in this object. + + Attributes: + billing_cycles (List[BillingCycleOverride]): 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. + payment_preferences (PaymentPreferencesOverride): The payment + preferences to override at subscription level. + taxes (TaxesOverride): The tax details. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "billing_cycles": 'billing_cycles', + "payment_preferences": 'payment_preferences', + "taxes": 'taxes' + } + + _optionals = [ + 'billing_cycles', + 'payment_preferences', + 'taxes', + ] + + def __init__(self, + billing_cycles=APIHelper.SKIP, + payment_preferences=APIHelper.SKIP, + taxes=APIHelper.SKIP): + """Constructor for the PlanOverride class""" + + # Initialize members of the class + if billing_cycles is not APIHelper.SKIP: + self.billing_cycles = billing_cycles + if payment_preferences is not APIHelper.SKIP: + self.payment_preferences = payment_preferences + if taxes is not APIHelper.SKIP: + self.taxes = taxes + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + billing_cycles = None + if dictionary.get('billing_cycles') is not None: + billing_cycles = [BillingCycleOverride.from_dictionary(x) for x in dictionary.get('billing_cycles')] + else: + billing_cycles = APIHelper.SKIP + payment_preferences = PaymentPreferencesOverride.from_dictionary(dictionary.get('payment_preferences')) if 'payment_preferences' in dictionary.keys() else APIHelper.SKIP + taxes = TaxesOverride.from_dictionary(dictionary.get('taxes')) if 'taxes' in dictionary.keys() else APIHelper.SKIP + # Return an object of this model + return cls(billing_cycles, + payment_preferences, + taxes) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'billing_cycles={(self.billing_cycles if hasattr(self, "billing_cycles") else None)!r}, ' + f'payment_preferences={(self.payment_preferences if hasattr(self, "payment_preferences") else None)!r}, ' + f'taxes={(self.taxes if hasattr(self, "taxes") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'billing_cycles={(self.billing_cycles if hasattr(self, "billing_cycles") else None)!s}, ' + f'payment_preferences={(self.payment_preferences if hasattr(self, "payment_preferences") else None)!s}, ' + f'taxes={(self.taxes if hasattr(self, "taxes") else None)!s})') diff --git a/paypalserversdk/models/plan_request.py b/paypalserversdk/models/plan_request.py new file mode 100644 index 0000000..e75ecdc --- /dev/null +++ b/paypalserversdk/models/plan_request.py @@ -0,0 +1,152 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.merchant_preferences import MerchantPreferences +from paypalserversdk.models.payment_preferences import PaymentPreferences +from paypalserversdk.models.subscription_billing_cycle import SubscriptionBillingCycle +from paypalserversdk.models.taxes import Taxes + + +class PlanRequest(object): + + """Implementation of the 'Plan Request' model. + + The create plan request details. + + Attributes: + product_id (str): The ID of the product created through Catalog + Products API. + name (str): The plan name. + status (PlanRequestStatus): The initial state of the plan. Allowed + input values are CREATED and ACTIVE. + description (str): The detailed description of the plan. + billing_cycles (List[SubscriptionBillingCycle]): 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. + payment_preferences (PaymentPreferences): The payment preferences for + a subscription. + merchant_preferences (MerchantPreferences): The merchant preferences + for a subscription. + taxes (Taxes): The tax details. + quantity_supported (bool): Indicates whether you can subscribe to this + plan by providing a quantity for the goods or service. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "product_id": 'product_id', + "name": 'name', + "billing_cycles": 'billing_cycles', + "payment_preferences": 'payment_preferences', + "status": 'status', + "description": 'description', + "merchant_preferences": 'merchant_preferences', + "taxes": 'taxes', + "quantity_supported": 'quantity_supported' + } + + _optionals = [ + 'status', + 'description', + 'merchant_preferences', + 'taxes', + 'quantity_supported', + ] + + def __init__(self, + product_id=None, + name=None, + billing_cycles=None, + payment_preferences=None, + status='ACTIVE', + description=APIHelper.SKIP, + merchant_preferences=APIHelper.SKIP, + taxes=APIHelper.SKIP, + quantity_supported=False): + """Constructor for the PlanRequest class""" + + # Initialize members of the class + self.product_id = product_id + self.name = name + self.status = status + if description is not APIHelper.SKIP: + self.description = description + self.billing_cycles = billing_cycles + self.payment_preferences = payment_preferences + if merchant_preferences is not APIHelper.SKIP: + self.merchant_preferences = merchant_preferences + if taxes is not APIHelper.SKIP: + self.taxes = taxes + self.quantity_supported = quantity_supported + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + product_id = dictionary.get("product_id") if dictionary.get("product_id") else None + name = dictionary.get("name") if dictionary.get("name") else None + billing_cycles = None + if dictionary.get('billing_cycles') is not None: + billing_cycles = [SubscriptionBillingCycle.from_dictionary(x) for x in dictionary.get('billing_cycles')] + payment_preferences = PaymentPreferences.from_dictionary(dictionary.get('payment_preferences')) if dictionary.get('payment_preferences') else None + status = dictionary.get("status") if dictionary.get("status") else 'ACTIVE' + description = dictionary.get("description") if dictionary.get("description") else APIHelper.SKIP + merchant_preferences = MerchantPreferences.from_dictionary(dictionary.get('merchant_preferences')) if 'merchant_preferences' in dictionary.keys() else APIHelper.SKIP + taxes = Taxes.from_dictionary(dictionary.get('taxes')) if 'taxes' in dictionary.keys() else APIHelper.SKIP + quantity_supported = dictionary.get("quantity_supported") if dictionary.get("quantity_supported") else False + # Return an object of this model + return cls(product_id, + name, + billing_cycles, + payment_preferences, + status, + description, + merchant_preferences, + taxes, + quantity_supported) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'product_id={self.product_id!r}, ' + f'name={self.name!r}, ' + f'status={(self.status if hasattr(self, "status") else None)!r}, ' + f'description={(self.description if hasattr(self, "description") else None)!r}, ' + f'billing_cycles={self.billing_cycles!r}, ' + f'payment_preferences={self.payment_preferences!r}, ' + f'merchant_preferences={(self.merchant_preferences if hasattr(self, "merchant_preferences") else None)!r}, ' + f'taxes={(self.taxes if hasattr(self, "taxes") else None)!r}, ' + f'quantity_supported={(self.quantity_supported if hasattr(self, "quantity_supported") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'product_id={self.product_id!s}, ' + f'name={self.name!s}, ' + f'status={(self.status if hasattr(self, "status") else None)!s}, ' + f'description={(self.description if hasattr(self, "description") else None)!s}, ' + f'billing_cycles={self.billing_cycles!s}, ' + f'payment_preferences={self.payment_preferences!s}, ' + f'merchant_preferences={(self.merchant_preferences if hasattr(self, "merchant_preferences") else None)!s}, ' + f'taxes={(self.taxes if hasattr(self, "taxes") else None)!s}, ' + f'quantity_supported={(self.quantity_supported if hasattr(self, "quantity_supported") else None)!s})') diff --git a/paypalserversdk/models/plan_request_status.py b/paypalserversdk/models/plan_request_status.py new file mode 100644 index 0000000..1ad21f6 --- /dev/null +++ b/paypalserversdk/models/plan_request_status.py @@ -0,0 +1,30 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" + + +class PlanRequestStatus(object): + + """Implementation of the 'Plan Request Status' enum. + + The initial state of the plan. Allowed input values are CREATED and ACTIVE. + + Attributes: + CREATED: The plan was created. You cannot create subscriptions for a + plan in this state. + INACTIVE: The plan is inactive. + ACTIVE: The plan is active. You can only create subscriptions for a + plan in this state. + + """ + CREATED = 'CREATED' + + INACTIVE = 'INACTIVE' + + ACTIVE = 'ACTIVE' + diff --git a/paypalserversdk/models/pricing_tier.py b/paypalserversdk/models/pricing_tier.py new file mode 100644 index 0000000..9f91779 --- /dev/null +++ b/paypalserversdk/models/pricing_tier.py @@ -0,0 +1,88 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.money import Money + + +class PricingTier(object): + + """Implementation of the 'Pricing Tier' model. + + The pricing tier details. + + Attributes: + starting_quantity (str): The starting quantity for the tier. + ending_quantity (str): The ending quantity for the tier. Optional for + the last tier. + amount (Money): The currency and amount for a financial transaction, + such as a balance or payment due. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "starting_quantity": 'starting_quantity', + "amount": 'amount', + "ending_quantity": 'ending_quantity' + } + + _optionals = [ + 'ending_quantity', + ] + + def __init__(self, + starting_quantity=None, + amount=None, + ending_quantity=APIHelper.SKIP): + """Constructor for the PricingTier class""" + + # Initialize members of the class + self.starting_quantity = starting_quantity + if ending_quantity is not APIHelper.SKIP: + self.ending_quantity = ending_quantity + self.amount = amount + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + starting_quantity = dictionary.get("starting_quantity") if dictionary.get("starting_quantity") else None + amount = Money.from_dictionary(dictionary.get('amount')) if dictionary.get('amount') else None + ending_quantity = dictionary.get("ending_quantity") if dictionary.get("ending_quantity") else APIHelper.SKIP + # Return an object of this model + return cls(starting_quantity, + amount, + ending_quantity) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'starting_quantity={self.starting_quantity!r}, ' + f'ending_quantity={(self.ending_quantity if hasattr(self, "ending_quantity") else None)!r}, ' + f'amount={self.amount!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'starting_quantity={self.starting_quantity!s}, ' + f'ending_quantity={(self.ending_quantity if hasattr(self, "ending_quantity") else None)!s}, ' + f'amount={self.amount!s})') diff --git a/paypalserversdk/models/purchase_unit_request.py b/paypalserversdk/models/purchase_unit_request.py index 40cc8a0..c4350c5 100644 --- a/paypalserversdk/models/purchase_unit_request.py +++ b/paypalserversdk/models/purchase_unit_request.py @@ -8,7 +8,7 @@ """ from paypalserversdk.api_helper import APIHelper from paypalserversdk.models.amount_with_breakdown import AmountWithBreakdown -from paypalserversdk.models.item import Item +from paypalserversdk.models.item_request import ItemRequest from paypalserversdk.models.payee_base import PayeeBase from paypalserversdk.models.payment_instruction import PaymentInstruction from paypalserversdk.models.shipping_details import ShippingDetails @@ -42,23 +42,35 @@ class PurchaseUnitRequest(object): instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order. - description (str): 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. + description (str): 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. custom_id (str): The API caller-provided external ID. Used to reconcile client transactions with PayPal transactions. Appears in transaction and settlement reports but is not visible to the payer. invoice_id (str): 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. - soft_descriptor (str): 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: + 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. + soft_descriptor (str): 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: PAYPAL_prefix+(space)+merchant_descriptor+(space)+ soft_descriptor Note: The merchant descriptor is the descriptor of the merchant’s payment receiving preferences which can be seen by logging into @@ -69,8 +81,8 @@ class PurchaseUnitRequest(object): prefix toggle is PAYPAL *. The merchant descriptor in the profile is Janes Gift. The soft descriptor is 800-123-1234. Then, the statement descriptor on the card is PAYPAL * Janes Gift 80. - items (List[Item]): An array of items that the customer purchases from - the merchant. + items (List[ItemRequest]): An array of items that the customer + purchases from the merchant. shipping (ShippingDetails): The shipping details. supplementary_data (SupplementaryData): Supplementary data about a payment. This object passes information that can be used to @@ -173,7 +185,7 @@ def from_dictionary(cls, soft_descriptor = dictionary.get("soft_descriptor") if dictionary.get("soft_descriptor") else APIHelper.SKIP items = None if dictionary.get('items') is not None: - items = [Item.from_dictionary(x) for x in dictionary.get('items')] + items = [ItemRequest.from_dictionary(x) for x in dictionary.get('items')] else: items = APIHelper.SKIP shipping = ShippingDetails.from_dictionary(dictionary.get('shipping')) if 'shipping' in dictionary.keys() else APIHelper.SKIP diff --git a/paypalserversdk/models/reason_code.py b/paypalserversdk/models/reason_code.py new file mode 100644 index 0000000..981baad --- /dev/null +++ b/paypalserversdk/models/reason_code.py @@ -0,0 +1,49 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" + + +class ReasonCode(object): + + """Implementation of the 'Reason Code' enum. + + The reason code for the payment failure. + + Attributes: + PAYMENT_DENIED: PayPal declined the payment due to one or more + customer issues. + INTERNAL_SERVER_ERROR: An internal server error has occurred. + PAYEE_ACCOUNT_RESTRICTED: The payee account is not in good standing + and cannot receive payments. + PAYER_ACCOUNT_RESTRICTED: The payer account is not in good standing + and cannot make payments. + PAYER_CANNOT_PAY: Payer cannot pay for this transaction. + SENDING_LIMIT_EXCEEDED: The transaction exceeds the payer's sending + limit. + TRANSACTION_RECEIVING_LIMIT_EXCEEDED: The transaction exceeds the + receiver's receiving limit. + CURRENCY_MISMATCH: The transaction is declined due to a currency + mismatch. + + """ + PAYMENT_DENIED = 'PAYMENT_DENIED' + + INTERNAL_SERVER_ERROR = 'INTERNAL_SERVER_ERROR' + + PAYEE_ACCOUNT_RESTRICTED = 'PAYEE_ACCOUNT_RESTRICTED' + + PAYER_ACCOUNT_RESTRICTED = 'PAYER_ACCOUNT_RESTRICTED' + + PAYER_CANNOT_PAY = 'PAYER_CANNOT_PAY' + + SENDING_LIMIT_EXCEEDED = 'SENDING_LIMIT_EXCEEDED' + + TRANSACTION_RECEIVING_LIMIT_EXCEEDED = 'TRANSACTION_RECEIVING_LIMIT_EXCEEDED' + + CURRENCY_MISMATCH = 'CURRENCY_MISMATCH' + diff --git a/paypalserversdk/models/reauthorize_request.py b/paypalserversdk/models/reauthorize_request.py index a8ef4a7..b424df1 100644 --- a/paypalserversdk/models/reauthorize_request.py +++ b/paypalserversdk/models/reauthorize_request.py @@ -24,8 +24,7 @@ class ReauthorizeRequest(object): authorized payment once. The allowed amount depends on context and geography, for example in US it is up to 115% of the original authorized amount, not to exceed an increase of $75 USD. Supports only the `amount` - request parameter. Note: This request is currently not supported for - Partner use cases. + request parameter. Attributes: amount (Money): The currency and amount for a financial transaction, diff --git a/paypalserversdk/models/return_flow.py b/paypalserversdk/models/return_flow.py new file mode 100644 index 0000000..fb5d781 --- /dev/null +++ b/paypalserversdk/models/return_flow.py @@ -0,0 +1,31 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" + + +class ReturnFlow(object): + + """Implementation of the 'Return Flow' enum. + + Merchant preference on how the buyer can navigate back to merchant website + post approving the transaction on the Venmo App. + + Attributes: + AUTO: After payment approval in the PayPal App, buyer will + automatically be redirected to the merchant website. + MANUAL: After payment approval in the PayPal App, buyer will be asked + to manually navigate back to the merchant website where they + started the transaction from. The buyer is shown a message like + 'Return to Merchant' to return to the source where the transaction + actually started. + + """ + AUTO = 'AUTO' + + MANUAL = 'MANUAL' + diff --git a/paypalserversdk/models/search_response.py b/paypalserversdk/models/search_response.py new file mode 100644 index 0000000..f792368 --- /dev/null +++ b/paypalserversdk/models/search_response.py @@ -0,0 +1,177 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.link_description import LinkDescription +from paypalserversdk.models.transaction_details import TransactionDetails + + +class SearchResponse(object): + + """Implementation of the 'Search Response' model. + + The search response information. + + Attributes: + transaction_details (List[TransactionDetails]): An array of + transaction detail objects. + account_number (str): The merchant account number. + start_date (str): 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. + end_date (str): 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. + last_refreshed_datetime (str): 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. + page (int): A zero-relative index of transactions. + total_items (int): The total number of transactions as an integer + beginning with the specified `page` in the full result and not + just in this response. + total_pages (int): The total number of pages, as an `integer`, when + the `total_items` is divided into pages of the specified + `page_size`. + links (List[LinkDescription]): An array of request-related [HATEOAS + links](/api/rest/responses/#hateoas-links). + + """ + + # Create a mapping from Model property names to API property names + _names = { + "transaction_details": 'transaction_details', + "account_number": 'account_number', + "start_date": 'start_date', + "end_date": 'end_date', + "last_refreshed_datetime": 'last_refreshed_datetime', + "page": 'page', + "total_items": 'total_items', + "total_pages": 'total_pages', + "links": 'links' + } + + _optionals = [ + 'transaction_details', + 'account_number', + 'start_date', + 'end_date', + 'last_refreshed_datetime', + 'page', + 'total_items', + 'total_pages', + 'links', + ] + + def __init__(self, + transaction_details=APIHelper.SKIP, + account_number=APIHelper.SKIP, + start_date=APIHelper.SKIP, + end_date=APIHelper.SKIP, + last_refreshed_datetime=APIHelper.SKIP, + page=APIHelper.SKIP, + total_items=APIHelper.SKIP, + total_pages=APIHelper.SKIP, + links=APIHelper.SKIP): + """Constructor for the SearchResponse class""" + + # Initialize members of the class + if transaction_details is not APIHelper.SKIP: + self.transaction_details = transaction_details + if account_number is not APIHelper.SKIP: + self.account_number = account_number + if start_date is not APIHelper.SKIP: + self.start_date = start_date + if end_date is not APIHelper.SKIP: + self.end_date = end_date + if last_refreshed_datetime is not APIHelper.SKIP: + self.last_refreshed_datetime = last_refreshed_datetime + if page is not APIHelper.SKIP: + self.page = page + if total_items is not APIHelper.SKIP: + self.total_items = total_items + if total_pages is not APIHelper.SKIP: + self.total_pages = total_pages + if links is not APIHelper.SKIP: + self.links = links + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + transaction_details = None + if dictionary.get('transaction_details') is not None: + transaction_details = [TransactionDetails.from_dictionary(x) for x in dictionary.get('transaction_details')] + else: + transaction_details = APIHelper.SKIP + account_number = dictionary.get("account_number") if dictionary.get("account_number") else APIHelper.SKIP + start_date = dictionary.get("start_date") if dictionary.get("start_date") else APIHelper.SKIP + end_date = dictionary.get("end_date") if dictionary.get("end_date") else APIHelper.SKIP + last_refreshed_datetime = dictionary.get("last_refreshed_datetime") if dictionary.get("last_refreshed_datetime") else APIHelper.SKIP + page = dictionary.get("page") if dictionary.get("page") else APIHelper.SKIP + total_items = dictionary.get("total_items") if dictionary.get("total_items") else APIHelper.SKIP + total_pages = dictionary.get("total_pages") if dictionary.get("total_pages") else APIHelper.SKIP + links = None + if dictionary.get('links') is not None: + links = [LinkDescription.from_dictionary(x) for x in dictionary.get('links')] + else: + links = APIHelper.SKIP + # Return an object of this model + return cls(transaction_details, + account_number, + start_date, + end_date, + last_refreshed_datetime, + page, + total_items, + total_pages, + links) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'transaction_details={(self.transaction_details if hasattr(self, "transaction_details") else None)!r}, ' + f'account_number={(self.account_number if hasattr(self, "account_number") else None)!r}, ' + f'start_date={(self.start_date if hasattr(self, "start_date") else None)!r}, ' + f'end_date={(self.end_date if hasattr(self, "end_date") else None)!r}, ' + f'last_refreshed_datetime={(self.last_refreshed_datetime if hasattr(self, "last_refreshed_datetime") else None)!r}, ' + f'page={(self.page if hasattr(self, "page") else None)!r}, ' + f'total_items={(self.total_items if hasattr(self, "total_items") else None)!r}, ' + f'total_pages={(self.total_pages if hasattr(self, "total_pages") else None)!r}, ' + f'links={(self.links if hasattr(self, "links") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'transaction_details={(self.transaction_details if hasattr(self, "transaction_details") else None)!s}, ' + f'account_number={(self.account_number if hasattr(self, "account_number") else None)!s}, ' + f'start_date={(self.start_date if hasattr(self, "start_date") else None)!s}, ' + f'end_date={(self.end_date if hasattr(self, "end_date") else None)!s}, ' + f'last_refreshed_datetime={(self.last_refreshed_datetime if hasattr(self, "last_refreshed_datetime") else None)!s}, ' + f'page={(self.page if hasattr(self, "page") else None)!s}, ' + f'total_items={(self.total_items if hasattr(self, "total_items") else None)!s}, ' + f'total_pages={(self.total_pages if hasattr(self, "total_pages") else None)!s}, ' + f'links={(self.links if hasattr(self, "links") else None)!s})') diff --git a/paypalserversdk/models/sepa_debit_experience_context.py b/paypalserversdk/models/sepa_debit_experience_context.py new file mode 100644 index 0000000..411dc74 --- /dev/null +++ b/paypalserversdk/models/sepa_debit_experience_context.py @@ -0,0 +1,96 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper + + +class SepaDebitExperienceContext(object): + + """Implementation of the 'SEPA Debit Experience Context' model. + + Customizes the payer experience during the approval process for the SEPA + Debit payment. + + Attributes: + locale (str): 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/). + return_url (str): Describes the URL. + cancel_url (str): Describes the URL. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "return_url": 'return_url', + "cancel_url": 'cancel_url', + "locale": 'locale' + } + + _optionals = [ + 'locale', + ] + + def __init__(self, + return_url=None, + cancel_url=None, + locale=APIHelper.SKIP): + """Constructor for the SepaDebitExperienceContext class""" + + # Initialize members of the class + if locale is not APIHelper.SKIP: + self.locale = locale + self.return_url = return_url + self.cancel_url = cancel_url + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + return_url = dictionary.get("return_url") if dictionary.get("return_url") else None + cancel_url = dictionary.get("cancel_url") if dictionary.get("cancel_url") else None + locale = dictionary.get("locale") if dictionary.get("locale") else APIHelper.SKIP + # Return an object of this model + return cls(return_url, + cancel_url, + locale) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'locale={(self.locale if hasattr(self, "locale") else None)!r}, ' + f'return_url={self.return_url!r}, ' + f'cancel_url={self.cancel_url!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'locale={(self.locale if hasattr(self, "locale") else None)!s}, ' + f'return_url={self.return_url!s}, ' + f'cancel_url={self.cancel_url!s})') diff --git a/paypalserversdk/models/sepa_debit_request.py b/paypalserversdk/models/sepa_debit_request.py new file mode 100644 index 0000000..30defbe --- /dev/null +++ b/paypalserversdk/models/sepa_debit_request.py @@ -0,0 +1,71 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.sepa_debit_experience_context import SepaDebitExperienceContext + + +class SepaDebitRequest(object): + + """Implementation of the 'SEPA Debit Request' model. + + An API resource denoting a request to securely store a SEPA Debit. + + Attributes: + experience_context (SepaDebitExperienceContext): Customizes the payer + experience during the approval process for the SEPA Debit payment. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "experience_context": 'experience_context' + } + + _optionals = [ + 'experience_context', + ] + + def __init__(self, + experience_context=APIHelper.SKIP): + """Constructor for the SepaDebitRequest class""" + + # Initialize members of the class + if experience_context is not APIHelper.SKIP: + self.experience_context = experience_context + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + experience_context = SepaDebitExperienceContext.from_dictionary(dictionary.get('experience_context')) if 'experience_context' in dictionary.keys() else APIHelper.SKIP + # Return an object of this model + return cls(experience_context) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'experience_context={(self.experience_context if hasattr(self, "experience_context") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'experience_context={(self.experience_context if hasattr(self, "experience_context") else None)!s})') diff --git a/paypalserversdk/models/setup_fee_failure_action.py b/paypalserversdk/models/setup_fee_failure_action.py new file mode 100644 index 0000000..4a24d9c --- /dev/null +++ b/paypalserversdk/models/setup_fee_failure_action.py @@ -0,0 +1,28 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" + + +class SetupFeeFailureAction(object): + + """Implementation of the 'Setup Fee Failure Action' enum. + + The action to take on the subscription if the initial payment for the + setup fails. + + Attributes: + CONTINUE: Continues the subscription if the initial payment for the + setup fails. + CANCEL: Cancels the subscription if the initial payment for the setup + fails. + + """ + CONTINUE = 'CONTINUE' + + CANCEL = 'CANCEL' + diff --git a/paypalserversdk/models/setup_token_request_card.py b/paypalserversdk/models/setup_token_request_card.py index 7325bd9..e71ca9d 100644 --- a/paypalserversdk/models/setup_token_request_card.py +++ b/paypalserversdk/models/setup_token_request_card.py @@ -8,7 +8,7 @@ """ from paypalserversdk.api_helper import APIHelper from paypalserversdk.models.address import Address -from paypalserversdk.models.setup_token_card_experience_context import SetupTokenCardExperienceContext +from paypalserversdk.models.vault_card_experience_context import VaultCardExperienceContext class SetupTokenRequestCard(object): @@ -37,8 +37,8 @@ class SetupTokenRequestCard(object): form-controls-the-autocomplete-attribute). verification_method (VaultCardVerificationMethod): The verification method of the card. - experience_context (SetupTokenCardExperienceContext): Customizes the - Vault creation flow experience for your customers. + experience_context (VaultCardExperienceContext): A resource + representing an experience context of vault a card. """ @@ -120,7 +120,7 @@ def from_dictionary(cls, brand = dictionary.get("brand") if dictionary.get("brand") else APIHelper.SKIP billing_address = Address.from_dictionary(dictionary.get('billing_address')) if 'billing_address' in dictionary.keys() else APIHelper.SKIP verification_method = dictionary.get("verification_method") if dictionary.get("verification_method") else APIHelper.SKIP - experience_context = SetupTokenCardExperienceContext.from_dictionary(dictionary.get('experience_context')) if 'experience_context' in dictionary.keys() else APIHelper.SKIP + experience_context = VaultCardExperienceContext.from_dictionary(dictionary.get('experience_context')) if 'experience_context' in dictionary.keys() else APIHelper.SKIP # Return an object of this model return cls(name, number, diff --git a/paypalserversdk/models/setup_token_request_payment_source.py b/paypalserversdk/models/setup_token_request_payment_source.py index b76efe4..3b1ec5e 100644 --- a/paypalserversdk/models/setup_token_request_payment_source.py +++ b/paypalserversdk/models/setup_token_request_payment_source.py @@ -7,7 +7,9 @@ https://www.apimatic.io ). """ from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.bank_request import BankRequest from paypalserversdk.models.setup_token_request_card import SetupTokenRequestCard +from paypalserversdk.models.vault_apple_pay_request import VaultApplePayRequest from paypalserversdk.models.vault_paypal_wallet_request import VaultPaypalWalletRequest from paypalserversdk.models.vault_token_request import VaultTokenRequest from paypalserversdk.models.vault_venmo_request import VaultVenmoRequest @@ -24,10 +26,14 @@ class SetupTokenRequestPaymentSource(object): vault a Card. paypal (VaultPaypalWalletRequest): A resource representing a request to vault PayPal Wallet. - venmo (VaultVenmoRequest): The model property of type - VaultVenmoRequest. + venmo (VaultVenmoRequest): A resource representing a request to vault + Venmo. + apple_pay (VaultApplePayRequest): A resource representing a request to + vault Apple Pay. token (VaultTokenRequest): The Tokenized Payment Source representing a Request to Vault a Token. + bank (BankRequest): A Resource representing a request to vault a Bank + used for ACH Debit. """ @@ -36,21 +42,27 @@ class SetupTokenRequestPaymentSource(object): "card": 'card', "paypal": 'paypal', "venmo": 'venmo', - "token": 'token' + "apple_pay": 'apple_pay', + "token": 'token', + "bank": 'bank' } _optionals = [ 'card', 'paypal', 'venmo', + 'apple_pay', 'token', + 'bank', ] def __init__(self, card=APIHelper.SKIP, paypal=APIHelper.SKIP, venmo=APIHelper.SKIP, - token=APIHelper.SKIP): + apple_pay=APIHelper.SKIP, + token=APIHelper.SKIP, + bank=APIHelper.SKIP): """Constructor for the SetupTokenRequestPaymentSource class""" # Initialize members of the class @@ -60,8 +72,12 @@ def __init__(self, self.paypal = paypal if venmo is not APIHelper.SKIP: self.venmo = venmo + if apple_pay is not APIHelper.SKIP: + self.apple_pay = apple_pay if token is not APIHelper.SKIP: self.token = token + if bank is not APIHelper.SKIP: + self.bank = bank @classmethod def from_dictionary(cls, @@ -85,23 +101,31 @@ def from_dictionary(cls, card = SetupTokenRequestCard.from_dictionary(dictionary.get('card')) if 'card' in dictionary.keys() else APIHelper.SKIP paypal = VaultPaypalWalletRequest.from_dictionary(dictionary.get('paypal')) if 'paypal' in dictionary.keys() else APIHelper.SKIP venmo = VaultVenmoRequest.from_dictionary(dictionary.get('venmo')) if 'venmo' in dictionary.keys() else APIHelper.SKIP + apple_pay = VaultApplePayRequest.from_dictionary(dictionary.get('apple_pay')) if 'apple_pay' in dictionary.keys() else APIHelper.SKIP token = VaultTokenRequest.from_dictionary(dictionary.get('token')) if 'token' in dictionary.keys() else APIHelper.SKIP + bank = BankRequest.from_dictionary(dictionary.get('bank')) if 'bank' in dictionary.keys() else APIHelper.SKIP # Return an object of this model return cls(card, paypal, venmo, - token) + apple_pay, + token, + bank) def __repr__(self): return (f'{self.__class__.__name__}(' f'card={(self.card if hasattr(self, "card") else None)!r}, ' f'paypal={(self.paypal if hasattr(self, "paypal") else None)!r}, ' f'venmo={(self.venmo if hasattr(self, "venmo") else None)!r}, ' - f'token={(self.token if hasattr(self, "token") else None)!r})') + f'apple_pay={(self.apple_pay if hasattr(self, "apple_pay") else None)!r}, ' + f'token={(self.token if hasattr(self, "token") else None)!r}, ' + f'bank={(self.bank if hasattr(self, "bank") else None)!r})') def __str__(self): return (f'{self.__class__.__name__}(' f'card={(self.card if hasattr(self, "card") else None)!s}, ' f'paypal={(self.paypal if hasattr(self, "paypal") else None)!s}, ' f'venmo={(self.venmo if hasattr(self, "venmo") else None)!s}, ' - f'token={(self.token if hasattr(self, "token") else None)!s})') + f'apple_pay={(self.apple_pay if hasattr(self, "apple_pay") else None)!s}, ' + f'token={(self.token if hasattr(self, "token") else None)!s}, ' + f'bank={(self.bank if hasattr(self, "bank") else None)!s})') diff --git a/paypalserversdk/models/setup_token_response.py b/paypalserversdk/models/setup_token_response.py index 2f26909..3ea7cf2 100644 --- a/paypalserversdk/models/setup_token_response.py +++ b/paypalserversdk/models/setup_token_response.py @@ -19,7 +19,9 @@ class SetupTokenResponse(object): Minimal representation of a cached setup token. Attributes: - id (str): The PayPal-generated ID for the vault token. + id (str): 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. customer (Customer): This object defines a customer in your system. Use it to manage customer profiles, save payment methods and contact details. diff --git a/paypalserversdk/models/setup_token_response_payment_source.py b/paypalserversdk/models/setup_token_response_payment_source.py index 209742a..5bd531a 100644 --- a/paypalserversdk/models/setup_token_response_payment_source.py +++ b/paypalserversdk/models/setup_token_response_payment_source.py @@ -21,10 +21,10 @@ class SetupTokenResponsePaymentSource(object): Attributes: card (SetupTokenResponseCard): The model property of type SetupTokenResponseCard. - paypal (PaypalPaymentToken): The model property of type - PaypalPaymentToken. - venmo (VenmoPaymentToken): The model property of type - VenmoPaymentToken. + paypal (PaypalPaymentToken): Full representation of a PayPal Payment + Token. + venmo (VenmoPaymentToken): Full representation of a Venmo Payment + Token. """ diff --git a/paypalserversdk/models/shipment_carrier.py b/paypalserversdk/models/shipment_carrier.py index 8cd2cfb..ee18830 100644 --- a/paypalserversdk/models/shipment_carrier.py +++ b/paypalserversdk/models/shipment_carrier.py @@ -1398,6 +1398,42 @@ class ShipmentCarrier(object): UPS_CHECKER: ups-checker. WINESHIPPING: Wineshipping. SPEDISCI: Spedisci online. + FOURKITES: Fourkites. + ETONAS: Etonas. + FINMILE: Fin Mile. + UNIUNI: Uniuni. + RODONAVES: Rodonaves. + INPOST_IT: Inpost Italy. + TFORCE_FREIGHT: Tforce Freight. + RICHMOM: Rich Mom. + FRANCO: Corriere Franco. + ECPARCEL: Ecparcel. + FEDEX_CHINA: Fedex China. + GOFO_EXPRESS: Gofo Express. + SHIPBOB: Shipbob. + JERSEYPOST_ATLAS: Jersey Post Group. + CORETRAILS: Coretrails. + RHENUS_ITALY: Rhenus Logistics Italy. + JADLOG: Jadlog. + JITSU: Jitsu. + YANWEN_EXPRESS: Yanwen Express. + DASHLINK: Dashlink. + SEINO_SUPER_EXPRESS: Seino Super Express. + FLOSHIP: Floship. + METROSCG: Metro Supply Chain. + SENDPARCEL: Sendparcel. + P2P: P2p. + CN_EXPRESS: Cn Express. + CIRROTRACK: Cirro Track. + LAND_LOGISTICS: Land Logistics. + VEHO: Veho. + MEDLINE: Medline. + VDTRACK: Vdtrack. + SINO_SCM: Sino Scm. + ENUM_3PE_EXPRESS: 3pe Express. + SWIFTX: Swiftx. + SFYDEXPRESS: Sfyd Express. + TOPTRANS: Toptrans. """ DPD_RU = 'DPD_RU' @@ -4152,3 +4188,75 @@ class ShipmentCarrier(object): SPEDISCI = 'SPEDISCI' + FOURKITES = 'FOURKITES' + + ETONAS = 'ETONAS' + + FINMILE = 'FINMILE' + + UNIUNI = 'UNIUNI' + + RODONAVES = 'RODONAVES' + + INPOST_IT = 'INPOST_IT' + + TFORCE_FREIGHT = 'TFORCE_FREIGHT' + + RICHMOM = 'RICHMOM' + + FRANCO = 'FRANCO' + + ECPARCEL = 'ECPARCEL' + + FEDEX_CHINA = 'FEDEX_CHINA' + + GOFO_EXPRESS = 'GOFO_EXPRESS' + + SHIPBOB = 'SHIPBOB' + + JERSEYPOST_ATLAS = 'JERSEYPOST_ATLAS' + + CORETRAILS = 'CORETRAILS' + + RHENUS_ITALY = 'RHENUS_ITALY' + + JADLOG = 'JADLOG' + + JITSU = 'JITSU' + + YANWEN_EXPRESS = 'YANWEN_EXPRESS' + + DASHLINK = 'DASHLINK' + + SEINO_SUPER_EXPRESS = 'SEINO_SUPER_EXPRESS' + + FLOSHIP = 'FLOSHIP' + + METROSCG = 'METROSCG' + + SENDPARCEL = 'SENDPARCEL' + + P2P = 'P2P' + + CN_EXPRESS = 'CN_EXPRESS' + + CIRROTRACK = 'CIRROTRACK' + + LAND_LOGISTICS = 'LAND_LOGISTICS' + + VEHO = 'VEHO' + + MEDLINE = 'MEDLINE' + + VDTRACK = 'VDTRACK' + + SINO_SCM = 'SINO_SCM' + + ENUM_3PE_EXPRESS = '3PE_EXPRESS' + + SWIFTX = 'SWIFTX' + + SFYDEXPRESS = 'SFYDEXPRESS' + + TOPTRANS = 'TOPTRANS' + diff --git a/paypalserversdk/models/shipping_information.py b/paypalserversdk/models/shipping_information.py new file mode 100644 index 0000000..e5969eb --- /dev/null +++ b/paypalserversdk/models/shipping_information.py @@ -0,0 +1,106 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.simple_postal_address_coarse_grained import SimplePostalAddressCoarseGrained + + +class ShippingInformation(object): + + """Implementation of the 'Shipping Information' model. + + The shipping information. + + Attributes: + name (str): The recipient's name. + method (str): The shipping method that is associated with this order. + address (SimplePostalAddressCoarseGrained): A simple postal address + with coarse-grained fields. Do not use for an international + address. Use for backward compatibility only. Does not contain + phone. + secondary_shipping_address (SimplePostalAddressCoarseGrained): A + simple postal address with coarse-grained fields. Do not use for + an international address. Use for backward compatibility only. + Does not contain phone. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "name": 'name', + "method": 'method', + "address": 'address', + "secondary_shipping_address": 'secondary_shipping_address' + } + + _optionals = [ + 'name', + 'method', + 'address', + 'secondary_shipping_address', + ] + + def __init__(self, + name=APIHelper.SKIP, + method=APIHelper.SKIP, + address=APIHelper.SKIP, + secondary_shipping_address=APIHelper.SKIP): + """Constructor for the ShippingInformation class""" + + # Initialize members of the class + if name is not APIHelper.SKIP: + self.name = name + if method is not APIHelper.SKIP: + self.method = method + if address is not APIHelper.SKIP: + self.address = address + if secondary_shipping_address is not APIHelper.SKIP: + self.secondary_shipping_address = secondary_shipping_address + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + name = dictionary.get("name") if dictionary.get("name") else APIHelper.SKIP + method = dictionary.get("method") if dictionary.get("method") else APIHelper.SKIP + address = SimplePostalAddressCoarseGrained.from_dictionary(dictionary.get('address')) if 'address' in dictionary.keys() else APIHelper.SKIP + secondary_shipping_address = SimplePostalAddressCoarseGrained.from_dictionary(dictionary.get('secondary_shipping_address')) if 'secondary_shipping_address' in dictionary.keys() else APIHelper.SKIP + # Return an object of this model + return cls(name, + method, + address, + secondary_shipping_address) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'name={(self.name if hasattr(self, "name") else None)!r}, ' + f'method={(self.method if hasattr(self, "method") else None)!r}, ' + f'address={(self.address if hasattr(self, "address") else None)!r}, ' + f'secondary_shipping_address={(self.secondary_shipping_address if hasattr(self, "secondary_shipping_address") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'name={(self.name if hasattr(self, "name") else None)!s}, ' + f'method={(self.method if hasattr(self, "method") else None)!s}, ' + f'address={(self.address if hasattr(self, "address") else None)!s}, ' + f'secondary_shipping_address={(self.secondary_shipping_address if hasattr(self, "secondary_shipping_address") else None)!s})') diff --git a/paypalserversdk/models/shipping_options_purchase_unit.py b/paypalserversdk/models/shipping_options_purchase_unit.py deleted file mode 100644 index 4e2c05e..0000000 --- a/paypalserversdk/models/shipping_options_purchase_unit.py +++ /dev/null @@ -1,125 +0,0 @@ -# -*- coding: utf-8 -*- - -""" -paypalserversdk - -This file was automatically generated by APIMATIC v3.0 ( - https://www.apimatic.io ). -""" -from paypalserversdk.api_helper import APIHelper -from paypalserversdk.models.amount_with_breakdown import AmountWithBreakdown -from paypalserversdk.models.item import Item -from paypalserversdk.models.shipping_option import ShippingOption - - -class ShippingOptionsPurchaseUnit(object): - - """Implementation of the 'Shipping Options Purchase Unit' model. - - This would contain shipping option and amount data at purchase unit level. - - Attributes: - reference_id (str): 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. - amount (AmountWithBreakdown): 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. - items (List[Item]): An array of items that the customer purchases from - the merchant. - shipping_options (List[ShippingOption]): An array of shipping options - that the payee or merchant offers to the payer to ship or pick up - their items. - - """ - - # Create a mapping from Model property names to API property names - _names = { - "reference_id": 'reference_id', - "amount": 'amount', - "items": 'items', - "shipping_options": 'shipping_options' - } - - _optionals = [ - 'reference_id', - 'amount', - 'items', - 'shipping_options', - ] - - def __init__(self, - reference_id=APIHelper.SKIP, - amount=APIHelper.SKIP, - items=APIHelper.SKIP, - shipping_options=APIHelper.SKIP): - """Constructor for the ShippingOptionsPurchaseUnit class""" - - # Initialize members of the class - if reference_id is not APIHelper.SKIP: - self.reference_id = reference_id - if amount is not APIHelper.SKIP: - self.amount = amount - if items is not APIHelper.SKIP: - self.items = items - if shipping_options is not APIHelper.SKIP: - self.shipping_options = shipping_options - - @classmethod - def from_dictionary(cls, - dictionary): - """Creates an instance of this model from a dictionary - - Args: - dictionary (dictionary): A dictionary representation of the object - as obtained from the deserialization of the server's response. The - keys MUST match property names in the API description. - - Returns: - object: An instance of this structure class. - - """ - - if not isinstance(dictionary, dict) or dictionary is None: - return None - - # Extract variables from the dictionary - reference_id = dictionary.get("reference_id") if dictionary.get("reference_id") else APIHelper.SKIP - amount = AmountWithBreakdown.from_dictionary(dictionary.get('amount')) if 'amount' in dictionary.keys() else APIHelper.SKIP - items = None - if dictionary.get('items') is not None: - items = [Item.from_dictionary(x) for x in dictionary.get('items')] - else: - items = APIHelper.SKIP - shipping_options = None - if dictionary.get('shipping_options') is not None: - shipping_options = [ShippingOption.from_dictionary(x) for x in dictionary.get('shipping_options')] - else: - shipping_options = APIHelper.SKIP - # Return an object of this model - return cls(reference_id, - amount, - items, - shipping_options) - - def __repr__(self): - return (f'{self.__class__.__name__}(' - f'reference_id={(self.reference_id if hasattr(self, "reference_id") else None)!r}, ' - f'amount={(self.amount if hasattr(self, "amount") else None)!r}, ' - f'items={(self.items if hasattr(self, "items") else None)!r}, ' - f'shipping_options={(self.shipping_options if hasattr(self, "shipping_options") else None)!r})') - - def __str__(self): - return (f'{self.__class__.__name__}(' - f'reference_id={(self.reference_id if hasattr(self, "reference_id") else None)!s}, ' - f'amount={(self.amount if hasattr(self, "amount") else None)!s}, ' - f'items={(self.items if hasattr(self, "items") else None)!s}, ' - f'shipping_options={(self.shipping_options if hasattr(self, "shipping_options") else None)!s})') diff --git a/paypalserversdk/models/shipping_with_tracking_details.py b/paypalserversdk/models/shipping_with_tracking_details.py index 10cfac0..900330f 100644 --- a/paypalserversdk/models/shipping_with_tracking_details.py +++ b/paypalserversdk/models/shipping_with_tracking_details.py @@ -9,7 +9,7 @@ from paypalserversdk.api_helper import APIHelper from paypalserversdk.models.address import Address from paypalserversdk.models.order_tracker_response import OrderTrackerResponse -from paypalserversdk.models.phone_number_with_country_code import PhoneNumberWithCountryCode +from paypalserversdk.models.phone_number_with_optional_country_code import PhoneNumberWithOptionalCountryCode from paypalserversdk.models.shipping_name import ShippingName from paypalserversdk.models.shipping_option import ShippingOption @@ -18,17 +18,17 @@ class ShippingWithTrackingDetails(object): """Implementation of the 'Shipping With Tracking Details' model. - The order shipping details. - Attributes: + trackers (List[OrderTrackerResponse]): An array of trackers for a + transaction. name (ShippingName): The name of the party. email_address (str): 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. - phone_number (PhoneNumberWithCountryCode): The phone number in its - canonical international [E.164 numbering plan + phone_number (PhoneNumberWithOptionalCountryCode): The phone number in + its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). mtype (FulfillmentType): A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either `type` or @@ -42,43 +42,43 @@ class ShippingWithTrackingDetails(object): form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling- form-controls-the-autocomplete-attribute). - trackers (List[OrderTrackerResponse]): An array of trackers for a - transaction. """ # Create a mapping from Model property names to API property names _names = { + "trackers": 'trackers', "name": 'name', "email_address": 'email_address', "phone_number": 'phone_number', "mtype": 'type', "options": 'options', - "address": 'address', - "trackers": 'trackers' + "address": 'address' } _optionals = [ + 'trackers', 'name', 'email_address', 'phone_number', 'mtype', 'options', 'address', - 'trackers', ] def __init__(self, + trackers=APIHelper.SKIP, name=APIHelper.SKIP, email_address=APIHelper.SKIP, phone_number=APIHelper.SKIP, mtype=APIHelper.SKIP, options=APIHelper.SKIP, - address=APIHelper.SKIP, - trackers=APIHelper.SKIP): + address=APIHelper.SKIP): """Constructor for the ShippingWithTrackingDetails class""" # Initialize members of the class + if trackers is not APIHelper.SKIP: + self.trackers = trackers if name is not APIHelper.SKIP: self.name = name if email_address is not APIHelper.SKIP: @@ -91,8 +91,6 @@ def __init__(self, self.options = options if address is not APIHelper.SKIP: self.address = address - if trackers is not APIHelper.SKIP: - self.trackers = trackers @classmethod def from_dictionary(cls, @@ -113,9 +111,14 @@ def from_dictionary(cls, return None # Extract variables from the dictionary + trackers = None + if dictionary.get('trackers') is not None: + trackers = [OrderTrackerResponse.from_dictionary(x) for x in dictionary.get('trackers')] + else: + trackers = APIHelper.SKIP name = ShippingName.from_dictionary(dictionary.get('name')) if 'name' in dictionary.keys() else APIHelper.SKIP email_address = dictionary.get("email_address") if dictionary.get("email_address") else APIHelper.SKIP - phone_number = PhoneNumberWithCountryCode.from_dictionary(dictionary.get('phone_number')) if 'phone_number' in dictionary.keys() else APIHelper.SKIP + phone_number = PhoneNumberWithOptionalCountryCode.from_dictionary(dictionary.get('phone_number')) if 'phone_number' in dictionary.keys() else APIHelper.SKIP mtype = dictionary.get("type") if dictionary.get("type") else APIHelper.SKIP options = None if dictionary.get('options') is not None: @@ -123,36 +126,31 @@ def from_dictionary(cls, else: options = APIHelper.SKIP address = Address.from_dictionary(dictionary.get('address')) if 'address' in dictionary.keys() else APIHelper.SKIP - trackers = None - if dictionary.get('trackers') is not None: - trackers = [OrderTrackerResponse.from_dictionary(x) for x in dictionary.get('trackers')] - else: - trackers = APIHelper.SKIP # Return an object of this model - return cls(name, + return cls(trackers, + name, email_address, phone_number, mtype, options, - address, - trackers) + address) def __repr__(self): return (f'{self.__class__.__name__}(' + f'trackers={(self.trackers if hasattr(self, "trackers") else None)!r}, ' f'name={(self.name if hasattr(self, "name") else None)!r}, ' f'email_address={(self.email_address if hasattr(self, "email_address") else None)!r}, ' f'phone_number={(self.phone_number if hasattr(self, "phone_number") else None)!r}, ' f'mtype={(self.mtype if hasattr(self, "mtype") else None)!r}, ' f'options={(self.options if hasattr(self, "options") else None)!r}, ' - f'address={(self.address if hasattr(self, "address") else None)!r}, ' - f'trackers={(self.trackers if hasattr(self, "trackers") else None)!r})') + f'address={(self.address if hasattr(self, "address") else None)!r})') def __str__(self): return (f'{self.__class__.__name__}(' + f'trackers={(self.trackers if hasattr(self, "trackers") else None)!s}, ' f'name={(self.name if hasattr(self, "name") else None)!s}, ' f'email_address={(self.email_address if hasattr(self, "email_address") else None)!s}, ' f'phone_number={(self.phone_number if hasattr(self, "phone_number") else None)!s}, ' f'mtype={(self.mtype if hasattr(self, "mtype") else None)!s}, ' f'options={(self.options if hasattr(self, "options") else None)!s}, ' - f'address={(self.address if hasattr(self, "address") else None)!s}, ' - f'trackers={(self.trackers if hasattr(self, "trackers") else None)!s})') + f'address={(self.address if hasattr(self, "address") else None)!s})') diff --git a/paypalserversdk/models/simple_postal_address_coarse_grained.py b/paypalserversdk/models/simple_postal_address_coarse_grained.py new file mode 100644 index 0000000..74a7f44 --- /dev/null +++ b/paypalserversdk/models/simple_postal_address_coarse_grained.py @@ -0,0 +1,139 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper + + +class SimplePostalAddressCoarseGrained(object): + + """Implementation of the 'Simple Postal Address (Coarse-Grained)' model. + + A simple postal address with coarse-grained fields. Do not use for an + international address. Use for backward compatibility only. Does not + contain phone. + + Attributes: + line_1 (str): The first line of the address. For example, number or + street. + line_2 (str): The second line of the address. For example, suite or + apartment number. + city (str): The city name. + state (str): 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. + country_code (str): 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. + postal_code (str): 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). + + """ + + # Create a mapping from Model property names to API property names + _names = { + "line_1": 'line1', + "city": 'city', + "country_code": 'country_code', + "line_2": 'line2', + "state": 'state', + "postal_code": 'postal_code' + } + + _optionals = [ + 'line_2', + 'state', + 'postal_code', + ] + + def __init__(self, + line_1=None, + city=None, + country_code=None, + line_2=APIHelper.SKIP, + state=APIHelper.SKIP, + postal_code=APIHelper.SKIP): + """Constructor for the SimplePostalAddressCoarseGrained class""" + + # Initialize members of the class + self.line_1 = line_1 + if line_2 is not APIHelper.SKIP: + self.line_2 = line_2 + self.city = city + if state is not APIHelper.SKIP: + self.state = state + self.country_code = country_code + if postal_code is not APIHelper.SKIP: + self.postal_code = postal_code + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + line_1 = dictionary.get("line1") if dictionary.get("line1") else None + city = dictionary.get("city") if dictionary.get("city") else None + country_code = dictionary.get("country_code") if dictionary.get("country_code") else None + line_2 = dictionary.get("line2") if dictionary.get("line2") else APIHelper.SKIP + state = dictionary.get("state") if dictionary.get("state") else APIHelper.SKIP + postal_code = dictionary.get("postal_code") if dictionary.get("postal_code") else APIHelper.SKIP + # Return an object of this model + return cls(line_1, + city, + country_code, + line_2, + state, + postal_code) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'line_1={self.line_1!r}, ' + f'line_2={(self.line_2 if hasattr(self, "line_2") else None)!r}, ' + f'city={self.city!r}, ' + f'state={(self.state if hasattr(self, "state") else None)!r}, ' + f'country_code={self.country_code!r}, ' + f'postal_code={(self.postal_code if hasattr(self, "postal_code") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'line_1={self.line_1!s}, ' + f'line_2={(self.line_2 if hasattr(self, "line_2") else None)!s}, ' + f'city={self.city!s}, ' + f'state={(self.state if hasattr(self, "state") else None)!s}, ' + f'country_code={self.country_code!s}, ' + f'postal_code={(self.postal_code if hasattr(self, "postal_code") else None)!s})') diff --git a/paypalserversdk/models/store_information.py b/paypalserversdk/models/store_information.py new file mode 100644 index 0000000..b5573f3 --- /dev/null +++ b/paypalserversdk/models/store_information.py @@ -0,0 +1,81 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper + + +class StoreInformation(object): + + """Implementation of the 'Store Information' model. + + The store information. + + Attributes: + store_id (str): The ID of a store for a merchant in the system of + record. + terminal_id (str): The terminal ID for the checkout stand in a + merchant store. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "store_id": 'store_id', + "terminal_id": 'terminal_id' + } + + _optionals = [ + 'store_id', + 'terminal_id', + ] + + def __init__(self, + store_id=APIHelper.SKIP, + terminal_id=APIHelper.SKIP): + """Constructor for the StoreInformation class""" + + # Initialize members of the class + if store_id is not APIHelper.SKIP: + self.store_id = store_id + if terminal_id is not APIHelper.SKIP: + self.terminal_id = terminal_id + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + store_id = dictionary.get("store_id") if dictionary.get("store_id") else APIHelper.SKIP + terminal_id = dictionary.get("terminal_id") if dictionary.get("terminal_id") else APIHelper.SKIP + # Return an object of this model + return cls(store_id, + terminal_id) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'store_id={(self.store_id if hasattr(self, "store_id") else None)!r}, ' + f'terminal_id={(self.terminal_id if hasattr(self, "terminal_id") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'store_id={(self.store_id if hasattr(self, "store_id") else None)!s}, ' + f'terminal_id={(self.terminal_id if hasattr(self, "terminal_id") else None)!s})') diff --git a/paypalserversdk/models/stored_payment_source.py b/paypalserversdk/models/stored_payment_source.py index edd95b2..bffe4dd 100644 --- a/paypalserversdk/models/stored_payment_source.py +++ b/paypalserversdk/models/stored_payment_source.py @@ -7,7 +7,7 @@ https://www.apimatic.io ). """ from paypalserversdk.api_helper import APIHelper -from paypalserversdk.models.network_transaction_reference import NetworkTransactionReference +from paypalserversdk.models.network_transaction import NetworkTransaction class StoredPaymentSource(object): @@ -33,9 +33,8 @@ class StoredPaymentSource(object): usage (StoredPaymentSourceUsageType): Indicates if this is a `first` or `subsequent` payment using a stored payment source (also referred to as stored credential or card on file). - previous_network_transaction_reference (NetworkTransactionReference): - Reference values used by the card network to identify a - transaction. + previous_network_transaction_reference (NetworkTransaction): Reference + values used by the card network to identify a transaction. """ @@ -88,7 +87,7 @@ def from_dictionary(cls, payment_initiator = dictionary.get("payment_initiator") if dictionary.get("payment_initiator") else None payment_type = dictionary.get("payment_type") if dictionary.get("payment_type") else None usage = dictionary.get("usage") if dictionary.get("usage") else 'DERIVED' - previous_network_transaction_reference = NetworkTransactionReference.from_dictionary(dictionary.get('previous_network_transaction_reference')) if 'previous_network_transaction_reference' in dictionary.keys() else APIHelper.SKIP + previous_network_transaction_reference = NetworkTransaction.from_dictionary(dictionary.get('previous_network_transaction_reference')) if 'previous_network_transaction_reference' in dictionary.keys() else APIHelper.SKIP # Return an object of this model return cls(payment_initiator, payment_type, diff --git a/paypalserversdk/models/subscriber.py b/paypalserversdk/models/subscriber.py new file mode 100644 index 0000000..f4d85de --- /dev/null +++ b/paypalserversdk/models/subscriber.py @@ -0,0 +1,93 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.name import Name +from paypalserversdk.models.shipping_details import ShippingDetails +from paypalserversdk.models.subscription_payment_source_response import SubscriptionPaymentSourceResponse + + +class Subscriber(object): + + """Implementation of the 'Subscriber' model. + + The subscriber response information. + + Attributes: + name (Name): The name of the party. + shipping_address (ShippingDetails): The shipping details. + payment_source (SubscriptionPaymentSourceResponse): The payment source + used to fund the payment. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "name": 'name', + "shipping_address": 'shipping_address', + "payment_source": 'payment_source' + } + + _optionals = [ + 'name', + 'shipping_address', + 'payment_source', + ] + + def __init__(self, + name=APIHelper.SKIP, + shipping_address=APIHelper.SKIP, + payment_source=APIHelper.SKIP): + """Constructor for the Subscriber class""" + + # Initialize members of the class + if name is not APIHelper.SKIP: + self.name = name + if shipping_address is not APIHelper.SKIP: + self.shipping_address = shipping_address + if payment_source is not APIHelper.SKIP: + self.payment_source = payment_source + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + name = Name.from_dictionary(dictionary.get('name')) if 'name' in dictionary.keys() else APIHelper.SKIP + shipping_address = ShippingDetails.from_dictionary(dictionary.get('shipping_address')) if 'shipping_address' in dictionary.keys() else APIHelper.SKIP + payment_source = SubscriptionPaymentSourceResponse.from_dictionary(dictionary.get('payment_source')) if 'payment_source' in dictionary.keys() else APIHelper.SKIP + # Return an object of this model + return cls(name, + shipping_address, + payment_source) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'name={(self.name if hasattr(self, "name") else None)!r}, ' + f'shipping_address={(self.shipping_address if hasattr(self, "shipping_address") else None)!r}, ' + f'payment_source={(self.payment_source if hasattr(self, "payment_source") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'name={(self.name if hasattr(self, "name") else None)!s}, ' + f'shipping_address={(self.shipping_address if hasattr(self, "shipping_address") else None)!s}, ' + f'payment_source={(self.payment_source if hasattr(self, "payment_source") else None)!s})') diff --git a/paypalserversdk/models/subscriber_request.py b/paypalserversdk/models/subscriber_request.py new file mode 100644 index 0000000..c575878 --- /dev/null +++ b/paypalserversdk/models/subscriber_request.py @@ -0,0 +1,108 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.name import Name +from paypalserversdk.models.phone_with_type import PhoneWithType +from paypalserversdk.models.shipping_details import ShippingDetails +from paypalserversdk.models.subscription_payment_source import SubscriptionPaymentSource + + +class SubscriberRequest(object): + + """Implementation of the 'Subscriber Request' model. + + The subscriber request information . + + Attributes: + name (Name): The name of the party. + phone (PhoneWithType): The phone information. + shipping_address (ShippingDetails): The shipping details. + payment_source (SubscriptionPaymentSource): 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. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "name": 'name', + "phone": 'phone', + "shipping_address": 'shipping_address', + "payment_source": 'payment_source' + } + + _optionals = [ + 'name', + 'phone', + 'shipping_address', + 'payment_source', + ] + + def __init__(self, + name=APIHelper.SKIP, + phone=APIHelper.SKIP, + shipping_address=APIHelper.SKIP, + payment_source=APIHelper.SKIP): + """Constructor for the SubscriberRequest class""" + + # Initialize members of the class + if name is not APIHelper.SKIP: + self.name = name + if phone is not APIHelper.SKIP: + self.phone = phone + if shipping_address is not APIHelper.SKIP: + self.shipping_address = shipping_address + if payment_source is not APIHelper.SKIP: + self.payment_source = payment_source + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + name = Name.from_dictionary(dictionary.get('name')) if 'name' in dictionary.keys() else APIHelper.SKIP + phone = PhoneWithType.from_dictionary(dictionary.get('phone')) if 'phone' in dictionary.keys() else APIHelper.SKIP + shipping_address = ShippingDetails.from_dictionary(dictionary.get('shipping_address')) if 'shipping_address' in dictionary.keys() else APIHelper.SKIP + payment_source = SubscriptionPaymentSource.from_dictionary(dictionary.get('payment_source')) if 'payment_source' in dictionary.keys() else APIHelper.SKIP + # Return an object of this model + return cls(name, + phone, + shipping_address, + payment_source) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'name={(self.name if hasattr(self, "name") else None)!r}, ' + f'phone={(self.phone if hasattr(self, "phone") else None)!r}, ' + f'shipping_address={(self.shipping_address if hasattr(self, "shipping_address") else None)!r}, ' + f'payment_source={(self.payment_source if hasattr(self, "payment_source") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'name={(self.name if hasattr(self, "name") else None)!s}, ' + f'phone={(self.phone if hasattr(self, "phone") else None)!s}, ' + f'shipping_address={(self.shipping_address if hasattr(self, "shipping_address") else None)!s}, ' + f'payment_source={(self.payment_source if hasattr(self, "payment_source") else None)!s})') diff --git a/paypalserversdk/models/subscription.py b/paypalserversdk/models/subscription.py new file mode 100644 index 0000000..9d09f45 --- /dev/null +++ b/paypalserversdk/models/subscription.py @@ -0,0 +1,215 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.link_description import LinkDescription +from paypalserversdk.models.money import Money +from paypalserversdk.models.plan_details import PlanDetails +from paypalserversdk.models.subscriber import Subscriber +from paypalserversdk.models.subscription_billing_information import SubscriptionBillingInformation + + +class Subscription(object): + + """Implementation of the 'Subscription' model. + + The subscription details. + + Attributes: + id (str): The PayPal-generated ID for the subscription. + plan_id (str): The ID of the plan. + start_time (str): 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. + quantity (str): The quantity of the product in the subscription. + shipping_amount (Money): The currency and amount for a financial + transaction, such as a balance or payment due. + subscriber (Subscriber): The subscriber response information. + billing_info (SubscriptionBillingInformation): The billing details for + the subscription. If the subscription was or is active, these + fields are populated. + create_time (str): 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. + update_time (str): 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. + custom_id (str): The custom id for the subscription. Can be invoice id. + plan_overridden (bool): Indicates whether the subscription has + overridden any plan attributes. + plan (PlanDetails): The plan details. + links (List[LinkDescription]): An array of request-related [HATEOAS + links](/docs/api/reference/api-responses/#hateoas-links). + + """ + + # Create a mapping from Model property names to API property names + _names = { + "id": 'id', + "plan_id": 'plan_id', + "start_time": 'start_time', + "quantity": 'quantity', + "shipping_amount": 'shipping_amount', + "subscriber": 'subscriber', + "billing_info": 'billing_info', + "create_time": 'create_time', + "update_time": 'update_time', + "custom_id": 'custom_id', + "plan_overridden": 'plan_overridden', + "plan": 'plan', + "links": 'links' + } + + _optionals = [ + 'id', + 'plan_id', + 'start_time', + 'quantity', + 'shipping_amount', + 'subscriber', + 'billing_info', + 'create_time', + 'update_time', + 'custom_id', + 'plan_overridden', + 'plan', + 'links', + ] + + def __init__(self, + id=APIHelper.SKIP, + plan_id=APIHelper.SKIP, + start_time=APIHelper.SKIP, + quantity=APIHelper.SKIP, + shipping_amount=APIHelper.SKIP, + subscriber=APIHelper.SKIP, + billing_info=APIHelper.SKIP, + create_time=APIHelper.SKIP, + update_time=APIHelper.SKIP, + custom_id=APIHelper.SKIP, + plan_overridden=APIHelper.SKIP, + plan=APIHelper.SKIP, + links=APIHelper.SKIP): + """Constructor for the Subscription class""" + + # Initialize members of the class + if id is not APIHelper.SKIP: + self.id = id + if plan_id is not APIHelper.SKIP: + self.plan_id = plan_id + if start_time is not APIHelper.SKIP: + self.start_time = start_time + if quantity is not APIHelper.SKIP: + self.quantity = quantity + if shipping_amount is not APIHelper.SKIP: + self.shipping_amount = shipping_amount + if subscriber is not APIHelper.SKIP: + self.subscriber = subscriber + if billing_info is not APIHelper.SKIP: + self.billing_info = billing_info + if create_time is not APIHelper.SKIP: + self.create_time = create_time + if update_time is not APIHelper.SKIP: + self.update_time = update_time + if custom_id is not APIHelper.SKIP: + self.custom_id = custom_id + if plan_overridden is not APIHelper.SKIP: + self.plan_overridden = plan_overridden + if plan is not APIHelper.SKIP: + self.plan = plan + if links is not APIHelper.SKIP: + self.links = links + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + id = dictionary.get("id") if dictionary.get("id") else APIHelper.SKIP + plan_id = dictionary.get("plan_id") if dictionary.get("plan_id") else APIHelper.SKIP + start_time = dictionary.get("start_time") if dictionary.get("start_time") else APIHelper.SKIP + quantity = dictionary.get("quantity") if dictionary.get("quantity") else APIHelper.SKIP + shipping_amount = Money.from_dictionary(dictionary.get('shipping_amount')) if 'shipping_amount' in dictionary.keys() else APIHelper.SKIP + subscriber = Subscriber.from_dictionary(dictionary.get('subscriber')) if 'subscriber' in dictionary.keys() else APIHelper.SKIP + billing_info = SubscriptionBillingInformation.from_dictionary(dictionary.get('billing_info')) if 'billing_info' in dictionary.keys() else APIHelper.SKIP + create_time = dictionary.get("create_time") if dictionary.get("create_time") else APIHelper.SKIP + update_time = dictionary.get("update_time") if dictionary.get("update_time") else APIHelper.SKIP + custom_id = dictionary.get("custom_id") if dictionary.get("custom_id") else APIHelper.SKIP + plan_overridden = dictionary.get("plan_overridden") if "plan_overridden" in dictionary.keys() else APIHelper.SKIP + plan = PlanDetails.from_dictionary(dictionary.get('plan')) if 'plan' in dictionary.keys() else APIHelper.SKIP + links = None + if dictionary.get('links') is not None: + links = [LinkDescription.from_dictionary(x) for x in dictionary.get('links')] + else: + links = APIHelper.SKIP + # Return an object of this model + return cls(id, + plan_id, + start_time, + quantity, + shipping_amount, + subscriber, + billing_info, + create_time, + update_time, + custom_id, + plan_overridden, + plan, + links) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={(self.id if hasattr(self, "id") else None)!r}, ' + f'plan_id={(self.plan_id if hasattr(self, "plan_id") else None)!r}, ' + f'start_time={(self.start_time if hasattr(self, "start_time") else None)!r}, ' + f'quantity={(self.quantity if hasattr(self, "quantity") else None)!r}, ' + f'shipping_amount={(self.shipping_amount if hasattr(self, "shipping_amount") else None)!r}, ' + f'subscriber={(self.subscriber if hasattr(self, "subscriber") else None)!r}, ' + f'billing_info={(self.billing_info if hasattr(self, "billing_info") else None)!r}, ' + f'create_time={(self.create_time if hasattr(self, "create_time") else None)!r}, ' + f'update_time={(self.update_time if hasattr(self, "update_time") else None)!r}, ' + f'custom_id={(self.custom_id if hasattr(self, "custom_id") else None)!r}, ' + f'plan_overridden={(self.plan_overridden if hasattr(self, "plan_overridden") else None)!r}, ' + f'plan={(self.plan if hasattr(self, "plan") else None)!r}, ' + f'links={(self.links if hasattr(self, "links") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={(self.id if hasattr(self, "id") else None)!s}, ' + f'plan_id={(self.plan_id if hasattr(self, "plan_id") else None)!s}, ' + f'start_time={(self.start_time if hasattr(self, "start_time") else None)!s}, ' + f'quantity={(self.quantity if hasattr(self, "quantity") else None)!s}, ' + f'shipping_amount={(self.shipping_amount if hasattr(self, "shipping_amount") else None)!s}, ' + f'subscriber={(self.subscriber if hasattr(self, "subscriber") else None)!s}, ' + f'billing_info={(self.billing_info if hasattr(self, "billing_info") else None)!s}, ' + f'create_time={(self.create_time if hasattr(self, "create_time") else None)!s}, ' + f'update_time={(self.update_time if hasattr(self, "update_time") else None)!s}, ' + f'custom_id={(self.custom_id if hasattr(self, "custom_id") else None)!s}, ' + f'plan_overridden={(self.plan_overridden if hasattr(self, "plan_overridden") else None)!s}, ' + f'plan={(self.plan if hasattr(self, "plan") else None)!s}, ' + f'links={(self.links if hasattr(self, "links") else None)!s})') diff --git a/paypalserversdk/models/subscription_amount_with_breakdown.py b/paypalserversdk/models/subscription_amount_with_breakdown.py new file mode 100644 index 0000000..11dfd43 --- /dev/null +++ b/paypalserversdk/models/subscription_amount_with_breakdown.py @@ -0,0 +1,125 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.money import Money + + +class SubscriptionAmountWithBreakdown(object): + + """Implementation of the 'Subscription Amount with Breakdown' model. + + The breakdown details for the amount. Includes the gross, tax, fee, and + shipping amounts. + + Attributes: + gross_amount (Money): The currency and amount for a financial + transaction, such as a balance or payment due. + total_item_amount (Money): The currency and amount for a financial + transaction, such as a balance or payment due. + fee_amount (Money): The currency and amount for a financial + transaction, such as a balance or payment due. + shipping_amount (Money): The currency and amount for a financial + transaction, such as a balance or payment due. + tax_amount (Money): The currency and amount for a financial + transaction, such as a balance or payment due. + net_amount (Money): The currency and amount for a financial + transaction, such as a balance or payment due. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "gross_amount": 'gross_amount', + "total_item_amount": 'total_item_amount', + "fee_amount": 'fee_amount', + "shipping_amount": 'shipping_amount', + "tax_amount": 'tax_amount', + "net_amount": 'net_amount' + } + + _optionals = [ + 'total_item_amount', + 'fee_amount', + 'shipping_amount', + 'tax_amount', + 'net_amount', + ] + + def __init__(self, + gross_amount=None, + total_item_amount=APIHelper.SKIP, + fee_amount=APIHelper.SKIP, + shipping_amount=APIHelper.SKIP, + tax_amount=APIHelper.SKIP, + net_amount=APIHelper.SKIP): + """Constructor for the SubscriptionAmountWithBreakdown class""" + + # Initialize members of the class + self.gross_amount = gross_amount + if total_item_amount is not APIHelper.SKIP: + self.total_item_amount = total_item_amount + if fee_amount is not APIHelper.SKIP: + self.fee_amount = fee_amount + if shipping_amount is not APIHelper.SKIP: + self.shipping_amount = shipping_amount + if tax_amount is not APIHelper.SKIP: + self.tax_amount = tax_amount + if net_amount is not APIHelper.SKIP: + self.net_amount = net_amount + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + gross_amount = Money.from_dictionary(dictionary.get('gross_amount')) if dictionary.get('gross_amount') else None + total_item_amount = Money.from_dictionary(dictionary.get('total_item_amount')) if 'total_item_amount' in dictionary.keys() else APIHelper.SKIP + fee_amount = Money.from_dictionary(dictionary.get('fee_amount')) if 'fee_amount' in dictionary.keys() else APIHelper.SKIP + shipping_amount = Money.from_dictionary(dictionary.get('shipping_amount')) if 'shipping_amount' in dictionary.keys() else APIHelper.SKIP + tax_amount = Money.from_dictionary(dictionary.get('tax_amount')) if 'tax_amount' in dictionary.keys() else APIHelper.SKIP + net_amount = Money.from_dictionary(dictionary.get('net_amount')) if 'net_amount' in dictionary.keys() else APIHelper.SKIP + # Return an object of this model + return cls(gross_amount, + total_item_amount, + fee_amount, + shipping_amount, + tax_amount, + net_amount) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'gross_amount={self.gross_amount!r}, ' + f'total_item_amount={(self.total_item_amount if hasattr(self, "total_item_amount") else None)!r}, ' + f'fee_amount={(self.fee_amount if hasattr(self, "fee_amount") else None)!r}, ' + f'shipping_amount={(self.shipping_amount if hasattr(self, "shipping_amount") else None)!r}, ' + f'tax_amount={(self.tax_amount if hasattr(self, "tax_amount") else None)!r}, ' + f'net_amount={(self.net_amount if hasattr(self, "net_amount") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'gross_amount={self.gross_amount!s}, ' + f'total_item_amount={(self.total_item_amount if hasattr(self, "total_item_amount") else None)!s}, ' + f'fee_amount={(self.fee_amount if hasattr(self, "fee_amount") else None)!s}, ' + f'shipping_amount={(self.shipping_amount if hasattr(self, "shipping_amount") else None)!s}, ' + f'tax_amount={(self.tax_amount if hasattr(self, "tax_amount") else None)!s}, ' + f'net_amount={(self.net_amount if hasattr(self, "net_amount") else None)!s})') diff --git a/paypalserversdk/models/subscription_application_context.py b/paypalserversdk/models/subscription_application_context.py new file mode 100644 index 0000000..c37cd25 --- /dev/null +++ b/paypalserversdk/models/subscription_application_context.py @@ -0,0 +1,135 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.payment_method import PaymentMethod + + +class SubscriptionApplicationContext(object): + + """Implementation of the 'Subscription Application Context' model. + + The application context, which customizes the payer experience during the + subscription approval process with PayPal. + + Attributes: + brand_name (str): The label that overrides the business name in the + PayPal account on the PayPal site. + locale (str): 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`. + shipping_preference (ExperienceContextShippingPreference): The + location from which the shipping address is derived. + user_action (ApplicationContextUserAction): Configures the label name + to `Continue` or `Subscribe Now` for subscription consent + experience. + payment_method (PaymentMethod): The customer and merchant payment + preferences. + return_url (str): The URL where the customer is redirected after the + customer approves the payment. + cancel_url (str): The URL where the customer is redirected after the + customer cancels the payment. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "return_url": 'return_url', + "cancel_url": 'cancel_url', + "brand_name": 'brand_name', + "locale": 'locale', + "shipping_preference": 'shipping_preference', + "user_action": 'user_action', + "payment_method": 'payment_method' + } + + _optionals = [ + 'brand_name', + 'locale', + 'shipping_preference', + 'user_action', + 'payment_method', + ] + + def __init__(self, + return_url=None, + cancel_url=None, + brand_name=APIHelper.SKIP, + locale=APIHelper.SKIP, + shipping_preference='GET_FROM_FILE', + user_action='SUBSCRIBE_NOW', + payment_method=APIHelper.SKIP): + """Constructor for the SubscriptionApplicationContext class""" + + # Initialize members of the class + if brand_name is not APIHelper.SKIP: + self.brand_name = brand_name + if locale is not APIHelper.SKIP: + self.locale = locale + self.shipping_preference = shipping_preference + self.user_action = user_action + if payment_method is not APIHelper.SKIP: + self.payment_method = payment_method + self.return_url = return_url + self.cancel_url = cancel_url + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + return_url = dictionary.get("return_url") if dictionary.get("return_url") else None + cancel_url = dictionary.get("cancel_url") if dictionary.get("cancel_url") else None + brand_name = dictionary.get("brand_name") if dictionary.get("brand_name") else APIHelper.SKIP + locale = dictionary.get("locale") if dictionary.get("locale") else APIHelper.SKIP + shipping_preference = dictionary.get("shipping_preference") if dictionary.get("shipping_preference") else 'GET_FROM_FILE' + user_action = dictionary.get("user_action") if dictionary.get("user_action") else 'SUBSCRIBE_NOW' + payment_method = PaymentMethod.from_dictionary(dictionary.get('payment_method')) if 'payment_method' in dictionary.keys() else APIHelper.SKIP + # Return an object of this model + return cls(return_url, + cancel_url, + brand_name, + locale, + shipping_preference, + user_action, + payment_method) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'brand_name={(self.brand_name if hasattr(self, "brand_name") else None)!r}, ' + f'locale={(self.locale if hasattr(self, "locale") else None)!r}, ' + f'shipping_preference={(self.shipping_preference if hasattr(self, "shipping_preference") else None)!r}, ' + f'user_action={(self.user_action if hasattr(self, "user_action") else None)!r}, ' + f'payment_method={(self.payment_method if hasattr(self, "payment_method") else None)!r}, ' + f'return_url={self.return_url!r}, ' + f'cancel_url={self.cancel_url!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'brand_name={(self.brand_name if hasattr(self, "brand_name") else None)!s}, ' + f'locale={(self.locale if hasattr(self, "locale") else None)!s}, ' + f'shipping_preference={(self.shipping_preference if hasattr(self, "shipping_preference") else None)!s}, ' + f'user_action={(self.user_action if hasattr(self, "user_action") else None)!s}, ' + f'payment_method={(self.payment_method if hasattr(self, "payment_method") else None)!s}, ' + f'return_url={self.return_url!s}, ' + f'cancel_url={self.cancel_url!s})') diff --git a/paypalserversdk/models/subscription_billing_cycle.py b/paypalserversdk/models/subscription_billing_cycle.py new file mode 100644 index 0000000..7052215 --- /dev/null +++ b/paypalserversdk/models/subscription_billing_cycle.py @@ -0,0 +1,114 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.frequency import Frequency +from paypalserversdk.models.subscription_pricing_scheme import SubscriptionPricingScheme + + +class SubscriptionBillingCycle(object): + + """Implementation of the 'Subscription Billing Cycle' model. + + The billing cycle details. + + Attributes: + pricing_scheme (SubscriptionPricingScheme): The pricing scheme details. + frequency (Frequency): The frequency of the billing cycle. + tenure_type (TenureType): The tenure type of the billing cycle. In + case of a plan having trial cycle, only 2 trial cycles are allowed + per plan. + sequence (int): 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. + total_cycles (int): 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). + + """ + + # Create a mapping from Model property names to API property names + _names = { + "frequency": 'frequency', + "tenure_type": 'tenure_type', + "sequence": 'sequence', + "pricing_scheme": 'pricing_scheme', + "total_cycles": 'total_cycles' + } + + _optionals = [ + 'pricing_scheme', + 'total_cycles', + ] + + def __init__(self, + frequency=None, + tenure_type=None, + sequence=None, + pricing_scheme=APIHelper.SKIP, + total_cycles=1): + """Constructor for the SubscriptionBillingCycle class""" + + # Initialize members of the class + if pricing_scheme is not APIHelper.SKIP: + self.pricing_scheme = pricing_scheme + self.frequency = frequency + self.tenure_type = tenure_type + self.sequence = sequence + self.total_cycles = total_cycles + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + frequency = Frequency.from_dictionary(dictionary.get('frequency')) if dictionary.get('frequency') else None + tenure_type = dictionary.get("tenure_type") if dictionary.get("tenure_type") else None + sequence = dictionary.get("sequence") if dictionary.get("sequence") else None + pricing_scheme = SubscriptionPricingScheme.from_dictionary(dictionary.get('pricing_scheme')) if 'pricing_scheme' in dictionary.keys() else APIHelper.SKIP + total_cycles = dictionary.get("total_cycles") if dictionary.get("total_cycles") else 1 + # Return an object of this model + return cls(frequency, + tenure_type, + sequence, + pricing_scheme, + total_cycles) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'pricing_scheme={(self.pricing_scheme if hasattr(self, "pricing_scheme") else None)!r}, ' + f'frequency={self.frequency!r}, ' + f'tenure_type={self.tenure_type!r}, ' + f'sequence={self.sequence!r}, ' + f'total_cycles={(self.total_cycles if hasattr(self, "total_cycles") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'pricing_scheme={(self.pricing_scheme if hasattr(self, "pricing_scheme") else None)!s}, ' + f'frequency={self.frequency!s}, ' + f'tenure_type={self.tenure_type!s}, ' + f'sequence={self.sequence!s}, ' + f'total_cycles={(self.total_cycles if hasattr(self, "total_cycles") else None)!s})') diff --git a/paypalserversdk/models/subscription_billing_information.py b/paypalserversdk/models/subscription_billing_information.py new file mode 100644 index 0000000..b22a6e6 --- /dev/null +++ b/paypalserversdk/models/subscription_billing_information.py @@ -0,0 +1,148 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.cycle_execution import CycleExecution +from paypalserversdk.models.failed_payment_details import FailedPaymentDetails +from paypalserversdk.models.last_payment_details import LastPaymentDetails +from paypalserversdk.models.money import Money + + +class SubscriptionBillingInformation(object): + + """Implementation of the 'Subscription Billing Information' model. + + The billing details for the subscription. If the subscription was or is + active, these fields are populated. + + Attributes: + outstanding_balance (Money): The currency and amount for a financial + transaction, such as a balance or payment due. + cycle_executions (List[CycleExecution]): The trial and regular billing + executions. + last_payment (LastPaymentDetails): The details for the last payment. + next_billing_time (str): 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. + final_payment_time (str): 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. + failed_payments_count (int): 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. + last_failed_payment (FailedPaymentDetails): The details for the failed + payment of the subscription. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "outstanding_balance": 'outstanding_balance', + "failed_payments_count": 'failed_payments_count', + "cycle_executions": 'cycle_executions', + "last_payment": 'last_payment', + "next_billing_time": 'next_billing_time', + "final_payment_time": 'final_payment_time', + "last_failed_payment": 'last_failed_payment' + } + + _optionals = [ + 'cycle_executions', + 'last_payment', + 'next_billing_time', + 'final_payment_time', + 'last_failed_payment', + ] + + def __init__(self, + outstanding_balance=None, + failed_payments_count=None, + cycle_executions=APIHelper.SKIP, + last_payment=APIHelper.SKIP, + next_billing_time=APIHelper.SKIP, + final_payment_time=APIHelper.SKIP, + last_failed_payment=APIHelper.SKIP): + """Constructor for the SubscriptionBillingInformation class""" + + # Initialize members of the class + self.outstanding_balance = outstanding_balance + if cycle_executions is not APIHelper.SKIP: + self.cycle_executions = cycle_executions + if last_payment is not APIHelper.SKIP: + self.last_payment = last_payment + if next_billing_time is not APIHelper.SKIP: + self.next_billing_time = next_billing_time + if final_payment_time is not APIHelper.SKIP: + self.final_payment_time = final_payment_time + self.failed_payments_count = failed_payments_count + if last_failed_payment is not APIHelper.SKIP: + self.last_failed_payment = last_failed_payment + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + outstanding_balance = Money.from_dictionary(dictionary.get('outstanding_balance')) if dictionary.get('outstanding_balance') else None + failed_payments_count = dictionary.get("failed_payments_count") if dictionary.get("failed_payments_count") else None + cycle_executions = None + if dictionary.get('cycle_executions') is not None: + cycle_executions = [CycleExecution.from_dictionary(x) for x in dictionary.get('cycle_executions')] + else: + cycle_executions = APIHelper.SKIP + last_payment = LastPaymentDetails.from_dictionary(dictionary.get('last_payment')) if 'last_payment' in dictionary.keys() else APIHelper.SKIP + next_billing_time = dictionary.get("next_billing_time") if dictionary.get("next_billing_time") else APIHelper.SKIP + final_payment_time = dictionary.get("final_payment_time") if dictionary.get("final_payment_time") else APIHelper.SKIP + last_failed_payment = FailedPaymentDetails.from_dictionary(dictionary.get('last_failed_payment')) if 'last_failed_payment' in dictionary.keys() else APIHelper.SKIP + # Return an object of this model + return cls(outstanding_balance, + failed_payments_count, + cycle_executions, + last_payment, + next_billing_time, + final_payment_time, + last_failed_payment) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'outstanding_balance={self.outstanding_balance!r}, ' + f'cycle_executions={(self.cycle_executions if hasattr(self, "cycle_executions") else None)!r}, ' + f'last_payment={(self.last_payment if hasattr(self, "last_payment") else None)!r}, ' + f'next_billing_time={(self.next_billing_time if hasattr(self, "next_billing_time") else None)!r}, ' + f'final_payment_time={(self.final_payment_time if hasattr(self, "final_payment_time") else None)!r}, ' + f'failed_payments_count={self.failed_payments_count!r}, ' + f'last_failed_payment={(self.last_failed_payment if hasattr(self, "last_failed_payment") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'outstanding_balance={self.outstanding_balance!s}, ' + f'cycle_executions={(self.cycle_executions if hasattr(self, "cycle_executions") else None)!s}, ' + f'last_payment={(self.last_payment if hasattr(self, "last_payment") else None)!s}, ' + f'next_billing_time={(self.next_billing_time if hasattr(self, "next_billing_time") else None)!s}, ' + f'final_payment_time={(self.final_payment_time if hasattr(self, "final_payment_time") else None)!s}, ' + f'failed_payments_count={self.failed_payments_count!s}, ' + f'last_failed_payment={(self.last_failed_payment if hasattr(self, "last_failed_payment") else None)!s})') diff --git a/paypalserversdk/models/subscription_card_request.py b/paypalserversdk/models/subscription_card_request.py new file mode 100644 index 0000000..d8b832e --- /dev/null +++ b/paypalserversdk/models/subscription_card_request.py @@ -0,0 +1,153 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.address import Address +from paypalserversdk.models.subscriptions_card_attributes import SubscriptionsCardAttributes + + +class SubscriptionCardRequest(object): + + """Implementation of the 'Subscription Card Request' model. + + The payment card to use to fund a payment. Can be a credit or debit card. + + Attributes: + name (str): The card holder's name as it appears on the card. + number (str): The primary account number (PAN) for the payment card. + expiry (str): 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). + security_code (str): 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`. + mtype (CardType): Type of card. i.e Credit, Debit and so on. + brand (SubscriptionsCardBrand): The card network or brand. Applies to + credit, debit, gift, and payment cards. + billing_address (Address): The portable international postal address. + Maps to + [AddressValidationMetadata](https://github.com/googlei18n/libaddres + sinput/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). + attributes (SubscriptionsCardAttributes): Additional attributes + associated with the use of this card. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "name": 'name', + "number": 'number', + "expiry": 'expiry', + "security_code": 'security_code', + "mtype": 'type', + "brand": 'brand', + "billing_address": 'billing_address', + "attributes": 'attributes' + } + + _optionals = [ + 'name', + 'number', + 'expiry', + 'security_code', + 'mtype', + 'brand', + 'billing_address', + 'attributes', + ] + + def __init__(self, + name=APIHelper.SKIP, + number=APIHelper.SKIP, + expiry=APIHelper.SKIP, + security_code=APIHelper.SKIP, + mtype=APIHelper.SKIP, + brand=APIHelper.SKIP, + billing_address=APIHelper.SKIP, + attributes=APIHelper.SKIP): + """Constructor for the SubscriptionCardRequest class""" + + # Initialize members of the class + if name is not APIHelper.SKIP: + self.name = name + if number is not APIHelper.SKIP: + self.number = number + if expiry is not APIHelper.SKIP: + self.expiry = expiry + if security_code is not APIHelper.SKIP: + self.security_code = security_code + if mtype is not APIHelper.SKIP: + self.mtype = mtype + if brand is not APIHelper.SKIP: + self.brand = brand + if billing_address is not APIHelper.SKIP: + self.billing_address = billing_address + if attributes is not APIHelper.SKIP: + self.attributes = attributes + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + name = dictionary.get("name") if dictionary.get("name") else APIHelper.SKIP + number = dictionary.get("number") if dictionary.get("number") else APIHelper.SKIP + expiry = dictionary.get("expiry") if dictionary.get("expiry") else APIHelper.SKIP + security_code = dictionary.get("security_code") if dictionary.get("security_code") else APIHelper.SKIP + mtype = dictionary.get("type") if dictionary.get("type") else APIHelper.SKIP + brand = dictionary.get("brand") if dictionary.get("brand") else APIHelper.SKIP + billing_address = Address.from_dictionary(dictionary.get('billing_address')) if 'billing_address' in dictionary.keys() else APIHelper.SKIP + attributes = SubscriptionsCardAttributes.from_dictionary(dictionary.get('attributes')) if 'attributes' in dictionary.keys() else APIHelper.SKIP + # Return an object of this model + return cls(name, + number, + expiry, + security_code, + mtype, + brand, + billing_address, + attributes) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'name={(self.name if hasattr(self, "name") else None)!r}, ' + f'number={(self.number if hasattr(self, "number") else None)!r}, ' + f'expiry={(self.expiry if hasattr(self, "expiry") else None)!r}, ' + f'security_code={(self.security_code if hasattr(self, "security_code") else None)!r}, ' + f'mtype={(self.mtype if hasattr(self, "mtype") else None)!r}, ' + f'brand={(self.brand if hasattr(self, "brand") else None)!r}, ' + f'billing_address={(self.billing_address if hasattr(self, "billing_address") else None)!r}, ' + f'attributes={(self.attributes if hasattr(self, "attributes") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'name={(self.name if hasattr(self, "name") else None)!s}, ' + f'number={(self.number if hasattr(self, "number") else None)!s}, ' + f'expiry={(self.expiry if hasattr(self, "expiry") else None)!s}, ' + f'security_code={(self.security_code if hasattr(self, "security_code") else None)!s}, ' + f'mtype={(self.mtype if hasattr(self, "mtype") else None)!s}, ' + f'brand={(self.brand if hasattr(self, "brand") else None)!s}, ' + f'billing_address={(self.billing_address if hasattr(self, "billing_address") else None)!s}, ' + f'attributes={(self.attributes if hasattr(self, "attributes") else None)!s})') diff --git a/paypalserversdk/models/subscription_collection.py b/paypalserversdk/models/subscription_collection.py new file mode 100644 index 0000000..0a41961 --- /dev/null +++ b/paypalserversdk/models/subscription_collection.py @@ -0,0 +1,90 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.link_description import LinkDescription +from paypalserversdk.models.subscription import Subscription + + +class SubscriptionCollection(object): + + """Implementation of the 'Subscription Collection' model. + + The list of subscriptions. + + Attributes: + subscriptions (List[Subscription]): An array of subscriptions. + links (List[LinkDescription]): An array of request-related [HATEOAS + links](/docs/api/reference/api-responses/#hateoas-links). + + """ + + # Create a mapping from Model property names to API property names + _names = { + "subscriptions": 'subscriptions', + "links": 'links' + } + + _optionals = [ + 'subscriptions', + 'links', + ] + + def __init__(self, + subscriptions=APIHelper.SKIP, + links=APIHelper.SKIP): + """Constructor for the SubscriptionCollection class""" + + # Initialize members of the class + if subscriptions is not APIHelper.SKIP: + self.subscriptions = subscriptions + if links is not APIHelper.SKIP: + self.links = links + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + subscriptions = None + if dictionary.get('subscriptions') is not None: + subscriptions = [Subscription.from_dictionary(x) for x in dictionary.get('subscriptions')] + else: + subscriptions = APIHelper.SKIP + links = None + if dictionary.get('links') is not None: + links = [LinkDescription.from_dictionary(x) for x in dictionary.get('links')] + else: + links = APIHelper.SKIP + # Return an object of this model + return cls(subscriptions, + links) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'subscriptions={(self.subscriptions if hasattr(self, "subscriptions") else None)!r}, ' + f'links={(self.links if hasattr(self, "links") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'subscriptions={(self.subscriptions if hasattr(self, "subscriptions") else None)!s}, ' + f'links={(self.links if hasattr(self, "links") else None)!s})') diff --git a/paypalserversdk/models/subscription_customer_information.py b/paypalserversdk/models/subscription_customer_information.py new file mode 100644 index 0000000..c96760e --- /dev/null +++ b/paypalserversdk/models/subscription_customer_information.py @@ -0,0 +1,94 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.phone_with_type import PhoneWithType + + +class SubscriptionCustomerInformation(object): + + """Implementation of the 'Subscription Customer Information' model. + + The details about a customer in PayPal's system of record. + + Attributes: + id (str): The unique ID for a customer generated by PayPal. + email_address (str): 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. + phone (PhoneWithType): The phone information. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "id": 'id', + "email_address": 'email_address', + "phone": 'phone' + } + + _optionals = [ + 'id', + 'email_address', + 'phone', + ] + + def __init__(self, + id=APIHelper.SKIP, + email_address=APIHelper.SKIP, + phone=APIHelper.SKIP): + """Constructor for the SubscriptionCustomerInformation class""" + + # Initialize members of the class + if id is not APIHelper.SKIP: + self.id = id + if email_address is not APIHelper.SKIP: + self.email_address = email_address + if phone is not APIHelper.SKIP: + self.phone = phone + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + id = dictionary.get("id") if dictionary.get("id") else APIHelper.SKIP + email_address = dictionary.get("email_address") if dictionary.get("email_address") else APIHelper.SKIP + phone = PhoneWithType.from_dictionary(dictionary.get('phone')) if 'phone' in dictionary.keys() else APIHelper.SKIP + # Return an object of this model + return cls(id, + email_address, + phone) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={(self.id if hasattr(self, "id") else None)!r}, ' + f'email_address={(self.email_address if hasattr(self, "email_address") else None)!r}, ' + f'phone={(self.phone if hasattr(self, "phone") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={(self.id if hasattr(self, "id") else None)!s}, ' + f'email_address={(self.email_address if hasattr(self, "email_address") else None)!s}, ' + f'phone={(self.phone if hasattr(self, "phone") else None)!s})') diff --git a/paypalserversdk/models/subscription_patch_application_context.py b/paypalserversdk/models/subscription_patch_application_context.py new file mode 100644 index 0000000..d4ef0e3 --- /dev/null +++ b/paypalserversdk/models/subscription_patch_application_context.py @@ -0,0 +1,124 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.payment_method import PaymentMethod + + +class SubscriptionPatchApplicationContext(object): + + """Implementation of the 'Subscription Patch Application Context' model. + + The application context, which customizes the payer experience during the + subscription approval process with PayPal. + + Attributes: + brand_name (str): The label that overrides the business name in the + PayPal account on the PayPal site. + locale (str): 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`. + shipping_preference (ExperienceContextShippingPreference): The + location from which the shipping address is derived. + payment_method (PaymentMethod): The customer and merchant payment + preferences. + return_url (str): The URL where the customer is redirected after the + customer approves the payment. + cancel_url (str): The URL where the customer is redirected after the + customer cancels the payment. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "return_url": 'return_url', + "cancel_url": 'cancel_url', + "brand_name": 'brand_name', + "locale": 'locale', + "shipping_preference": 'shipping_preference', + "payment_method": 'payment_method' + } + + _optionals = [ + 'brand_name', + 'locale', + 'shipping_preference', + 'payment_method', + ] + + def __init__(self, + return_url=None, + cancel_url=None, + brand_name=APIHelper.SKIP, + locale=APIHelper.SKIP, + shipping_preference='GET_FROM_FILE', + payment_method=APIHelper.SKIP): + """Constructor for the SubscriptionPatchApplicationContext class""" + + # Initialize members of the class + if brand_name is not APIHelper.SKIP: + self.brand_name = brand_name + if locale is not APIHelper.SKIP: + self.locale = locale + self.shipping_preference = shipping_preference + if payment_method is not APIHelper.SKIP: + self.payment_method = payment_method + self.return_url = return_url + self.cancel_url = cancel_url + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + return_url = dictionary.get("return_url") if dictionary.get("return_url") else None + cancel_url = dictionary.get("cancel_url") if dictionary.get("cancel_url") else None + brand_name = dictionary.get("brand_name") if dictionary.get("brand_name") else APIHelper.SKIP + locale = dictionary.get("locale") if dictionary.get("locale") else APIHelper.SKIP + shipping_preference = dictionary.get("shipping_preference") if dictionary.get("shipping_preference") else 'GET_FROM_FILE' + payment_method = PaymentMethod.from_dictionary(dictionary.get('payment_method')) if 'payment_method' in dictionary.keys() else APIHelper.SKIP + # Return an object of this model + return cls(return_url, + cancel_url, + brand_name, + locale, + shipping_preference, + payment_method) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'brand_name={(self.brand_name if hasattr(self, "brand_name") else None)!r}, ' + f'locale={(self.locale if hasattr(self, "locale") else None)!r}, ' + f'shipping_preference={(self.shipping_preference if hasattr(self, "shipping_preference") else None)!r}, ' + f'payment_method={(self.payment_method if hasattr(self, "payment_method") else None)!r}, ' + f'return_url={self.return_url!r}, ' + f'cancel_url={self.cancel_url!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'brand_name={(self.brand_name if hasattr(self, "brand_name") else None)!s}, ' + f'locale={(self.locale if hasattr(self, "locale") else None)!s}, ' + f'shipping_preference={(self.shipping_preference if hasattr(self, "shipping_preference") else None)!s}, ' + f'payment_method={(self.payment_method if hasattr(self, "payment_method") else None)!s}, ' + f'return_url={self.return_url!s}, ' + f'cancel_url={self.cancel_url!s})') diff --git a/paypalserversdk/models/subscription_payer_name.py b/paypalserversdk/models/subscription_payer_name.py new file mode 100644 index 0000000..3c39961 --- /dev/null +++ b/paypalserversdk/models/subscription_payer_name.py @@ -0,0 +1,125 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper + + +class SubscriptionPayerName(object): + + """Implementation of the 'Subscription Payer Name' model. + + The name of the party. + + Attributes: + prefix (str): The prefix, or title, to the party's name. + given_name (str): When the party is a person, the party's given, or + first, name. + surname (str): 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. + middle_name (str): 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. + suffix (str): The suffix for the party's name. + full_name (str): When the party is a person, the party's full name. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "prefix": 'prefix', + "given_name": 'given_name', + "surname": 'surname', + "middle_name": 'middle_name', + "suffix": 'suffix', + "full_name": 'full_name' + } + + _optionals = [ + 'prefix', + 'given_name', + 'surname', + 'middle_name', + 'suffix', + 'full_name', + ] + + def __init__(self, + prefix=APIHelper.SKIP, + given_name=APIHelper.SKIP, + surname=APIHelper.SKIP, + middle_name=APIHelper.SKIP, + suffix=APIHelper.SKIP, + full_name=APIHelper.SKIP): + """Constructor for the SubscriptionPayerName class""" + + # Initialize members of the class + if prefix is not APIHelper.SKIP: + self.prefix = prefix + if given_name is not APIHelper.SKIP: + self.given_name = given_name + if surname is not APIHelper.SKIP: + self.surname = surname + if middle_name is not APIHelper.SKIP: + self.middle_name = middle_name + if suffix is not APIHelper.SKIP: + self.suffix = suffix + if full_name is not APIHelper.SKIP: + self.full_name = full_name + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + prefix = dictionary.get("prefix") if dictionary.get("prefix") else APIHelper.SKIP + given_name = dictionary.get("given_name") if dictionary.get("given_name") else APIHelper.SKIP + surname = dictionary.get("surname") if dictionary.get("surname") else APIHelper.SKIP + middle_name = dictionary.get("middle_name") if dictionary.get("middle_name") else APIHelper.SKIP + suffix = dictionary.get("suffix") if dictionary.get("suffix") else APIHelper.SKIP + full_name = dictionary.get("full_name") if dictionary.get("full_name") else APIHelper.SKIP + # Return an object of this model + return cls(prefix, + given_name, + surname, + middle_name, + suffix, + full_name) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'prefix={(self.prefix if hasattr(self, "prefix") else None)!r}, ' + f'given_name={(self.given_name if hasattr(self, "given_name") else None)!r}, ' + f'surname={(self.surname if hasattr(self, "surname") else None)!r}, ' + f'middle_name={(self.middle_name if hasattr(self, "middle_name") else None)!r}, ' + f'suffix={(self.suffix if hasattr(self, "suffix") else None)!r}, ' + f'full_name={(self.full_name if hasattr(self, "full_name") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'prefix={(self.prefix if hasattr(self, "prefix") else None)!s}, ' + f'given_name={(self.given_name if hasattr(self, "given_name") else None)!s}, ' + f'surname={(self.surname if hasattr(self, "surname") else None)!s}, ' + f'middle_name={(self.middle_name if hasattr(self, "middle_name") else None)!s}, ' + f'suffix={(self.suffix if hasattr(self, "suffix") else None)!s}, ' + f'full_name={(self.full_name if hasattr(self, "full_name") else None)!s})') diff --git a/paypalserversdk/models/subscription_payment_source.py b/paypalserversdk/models/subscription_payment_source.py new file mode 100644 index 0000000..ad78fb2 --- /dev/null +++ b/paypalserversdk/models/subscription_payment_source.py @@ -0,0 +1,74 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.subscription_card_request import SubscriptionCardRequest + + +class SubscriptionPaymentSource(object): + + """Implementation of the 'Subscription Payment Source' model. + + 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. + + Attributes: + card (SubscriptionCardRequest): The payment card to use to fund a + payment. Can be a credit or debit card. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "card": 'card' + } + + _optionals = [ + 'card', + ] + + def __init__(self, + card=APIHelper.SKIP): + """Constructor for the SubscriptionPaymentSource class""" + + # Initialize members of the class + if card is not APIHelper.SKIP: + self.card = card + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + card = SubscriptionCardRequest.from_dictionary(dictionary.get('card')) if 'card' in dictionary.keys() else APIHelper.SKIP + # Return an object of this model + return cls(card) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'card={(self.card if hasattr(self, "card") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'card={(self.card if hasattr(self, "card") else None)!s})') diff --git a/paypalserversdk/models/subscription_payment_source_response.py b/paypalserversdk/models/subscription_payment_source_response.py new file mode 100644 index 0000000..d057437 --- /dev/null +++ b/paypalserversdk/models/subscription_payment_source_response.py @@ -0,0 +1,71 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.card_response_with_billing_address import CardResponseWithBillingAddress + + +class SubscriptionPaymentSourceResponse(object): + + """Implementation of the 'Subscription Payment Source Response' model. + + The payment source used to fund the payment. + + Attributes: + card (CardResponseWithBillingAddress): The payment card used to fund + the payment. Card can be a credit or debit card. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "card": 'card' + } + + _optionals = [ + 'card', + ] + + def __init__(self, + card=APIHelper.SKIP): + """Constructor for the SubscriptionPaymentSourceResponse class""" + + # Initialize members of the class + if card is not APIHelper.SKIP: + self.card = card + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + card = CardResponseWithBillingAddress.from_dictionary(dictionary.get('card')) if 'card' in dictionary.keys() else APIHelper.SKIP + # Return an object of this model + return cls(card) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'card={(self.card if hasattr(self, "card") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'card={(self.card if hasattr(self, "card") else None)!s})') diff --git a/paypalserversdk/models/subscription_plan_status.py b/paypalserversdk/models/subscription_plan_status.py new file mode 100644 index 0000000..89629f7 --- /dev/null +++ b/paypalserversdk/models/subscription_plan_status.py @@ -0,0 +1,30 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" + + +class SubscriptionPlanStatus(object): + + """Implementation of the 'Subscription Plan Status' enum. + + The plan status. + + Attributes: + CREATED: The plan was created. You cannot create subscriptions for a + plan in this state. + INACTIVE: The plan is inactive. + ACTIVE: The plan is active. You can only create subscriptions for a + plan in this state. + + """ + CREATED = 'CREATED' + + INACTIVE = 'INACTIVE' + + ACTIVE = 'ACTIVE' + diff --git a/paypalserversdk/models/subscription_pricing_model.py b/paypalserversdk/models/subscription_pricing_model.py new file mode 100644 index 0000000..8c4a14f --- /dev/null +++ b/paypalserversdk/models/subscription_pricing_model.py @@ -0,0 +1,25 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" + + +class SubscriptionPricingModel(object): + + """Implementation of the 'Subscription Pricing Model' enum. + + The pricing model for tiered plan. The `tiers` parameter is required. + + Attributes: + VOLUME: A volume pricing model. + TIERED: A tiered pricing model. + + """ + VOLUME = 'VOLUME' + + TIERED = 'TIERED' + diff --git a/paypalserversdk/models/subscription_pricing_scheme.py b/paypalserversdk/models/subscription_pricing_scheme.py new file mode 100644 index 0000000..582a258 --- /dev/null +++ b/paypalserversdk/models/subscription_pricing_scheme.py @@ -0,0 +1,137 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.money import Money +from paypalserversdk.models.pricing_tier import PricingTier + + +class SubscriptionPricingScheme(object): + + """Implementation of the 'Subscription Pricing Scheme' model. + + The pricing scheme details. + + Attributes: + version (int): The version of the pricing scheme. + fixed_price (Money): The currency and amount for a financial + transaction, such as a balance or payment due. + pricing_model (SubscriptionPricingModel): The pricing model for tiered + plan. The `tiers` parameter is required. + tiers (List[PricingTier]): An array of pricing tiers which are used + for billing volume/tiered plans. pricing_model field has to be + specified. + create_time (str): 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. + update_time (str): 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. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "version": 'version', + "fixed_price": 'fixed_price', + "pricing_model": 'pricing_model', + "tiers": 'tiers', + "create_time": 'create_time', + "update_time": 'update_time' + } + + _optionals = [ + 'version', + 'fixed_price', + 'pricing_model', + 'tiers', + 'create_time', + 'update_time', + ] + + def __init__(self, + version=APIHelper.SKIP, + fixed_price=APIHelper.SKIP, + pricing_model=APIHelper.SKIP, + tiers=APIHelper.SKIP, + create_time=APIHelper.SKIP, + update_time=APIHelper.SKIP): + """Constructor for the SubscriptionPricingScheme class""" + + # Initialize members of the class + if version is not APIHelper.SKIP: + self.version = version + if fixed_price is not APIHelper.SKIP: + self.fixed_price = fixed_price + if pricing_model is not APIHelper.SKIP: + self.pricing_model = pricing_model + if tiers is not APIHelper.SKIP: + self.tiers = tiers + if create_time is not APIHelper.SKIP: + self.create_time = create_time + if update_time is not APIHelper.SKIP: + self.update_time = update_time + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + version = dictionary.get("version") if dictionary.get("version") else APIHelper.SKIP + fixed_price = Money.from_dictionary(dictionary.get('fixed_price')) if 'fixed_price' in dictionary.keys() else APIHelper.SKIP + pricing_model = dictionary.get("pricing_model") if dictionary.get("pricing_model") else APIHelper.SKIP + tiers = None + if dictionary.get('tiers') is not None: + tiers = [PricingTier.from_dictionary(x) for x in dictionary.get('tiers')] + else: + tiers = APIHelper.SKIP + create_time = dictionary.get("create_time") if dictionary.get("create_time") else APIHelper.SKIP + update_time = dictionary.get("update_time") if dictionary.get("update_time") else APIHelper.SKIP + # Return an object of this model + return cls(version, + fixed_price, + pricing_model, + tiers, + create_time, + update_time) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'version={(self.version if hasattr(self, "version") else None)!r}, ' + f'fixed_price={(self.fixed_price if hasattr(self, "fixed_price") else None)!r}, ' + f'pricing_model={(self.pricing_model if hasattr(self, "pricing_model") else None)!r}, ' + f'tiers={(self.tiers if hasattr(self, "tiers") else None)!r}, ' + f'create_time={(self.create_time if hasattr(self, "create_time") else None)!r}, ' + f'update_time={(self.update_time if hasattr(self, "update_time") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'version={(self.version if hasattr(self, "version") else None)!s}, ' + f'fixed_price={(self.fixed_price if hasattr(self, "fixed_price") else None)!s}, ' + f'pricing_model={(self.pricing_model if hasattr(self, "pricing_model") else None)!s}, ' + f'tiers={(self.tiers if hasattr(self, "tiers") else None)!s}, ' + f'create_time={(self.create_time if hasattr(self, "create_time") else None)!s}, ' + f'update_time={(self.update_time if hasattr(self, "update_time") else None)!s})') diff --git a/paypalserversdk/models/subscription_transaction_details.py b/paypalserversdk/models/subscription_transaction_details.py new file mode 100644 index 0000000..c1c8e6c --- /dev/null +++ b/paypalserversdk/models/subscription_transaction_details.py @@ -0,0 +1,125 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.subscription_amount_with_breakdown import SubscriptionAmountWithBreakdown +from paypalserversdk.models.subscription_payer_name import SubscriptionPayerName + + +class SubscriptionTransactionDetails(object): + + """Implementation of the 'Subscription Transaction Details' model. + + The transaction details. + + Attributes: + status (CaptureStatus): The status of the captured payment. + id (str): The PayPal-generated transaction ID. + amount_with_breakdown (SubscriptionAmountWithBreakdown): The breakdown + details for the amount. Includes the gross, tax, fee, and shipping + amounts. + payer_name (SubscriptionPayerName): The name of the party. + payer_email (str): 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. + time (str): 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. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "id": 'id', + "amount_with_breakdown": 'amount_with_breakdown', + "time": 'time', + "status": 'status', + "payer_name": 'payer_name', + "payer_email": 'payer_email' + } + + _optionals = [ + 'status', + 'payer_name', + 'payer_email', + ] + + def __init__(self, + id=None, + amount_with_breakdown=None, + time=None, + status=APIHelper.SKIP, + payer_name=APIHelper.SKIP, + payer_email=APIHelper.SKIP): + """Constructor for the SubscriptionTransactionDetails class""" + + # Initialize members of the class + if status is not APIHelper.SKIP: + self.status = status + self.id = id + self.amount_with_breakdown = amount_with_breakdown + if payer_name is not APIHelper.SKIP: + self.payer_name = payer_name + if payer_email is not APIHelper.SKIP: + self.payer_email = payer_email + self.time = time + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + id = dictionary.get("id") if dictionary.get("id") else None + amount_with_breakdown = SubscriptionAmountWithBreakdown.from_dictionary(dictionary.get('amount_with_breakdown')) if dictionary.get('amount_with_breakdown') else None + time = dictionary.get("time") if dictionary.get("time") else None + status = dictionary.get("status") if dictionary.get("status") else APIHelper.SKIP + payer_name = SubscriptionPayerName.from_dictionary(dictionary.get('payer_name')) if 'payer_name' in dictionary.keys() else APIHelper.SKIP + payer_email = dictionary.get("payer_email") if dictionary.get("payer_email") else APIHelper.SKIP + # Return an object of this model + return cls(id, + amount_with_breakdown, + time, + status, + payer_name, + payer_email) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'status={(self.status if hasattr(self, "status") else None)!r}, ' + f'id={self.id!r}, ' + f'amount_with_breakdown={self.amount_with_breakdown!r}, ' + f'payer_name={(self.payer_name if hasattr(self, "payer_name") else None)!r}, ' + f'payer_email={(self.payer_email if hasattr(self, "payer_email") else None)!r}, ' + f'time={self.time!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'status={(self.status if hasattr(self, "status") else None)!s}, ' + f'id={self.id!s}, ' + f'amount_with_breakdown={self.amount_with_breakdown!s}, ' + f'payer_name={(self.payer_name if hasattr(self, "payer_name") else None)!s}, ' + f'payer_email={(self.payer_email if hasattr(self, "payer_email") else None)!s}, ' + f'time={self.time!s})') diff --git a/paypalserversdk/models/subscriptions_card_attributes.py b/paypalserversdk/models/subscriptions_card_attributes.py new file mode 100644 index 0000000..e3e70fe --- /dev/null +++ b/paypalserversdk/models/subscriptions_card_attributes.py @@ -0,0 +1,97 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.card_customer import CardCustomer +from paypalserversdk.models.card_verification import CardVerification +from paypalserversdk.models.vault_instruction_base import VaultInstructionBase + + +class SubscriptionsCardAttributes(object): + + """Implementation of the 'Subscriptions Card Attributes' model. + + Additional attributes associated with the use of this card. + + Attributes: + customer (CardCustomer): The details about a customer in PayPal's + system of record. + vault (VaultInstructionBase): Basic vault instruction specification + that can be extended by specific payment sources that supports + vaulting. + verification (CardVerification): The API caller can opt in to verify + the card through PayPal offered verification services (e.g. Smart + Dollar Auth, 3DS). + + """ + + # Create a mapping from Model property names to API property names + _names = { + "customer": 'customer', + "vault": 'vault', + "verification": 'verification' + } + + _optionals = [ + 'customer', + 'vault', + 'verification', + ] + + def __init__(self, + customer=APIHelper.SKIP, + vault=APIHelper.SKIP, + verification=APIHelper.SKIP): + """Constructor for the SubscriptionsCardAttributes class""" + + # Initialize members of the class + if customer is not APIHelper.SKIP: + self.customer = customer + if vault is not APIHelper.SKIP: + self.vault = vault + if verification is not APIHelper.SKIP: + self.verification = verification + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + customer = CardCustomer.from_dictionary(dictionary.get('customer')) if 'customer' in dictionary.keys() else APIHelper.SKIP + vault = VaultInstructionBase.from_dictionary(dictionary.get('vault')) if 'vault' in dictionary.keys() else APIHelper.SKIP + verification = CardVerification.from_dictionary(dictionary.get('verification')) if 'verification' in dictionary.keys() else APIHelper.SKIP + # Return an object of this model + return cls(customer, + vault, + verification) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'customer={(self.customer if hasattr(self, "customer") else None)!r}, ' + f'vault={(self.vault if hasattr(self, "vault") else None)!r}, ' + f'verification={(self.verification if hasattr(self, "verification") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'customer={(self.customer if hasattr(self, "customer") else None)!s}, ' + f'vault={(self.vault if hasattr(self, "vault") else None)!s}, ' + f'verification={(self.verification if hasattr(self, "verification") else None)!s})') diff --git a/paypalserversdk/models/subscriptions_card_brand.py b/paypalserversdk/models/subscriptions_card_brand.py new file mode 100644 index 0000000..e5664c9 --- /dev/null +++ b/paypalserversdk/models/subscriptions_card_brand.py @@ -0,0 +1,99 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" + + +class SubscriptionsCardBrand(object): + + """Implementation of the 'Subscriptions Card Brand' enum. + + The card network or brand. Applies to credit, debit, gift, and payment + cards. + + Attributes: + VISA: Visa card. + MASTERCARD: Mastercard card. + DISCOVER: Discover card. + AMEX: American Express card. + SOLO: Solo debit card. + JCB: Japan Credit Bureau card. + STAR: Military Star card. + DELTA: Delta Airlines card. + SWITCH: Switch credit card. + MAESTRO: Maestro credit card. + CB_NATIONALE: Carte Bancaire (CB) credit card. + CONFIGOGA: Configoga credit card. + CONFIDIS: Confidis credit card. + ELECTRON: Visa Electron credit card. + CETELEM: Cetelem credit card. + CHINA_UNION_PAY: China union pay credit card. + DINERS: The Diners Club International banking and payment services + capability network owned by Discover Financial Services (DFS), one + of the most recognized brands in US financial services. + ELO: The Brazilian Elo card payment network. + HIPER: The Hiper - Ingenico ePayment network. + HIPERCARD: The Brazilian Hipercard payment network that's widely + accepted in the retail market. + RUPAY: The RuPay payment network. + GE: The GE Credit Union 3Point card payment network. + SYNCHRONY: The Synchrony Financial (SYF) payment network. + EFTPOS: The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit + card payment network. + UNKNOWN: UNKNOWN payment network. + + """ + VISA = 'VISA' + + MASTERCARD = 'MASTERCARD' + + DISCOVER = 'DISCOVER' + + AMEX = 'AMEX' + + SOLO = 'SOLO' + + JCB = 'JCB' + + STAR = 'STAR' + + DELTA = 'DELTA' + + SWITCH = 'SWITCH' + + MAESTRO = 'MAESTRO' + + CB_NATIONALE = 'CB_NATIONALE' + + CONFIGOGA = 'CONFIGOGA' + + CONFIDIS = 'CONFIDIS' + + ELECTRON = 'ELECTRON' + + CETELEM = 'CETELEM' + + CHINA_UNION_PAY = 'CHINA_UNION_PAY' + + DINERS = 'DINERS' + + ELO = 'ELO' + + HIPER = 'HIPER' + + HIPERCARD = 'HIPERCARD' + + RUPAY = 'RUPAY' + + GE = 'GE' + + SYNCHRONY = 'SYNCHRONY' + + EFTPOS = 'EFTPOS' + + UNKNOWN = 'UNKNOWN' + diff --git a/paypalserversdk/models/supplementary_purchase_data.py b/paypalserversdk/models/supplementary_purchase_data.py deleted file mode 100644 index 14ffb72..0000000 --- a/paypalserversdk/models/supplementary_purchase_data.py +++ /dev/null @@ -1,84 +0,0 @@ -# -*- coding: utf-8 -*- - -""" -paypalserversdk - -This file was automatically generated by APIMATIC v3.0 ( - https://www.apimatic.io ). -""" -from paypalserversdk.api_helper import APIHelper - - -class SupplementaryPurchaseData(object): - - """Implementation of the 'Supplementary Purchase Data' model. - - The capture identification-related fields. Includes the invoice ID, custom - ID, note to payer, and soft descriptor. - - Attributes: - invoice_id (str): 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. - note_to_payer (str): An informational note about this settlement. - Appears in both the payer's transaction history and the emails - that the payer receives. - - """ - - # Create a mapping from Model property names to API property names - _names = { - "invoice_id": 'invoice_id', - "note_to_payer": 'note_to_payer' - } - - _optionals = [ - 'invoice_id', - 'note_to_payer', - ] - - def __init__(self, - invoice_id=APIHelper.SKIP, - note_to_payer=APIHelper.SKIP): - """Constructor for the SupplementaryPurchaseData class""" - - # Initialize members of the class - if invoice_id is not APIHelper.SKIP: - self.invoice_id = invoice_id - if note_to_payer is not APIHelper.SKIP: - self.note_to_payer = note_to_payer - - @classmethod - def from_dictionary(cls, - dictionary): - """Creates an instance of this model from a dictionary - - Args: - dictionary (dictionary): A dictionary representation of the object - as obtained from the deserialization of the server's response. The - keys MUST match property names in the API description. - - Returns: - object: An instance of this structure class. - - """ - - if not isinstance(dictionary, dict) or dictionary is None: - return None - - # Extract variables from the dictionary - invoice_id = dictionary.get("invoice_id") if dictionary.get("invoice_id") else APIHelper.SKIP - note_to_payer = dictionary.get("note_to_payer") if dictionary.get("note_to_payer") else APIHelper.SKIP - # Return an object of this model - return cls(invoice_id, - note_to_payer) - - def __repr__(self): - return (f'{self.__class__.__name__}(' - f'invoice_id={(self.invoice_id if hasattr(self, "invoice_id") else None)!r}, ' - f'note_to_payer={(self.note_to_payer if hasattr(self, "note_to_payer") else None)!r})') - - def __str__(self): - return (f'{self.__class__.__name__}(' - f'invoice_id={(self.invoice_id if hasattr(self, "invoice_id") else None)!s}, ' - f'note_to_payer={(self.note_to_payer if hasattr(self, "note_to_payer") else None)!s})') diff --git a/paypalserversdk/models/suspend_subscription.py b/paypalserversdk/models/suspend_subscription.py new file mode 100644 index 0000000..3362bbf --- /dev/null +++ b/paypalserversdk/models/suspend_subscription.py @@ -0,0 +1,63 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" + + +class SuspendSubscription(object): + + """Implementation of the 'Suspend Subscription' model. + + The suspend subscription request details. + + Attributes: + reason (str): The reason for suspension of the Subscription. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "reason": 'reason' + } + + def __init__(self, + reason=None): + """Constructor for the SuspendSubscription class""" + + # Initialize members of the class + self.reason = reason + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + reason = dictionary.get("reason") if dictionary.get("reason") else None + # Return an object of this model + return cls(reason) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'reason={self.reason!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'reason={self.reason!s})') diff --git a/paypalserversdk/models/tax_amount.py b/paypalserversdk/models/tax_amount.py new file mode 100644 index 0000000..1896bc0 --- /dev/null +++ b/paypalserversdk/models/tax_amount.py @@ -0,0 +1,71 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.money import Money + + +class TaxAmount(object): + + """Implementation of the 'Tax Amount' model. + + The tax levied by a government on the purchase of goods or services. + + Attributes: + tax_amount (Money): The currency and amount for a financial + transaction, such as a balance or payment due. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "tax_amount": 'tax_amount' + } + + _optionals = [ + 'tax_amount', + ] + + def __init__(self, + tax_amount=APIHelper.SKIP): + """Constructor for the TaxAmount class""" + + # Initialize members of the class + if tax_amount is not APIHelper.SKIP: + self.tax_amount = tax_amount + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + tax_amount = Money.from_dictionary(dictionary.get('tax_amount')) if 'tax_amount' in dictionary.keys() else APIHelper.SKIP + # Return an object of this model + return cls(tax_amount) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'tax_amount={(self.tax_amount if hasattr(self, "tax_amount") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'tax_amount={(self.tax_amount if hasattr(self, "tax_amount") else None)!s})') diff --git a/paypalserversdk/models/taxes.py b/paypalserversdk/models/taxes.py new file mode 100644 index 0000000..7fffa30 --- /dev/null +++ b/paypalserversdk/models/taxes.py @@ -0,0 +1,78 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper + + +class Taxes(object): + + """Implementation of the 'Taxes' model. + + The tax details. + + Attributes: + percentage (str): The percentage, as a fixed-point, signed decimal + number. For example, define a 19.99% interest rate as `19.99`. + inclusive (bool): Indicates whether the tax was already included in + the billing amount. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "percentage": 'percentage', + "inclusive": 'inclusive' + } + + _optionals = [ + 'inclusive', + ] + + def __init__(self, + percentage=None, + inclusive=True): + """Constructor for the Taxes class""" + + # Initialize members of the class + self.percentage = percentage + self.inclusive = inclusive + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + percentage = dictionary.get("percentage") if dictionary.get("percentage") else None + inclusive = dictionary.get("inclusive") if dictionary.get("inclusive") else True + # Return an object of this model + return cls(percentage, + inclusive) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'percentage={self.percentage!r}, ' + f'inclusive={(self.inclusive if hasattr(self, "inclusive") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'percentage={self.percentage!s}, ' + f'inclusive={(self.inclusive if hasattr(self, "inclusive") else None)!s})') diff --git a/paypalserversdk/models/taxes_override.py b/paypalserversdk/models/taxes_override.py new file mode 100644 index 0000000..68691cc --- /dev/null +++ b/paypalserversdk/models/taxes_override.py @@ -0,0 +1,81 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper + + +class TaxesOverride(object): + + """Implementation of the 'Taxes Override' model. + + The tax details. + + Attributes: + percentage (str): The percentage, as a fixed-point, signed decimal + number. For example, define a 19.99% interest rate as `19.99`. + inclusive (bool): Indicates whether the tax was already included in + the billing amount. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "percentage": 'percentage', + "inclusive": 'inclusive' + } + + _optionals = [ + 'percentage', + 'inclusive', + ] + + def __init__(self, + percentage=APIHelper.SKIP, + inclusive=APIHelper.SKIP): + """Constructor for the TaxesOverride class""" + + # Initialize members of the class + if percentage is not APIHelper.SKIP: + self.percentage = percentage + if inclusive is not APIHelper.SKIP: + self.inclusive = inclusive + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + percentage = dictionary.get("percentage") if dictionary.get("percentage") else APIHelper.SKIP + inclusive = dictionary.get("inclusive") if "inclusive" in dictionary.keys() else APIHelper.SKIP + # Return an object of this model + return cls(percentage, + inclusive) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'percentage={(self.percentage if hasattr(self, "percentage") else None)!r}, ' + f'inclusive={(self.inclusive if hasattr(self, "inclusive") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'percentage={(self.percentage if hasattr(self, "percentage") else None)!s}, ' + f'inclusive={(self.inclusive if hasattr(self, "inclusive") else None)!s})') diff --git a/paypalserversdk/models/tenure_type.py b/paypalserversdk/models/tenure_type.py index 9684f3e..0c7e99f 100644 --- a/paypalserversdk/models/tenure_type.py +++ b/paypalserversdk/models/tenure_type.py @@ -13,7 +13,9 @@ class TenureType(object): """Implementation of the 'Tenure Type' enum. The tenure type of the billing cycle identifies if the billing cycle is a - trial(free or discounted) or regular billing cycle. + trial(free or discounted) 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. Attributes: REGULAR: A regular billing cycle to identify recurring charges for the diff --git a/paypalserversdk/models/transaction_details.py b/paypalserversdk/models/transaction_details.py new file mode 100644 index 0000000..37a19c5 --- /dev/null +++ b/paypalserversdk/models/transaction_details.py @@ -0,0 +1,136 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.auction_information import AuctionInformation +from paypalserversdk.models.cart_information import CartInformation +from paypalserversdk.models.incentive_information import IncentiveInformation +from paypalserversdk.models.payer_information import PayerInformation +from paypalserversdk.models.shipping_information import ShippingInformation +from paypalserversdk.models.store_information import StoreInformation +from paypalserversdk.models.transaction_information import TransactionInformation + + +class TransactionDetails(object): + + """Implementation of the 'Transaction Details' model. + + The transaction details. + + Attributes: + transaction_info (TransactionInformation): The transaction information. + payer_info (PayerInformation): The payer information. + shipping_info (ShippingInformation): The shipping information. + cart_info (CartInformation): The cart information. + store_info (StoreInformation): The store information. + auction_info (AuctionInformation): The auction information. + incentive_info (IncentiveInformation): The incentive details. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "transaction_info": 'transaction_info', + "payer_info": 'payer_info', + "shipping_info": 'shipping_info', + "cart_info": 'cart_info', + "store_info": 'store_info', + "auction_info": 'auction_info', + "incentive_info": 'incentive_info' + } + + _optionals = [ + 'transaction_info', + 'payer_info', + 'shipping_info', + 'cart_info', + 'store_info', + 'auction_info', + 'incentive_info', + ] + + def __init__(self, + transaction_info=APIHelper.SKIP, + payer_info=APIHelper.SKIP, + shipping_info=APIHelper.SKIP, + cart_info=APIHelper.SKIP, + store_info=APIHelper.SKIP, + auction_info=APIHelper.SKIP, + incentive_info=APIHelper.SKIP): + """Constructor for the TransactionDetails class""" + + # Initialize members of the class + if transaction_info is not APIHelper.SKIP: + self.transaction_info = transaction_info + if payer_info is not APIHelper.SKIP: + self.payer_info = payer_info + if shipping_info is not APIHelper.SKIP: + self.shipping_info = shipping_info + if cart_info is not APIHelper.SKIP: + self.cart_info = cart_info + if store_info is not APIHelper.SKIP: + self.store_info = store_info + if auction_info is not APIHelper.SKIP: + self.auction_info = auction_info + if incentive_info is not APIHelper.SKIP: + self.incentive_info = incentive_info + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + transaction_info = TransactionInformation.from_dictionary(dictionary.get('transaction_info')) if 'transaction_info' in dictionary.keys() else APIHelper.SKIP + payer_info = PayerInformation.from_dictionary(dictionary.get('payer_info')) if 'payer_info' in dictionary.keys() else APIHelper.SKIP + shipping_info = ShippingInformation.from_dictionary(dictionary.get('shipping_info')) if 'shipping_info' in dictionary.keys() else APIHelper.SKIP + cart_info = CartInformation.from_dictionary(dictionary.get('cart_info')) if 'cart_info' in dictionary.keys() else APIHelper.SKIP + store_info = StoreInformation.from_dictionary(dictionary.get('store_info')) if 'store_info' in dictionary.keys() else APIHelper.SKIP + auction_info = AuctionInformation.from_dictionary(dictionary.get('auction_info')) if 'auction_info' in dictionary.keys() else APIHelper.SKIP + incentive_info = IncentiveInformation.from_dictionary(dictionary.get('incentive_info')) if 'incentive_info' in dictionary.keys() else APIHelper.SKIP + # Return an object of this model + return cls(transaction_info, + payer_info, + shipping_info, + cart_info, + store_info, + auction_info, + incentive_info) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'transaction_info={(self.transaction_info if hasattr(self, "transaction_info") else None)!r}, ' + f'payer_info={(self.payer_info if hasattr(self, "payer_info") else None)!r}, ' + f'shipping_info={(self.shipping_info if hasattr(self, "shipping_info") else None)!r}, ' + f'cart_info={(self.cart_info if hasattr(self, "cart_info") else None)!r}, ' + f'store_info={(self.store_info if hasattr(self, "store_info") else None)!r}, ' + f'auction_info={(self.auction_info if hasattr(self, "auction_info") else None)!r}, ' + f'incentive_info={(self.incentive_info if hasattr(self, "incentive_info") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'transaction_info={(self.transaction_info if hasattr(self, "transaction_info") else None)!s}, ' + f'payer_info={(self.payer_info if hasattr(self, "payer_info") else None)!s}, ' + f'shipping_info={(self.shipping_info if hasattr(self, "shipping_info") else None)!s}, ' + f'cart_info={(self.cart_info if hasattr(self, "cart_info") else None)!s}, ' + f'store_info={(self.store_info if hasattr(self, "store_info") else None)!s}, ' + f'auction_info={(self.auction_info if hasattr(self, "auction_info") else None)!s}, ' + f'incentive_info={(self.incentive_info if hasattr(self, "incentive_info") else None)!s})') diff --git a/paypalserversdk/models/transaction_information.py b/paypalserversdk/models/transaction_information.py new file mode 100644 index 0000000..2775524 --- /dev/null +++ b/paypalserversdk/models/transaction_information.py @@ -0,0 +1,468 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.money import Money + + +class TransactionInformation(object): + + """Implementation of the 'Transaction Information' model. + + The transaction information. + + Attributes: + paypal_account_id (str): The ID of the PayPal account of the + counterparty. + transaction_id (str): The PayPal-generated transaction ID. + paypal_reference_id (str): The PayPal-generated base ID. PayPal + exclusive. Cannot be altered. Defined as a related, pre-existing + transaction or event. + paypal_reference_id_type (PaypalReferenceIdType): The PayPal reference + ID type. + transaction_event_code (str): 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-even + t-codes/). + transaction_initiation_date (str): 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. + transaction_updated_date (str): 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. + transaction_amount (Money): The currency and amount for a financial + transaction, such as a balance or payment due. + fee_amount (Money): The currency and amount for a financial + transaction, such as a balance or payment due. + discount_amount (Money): The currency and amount for a financial + transaction, such as a balance or payment due. + insurance_amount (Money): The currency and amount for a financial + transaction, such as a balance or payment due. + sales_tax_amount (Money): The currency and amount for a financial + transaction, such as a balance or payment due. + shipping_amount (Money): The currency and amount for a financial + transaction, such as a balance or payment due. + shipping_discount_amount (Money): The currency and amount for a + financial transaction, such as a balance or payment due. + shipping_tax_amount (Money): The currency and amount for a financial + transaction, such as a balance or payment due. + other_amount (Money): The currency and amount for a financial + transaction, such as a balance or payment due. + tip_amount (Money): The currency and amount for a financial + transaction, such as a balance or payment due. + transaction_status (str): 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. + transaction_subject (str): 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. + transaction_note (str): A special note that the payer passes to the + payee. Might contain special customer requests, such as shipping + instructions. + payment_tracking_id (str): The payment tracking ID, which is a unique + ID that partners specify to either get information about a payment + or request a refund. + bank_reference_id (str): The bank reference ID. The bank provides this + value for an ACH transaction. + ending_balance (Money): The currency and amount for a financial + transaction, such as a balance or payment due. + available_balance (Money): The currency and amount for a financial + transaction, such as a balance or payment due. + invoice_id (str): 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. + custom_field (str): The merchant-provided custom text. Note: Usually, + this field includes the unique ID for payments made with MassPay + type transaction. + protection_eligibility (str): Indicates whether the transaction is + eligible for protection. Value is: 01. Eligible. 02. Not eligible + 03. Partially eligible. + credit_term (str): The credit term. The time span covered by the + installment payments as expressed in the term length plus the + length time unit code. + credit_transactional_fee (Money): The currency and amount for a + financial transaction, such as a balance or payment due. + credit_promotional_fee (Money): The currency and amount for a + financial transaction, such as a balance or payment due. + annual_percentage_rate (str): The percentage, as a fixed-point, signed + decimal number. For example, define a 19.99% interest rate as + `19.99`. + payment_method_type (str): 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. + instrument_type (str): 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). + instrument_sub_type (str): 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. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "paypal_account_id": 'paypal_account_id', + "transaction_id": 'transaction_id', + "paypal_reference_id": 'paypal_reference_id', + "paypal_reference_id_type": 'paypal_reference_id_type', + "transaction_event_code": 'transaction_event_code', + "transaction_initiation_date": 'transaction_initiation_date', + "transaction_updated_date": 'transaction_updated_date', + "transaction_amount": 'transaction_amount', + "fee_amount": 'fee_amount', + "discount_amount": 'discount_amount', + "insurance_amount": 'insurance_amount', + "sales_tax_amount": 'sales_tax_amount', + "shipping_amount": 'shipping_amount', + "shipping_discount_amount": 'shipping_discount_amount', + "shipping_tax_amount": 'shipping_tax_amount', + "other_amount": 'other_amount', + "tip_amount": 'tip_amount', + "transaction_status": 'transaction_status', + "transaction_subject": 'transaction_subject', + "transaction_note": 'transaction_note', + "payment_tracking_id": 'payment_tracking_id', + "bank_reference_id": 'bank_reference_id', + "ending_balance": 'ending_balance', + "available_balance": 'available_balance', + "invoice_id": 'invoice_id', + "custom_field": 'custom_field', + "protection_eligibility": 'protection_eligibility', + "credit_term": 'credit_term', + "credit_transactional_fee": 'credit_transactional_fee', + "credit_promotional_fee": 'credit_promotional_fee', + "annual_percentage_rate": 'annual_percentage_rate', + "payment_method_type": 'payment_method_type', + "instrument_type": 'instrument_type', + "instrument_sub_type": 'instrument_sub_type' + } + + _optionals = [ + 'paypal_account_id', + 'transaction_id', + 'paypal_reference_id', + 'paypal_reference_id_type', + 'transaction_event_code', + 'transaction_initiation_date', + 'transaction_updated_date', + 'transaction_amount', + 'fee_amount', + 'discount_amount', + 'insurance_amount', + 'sales_tax_amount', + 'shipping_amount', + 'shipping_discount_amount', + 'shipping_tax_amount', + 'other_amount', + 'tip_amount', + 'transaction_status', + 'transaction_subject', + 'transaction_note', + 'payment_tracking_id', + 'bank_reference_id', + 'ending_balance', + 'available_balance', + 'invoice_id', + 'custom_field', + 'protection_eligibility', + 'credit_term', + 'credit_transactional_fee', + 'credit_promotional_fee', + 'annual_percentage_rate', + 'payment_method_type', + 'instrument_type', + 'instrument_sub_type', + ] + + def __init__(self, + paypal_account_id=APIHelper.SKIP, + transaction_id=APIHelper.SKIP, + paypal_reference_id=APIHelper.SKIP, + paypal_reference_id_type=APIHelper.SKIP, + transaction_event_code=APIHelper.SKIP, + transaction_initiation_date=APIHelper.SKIP, + transaction_updated_date=APIHelper.SKIP, + transaction_amount=APIHelper.SKIP, + fee_amount=APIHelper.SKIP, + discount_amount=APIHelper.SKIP, + insurance_amount=APIHelper.SKIP, + sales_tax_amount=APIHelper.SKIP, + shipping_amount=APIHelper.SKIP, + shipping_discount_amount=APIHelper.SKIP, + shipping_tax_amount=APIHelper.SKIP, + other_amount=APIHelper.SKIP, + tip_amount=APIHelper.SKIP, + transaction_status=APIHelper.SKIP, + transaction_subject=APIHelper.SKIP, + transaction_note=APIHelper.SKIP, + payment_tracking_id=APIHelper.SKIP, + bank_reference_id=APIHelper.SKIP, + ending_balance=APIHelper.SKIP, + available_balance=APIHelper.SKIP, + invoice_id=APIHelper.SKIP, + custom_field=APIHelper.SKIP, + protection_eligibility=APIHelper.SKIP, + credit_term=APIHelper.SKIP, + credit_transactional_fee=APIHelper.SKIP, + credit_promotional_fee=APIHelper.SKIP, + annual_percentage_rate=APIHelper.SKIP, + payment_method_type=APIHelper.SKIP, + instrument_type=APIHelper.SKIP, + instrument_sub_type=APIHelper.SKIP): + """Constructor for the TransactionInformation class""" + + # Initialize members of the class + if paypal_account_id is not APIHelper.SKIP: + self.paypal_account_id = paypal_account_id + if transaction_id is not APIHelper.SKIP: + self.transaction_id = transaction_id + if paypal_reference_id is not APIHelper.SKIP: + self.paypal_reference_id = paypal_reference_id + if paypal_reference_id_type is not APIHelper.SKIP: + self.paypal_reference_id_type = paypal_reference_id_type + if transaction_event_code is not APIHelper.SKIP: + self.transaction_event_code = transaction_event_code + if transaction_initiation_date is not APIHelper.SKIP: + self.transaction_initiation_date = transaction_initiation_date + if transaction_updated_date is not APIHelper.SKIP: + self.transaction_updated_date = transaction_updated_date + if transaction_amount is not APIHelper.SKIP: + self.transaction_amount = transaction_amount + if fee_amount is not APIHelper.SKIP: + self.fee_amount = fee_amount + if discount_amount is not APIHelper.SKIP: + self.discount_amount = discount_amount + if insurance_amount is not APIHelper.SKIP: + self.insurance_amount = insurance_amount + if sales_tax_amount is not APIHelper.SKIP: + self.sales_tax_amount = sales_tax_amount + if shipping_amount is not APIHelper.SKIP: + self.shipping_amount = shipping_amount + if shipping_discount_amount is not APIHelper.SKIP: + self.shipping_discount_amount = shipping_discount_amount + if shipping_tax_amount is not APIHelper.SKIP: + self.shipping_tax_amount = shipping_tax_amount + if other_amount is not APIHelper.SKIP: + self.other_amount = other_amount + if tip_amount is not APIHelper.SKIP: + self.tip_amount = tip_amount + if transaction_status is not APIHelper.SKIP: + self.transaction_status = transaction_status + if transaction_subject is not APIHelper.SKIP: + self.transaction_subject = transaction_subject + if transaction_note is not APIHelper.SKIP: + self.transaction_note = transaction_note + if payment_tracking_id is not APIHelper.SKIP: + self.payment_tracking_id = payment_tracking_id + if bank_reference_id is not APIHelper.SKIP: + self.bank_reference_id = bank_reference_id + if ending_balance is not APIHelper.SKIP: + self.ending_balance = ending_balance + if available_balance is not APIHelper.SKIP: + self.available_balance = available_balance + if invoice_id is not APIHelper.SKIP: + self.invoice_id = invoice_id + if custom_field is not APIHelper.SKIP: + self.custom_field = custom_field + if protection_eligibility is not APIHelper.SKIP: + self.protection_eligibility = protection_eligibility + if credit_term is not APIHelper.SKIP: + self.credit_term = credit_term + if credit_transactional_fee is not APIHelper.SKIP: + self.credit_transactional_fee = credit_transactional_fee + if credit_promotional_fee is not APIHelper.SKIP: + self.credit_promotional_fee = credit_promotional_fee + if annual_percentage_rate is not APIHelper.SKIP: + self.annual_percentage_rate = annual_percentage_rate + if payment_method_type is not APIHelper.SKIP: + self.payment_method_type = payment_method_type + if instrument_type is not APIHelper.SKIP: + self.instrument_type = instrument_type + if instrument_sub_type is not APIHelper.SKIP: + self.instrument_sub_type = instrument_sub_type + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + paypal_account_id = dictionary.get("paypal_account_id") if dictionary.get("paypal_account_id") else APIHelper.SKIP + transaction_id = dictionary.get("transaction_id") if dictionary.get("transaction_id") else APIHelper.SKIP + paypal_reference_id = dictionary.get("paypal_reference_id") if dictionary.get("paypal_reference_id") else APIHelper.SKIP + paypal_reference_id_type = dictionary.get("paypal_reference_id_type") if dictionary.get("paypal_reference_id_type") else APIHelper.SKIP + transaction_event_code = dictionary.get("transaction_event_code") if dictionary.get("transaction_event_code") else APIHelper.SKIP + transaction_initiation_date = dictionary.get("transaction_initiation_date") if dictionary.get("transaction_initiation_date") else APIHelper.SKIP + transaction_updated_date = dictionary.get("transaction_updated_date") if dictionary.get("transaction_updated_date") else APIHelper.SKIP + transaction_amount = Money.from_dictionary(dictionary.get('transaction_amount')) if 'transaction_amount' in dictionary.keys() else APIHelper.SKIP + fee_amount = Money.from_dictionary(dictionary.get('fee_amount')) if 'fee_amount' in dictionary.keys() else APIHelper.SKIP + discount_amount = Money.from_dictionary(dictionary.get('discount_amount')) if 'discount_amount' in dictionary.keys() else APIHelper.SKIP + insurance_amount = Money.from_dictionary(dictionary.get('insurance_amount')) if 'insurance_amount' in dictionary.keys() else APIHelper.SKIP + sales_tax_amount = Money.from_dictionary(dictionary.get('sales_tax_amount')) if 'sales_tax_amount' in dictionary.keys() else APIHelper.SKIP + shipping_amount = Money.from_dictionary(dictionary.get('shipping_amount')) if 'shipping_amount' in dictionary.keys() else APIHelper.SKIP + shipping_discount_amount = Money.from_dictionary(dictionary.get('shipping_discount_amount')) if 'shipping_discount_amount' in dictionary.keys() else APIHelper.SKIP + shipping_tax_amount = Money.from_dictionary(dictionary.get('shipping_tax_amount')) if 'shipping_tax_amount' in dictionary.keys() else APIHelper.SKIP + other_amount = Money.from_dictionary(dictionary.get('other_amount')) if 'other_amount' in dictionary.keys() else APIHelper.SKIP + tip_amount = Money.from_dictionary(dictionary.get('tip_amount')) if 'tip_amount' in dictionary.keys() else APIHelper.SKIP + transaction_status = dictionary.get("transaction_status") if dictionary.get("transaction_status") else APIHelper.SKIP + transaction_subject = dictionary.get("transaction_subject") if dictionary.get("transaction_subject") else APIHelper.SKIP + transaction_note = dictionary.get("transaction_note") if dictionary.get("transaction_note") else APIHelper.SKIP + payment_tracking_id = dictionary.get("payment_tracking_id") if dictionary.get("payment_tracking_id") else APIHelper.SKIP + bank_reference_id = dictionary.get("bank_reference_id") if dictionary.get("bank_reference_id") else APIHelper.SKIP + ending_balance = Money.from_dictionary(dictionary.get('ending_balance')) if 'ending_balance' in dictionary.keys() else APIHelper.SKIP + available_balance = Money.from_dictionary(dictionary.get('available_balance')) if 'available_balance' in dictionary.keys() else APIHelper.SKIP + invoice_id = dictionary.get("invoice_id") if dictionary.get("invoice_id") else APIHelper.SKIP + custom_field = dictionary.get("custom_field") if dictionary.get("custom_field") else APIHelper.SKIP + protection_eligibility = dictionary.get("protection_eligibility") if dictionary.get("protection_eligibility") else APIHelper.SKIP + credit_term = dictionary.get("credit_term") if dictionary.get("credit_term") else APIHelper.SKIP + credit_transactional_fee = Money.from_dictionary(dictionary.get('credit_transactional_fee')) if 'credit_transactional_fee' in dictionary.keys() else APIHelper.SKIP + credit_promotional_fee = Money.from_dictionary(dictionary.get('credit_promotional_fee')) if 'credit_promotional_fee' in dictionary.keys() else APIHelper.SKIP + annual_percentage_rate = dictionary.get("annual_percentage_rate") if dictionary.get("annual_percentage_rate") else APIHelper.SKIP + payment_method_type = dictionary.get("payment_method_type") if dictionary.get("payment_method_type") else APIHelper.SKIP + instrument_type = dictionary.get("instrument_type") if dictionary.get("instrument_type") else APIHelper.SKIP + instrument_sub_type = dictionary.get("instrument_sub_type") if dictionary.get("instrument_sub_type") else APIHelper.SKIP + # Return an object of this model + return cls(paypal_account_id, + transaction_id, + paypal_reference_id, + paypal_reference_id_type, + transaction_event_code, + transaction_initiation_date, + transaction_updated_date, + transaction_amount, + fee_amount, + discount_amount, + insurance_amount, + sales_tax_amount, + shipping_amount, + shipping_discount_amount, + shipping_tax_amount, + other_amount, + tip_amount, + transaction_status, + transaction_subject, + transaction_note, + payment_tracking_id, + bank_reference_id, + ending_balance, + available_balance, + invoice_id, + custom_field, + protection_eligibility, + credit_term, + credit_transactional_fee, + credit_promotional_fee, + annual_percentage_rate, + payment_method_type, + instrument_type, + instrument_sub_type) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'paypal_account_id={(self.paypal_account_id if hasattr(self, "paypal_account_id") else None)!r}, ' + f'transaction_id={(self.transaction_id if hasattr(self, "transaction_id") else None)!r}, ' + f'paypal_reference_id={(self.paypal_reference_id if hasattr(self, "paypal_reference_id") else None)!r}, ' + f'paypal_reference_id_type={(self.paypal_reference_id_type if hasattr(self, "paypal_reference_id_type") else None)!r}, ' + f'transaction_event_code={(self.transaction_event_code if hasattr(self, "transaction_event_code") else None)!r}, ' + f'transaction_initiation_date={(self.transaction_initiation_date if hasattr(self, "transaction_initiation_date") else None)!r}, ' + f'transaction_updated_date={(self.transaction_updated_date if hasattr(self, "transaction_updated_date") else None)!r}, ' + f'transaction_amount={(self.transaction_amount if hasattr(self, "transaction_amount") else None)!r}, ' + f'fee_amount={(self.fee_amount if hasattr(self, "fee_amount") else None)!r}, ' + f'discount_amount={(self.discount_amount if hasattr(self, "discount_amount") else None)!r}, ' + f'insurance_amount={(self.insurance_amount if hasattr(self, "insurance_amount") else None)!r}, ' + f'sales_tax_amount={(self.sales_tax_amount if hasattr(self, "sales_tax_amount") else None)!r}, ' + f'shipping_amount={(self.shipping_amount if hasattr(self, "shipping_amount") else None)!r}, ' + f'shipping_discount_amount={(self.shipping_discount_amount if hasattr(self, "shipping_discount_amount") else None)!r}, ' + f'shipping_tax_amount={(self.shipping_tax_amount if hasattr(self, "shipping_tax_amount") else None)!r}, ' + f'other_amount={(self.other_amount if hasattr(self, "other_amount") else None)!r}, ' + f'tip_amount={(self.tip_amount if hasattr(self, "tip_amount") else None)!r}, ' + f'transaction_status={(self.transaction_status if hasattr(self, "transaction_status") else None)!r}, ' + f'transaction_subject={(self.transaction_subject if hasattr(self, "transaction_subject") else None)!r}, ' + f'transaction_note={(self.transaction_note if hasattr(self, "transaction_note") else None)!r}, ' + f'payment_tracking_id={(self.payment_tracking_id if hasattr(self, "payment_tracking_id") else None)!r}, ' + f'bank_reference_id={(self.bank_reference_id if hasattr(self, "bank_reference_id") else None)!r}, ' + f'ending_balance={(self.ending_balance if hasattr(self, "ending_balance") else None)!r}, ' + f'available_balance={(self.available_balance if hasattr(self, "available_balance") else None)!r}, ' + f'invoice_id={(self.invoice_id if hasattr(self, "invoice_id") else None)!r}, ' + f'custom_field={(self.custom_field if hasattr(self, "custom_field") else None)!r}, ' + f'protection_eligibility={(self.protection_eligibility if hasattr(self, "protection_eligibility") else None)!r}, ' + f'credit_term={(self.credit_term if hasattr(self, "credit_term") else None)!r}, ' + f'credit_transactional_fee={(self.credit_transactional_fee if hasattr(self, "credit_transactional_fee") else None)!r}, ' + f'credit_promotional_fee={(self.credit_promotional_fee if hasattr(self, "credit_promotional_fee") else None)!r}, ' + f'annual_percentage_rate={(self.annual_percentage_rate if hasattr(self, "annual_percentage_rate") else None)!r}, ' + f'payment_method_type={(self.payment_method_type if hasattr(self, "payment_method_type") else None)!r}, ' + f'instrument_type={(self.instrument_type if hasattr(self, "instrument_type") else None)!r}, ' + f'instrument_sub_type={(self.instrument_sub_type if hasattr(self, "instrument_sub_type") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'paypal_account_id={(self.paypal_account_id if hasattr(self, "paypal_account_id") else None)!s}, ' + f'transaction_id={(self.transaction_id if hasattr(self, "transaction_id") else None)!s}, ' + f'paypal_reference_id={(self.paypal_reference_id if hasattr(self, "paypal_reference_id") else None)!s}, ' + f'paypal_reference_id_type={(self.paypal_reference_id_type if hasattr(self, "paypal_reference_id_type") else None)!s}, ' + f'transaction_event_code={(self.transaction_event_code if hasattr(self, "transaction_event_code") else None)!s}, ' + f'transaction_initiation_date={(self.transaction_initiation_date if hasattr(self, "transaction_initiation_date") else None)!s}, ' + f'transaction_updated_date={(self.transaction_updated_date if hasattr(self, "transaction_updated_date") else None)!s}, ' + f'transaction_amount={(self.transaction_amount if hasattr(self, "transaction_amount") else None)!s}, ' + f'fee_amount={(self.fee_amount if hasattr(self, "fee_amount") else None)!s}, ' + f'discount_amount={(self.discount_amount if hasattr(self, "discount_amount") else None)!s}, ' + f'insurance_amount={(self.insurance_amount if hasattr(self, "insurance_amount") else None)!s}, ' + f'sales_tax_amount={(self.sales_tax_amount if hasattr(self, "sales_tax_amount") else None)!s}, ' + f'shipping_amount={(self.shipping_amount if hasattr(self, "shipping_amount") else None)!s}, ' + f'shipping_discount_amount={(self.shipping_discount_amount if hasattr(self, "shipping_discount_amount") else None)!s}, ' + f'shipping_tax_amount={(self.shipping_tax_amount if hasattr(self, "shipping_tax_amount") else None)!s}, ' + f'other_amount={(self.other_amount if hasattr(self, "other_amount") else None)!s}, ' + f'tip_amount={(self.tip_amount if hasattr(self, "tip_amount") else None)!s}, ' + f'transaction_status={(self.transaction_status if hasattr(self, "transaction_status") else None)!s}, ' + f'transaction_subject={(self.transaction_subject if hasattr(self, "transaction_subject") else None)!s}, ' + f'transaction_note={(self.transaction_note if hasattr(self, "transaction_note") else None)!s}, ' + f'payment_tracking_id={(self.payment_tracking_id if hasattr(self, "payment_tracking_id") else None)!s}, ' + f'bank_reference_id={(self.bank_reference_id if hasattr(self, "bank_reference_id") else None)!s}, ' + f'ending_balance={(self.ending_balance if hasattr(self, "ending_balance") else None)!s}, ' + f'available_balance={(self.available_balance if hasattr(self, "available_balance") else None)!s}, ' + f'invoice_id={(self.invoice_id if hasattr(self, "invoice_id") else None)!s}, ' + f'custom_field={(self.custom_field if hasattr(self, "custom_field") else None)!s}, ' + f'protection_eligibility={(self.protection_eligibility if hasattr(self, "protection_eligibility") else None)!s}, ' + f'credit_term={(self.credit_term if hasattr(self, "credit_term") else None)!s}, ' + f'credit_transactional_fee={(self.credit_transactional_fee if hasattr(self, "credit_transactional_fee") else None)!s}, ' + f'credit_promotional_fee={(self.credit_promotional_fee if hasattr(self, "credit_promotional_fee") else None)!s}, ' + f'annual_percentage_rate={(self.annual_percentage_rate if hasattr(self, "annual_percentage_rate") else None)!s}, ' + f'payment_method_type={(self.payment_method_type if hasattr(self, "payment_method_type") else None)!s}, ' + f'instrument_type={(self.instrument_type if hasattr(self, "instrument_type") else None)!s}, ' + f'instrument_sub_type={(self.instrument_sub_type if hasattr(self, "instrument_sub_type") else None)!s})') diff --git a/paypalserversdk/models/order_update_callback_error_response_details.py b/paypalserversdk/models/transaction_search_error_details.py similarity index 61% rename from paypalserversdk/models/order_update_callback_error_response_details.py rename to paypalserversdk/models/transaction_search_error_details.py index fbf83c2..56b8964 100644 --- a/paypalserversdk/models/order_update_callback_error_response_details.py +++ b/paypalserversdk/models/transaction_search_error_details.py @@ -9,9 +9,9 @@ from paypalserversdk.api_helper import APIHelper -class OrderUpdateCallbackErrorResponseDetails(object): +class TransactionSearchErrorDetails(object): - """Implementation of the 'Order Update Callback Error Response Details' model. + """Implementation of the 'Transaction Search Error Details' model. The error details. Required for client-side `4XX` errors. @@ -20,7 +20,12 @@ class OrderUpdateCallbackErrorResponseDetails(object): body, set this value to the field's JSON pointer value. Required for client-side errors. value (str): The value of the field that caused the error. + location (str): The location of the field that caused the error. Value + is `body`, `path`, or `query`. issue (str): The unique, fine-grained application-level error code. + description (str): 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. """ @@ -28,26 +33,35 @@ class OrderUpdateCallbackErrorResponseDetails(object): _names = { "issue": 'issue', "field": 'field', - "value": 'value' + "value": 'value', + "location": 'location', + "description": 'description' } _optionals = [ 'field', 'value', + 'location', + 'description', ] def __init__(self, issue=None, field=APIHelper.SKIP, - value=APIHelper.SKIP): - """Constructor for the OrderUpdateCallbackErrorResponseDetails class""" + value=APIHelper.SKIP, + location='body', + description=APIHelper.SKIP): + """Constructor for the TransactionSearchErrorDetails class""" # Initialize members of the class if field is not APIHelper.SKIP: self.field = field if value is not APIHelper.SKIP: self.value = value + self.location = location self.issue = issue + if description is not APIHelper.SKIP: + self.description = description @classmethod def from_dictionary(cls, @@ -71,19 +85,27 @@ def from_dictionary(cls, issue = dictionary.get("issue") if dictionary.get("issue") else None field = dictionary.get("field") if dictionary.get("field") else APIHelper.SKIP value = dictionary.get("value") if dictionary.get("value") else APIHelper.SKIP + location = dictionary.get("location") if dictionary.get("location") else 'body' + description = dictionary.get("description") if dictionary.get("description") else APIHelper.SKIP # Return an object of this model return cls(issue, field, - value) + value, + location, + description) def __repr__(self): return (f'{self.__class__.__name__}(' f'field={(self.field if hasattr(self, "field") else None)!r}, ' f'value={(self.value if hasattr(self, "value") else None)!r}, ' - f'issue={self.issue!r})') + f'location={(self.location if hasattr(self, "location") else None)!r}, ' + f'issue={self.issue!r}, ' + f'description={(self.description if hasattr(self, "description") else None)!r})') def __str__(self): return (f'{self.__class__.__name__}(' f'field={(self.field if hasattr(self, "field") else None)!s}, ' f'value={(self.value if hasattr(self, "value") else None)!s}, ' - f'issue={self.issue!s})') + f'location={(self.location if hasattr(self, "location") else None)!s}, ' + f'issue={self.issue!s}, ' + f'description={(self.description if hasattr(self, "description") else None)!s})') diff --git a/paypalserversdk/models/transactions_list.py b/paypalserversdk/models/transactions_list.py new file mode 100644 index 0000000..484ea0f --- /dev/null +++ b/paypalserversdk/models/transactions_list.py @@ -0,0 +1,111 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.link_description import LinkDescription +from paypalserversdk.models.subscription_transaction_details import SubscriptionTransactionDetails + + +class TransactionsList(object): + + """Implementation of the 'Transactions List' model. + + The list transactions for a subscription request details. + + Attributes: + transactions (List[SubscriptionTransactionDetails]): An array of + transactions. + total_items (int): The total number of items. + total_pages (int): The total number of pages. + links (List[LinkDescription]): An array of request-related [HATEOAS + links](/docs/api/reference/api-responses/#hateoas-links). + + """ + + # Create a mapping from Model property names to API property names + _names = { + "transactions": 'transactions', + "total_items": 'total_items', + "total_pages": 'total_pages', + "links": 'links' + } + + _optionals = [ + 'transactions', + 'total_items', + 'total_pages', + 'links', + ] + + def __init__(self, + transactions=APIHelper.SKIP, + total_items=APIHelper.SKIP, + total_pages=APIHelper.SKIP, + links=APIHelper.SKIP): + """Constructor for the TransactionsList class""" + + # Initialize members of the class + if transactions is not APIHelper.SKIP: + self.transactions = transactions + if total_items is not APIHelper.SKIP: + self.total_items = total_items + if total_pages is not APIHelper.SKIP: + self.total_pages = total_pages + if links is not APIHelper.SKIP: + self.links = links + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + transactions = None + if dictionary.get('transactions') is not None: + transactions = [SubscriptionTransactionDetails.from_dictionary(x) for x in dictionary.get('transactions')] + else: + transactions = APIHelper.SKIP + total_items = dictionary.get("total_items") if dictionary.get("total_items") else APIHelper.SKIP + total_pages = dictionary.get("total_pages") if dictionary.get("total_pages") else APIHelper.SKIP + links = None + if dictionary.get('links') is not None: + links = [LinkDescription.from_dictionary(x) for x in dictionary.get('links')] + else: + links = APIHelper.SKIP + # Return an object of this model + return cls(transactions, + total_items, + total_pages, + links) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'transactions={(self.transactions if hasattr(self, "transactions") else None)!r}, ' + f'total_items={(self.total_items if hasattr(self, "total_items") else None)!r}, ' + f'total_pages={(self.total_pages if hasattr(self, "total_pages") else None)!r}, ' + f'links={(self.links if hasattr(self, "links") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'transactions={(self.transactions if hasattr(self, "transactions") else None)!s}, ' + f'total_items={(self.total_items if hasattr(self, "total_items") else None)!s}, ' + f'total_pages={(self.total_pages if hasattr(self, "total_pages") else None)!s}, ' + f'links={(self.links if hasattr(self, "links") else None)!s})') diff --git a/paypalserversdk/models/update_pricing_scheme.py b/paypalserversdk/models/update_pricing_scheme.py new file mode 100644 index 0000000..6f1ec38 --- /dev/null +++ b/paypalserversdk/models/update_pricing_scheme.py @@ -0,0 +1,72 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.models.subscription_pricing_scheme import SubscriptionPricingScheme + + +class UpdatePricingScheme(object): + + """Implementation of the 'Update Pricing Scheme' model. + + The update pricing scheme request details. + + Attributes: + billing_cycle_sequence (int): The billing cycle sequence. + pricing_scheme (SubscriptionPricingScheme): The pricing scheme details. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "billing_cycle_sequence": 'billing_cycle_sequence', + "pricing_scheme": 'pricing_scheme' + } + + def __init__(self, + billing_cycle_sequence=None, + pricing_scheme=None): + """Constructor for the UpdatePricingScheme class""" + + # Initialize members of the class + self.billing_cycle_sequence = billing_cycle_sequence + self.pricing_scheme = pricing_scheme + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + billing_cycle_sequence = dictionary.get("billing_cycle_sequence") if dictionary.get("billing_cycle_sequence") else None + pricing_scheme = SubscriptionPricingScheme.from_dictionary(dictionary.get('pricing_scheme')) if dictionary.get('pricing_scheme') else None + # Return an object of this model + return cls(billing_cycle_sequence, + pricing_scheme) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'billing_cycle_sequence={self.billing_cycle_sequence!r}, ' + f'pricing_scheme={self.pricing_scheme!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'billing_cycle_sequence={self.billing_cycle_sequence!s}, ' + f'pricing_scheme={self.pricing_scheme!s})') diff --git a/paypalserversdk/models/update_pricing_schemes_request.py b/paypalserversdk/models/update_pricing_schemes_request.py new file mode 100644 index 0000000..a7ef4f3 --- /dev/null +++ b/paypalserversdk/models/update_pricing_schemes_request.py @@ -0,0 +1,67 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.models.update_pricing_scheme import UpdatePricingScheme + + +class UpdatePricingSchemesRequest(object): + + """Implementation of the 'Update Pricing Schemes Request' model. + + The update pricing scheme request details. + + Attributes: + pricing_schemes (List[UpdatePricingScheme]): An array of pricing + schemes. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "pricing_schemes": 'pricing_schemes' + } + + def __init__(self, + pricing_schemes=None): + """Constructor for the UpdatePricingSchemesRequest class""" + + # Initialize members of the class + self.pricing_schemes = pricing_schemes + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + pricing_schemes = None + if dictionary.get('pricing_schemes') is not None: + pricing_schemes = [UpdatePricingScheme.from_dictionary(x) for x in dictionary.get('pricing_schemes')] + # Return an object of this model + return cls(pricing_schemes) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'pricing_schemes={self.pricing_schemes!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'pricing_schemes={self.pricing_schemes!s})') diff --git a/paypalserversdk/models/vault_apple_pay_request.py b/paypalserversdk/models/vault_apple_pay_request.py new file mode 100644 index 0000000..5934692 --- /dev/null +++ b/paypalserversdk/models/vault_apple_pay_request.py @@ -0,0 +1,82 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.apple_pay_request_card import ApplePayRequestCard + + +class VaultApplePayRequest(object): + + """Implementation of the 'Vault Apple Pay Request' model. + + A resource representing a request to vault Apple Pay. + + Attributes: + token (str): Encrypted Apple Pay token, containing card information. + This token would be base64 encoded. + card (ApplePayRequestCard): The payment card to be used to fund a + payment. Can be a credit or debit card. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "token": 'token', + "card": 'card' + } + + _optionals = [ + 'token', + 'card', + ] + + def __init__(self, + token=APIHelper.SKIP, + card=APIHelper.SKIP): + """Constructor for the VaultApplePayRequest class""" + + # Initialize members of the class + if token is not APIHelper.SKIP: + self.token = token + if card is not APIHelper.SKIP: + self.card = card + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + token = dictionary.get("token") if dictionary.get("token") else APIHelper.SKIP + card = ApplePayRequestCard.from_dictionary(dictionary.get('card')) if 'card' in dictionary.keys() else APIHelper.SKIP + # Return an object of this model + return cls(token, + card) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'token={(self.token if hasattr(self, "token") else None)!r}, ' + f'card={(self.card if hasattr(self, "card") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'token={(self.token if hasattr(self, "token") else None)!s}, ' + f'card={(self.card if hasattr(self, "card") else None)!s})') diff --git a/paypalserversdk/models/setup_token_card_experience_context.py b/paypalserversdk/models/vault_card_experience_context.py similarity index 76% rename from paypalserversdk/models/setup_token_card_experience_context.py rename to paypalserversdk/models/vault_card_experience_context.py index e604938..b03ac88 100644 --- a/paypalserversdk/models/setup_token_card_experience_context.py +++ b/paypalserversdk/models/vault_card_experience_context.py @@ -9,11 +9,11 @@ from paypalserversdk.api_helper import APIHelper -class SetupTokenCardExperienceContext(object): +class VaultCardExperienceContext(object): - """Implementation of the 'Setup Token Card Experience Context' model. + """Implementation of the 'Vault Card Experience Context' model. - Customizes the Vault creation flow experience for your customers. + A resource representing an experience context of vault a card. Attributes: brand_name (str): The label that overrides the business name in the @@ -36,8 +36,11 @@ class SetupTokenCardExperienceContext(object): cancel_url (str): The URL where the customer is redirected after customer cancels or leaves the flow. It is a required field for contingency flows like PayPal wallet, 3DS. - vault_instruction (VaultInstructionAction): Vault Instruction on - action to be performed after a successful payer approval. + vault_instruction (VaultInstructionAction): DEPRECATED. Vault + Instruction on action to be performed after a successful payer + approval. + user_action (VaultUserAction): User Action on action to be performed + after a successful payer approval. """ @@ -47,7 +50,8 @@ class SetupTokenCardExperienceContext(object): "locale": 'locale', "return_url": 'return_url', "cancel_url": 'cancel_url', - "vault_instruction": 'vault_instruction' + "vault_instruction": 'vault_instruction', + "user_action": 'user_action' } _optionals = [ @@ -56,6 +60,7 @@ class SetupTokenCardExperienceContext(object): 'return_url', 'cancel_url', 'vault_instruction', + 'user_action', ] def __init__(self, @@ -63,8 +68,9 @@ def __init__(self, locale=APIHelper.SKIP, return_url=APIHelper.SKIP, cancel_url=APIHelper.SKIP, - vault_instruction='ON_CREATE_PAYMENT_TOKENS'): - """Constructor for the SetupTokenCardExperienceContext class""" + vault_instruction=APIHelper.SKIP, + user_action='CONTINUE'): + """Constructor for the VaultCardExperienceContext class""" # Initialize members of the class if brand_name is not APIHelper.SKIP: @@ -75,7 +81,9 @@ def __init__(self, self.return_url = return_url if cancel_url is not APIHelper.SKIP: self.cancel_url = cancel_url - self.vault_instruction = vault_instruction + if vault_instruction is not APIHelper.SKIP: + self.vault_instruction = vault_instruction + self.user_action = user_action @classmethod def from_dictionary(cls, @@ -100,13 +108,15 @@ def from_dictionary(cls, locale = dictionary.get("locale") if dictionary.get("locale") else APIHelper.SKIP return_url = dictionary.get("return_url") if dictionary.get("return_url") else APIHelper.SKIP cancel_url = dictionary.get("cancel_url") if dictionary.get("cancel_url") else APIHelper.SKIP - vault_instruction = dictionary.get("vault_instruction") if dictionary.get("vault_instruction") else 'ON_CREATE_PAYMENT_TOKENS' + vault_instruction = dictionary.get("vault_instruction") if dictionary.get("vault_instruction") else APIHelper.SKIP + user_action = dictionary.get("user_action") if dictionary.get("user_action") else 'CONTINUE' # Return an object of this model return cls(brand_name, locale, return_url, cancel_url, - vault_instruction) + vault_instruction, + user_action) def __repr__(self): return (f'{self.__class__.__name__}(' @@ -114,7 +124,8 @@ def __repr__(self): f'locale={(self.locale if hasattr(self, "locale") else None)!r}, ' f'return_url={(self.return_url if hasattr(self, "return_url") else None)!r}, ' f'cancel_url={(self.cancel_url if hasattr(self, "cancel_url") else None)!r}, ' - f'vault_instruction={(self.vault_instruction if hasattr(self, "vault_instruction") else None)!r})') + f'vault_instruction={(self.vault_instruction if hasattr(self, "vault_instruction") else None)!r}, ' + f'user_action={(self.user_action if hasattr(self, "user_action") else None)!r})') def __str__(self): return (f'{self.__class__.__name__}(' @@ -122,4 +133,5 @@ def __str__(self): f'locale={(self.locale if hasattr(self, "locale") else None)!s}, ' f'return_url={(self.return_url if hasattr(self, "return_url") else None)!s}, ' f'cancel_url={(self.cancel_url if hasattr(self, "cancel_url") else None)!s}, ' - f'vault_instruction={(self.vault_instruction if hasattr(self, "vault_instruction") else None)!s})') + f'vault_instruction={(self.vault_instruction if hasattr(self, "vault_instruction") else None)!s}, ' + f'user_action={(self.user_action if hasattr(self, "user_action") else None)!s})') diff --git a/paypalserversdk/models/vault_experience_context.py b/paypalserversdk/models/vault_experience_context.py index cec75a4..2646ada 100644 --- a/paypalserversdk/models/vault_experience_context.py +++ b/paypalserversdk/models/vault_experience_context.py @@ -7,6 +7,7 @@ https://www.apimatic.io ). """ from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.app_switch_context import AppSwitchContext class VaultExperienceContext(object): @@ -36,10 +37,16 @@ class VaultExperienceContext(object): cancel_url (str): The URL where the customer is redirected after customer cancels or leaves the flow. It is a required field for contingency flows like PayPal wallet, 3DS. - shipping_preference (OrderApplicationContextShippingPreference): The + shipping_preference (ExperienceContextShippingPreference): The shipping preference. This only applies to PayPal payment source. - vault_instruction (VaultInstructionAction): Vault Instruction on - action to be performed after a successful payer approval. + vault_instruction (VaultInstructionAction): DEPRECATED. Vault + Instruction on action to be performed after a successful payer + approval. + app_switch_context (AppSwitchContext): Merchant provided details of + the native app or mobile web browser to facilitate buyer's app + switch to the PayPal consumer app. + user_action (VaultUserAction): User Action on action to be performed + after a successful payer approval. """ @@ -50,7 +57,9 @@ class VaultExperienceContext(object): "return_url": 'return_url', "cancel_url": 'cancel_url', "shipping_preference": 'shipping_preference', - "vault_instruction": 'vault_instruction' + "vault_instruction": 'vault_instruction', + "app_switch_context": 'app_switch_context', + "user_action": 'user_action' } _optionals = [ @@ -60,6 +69,8 @@ class VaultExperienceContext(object): 'cancel_url', 'shipping_preference', 'vault_instruction', + 'app_switch_context', + 'user_action', ] def __init__(self, @@ -68,7 +79,9 @@ def __init__(self, return_url=APIHelper.SKIP, cancel_url=APIHelper.SKIP, shipping_preference='GET_FROM_FILE', - vault_instruction='ON_CREATE_PAYMENT_TOKENS'): + vault_instruction=APIHelper.SKIP, + app_switch_context=APIHelper.SKIP, + user_action='CONTINUE'): """Constructor for the VaultExperienceContext class""" # Initialize members of the class @@ -81,7 +94,11 @@ def __init__(self, if cancel_url is not APIHelper.SKIP: self.cancel_url = cancel_url self.shipping_preference = shipping_preference - self.vault_instruction = vault_instruction + if vault_instruction is not APIHelper.SKIP: + self.vault_instruction = vault_instruction + if app_switch_context is not APIHelper.SKIP: + self.app_switch_context = app_switch_context + self.user_action = user_action @classmethod def from_dictionary(cls, @@ -107,14 +124,18 @@ def from_dictionary(cls, return_url = dictionary.get("return_url") if dictionary.get("return_url") else APIHelper.SKIP cancel_url = dictionary.get("cancel_url") if dictionary.get("cancel_url") else APIHelper.SKIP shipping_preference = dictionary.get("shipping_preference") if dictionary.get("shipping_preference") else 'GET_FROM_FILE' - vault_instruction = dictionary.get("vault_instruction") if dictionary.get("vault_instruction") else 'ON_CREATE_PAYMENT_TOKENS' + vault_instruction = dictionary.get("vault_instruction") if dictionary.get("vault_instruction") else APIHelper.SKIP + app_switch_context = AppSwitchContext.from_dictionary(dictionary.get('app_switch_context')) if 'app_switch_context' in dictionary.keys() else APIHelper.SKIP + user_action = dictionary.get("user_action") if dictionary.get("user_action") else 'CONTINUE' # Return an object of this model return cls(brand_name, locale, return_url, cancel_url, shipping_preference, - vault_instruction) + vault_instruction, + app_switch_context, + user_action) def __repr__(self): return (f'{self.__class__.__name__}(' @@ -123,7 +144,9 @@ def __repr__(self): f'return_url={(self.return_url if hasattr(self, "return_url") else None)!r}, ' f'cancel_url={(self.cancel_url if hasattr(self, "cancel_url") else None)!r}, ' f'shipping_preference={(self.shipping_preference if hasattr(self, "shipping_preference") else None)!r}, ' - f'vault_instruction={(self.vault_instruction if hasattr(self, "vault_instruction") else None)!r})') + f'vault_instruction={(self.vault_instruction if hasattr(self, "vault_instruction") else None)!r}, ' + f'app_switch_context={(self.app_switch_context if hasattr(self, "app_switch_context") else None)!r}, ' + f'user_action={(self.user_action if hasattr(self, "user_action") else None)!r})') def __str__(self): return (f'{self.__class__.__name__}(' @@ -132,4 +155,6 @@ def __str__(self): f'return_url={(self.return_url if hasattr(self, "return_url") else None)!s}, ' f'cancel_url={(self.cancel_url if hasattr(self, "cancel_url") else None)!s}, ' f'shipping_preference={(self.shipping_preference if hasattr(self, "shipping_preference") else None)!s}, ' - f'vault_instruction={(self.vault_instruction if hasattr(self, "vault_instruction") else None)!s})') + f'vault_instruction={(self.vault_instruction if hasattr(self, "vault_instruction") else None)!s}, ' + f'app_switch_context={(self.app_switch_context if hasattr(self, "app_switch_context") else None)!s}, ' + f'user_action={(self.user_action if hasattr(self, "user_action") else None)!s})') diff --git a/paypalserversdk/models/vault_paypal_wallet_request.py b/paypalserversdk/models/vault_paypal_wallet_request.py index ceefc1a..dbd46ed 100644 --- a/paypalserversdk/models/vault_paypal_wallet_request.py +++ b/paypalserversdk/models/vault_paypal_wallet_request.py @@ -42,8 +42,8 @@ class VaultPaypalWalletRequest(object): either a business or a consumer. billing_plan (Plan): The merchant level Recurring Billing plan metadata for the Billing Agreement. - experience_context (VaultExperienceContext): Customizes the Vault - creation flow experience for your customers. + experience_context (VaultExperienceContext): A resource representing + an experience context of vault PayPal Wallet. """ diff --git a/paypalserversdk/models/vault_user_action.py b/paypalserversdk/models/vault_user_action.py new file mode 100644 index 0000000..bf9095c --- /dev/null +++ b/paypalserversdk/models/vault_user_action.py @@ -0,0 +1,32 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" + + +class VaultUserAction(object): + + """Implementation of the 'Vault User Action' enum. + + User Action on action to be performed after a successful payer approval. + + Attributes: + SETUP_NOW: After you redirect the customer to the PayPal payment page, + a Setup Now button appears. Use this option when no additional + inputs are needed from merchant site and to create the billing + agreement immediately when the customer clicks Setup Now. + CONTINUE: After you redirect the customer to the PayPal payment page, + a Continue button appears. Use this option when you want to + redirect the customer from the completed payment page to the + merchant site for additional inputs without immediately creating + the billing agreement. + + """ + SETUP_NOW = 'SETUP_NOW' + + CONTINUE = 'CONTINUE' + diff --git a/paypalserversdk/models/vault_venmo_request.py b/paypalserversdk/models/vault_venmo_request.py index 4aa29f0..44b7ef1 100644 --- a/paypalserversdk/models/vault_venmo_request.py +++ b/paypalserversdk/models/vault_venmo_request.py @@ -7,14 +7,16 @@ https://www.apimatic.io ). """ from paypalserversdk.api_helper import APIHelper -from paypalserversdk.models.vault_venmo_experience_context import VaultVenmoExperienceContext from paypalserversdk.models.vaulted_digital_wallet_shipping_details import VaultedDigitalWalletShippingDetails +from paypalserversdk.models.venmo_experience_context import VenmoExperienceContext class VaultVenmoRequest(object): """Implementation of the 'Vault Venmo Request' model. + A resource representing a request to vault Venmo. + Attributes: description (str): The description displayed to the consumer on the approval flow for a digital wallet, as well as on the merchant @@ -37,8 +39,8 @@ class VaultVenmoRequest(object): associated with a digital wallet payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer. - experience_context (VaultVenmoExperienceContext): Customizes the Vault - creation flow experience for your customers. + experience_context (VenmoExperienceContext): A resource representing + an experience context of vault a venmo account. """ @@ -113,7 +115,7 @@ def from_dictionary(cls, permit_multiple_payment_tokens = dictionary.get("permit_multiple_payment_tokens") if dictionary.get("permit_multiple_payment_tokens") else False usage_type = dictionary.get("usage_type") if dictionary.get("usage_type") else APIHelper.SKIP customer_type = dictionary.get("customer_type") if dictionary.get("customer_type") else APIHelper.SKIP - experience_context = VaultVenmoExperienceContext.from_dictionary(dictionary.get('experience_context')) if 'experience_context' in dictionary.keys() else APIHelper.SKIP + experience_context = VenmoExperienceContext.from_dictionary(dictionary.get('experience_context')) if 'experience_context' in dictionary.keys() else APIHelper.SKIP # Return an object of this model return cls(description, usage_pattern, diff --git a/paypalserversdk/models/vaulted_digital_wallet_shipping_details.py b/paypalserversdk/models/vaulted_digital_wallet_shipping_details.py index 4db761d..eedefc5 100644 --- a/paypalserversdk/models/vaulted_digital_wallet_shipping_details.py +++ b/paypalserversdk/models/vaulted_digital_wallet_shipping_details.py @@ -20,6 +20,11 @@ class VaultedDigitalWalletShippingDetails(object): Attributes: name (ShippingName): The name of the party. + email_address (str): 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. phone_number (PhoneNumberWithCountryCode): The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). @@ -38,6 +43,7 @@ class VaultedDigitalWalletShippingDetails(object): # Create a mapping from Model property names to API property names _names = { "name": 'name', + "email_address": 'email_address', "phone_number": 'phone_number', "mtype": 'type', "address": 'address' @@ -45,6 +51,7 @@ class VaultedDigitalWalletShippingDetails(object): _optionals = [ 'name', + 'email_address', 'phone_number', 'mtype', 'address', @@ -52,6 +59,7 @@ class VaultedDigitalWalletShippingDetails(object): def __init__(self, name=APIHelper.SKIP, + email_address=APIHelper.SKIP, phone_number=APIHelper.SKIP, mtype=APIHelper.SKIP, address=APIHelper.SKIP): @@ -60,6 +68,8 @@ def __init__(self, # Initialize members of the class if name is not APIHelper.SKIP: self.name = name + if email_address is not APIHelper.SKIP: + self.email_address = email_address if phone_number is not APIHelper.SKIP: self.phone_number = phone_number if mtype is not APIHelper.SKIP: @@ -87,11 +97,13 @@ def from_dictionary(cls, # Extract variables from the dictionary name = ShippingName.from_dictionary(dictionary.get('name')) if 'name' in dictionary.keys() else APIHelper.SKIP + email_address = dictionary.get("email_address") if dictionary.get("email_address") else APIHelper.SKIP phone_number = PhoneNumberWithCountryCode.from_dictionary(dictionary.get('phone_number')) if 'phone_number' in dictionary.keys() else APIHelper.SKIP mtype = dictionary.get("type") if dictionary.get("type") else APIHelper.SKIP address = Address.from_dictionary(dictionary.get('address')) if 'address' in dictionary.keys() else APIHelper.SKIP # Return an object of this model return cls(name, + email_address, phone_number, mtype, address) @@ -99,6 +111,7 @@ def from_dictionary(cls, def __repr__(self): return (f'{self.__class__.__name__}(' f'name={(self.name if hasattr(self, "name") else None)!r}, ' + f'email_address={(self.email_address if hasattr(self, "email_address") else None)!r}, ' f'phone_number={(self.phone_number if hasattr(self, "phone_number") else None)!r}, ' f'mtype={(self.mtype if hasattr(self, "mtype") else None)!r}, ' f'address={(self.address if hasattr(self, "address") else None)!r})') @@ -106,6 +119,7 @@ def __repr__(self): def __str__(self): return (f'{self.__class__.__name__}(' f'name={(self.name if hasattr(self, "name") else None)!s}, ' + f'email_address={(self.email_address if hasattr(self, "email_address") else None)!s}, ' f'phone_number={(self.phone_number if hasattr(self, "phone_number") else None)!s}, ' f'mtype={(self.mtype if hasattr(self, "mtype") else None)!s}, ' f'address={(self.address if hasattr(self, "address") else None)!s})') diff --git a/paypalserversdk/models/vault_venmo_experience_context.py b/paypalserversdk/models/venmo_experience_context.py similarity index 65% rename from paypalserversdk/models/vault_venmo_experience_context.py rename to paypalserversdk/models/venmo_experience_context.py index 9272b31..cef8bad 100644 --- a/paypalserversdk/models/vault_venmo_experience_context.py +++ b/paypalserversdk/models/venmo_experience_context.py @@ -9,20 +9,23 @@ from paypalserversdk.api_helper import APIHelper -class VaultVenmoExperienceContext(object): +class VenmoExperienceContext(object): - """Implementation of the 'Vault Venmo Experience Context' model. + """Implementation of the 'Venmo Experience Context' model. - Customizes the Vault creation flow experience for your customers. + A resource representing an experience context of vault a venmo account. Attributes: brand_name (str): The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode. - shipping_preference (OrderApplicationContextShippingPreference): The + shipping_preference (ExperienceContextShippingPreference): The shipping preference. This only applies to PayPal payment source. - vault_instruction (VaultInstructionAction): Vault Instruction on - action to be performed after a successful payer approval. + vault_instruction (VaultInstructionAction): DEPRECATED. Vault + Instruction on action to be performed after a successful payer + approval. + user_action (VaultUserAction): User Action on action to be performed + after a successful payer approval. """ @@ -30,26 +33,31 @@ class VaultVenmoExperienceContext(object): _names = { "brand_name": 'brand_name', "shipping_preference": 'shipping_preference', - "vault_instruction": 'vault_instruction' + "vault_instruction": 'vault_instruction', + "user_action": 'user_action' } _optionals = [ 'brand_name', 'shipping_preference', 'vault_instruction', + 'user_action', ] def __init__(self, brand_name=APIHelper.SKIP, shipping_preference='GET_FROM_FILE', - vault_instruction='ON_CREATE_PAYMENT_TOKENS'): - """Constructor for the VaultVenmoExperienceContext class""" + vault_instruction=APIHelper.SKIP, + user_action='CONTINUE'): + """Constructor for the VenmoExperienceContext class""" # Initialize members of the class if brand_name is not APIHelper.SKIP: self.brand_name = brand_name self.shipping_preference = shipping_preference - self.vault_instruction = vault_instruction + if vault_instruction is not APIHelper.SKIP: + self.vault_instruction = vault_instruction + self.user_action = user_action @classmethod def from_dictionary(cls, @@ -72,20 +80,24 @@ def from_dictionary(cls, # Extract variables from the dictionary brand_name = dictionary.get("brand_name") if dictionary.get("brand_name") else APIHelper.SKIP shipping_preference = dictionary.get("shipping_preference") if dictionary.get("shipping_preference") else 'GET_FROM_FILE' - vault_instruction = dictionary.get("vault_instruction") if dictionary.get("vault_instruction") else 'ON_CREATE_PAYMENT_TOKENS' + vault_instruction = dictionary.get("vault_instruction") if dictionary.get("vault_instruction") else APIHelper.SKIP + user_action = dictionary.get("user_action") if dictionary.get("user_action") else 'CONTINUE' # Return an object of this model return cls(brand_name, shipping_preference, - vault_instruction) + vault_instruction, + user_action) def __repr__(self): return (f'{self.__class__.__name__}(' f'brand_name={(self.brand_name if hasattr(self, "brand_name") else None)!r}, ' f'shipping_preference={(self.shipping_preference if hasattr(self, "shipping_preference") else None)!r}, ' - f'vault_instruction={(self.vault_instruction if hasattr(self, "vault_instruction") else None)!r})') + f'vault_instruction={(self.vault_instruction if hasattr(self, "vault_instruction") else None)!r}, ' + f'user_action={(self.user_action if hasattr(self, "user_action") else None)!r})') def __str__(self): return (f'{self.__class__.__name__}(' f'brand_name={(self.brand_name if hasattr(self, "brand_name") else None)!s}, ' f'shipping_preference={(self.shipping_preference if hasattr(self, "shipping_preference") else None)!s}, ' - f'vault_instruction={(self.vault_instruction if hasattr(self, "vault_instruction") else None)!s})') + f'vault_instruction={(self.vault_instruction if hasattr(self, "vault_instruction") else None)!s}, ' + f'user_action={(self.user_action if hasattr(self, "user_action") else None)!s})') diff --git a/paypalserversdk/models/venmo_payment_token.py b/paypalserversdk/models/venmo_payment_token.py index f9f552a..7c056dc 100644 --- a/paypalserversdk/models/venmo_payment_token.py +++ b/paypalserversdk/models/venmo_payment_token.py @@ -17,6 +17,8 @@ class VenmoPaymentToken(object): """Implementation of the 'Venmo Payment Token' model. + Full representation of a Venmo Payment Token. + Attributes: description (str): The description displayed to the consumer on the approval flow for a digital wallet, as well as on the merchant @@ -39,11 +41,12 @@ class VenmoPaymentToken(object): associated with a digital wallet payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer. - email_address (str): 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. + email_address (str): 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 +payer_id (str): The account identifier for a PayPal account. name (Name): The name of the party. phone (PhoneWithType): The phone information. diff --git a/paypalserversdk/models/venmo_vault_response.py b/paypalserversdk/models/venmo_vault_response.py new file mode 100644 index 0000000..21661b8 --- /dev/null +++ b/paypalserversdk/models/venmo_vault_response.py @@ -0,0 +1,108 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" +from paypalserversdk.api_helper import APIHelper +from paypalserversdk.models.customer_information import CustomerInformation +from paypalserversdk.models.link_description import LinkDescription + + +class VenmoVaultResponse(object): + + """Implementation of the 'Venmo Vault Response' model. + + The details about a saved venmo payment source. + + Attributes: + id (str): The PayPal-generated ID for the saved payment source. + status (VenmoVaultResponseStatus): The vault status. + links (List[LinkDescription]): An array of request-related HATEOAS + links. + customer (CustomerInformation): This object represents a merchant’s + customer, allowing them to store contact details, and track all + payments associated with the same customer. + + """ + + # Create a mapping from Model property names to API property names + _names = { + "id": 'id', + "status": 'status', + "links": 'links', + "customer": 'customer' + } + + _optionals = [ + 'id', + 'status', + 'links', + 'customer', + ] + + def __init__(self, + id=APIHelper.SKIP, + status=APIHelper.SKIP, + links=APIHelper.SKIP, + customer=APIHelper.SKIP): + """Constructor for the VenmoVaultResponse class""" + + # Initialize members of the class + if id is not APIHelper.SKIP: + self.id = id + if status is not APIHelper.SKIP: + self.status = status + if links is not APIHelper.SKIP: + self.links = links + if customer is not APIHelper.SKIP: + self.customer = customer + + @classmethod + def from_dictionary(cls, + dictionary): + """Creates an instance of this model from a dictionary + + Args: + dictionary (dictionary): A dictionary representation of the object + as obtained from the deserialization of the server's response. The + keys MUST match property names in the API description. + + Returns: + object: An instance of this structure class. + + """ + + if not isinstance(dictionary, dict) or dictionary is None: + return None + + # Extract variables from the dictionary + id = dictionary.get("id") if dictionary.get("id") else APIHelper.SKIP + status = dictionary.get("status") if dictionary.get("status") else APIHelper.SKIP + links = None + if dictionary.get('links') is not None: + links = [LinkDescription.from_dictionary(x) for x in dictionary.get('links')] + else: + links = APIHelper.SKIP + customer = CustomerInformation.from_dictionary(dictionary.get('customer')) if 'customer' in dictionary.keys() else APIHelper.SKIP + # Return an object of this model + return cls(id, + status, + links, + customer) + + def __repr__(self): + return (f'{self.__class__.__name__}(' + f'id={(self.id if hasattr(self, "id") else None)!r}, ' + f'status={(self.status if hasattr(self, "status") else None)!r}, ' + f'links={(self.links if hasattr(self, "links") else None)!r}, ' + f'customer={(self.customer if hasattr(self, "customer") else None)!r})') + + def __str__(self): + return (f'{self.__class__.__name__}(' + f'id={(self.id if hasattr(self, "id") else None)!s}, ' + f'status={(self.status if hasattr(self, "status") else None)!s}, ' + f'links={(self.links if hasattr(self, "links") else None)!s}, ' + f'customer={(self.customer if hasattr(self, "customer") else None)!s})') diff --git a/paypalserversdk/models/venmo_vault_response_status.py b/paypalserversdk/models/venmo_vault_response_status.py new file mode 100644 index 0000000..91ec1c6 --- /dev/null +++ b/paypalserversdk/models/venmo_vault_response_status.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" + + +class VenmoVaultResponseStatus(object): + + """Implementation of the 'Venmo Vault Response Status' enum. + + The vault status. + + Attributes: + VAULTED: The payment source has been saved in your customer's vault. + This vault status reflects `/v3/vault` status. + CREATED: DEPRECATED. The payment source has been saved in your + customer's vault. This status applies to deprecated integration + patterns and will not be returned for v3/vault integrations. + APPROVED: Customer has approved the action of saving the specified + payment_source into their vault. Use v3/vault/payment-tokens with + given setup_token to save the payment source in the vault + + """ + VAULTED = 'VAULTED' + + CREATED = 'CREATED' + + APPROVED = 'APPROVED' + diff --git a/paypalserversdk/models/venmo_wallet_attributes_response.py b/paypalserversdk/models/venmo_wallet_attributes_response.py index a6d6dca..efafc93 100644 --- a/paypalserversdk/models/venmo_wallet_attributes_response.py +++ b/paypalserversdk/models/venmo_wallet_attributes_response.py @@ -7,7 +7,7 @@ https://www.apimatic.io ). """ from paypalserversdk.api_helper import APIHelper -from paypalserversdk.models.vault_response import VaultResponse +from paypalserversdk.models.venmo_vault_response import VenmoVaultResponse class VenmoWalletAttributesResponse(object): @@ -17,7 +17,8 @@ class VenmoWalletAttributesResponse(object): Additional attributes associated with the use of a Venmo Wallet. Attributes: - vault (VaultResponse): The details about a saved payment source. + vault (VenmoVaultResponse): The details about a saved venmo payment + source. """ @@ -57,7 +58,7 @@ def from_dictionary(cls, return None # Extract variables from the dictionary - vault = VaultResponse.from_dictionary(dictionary.get('vault')) if 'vault' in dictionary.keys() else APIHelper.SKIP + vault = VenmoVaultResponse.from_dictionary(dictionary.get('vault')) if 'vault' in dictionary.keys() else APIHelper.SKIP # Return an object of this model return cls(vault) diff --git a/paypalserversdk/models/venmo_wallet_experience_context.py b/paypalserversdk/models/venmo_wallet_experience_context.py index 136cf7a..8f9b5e8 100644 --- a/paypalserversdk/models/venmo_wallet_experience_context.py +++ b/paypalserversdk/models/venmo_wallet_experience_context.py @@ -22,10 +22,12 @@ class VenmoWalletExperienceContext(object): Attributes: brand_name (str): The business name of the merchant. The pattern is defined by an external party and supports Unicode. - shipping_preference (ShippingPreference): The location from which the - shipping address is derived. + shipping_preference (VenmoWalletExperienceContextShippingPreference): + The location from which the shipping address is derived. order_update_callback_config (CallbackConfiguration): CallBack Configuration that the merchant can provide to PayPal/Venmo. + user_action (VenmoWalletExperienceContextUserAction): Configures a + Continue or Pay Now checkout flow. """ @@ -33,19 +35,22 @@ class VenmoWalletExperienceContext(object): _names = { "brand_name": 'brand_name', "shipping_preference": 'shipping_preference', - "order_update_callback_config": 'order_update_callback_config' + "order_update_callback_config": 'order_update_callback_config', + "user_action": 'user_action' } _optionals = [ 'brand_name', 'shipping_preference', 'order_update_callback_config', + 'user_action', ] def __init__(self, brand_name=APIHelper.SKIP, shipping_preference='GET_FROM_FILE', - order_update_callback_config=APIHelper.SKIP): + order_update_callback_config=APIHelper.SKIP, + user_action='CONTINUE'): """Constructor for the VenmoWalletExperienceContext class""" # Initialize members of the class @@ -54,6 +59,7 @@ def __init__(self, self.shipping_preference = shipping_preference if order_update_callback_config is not APIHelper.SKIP: self.order_update_callback_config = order_update_callback_config + self.user_action = user_action @classmethod def from_dictionary(cls, @@ -77,19 +83,23 @@ def from_dictionary(cls, brand_name = dictionary.get("brand_name") if dictionary.get("brand_name") else APIHelper.SKIP shipping_preference = dictionary.get("shipping_preference") if dictionary.get("shipping_preference") else 'GET_FROM_FILE' order_update_callback_config = CallbackConfiguration.from_dictionary(dictionary.get('order_update_callback_config')) if 'order_update_callback_config' in dictionary.keys() else APIHelper.SKIP + user_action = dictionary.get("user_action") if dictionary.get("user_action") else 'CONTINUE' # Return an object of this model return cls(brand_name, shipping_preference, - order_update_callback_config) + order_update_callback_config, + user_action) def __repr__(self): return (f'{self.__class__.__name__}(' f'brand_name={(self.brand_name if hasattr(self, "brand_name") else None)!r}, ' f'shipping_preference={(self.shipping_preference if hasattr(self, "shipping_preference") else None)!r}, ' - f'order_update_callback_config={(self.order_update_callback_config if hasattr(self, "order_update_callback_config") else None)!r})') + f'order_update_callback_config={(self.order_update_callback_config if hasattr(self, "order_update_callback_config") else None)!r}, ' + f'user_action={(self.user_action if hasattr(self, "user_action") else None)!r})') def __str__(self): return (f'{self.__class__.__name__}(' f'brand_name={(self.brand_name if hasattr(self, "brand_name") else None)!s}, ' f'shipping_preference={(self.shipping_preference if hasattr(self, "shipping_preference") else None)!s}, ' - f'order_update_callback_config={(self.order_update_callback_config if hasattr(self, "order_update_callback_config") else None)!s})') + f'order_update_callback_config={(self.order_update_callback_config if hasattr(self, "order_update_callback_config") else None)!s}, ' + f'user_action={(self.user_action if hasattr(self, "user_action") else None)!s})') diff --git a/paypalserversdk/models/shipping_preference.py b/paypalserversdk/models/venmo_wallet_experience_context_shipping_preference.py similarity index 84% rename from paypalserversdk/models/shipping_preference.py rename to paypalserversdk/models/venmo_wallet_experience_context_shipping_preference.py index 897fa15..5f8e5ad 100644 --- a/paypalserversdk/models/shipping_preference.py +++ b/paypalserversdk/models/venmo_wallet_experience_context_shipping_preference.py @@ -8,9 +8,9 @@ """ -class ShippingPreference(object): +class VenmoWalletExperienceContextShippingPreference(object): - """Implementation of the 'Shipping Preference' enum. + """Implementation of the 'Venmo Wallet Experience Context Shipping Preference' enum. The location from which the shipping address is derived. diff --git a/paypalserversdk/models/venmo_wallet_experience_context_user_action.py b/paypalserversdk/models/venmo_wallet_experience_context_user_action.py new file mode 100644 index 0000000..15991c0 --- /dev/null +++ b/paypalserversdk/models/venmo_wallet_experience_context_user_action.py @@ -0,0 +1,32 @@ +# -*- coding: utf-8 -*- + +""" +paypalserversdk + +This file was automatically generated by APIMATIC v3.0 ( + https://www.apimatic.io ). +""" + + +class VenmoWalletExperienceContextUserAction(object): + + """Implementation of the 'Venmo Wallet Experience Context User Action' enum. + + Configures a Continue or Pay Now checkout flow. + + Attributes: + CONTINUE: After you redirect the customer to the Venmo payment page, a + Continue button appears. Use this option when the final amount is + not known when the checkout flow is initiated and you want to + redirect the customer to the merchant page without processing the + payment. + PAY_NOW: After you redirect the customer to the Venmo payment page, a + Pay Now button appears. Use this option when the final amount is + known when the checkout is initiated and you want to process the + payment immediately when the customer clicks Pay Now. + + """ + CONTINUE = 'CONTINUE' + + PAY_NOW = 'PAY_NOW' + diff --git a/paypalserversdk/models/venmo_wallet_response.py b/paypalserversdk/models/venmo_wallet_response.py index bf07fad..76963ff 100644 --- a/paypalserversdk/models/venmo_wallet_response.py +++ b/paypalserversdk/models/venmo_wallet_response.py @@ -41,6 +41,9 @@ class VenmoWalletResponse(object): form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling- form-controls-the-autocomplete-attribute). + return_flow (ReturnFlow): Merchant preference on how the buyer can + navigate back to merchant website post approving the transaction + on the Venmo App. attributes (VenmoWalletAttributesResponse): Additional attributes associated with the use of a Venmo Wallet. @@ -54,6 +57,7 @@ class VenmoWalletResponse(object): "name": 'name', "phone_number": 'phone_number', "address": 'address', + "return_flow": 'return_flow', "attributes": 'attributes' } @@ -64,6 +68,7 @@ class VenmoWalletResponse(object): 'name', 'phone_number', 'address', + 'return_flow', 'attributes', ] @@ -74,6 +79,7 @@ def __init__(self, name=APIHelper.SKIP, phone_number=APIHelper.SKIP, address=APIHelper.SKIP, + return_flow='AUTO', attributes=APIHelper.SKIP): """Constructor for the VenmoWalletResponse class""" @@ -90,6 +96,7 @@ def __init__(self, self.phone_number = phone_number if address is not APIHelper.SKIP: self.address = address + self.return_flow = return_flow if attributes is not APIHelper.SKIP: self.attributes = attributes @@ -118,6 +125,7 @@ def from_dictionary(cls, name = Name.from_dictionary(dictionary.get('name')) if 'name' in dictionary.keys() else APIHelper.SKIP phone_number = PhoneNumber.from_dictionary(dictionary.get('phone_number')) if 'phone_number' in dictionary.keys() else APIHelper.SKIP address = Address.from_dictionary(dictionary.get('address')) if 'address' in dictionary.keys() else APIHelper.SKIP + return_flow = dictionary.get("return_flow") if dictionary.get("return_flow") else 'AUTO' attributes = VenmoWalletAttributesResponse.from_dictionary(dictionary.get('attributes')) if 'attributes' in dictionary.keys() else APIHelper.SKIP # Return an object of this model return cls(email_address, @@ -126,6 +134,7 @@ def from_dictionary(cls, name, phone_number, address, + return_flow, attributes) def __repr__(self): @@ -136,6 +145,7 @@ def __repr__(self): f'name={(self.name if hasattr(self, "name") else None)!r}, ' f'phone_number={(self.phone_number if hasattr(self, "phone_number") else None)!r}, ' f'address={(self.address if hasattr(self, "address") else None)!r}, ' + f'return_flow={(self.return_flow if hasattr(self, "return_flow") else None)!r}, ' f'attributes={(self.attributes if hasattr(self, "attributes") else None)!r})') def __str__(self): @@ -146,4 +156,5 @@ def __str__(self): f'name={(self.name if hasattr(self, "name") else None)!s}, ' f'phone_number={(self.phone_number if hasattr(self, "phone_number") else None)!s}, ' f'address={(self.address if hasattr(self, "address") else None)!s}, ' + f'return_flow={(self.return_flow if hasattr(self, "return_flow") else None)!s}, ' f'attributes={(self.attributes if hasattr(self, "attributes") else None)!s})') diff --git a/paypalserversdk/paypal_serversdk_client.py b/paypalserversdk/paypal_serversdk_client.py index 6eb9514..b7ed603 100644 --- a/paypalserversdk/paypal_serversdk_client.py +++ b/paypalserversdk/paypal_serversdk_client.py @@ -16,6 +16,10 @@ from paypalserversdk.controllers.orders_controller import OrdersController from paypalserversdk.controllers.payments_controller import PaymentsController from paypalserversdk.controllers.vault_controller import VaultController +from paypalserversdk.controllers.transaction_search_controller\ + import TransactionSearchController +from paypalserversdk.controllers.subscriptions_controller\ + import SubscriptionsController from paypalserversdk.controllers.o_auth_authorization_controller\ import OAuthAuthorizationController @@ -33,6 +37,14 @@ def payments(self): def vault(self): return VaultController(self.global_configuration) + @LazyProperty + def transaction_search(self): + return TransactionSearchController(self.global_configuration) + + @LazyProperty + def subscriptions(self): + return SubscriptionsController(self.global_configuration) + @LazyProperty def o_auth_authorization(self): return OAuthAuthorizationController(self.global_configuration) @@ -44,7 +56,7 @@ def oauth_2(self): def __init__(self, http_client_instance=None, override_http_client_configuration=False, http_call_back=None, timeout=60, max_retries=0, backoff_factor=2, - retry_statuses=None, retry_methods=None, + retry_statuses=None, retry_methods=None, proxy_settings=None, logging_configuration=None, environment=Environment.SANDBOX, client_credentials_auth_credentials=None, config=None): self.config = config or Configuration( @@ -53,6 +65,7 @@ def __init__(self, http_client_instance=None, http_call_back=http_call_back, timeout=timeout, max_retries=max_retries, backoff_factor=backoff_factor, retry_statuses=retry_statuses, retry_methods=retry_methods, + proxy_settings=proxy_settings, logging_configuration=logging_configuration, environment=environment, client_credentials_auth_credentials=client_credentials_auth_credentials) diff --git a/paypalserversdk/utilities/__init__.py b/paypalserversdk/utilities/__init__.py index 28ebe4a..3ab66eb 100644 --- a/paypalserversdk/utilities/__init__.py +++ b/paypalserversdk/utilities/__init__.py @@ -1,3 +1,4 @@ __all__ = [ + 'pagination', 'file_wrapper', ] diff --git a/pyproject.toml b/pyproject.toml index 7d2de8c..ece5abc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,18 +1,21 @@ [build-system] -build-backend = "setuptools.build_meta" requires = ["setuptools>=61.0"] +build-backend = "setuptools.build_meta" [project] name = "paypal-server-sdk" description = "PayPal's SDK for interacting with the REST APIs" -version = "1.1.0" +version = "2.0.0" readme = "README.md" -requires-python = ">=3.7" keywords = [] authors = [] -urls = {Homepage = "https://github.com/paypal/PayPal-Python-Server-SDK"} -dependencies = ["apimatic-core~=0.2.0, >= 0.2.17", "apimatic-core-interfaces~=0.1.0, >= 0.1.5", "apimatic-requests-client-adapter~=0.1.0, >= 0.1.6"] +dependencies = ["apimatic-core~=0.2.0, >= 0.2.23", "apimatic-core-interfaces~=0.1.0, >= 0.1.8", "apimatic-requests-client-adapter~=0.1.0, >= 0.1.9"] classifiers = [] +requires-python = ">=3.7" +[project.urls] [project.optional-dependencies] testutils = ["pytest>=7.2.2"] +[tool] +[tool.setuptools] +[tool.setuptools.packages] [tool.setuptools.packages.find] exclude = ["tests", "tests.*"] diff --git a/requirements.txt b/requirements.txt index 381727f..bc49b7d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,3 @@ -apimatic-core~=0.2.0, >= 0.2.17 -apimatic-core-interfaces~=0.1.0, >= 0.1.5 -apimatic-requests-client-adapter~=0.1.0, >= 0.1.6 +apimatic-core~=0.2.0, >= 0.2.23 +apimatic-core-interfaces~=0.1.0, >= 0.1.8 +apimatic-requests-client-adapter~=0.1.0, >= 0.1.9 diff --git a/test-requirements.txt b/test-requirements.txt deleted file mode 100644 index dce0f1a..0000000 --- a/test-requirements.txt +++ /dev/null @@ -1 +0,0 @@ -pytest>=7.2.2@sign. However, the generally accepted maximum + length for an email address is 254 characters. The pattern + verifies that an unquoted@sign exists.