global-open-sdk-python 1.6.1__tar.gz → 1.6.2__tar.gz

{global_open_sdk_python-1.6.1 → global_open_sdk_python-1.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: global-open-sdk-python
-Version: 1.6.1
+Version: 1.6.2
 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.6.2/README.md

@@ -0,0 +1,207 @@
+# Antom SDK for Python
+
+Latest release: **1.6.2**
+
+## Installation
+
+Use Python 3.9.2 or later; a maintained Python release is recommended.
+The SDK uses Python 3.9+ type annotations, and its `cryptography` dependency
+excludes Python 3.9.0 and 3.9.1. Use a virtual environment and ensure `python`
+refers to that interpreter.
+
+```sh
+python -m pip install --upgrade global-open-sdk-python
+```
+
+For Meter HTTP/2, install the optional dependencies with
+`python -m pip install --upgrade "global-open-sdk-python[http2]"`.
+
+## Quick start
+
+- **RSA:** follow the [configuration](#rsa-configuration) and [inline example](#payment) below.
+- **API Key (limited availability):** follow the [setup guide](docs/api-key-client.md) and run the [sandbox example](example/api_key_payment_session.py).
+- Browse [more examples](example) and the [API documentation](https://global.alipay.com/docs/).
+
+RSA and API Key clients share request/response models. File uploads and notification
+verification still require RSA credentials.
+
+### RSA configuration
+
+Before using the RSA client, prepare these values from your Antom integration:
+
+```properties
+gatewayUrl=your_regional_https_gateway
+clientId=your_client_id
+merchantPrivateKey=your_merchant_private_key
+alipayPublicKey=your_antom_public_key
+```
+
+The examples read them from `ANTOM_GATEWAY_URL`, `ANTOM_CLIENT_ID`,
+`ANTOM_MERCHANT_PRIVATE_KEY`, and `ANTOM_PUBLIC_KEY`, respectively.
+Keep keys in server-side configuration. Replace sample order data and callback
+URLs with your own values before sending a request.
+
+### Payment
+
+Save as `payment_example.py` and configure the four environment variables above.
+
+```python
+import os
+import uuid
+from com.alipay.ams.api.model.merchant import Merchant
+from com.alipay.ams.api.model.amount import Amount
+from com.alipay.ams.api.model.settlement_strategy import SettlementStrategy
+from com.alipay.ams.api.model.order import Order
+from com.alipay.ams.api.model.product_code_type import ProductCodeType
+from com.alipay.ams.api.model.payment_method import PaymentMethod
+from com.alipay.ams.api.model.env import Env
+from com.alipay.ams.api.model.goods import Goods
+from com.alipay.ams.api.model.terminal_type import TerminalType
+from com.alipay.ams.api.model.os_type import OsType
+from com.alipay.ams.api.model.result_status_type import ResultStatusType
+from com.alipay.ams.api.default_alipay_client import DefaultAlipayClient
+from com.alipay.ams.api.request.pay.alipay_pay_request import AlipayPayRequest
+from com.alipay.ams.api.response.pay.alipay_pay_response import AlipayPayResponse
+
+MERCHANT_PRIVATE_KEY = os.environ["ANTOM_MERCHANT_PRIVATE_KEY"]
+ALIPAY_PUBLIC_KEY = os.environ["ANTOM_PUBLIC_KEY"]
+CLIENT_ID = os.environ["ANTOM_CLIENT_ID"]
+GATEWAY_HOST = os.environ["ANTOM_GATEWAY_URL"]
+
+
+
+default_alipay_client = DefaultAlipayClient(GATEWAY_HOST, CLIENT_ID, MERCHANT_PRIVATE_KEY,
+                                            ALIPAY_PUBLIC_KEY)
+
+alipay_pay_request = AlipayPayRequest()
+
+alipay_pay_request.product_code = ProductCodeType.CASHIER_PAYMENT
+alipay_pay_request.payment_notify_url = "https://www.yourNotifyUrl.com"
+alipay_pay_request.payment_redirect_url = "https://www.yourRedirectUrl.com"
+alipay_pay_request.payment_request_id = str(uuid.uuid4())
+
+payment_method = PaymentMethod()
+payment_method.payment_method_type = "GCASH"
+alipay_pay_request.payment_method = payment_method
+
+amount = Amount("PHP", "10000")
+alipay_pay_request.payment_amount = amount
+
+order = Order()
+order.reference_order_id = "102775765675669"
+order.order_description = "Mi Band 3 Wrist Strap Metal Screwless Stainless Steel For Xiaomi Mi Band 3"
+order.order_amount = amount
+
+goods_arr = []
+good = Goods()
+good.goods_brand = "goods_brand"
+good.goods_name = "goods_name"
+goods_arr.append(good)
+order.goods = goods_arr
+
+merchant = Merchant()
+merchant.merchant_mcc = "merchantMcc"
+merchant.reference_merchant_id = "referenceMerchantId"
+
+order.merchant = merchant
+alipay_pay_request.order = order
+
+settlement_strategy = SettlementStrategy()
+settlement_strategy.settlement_currency = "USD"
+alipay_pay_request.settlement_strategy = settlement_strategy
+
+env = Env()
+env.terminal_type = TerminalType.APP
+env.os_type = OsType.IOS
+alipay_pay_request.env = env
+
+# alipay_pay_request.is_authorization = "true"
+
+print(alipay_pay_request.to_ams_json())
+
+rsp_body = default_alipay_client.execute(alipay_pay_request)
+
+alipay_pay_response = AlipayPayResponse(rsp_body)
+
+if alipay_pay_response.result.result_status.name != ResultStatusType.F.name:
+    print(alipay_pay_response.payment_id)
+    print(alipay_pay_response.payment_create_time)
+else:
+    print(alipay_pay_response.result.result_message)
+```
+
+### API Key client (limited availability)
+
+> API Key access is not yet available to all merchants. Use this client only if
+> API Key access has been enabled for your account; otherwise, use RSA.
+
+Set `ANTOM_GATEWAY_URL` and `ANTOM_API_KEY` in your server environment.
+This initializes the client; see the [setup guide](docs/api-key-client.md) for a
+complete sandbox request and its additional configuration.
+
+```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"])
+```
+
+## Upgrade notes
+
+Gateway responses with `resultStatus S` must be signed; responses with only one
+of the signature and response-time headers are rejected.
+
+Billing integrations: `availableAmount` now uses `Amount`; the `AvailableAmount`
+model has been removed.
+
+## Meter event upload
+
+Install the optional HTTP/2 dependencies using the Python environment described
+in [Installation](#installation).
+
+```bash
+python -m pip install --upgrade "global-open-sdk-python[http2]"
+```
+
+`meter/createSession` uses the regular signed AMS transport. Use its session ID
+to call `meter/uploadEvent` through `execute_with_headers`:
+
+The fragment below assumes an initialized RSA client, a valid session ID from
+`meter/createSession`, and a populated collection of meter event batches.
+
+```python
+# Requires the http2 extra installed above.
+from com.alipay.ams.api.request.billing.alipay_meter_upload_event_request import AlipayMeterUploadEventRequest
+
+request = AlipayMeterUploadEventRequest()
+request.meters = meters
+response_body = default_alipay_client.execute_with_headers(
+    request, {"X-Session-Id": session_id}
+)
+```
+
+The SDK sends `meter/uploadEvent` to the gateway URL configured on the client,
+without sandbox path rewriting, request signing, response signature verification,
+or automatic retries. This API requires HTTP/2.
+
+## Advanced usage
+
+### Sign and verify without the HTTP client
+
+Use the exact transmitted path, timestamp, body, and configured keys. The variables
+below come from your request/response. Verify notifications before parsing their
+original body.
+
+```python
+from com.alipay.ams.api.tools.signature_tool import sign, verify
+
+signature = sign(http_method, path, client_id, request_time, request_body, merchant_private_key)
+verified = verify(
+    http_method, path, client_id, response_time, response_body, response_signature, alipay_public_key
+)
+```
+
+## Support
+
+For integration questions, contact overseas_support@service.alibaba.com.

{global_open_sdk_python-1.6.1 → global_open_sdk_python-1.6.2}/com/alipay/ams/api/_version.py

@@ -1,2 +1,2 @@
-VERSION = "1.6.1"
+VERSION = "1.6.2"
 USER_AGENT = "global-open-sdk-python/" + VERSION

global_open_sdk_python-1.6.2/com/alipay/ams/api/model/authorization_access_params.py

@@ -0,0 +1,37 @@
+import json
+
+
+
+
+class AuthorizationAccessParams:
+    def __init__(self):
+        
+        self.__channel = None  # type: str
+        
+
+    @property
+    def channel(self):
+        """
+        Required when directDebitInfo is provided for periodic signing. Null, empty and blank values are invalid. Maximum length: 100 characters. Allowed values: ALIPAYAPP, QRCODE, QRCODEORSMS. The Alipay app, QR-code, or QR-code/SMS signing entry.
+        """
+        return self.__channel
+
+    @channel.setter
+    def channel(self, value):
+        self.__channel = value
+
+
+    
+
+    def to_ams_dict(self):
+        params = dict()
+        if hasattr(self, "channel") and self.channel is not None:
+            params['channel'] = self.channel
+        return params
+
+
+    def parse_rsp_body(self, response_body):
+        if isinstance(response_body, str): 
+            response_body = json.loads(response_body)
+        if 'channel' in response_body:
+            self.__channel = response_body['channel']

global_open_sdk_python-1.6.2/com/alipay/ams/api/model/authorization_consult_direct_debit_info.py

@@ -0,0 +1,182 @@
+import json
+from com.alipay.ams.api.model.authorization_access_params import AuthorizationAccessParams
+from com.alipay.ams.api.model.period_rule_params import PeriodRuleParams
+from com.alipay.ams.api.model.authorization_consult_pass_back_params import AuthorizationConsultPassBackParams
+from com.alipay.ams.api.model.authorization_consult_subscription_params import AuthorizationConsultSubscriptionParams
+from com.alipay.ams.api.model.authorization_consult_sub_merchant import AuthorizationConsultSubMerchant
+
+
+
+
+class AuthorizationConsultDirectDebitInfo:
+    def __init__(self):
+        
+        self.__channel_product_code = None  # type: str
+        self.__personal_product_code = None  # type: str
+        self.__sign_scene = None  # type: str
+        self.__access_params = None  # type: AuthorizationAccessParams
+        self.__period_rule_params = None  # type: PeriodRuleParams
+        self.__pass_back_params = None  # type: AuthorizationConsultPassBackParams
+        self.__subscription_params = None  # type: AuthorizationConsultSubscriptionParams
+        self.__sub_merchant = None  # type: AuthorizationConsultSubMerchant
+        self.__subscribe_type = None  # type: str
+        self.__ori_agreement_no = None  # type: str
+        
+
+    @property
+    def channel_product_code(self):
+        """
+        Required when directDebitInfo is provided for periodic signing. Null, empty and blank values are invalid. Maximum length: 64 characters. Send CYCLE_PAY_AUTH; do not replace it with the channel product code. Allowed values: CYCLE_PAY_AUTH. The periodic-signing API product selector. The service maps it to the channel signing product GENERAL_WITHHOLDING.
+        """
+        return self.__channel_product_code
+
+    @channel_product_code.setter
+    def channel_product_code(self, value):
+        self.__channel_product_code = value
+    @property
+    def personal_product_code(self):
+        """
+        Required when directDebitInfo is provided for periodic signing. Null, empty and blank values are invalid. Maximum length: 64 characters. Allowed values: CYCLE_PAY_AUTH_P. The Alipay periodic-signing authorization product.
+        """
+        return self.__personal_product_code
+
+    @personal_product_code.setter
+    def personal_product_code(self, value):
+        self.__personal_product_code = value
+    @property
+    def sign_scene(self):
+        """
+        Required when directDebitInfo is provided for periodic signing. Null, empty and blank values are invalid. Production uses INDUSTRY|SUBSCRIPTION_DEFAULT_SCENE. Test environments use only explicitly configured test scenes; do not use a test scene in production.
+        """
+        return self.__sign_scene
+
+    @sign_scene.setter
+    def sign_scene(self, value):
+        self.__sign_scene = value
+    @property
+    def access_params(self):
+        """Gets the access_params of this AuthorizationConsultDirectDebitInfo.
+        
+        """
+        return self.__access_params
+
+    @access_params.setter
+    def access_params(self, value):
+        self.__access_params = value
+    @property
+    def period_rule_params(self):
+        """Gets the period_rule_params of this AuthorizationConsultDirectDebitInfo.
+        
+        """
+        return self.__period_rule_params
+
+    @period_rule_params.setter
+    def period_rule_params(self, value):
+        self.__period_rule_params = value
+    @property
+    def pass_back_params(self):
+        """Gets the pass_back_params of this AuthorizationConsultDirectDebitInfo.
+        
+        """
+        return self.__pass_back_params
+
+    @pass_back_params.setter
+    def pass_back_params(self, value):
+        self.__pass_back_params = value
+    @property
+    def subscription_params(self):
+        """Gets the subscription_params of this AuthorizationConsultDirectDebitInfo.
+        
+        """
+        return self.__subscription_params
+
+    @subscription_params.setter
+    def subscription_params(self, value):
+        self.__subscription_params = value
+    @property
+    def sub_merchant(self):
+        """Gets the sub_merchant of this AuthorizationConsultDirectDebitInfo.
+        
+        """
+        return self.__sub_merchant
+
+    @sub_merchant.setter
+    def sub_merchant(self, value):
+        self.__sub_merchant = value
+    @property
+    def subscribe_type(self):
+        """
+        Required when directDebitInfo is provided for periodic signing. Null, empty and blank values are invalid. A signing action, distinct from the page template and not a passBackParams property. Allowed values: CREATE, TRIAL, UPDATE, DOWNGRADE, REVERT_CANCEL. The subscription signing action. Supported enum values do not imply that every action is enabled in production.
+        """
+        return self.__subscribe_type
+
+    @subscribe_type.setter
+    def subscribe_type(self, value):
+        self.__subscribe_type = value
+    @property
+    def ori_agreement_no(self):
+        """
+        Required for UPDATE, DOWNGRADE and REVERT_CANCEL; omit for CREATE and TRIAL. Supply the original Antom Alipay authorization accessToken, not a raw channel agreement number. The service resolves it within the current merchant and maps it to the channel agreement. Do not log the token. Null and blank values are invalid.
+        """
+        return self.__ori_agreement_no
+
+    @ori_agreement_no.setter
+    def ori_agreement_no(self, value):
+        self.__ori_agreement_no = value
+
+
+    
+
+    def to_ams_dict(self):
+        params = dict()
+        if hasattr(self, "channel_product_code") and self.channel_product_code is not None:
+            params['channelProductCode'] = self.channel_product_code
+        if hasattr(self, "personal_product_code") and self.personal_product_code is not None:
+            params['personalProductCode'] = self.personal_product_code
+        if hasattr(self, "sign_scene") and self.sign_scene is not None:
+            params['signScene'] = self.sign_scene
+        if hasattr(self, "access_params") and self.access_params is not None:
+            params['accessParams'] = self.access_params
+        if hasattr(self, "period_rule_params") and self.period_rule_params is not None:
+            params['periodRuleParams'] = self.period_rule_params
+        if hasattr(self, "pass_back_params") and self.pass_back_params is not None:
+            params['passBackParams'] = self.pass_back_params
+        if hasattr(self, "subscription_params") and self.subscription_params is not None:
+            params['subscriptionParams'] = self.subscription_params
+        if hasattr(self, "sub_merchant") and self.sub_merchant is not None:
+            params['subMerchant'] = self.sub_merchant
+        if hasattr(self, "subscribe_type") and self.subscribe_type is not None:
+            params['subscribeType'] = self.subscribe_type
+        if hasattr(self, "ori_agreement_no") and self.ori_agreement_no is not None:
+            params['oriAgreementNo'] = self.ori_agreement_no
+        return params
+
+
+    def parse_rsp_body(self, response_body):
+        if isinstance(response_body, str): 
+            response_body = json.loads(response_body)
+        if 'channelProductCode' in response_body:
+            self.__channel_product_code = response_body['channelProductCode']
+        if 'personalProductCode' in response_body:
+            self.__personal_product_code = response_body['personalProductCode']
+        if 'signScene' in response_body:
+            self.__sign_scene = response_body['signScene']
+        if 'accessParams' in response_body:
+            self.__access_params = AuthorizationAccessParams()
+            self.__access_params.parse_rsp_body(response_body['accessParams'])
+        if 'periodRuleParams' in response_body:
+            self.__period_rule_params = PeriodRuleParams()
+            self.__period_rule_params.parse_rsp_body(response_body['periodRuleParams'])
+        if 'passBackParams' in response_body:
+            self.__pass_back_params = AuthorizationConsultPassBackParams()
+            self.__pass_back_params.parse_rsp_body(response_body['passBackParams'])
+        if 'subscriptionParams' in response_body:
+            self.__subscription_params = AuthorizationConsultSubscriptionParams()
+            self.__subscription_params.parse_rsp_body(response_body['subscriptionParams'])
+        if 'subMerchant' in response_body:
+            self.__sub_merchant = AuthorizationConsultSubMerchant()
+            self.__sub_merchant.parse_rsp_body(response_body['subMerchant'])
+        if 'subscribeType' in response_body:
+            self.__subscribe_type = response_body['subscribeType']
+        if 'oriAgreementNo' in response_body:
+            self.__ori_agreement_no = response_body['oriAgreementNo']

global_open_sdk_python-1.6.2/com/alipay/ams/api/model/authorization_consult_pass_back_params.py

@@ -0,0 +1,52 @@
+import json
+
+
+
+
+class AuthorizationConsultPassBackParams:
+    def __init__(self):
+        
+        self.__subscription_id = None  # type: str
+        self.__item_id = None  # type: str
+        
+
+    @property
+    def subscription_id(self):
+        """
+        Required when directDebitInfo is provided for periodic signing. Null, empty and blank values are invalid. The actual international subscription ID. Do not substitute authState, a payment order ID or a placeholder.
+        """
+        return self.__subscription_id
+
+    @subscription_id.setter
+    def subscription_id(self, value):
+        self.__subscription_id = value
+    @property
+    def item_id(self):
+        """
+        Required when directDebitInfo is provided for periodic signing. Null, empty and blank values are invalid. The actual subscription item ID belonging to subscriptionId.
+        """
+        return self.__item_id
+
+    @item_id.setter
+    def item_id(self, value):
+        self.__item_id = value
+
+
+    
+
+    def to_ams_dict(self):
+        params = dict()
+        if hasattr(self, "subscription_id") and self.subscription_id is not None:
+            params['subscriptionId'] = self.subscription_id
+        if hasattr(self, "item_id") and self.item_id is not None:
+            params['itemId'] = self.item_id
+        return params
+
+
+    def parse_rsp_body(self, response_body):
+        if isinstance(response_body, str): 
+            response_body = json.loads(response_body)
+        if 'subscriptionId' in response_body:
+            self.__subscription_id = response_body['subscriptionId']
+        if 'itemId' in response_body:
+            self.__item_id = response_body['itemId']

global_open_sdk_python-1.6.2/com/alipay/ams/api/model/authorization_consult_sub_merchant.py

@@ -0,0 +1,52 @@
+import json
+
+
+
+
+class AuthorizationConsultSubMerchant:
+    def __init__(self):
+        
+        self.__sub_merchant_service_name = None  # type: str
+        self.__sub_merchant_service_description = None  # type: str
+        
+
+    @property
+    def sub_merchant_service_name(self):
+        """
+        Required when directDebitInfo is provided for periodic signing. Null, empty and blank values are invalid. The actual customer-facing service name displayed on the signing page.
+        """
+        return self.__sub_merchant_service_name
+
+    @sub_merchant_service_name.setter
+    def sub_merchant_service_name(self, value):
+        self.__sub_merchant_service_name = value
+    @property
+    def sub_merchant_service_description(self):
+        """
+        Provide when seat or billing information must be displayed to the user; otherwise omit. Use accurate customer-facing seat/billing information, not unrelated personal information. Null or blank values are invalid.
+        """
+        return self.__sub_merchant_service_description
+
+    @sub_merchant_service_description.setter
+    def sub_merchant_service_description(self, value):
+        self.__sub_merchant_service_description = value
+
+
+    
+
+    def to_ams_dict(self):
+        params = dict()
+        if hasattr(self, "sub_merchant_service_name") and self.sub_merchant_service_name is not None:
+            params['subMerchantServiceName'] = self.sub_merchant_service_name
+        if hasattr(self, "sub_merchant_service_description") and self.sub_merchant_service_description is not None:
+            params['subMerchantServiceDescription'] = self.sub_merchant_service_description
+        return params
+
+
+    def parse_rsp_body(self, response_body):
+        if isinstance(response_body, str): 
+            response_body = json.loads(response_body)
+        if 'subMerchantServiceName' in response_body:
+            self.__sub_merchant_service_name = response_body['subMerchantServiceName']
+        if 'subMerchantServiceDescription' in response_body:
+            self.__sub_merchant_service_description = response_body['subMerchantServiceDescription']