Merge pull request #60 from XeroAPI/app-store-subscriptions

app store subscriptions added

Author: RettBehrens

docs/v1/accounting/index.html

@@ -48,5 +48,5 @@ def read_file(filename):
     keywords="xero python sdk API oAuth",
     name="xero_python",
     packages=find_packages(include=["xero_python", "xero_python.*"]),
-    version="1.8.1",
+    version="1.9.0",
 )

setup.py

@@ -2,4 +2,4 @@
 
 __author__ = """Xero Developer API"""
 __email__ = "api@xero.com"
-__version__ = "1.8.1"
+__version__ = "1.9.0"

xero_python/__init__.py

@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **date** | **date** | Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06 | [optional] 
 **currency_rate** | **float** | Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500 | [optional] 
 **amount** | **float** | The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00 | [optional] 
+**bank_amount** | **float** | The amount of the payment in the currency of the bank account. | [optional] 
 **reference** | **str** | An optional description for the payment e.g. Direct Debit | [optional] 
 **is_reconciled** | **bool** | An optional parameter for the payment. A boolean indicating whether you would like the payment to be created as reconciled when using PUT, or whether a payment has been reconciled when using GET | [optional] 
 **status** | **str** | The status of the payment. | [optional] 

xero_python/accounting/api/accounting_api.py

@@ -41,6 +41,7 @@ class Payment(BaseModel):
         "date": "date[ms-format]",
         "currency_rate": "float",
         "amount": "float",
+        "bank_amount": "float",
         "reference": "str",
         "is_reconciled": "bool",
         "status": "str",
@@ -69,6 +70,7 @@ class Payment(BaseModel):
         "date": "Date",
         "currency_rate": "CurrencyRate",
         "amount": "Amount",
+        "bank_amount": "BankAmount",
         "reference": "Reference",
         "is_reconciled": "IsReconciled",
         "status": "Status",
@@ -98,6 +100,7 @@ def __init__(
         date=None,
         currency_rate=None,
         amount=None,
+        bank_amount=None,
         reference=None,
         is_reconciled=None,
         status=None,
@@ -126,6 +129,7 @@ def __init__(
         self._date = None
         self._currency_rate = None
         self._amount = None
+        self._bank_amount = None
         self._reference = None
         self._is_reconciled = None
         self._status = None
@@ -164,6 +168,8 @@ def __init__(
             self.currency_rate = currency_rate
         if amount is not None:
             self.amount = amount
+        if bank_amount is not None:
+            self.bank_amount = bank_amount
         if reference is not None:
             self.reference = reference
         if is_reconciled is not None:
@@ -436,6 +442,29 @@ def amount(self, amount):
 
         self._amount = amount
 
+    @property
+    def bank_amount(self):
+        """Gets the bank_amount of this Payment.  # noqa: E501
+
+        The amount of the payment in the currency of the bank account.  # noqa: E501
+
+        :return: The bank_amount of this Payment.  # noqa: E501
+        :rtype: float
+        """
+        return self._bank_amount
+
+    @bank_amount.setter
+    def bank_amount(self, bank_amount):
+        """Sets the bank_amount of this Payment.
+
+        The amount of the payment in the currency of the bank account.  # noqa: E501
+
+        :param bank_amount: The bank_amount of this Payment.  # noqa: E501
+        :type: float
+        """
+
+        self._bank_amount = bank_amount
+
     @property
     def reference(self):
         """Gets the reference of this Payment.  # noqa: E501

xero_python/accounting/docs/Payment.md

@@ -132,3 +132,4 @@ class TimeZone(Enum):
     HAWAIIANSTANDARDTIME = "HAWAIIANSTANDARDTIME"
     UTC11 = "UTC11"
     DATELINESTANDARDTIME = "DATELINESTANDARDTIME"
+    EASTERISLANDSTANDARDTIME = "EASTERISLANDSTANDARDTIME"

xero_python/accounting/models/payment.py

@@ -758,13 +758,13 @@ def revoke_oauth2_token(self):
         if oauth2_token.revoke_access_token(self):
             return self.get_oauth2_token()
 
-    def get_client_credentials_token(self):
+    def get_client_credentials_token(self, app_store_billing=False):
         """
         Obtain oauth2 token using client credentials grant type
         :return: oauth2 token
         """
         oauth2_token = self.configuration.oauth2_token
-        if oauth2_token.get_client_credentials_access_token(self):
+        if oauth2_token.get_client_credentials_access_token(self, app_store_billing):
             return self.get_oauth2_token()
 
     def oauth2_token_getter(self, token_getter):

xero_python/accounting/models/time_zone.py

@@ -24,6 +24,7 @@
 MS_DATETIME_RE = re.compile(r"/Date\((?P<timestamp>-?\d+)(?P<tzinfo>[+-]\d{2,4})?\)/$")
 DATE_WITH_NO_DAY_RE = re.compile("(\d\d\d\d)-(\d\d)")
 
+
 def deserialize_routing(data_type, data, model_finder):
     """Custom logic to find matching deserialize implementation and
        returns it's unique registration string key
@@ -210,16 +211,17 @@ def deserialize_datetime(data_type, data, model_finder):
     :return: deserialized datetime.datetime
 
     """
-    try:
-        dt = isoparse(data)
-    except (ValueError, TypeError):
-        raise ValueError("Invalid datetime value {!r}".format(data))
+    if data is not None:
+        try:
+            dt = isoparse(data)
+        except (ValueError, TypeError):
+            raise ValueError("Invalid datetime value {!r}".format(data))
 
-    if not dt.tzinfo:
-        # timezone naive datetime from Xero API response always in UTC
-        dt = dt.replace(tzinfo=tz.UTC)
+        if not dt.tzinfo:
+            # timezone naive datetime from Xero API response always in UTC
+            dt = dt.replace(tzinfo=tz.UTC)
 
-    return dt
+        return dt
 
 
 @deserialize.register("datetime[ms-format]")
@@ -251,7 +253,7 @@ def deserialize_datetime_ms(data_type, data, model_finder):
         timestamp_s = timestamp_ms / 1000
         return datetime.datetime.fromtimestamp(timestamp_s, tz=tz_info)
     elif DATE_WITH_NO_DAY_RE.match(str(data)):
-        return datetime.datetime.strptime(data + '-01', '%Y-%m-%d')
+        return datetime.datetime.strptime(data + "-01", "%Y-%m-%d")
     else:
         raise ValueError("Invalid datetime value {!r}".format(data))
 

xero_python/api_client/__init__.py

@@ -81,7 +81,7 @@ def revoke_token(self, refresh_token):
             )
         return status
 
-    def get_client_credentials_token(self):
+    def get_client_credentials_token(self, app_store_billing):
         """
         Call Xero Identity API to obtain an access token via OAuth2 Client Credentails grant type
         :return: dictionary with new auth2 token
@@ -91,6 +91,8 @@ def get_client_credentials_token(self):
             "client_secret": self.client_secret,
             "grant_type": "client_credentials",
         }
+        if app_store_billing:
+            post_data["scope"] = "marketplace.billing"
         response, status, headers = self.api_client.call_api(
             self.client_credentials_token_url,
             "POST",
@@ -231,14 +233,14 @@ def refresh_access_token(self, api_client):
         api_client.set_oauth2_token(new_token)
         return True
 
-    def get_client_credentials_access_token(self, api_client):
+    def get_client_credentials_access_token(self, api_client, app_store_billing):
         """
         Perform OAuth2 Client Credentials grant token request.
         :param api_client:  ApiClient instance used to perform refresh token API call.
         :return: bool - True if success
         """
         token_api = TokenApi(api_client, self.client_id, self.client_secret)
-        new_token = token_api.get_client_credentials_token()
+        new_token = token_api.get_client_credentials_token(app_store_billing)
         self.update_token(**new_token)
         api_client.set_oauth2_token(new_token)
         return True

xero_python/api_client/deserializer.py

@@ -0,0 +1,25 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    Xero AppStore API
+
+    These endpoints are for Xero Partners to interact with the App Store Billing platform  # noqa: E501
+
+    Contact: api@xero.com
+    Generated by: https://openapi-generator.tech
+"""
+
+
+# import apis into sdk package
+from xero_python.appstore.api.app_store_api import AppStoreApi
+
+
+# import models into sdk package
+from xero_python.appstore.models.plan import Plan
+from xero_python.appstore.models.price import Price
+from xero_python.appstore.models.problem_details import ProblemDetails
+from xero_python.appstore.models.product import Product
+from xero_python.appstore.models.subscription import Subscription
+from xero_python.appstore.models.subscription_item import SubscriptionItem

xero_python/api_client/oauth2.py

@@ -0,0 +1,4 @@
+# flake8: noqa
+
+# import apis into api package
+from xero_python.appstore.api.app_store_api import AppStoreApi

xero_python/appstore/__init__.py

@@ -0,0 +1,123 @@
+# coding: utf-8
+
+"""
+    Xero AppStore API
+
+    These endpoints are for Xero Partners to interact with the App Store Billing platform  # noqa: E501
+
+    Contact: api@xero.com
+    Generated by: https://openapi-generator.tech
+"""
+
+"""
+    OpenAPI spec version: 2.16.1
+"""
+
+import importlib
+import re  # noqa: F401
+
+from xero_python import exceptions
+from xero_python.api_client import ApiClient, ModelFinder
+
+try:
+    from .exception_handler import translate_status_exception
+except ImportError:
+    translate_status_exception = exceptions.translate_status_exception
+
+
+class empty:
+    """empty object to mark optional parameter not set"""
+
+
+class AppStoreApi(object):
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    base_url = "https://api.xero.com/appstore/2.0"
+    models_module = importlib.import_module("xero_python.appstore.models")
+
+    def __init__(self, api_client=None, base_url=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+        self.base_url = base_url or self.base_url
+
+    def get_resource_url(self, resource_path):
+        """
+        Combine API base url with resource specific path
+        :param str resource_path: API endpoint specific path
+        :return: str full resource path
+        """
+        return self.base_url + resource_path
+
+    def get_model_finder(self):
+        return ModelFinder(self.models_module)
+
+    def get_subscription(
+        self,
+        subscription_id,
+        _return_http_data_only=True,
+        _preload_content=True,
+        _request_timeout=None,
+    ):
+        """Retrieves a subscription for a given subscriptionId  # noqa: E501
+        OAuth2 scope: marketplace.billing
+        :param str subscription_id: Unique identifier for Subscription object (required)
+        :param bool _return_http_data_only: return received data only
+        :param bool _preload_content: load received data in models
+        :param bool _request_timeout: maximum wait time for response
+        :return: Subscription
+        """
+
+        # verify the required parameter 'subscription_id' is set
+        if subscription_id is None:
+            raise ValueError(
+                "Missing the required parameter `subscription_id` "
+                "when calling `get_subscription`"
+            )
+
+        collection_formats = {}
+        path_params = {
+            "subscriptionId": subscription_id,
+        }
+
+        query_params = []
+
+        header_params = {}
+
+        local_var_files = {}
+        form_params = []
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params["Accept"] = self.api_client.select_header_accept(
+            ["application/json"]
+        )
+
+        # Authentication setting
+        auth_settings = ["OAuth2"]
+        url = self.get_resource_url("/subscriptions/{subscriptionId}")
+
+        try:
+            return self.api_client.call_api(
+                url,
+                "GET",
+                path_params,
+                query_params,
+                header_params,
+                body=body_params,
+                post_params=form_params,
+                files=local_var_files,
+                response_type="Subscription",
+                response_model_finder=self.get_model_finder(),
+                auth_settings=auth_settings,
+                _return_http_data_only=_return_http_data_only,
+                _preload_content=_preload_content,
+                _request_timeout=_request_timeout,
+                collection_formats=collection_formats,
+            )
+        except exceptions.HTTPStatusException as error:
+            raise translate_status_exception(error, self, "get_subscription")