global-open-sdk-python 1.5.3__tar.gz → 1.5.4__tar.gz

{global_open_sdk_python-1.5.3 → global_open_sdk_python-1.5.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: global-open-sdk-python
-Version: 1.5.3
+Version: 1.5.4
 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.3 → global_open_sdk_python-1.5.4}/README.md

@@ -1,7 +1,7 @@
 ```
 Language：Python  
 Python version：2.7+  
-Release ^1.5.3
+Release ^1.5.4
 Copyright：Ant financial services group  
 ```
 

{global_open_sdk_python-1.5.3 → global_open_sdk_python-1.5.4}/com/alipay/ams/api/_version.py

@@ -1,2 +1,2 @@
-VERSION = "1.5.3"
+VERSION = "1.5.4"
 USER_AGENT = "global-open-sdk-python/" + VERSION

{global_open_sdk_python-1.5.3 → global_open_sdk_python-1.5.4}/com/alipay/ams/api/default_alipay_client.py

@@ -23,6 +23,30 @@ class DefaultAlipayClient(object):
         self.__alipay_public_key = alipay_public_key
         self.__is_sandbox_mode = client_id.startswith("SANDBOX_")
         self.__agent_token = agent_token
+        self.__upload_gateway_url = None
+
+    def set_upload_gateway_url(self, upload_gateway_url):
+        from com.alipay.ams.api.file_upload_executor import (
+            normalize_explicit_upload_gateway,
+        )
+
+        self.__upload_gateway_url = normalize_explicit_upload_gateway(
+            upload_gateway_url
+        )
+        return self
+
+    def upload_file(self, request):
+        from com.alipay.ams.api.file_upload_executor import execute_file_upload
+
+        return execute_file_upload(
+            request=request,
+            gateway_url=self.__gateway_url,
+            upload_gateway_url=self.__upload_gateway_url,
+            client_id=self.__client_id,
+            merchant_private_key=self.__merchant_private_key,
+            alipay_public_key=self.__alipay_public_key,
+            agent_token=self.__agent_token,
+        )
 
     """
     内部方法，生成请求签名
@@ -147,10 +171,8 @@ class DefaultAlipayClient(object):
         "agent-token",
         "user-agent",
     }
-    _SANDBOX_PRODUCTION_PATH_PREFIXES = (
-        "/ams/api/v1/billing/",
-        "/ams/api/v1/meter/",
-    )
+    # Billing and Meter APIs now support sandbox. Keep the filter logic for future use.
+    _SANDBOX_PRODUCTION_PATH_PREFIXES = ()
 
     def execute_with_headers(self, request, extra_headers=None):
 

global_open_sdk_python-1.5.4/com/alipay/ams/api/file_upload_executor.py

@@ -0,0 +1,277 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import hashlib
+import json
+import mimetypes
+
+try:
+    import urllib.parse as url_parse
+except ImportError:
+    import urlparse as url_parse
+
+from com.alipay.ams.api._version import USER_AGENT
+from com.alipay.ams.api.exception.exception import AlipayApiException
+from com.alipay.ams.api.net.multipart_http_rpc import do_multipart_post
+from com.alipay.ams.api.request.alipay_file_request import AlipayFileRequest
+from com.alipay.ams.api.request.billing.alipay_product_upload_image_request import (
+    AlipayProductUploadImageRequest,
+)
+from com.alipay.ams.api.response.billing.alipay_product_upload_image_response import (
+    AlipayProductUploadImageResponse,
+)
+from com.alipay.ams.api.tools.constants import DEFAULT_CHARSET, DEFAULT_KEY_VERSION
+from com.alipay.ams.api.tools.date_tools import get_cur_iso8601_time
+from com.alipay.ams.api.tools.signature_tool import sign, verify
+
+try:
+    string_types = (basestring,)
+except NameError:
+    string_types = (str,)
+
+
+_GATEWAY_HOSTS = {
+    "open-sea-global.alipay.com": "open-big-sea.alipay.com",
+    "open-sea.alipay.com": "open-big-sea.alipay.com",
+    "open-na-global.alipay.com": "open-big-na.alipay.com",
+    "open-na.alipay.com": "open-big-na.alipay.com",
+    "open-de-global.alipay.com": "open-big-de-global.alipay.com",
+}
+
+_PRODUCT_IMAGE_OPERATION = {
+    "path": "/ams/api/v1/billing/product/uploadImage",
+    "max_file_size": 2 * 1024 * 1024,
+    "file_part_names": ("file", "imageFile"),
+    "response_type": AlipayProductUploadImageResponse,
+}
+
+_OPERATIONS = {
+    AlipayProductUploadImageRequest: _PRODUCT_IMAGE_OPERATION,
+}
+
+
+def normalize_explicit_upload_gateway(upload_gateway_url):
+    return _normalize_gateway(upload_gateway_url, require_known_host=False)
+
+
+def execute_file_upload(
+    request,
+    gateway_url,
+    upload_gateway_url,
+    client_id,
+    merchant_private_key,
+    alipay_public_key,
+    agent_token=None,
+):
+    if not isinstance(request, AlipayFileRequest):
+        raise AlipayApiException("request must be an AlipayFileRequest")
+    operation = _OPERATIONS.get(type(request))
+    if operation is None:
+        raise AlipayApiException("Only SDK-provided file upload requests are supported")
+
+    product_id = request.product_id
+    if not isinstance(product_id, string_types) or not product_id.strip():
+        raise AlipayApiException("product_id can't be empty")
+    if len(product_id) > 64:
+        raise AlipayApiException("product_id length cannot exceed 64 characters")
+
+    file_content = _read_bounded_file(request.file, operation["max_file_size"])
+    file_name = request.filename
+    file_content_type = mimetypes.guess_type(file_name)[0] or "application/octet-stream"
+    request_body = json.dumps(
+        {
+            "productId": product_id,
+            "fileSha256": hashlib.sha256(file_content).hexdigest(),
+        },
+        ensure_ascii=False,
+        separators=(",", ":"),
+    )
+
+    path = operation["path"]
+    if client_id.startswith("SANDBOX_"):
+        path = path.replace("/ams/api", "/ams/sandbox/api", 1)
+    gateway = _resolve_upload_gateway(gateway_url, upload_gateway_url)
+    request_time = get_cur_iso8601_time()
+    signature_value = sign(
+        "POST",
+        path,
+        client_id,
+        request_time,
+        request_body,
+        merchant_private_key,
+    )
+    key_version = request.key_version or DEFAULT_KEY_VERSION
+    headers = {
+        "Accept": "text/plain,text/xml,text/javascript,text/html",
+        "Cache-Control": "no-cache",
+        "Connection": "Keep-Alive",
+        "User-Agent": USER_AGENT,
+        "Request-Time": request_time,
+        "client-id": client_id,
+        "Signature": "algorithm=RSA256,keyVersion={0},signature={1}".format(
+            key_version, signature_value
+        ),
+    }
+    if agent_token:
+        headers["Agent-Token"] = agent_token
+
+    response_headers, response = do_multipart_post(
+        gateway + path,
+        headers,
+        request_body,
+        operation["file_part_names"],
+        file_name,
+        file_content_type,
+        file_content,
+    )
+    response_body = response.decode(DEFAULT_CHARSET)
+    response_data = _parse_response(response_body)
+    _verify_response(
+        response_headers,
+        response_body,
+        response_data,
+        path,
+        client_id,
+        alipay_public_key,
+    )
+    return operation["response_type"](response_body)
+
+
+def _read_bounded_file(file_object, max_file_size):
+    if file_object is None or not hasattr(file_object, "read"):
+        raise AlipayApiException("file must be a readable binary file object")
+
+    position = None
+    if hasattr(file_object, "tell"):
+        try:
+            position = file_object.tell()
+        except (IOError, OSError):
+            position = None
+
+    read_error = None
+    try:
+        content = file_object.read(max_file_size + 1)
+    except Exception as exc:
+        read_error = exc
+        content = None
+    finally:
+        if position is not None and hasattr(file_object, "seek"):
+            try:
+                file_object.seek(position)
+            except (IOError, OSError) as exc:
+                if read_error is None:
+                    raise AlipayApiException("Unable to restore file position: " + str(exc))
+
+    if read_error is not None:
+        raise AlipayApiException("Unable to read file: " + str(read_error))
+    if isinstance(content, bytearray):
+        content = bytes(content)
+    if not isinstance(content, bytes):
+        raise AlipayApiException("file must be opened in binary mode")
+    if not content:
+        raise AlipayApiException("file can't be empty")
+    if len(content) > max_file_size:
+        raise AlipayApiException(
+            "file size cannot exceed {0} bytes".format(max_file_size)
+        )
+    return content
+
+
+def _parse_response(response_body):
+    try:
+        response_data = json.loads(response_body)
+    except (TypeError, ValueError) as exc:
+        raise AlipayApiException("Invalid file response JSON: " + str(exc))
+    if not isinstance(response_data, dict) or not isinstance(
+        response_data.get("result"), dict
+    ):
+        raise AlipayApiException("File response result field is missing")
+    return response_data
+
+
+def _verify_response(
+    response_headers,
+    response_body,
+    response_data,
+    path,
+    client_id,
+    alipay_public_key,
+):
+    headers = {}
+    for name, value in response_headers:
+        headers[name.lower()] = value
+    response_time = headers.get("response-time")
+    signature_value = _extract_signature(headers.get("signature"))
+
+    if not signature_value and not response_time:
+        if response_data["result"].get("resultStatus") != "F":
+            raise AlipayApiException("Unsigned file response is not a failure response")
+        return
+    if not signature_value or not response_time:
+        raise AlipayApiException(
+            "File response must contain both Signature and Response-Time"
+        )
+    try:
+        verified = verify(
+            "POST",
+            path,
+            client_id,
+            response_time,
+            response_body,
+            signature_value,
+            alipay_public_key,
+        )
+    except Exception as exc:
+        raise AlipayApiException("File response verification failed: " + str(exc))
+    if not verified:
+        raise AlipayApiException("File response signature verification failed")
+
+
+def _extract_signature(signature_header):
+    if not signature_header:
+        return None
+    for item in signature_header.split(","):
+        key_value = item.strip().split("=", 1)
+        if len(key_value) == 2 and key_value[0].lower() == "signature":
+            return key_value[1]
+    return None
+
+
+def _resolve_upload_gateway(gateway_url, explicit_upload_gateway):
+    if explicit_upload_gateway:
+        return explicit_upload_gateway
+    return _normalize_gateway(gateway_url, require_known_host=True)
+
+
+def _normalize_gateway(gateway_url, require_known_host):
+    if not isinstance(gateway_url, string_types) or not gateway_url.strip():
+        raise AlipayApiException("upload gateway URL can't be empty")
+    candidate = gateway_url.strip()
+    if "://" not in candidate:
+        candidate = "https://" + candidate
+    parsed = url_parse.urlparse(candidate)
+    if parsed.scheme.lower() != "https" or not parsed.hostname:
+        raise AlipayApiException("upload gateway URL must use HTTPS")
+    if parsed.username or parsed.password or parsed.path not in ("", "/"):
+        raise AlipayApiException("upload gateway URL must not contain credentials or a path")
+    if parsed.params or parsed.query or parsed.fragment:
+        raise AlipayApiException("upload gateway URL must not contain params, query, or fragment")
+    try:
+        port = parsed.port
+    except ValueError as exc:
+        raise AlipayApiException("invalid upload gateway port: " + str(exc))
+    if require_known_host and port not in (None, 443):
+        raise AlipayApiException("upload gateway URL only supports port 443")
+
+    host = parsed.hostname.lower()
+    if require_known_host:
+        mapped_host = _GATEWAY_HOSTS.get(host)
+        if mapped_host is None:
+            raise AlipayApiException(
+                "No upload gateway mapping for {0}; configure one explicitly".format(host)
+            )
+        host = mapped_host
+    authority = host
+    if not require_known_host and port is not None:
+        authority += ":" + str(port)
+    return "https://" + authority

{global_open_sdk_python-1.5.3 → global_open_sdk_python-1.5.4}/com/alipay/ams/api/model/billing_discount.py

@@ -13,7 +13,7 @@ class BillingDiscount:
     @property
     def coupon_id(self):
         """
-        Coupon ID.
+        Coupon ID associated with the discount. Exactly one of `couponId` and `promotionCodeId` can be provided in a discount request; responses return the identifier that was applied. Maximum length: 64 characters.
         """
         return self.__coupon_id
 
@@ -23,7 +23,7 @@ class BillingDiscount:
     @property
     def promotion_code_id(self):
         """
-        Promotion code ID.
+        Promotion code ID associated with the discount. Exactly one of `couponId` and `promotionCodeId` can be provided in a discount request; responses return the identifier that was applied. Maximum length: 64 characters.
         """
         return self.__promotion_code_id
 

{global_open_sdk_python-1.5.3 → global_open_sdk_python-1.5.4}/com/alipay/ams/api/model/billing_subscription.py

@@ -13,11 +13,11 @@ class BillingSubscription:
         self.__payment_behavior = None  # type: str
         self.__collection_method = None  # type: str
         self.__days_until_due = None  # type: int
-        self.__billing_cycle_anchor = None  # type: str
         self.__cancel_at = None  # type: str
         self.__cancel_at_period_end = None  # type: bool
         self.__description = None  # type: str
         self.__discounts = None  # type: [BillingDiscount]
+        self.__default_payment_method = None  # type: str
         self.__allow_promotion_code = None  # type: bool
         self.__subscription_notify_url = None  # type: str
         
@@ -45,7 +45,7 @@ class BillingSubscription:
     @property
     def payment_behavior(self):
         """
-        Payment behavior.
+        The payment behavior for subscription creation. The currently supported value is ALLOW_INCOMPLETE.
         """
         return self.__payment_behavior
 
@@ -73,16 +73,6 @@ class BillingSubscription:
     def days_until_due(self, value):
         self.__days_until_due = value
     @property
-    def billing_cycle_anchor(self):
-        """
-        Billing cycle anchor time.
-        """
-        return self.__billing_cycle_anchor
-
-    @billing_cycle_anchor.setter
-    def billing_cycle_anchor(self, value):
-        self.__billing_cycle_anchor = value
-    @property
     def cancel_at(self):
         """
         Cancellation time.
@@ -123,6 +113,16 @@ class BillingSubscription:
     def discounts(self, value):
         self.__discounts = value
     @property
+    def default_payment_method(self):
+        """
+        The default payment method for this subscription. It takes precedence over the customer-level default. Maximum length: 64 characters.
+        """
+        return self.__default_payment_method
+
+    @default_payment_method.setter
+    def default_payment_method(self, value):
+        self.__default_payment_method = value
+    @property
     def allow_promotion_code(self):
         """
         Whether to allow promotion codes.
@@ -158,8 +158,6 @@ class BillingSubscription:
             params['collectionMethod'] = self.collection_method
         if hasattr(self, "days_until_due") and self.days_until_due is not None:
             params['daysUntilDue'] = self.days_until_due
-        if hasattr(self, "billing_cycle_anchor") and self.billing_cycle_anchor is not None:
-            params['billingCycleAnchor'] = self.billing_cycle_anchor
         if hasattr(self, "cancel_at") and self.cancel_at is not None:
             params['cancelAt'] = self.cancel_at
         if hasattr(self, "cancel_at_period_end") and self.cancel_at_period_end is not None:
@@ -168,6 +166,8 @@ class BillingSubscription:
             params['description'] = self.description
         if hasattr(self, "discounts") and self.discounts is not None:
             params['discounts'] = self.discounts
+        if hasattr(self, "default_payment_method") and self.default_payment_method is not None:
+            params['defaultPaymentMethod'] = self.default_payment_method
         if hasattr(self, "allow_promotion_code") and self.allow_promotion_code is not None:
             params['allowPromotionCode'] = self.allow_promotion_code
         if hasattr(self, "subscription_notify_url") and self.subscription_notify_url is not None:
@@ -189,8 +189,6 @@ class BillingSubscription:
             self.__collection_method = response_body['collectionMethod']
         if 'daysUntilDue' in response_body:
             self.__days_until_due = response_body['daysUntilDue']
-        if 'billingCycleAnchor' in response_body:
-            self.__billing_cycle_anchor = response_body['billingCycleAnchor']
         if 'cancelAt' in response_body:
             self.__cancel_at = response_body['cancelAt']
         if 'cancelAtPeriodEnd' in response_body:
@@ -203,6 +201,8 @@ class BillingSubscription:
                 obj = BillingDiscount()
                 obj.parse_rsp_body(item)
                 self.__discounts.append(obj)
+        if 'defaultPaymentMethod' in response_body:
+            self.__default_payment_method = response_body['defaultPaymentMethod']
         if 'allowPromotionCode' in response_body:
             self.__allow_promotion_code = response_body['allowPromotionCode']
         if 'subscriptionNotifyUrl' in response_body:

global_open_sdk_python-1.5.4/com/alipay/ams/api/model/billing_subscription_cancellation_details.py

@@ -0,0 +1,52 @@
+import json
+
+
+
+
+class BillingSubscriptionCancellationDetails:
+    def __init__(self):
+        
+        self.__feedback = None  # type: str
+        self.__comment = None  # type: str
+        
+
+    @property
+    def feedback(self):
+        """
+        Structured cancellation feedback. Recommended values include TOO_EXPENSIVE, UNUSED, MISSING_FEATURES, TOO_COMPLEX, SWITCHED_SERVICE, LOW_QUALITY, CUSTOMER_SERVICE, and OTHER. Other values are accepted. Maximum length: 64 characters.
+        """
+        return self.__feedback
+
+    @feedback.setter
+    def feedback(self, value):
+        self.__feedback = value
+    @property
+    def comment(self):
+        """
+        Additional cancellation details. Do not include personally identifiable information. Maximum length: 500 characters.
+        """
+        return self.__comment
+
+    @comment.setter
+    def comment(self, value):
+        self.__comment = value
+
+
+    
+
+    def to_ams_dict(self):
+        params = dict()
+        if hasattr(self, "feedback") and self.feedback is not None:
+            params['feedback'] = self.feedback
+        if hasattr(self, "comment") and self.comment is not None:
+            params['comment'] = self.comment
+        return params
+
+
+    def parse_rsp_body(self, response_body):
+        if isinstance(response_body, str): 
+            response_body = json.loads(response_body)
+        if 'feedback' in response_body:
+            self.__feedback = response_body['feedback']
+        if 'comment' in response_body:
+            self.__comment = response_body['comment']

{global_open_sdk_python-1.5.3 → global_open_sdk_python-1.5.4}/com/alipay/ams/api/model/billing_subscription_discount_info.py

@@ -10,7 +10,7 @@ class BillingSubscriptionDiscountInfo:
         self.__discount_id = None  # type: str
         self.__coupon_id = None  # type: str
         self.__type = None  # type: str
-        self.__percent_off = None  # type: int
+        self.__percent_off = None  # type: str
         self.__amount_off = None  # type: Amount
         self.__duration = None  # type: str
         self.__times = None  # type: int
@@ -50,7 +50,7 @@ class BillingSubscriptionDiscountInfo:
     @property
     def percent_off(self):
         """
-        The percent off. Note: See documentation for details.
+        Percentage discount as a decimal string.
         """
         return self.__percent_off