Merge pull request #51 from XeroAPI/sid-development

Build from OAS 2.12.0

Author: SidneyAllen

docs/v1/accounting/index.html

@@ -3662,7 +3662,6 @@
       "type" : "number",
       "description" : "The calculated tax amount based on the TaxType and LineAmount",
       "format" : "double",
-      "readOnly" : true,
       "example" : 0.0,
       "x-is-money" : true
     },
@@ -4373,6 +4372,13 @@
         "$ref" : "#/components/schemas/Allocation"
       }
     },
+    "Payments" : {
+      "type" : "array",
+      "description" : "See Payments",
+      "items" : {
+        "$ref" : "#/components/schemas/Payment"
+      }
+    },
     "AppliedAmount" : {
       "type" : "number",
       "description" : "The amount of applied to an invoice",
@@ -5789,7 +5795,7 @@
             } else if (location.includes('php')){
               sdkLang = 'php'
               sdkName = 'xero-php-oauth2'
-            } else if (location.includes('dotnet')){
+            } else if (location.includes('xero-netstandard') || location.includes('csharp')){
               sdkLang = 'dotnet'
               sdkName = 'Xero-NetStandard'
             } else if (location.includes('java')){
@@ -5813,7 +5819,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>1.5.3</li>
+              <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>1.6.0</li>
               <li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
               <li data-group="Accounting" data-name="createAccount" class="">
                 <a href="#api-Accounting-createAccount">createAccount</a>
@@ -21692,9 +21698,10 @@ <h3>Usage and SDK Samples</h3>
     order = 'Name ASC'
     ids = [&quot;00000000-0000-0000-0000-000000000000&quot;]
     include_archived = 'true'
+    summary_only = 'true'
 
     try:
-        api_response = api_instance.get_contacts(xero_tenant_id, if_modified_since, where, order, ids, page, include_archived)
+        api_response = api_instance.get_contacts(xero_tenant_id, if_modified_since, where, order, ids, page, include_archived, summary_only)
         print(api_response)
     except AccountingBadRequestException as e:
         print("Exception when calling AccountingApi->getContacts: %s\n" % e)</code></pre>
@@ -21870,6 +21877,26 @@ <h2>Parameters</h2>
         </div>
     </div>
 </td>
+</tr>
+
+                    <tr><td style="width:150px;">summaryOnly</td>
+<td>
+
+
+    <div id="d2e199_getContacts_summaryOnly">
+        <div class="json-schema-view">
+            <div class="primitive">
+                <span class="type">
+                    Boolean
+                </span>
+
+                    <div class="inner description marked">
+Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient.
+                    </div>
+            </div>
+        </div>
+    </div>
+</td>
 </tr>
 
                   </table>
@@ -24794,9 +24821,10 @@ <h3>Usage and SDK Samples</h3>
     statuses = [&quot;DRAFT&quot;, &quot;SUBMITTED&quot;]
     include_archived = 'true'
     created_by_my_app = 'false'
+    summary_only = 'true'
 
     try:
-        api_response = api_instance.get_invoices(xero_tenant_id, if_modified_since, where, order, ids, invoice_numbers, contact_ids, statuses, page, include_archived, created_by_my_app, unitdp)
+        api_response = api_instance.get_invoices(xero_tenant_id, if_modified_since, where, order, ids, invoice_numbers, contact_ids, statuses, page, include_archived, created_by_my_app, summary_only, unitdp)
         print(api_response)
     except AccountingBadRequestException as e:
         print("Exception when calling AccountingApi->getInvoices: %s\n" % e)</code></pre>
@@ -25055,6 +25083,26 @@ <h2>Parameters</h2>
         </div>
     </div>
 </td>
+</tr>
+
+                    <tr><td style="width:150px;">summaryOnly</td>
+<td>
+
+
+    <div id="d2e199_getInvoices_summaryOnly">
+        <div class="json-schema-view">
+            <div class="primitive">
+                <span class="type">
+                    Boolean
+                </span>
+
+                    <div class="inner description marked">
+Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient.
+                    </div>
+            </div>
+        </div>
+    </div>
+</td>
 </tr>
 
                     <tr><td style="width:150px;">unitdp</td>

setup.py

@@ -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.5.3",
+    version="1.6.0",
 )

xero_python/__init__.py

@@ -2,4 +2,4 @@
 
 __author__ = """Xero Developer API"""
 __email__ = "[email protected]"
-__version__ = "1.5.3"
+__version__ = "1.6.0"

xero_python/accounting/api/accounting_api.py

@@ -10,7 +10,7 @@
 """
 
 """
-    OpenAPI spec version: 2.10.4
+    OpenAPI spec version: 2.12.0
 """
 
 import importlib
@@ -8290,6 +8290,7 @@ def get_contacts(
         i_ds=empty,
         page=empty,
         include_archived=empty,
+        summary_only=empty,
         _return_http_data_only=True,
         _preload_content=True,
         _request_timeout=None,
@@ -8303,6 +8304,7 @@ def get_contacts(
         :param list[str] i_ds: Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call.
         :param int page: e.g. page=1 - Up to 100 contacts will be returned in a single API call.
         :param bool include_archived: e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response
+        :param bool summary_only: Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient.
         :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
@@ -8338,6 +8340,9 @@ def get_contacts(
         if include_archived is not empty:
             query_params.append(("includeArchived", include_archived))
 
+        if summary_only is not empty:
+            query_params.append(("summaryOnly", summary_only))
+
         header_params = {
             "xero-tenant-id": xero_tenant_id,
         }
@@ -10021,6 +10026,7 @@ def get_invoices(
         page=empty,
         include_archived=empty,
         created_by_my_app=empty,
+        summary_only=empty,
         unitdp=empty,
         _return_http_data_only=True,
         _preload_content=True,
@@ -10039,6 +10045,7 @@ def get_invoices(
         :param int page: e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice
         :param bool include_archived: e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response
         :param bool created_by_my_app: When set to true you'll only retrieve Invoices created by your app
+        :param bool summary_only: Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient.
         :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
         :param bool _return_http_data_only: return received data only
         :param bool _preload_content: load received data in models
@@ -10090,6 +10097,9 @@ def get_invoices(
         if created_by_my_app is not empty:
             query_params.append(("createdByMyApp", created_by_my_app))
 
+        if summary_only is not empty:
+            query_params.append(("summaryOnly", summary_only))
+
         if unitdp is not empty:
             query_params.append(("unitdp", unitdp))
 

xero_python/accounting/docs/AccountingApi.md

@@ -6401,7 +6401,7 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **get_contacts**
-> Contacts get_contacts(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, page=page, include_archived=include_archived)
+> Contacts get_contacts(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, page=page, include_archived=include_archived, summary_only=summary_only)
 
 Retrieves all contacts in a Xero organisation
 
@@ -6438,9 +6438,10 @@ order = 'Name ASC' # str | Order by an any element (optional)
 i_ds = ['"00000000-0000-0000-0000-000000000000"'] # list[str] | Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call. (optional)
 page = 1 # int | e.g. page=1 - Up to 100 contacts will be returned in a single API call. (optional)
 include_archived = True # bool | e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response (optional)
+summary_only = False # bool | Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. (optional) (default to False)
 try:
     # Retrieves all contacts in a Xero organisation
-    api_response = api_instance.get_contacts(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, page=page, include_archived=include_archived)
+    api_response = api_instance.get_contacts(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, page=page, include_archived=include_archived, summary_only=summary_only)
     pprint(api_response)
 except ApiException as e:
     print("Exception when calling AccountingApi->get_contacts: %s\n" % e)
@@ -6457,6 +6458,7 @@ Name | Type | Description  | Notes
  **i_ds** | [**list[str]**](str.md)| Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call. | [optional] 
  **page** | **int**| e.g. page=1 - Up to 100 contacts will be returned in a single API call. | [optional] 
  **include_archived** | **bool**| e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response | [optional] 
+ **summary_only** | **bool**| Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. | [optional] [default to False]
 
 ### Return type
 
@@ -7770,7 +7772,7 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **get_invoices**
-> Invoices get_invoices(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, invoice_numbers=invoice_numbers, contact_i_ds=contact_i_ds, statuses=statuses, page=page, include_archived=include_archived, created_by_my_app=created_by_my_app, unitdp=unitdp)
+> Invoices get_invoices(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, invoice_numbers=invoice_numbers, contact_i_ds=contact_i_ds, statuses=statuses, page=page, include_archived=include_archived, created_by_my_app=created_by_my_app, summary_only=summary_only, unitdp=unitdp)
 
 Retrieves sales invoices or purchase bills
 
@@ -7811,10 +7813,11 @@ statuses = ['"DRAFT", "SUBMITTED"'] # list[str] | Filter by
 page = 1 # int | e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice (optional)
 include_archived = True # bool | e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response (optional)
 created_by_my_app = false # bool | When set to true you'll only retrieve Invoices created by your app (optional)
+summary_only = False # bool | Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. (optional) (default to False)
 unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional)
 try:
     # Retrieves sales invoices or purchase bills
-    api_response = api_instance.get_invoices(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, invoice_numbers=invoice_numbers, contact_i_ds=contact_i_ds, statuses=statuses, page=page, include_archived=include_archived, created_by_my_app=created_by_my_app, unitdp=unitdp)
+    api_response = api_instance.get_invoices(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, invoice_numbers=invoice_numbers, contact_i_ds=contact_i_ds, statuses=statuses, page=page, include_archived=include_archived, created_by_my_app=created_by_my_app, summary_only=summary_only, unitdp=unitdp)
     pprint(api_response)
 except ApiException as e:
     print("Exception when calling AccountingApi->get_invoices: %s\n" % e)
@@ -7835,6 +7838,7 @@ Name | Type | Description  | Notes
  **page** | **int**| e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice | [optional] 
  **include_archived** | **bool**| e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response | [optional] 
  **created_by_my_app** | **bool**| When set to true you'll only retrieve Invoices created by your app | [optional] 
+ **summary_only** | **bool**| Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. | [optional] [default to False]
  **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] 
 
 ### Return type

xero_python/accounting/docs/Prepayment.md

@@ -19,6 +19,7 @@ Name | Type | Description | Notes
 **currency_rate** | **float** | The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used | [optional] 
 **remaining_credit** | **float** | The remaining credit balance on the prepayment | [optional] 
 **allocations** | [**list[Allocation]**](Allocation.md) | See Allocations | [optional] 
+**payments** | [**list[Payment]**](Payment.md) | See Payments | [optional] 
 **applied_amount** | **float** | The amount of applied to an invoice | [optional] 
 **has_attachments** | **bool** | boolean to indicate if a prepayment has an attachment | [optional] [default to False]
 **attachments** | [**list[Attachment]**](Attachment.md) | See Attachments | [optional] 

xero_python/accounting/models/prepayment.py

@@ -46,6 +46,7 @@ class Prepayment(BaseModel):
         "currency_rate": "float",
         "remaining_credit": "float",
         "allocations": "list[Allocation]",
+        "payments": "list[Payment]",
         "applied_amount": "float",
         "has_attachments": "bool",
         "attachments": "list[Attachment]",
@@ -68,6 +69,7 @@ class Prepayment(BaseModel):
         "currency_rate": "CurrencyRate",
         "remaining_credit": "RemainingCredit",
         "allocations": "Allocations",
+        "payments": "Payments",
         "applied_amount": "AppliedAmount",
         "has_attachments": "HasAttachments",
         "attachments": "Attachments",
@@ -91,6 +93,7 @@ def __init__(
         currency_rate=None,
         remaining_credit=None,
         allocations=None,
+        payments=None,
         applied_amount=None,
         has_attachments=False,
         attachments=None,
@@ -113,6 +116,7 @@ def __init__(
         self._currency_rate = None
         self._remaining_credit = None
         self._allocations = None
+        self._payments = None
         self._applied_amount = None
         self._has_attachments = None
         self._attachments = None
@@ -150,6 +154,8 @@ def __init__(
             self.remaining_credit = remaining_credit
         if allocations is not None:
             self.allocations = allocations
+        if payments is not None:
+            self.payments = payments
         if applied_amount is not None:
             self.applied_amount = applied_amount
         if has_attachments is not None:
@@ -543,6 +549,29 @@ def allocations(self, allocations):
 
         self._allocations = allocations
 
+    @property
+    def payments(self):
+        """Gets the payments of this Prepayment.  # noqa: E501
+
+        See Payments  # noqa: E501
+
+        :return: The payments of this Prepayment.  # noqa: E501
+        :rtype: list[Payment]
+        """
+        return self._payments
+
+    @payments.setter
+    def payments(self, payments):
+        """Sets the payments of this Prepayment.
+
+        See Payments  # noqa: E501
+
+        :param payments: The payments of this Prepayment.  # noqa: E501
+        :type: list[Payment]
+        """
+
+        self._payments = payments
+
     @property
     def applied_amount(self):
         """Gets the applied_amount of this Prepayment.  # noqa: E501

xero_python/assets/api/asset_api.py

@@ -10,7 +10,7 @@
 """
 
 """
-    OpenAPI spec version: 2.10.4
+    OpenAPI spec version: 2.12.0
 """
 
 import importlib

xero_python/assets/docs/AssetApi.md

@@ -176,7 +176,7 @@ api_client = ApiClient(
 api_instance = AssetApi(api_client)
 
 xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant
-id = '4f7bcdcb-5ec1-4258-9558-19f662fccdfe' # str | fixed asset id for single object
+id = '00000000-0000-0000-0000-000000000000' # str | fixed asset id for single object
 try:
     # Retrieves fixed asset by id
     api_response = api_instance.get_asset_by_id(xero_tenant_id, id)

xero_python/docs/README.md

@@ -3,8 +3,8 @@ These endpoints are related to managing authentication tokens and identity for X
 
 The `xero_python` package is automatically generated by the [XeroAPI SDK 2.0 Codegen](https://github.com/xero-github/xeroapi-sdk-codegen) project:
 
-- API version: 2.10.4
-- Package version: 1.5.3
+- API version: 2.12.0
+- Package version: 1.6.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://developer.xero.com](https://developer.xero.com)