Merge pull request #233 from XeroAPI/xero-ruby-3.13.0

generates xero-ruby 3.13.0 from OAS 2.29.0
XeroAPI · Sep 14, 2022 · 7117a0a · 7117a0a
2 parents fa85c69 + 60931fb
commit 7117a0a
Show file tree

Hide file tree

Showing 21 changed files with 303 additions and 33 deletions.
diff --git a/docs/accounting/Account.md b/docs/accounting/Account.md
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **description** | **String** | Description of the Account. Valid for all types of accounts except bank accounts (max length &#x3D; 4000) | [optional] 
 **bank_account_type** | **String** | For bank accounts only. See Bank Account types | [optional] 
 **currency_code** | [**CurrencyCode**](CurrencyCode.md) |  | [optional] 
-**tax_type** | **String** | The tax type from TaxRates | [optional] 
+**tax_type** | **String** | The tax type from taxRates | [optional] 
 **enable_payments_to_account** | **Boolean** | Boolean – describes whether account can have payments applied to it | [optional] 
 **show_in_expense_claims** | **Boolean** | Boolean – describes whether account code is available for use with expense claims | [optional] 
 **_class** | **String** | See Account Class Types | [optional] 

diff --git a/docs/accounting/AccountingApi.md b/docs/accounting/AccountingApi.md
@@ -88,6 +88,7 @@ Method | HTTP request | Description
 [**get_bank_transfer_attachments**](AccountingApi.md#get_bank_transfer_attachments) | **GET** /BankTransfers/{BankTransferID}/Attachments | Retrieves attachments from a specific bank transfer
 [**get_bank_transfer_history**](AccountingApi.md#get_bank_transfer_history) | **GET** /BankTransfers/{BankTransferID}/History | Retrieves history from a specific bank transfer using a unique bank transfer Id
 [**get_bank_transfers**](AccountingApi.md#get_bank_transfers) | **GET** /BankTransfers | Retrieves all bank transfers
+[**get_batch_payment**](AccountingApi.md#get_batch_payment) | **GET** /BatchPayments/{BatchPaymentID} | Retrieves a specific batch payment using a unique batch payment Id
 [**get_batch_payment_history**](AccountingApi.md#get_batch_payment_history) | **GET** /BatchPayments/{BatchPaymentID}/History | Retrieves history from a specific batch payment
 [**get_batch_payments**](AccountingApi.md#get_batch_payments) | **GET** /BatchPayments | Retrieves either one or many batch payments for invoices
 [**get_branding_theme**](AccountingApi.md#get_branding_theme) | **GET** /BrandingThemes/{BrandingThemeID} | Retrieves a specific branding theme using a unique branding theme Id
@@ -5870,6 +5871,70 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## get_batch_payment
+
+> BatchPayments get_batch_payment(xero_tenant_id, batch_payment_id)
+
+Retrieves a specific batch payment using a unique batch payment Id
+
+### 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
+batch_payment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for BatchPayment
+begin
+  #Retrieves a specific batch payment using a unique batch payment Id
+  result = api_instance.get_batch_payment(xero_tenant_id, batch_payment_id)
+  p result
+rescue XeroRuby::Accounting::ApiError => e
+  puts "Exception when calling AccountingApi->get_batch_payment: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **xero_tenant_id** | **String**| Xero identifier for Tenant | 
+ **batch_payment_id** | [**String**](.md)| Unique identifier for BatchPayment | 
+
+### Return type
+
+[**BatchPayments**](BatchPayments.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_batch_payment_history
 
 > HistoryRecords get_batch_payment_history(xero_tenant_id, batch_payment_id)

diff --git a/docs/accounting/JournalLine.md b/docs/accounting/JournalLine.md
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **net_amount** | **BigDecimal** | Net amount of journal line. This will be a positive value for a debit and negative for a credit | [optional] 
 **gross_amount** | **BigDecimal** | Gross amount of journal line (NetAmount + TaxAmount). | [optional] 
 **tax_amount** | **BigDecimal** | Total tax on a journal line | [optional] 
-**tax_type** | **String** | The tax type from TaxRates | [optional] 
+**tax_type** | **String** | The tax type from taxRates | [optional] 
 **tax_name** | **String** | see TaxRates | [optional] 
 **tracking_categories** | [**Array&lt;TrackingCategory&gt;**](TrackingCategory.md) | Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 &lt;TrackingCategory&gt; elements. | [optional] 
 

diff --git a/docs/accounting/index.html b/docs/accounting/index.html
@@ -909,7 +909,7 @@
     },
     "TaxType" : {
       "type" : "string",
-      "description" : "The tax type from TaxRates"
+      "description" : "The tax type from taxRates"
     },
     "EnablePaymentsToAccount" : {
       "type" : "boolean",
@@ -3482,7 +3482,7 @@
     },
     "TaxType" : {
       "type" : "string",
-      "description" : "The tax type from TaxRates"
+      "description" : "The tax type from taxRates"
     },
     "TaxName" : {
       "type" : "string",
@@ -5621,7 +5621,7 @@
     "ReportTaxType" : {
       "type" : "string",
       "description" : "See ReportTaxTypes",
-      "enum" : [ "AVALARA", "BASEXCLUDED", "CAPITALSALESOUTPUT", "CAPITALEXPENSESINPUT", "ECOUTPUT", "ECOUTPUTSERVICES", "ECINPUT", "ECACQUISITIONS", "EXEMPTEXPENSES", "EXEMPTINPUT", "EXEMPTOUTPUT", "GSTONIMPORTS", "INPUT", "INPUTTAXED", "MOSSSALES", "NONE", "NONEOUTPUT", "OUTPUT", "PURCHASESINPUT", "SALESOUTPUT", "EXEMPTCAPITAL", "EXEMPTEXPORT", "CAPITALEXINPUT", "GSTONCAPIMPORTS", "GSTONCAPITALIMPORTS", "REVERSECHARGES", "PAYMENTS", "INVOICE", "CASH", "ACCRUAL", "FLATRATECASH", "FLATRATEACCRUAL", "ACCRUALS", "TXCA", "SRCAS", "DSOUTPUT", "BLINPUT2", "EPINPUT", "IMINPUT2", "MEINPUT", "IGDSINPUT2", "ESN33OUTPUT", "OPINPUT", "OSOUTPUT", "TXN33INPUT", "TXESSINPUT", "TXREINPUT", "TXPETINPUT", "NRINPUT", "ES33OUTPUT", "ZERORATEDINPUT", "ZERORATEDOUTPUT", "DRCHARGESUPPLY", "DRCHARGE", "CAPINPUT", "CAPIMPORTS", "IMINPUT", "INPUT2", "CIUINPUT", "SRINPUT", "OUTPUT2", "SROUTPUT", "CAPOUTPUT", "SROUTPUT2", "CIUOUTPUT", "ZROUTPUT", "ZREXPORT", "ACC28PLUS", "ACCUPTO28", "OTHEROUTPUT", "SHOUTPUT", "ZRINPUT", "BADDEBT", "OTHERINPUT", "BADDEBTRELIEF", "IGDSINPUT3", "SROVR", "TOURISTREFUND", "TXRCN33INPUT", "TXRCREINPUT", "TXRCESSINPUT", "TXRCTSINPUT" ]
+      "enum" : [ "AVALARA", "BASEXCLUDED", "CAPITALSALESOUTPUT", "CAPITALEXPENSESINPUT", "ECOUTPUT", "ECOUTPUTSERVICES", "ECINPUT", "ECACQUISITIONS", "EXEMPTEXPENSES", "EXEMPTINPUT", "EXEMPTOUTPUT", "GSTONIMPORTS", "INPUT", "INPUTTAXED", "MOSSSALES", "NONE", "NONEOUTPUT", "OUTPUT", "PURCHASESINPUT", "SALESOUTPUT", "EXEMPTCAPITAL", "EXEMPTEXPORT", "CAPITALEXINPUT", "GSTONCAPIMPORTS", "GSTONCAPITALIMPORTS", "REVERSECHARGES", "PAYMENTS", "INVOICE", "CASH", "ACCRUAL", "FLATRATECASH", "FLATRATEACCRUAL", "ACCRUALS", "TXCA", "SRCAS", "DSOUTPUT", "BLINPUT2", "EPINPUT", "IMINPUT2", "MEINPUT", "IGDSINPUT2", "ESN33OUTPUT", "OPINPUT", "OSOUTPUT", "TXN33INPUT", "TXESSINPUT", "TXREINPUT", "TXPETINPUT", "NRINPUT", "ES33OUTPUT", "ZERORATEDINPUT", "ZERORATEDOUTPUT", "DRCHARGESUPPLY", "DRCHARGE", "CAPINPUT", "CAPIMPORTS", "IMINPUT", "INPUT2", "CIUINPUT", "SRINPUT", "OUTPUT2", "SROUTPUT", "CAPOUTPUT", "SROUTPUT2", "CIUOUTPUT", "ZROUTPUT", "ZREXPORT", "ACC28PLUS", "ACCUPTO28", "OTHEROUTPUT", "SHOUTPUT", "ZRINPUT", "BADDEBT", "OTHERINPUT", "BADDEBTRELIEF", "IGDSINPUT3", "SROVR", "TOURISTREFUND", "TXRCN33INPUT", "TXRCREINPUT", "TXRCESSINPUT", "TXRCTSINPUT", "CAPEXINPUT", "UNDEFINED", "CAPEXOUTPUT", "ZEROEXPOUTPUT", "GOODSIMPORT", "NONEINPUT", "NOTREPORTED" ]
     },
     "CanApplyToAssets" : {
       "type" : "boolean",
@@ -6069,7 +6069,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>3.12.0</li>
+              <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>3.13.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>
@@ -6323,6 +6323,9 @@
               <li data-group="Accounting" data-name="getBankTransfers" class="">
                 <a href="#api-Accounting-getBankTransfers">getBankTransfers</a>
               </li>
+              <li data-group="Accounting" data-name="getBatchPayment" class="">
+                <a href="#api-Accounting-getBatchPayment">getBatchPayment</a>
+              </li>
               <li data-group="Accounting" data-name="getBatchPaymentHistory" class="">
                 <a href="#api-Accounting-getBatchPaymentHistory">getBatchPaymentHistory</a>
               </li>
@@ -19752,6 +19755,124 @@ <h2>Parameters</h2>
         </div>
     </div>
 </td>
+</tr>
+
+                  </table>
+                </article>
+              </div>
+              <hr>
+              <div id="api-Accounting-getBatchPayment">
+                <article id="api-Accounting-getBatchPayment-0" data-group="User" data-name="getBatchPayment" data-version="0">
+                  <div class="pull-left">
+                    <h1>getBatchPayment</h1>
+                    <p>Retrieves a specific batch payment using a unique batch payment Id</p>
+                  </div>
+                  <div class="pull-right"></div>
+                  <div class="clearfix"></div>
+                  <p></p>
+                  <p class="marked"></p>
+                  <p></p>
+                  <br />
+                  <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/BatchPayments/{BatchPaymentID}</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-Accounting-getBatchPayment-0-ruby">Ruby</a></li>
+                  </ul>
+                  <div class="tab-content">
+                    <!-- *****REPLACE***** comment out the other languages tab-pane -->
+                    <div class="tab-pane" id="examples-Accounting-getBatchPayment-0-ruby">
+                      <pre class="prettyprint"><code class="language-ruby">xero_client.set_token_set(user.token_set)
+
+xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+batch_payment_id = '00000000-0000-0000-0000-000000000000'
+
+begin
+  response = xero_client.accounting_api.get_batch_payment(xero_tenant_id, batch_payment_id)
+  return response
+rescue XeroRuby::ApiError => e
+  puts "Exception when calling get_batch_payment: #{e}"
+end
+</code></pre>
+                    </div>
+                  </div>
+                  <h2>Scopes</h2>
+                  <table>
+
+                    <tr>
+                      <td>accounting.transactions</td>
+                      <td>Grant read-write access to bank transactions, credit notes, invoices, repeating invoices</td>
+                    </tr>
+
+                    <tr>
+                      <td>accounting.transactions.read</td>
+                      <td>Grant read-only access to invoices</td>
+                    </tr>
+
+                  </table>
+                  <h2>Parameters</h2>
+                  <div class="methodsubtabletitle">Path parameters</div>
+                  <table id="methodsubtable">
+                    <tr>
+                      <th width="150px">Name</th>
+                      <th>Description</th>
+                    </tr>
+                    <tr><td style="width:150px;">BatchPaymentID<span style="color:red;">*</span></td>
+<td>
+
+
+    <div id="d2e199_getBatchPayment_batchPaymentID">
+        <div class="json-schema-view">
+            <div class="primitive">
+                <span class="type">
+                    UUID
+                </span>
+                    <span class="format">
+                        (uuid)
+                    </span>
+
+                    <div class="inner description marked">
+Unique identifier for BatchPayment
+                    </div>
+            </div>
+                <div class="inner required">
+                    Required
+                </div>
+        </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;">xero-tenant-id<span style="color:red;">*</span></td>
+<td>
+
+
+    <div id="d2e199_getBatchPayment_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>

diff --git a/docs/app_store/index.html b/docs/app_store/index.html
@@ -1141,7 +1141,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>3.12.0</li>
+              <li class="nav-header" data-group="AppStore"><strong>VSN: </strong>3.13.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>3.12.0</li>
+              <li class="nav-header" data-group="Asset"><strong>VSN: </strong>3.13.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/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>3.12.0</li>
+              <li class="nav-header" data-group="Files"><strong>VSN: </strong>3.13.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>

diff --git a/docs/finance/index.html b/docs/finance/index.html
@@ -2718,7 +2718,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>3.12.0</li>
+              <li class="nav-header" data-group="Finance"><strong>VSN: </strong>3.13.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/index.html b/docs/payroll_au/index.html
@@ -1634,7 +1634,7 @@
   "type" : "string",
   "description" : "Code used to identify the Leave Category",
   "example" : "ANNUALLEAVE",
-  "enum" : [ "ANNUALLEAVE", "LONGSERVICELEAVE", "PERSONALCARERSLEAVE", "ROSTEREDDAYOFF", "TIMEOFFINLIEU", "COMPASSIONATEANDBEREAVEMENTLEAVE", "STUDYLEAVE", "FAMILYANDDOMESTICVIOLENCELEAVE", "SPECIALPAIDLEAVE", "COMMUNITYSERVICELEAVE", "JURYDUTYLEAVE", "DEFENCERESERVELEAVE" ]
+  "enum" : [ "ANNUALLEAVE", "LONGSERVICELEAVE", "PERSONALSICKCARERSLEAVE", "ROSTEREDDAYOFF", "TIMEOFFINLIEU", "COMPASSIONATEANDBEREAVEMENTLEAVE", "STUDYLEAVE", "FAMILYANDDOMESTICVIOLENCELEAVE", "SPECIALPAIDLEAVE", "COMMUNITYSERVICELEAVE", "JURYDUTYLEAVE", "DEFENCERESERVELEAVE" ]
 };
       defs["LeaveEarningsLine"] = {
   "title" : "",
@@ -3274,7 +3274,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="PayrollAu"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>3.12.0</li>
+              <li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>3.13.0</li>
               <li class="nav-header" data-group="PayrollAu"><a href="#api-PayrollAu">Methods</a></li>
               <li data-group="PayrollAu" data-name="createEmployee" class="">
                 <a href="#api-PayrollAu-createEmployee">createEmployee</a>

diff --git a/docs/payroll_nz/index.html b/docs/payroll_nz/index.html
@@ -3838,7 +3838,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="PayrollNz"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>3.12.0</li>
+              <li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>3.13.0</li>
               <li class="nav-header" data-group="PayrollNz"><a href="#api-PayrollNz">Methods</a></li>
               <li data-group="PayrollNz" data-name="approveTimesheet" class="">
                 <a href="#api-PayrollNz-approveTimesheet">approveTimesheet</a>

diff --git a/docs/payroll_uk/index.html b/docs/payroll_uk/index.html
@@ -3510,7 +3510,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="PayrollUk"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>3.12.0</li>
+              <li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>3.13.0</li>
               <li class="nav-header" data-group="PayrollUk"><a href="#api-PayrollUk">Methods</a></li>
               <li data-group="PayrollUk" data-name="approveTimesheet" class="">
                 <a href="#api-PayrollUk-approveTimesheet">approveTimesheet</a>

diff --git a/docs/projects/ProjectApi.md b/docs/projects/ProjectApi.md
@@ -89,7 +89,7 @@ Name | Type | Description  | Notes
 
 ## create_task
 
-> create_task(xero_tenant_id, project_id, task_create_or_update)
+> Task create_task(xero_tenant_id, project_id, task_create_or_update)
 
 Allows you to create a task
 
@@ -125,7 +125,8 @@ project_id = 'project_id_example' # String | You can create a task on a specifie
 task_create_or_update = { "status": "INPROGRESS" } # TaskCreateOrUpdate | The task object you are creating
 begin
   #Allows you to create a task
-  api_instance.create_task(xero_tenant_id, project_id, task_create_or_update)
+  result = api_instance.create_task(xero_tenant_id, project_id, task_create_or_update)
+  p result
 rescue XeroRuby::Projects::ApiError => e
   puts "Exception when calling ProjectApi->create_task: #{e}"
 end
@@ -142,7 +143,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-nil (empty response body)
+[**Task**](Task.md)
 
 ### Authorization