Build from OpenAPI v2.39.0-v2.40.3

Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    xero-ruby (4.0.0)
+    xero-ruby (4.4.0)
       faraday (>= 2.0, < 3.0)
       json (~> 2.1, >= 2.1.0)
-      json-jwt (~> 1.5, >= 1.5.2)
+      json-jwt (~> 1.16, >= 1.16.3)
 
 GEM
   remote: https://rubygems.org/

docs/accounting/Allocation.md

@@ -4,12 +4,14 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**allocation_id** | **String** | Xero generated unique identifier | [optional] 
 **invoice** | [**Invoice**](Invoice.md) |  | 
 **overpayment** | [**Overpayment**](Overpayment.md) |  | [optional] 
 **prepayment** | [**Prepayment**](Prepayment.md) |  | [optional] 
 **credit_note** | [**CreditNote**](CreditNote.md) |  | [optional] 
 **amount** | **BigDecimal** | the amount being applied to the invoice | 
 **date** | **Date** | the date the allocation is applied YYYY-MM-DD. | 
+**is_deleted** | **Boolean** | A flag that returns true when the allocation is succesfully deleted | [optional] 
 **status_attribute_string** | **String** | A string to indicate if a invoice status | [optional] 
 **validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional] 
 
@@ -18,12 +20,14 @@ Name | Type | Description | Notes
 ```ruby
 require 'XeroRuby::Accounting'
 
-instance = XeroRuby::Accounting::Allocation.new(invoice: null,
+instance = XeroRuby::Accounting::Allocation.new(allocation_id: null,
+                                 invoice: null,
                                  overpayment: null,
                                  prepayment: null,
                                  credit_note: null,
                                  amount: null,
                                  date: null,
+                                 is_deleted: null,
                                  status_attribute_string: null,
                                  validation_errors: null)
 ```

docs/accounting/Contact.md

@@ -14,7 +14,6 @@ Name | Type | Description | Notes
 **last_name** | **String** | Last name of contact person (max length = 255) | [optional] 
 **company_number** | **String** | Company registration number (max length = 50) | [optional] 
 **email_address** | **String** | Email address of contact person (umlauts not supported) (max length  = 255) | [optional] 
-**skype_user_name** | **String** | Skype user name of contact | [optional] 
 **contact_persons** | [**Array<ContactPerson>**](ContactPerson.md) | See contact persons | [optional] 
 **bank_account_details** | **String** | Bank account number of contact | [optional] 
 **tax_number** | **String** | Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50) | [optional] 
@@ -63,7 +62,6 @@ instance = XeroRuby::Accounting::Contact.new(contact_id: null,
                                  last_name: null,
                                  company_number: null,
                                  email_address: null,
-                                 skype_user_name: null,
                                  contact_persons: null,
                                  bank_account_details: null,
                                  tax_number: null,

docs/accounting/TenNinetyNineContact.md

@@ -26,6 +26,9 @@ Name | Type | Description | Notes
 **street_address** | **String** | Contact address on 1099 Form | [optional] 
 **tax_id** | **String** | Contact tax id on 1099 Form | [optional] 
 **contact_id** | **String** | Contact contact id | [optional] 
+**legal_name** | **String** | Contact legal name | [optional] 
+**business_name** | **String** | Contact business name | [optional] 
+**federal_tax_classification** | **String** | Contact federal tax classification | [optional] 
 
 ## Code Sample
 
@@ -53,7 +56,10 @@ instance = XeroRuby::Accounting::TenNinetyNineContact.new(box1: null,
                                  email: null,
                                  street_address: null,
                                  tax_id: null,
-                                 contact_id: null)
+                                 contact_id: null,
+                                 legal_name: null,
+                                 business_name: null,
+                                 federal_tax_classification: null)
 ```
 
 

docs/app_store/AppStoreApi.md

@@ -137,7 +137,7 @@ Name | Type | Description  | Notes
 
 ## post_usage_records
 
-> UsageRecord post_usage_records(subscription_id, subscription_item_id, create_usage_record)
+> UsageRecord post_usage_records(subscription_id, subscription_item_id, create_usage_record, opts)
 
 Send metered usage belonging to this subscription and subscription item
 
@@ -169,9 +169,13 @@ api_instance = xero_client.<api_set>
 subscription_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Subscription object
 subscription_item_id = '00000000-0000-0000-0000-000000000000' # String | The unique identifier of the subscriptionItem
 create_usage_record = { "timestamp": "2022-01-21T13:01:00", "quantity": 10 } # CreateUsageRecord | Contains the quantity for the usage record to create
+opts = {
+  idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+}
+
 begin
   #Send metered usage belonging to this subscription and subscription item
-  result = api_instance.post_usage_records(subscription_id, subscription_item_id, create_usage_record)
+  result = api_instance.post_usage_records(subscription_id, subscription_item_id, create_usage_record, opts)
   p result
 rescue XeroRuby::AppStore::ApiError => e
   puts "Exception when calling AppStoreApi->post_usage_records: #{e}"
@@ -186,6 +190,7 @@ Name | Type | Description  | Notes
  **subscription_id** | [**String**](.md)| Unique identifier for Subscription object | 
  **subscription_item_id** | [**String**](.md)| The unique identifier of the subscriptionItem | 
  **create_usage_record** | [**CreateUsageRecord**](CreateUsageRecord.md)| Contains the quantity for the usage record to create | 
+ **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] 
 
 ### Return type
 
@@ -203,7 +208,7 @@ Name | Type | Description  | Notes
 
 ## put_usage_records
 
-> UsageRecord put_usage_records(subscription_id, subscription_item_id, usage_record_id, update_usage_record)
+> UsageRecord put_usage_records(subscription_id, subscription_item_id, usage_record_id, update_usage_record, opts)
 
 Update and existing metered usage belonging to this subscription and subscription item
 
@@ -236,9 +241,13 @@ subscription_id = '00000000-0000-0000-0000-000000000000' # String | Unique ident
 subscription_item_id = '00000000-0000-0000-0000-000000000000' # String | The unique identifier of the subscriptionItem
 usage_record_id = '00000000-0000-0000-0000-000000000000' # String | The unique identifier of the usage record
 update_usage_record = { "quantity": 10 } # UpdateUsageRecord | Contains the quantity for the usage record to update
+opts = {
+  idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+}
+
 begin
   #Update and existing metered usage belonging to this subscription and subscription item
-  result = api_instance.put_usage_records(subscription_id, subscription_item_id, usage_record_id, update_usage_record)
+  result = api_instance.put_usage_records(subscription_id, subscription_item_id, usage_record_id, update_usage_record, opts)
   p result
 rescue XeroRuby::AppStore::ApiError => e
   puts "Exception when calling AppStoreApi->put_usage_records: #{e}"
@@ -254,6 +263,7 @@ Name | Type | Description  | Notes
  **subscription_item_id** | [**String**](.md)| The unique identifier of the subscriptionItem | 
  **usage_record_id** | [**String**](.md)| The unique identifier of the usage record | 
  **update_usage_record** | [**UpdateUsageRecord**](UpdateUsageRecord.md)| Contains the quantity for the usage record to update | 
+ **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] 
 
 ### Return type
 

docs/app_store/index.html

@@ -1241,7 +1241,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="AppStore"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="AppStore"><strong>VSN: </strong>4.3.0</li>
+              <li class="nav-header" data-group="AppStore"><strong>VSN: </strong>4.4.0</li>
               <li class="nav-header" data-group="AppStore"><a href="#api-AppStore">Methods</a></li>
               <li data-group="AppStore" data-name="getSubscription" class="">
                 <a href="#api-AppStore-getSubscription">getSubscription</a>
@@ -1464,9 +1464,10 @@ <h3>Usage and SDK Samples</h3>
 
 subscription_id = '00000000-0000-0000-0000-000000000000'
 subscription_item_id = '00000000-0000-0000-0000-000000000000'
+idempotency_key = 'KEY_VALUE'
 
 begin
-  response = xero_client.accounting_api.post_usage_records(subscription_id, subscription_item_id, createUsageRecord)
+  response = xero_client.accounting_api.post_usage_records(subscription_id, subscription_item_id, createUsageRecord, idempotency_key)
   return response
 rescue XeroRuby::ApiError => e
   puts "Exception when calling post_usage_records: #{e}"
@@ -1540,6 +1541,33 @@ <h2>Parameters</h2>
         </div>
     </div>
 </td>
+</tr>
+
+                  </table>
+                  <div class="methodsubtabletitle">Header parameters</div>
+                  <table id="methodsubtable">
+                    <tr>
+                      <th width="150px">Name</th>
+                      <th>Description</th>
+                    </tr>
+                    <tr><td style="width:150px;">Idempotency-Key</td>
+<td>
+
+
+    <div id="d2e199_postUsageRecords_idempotencyKey">
+        <div class="json-schema-view">
+            <div class="primitive">
+                <span class="type">
+                    String
+                </span>
+
+                    <div class="inner description marked">
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+                    </div>
+            </div>
+        </div>
+    </div>
+</td>
 </tr>
 
                   </table>
@@ -1611,9 +1639,10 @@ <h3>Usage and SDK Samples</h3>
 subscription_id = '00000000-0000-0000-0000-000000000000'
 subscription_item_id = '00000000-0000-0000-0000-000000000000'
 usage_record_id = '00000000-0000-0000-0000-000000000000'
+idempotency_key = 'KEY_VALUE'
 
 begin
-  response = xero_client.accounting_api.put_usage_records(subscription_id, subscription_item_id, usage_record_id, updateUsageRecord)
+  response = xero_client.accounting_api.put_usage_records(subscription_id, subscription_item_id, usage_record_id, updateUsageRecord, idempotency_key)
   return response
 rescue XeroRuby::ApiError => e
   puts "Exception when calling put_usage_records: #{e}"
@@ -1713,6 +1742,33 @@ <h2>Parameters</h2>
         </div>
     </div>
 </td>
+</tr>
+
+                  </table>
+                  <div class="methodsubtabletitle">Header parameters</div>
+                  <table id="methodsubtable">
+                    <tr>
+                      <th width="150px">Name</th>
+                      <th>Description</th>
+                    </tr>
+                    <tr><td style="width:150px;">Idempotency-Key</td>
+<td>
+
+
+    <div id="d2e199_putUsageRecords_idempotencyKey">
+        <div class="json-schema-view">
+            <div class="primitive">
+                <span class="type">
+                    String
+                </span>
+
+                    <div class="inner description marked">
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+                    </div>
+            </div>
+        </div>
+    </div>
+</td>
 </tr>
 
                   </table>

docs/assets/AssetApi.md

@@ -15,7 +15,7 @@ Method | HTTP request | Description
 
 ## create_asset
 
-> Asset create_asset(xero_tenant_id, asset)
+> Asset create_asset(xero_tenant_id, asset, opts)
 
 adds a fixed asset
 
@@ -48,9 +48,13 @@ api_instance = xero_client.<api_set>
 
 xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
 asset = { "assetName":"Computer74863", "assetNumber":"123477544", "purchaseDate":"2020-01-01", "purchasePrice":100.0, "disposalPrice":23.23, "assetStatus":"Draft", "bookDepreciationSetting":{ "depreciationMethod":"StraightLine", "averagingMethod":"ActualDays", "depreciationRate":0.5, "depreciationCalculationMethod":"None" }, "bookDepreciationDetail":{ "currentCapitalGain":5.32, "currentGainLoss":3.88, "depreciationStartDate":"2020-01-02", "costLimit":100.0, "currentAccumDepreciationAmount":2.25 }, "AccountingBookValue":99.5 } # Asset | Fixed asset you are creating
+opts = {
+  idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+}
+
 begin
   #adds a fixed asset
-  result = api_instance.create_asset(xero_tenant_id, asset)
+  result = api_instance.create_asset(xero_tenant_id, asset, opts)
   p result
 rescue XeroRuby::Assets::ApiError => e
   puts "Exception when calling AssetApi->create_asset: #{e}"
@@ -64,6 +68,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **xero_tenant_id** | **String**| Xero identifier for Tenant | 
  **asset** | [**Asset**](Asset.md)| Fixed asset you are creating | 
+ **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] 
 
 ### Return type
 
@@ -114,6 +119,8 @@ api_instance = xero_client.<api_set>
 
 xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
 opts = {
+  idempotency_key: 'KEY_VALUE', # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+
   asset_type: { "assetTypeName":"Machinery11004", "fixedAssetAccountId":"3d8d063a-c148-4bb8-8b3c-a5e2ad3b1e82", "depreciationExpenseAccountId":"d1602f69-f900-4616-8d34-90af393fa368", "accumulatedDepreciationAccountId":"9195cadd-8645-41e6-9f67-7bcd421defe8", "bookDepreciationSetting":{ "depreciationMethod":"DiminishingValue100", "averagingMethod":"ActualDays", "depreciationRate":0.05, "depreciationCalculationMethod":"None" } } # AssetType | Asset type to add
 }
 
@@ -132,6 +139,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **xero_tenant_id** | **String**| Xero identifier for Tenant | 
+ **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] 
  **asset_type** | [**AssetType**](AssetType.md)| Asset type to add | [optional] 
 
 ### Return type

docs/assets/index.html

@@ -1392,7 +1392,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Asset"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Asset"><strong>VSN: </strong>4.3.0</li>
+              <li class="nav-header" data-group="Asset"><strong>VSN: </strong>4.4.0</li>
               <li class="nav-header" data-group="Asset"><a href="#api-Asset">Methods</a></li>
               <li data-group="Asset" data-name="createAsset" class="">
                 <a href="#api-Asset-createAsset">createAsset</a>
@@ -1456,6 +1456,7 @@ <h3>Usage and SDK Samples</h3>
                       <pre class="prettyprint"><code class="language-ruby">xero_client.set_token_set(user.token_set)
 
 xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+idempotency_key = 'KEY_VALUE'
 
 asset = { 
   asset_name: "Other Computer",
@@ -1464,7 +1465,7 @@ <h3>Usage and SDK Samples</h3>
 }  
 
 begin
-  response = xero_client.accounting_api.create_asset(xero_tenant_id, asset)
+  response = xero_client.accounting_api.create_asset(xero_tenant_id, asset, idempotency_key)
   return response
 rescue XeroRuby::ApiError => e
   puts "Exception when calling create_asset: #{e}"
@@ -1509,6 +1510,26 @@ <h2>Parameters</h2>
         </div>
     </div>
 </td>
+</tr>
+
+                    <tr><td style="width:150px;">Idempotency-Key</td>
+<td>
+
+
+    <div id="d2e199_createAsset_idempotencyKey">
+        <div class="json-schema-view">
+            <div class="primitive">
+                <span class="type">
+                    String
+                </span>
+
+                    <div class="inner description marked">
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+                    </div>
+            </div>
+        </div>
+    </div>
+</td>
 </tr>
 
                   </table>
@@ -1578,6 +1599,7 @@ <h3>Usage and SDK Samples</h3>
                       <pre class="prettyprint"><code class="language-ruby">xero_client.set_token_set(user.token_set)
 
 xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+idempotency_key = 'KEY_VALUE'
 
 book_depreciation_setting = { 
   depreciation_method: "DiminishingValue100",
@@ -1595,7 +1617,7 @@ <h3>Usage and SDK Samples</h3>
 }  
 
 begin
-  response = xero_client.accounting_api.create_asset_type(xero_tenant_id, assetType)
+  response = xero_client.accounting_api.create_asset_type(xero_tenant_id, idempotency_key, assetType)
   return response
 rescue XeroRuby::ApiError => e
   puts "Exception when calling create_asset_type: #{e}"
@@ -1640,6 +1662,26 @@ <h2>Parameters</h2>
         </div>
     </div>
 </td>
+</tr>
+
+                    <tr><td style="width:150px;">Idempotency-Key</td>
+<td>
+
+
+    <div id="d2e199_createAssetType_idempotencyKey">
+        <div class="json-schema-view">
+            <div class="primitive">
+                <span class="type">
+                    String
+                </span>
+
+                    <div class="inner description marked">
+This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+                    </div>
+            </div>
+        </div>
+    </div>
+</td>
 </tr>
 
                   </table>