Skip to content

Commit

Permalink
Merge pull request #229 from XeroAPI/xero-ruby-3.12.0
Browse files Browse the repository at this point in the history
generates from OAS 2.27.0
  • Loading branch information
RettBehrens authored Aug 30, 2022
2 parents 0d80354 + 5c1d6be commit 9eba2a1
Show file tree
Hide file tree
Showing 19 changed files with 127 additions and 24 deletions.
2 changes: 1 addition & 1 deletion docs/accounting/AccountingApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6979,7 +6979,7 @@ opts = {

summary_only: false, # Boolean | Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient.

search_term: 'searchTerm=Joe Bloggs' # String | Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields.
search_term: 'Joe Bloggs' # String | Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields.
}

begin
Expand Down
6 changes: 3 additions & 3 deletions docs/accounting/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4054,7 +4054,7 @@
"Class" : {
"type" : "string",
"description" : "Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM)",
"enum" : [ "DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK", "ULTIMATE" ]
"enum" : [ "DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK", "ULTIMATE", "LITE" ]
},
"Edition" : {
"type" : "string",
Expand Down Expand Up @@ -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.11.0</li>
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>3.12.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>
Expand Down Expand Up @@ -21880,7 +21880,7 @@ <h3>Usage and SDK Samples</h3>
page = 1
include_archived = true
summary_only = true
search_term = 'searchTerm=Joe Bloggs'
search_term = 'Joe Bloggs'

begin
response = xero_client.accounting_api.get_contacts(xero_tenant_id, if_modified_since, where, order, ids, page, include_archived, summary_only, search_term)
Expand Down
2 changes: 1 addition & 1 deletion docs/app_store/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.11.0</li>
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>3.12.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>
Expand Down
2 changes: 1 addition & 1 deletion docs/assets/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.11.0</li>
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>3.12.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>
Expand Down
2 changes: 1 addition & 1 deletion docs/files/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.11.0</li>
<li class="nav-header" data-group="Files"><strong>VSN: </strong>3.12.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>
Expand Down
2 changes: 1 addition & 1 deletion docs/finance/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.11.0</li>
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>3.12.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>
Expand Down
2 changes: 1 addition & 1 deletion docs/payroll_au/Employee.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Name | Type | Description | Notes
**title** | **String** | Title of the employee | [optional]
**middle_names** | **String** | Middle name(s) of the employee | [optional]
**email** | **String** | The email address for the employee | [optional]
**gender** | **String** | The employee’s gender. See Employee Gender | [optional]
**gender** | **String** | The employee’s gender. See Employee Gender | [optional]
**phone** | **String** | Employee phone number | [optional]
**mobile** | **String** | Employee mobile number | [optional]
**twitter_user_name** | **String** | Employee’s twitter name | [optional]
Expand Down
16 changes: 16 additions & 0 deletions docs/payroll_au/LeaveCategoryCode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# XeroRuby::PayrollAu::LeaveCategoryCode

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

## Code Sample

```ruby
require 'XeroRuby::PayrollAu'

instance = XeroRuby::PayrollAu::LeaveCategoryCode.new()
```


6 changes: 5 additions & 1 deletion docs/payroll_au/LeaveType.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Name | Type | Description | Notes
**is_paid_leave** | **Boolean** | Set this to indicate that an employee will be paid when taking this type of leave | [optional]
**show_on_payslip** | **Boolean** | Set this if you want a balance for this leave type to be shown on your employee’s payslips | [optional]
**current_record** | **Boolean** | Is the current record | [optional]
**leave_category_code** | [**LeaveCategoryCode**](LeaveCategoryCode.md) | | [optional]
**sgc_exempt** | **Boolean** | Set this to indicate that the leave type is exempt from superannuation guarantee contribution | [optional]

## Code Sample

Expand All @@ -27,7 +29,9 @@ instance = XeroRuby::PayrollAu::LeaveType.new(name: PTO,
updated_date_utc: /Date(1583967733054+0000)/,
is_paid_leave: true,
show_on_payslip: true,
current_record: true)
current_record: true,
leave_category_code: null,
sgc_exempt: true)
```


19 changes: 17 additions & 2 deletions docs/payroll_au/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1294,7 +1294,7 @@
},
"Gender" : {
"type" : "string",
"description" : "The employee’s gender. See Employee Gender",
"description" : "The employee’s gender. See Employee Gender",
"example" : "F",
"enum" : [ "N", "M", "F", "I" ]
},
Expand Down Expand Up @@ -1628,6 +1628,13 @@
}
},
"description" : ""
};
defs["LeaveCategoryCode"] = {
"title" : "",
"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" ]
};
defs["LeaveEarningsLine"] = {
"title" : "",
Expand Down Expand Up @@ -1813,6 +1820,14 @@
"type" : "boolean",
"description" : "Is the current record",
"example" : true
},
"LeaveCategoryCode" : {
"$ref" : "#/components/schemas/LeaveCategoryCode"
},
"SGCExempt" : {
"type" : "boolean",
"description" : "Set this to indicate that the leave type is exempt from superannuation guarantee contribution",
"example" : true
}
},
"description" : ""
Expand Down Expand Up @@ -3259,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.11.0</li>
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>3.12.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>
Expand Down
2 changes: 1 addition & 1 deletion docs/payroll_nz/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.11.0</li>
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>3.12.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>
Expand Down
2 changes: 1 addition & 1 deletion docs/payroll_uk/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.11.0</li>
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>3.12.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>
Expand Down
2 changes: 1 addition & 1 deletion docs/projects/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1462,7 +1462,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="Project"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="Project"><strong>VSN: </strong>3.11.0</li>
<li class="nav-header" data-group="Project"><strong>VSN: </strong>3.12.0</li>
<li class="nav-header" data-group="Project"><a href="#api-Project">Methods</a></li>
<li data-group="Project" data-name="createProject" class="">
<a href="#api-Project-createProject">createProject</a>
Expand Down
1 change: 1 addition & 0 deletions lib/xero-ruby.rb
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,7 @@
require 'xero-ruby/models/payroll_au/leave_application'
require 'xero-ruby/models/payroll_au/leave_applications'
require 'xero-ruby/models/payroll_au/leave_balance'
require 'xero-ruby/models/payroll_au/leave_category_code'
require 'xero-ruby/models/payroll_au/leave_earnings_line'
require 'xero-ruby/models/payroll_au/leave_line'
require 'xero-ruby/models/payroll_au/leave_line_calculation_type'
Expand Down
5 changes: 3 additions & 2 deletions lib/xero-ruby/models/accounting/organisation.rb
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@ class Organisation
GST_CASHBOOK ||= "GST_CASHBOOK".freeze
NON_GST_CASHBOOK ||= "NON_GST_CASHBOOK".freeze
ULTIMATE ||= "ULTIMATE".freeze
LITE ||= "LITE".freeze

# BUSINESS or PARTNER. Partner edition organisations are sold exclusively through accounting partners and have restricted functionality (e.g. no access to invoicing)
attr_accessor :edition
Expand Down Expand Up @@ -462,7 +463,7 @@ def valid?
return false unless sales_tax_period_validator.valid?(@sales_tax_period)
organisation_entity_type_validator = EnumAttributeValidator.new('String', ["ACCOUNTING_PRACTICE", "COMPANY", "CHARITY", "CLUB_OR_SOCIETY", "INDIVIDUAL", "LOOK_THROUGH_COMPANY", "NOT_FOR_PROFIT", "PARTNERSHIP", "S_CORPORATION", "SELF_MANAGED_SUPERANNUATION_FUND", "SOLE_TRADER", "SUPERANNUATION_FUND", "TRUST"])
return false unless organisation_entity_type_validator.valid?(@organisation_entity_type)
_class_validator = EnumAttributeValidator.new('String', ["DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK", "ULTIMATE"])
_class_validator = EnumAttributeValidator.new('String', ["DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK", "ULTIMATE", "LITE"])
return false unless _class_validator.valid?(@_class)
edition_validator = EnumAttributeValidator.new('String', ["BUSINESS", "PARTNER"])
return false unless edition_validator.valid?(@edition)
Expand Down Expand Up @@ -522,7 +523,7 @@ def organisation_entity_type=(organisation_entity_type)
# Custom attribute writer method checking allowed values (enum).
# @param [Object] _class Object to be assigned
def _class=(_class)
validator = EnumAttributeValidator.new('String', ["DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK", "ULTIMATE"])
validator = EnumAttributeValidator.new('String', ["DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK", "ULTIMATE", "LITE"])
unless validator.valid?(_class)
fail ArgumentError, "invalid value for \"_class\", must be one of #{validator.allowable_values}."
end
Expand Down
2 changes: 1 addition & 1 deletion lib/xero-ruby/models/payroll_au/employee.rb
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ class Employee
# The email address for the employee
attr_accessor :email

# The employee’s gender. See Employee Gender
# The employee’s gender. See Employee Gender
attr_accessor :gender
N ||= "N".freeze
M ||= "M".freeze
Expand Down
46 changes: 46 additions & 0 deletions lib/xero-ruby/models/payroll_au/leave_category_code.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
=begin
#Xero Payroll AU API

#This is the Xero Payroll API for orgs in Australia region.

Contact: [email protected]
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 4.3.1

=end

require 'time'
require 'date'

module XeroRuby::PayrollAu
class LeaveCategoryCode
ANNUALLEAVE ||= "ANNUALLEAVE".freeze
LONGSERVICELEAVE ||= "LONGSERVICELEAVE".freeze
PERSONALCARERSLEAVE ||= "PERSONALCARERSLEAVE".freeze
ROSTEREDDAYOFF ||= "ROSTEREDDAYOFF".freeze
TIMEOFFINLIEU ||= "TIMEOFFINLIEU".freeze
COMPASSIONATEANDBEREAVEMENTLEAVE ||= "COMPASSIONATEANDBEREAVEMENTLEAVE".freeze
STUDYLEAVE ||= "STUDYLEAVE".freeze
FAMILYANDDOMESTICVIOLENCELEAVE ||= "FAMILYANDDOMESTICVIOLENCELEAVE".freeze
SPECIALPAIDLEAVE ||= "SPECIALPAIDLEAVE".freeze
COMMUNITYSERVICELEAVE ||= "COMMUNITYSERVICELEAVE".freeze
JURYDUTYLEAVE ||= "JURYDUTYLEAVE".freeze
DEFENCERESERVELEAVE ||= "DEFENCERESERVELEAVE".freeze

# Builds the enum from string
# @param [String] The enum value in the form of the string
# @return [String] The enum value
def self.build_from_hash(value)
new.build_from_hash(value)
end

# Builds the enum from string
# @param [String] The enum value in the form of the string
# @return [String] The enum value
def build_from_hash(value)
constantValues = LeaveCategoryCode.constants.select { |c| LeaveCategoryCode::const_get(c) == value }
raise "Invalid ENUM value #{value} for class #LeaveCategoryCode" if constantValues.empty?
value
end
end
end
28 changes: 24 additions & 4 deletions lib/xero-ruby/models/payroll_au/leave_type.rb
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,12 @@ class LeaveType
# Is the current record
attr_accessor :current_record


attr_accessor :leave_category_code

# Set this to indicate that the leave type is exempt from superannuation guarantee contribution
attr_accessor :sgc_exempt

# Attribute mapping from ruby-style variable name to JSON key.
def self.attribute_map
{
Expand All @@ -54,7 +60,9 @@ def self.attribute_map
:'updated_date_utc' => :'UpdatedDateUTC',
:'is_paid_leave' => :'IsPaidLeave',
:'show_on_payslip' => :'ShowOnPayslip',
:'current_record' => :'CurrentRecord'
:'current_record' => :'CurrentRecord',
:'leave_category_code' => :'LeaveCategoryCode',
:'sgc_exempt' => :'SGCExempt'
}
end

Expand All @@ -69,7 +77,9 @@ def self.openapi_types
:'updated_date_utc' => :'DateTime',
:'is_paid_leave' => :'Boolean',
:'show_on_payslip' => :'Boolean',
:'current_record' => :'Boolean'
:'current_record' => :'Boolean',
:'leave_category_code' => :'LeaveCategoryCode',
:'sgc_exempt' => :'Boolean'
}
end

Expand Down Expand Up @@ -123,6 +133,14 @@ def initialize(attributes = {})
if attributes.key?(:'current_record')
self.current_record = attributes[:'current_record']
end

if attributes.key?(:'leave_category_code')
self.leave_category_code = attributes[:'leave_category_code']
end

if attributes.key?(:'sgc_exempt')
self.sgc_exempt = attributes[:'sgc_exempt']
end
end

# Show invalid properties with the reasons. Usually used together with valid?
Expand Down Expand Up @@ -166,7 +184,9 @@ def ==(o)
updated_date_utc == o.updated_date_utc &&
is_paid_leave == o.is_paid_leave &&
show_on_payslip == o.show_on_payslip &&
current_record == o.current_record
current_record == o.current_record &&
leave_category_code == o.leave_category_code &&
sgc_exempt == o.sgc_exempt
end

# @see the `==` method
Expand All @@ -178,7 +198,7 @@ def eql?(o)
# Calculates hash code according to all attributes.
# @return [Integer] Hash code
def hash
[name, type_of_units, leave_type_id, normal_entitlement, leave_loading_rate, updated_date_utc, is_paid_leave, show_on_payslip, current_record].hash
[name, type_of_units, leave_type_id, normal_entitlement, leave_loading_rate, updated_date_utc, is_paid_leave, show_on_payslip, current_record, leave_category_code, sgc_exempt].hash
end

# Builds the object from hash
Expand Down
4 changes: 2 additions & 2 deletions lib/xero-ruby/version.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 4.3.1

The version of the XeroOpenAPI document: 2.25.0
The version of the XeroOpenAPI document: 2.27.0
=end

module XeroRuby
VERSION = '3.11.0'
VERSION = '3.12.0'
end

0 comments on commit 9eba2a1

Please sign in to comment.