global-open-sdk-python 1.5.7__tar.gz → 1.6.0__tar.gz

{global_open_sdk_python-1.5.7 → global_open_sdk_python-1.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: global-open-sdk-python
-Version: 1.5.7
+Version: 1.6.0
 Summary: The global alipay gateway SDK for Python.
 Home-page: https://github.com/alipay/global-open-sdk-python
 Author: guodong.wzj

{global_open_sdk_python-1.5.7 → global_open_sdk_python-1.6.0}/README.md

@@ -1,10 +1,32 @@
 ```
 Language：Python  
 Python version：2.7+  
-Release ^1.5.7
+Release ^1.6.0
 Copyright：Ant financial services group  
 ```
 
+
+Planned release: **1.6.0**. This version is not published yet; package/tag references
+below describe the target release. Build this branch to try it before publication.
+
+## API Key client (planned for 1.6.0)
+
+Use `ApiKeyAlipayClient` with a regional HTTPS gateway and API Key. Existing request
+models are shared with the RSA client; ClientId and RSA keys are not required.
+
+```python
+import os
+from com.alipay.ams.api.api_key_alipay_client import ApiKeyAlipayClient
+
+client = ApiKeyAlipayClient(
+    os.environ["ANTOM_GATEWAY_URL"], os.environ["ANTOM_API_KEY"])
+```
+
+Start with the [sandbox createPaymentSession example](example/api_key_payment_session.py) and its
+[configuration and run instructions](docs/api-key-client.md). Existing RSA usage below remains supported.
+
+
+
 #### Meter event upload
 
 Install the optional HTTP/2 dependencies. This API requires Python 3.9 or later;

{global_open_sdk_python-1.5.7 → global_open_sdk_python-1.6.0}/com/alipay/ams/api/_version.py

@@ -1,2 +1,2 @@
-VERSION = "1.5.7"
+VERSION = "1.6.0"
 USER_AGENT = "global-open-sdk-python/" + VERSION

global_open_sdk_python-1.6.0/com/alipay/ams/api/api_key_alipay_client.py

@@ -0,0 +1,54 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+from com.alipay.ams.api._version import USER_AGENT
+from com.alipay.ams.api.api_key_auth import ApiKeyAuth, add_extra_headers
+from com.alipay.ams.api.exception.exception import AlipayApiException
+from com.alipay.ams.api.net.api_key_http_rpc import do_post
+from com.alipay.ams.api.request_transport_resolver import requires_session_http2
+
+
+class ApiKeyAlipayClient(object):
+    """Independent API Key client; execute returns the response body, like RSA."""
+
+    def __init__(self, gateway_url, api_key, timeout=30):
+        self.__auth = ApiKeyAuth(gateway_url, api_key)
+        if not isinstance(timeout, (int, float)) or timeout <= 0:
+            raise ValueError("timeout must be positive")
+        self.__timeout = timeout
+
+    def execute(self, request):
+        return self.execute_with_headers(request)
+
+    def execute_with_headers(self, request, extra_headers=None):
+        if not hasattr(request, "path") or not request.path:
+            raise AlipayApiException("invalid path")
+        method = request.http_method.value
+        if requires_session_http2(method, request.path):
+            from com.alipay.ams.api.session_http2_executor import execute_session_http2
+
+            return execute_session_http2(
+                self.__auth.gateway_url, request, extra_headers
+            )
+        error = None
+        try:
+            if method.upper() != "POST":
+                raise AlipayApiException(
+                    "Only POST is supported for ordinary API requests"
+                )
+            path = self.__auth.path(request.path)
+            headers = {
+                "Authorization": self.__auth.authorization(),
+                "Content-Type": "application/json; charset=UTF-8",
+                "User-Agent": USER_AGENT,
+            }
+            add_extra_headers(headers, extra_headers)
+            return do_post(
+                self.__auth.gateway_url + path,
+                headers,
+                request.to_ams_json(),
+                self.__timeout,
+            )
+        except Exception as exc:
+            error = self.__auth.redact(exc)
+        # Raise outside the handler to avoid retaining a sensitive exception context.
+        raise AlipayApiException(error)

global_open_sdk_python-1.6.0/com/alipay/ams/api/api_key_auth.py

@@ -0,0 +1,94 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""Internal API Key authentication without decoding the identity fragment."""
+
+import re
+
+try:
+    from urllib.parse import urlsplit
+except ImportError:
+    from urlparse import urlsplit
+
+_RESERVED_HEADERS = frozenset(
+    (
+        "authorization",
+        "signature",
+        "client-id",
+        "request-time",
+        "key-version",
+        "keyversion",
+        "agent-token",
+        "content-type",
+        "user-agent",
+        "x-sdkversion",
+        "sdk-version",
+        "host",
+        "content-length",
+        "transfer-encoding",
+        "connection",
+        "proxy-authorization",
+    )
+)
+
+
+class ApiKeyAuth(object):
+    def __init__(self, gateway_url, api_key):
+        if not isinstance(api_key, str) or not re.match(
+            r"\A(?:isak|irak)_(?:TEST|PROD)_[^_\s\x00-\x1f\x7f]+_[^\s\x00-\x1f\x7f]+\Z",
+            api_key,
+        ):
+            raise ValueError("api_key must be a Standard or Restricted TEST/PROD key")
+        try:
+            uri = urlsplit(gateway_url)
+            valid = (
+                uri.scheme == "https"
+                and uri.hostname
+                and uri.username is None
+                and uri.password is None
+                and uri.path in ("", "/")
+                and not uri.query
+                and not uri.fragment
+                and not re.search(r"\s", gateway_url)
+            )
+            uri.port  # Validate the configured port before any request.
+        except (TypeError, ValueError):
+            valid = False
+        if not valid:
+            raise ValueError("gateway_url must be an HTTPS base URL")
+        self.gateway_url = gateway_url.rstrip("/")
+        self.__api_key = api_key
+        self.__sandbox = api_key.split("_", 2)[1] == "TEST"
+
+    def authorization(self):
+        return "Bearer " + self.__api_key
+
+    def path(self, path):
+        if (
+            not isinstance(path, str)
+            or not re.match(r"\A/ams/(?:sandbox/)?api/[A-Za-z0-9_/-]+\Z", path)
+            or "//" in path
+        ):
+            raise ValueError("request path must be an ordinary /ams/api/ path")
+        normal = path.replace("/ams/sandbox/api/", "/ams/api/", 1)
+        return (
+            normal.replace("/ams/api/", "/ams/sandbox/api/", 1)
+            if self.__sandbox
+            else normal
+        )
+
+    def redact(self, message):
+        return str(message).replace(self.__api_key, "[REDACTED]")
+
+
+def add_extra_headers(headers, extra_headers):
+    for name, value in (extra_headers or {}).items():
+        if (
+            not isinstance(name, str)
+            or not re.match(r"\A[!#$%&'*+.^_`|~0-9A-Za-z-]+\Z", name)
+            or not isinstance(value, str)
+            or "\r" in value
+            or "\n" in value
+        ):
+            raise ValueError("Invalid custom header")
+        if name.lower() not in _RESERVED_HEADERS:
+            headers[name] = value

global_open_sdk_python-1.6.0/com/alipay/ams/api/model/account_last_modified.py

@@ -0,0 +1,97 @@
+import json
+
+
+
+
+class AccountLastModified:
+    def __init__(self):
+        
+        self.__password_change_date = None  # type: str
+        self.__email_change_date = None  # type: str
+        self.__listing_change_date = None  # type: str
+        self.__login_date = None  # type: str
+        self.__address_change_date = None  # type: str
+        
+
+    @property
+    def password_change_date(self):
+        """
+        The date and time when the merchant last changed the account password. The value follows the ISO 8601 standard format. For example, \"2019-11-27T12:01:01+08:00\".
+        """
+        return self.__password_change_date
+
+    @password_change_date.setter
+    def password_change_date(self, value):
+        self.__password_change_date = value
+    @property
+    def email_change_date(self):
+        """
+        The date and time when the merchant last changed the account email address. The value follows the ISO 8601 standard format. For example, \"2019-11-27T12:01:01+08:00\".
+        """
+        return self.__email_change_date
+
+    @email_change_date.setter
+    def email_change_date(self, value):
+        self.__email_change_date = value
+    @property
+    def listing_change_date(self):
+        """
+        The date and time when the merchant last changed the account listing information. The value follows the ISO 8601 standard format. For example, \"2019-11-27T12:01:01+08:00\".
+        """
+        return self.__listing_change_date
+
+    @listing_change_date.setter
+    def listing_change_date(self, value):
+        self.__listing_change_date = value
+    @property
+    def login_date(self):
+        """
+        The date and time when the merchant last logged in to the account. The value follows the ISO 8601 standard format. For example, \"2019-11-27T12:01:01+08:00\".
+        """
+        return self.__login_date
+
+    @login_date.setter
+    def login_date(self, value):
+        self.__login_date = value
+    @property
+    def address_change_date(self):
+        """
+        The date and time when the merchant last changed the account address. The value follows the ISO 8601 standard format. For example, \"2019-11-27T12:01:01+08:00\".
+        """
+        return self.__address_change_date
+
+    @address_change_date.setter
+    def address_change_date(self, value):
+        self.__address_change_date = value
+
+
+    
+
+    def to_ams_dict(self):
+        params = dict()
+        if hasattr(self, "password_change_date") and self.password_change_date is not None:
+            params['passwordChangeDate'] = self.password_change_date
+        if hasattr(self, "email_change_date") and self.email_change_date is not None:
+            params['emailChangeDate'] = self.email_change_date
+        if hasattr(self, "listing_change_date") and self.listing_change_date is not None:
+            params['listingChangeDate'] = self.listing_change_date
+        if hasattr(self, "login_date") and self.login_date is not None:
+            params['loginDate'] = self.login_date
+        if hasattr(self, "address_change_date") and self.address_change_date is not None:
+            params['addressChangeDate'] = self.address_change_date
+        return params
+
+
+    def parse_rsp_body(self, response_body):
+        if isinstance(response_body, str): 
+            response_body = json.loads(response_body)
+        if 'passwordChangeDate' in response_body:
+            self.__password_change_date = response_body['passwordChangeDate']
+        if 'emailChangeDate' in response_body:
+            self.__email_change_date = response_body['emailChangeDate']
+        if 'listingChangeDate' in response_body:
+            self.__listing_change_date = response_body['listingChangeDate']
+        if 'loginDate' in response_body:
+            self.__login_date = response_body['loginDate']
+        if 'addressChangeDate' in response_body:
+            self.__address_change_date = response_body['addressChangeDate']

{global_open_sdk_python-1.5.7 → global_open_sdk_python-1.6.0}/com/alipay/ams/api/model/acquirer_info.py

@@ -16,6 +16,7 @@ class AcquirerInfo:
         self.__acquirer_reason_description = None  # type: str
         self.__ptsp_transaction_id = None  # type: str
         self.__acquirer_card_token = None  # type: str
+        self.__acquirer_fingerprint = None  # type: str
         
 
     @property
@@ -118,6 +119,16 @@ class AcquirerInfo:
     @acquirer_card_token.setter
     def acquirer_card_token(self, value):
         self.__acquirer_card_token = value
+    @property
+    def acquirer_fingerprint(self):
+        """
+        An acquirer-generated, irreversible card fingerprint passed through for card identification, reconciliation, and risk deduplication. It is returned only for APO merchants enrolled in fingerprint passthrough when Checkout.com is the acquirer and the original scenario is card vaulting or payment with vaulting. It is not returned in other scenarios and may be empty. Maximum length: 64 characters.
+        """
+        return self.__acquirer_fingerprint
+
+    @acquirer_fingerprint.setter
+    def acquirer_fingerprint(self, value):
+        self.__acquirer_fingerprint = value
 
 
     
@@ -144,6 +155,8 @@ class AcquirerInfo:
             params['ptspTransactionId'] = self.ptsp_transaction_id
         if hasattr(self, "acquirer_card_token") and self.acquirer_card_token is not None:
             params['acquirerCardToken'] = self.acquirer_card_token
+        if hasattr(self, "acquirer_fingerprint") and self.acquirer_fingerprint is not None:
+            params['acquirerFingerprint'] = self.acquirer_fingerprint
         return params
 
 
@@ -170,3 +183,5 @@ class AcquirerInfo:
             self.__ptsp_transaction_id = response_body['ptspTransactionId']
         if 'acquirerCardToken' in response_body:
             self.__acquirer_card_token = response_body['acquirerCardToken']
+        if 'acquirerFingerprint' in response_body:
+            self.__acquirer_fingerprint = response_body['acquirerFingerprint']

global_open_sdk_python-1.6.0/com/alipay/ams/api/model/automatic_tax.py

@@ -0,0 +1,37 @@
+import json
+
+
+
+
+class AutomaticTax:
+    def __init__(self):
+        
+        self.__enabled = None  # type: bool
+        
+
+    @property
+    def enabled(self):
+        """
+        Indicates whether automatic tax is enabled for this payment session. This field is required when automaticTax is provided. true enables automatic tax and false disables it for this session when merchant tax settings exist.
+        """
+        return self.__enabled
+
+    @enabled.setter
+    def enabled(self, value):
+        self.__enabled = value
+
+
+    
+
+    def to_ams_dict(self):
+        params = dict()
+        if hasattr(self, "enabled") and self.enabled is not None:
+            params['enabled'] = self.enabled
+        return params
+
+
+    def parse_rsp_body(self, response_body):
+        if isinstance(response_body, str): 
+            response_body = json.loads(response_body)
+        if 'enabled' in response_body:
+            self.__enabled = response_body['enabled']

{global_open_sdk_python-1.5.7 → global_open_sdk_python-1.6.0}/com/alipay/ams/api/model/available_payment_method.py

@@ -14,7 +14,7 @@ class AvailablePaymentMethod:
     @property
     def payment_method_meta_data(self):
         """
-        Additional information required for some specific payment methods.  
+        Additional information required for some specific payment methods. This object remains free-form. For merchants with the billing-address collection capability enabled, billingAddressCollectionMode controls whether the billing address is collected. Supported values are ALWAYS, DYNAMIC, and NEVER. If this field is omitted, the service uses NEVER.
         """
         return self.__payment_method_meta_data
 

{global_open_sdk_python-1.5.7 → global_open_sdk_python-1.6.0}/com/alipay/ams/api/model/buyer.py

@@ -1,5 +1,8 @@
 import json
 from com.alipay.ams.api.model.user_name import UserName
+from com.alipay.ams.api.model.amount import Amount
+from com.alipay.ams.api.model.buyer_tax_id import BuyerTaxId
+from com.alipay.ams.api.model.address import Address
 
 
 
@@ -15,6 +18,11 @@ class Buyer:
         self.__is_account_verified = None  # type: bool
         self.__successful_order_count = None  # type: int
         self.__buyer_phone_no_contry_code = None  # type: str
+        self.__successful_order_amount = None  # type: Amount
+        self.__date_of_last_paid_purchase = None  # type: str
+        self.__date_of_first_paid_purchase = None  # type: str
+        self.__tax_ids = None  # type: [BuyerTaxId]
+        self.__business_address = None  # type: Address
         
 
     @property
@@ -97,6 +105,56 @@ class Buyer:
     @buyer_phone_no_contry_code.setter
     def buyer_phone_no_contry_code(self, value):
         self.__buyer_phone_no_contry_code = value
+    @property
+    def successful_order_amount(self):
+        """Gets the successful_order_amount of this Buyer.
+        
+        """
+        return self.__successful_order_amount
+
+    @successful_order_amount.setter
+    def successful_order_amount(self, value):
+        self.__successful_order_amount = value
+    @property
+    def date_of_last_paid_purchase(self):
+        """
+        The date and time of the buyer's last paid purchase. When using KLARNA for an e-commerce merchant, this field is required. The value follows the ISO 8601 standard format. For example, \"2019-11-27T12:01:01+08:00\".
+        """
+        return self.__date_of_last_paid_purchase
+
+    @date_of_last_paid_purchase.setter
+    def date_of_last_paid_purchase(self, value):
+        self.__date_of_last_paid_purchase = value
+    @property
+    def date_of_first_paid_purchase(self):
+        """
+        The date and time of the buyer's first paid purchase. When using KLARNA for an e-commerce merchant, this field is required. The value follows the ISO 8601 standard format. For example, \"2019-11-27T12:01:01+08:00\".
+        """
+        return self.__date_of_first_paid_purchase
+
+    @date_of_first_paid_purchase.setter
+    def date_of_first_paid_purchase(self, value):
+        self.__date_of_first_paid_purchase = value
+    @property
+    def tax_ids(self):
+        """
+        For createPaymentSession, these buyer tax IDs are used for B2B or reverse-charge determination when automatic tax is active. If omitted, null, invalid, or unusable, Antom calculates tax as B2C instead of rejecting the payment session. Because Buyer is a shared SDK model, omit this field in APIs that do not explicitly document support. Maximum size: 10.
+        """
+        return self.__tax_ids
+
+    @tax_ids.setter
+    def tax_ids(self, value):
+        self.__tax_ids = value
+    @property
+    def business_address(self):
+        """Gets the business_address of this Buyer.
+        
+        """
+        return self.__business_address
+
+    @business_address.setter
+    def business_address(self, value):
+        self.__business_address = value
 
 
     
@@ -119,6 +177,16 @@ class Buyer:
             params['successfulOrderCount'] = self.successful_order_count
         if hasattr(self, "buyer_phone_no_contry_code") and self.buyer_phone_no_contry_code is not None:
             params['buyerPhoneNoContryCode'] = self.buyer_phone_no_contry_code
+        if hasattr(self, "successful_order_amount") and self.successful_order_amount is not None:
+            params['successfulOrderAmount'] = self.successful_order_amount
+        if hasattr(self, "date_of_last_paid_purchase") and self.date_of_last_paid_purchase is not None:
+            params['dateOfLastPaidPurchase'] = self.date_of_last_paid_purchase
+        if hasattr(self, "date_of_first_paid_purchase") and self.date_of_first_paid_purchase is not None:
+            params['dateOfFirstPaidPurchase'] = self.date_of_first_paid_purchase
+        if hasattr(self, "tax_ids") and self.tax_ids is not None:
+            params['taxIds'] = self.tax_ids
+        if hasattr(self, "business_address") and self.business_address is not None:
+            params['businessAddress'] = self.business_address
         return params
 
 
@@ -142,3 +210,19 @@ class Buyer:
             self.__successful_order_count = response_body['successfulOrderCount']
         if 'buyerPhoneNoContryCode' in response_body:
             self.__buyer_phone_no_contry_code = response_body['buyerPhoneNoContryCode']
+        if 'successfulOrderAmount' in response_body:
+            self.__successful_order_amount = Amount()
+            self.__successful_order_amount.parse_rsp_body(response_body['successfulOrderAmount'])
+        if 'dateOfLastPaidPurchase' in response_body:
+            self.__date_of_last_paid_purchase = response_body['dateOfLastPaidPurchase']
+        if 'dateOfFirstPaidPurchase' in response_body:
+            self.__date_of_first_paid_purchase = response_body['dateOfFirstPaidPurchase']
+        if 'taxIds' in response_body:
+            self.__tax_ids = []
+            for item in response_body['taxIds']:
+                obj = BuyerTaxId()
+                obj.parse_rsp_body(item)
+                self.__tax_ids.append(obj)
+        if 'businessAddress' in response_body:
+            self.__business_address = Address()
+            self.__business_address.parse_rsp_body(response_body['businessAddress'])

global_open_sdk_python-1.6.0/com/alipay/ams/api/model/buyer_tax_id.py

@@ -0,0 +1,67 @@
+import json
+
+
+
+
+class BuyerTaxId:
+    def __init__(self):
+        
+        self.__country = None  # type: str
+        self.__region = None  # type: str
+        self.__value = None  # type: str
+        
+
+    @property
+    def country(self):
+        """
+        The two-letter ISO 3166-1 alpha-2 country or region code used to validate the tax ID. Maximum length: 2 characters.
+        """
+        return self.__country
+
+    @country.setter
+    def country(self, value):
+        self.__country = value
+    @property
+    def region(self):
+        """
+        The two-character country-specific subdivision code. Required only when the applicable tax authority or country or region rule requires subdivision-level identification. Maximum length: 2 characters.
+        """
+        return self.__region
+
+    @region.setter
+    def region(self, value):
+        self.__region = value
+    @property
+    def value(self):
+        """
+        The buyer tax ID value. The accepted format is country-specific. Maximum length: 64 characters.
+        """
+        return self.__value
+
+    @value.setter
+    def value(self, value):
+        self.__value = value
+
+
+    
+
+    def to_ams_dict(self):
+        params = dict()
+        if hasattr(self, "country") and self.country is not None:
+            params['country'] = self.country
+        if hasattr(self, "region") and self.region is not None:
+            params['region'] = self.region
+        if hasattr(self, "value") and self.value is not None:
+            params['value'] = self.value
+        return params
+
+
+    def parse_rsp_body(self, response_body):
+        if isinstance(response_body, str): 
+            response_body = json.loads(response_body)
+        if 'country' in response_body:
+            self.__country = response_body['country']
+        if 'region' in response_body:
+            self.__region = response_body['region']
+        if 'value' in response_body:
+            self.__value = response_body['value']

{global_open_sdk_python-1.5.7 → global_open_sdk_python-1.6.0}/com/alipay/ams/api/model/goods.py

@@ -22,6 +22,8 @@ class Goods:
         self.__goods_discount_amount = None  # type: Amount
         self.__goods_ends_on_time = None  # type: str
         self.__cross_sell = None  # type: Goods
+        self.__tax_code = None  # type: str
+        self.__tax_behavior = None  # type: str
         
 
     @property
@@ -116,8 +118,8 @@ class Goods:
         self.__delivery_method_type = value
     @property
     def goods_image_url(self):
-        """Gets the goods_image_url of this Goods.
-        
+        """
+        The URL of the goods image. When using KLARNA, this value is used to display the goods image in the payment method app and must not exceed 1024 characters.
         """
         return self.__goods_image_url
 
@@ -164,6 +166,26 @@ class Goods:
     @cross_sell.setter
     def cross_sell(self, value):
         self.__cross_sell = value
+    @property
+    def tax_code(self):
+        """
+        For createPaymentSession, this is the product tax code used by Antom GlobalTax to classify the goods line. When automatic tax is active, omit it to use the merchant default tax code. Because Goods is a shared SDK model, omit this field in APIs that do not explicitly document support. Maximum length: 64 characters.
+        """
+        return self.__tax_code
+
+    @tax_code.setter
+    def tax_code(self, value):
+        self.__tax_code = value
+    @property
+    def tax_behavior(self):
+        """
+        For createPaymentSession, this value indicates whether the goods-line price excludes or includes tax. Supported values are EXCLUSIVE and INCLUSIVE. When automatic tax is active, omit it to use the merchant tax behavior settings. Because Goods is a shared SDK model, omit this field in APIs that do not explicitly document support. Maximum length: 16 characters.
+        """
+        return self.__tax_behavior
+
+    @tax_behavior.setter
+    def tax_behavior(self, value):
+        self.__tax_behavior = value
 
 
     
@@ -198,6 +220,10 @@ class Goods:
             params['goodsEndsOnTime'] = self.goods_ends_on_time
         if hasattr(self, "cross_sell") and self.cross_sell is not None:
             params['crossSell'] = self.cross_sell
+        if hasattr(self, "tax_code") and self.tax_code is not None:
+            params['taxCode'] = self.tax_code
+        if hasattr(self, "tax_behavior") and self.tax_behavior is not None:
+            params['taxBehavior'] = self.tax_behavior
         return params
 
 
@@ -235,3 +261,7 @@ class Goods:
         if 'crossSell' in response_body:
             self.__cross_sell = Goods()
             self.__cross_sell.parse_rsp_body(response_body['crossSell'])
+        if 'taxCode' in response_body:
+            self.__tax_code = response_body['taxCode']
+        if 'taxBehavior' in response_body:
+            self.__tax_behavior = response_body['taxBehavior']