Merge pull request #244 from XeroAPI/xero-ruby-4.0.0

generates xero-ruby 4.0.0 from OAS 2.34.1
XeroAPI · Dec 14, 2022 · bab3a05 · bab3a05
2 parents 9e485cd + 5d784a9
commit bab3a05
Show file tree

Hide file tree

Showing 20 changed files with 130 additions and 40 deletions.
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,40 +1,44 @@
 PATH
   remote: .
   specs:
-    xero-ruby (3.6.0)
-      faraday (>= 1.0.1, < 3.0)
+    xero-ruby (4.0.0)
+      faraday (>= 2.0, < 3.0)
       json (~> 2.1, >= 2.1.0)
       json-jwt (~> 1.5, >= 1.5.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.1)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     aes_key_wrap (1.1.0)
     ast (2.4.2)
-    bindata (2.4.10)
+    bindata (2.4.14)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
-    faraday (2.2.0)
-      faraday-net_http (~> 2.0)
+    faraday (2.7.1)
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-net_http (2.0.1)
-    i18n (1.9.1)
+    faraday-follow_redirects (0.3.0)
+      faraday (>= 1, < 3)
+    faraday-net_http (3.0.2)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
-    json (2.6.1)
-    json-jwt (1.13.0)
+    json (2.6.3)
+    json-jwt (1.16.1)
       activesupport (>= 4.2)
       aes_key_wrap
       bindata
+      faraday (~> 2.0)
+      faraday-follow_redirects
     method_source (1.0.0)
-    minitest (5.15.0)
+    minitest (5.16.3)
     parallel (1.21.0)
     parser (3.1.0.0)
       ast (~> 2.4.1)
@@ -72,7 +76,7 @@ GEM
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     stringio (3.0.1)
-    tzinfo (2.0.4)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.5.0)
 

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>3.17.0</li>
+              <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>4.0.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>3.17.0</li>
+              <li class="nav-header" data-group="AppStore"><strong>VSN: </strong>4.0.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.17.0</li>
+              <li class="nav-header" data-group="Asset"><strong>VSN: </strong>4.0.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.17.0</li>
+              <li class="nav-header" data-group="Files"><strong>VSN: </strong>4.0.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/StatementLineResponse.md b/docs/finance/StatementLineResponse.md
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **statement_line_id** | **String** | Xero Identifier of statement line | [optional] 
 **posted_date** | **Date** | Date of when statement line was posted | [optional] 
+**payee** | **String** | Payee description of statement line | [optional] 
 **reference** | **String** | Reference description of statement line | [optional] 
 **notes** | **String** | Notes description of statement line | [optional] 
 **cheque_no** | **String** | Cheque number of statement line | [optional] 
@@ -25,6 +26,7 @@ require 'XeroRuby::Finance'
 
 instance = XeroRuby::Finance::StatementLineResponse.new(statement_line_id: null,
                                  posted_date: null,
+                                 payee: null,
                                  reference: null,
                                  notes: null,
                                  cheque_no: null,

diff --git a/docs/finance/StatementResponse.md b/docs/finance/StatementResponse.md
@@ -9,8 +9,10 @@ Name | Type | Description | Notes
 **end_date** | **Date** | End date of statement | [optional] 
 **imported_date_time_utc** | **DateTime** | Utc date time of when the statement was imported in Xero | [optional] 
 **import_source** | **String** | Indicates the source of the statement data. Either imported from 1) direct bank feed OR 2) manual customer entry or upload. Manual import sources are STMTIMPORTSRC/MANUAL, STMTIMPORTSRC/CSV, STMTIMPORTSRC/OFX, Ofx or STMTIMPORTSRC/QIF. All other import sources are direct and, depending on the direct solution, may contain the name of the financial institution. | [optional] 
-**start_balance** | **BigDecimal** | Opening balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied. | [optional] 
-**end_balance** | **BigDecimal** | Closing balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied. | [optional] 
+**start_balance** | **BigDecimal** | Opening balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied. Where not supplied, the value will be 0. | [optional] 
+**end_balance** | **BigDecimal** | Closing balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied. Where not supplied, the value will be 0. | [optional] 
+**indicative_start_balance** | **BigDecimal** | Opening statement balance calculated in Xero (&#x3D; bank account conversion balance plus sum of imported bank statement lines). Note: If indicative statement balance doesn&#39;t match imported statement balance for the same date, either the conversion (opening at inception) balance in Xero is wrong or there&#39;s an error in the bank statement lines in Xero. Ref: https://central.xero.com/s/article/Compare-the-statement-balance-in-Xero-to-your-actual-bank-balance?userregion&#x3D;true  | [optional] 
+**indicative_end_balance** | **BigDecimal** | Closing statement balance calculated in Xero (&#x3D; bank account conversion balance plus sum of imported bank statement lines). Note: If indicative statement balance doesn&#39;t match imported statement balance for the same date, either the conversion (opening at inception) balance in Xero is wrong or there&#39;s an error in the bank statement lines in Xero. Ref: https://central.xero.com/s/article/Compare-the-statement-balance-in-Xero-to-your-actual-bank-balance?userregion&#x3D;true   | [optional] 
 **statement_lines** | [**Array&lt;StatementLineResponse&gt;**](StatementLineResponse.md) | List of statement lines | [optional] 
 
 ## Code Sample
@@ -25,6 +27,8 @@ instance = XeroRuby::Finance::StatementResponse.new(statement_id: null,
                                  import_source: null,
                                  start_balance: null,
                                  end_balance: null,
+                                 indicative_start_balance: null,
+                                 indicative_end_balance: null,
                                  statement_lines: null)
 ```
 

diff --git a/docs/finance/index.html b/docs/finance/index.html
@@ -2161,6 +2161,10 @@
       "description" : "Date of when statement line was posted",
       "format" : "date"
     },
+    "payee" : {
+      "type" : "string",
+      "description" : "Payee description of statement line"
+    },
     "reference" : {
       "type" : "string",
       "description" : "Reference description of statement line"
@@ -2349,13 +2353,25 @@
     },
     "startBalance" : {
       "type" : "number",
-      "description" : "Opening balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied.",
+      "description" : "Opening balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied. Where not supplied, the value will be 0.",
       "format" : "double",
       "x-is-money" : true
     },
     "endBalance" : {
       "type" : "number",
-      "description" : "Closing balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied.",
+      "description" : "Closing balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied. Where not supplied, the value will be 0.",
+      "format" : "double",
+      "x-is-money" : true
+    },
+    "indicativeStartBalance" : {
+      "type" : "number",
+      "description" : "Opening statement balance calculated in Xero (= bank account conversion balance plus sum of imported bank statement lines). Note: If indicative statement balance doesn't match imported statement balance for the same date, either the conversion (opening at inception) balance in Xero is wrong or there's an error in the bank statement lines in Xero. Ref: https://central.xero.com/s/article/Compare-the-statement-balance-in-Xero-to-your-actual-bank-balance?userregion=true\n",
+      "format" : "double",
+      "x-is-money" : true
+    },
+    "indicativeEndBalance" : {
+      "type" : "number",
+      "description" : "Closing statement balance calculated in Xero (= bank account conversion balance plus sum of imported bank statement lines). Note: If indicative statement balance doesn't match imported statement balance for the same date, either the conversion (opening at inception) balance in Xero is wrong or there's an error in the bank statement lines in Xero. Ref: https://central.xero.com/s/article/Compare-the-statement-balance-in-Xero-to-your-actual-bank-balance?userregion=true \n",
       "format" : "double",
       "x-is-money" : true
     },
@@ -2718,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>3.17.0</li>
+              <li class="nav-header" data-group="Finance"><strong>VSN: </strong>4.0.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/EarningsRate.md b/docs/payroll_au/EarningsRate.md
@@ -10,6 +10,8 @@ Name | Type | Description | Notes
 **is_exempt_from_tax** | **Boolean** | Most payments are subject to tax, so you should only set this value if you are sure that a payment is exempt from PAYG withholding | [optional] 
 **is_exempt_from_super** | **Boolean** | See the ATO website for details of which payments are exempt from SGC | [optional] 
 **is_reportable_as_w1** | **Boolean** | Boolean to determine if the earnings rate is reportable or exempt from W1 | [optional] 
+**allowance_contributes_to_annual_leave_rate** | **Boolean** | Boolean to determine if the allowance earnings rate contributes towards annual leave rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT | [optional] 
+**allowance_contributes_to_overtime_rate** | **Boolean** | Boolean to determine if the allowance earnings rate contributes towards overtime allowance rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT | [optional] 
 **earnings_type** | [**EarningsType**](EarningsType.md) |  | [optional] 
 **earnings_rate_id** | **String** | Xero identifier | [optional] 
 **rate_type** | [**RateType**](RateType.md) |  | [optional] 
@@ -34,6 +36,8 @@ instance = XeroRuby::PayrollAu::EarningsRate.new(name: PTO,
                                  is_exempt_from_tax: false,
                                  is_exempt_from_super: false,
                                  is_reportable_as_w1: false,
+                                 allowance_contributes_to_annual_leave_rate: false,
+                                 allowance_contributes_to_overtime_rate: false,
                                  earnings_type: null,
                                  earnings_rate_id: e0eb6747-7c17-4075-b804-989f8d4e5d39,
                                  rate_type: null,

diff --git a/docs/payroll_au/PayrollAuApi.md b/docs/payroll_au/PayrollAuApi.md
@@ -196,7 +196,7 @@ api_instance = xero_client.<api_set>
 
 
 xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-pay_item = { "EarningsRates": [ { "Name": "MyRate", "AccountCode": "400", "TypeOfUnits": "4.00", "IsExemptFromTax": true, "IsExemptFromSuper": true, "IsReportableAsW1": false, "EarningsType": "ORDINARYTIMEEARNINGS", "EarningsRateID": "1fa4e226-b711-46ba-a8a7-4344c9c5fb87", "RateType": "MULTIPLE", "RatePerUnit": "10.0", "Multiplier": 1.5, "Amount": 5, "EmploymentTerminationPaymentType": "O" } ] } # PayItem | 
+pay_item = { "EarningsRates": [ { "Name": "MyRate", "AccountCode": "400", "TypeOfUnits": "4.00", "IsExemptFromTax": true, "IsExemptFromSuper": true, "IsReportableAsW1": false, "AllowanceContributesToAnnualLeaveRate": false, "AllowanceContributesToOvertimeRate": false, "EarningsType": "ORDINARYTIMEEARNINGS", "EarningsRateID": "1fa4e226-b711-46ba-a8a7-4344c9c5fb87", "RateType": "MULTIPLE", "RatePerUnit": "10.0", "Multiplier": 1.5, "Amount": 5, "EmploymentTerminationPaymentType": "O" } ] } # PayItem | 
 begin
   #Creates a pay item
   result = api_instance.create_pay_item(xero_tenant_id, pay_item)

diff --git a/docs/payroll_au/index.html b/docs/payroll_au/index.html
@@ -1182,6 +1182,16 @@
       "description" : "Boolean to determine if the earnings rate is reportable or exempt from W1",
       "example" : false
     },
+    "AllowanceContributesToAnnualLeaveRate" : {
+      "type" : "boolean",
+      "description" : "Boolean to determine if the allowance earnings rate contributes towards annual leave rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT",
+      "example" : false
+    },
+    "AllowanceContributesToOvertimeRate" : {
+      "type" : "boolean",
+      "description" : "Boolean to determine if the allowance earnings rate contributes towards overtime allowance rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT",
+      "example" : false
+    },
     "EarningsType" : {
       "$ref" : "#/components/schemas/EarningsType"
     },
@@ -3344,7 +3354,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.17.0</li>
+              <li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>4.0.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>
@@ -3859,7 +3869,7 @@ <h2>Parameters</h2>
       "schema" : {
         "$ref" : "#/components/schemas/PayItem"
       },
-      "example" : "{ \"EarningsRates\": [ { \"Name\": \"MyRate\", \"AccountCode\": \"400\", \"TypeOfUnits\": \"4.00\", \"IsExemptFromTax\": true, \"IsExemptFromSuper\": true, \"IsReportableAsW1\": false, \"EarningsType\": \"ORDINARYTIMEEARNINGS\", \"EarningsRateID\": \"1fa4e226-b711-46ba-a8a7-4344c9c5fb87\", \"RateType\": \"MULTIPLE\", \"RatePerUnit\": \"10.0\", \"Multiplier\": 1.5, \"Amount\": 5, \"EmploymentTerminationPaymentType\": \"O\" } ] }"
+      "example" : "{ \"EarningsRates\": [ { \"Name\": \"MyRate\", \"AccountCode\": \"400\", \"TypeOfUnits\": \"4.00\", \"IsExemptFromTax\": true, \"IsExemptFromSuper\": true, \"IsReportableAsW1\": false, \"AllowanceContributesToAnnualLeaveRate\": false, \"AllowanceContributesToOvertimeRate\": false, \"EarningsType\": \"ORDINARYTIMEEARNINGS\", \"EarningsRateID\": \"1fa4e226-b711-46ba-a8a7-4344c9c5fb87\", \"RateType\": \"MULTIPLE\", \"RatePerUnit\": \"10.0\", \"Multiplier\": 1.5, \"Amount\": 5, \"EmploymentTerminationPaymentType\": \"O\" } ] }"
     }
   },
   "required" : true

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.17.0</li>
+              <li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>4.0.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
@@ -1381,7 +1381,7 @@
     "earningsType" : {
       "type" : "string",
       "description" : "Indicates how an employee will be paid when taking this type of earning",
-      "enum" : [ "Allowance", "Backpay", "Bonus", "Commission", "LumpSum", "OtherEarnings", "OvertimeEarnings", "RegularEarnings", "StatutoryAdoptionPay", "StatutoryAdoptionPayNonPensionable", "StatutoryBereavementPay", "StatutoryMaternityPay", "StatutoryMaternityPayNonPensionable", "StatutoryPaternityPay", "StatutoryPaternityPayNonPensionable", "StatutoryParentalBereavementPayNonPensionable", "StatutorySharedParentalPay", "StatutorySharedParentalPayNonPensionable", "StatutorySickPay", "StatutorySickPayNonPensionable", "TipsNonDirect", "TipsDirect", "TerminationPay" ]
+      "enum" : [ "Allowance", "BackPay", "Bonus", "Commission", "LumpSum", "OtherEarnings", "OvertimeEarnings", "RegularEarnings", "StatutoryAdoptionPay", "StatutoryAdoptionPayNonPensionable", "StatutoryBereavementPay", "StatutoryMaternityPay", "StatutoryMaternityPayNonPensionable", "StatutoryPaternityPay", "StatutoryPaternityPayNonPensionable", "StatutoryParentalBereavementPayNonPensionable", "StatutorySharedParentalPay", "StatutorySharedParentalPayNonPensionable", "StatutorySickPay", "StatutorySickPayNonPensionable", "TipsNonDirect", "TipsDirect", "TerminationPay" ]
     },
     "rateType" : {
       "type" : "string",
@@ -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.17.0</li>
+              <li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>4.0.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>