Merge pull request #249 from XeroAPI/xero-ruby-4.1.0

generates xero-ruby 4.1.0 from OAS 2.36.0
XeroAPI · Feb 17, 2023 · 64dab42 · 64dab42
2 parents a26ec2e + 3d6f20d
commit 64dab42
Show file tree

Hide file tree

Showing 23 changed files with 739 additions and 26 deletions.
diff --git a/docs/accounting/index.html b/docs/accounting/index.html
@@ -6074,7 +6074,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>4.0.0</li>
+              <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>4.1.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>

diff --git a/docs/app_store/index.html b/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.0.0</li>
+              <li class="nav-header" data-group="AppStore"><strong>VSN: </strong>4.1.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>

diff --git a/docs/assets/index.html b/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.0.0</li>
+              <li class="nav-header" data-group="Asset"><strong>VSN: </strong>4.1.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>

diff --git a/docs/files/FilesApi.md b/docs/files/FilesApi.md
@@ -10,6 +10,7 @@ Method | HTTP request | Description
 [**delete_file_association**](FilesApi.md#delete_file_association) | **DELETE** /Files/{FileId}/Associations/{ObjectId} | Deletes an existing file association
 [**delete_folder**](FilesApi.md#delete_folder) | **DELETE** /Folders/{FolderId} | Deletes a folder
 [**get_associations_by_object**](FilesApi.md#get_associations_by_object) | **GET** /Associations/{ObjectId} | Retrieves an association object using a unique object ID
+[**get_associations_count**](FilesApi.md#get_associations_count) | **GET** /Associations/Count | Retrieves a count of associations for a list of objects.
 [**get_file**](FilesApi.md#get_file) | **GET** /Files/{FileId} | Retrieves a file by a unique file ID
 [**get_file_associations**](FilesApi.md#get_file_associations) | **GET** /Files/{FileId}/Associations | Retrieves a specific file associations
 [**get_file_content**](FilesApi.md#get_file_content) | **GET** /Files/{FileId}/Content | Retrieves the content of a specific file
@@ -367,7 +368,7 @@ nil (empty response body)
 
 Retrieves an association object using a unique object ID
 
-By passing in the appropriate options,
+By passing in the appropriate options, you can retrieve an association
 
 ### Example
 
@@ -427,6 +428,72 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## get_associations_count
+
+> Object get_associations_count(xero_tenant_id, object_ids)
+
+Retrieves a count of associations for a list of objects.
+
+By passing in the appropriate options, you can retrieve the association count for objects
+
+### Example
+
+```ruby
+# load the gem
+require 'xero-ruby'
+
+creds = {
+  client_id: ENV['CLIENT_ID'],
+  client_secret: ENV['CLIENT_SECRET'],
+  redirect_uri: ENV['REDIRECT_URI'],
+  scopes: ENV['SCOPES']
+}
+xero_client = XeroRuby::ApiClient.new(credentials: creds)
+
+token_set = fetch_valid_token_set(user) # example
+
+xero_client.refresh_token_set(token_set)
+
+# You need to namespace your api method call to one of the following api sets
+# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api, :app_store_api]
+
+api_instance = xero_client.<api_set>
+
+
+
+xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
+object_ids = ['object_ids_example'] # Array<String> | A comma-separated list of object ids
+begin
+  #Retrieves a count of associations for a list of objects.
+  result = api_instance.get_associations_count(xero_tenant_id, object_ids)
+  p result
+rescue XeroRuby::Files::ApiError => e
+  puts "Exception when calling FilesApi->get_associations_count: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **xero_tenant_id** | **String**| Xero identifier for Tenant | 
+ **object_ids** | [**Array&lt;String&gt;**](String.md)| A comma-separated list of object ids | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_file
 
 > FileObject get_file(xero_tenant_id, file_id)

diff --git a/docs/files/index.html b/docs/files/index.html
@@ -1155,7 +1155,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Files"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Files"><strong>VSN: </strong>4.0.0</li>
+              <li class="nav-header" data-group="Files"><strong>VSN: </strong>4.1.0</li>
               <li class="nav-header" data-group="Files"><a href="#api-Files">Methods</a></li>
               <li data-group="Files" data-name="createFileAssociation" class="">
                 <a href="#api-Files-createFileAssociation">createFileAssociation</a>
@@ -1175,6 +1175,9 @@
               <li data-group="Files" data-name="getAssociationsByObject" class="">
                 <a href="#api-Files-getAssociationsByObject">getAssociationsByObject</a>
               </li>
+              <li data-group="Files" data-name="getAssociationsCount" class="">
+                <a href="#api-Files-getAssociationsCount">getAssociationsCount</a>
+              </li>
               <li data-group="Files" data-name="getFile" class="">
                 <a href="#api-Files-getFile">getFile</a>
               </li>
@@ -1857,7 +1860,7 @@ <h1>getAssociationsByObject</h1>
                   <div class="pull-right"></div>
                   <div class="clearfix"></div>
                   <p></p>
-                  <p class="marked">By passing in the appropriate options,</p>
+                  <p class="marked">By passing in the appropriate options, you can retrieve an association</p>
                   <p></p>
                   <br />
                   <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/Associations/{ObjectId}</span></code></pre>
@@ -1960,6 +1963,124 @@ <h2>Parameters</h2>
         </div>
     </div>
 </td>
+</tr>
+
+                  </table>
+                </article>
+              </div>
+              <hr>
+              <div id="api-Files-getAssociationsCount">
+                <article id="api-Files-getAssociationsCount-0" data-group="User" data-name="getAssociationsCount" data-version="0">
+                  <div class="pull-left">
+                    <h1>getAssociationsCount</h1>
+                    <p>Retrieves a count of associations for a list of objects.</p>
+                  </div>
+                  <div class="pull-right"></div>
+                  <div class="clearfix"></div>
+                  <p></p>
+                  <p class="marked">By passing in the appropriate options, you can retrieve the association count for objects</p>
+                  <p></p>
+                  <br />
+                  <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/Associations/Count</span></code></pre>
+                  <p>
+                  <h3>Usage and SDK Samples</h3>
+                  </p>
+                  <ul class="nav nav-tabs nav-tabs-examples">
+                    <!-- *****REPLACE***** comment out the other languages <li> -->
+                    <li class=""><a href="#examples-Files-getAssociationsCount-0-ruby">Ruby</a></li>
+                  </ul>
+                  <div class="tab-content">
+                    <!-- *****REPLACE***** comment out the other languages tab-pane -->
+                    <div class="tab-pane" id="examples-Files-getAssociationsCount-0-ruby">
+                      <pre class="prettyprint"><code class="language-ruby">xero_client.set_token_set(user.token_set)
+
+xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+objectIds = []
+
+begin
+  response = xero_client.accounting_api.get_associations_count(xero_tenant_id, objectIds)
+  return response
+rescue XeroRuby::ApiError => e
+  puts "Exception when calling get_associations_count: #{e}"
+end
+</code></pre>
+                    </div>
+                  </div>
+                  <h2>Scopes</h2>
+                  <table>
+
+                    <tr>
+                      <td>files</td>
+                      <td>Grant read-write access to files and folders</td>
+                    </tr>
+
+                    <tr>
+                      <td>files.read</td>
+                      <td>Grant read-only access to files and folders</td>
+                    </tr>
+
+                  </table>
+                  <h2>Parameters</h2>
+                  <div class="methodsubtabletitle">Header parameters</div>
+                  <table id="methodsubtable">
+                    <tr>
+                      <th width="150px">Name</th>
+                      <th>Description</th>
+                    </tr>
+                    <tr><td style="width:150px;">xero-tenant-id<span style="color:red;">*</span></td>
+<td>
+
+
+    <div id="d2e199_getAssociationsCount_xeroTenantId">
+        <div class="json-schema-view">
+            <div class="primitive">
+                <span class="type">
+                    String
+                </span>
+
+                    <div class="inner description marked">
+Xero identifier for Tenant
+                    </div>
+            </div>
+                <div class="inner required">
+                    Required
+                </div>
+        </div>
+    </div>
+</td>
+</tr>
+
+                  </table>
+                  <div class="methodsubtabletitle">Query parameters</div>
+                  <table id="methodsubtable">
+                    <tr>
+                      <th width="150px">Name</th>
+                      <th>Description</th>
+                    </tr>
+                    <tr><td style="width:150px;">ObjectIds<span style="color:red;">*</span></td>
+<td>
+
+
+    <div id="d2e199_getAssociationsCount_objectIds">
+        <div class="json-schema-view">
+            <div class="primitive">
+                <span class="type">
+                    array[UUID]
+                </span>
+                    <span class="format">
+                        (uuid)
+                    </span>
+
+                    <div class="inner description marked">
+A comma-separated list of object ids
+                    </div>
+            </div>
+                <div class="inner required">
+                    Required
+                </div>
+        </div>
+    </div>
+</td>
 </tr>
 
                   </table>

diff --git a/docs/finance/index.html b/docs/finance/index.html
@@ -2734,7 +2734,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Finance"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Finance"><strong>VSN: </strong>4.0.0</li>
+              <li class="nav-header" data-group="Finance"><strong>VSN: </strong>4.1.0</li>
               <li class="nav-header" data-group="Finance"><a href="#api-Finance">Methods</a></li>
               <li data-group="Finance" data-name="getAccountingActivityAccountUsage" class="">
                 <a href="#api-Finance-getAccountingActivityAccountUsage">getAccountingActivityAccountUsage</a>

diff --git a/docs/payroll_au/LeaveApplication.md b/docs/payroll_au/LeaveApplication.md
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **start_date** | **Date** | Start date of the leave (YYYY-MM-DD) | [optional] 
 **end_date** | **Date** | End date of the leave (YYYY-MM-DD) | [optional] 
 **description** | **String** | The Description of the Leave | [optional] 
+**pay_out_type** | [**PayOutType**](PayOutType.md) |  | [optional] 
 **leave_periods** | [**Array&lt;LeavePeriod&gt;**](LeavePeriod.md) |  | [optional] 
 **updated_date_utc** | **DateTime** | Last modified timestamp | [optional] 
 **validation_errors** | [**Array&lt;ValidationError&gt;**](ValidationError.md) | Displays array of validation error messages from the API | [optional] 
@@ -27,6 +28,7 @@ instance = XeroRuby::PayrollAu::LeaveApplication.new(leave_application_id: e0eb6
                                  start_date: /Date(322560000000+0000)/,
                                  end_date: /Date(322560000000+0000)/,
                                  description: My leave,
+                                 pay_out_type: null,
                                  leave_periods: null,
                                  updated_date_utc: /Date(1583967733054+0000)/,
                                  validation_errors: null)

diff --git a/docs/payroll_au/LeaveEarningsLine.md b/docs/payroll_au/LeaveEarningsLine.md
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **earnings_rate_id** | **String** | Xero identifier | [optional] 
 **rate_per_unit** | **BigDecimal** | Rate per unit of the EarningsLine. | [optional] 
 **number_of_units** | **BigDecimal** | Earnings rate number of units. | [optional] 
+**pay_out_type** | [**PayOutType**](PayOutType.md) |  | [optional] 
 
 ## Code Sample
 
@@ -15,7 +16,8 @@ require 'XeroRuby::PayrollAu'
 
 instance = XeroRuby::PayrollAu::LeaveEarningsLine.new(earnings_rate_id: e0eb6747-7c17-4075-b804-989f8d4e5d39,
                                  rate_per_unit: 38.0,
-                                 number_of_units: 2.5)
+                                 number_of_units: 2.5,
+                                 pay_out_type: null)
 ```
 
 
diff --git a/docs/payroll_au/OpeningBalances.md b/docs/payroll_au/OpeningBalances.md
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **super_lines** | [**Array&lt;SuperLine&gt;**](SuperLine.md) |  | [optional] 
 **reimbursement_lines** | [**Array&lt;ReimbursementLine&gt;**](ReimbursementLine.md) |  | [optional] 
 **leave_lines** | [**Array&lt;LeaveLine&gt;**](LeaveLine.md) |  | [optional] 
+**paid_leave_earnings_lines** | [**Array&lt;PaidLeaveEarningsLine&gt;**](PaidLeaveEarningsLine.md) |  | [optional] 
 
 ## Code Sample
 
@@ -23,7 +24,8 @@ instance = XeroRuby::PayrollAu::OpeningBalances.new(opening_balance_date: /Date(
                                  deduction_lines: null,
                                  super_lines: null,
                                  reimbursement_lines: null,
-                                 leave_lines: null)
+                                 leave_lines: null,
+                                 paid_leave_earnings_lines: null)
 ```
 
 
diff --git a/docs/payroll_au/PaidLeaveEarningsLine.md b/docs/payroll_au/PaidLeaveEarningsLine.md
@@ -0,0 +1,25 @@
+# XeroRuby::PayrollAu::PaidLeaveEarningsLine
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**leave_type_id** | **String** | Xero leave type identifier | 
+**amount** | **BigDecimal** | Paid leave amount | 
+**sgc_applied_leave_loading_amount** | **BigDecimal** | The amount of leave loading applied for the leave type that is subject to Superannuation Guarantee Contributions. *Only applicable for Leave Types with Annual Leave Categories | [optional] 
+**sgc_exempted_leave_loading_amount** | **BigDecimal** | The amount of leave loading applied for the leave type that is exempt from Superannuation Guarantee Contributions. *Only applicable for Leave Types with Annual Leave Categories | [optional] 
+**reset_stp_categorisation** | **Boolean** | Reset the STP categorisations for the leave type. *Only applicable for Leave Types with Annual Leave Categories | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::PaidLeaveEarningsLine.new(leave_type_id: 742998cb-7584-4ecf-aa88-d694f59c50f9,
+                                 amount: 500.0,
+                                 sgc_applied_leave_loading_amount: 50.0,
+                                 sgc_exempted_leave_loading_amount: 60.0,
+                                 reset_stp_categorisation: true)
+```
+
+
diff --git a/docs/payroll_au/PayOutType.md b/docs/payroll_au/PayOutType.md
@@ -0,0 +1,16 @@
+# XeroRuby::PayrollAu::PayOutType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::PayOutType.new()
+```
+
+