Merge pull request #237 from XeroAPI/xero-ruby-3.14.0

generates xero-ruby 3.14.0 from OAS 2.30.2
XeroAPI · Oct 7, 2022 · 58f5164 · 58f5164
2 parents d2feaf9 + 3ebffba
commit 58f5164
Show file tree

Hide file tree

Showing 32 changed files with 900 additions and 113 deletions.
diff --git a/README.md b/README.md
@@ -118,7 +118,7 @@ It is reccomended that you store this token set JSON in a datastore in relation
 | access_token: | "xxx.yyy.zzz" | [Bearer token](https://oauth.net/2/jwt/) with a 30 minute expiration required for all API calls |
 | expires_in: | 1800 | Time in seconds till the token expires - 1800s is 30m |
 | refresh_token: | "XXXXXXX" | Alphanumeric string used to obtain a new Token Set w/ a fresh access_token - 60 day expiry |
-| scope: | ["email", "profile", "openid", "accounting.transactions", "offline_access"] | The Xero permissions that are embedded in the `access_token` |
+| scope: | "email profile openid accounting.transactions offline_access" | The Xero permissions that are embedded in the `access_token` |
 
 Example Token Set JSON:
 ```
@@ -128,7 +128,7 @@ Example Token Set JSON:
   "expires_in": 1800,
   "token_type": "Bearer",
   "refresh_token": "xxxxxxxxx",
-  "scope": ["email", "profile", "openid", "accounting.transactions", "offline_access"]
+  "scope": "email profile openid accounting.transactions offline_access"
 }
 ```
 ---

diff --git a/docs/accounting/index.html b/docs/accounting/index.html
@@ -5813,7 +5813,7 @@
   "title" : "",
   "type" : "string",
   "description" : "Timezone specifications",
-  "enum" : [ "MOROCCOSTANDARDTIME", "UTC", "GMTSTANDARDTIME", "GREENWICHSTANDARDTIME", "WEUROPESTANDARDTIME", "CENTRALEUROPESTANDARDTIME", "ROMANCESTANDARDTIME", "CENTRALEUROPEANSTANDARDTIME", "WCENTRALAFRICASTANDARDTIME", "NAMIBIASTANDARDTIME", "JORDANSTANDARDTIME", "GTBSTANDARDTIME", "MIDDLEEASTSTANDARDTIME", "EGYPTSTANDARDTIME", "SYRIASTANDARDTIME", "EEUROPESTANDARDTIME", "SOUTHAFRICASTANDARDTIME", "FLESTANDARDTIME", "TURKEYSTANDARDTIME", "ISRAELSTANDARDTIME", "KALININGRADSTANDARDTIME", "LIBYASTANDARDTIME", "ARABICSTANDARDTIME", "ARABSTANDARDTIME", "BELARUSSTANDARDTIME", "RUSSIANSTANDARDTIME", "EAFRICASTANDARDTIME", "IRANSTANDARDTIME", "ARABIANSTANDARDTIME", "AZERBAIJANSTANDARDTIME", "RUSSIATIMEZONE3", "MAURITIUSSTANDARDTIME", "GEORGIANSTANDARDTIME", "CAUCASUSSTANDARDTIME", "AFGHANISTANSTANDARDTIME", "WESTASIASTANDARDTIME", "EKATERINBURGSTANDARDTIME", "PAKISTANSTANDARDTIME", "INDIASTANDARDTIME", "SRILANKASTANDARDTIME", "NEPALSTANDARDTIME", "CENTRALASIASTANDARDTIME", "BANGLADESHSTANDARDTIME", "NCENTRALASIASTANDARDTIME", "MYANMARSTANDARDTIME", "SEASIASTANDARDTIME", "NORTHASIASTANDARDTIME", "CHINASTANDARDTIME", "NORTHASIAEASTSTANDARDTIME", "SINGAPORESTANDARDTIME", "WAUSTRALIASTANDARDTIME", "TAIPEISTANDARDTIME", "ULAANBAATARSTANDARDTIME", "TOKYOSTANDARDTIME", "KOREASTANDARDTIME", "YAKUTSKSTANDARDTIME", "CENAUSTRALIASTANDARDTIME", "AUSCENTRALSTANDARDTIME", "EAUSTRALIASTANDARDTIME", "AUSEASTERNSTANDARDTIME", "WESTPACIFICSTANDARDTIME", "TASMANIASTANDARDTIME", "MAGADANSTANDARDTIME", "VLADIVOSTOKSTANDARDTIME", "RUSSIATIMEZONE10", "CENTRALPACIFICSTANDARDTIME", "RUSSIATIMEZONE11", "NEWZEALANDSTANDARDTIME", "UTC+12", "UTC+13", "FIJISTANDARDTIME", "KAMCHATKASTANDARDTIME", "TONGASTANDARDTIME", "SAMOASTANDARDTIME", "LINEISLANDSSTANDARDTIME", "AZORESSTANDARDTIME", "CAPEVERDESTANDARDTIME", "UTC02", "MIDATLANTICSTANDARDTIME", "ESOUTHAMERICASTANDARDTIME", "ARGENTINASTANDARDTIME", "SAEASTERNSTANDARDTIME", "GREENLANDSTANDARDTIME", "MONTEVIDEOSTANDARDTIME", "BAHIASTANDARDTIME", "NEWFOUNDLANDSTANDARDTIME", "PARAGUAYSTANDARDTIME", "ATLANTICSTANDARDTIME", "CENTRALBRAZILIANSTANDARDTIME", "SAWESTERNSTANDARDTIME", "PACIFICSASTANDARDTIME", "VENEZUELASTANDARDTIME", "SAPACIFICSTANDARDTIME", "EASTERNSTANDARDTIME", "USEASTERNSTANDARDTIME", "CENTRALAMERICASTANDARDTIME", "CENTRALSTANDARDTIME", "CENTRALSTANDARDTIME(MEXICO)", "CANADACENTRALSTANDARDTIME", "USMOUNTAINSTANDARDTIME", "MOUNTAINSTANDARDTIME(MEXICO)", "MOUNTAINSTANDARDTIME", "PACIFICSTANDARDTIME(MEXICO)", "PACIFICSTANDARDTIME", "ALASKANSTANDARDTIME", "HAWAIIANSTANDARDTIME", "UTC11", "DATELINESTANDARDTIME", "EASTERISLANDSTANDARDTIME" ]
+  "enum" : [ "AFGHANISTANSTANDARDTIME", "ALASKANSTANDARDTIME", "ALEUTIANSTANDARDTIME", "ALTAISTANDARDTIME", "ARABIANSTANDARDTIME", "ARABICSTANDARDTIME", "ARABSTANDARDTIME", "ARGENTINASTANDARDTIME", "ASTRAKHANSTANDARDTIME", "ATLANTICSTANDARDTIME", "AUSCENTRALSTANDARDTIME", "AUSCENTRALWSTANDARDTIME", "AUSEASTERNSTANDARDTIME", "AZERBAIJANSTANDARDTIME", "AZORESSTANDARDTIME", "BAHIASTANDARDTIME", "BANGLADESHSTANDARDTIME", "BELARUSSTANDARDTIME", "BOUGAINVILLESTANDARDTIME", "CANADACENTRALSTANDARDTIME", "CAPEVERDESTANDARDTIME", "CAUCASUSSTANDARDTIME", "CENAUSTRALIASTANDARDTIME", "CENTRALAMERICASTANDARDTIME", "CENTRALASIASTANDARDTIME", "CENTRALBRAZILIANSTANDARDTIME", "CENTRALEUROPEANSTANDARDTIME", "CENTRALEUROPESTANDARDTIME", "CENTRALPACIFICSTANDARDTIME", "CENTRALSTANDARDTIME", "CENTRALSTANDARDTIME(MEXICO)", "CHATHAMISLANDSSTANDARDTIME", "CHINASTANDARDTIME", "CUBASTANDARDTIME", "DATELINESTANDARDTIME", "EAFRICASTANDARDTIME", "EASTERISLANDSTANDARDTIME", "EASTERNSTANDARDTIME", "EASTERNSTANDARDTIME(MEXICO)", "EAUSTRALIASTANDARDTIME", "EEUROPESTANDARDTIME", "EGYPTSTANDARDTIME", "EKATERINBURGSTANDARDTIME", "ESOUTHAMERICASTANDARDTIME", "FIJISTANDARDTIME", "FLESTANDARDTIME", "GEORGIANSTANDARDTIME", "GMTSTANDARDTIME", "GREENLANDSTANDARDTIME", "GREENWICHSTANDARDTIME", "GTBSTANDARDTIME", "HAITISTANDARDTIME", "HAWAIIANSTANDARDTIME", "INDIASTANDARDTIME", "IRANSTANDARDTIME", "ISRAELSTANDARDTIME", "JORDANSTANDARDTIME", "KALININGRADSTANDARDTIME", "KAMCHATKASTANDARDTIME", "KOREASTANDARDTIME", "LIBYASTANDARDTIME", "LINEISLANDSSTANDARDTIME", "LORDHOWESTANDARDTIME", "MAGADANSTANDARDTIME", "MAGALLANESSTANDARDTIME", "MARQUESASSTANDARDTIME", "MAURITIUSSTANDARDTIME", "MIDATLANTICSTANDARDTIME", "MIDDLEEASTSTANDARDTIME", "MONTEVIDEOSTANDARDTIME", "MOROCCOSTANDARDTIME", "MOUNTAINSTANDARDTIME", "MOUNTAINSTANDARDTIME(MEXICO)", "MYANMARSTANDARDTIME", "NAMIBIASTANDARDTIME", "NCENTRALASIASTANDARDTIME", "NEPALSTANDARDTIME", "NEWFOUNDLANDSTANDARDTIME", "NEWZEALANDSTANDARDTIME", "NORFOLKSTANDARDTIME", "NORTHASIAEASTSTANDARDTIME", "NORTHASIASTANDARDTIME", "NORTHKOREASTANDARDTIME", "OMSKSTANDARDTIME", "PACIFICSASTANDARDTIME", "PACIFICSTANDARDTIME", "PACIFICSTANDARDTIME(MEXICO)", "PAKISTANSTANDARDTIME", "PARAGUAYSTANDARDTIME", "QYZYLORDASTANDARDTIME", "ROMANCESTANDARDTIME", "RUSSIANSTANDARDTIME", "RUSSIATIMEZONE10", "RUSSIATIMEZONE11", "RUSSIATIMEZONE3", "SAEASTERNSTANDARDTIME", "SAINTPIERRESTANDARDTIME", "SAKHALINSTANDARDTIME", "SAMOASTANDARDTIME", "SAOTOMESTANDARDTIME", "SAPACIFICSTANDARDTIME", "SARATOVSTANDARDTIME", "SAWESTERNSTANDARDTIME", "SEASIASTANDARDTIME", "SINGAPORESTANDARDTIME", "SOUTHAFRICASTANDARDTIME", "SOUTHSUDANSTANDARDTIME", "SRILANKASTANDARDTIME", "SUDANSTANDARDTIME", "SYRIASTANDARDTIME", "TAIPEISTANDARDTIME", "TASMANIASTANDARDTIME", "TOCANTINSSTANDARDTIME", "TOKYOSTANDARDTIME", "TOMSKSTANDARDTIME", "TONGASTANDARDTIME", "TRANSBAIKALSTANDARDTIME", "TURKEYSTANDARDTIME", "TURKSANDCAICOSSTANDARDTIME", "ULAANBAATARSTANDARDTIME", "USEASTERNSTANDARDTIME", "USMOUNTAINSTANDARDTIME", "UTC", "UTC+12", "UTC+13", "UTC02", "UTC08", "UTC09", "UTC11", "VENEZUELASTANDARDTIME", "VLADIVOSTOKSTANDARDTIME", "VOLGOGRADSTANDARDTIME", "WAUSTRALIASTANDARDTIME", "WCENTRALAFRICASTANDARDTIME", "WESTASIASTANDARDTIME", "WESTBANKSTANDARDTIME", "WESTPACIFICSTANDARDTIME", "WEUROPESTANDARDTIME", "WMONGOLIASTANDARDTIME", "YAKUTSKSTANDARDTIME", "YUKONSTANDARDTIME" ]
 };
       defs["TrackingCategories"] = {
   "title" : "",
@@ -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.13.0</li>
+              <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>3.14.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
@@ -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.13.0</li>
+              <li class="nav-header" data-group="AppStore"><strong>VSN: </strong>3.14.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.13.0</li>
+              <li class="nav-header" data-group="Asset"><strong>VSN: </strong>3.14.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.13.0</li>
+              <li class="nav-header" data-group="Files"><strong>VSN: </strong>3.14.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.13.0</li>
+              <li class="nav-header" data-group="Finance"><strong>VSN: </strong>3.14.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/CountryOfResidence.md b/docs/payroll_au/CountryOfResidence.md
@@ -0,0 +1,16 @@
+# XeroRuby::PayrollAu::CountryOfResidence
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::CountryOfResidence.new()
+```
+
+
diff --git a/docs/payroll_au/Employee.md b/docs/payroll_au/Employee.md
@@ -30,6 +30,10 @@ Name | Type | Description | Notes
 **pay_template** | [**PayTemplate**](PayTemplate.md) |  | [optional] 
 **opening_balances** | [**OpeningBalances**](OpeningBalances.md) |  | [optional] 
 **tax_declaration** | [**TaxDeclaration**](TaxDeclaration.md) |  | [optional] 
+**income_type** | [**IncomeType**](IncomeType.md) |  | [optional] 
+**employment_type** | [**EmploymentType**](EmploymentType.md) |  | [optional] 
+**country_of_residence** | [**CountryOfResidence**](CountryOfResidence.md) |  | [optional] 
+**is_stp2_qualified** | **Boolean** | Indicates if the employee has been updated for STP Phase 2 compliance. Doesn&#39;t indicate that the employee is payable. | [optional] 
 **leave_balances** | [**Array&lt;LeaveBalance&gt;**](LeaveBalance.md) |  | [optional] 
 **leave_lines** | [**Array&lt;LeaveLine&gt;**](LeaveLine.md) |  | [optional] 
 **super_memberships** | [**Array&lt;SuperMembership&gt;**](SuperMembership.md) |  | [optional] 
@@ -68,6 +72,10 @@ instance = XeroRuby::PayrollAu::Employee.new(first_name: Karen,
                                  pay_template: null,
                                  opening_balances: null,
                                  tax_declaration: null,
+                                 income_type: null,
+                                 employment_type: null,
+                                 country_of_residence: null,
+                                 is_stp2_qualified: true,
                                  leave_balances: null,
                                  leave_lines: null,
                                  super_memberships: null,

diff --git a/docs/payroll_au/EmploymentType.md b/docs/payroll_au/EmploymentType.md
@@ -0,0 +1,16 @@
+# XeroRuby::PayrollAu::EmploymentType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::EmploymentType.new()
+```
+
+
diff --git a/docs/payroll_au/IncomeType.md b/docs/payroll_au/IncomeType.md
@@ -0,0 +1,16 @@
+# XeroRuby::PayrollAu::IncomeType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::IncomeType.new()
+```
+
+
diff --git a/docs/payroll_au/SeniorMaritalStatus.md b/docs/payroll_au/SeniorMaritalStatus.md
@@ -0,0 +1,16 @@
+# XeroRuby::PayrollAu::SeniorMaritalStatus
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::SeniorMaritalStatus.new()
+```
+
+
diff --git a/docs/payroll_au/Settings.md b/docs/payroll_au/Settings.md
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **accounts** | [**Array&lt;Account&gt;**](Account.md) | Payroll Account details for SuperExpense, SuperLiabilty, WagesExpense, PAYGLiability &amp; WagesPayable. | [optional] 
 **tracking_categories** | [**SettingsTrackingCategories**](SettingsTrackingCategories.md) |  | [optional] 
 **days_in_payroll_year** | **Integer** | Number of days in the Payroll year | [optional] 
+**employees_are_stp2** | **Boolean** | Indicates if the organisation has been enabled for STP Phase 2 editing of employees. | [optional] 
 
 ## Code Sample
 
@@ -15,7 +16,8 @@ require 'XeroRuby::PayrollAu'
 
 instance = XeroRuby::PayrollAu::Settings.new(accounts: null,
                                  tracking_categories: null,
-                                 days_in_payroll_year: 365)
+                                 days_in_payroll_year: 365,
+                                 employees_are_stp2: true)
 ```
 
 
diff --git a/docs/payroll_au/TaxDeclaration.md b/docs/payroll_au/TaxDeclaration.md
@@ -8,8 +8,12 @@ Name | Type | Description | Notes
 **employment_basis** | [**EmploymentBasis**](EmploymentBasis.md) |  | [optional] 
 **tfn_exemption_type** | [**TFNExemptionType**](TFNExemptionType.md) |  | [optional] 
 **tax_file_number** | **String** | The tax file number e.g 123123123. | [optional] 
+**abn** | **String** | 11-digit Australian Business Number e.g 21006819692 or an empty string (\&quot;\&quot;) to unset a previously set value. Only applicable, and mandatory if income type is NONEMPLOYEE. | [optional] 
 **australian_resident_for_tax_purposes** | **Boolean** | If the employee is Australian resident for tax purposes. e.g true or false | [optional] 
 **residency_status** | [**ResidencyStatus**](ResidencyStatus.md) |  | [optional] 
+**tax_scale_type** | [**TaxScaleType**](TaxScaleType.md) |  | [optional] 
+**work_condition** | [**WorkCondition**](WorkCondition.md) |  | [optional] 
+**senior_marital_status** | [**SeniorMaritalStatus**](SeniorMaritalStatus.md) |  | [optional] 
 **tax_free_threshold_claimed** | **Boolean** | If tax free threshold claimed. e.g true or false | [optional] 
 **tax_offset_estimated_amount** | **Float** | If has tax offset estimated then the tax offset estimated amount. e.g 100 | [optional] 
 **has_help_debt** | **Boolean** | If employee has HECS or HELP debt. e.g true or false | [optional] 
@@ -31,8 +35,12 @@ instance = XeroRuby::PayrollAu::TaxDeclaration.new(employee_id: null,
                                  employment_basis: null,
                                  tfn_exemption_type: null,
                                  tax_file_number: 123123123,
+                                 abn: 21006819692,
                                  australian_resident_for_tax_purposes: true,
                                  residency_status: null,
+                                 tax_scale_type: null,
+                                 work_condition: null,
+                                 senior_marital_status: null,
                                  tax_free_threshold_claimed: false,
                                  tax_offset_estimated_amount: 100,
                                  has_help_debt: false,

diff --git a/docs/payroll_au/TaxScaleType.md b/docs/payroll_au/TaxScaleType.md
@@ -0,0 +1,16 @@
+# XeroRuby::PayrollAu::TaxScaleType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::TaxScaleType.new()
+```
+
+
diff --git a/docs/payroll_au/WorkCondition.md b/docs/payroll_au/WorkCondition.md
@@ -0,0 +1,16 @@
+# XeroRuby::PayrollAu::WorkCondition
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::PayrollAu'
+
+instance = XeroRuby::PayrollAu::WorkCondition.new()
+```
+
+