xero-ruby 2.4.0 → 2.4.1

data/docs/accounting/TrackingCategory.md

@@ -1,27 +0,0 @@
-# XeroRuby::Accounting::TrackingCategory
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**tracking_category_id** | **String** | The Xero identifier for a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 | [optional] 
-**tracking_option_id** | **String** | The Xero identifier for a tracking option e.g. dc54c220-0140-495a-b925-3246adc0075f | [optional] 
-**name** | **String** | The name of the tracking category e.g. Department, Region (max length = 100) | [optional] 
-**option** | **String** | The option name of the tracking option e.g. East, West (max length = 100) | [optional] 
-**status** | **String** | The status of a tracking category | [optional] 
-**options** | [**Array<TrackingOption>**](TrackingOption.md) | See Tracking Options | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::TrackingCategory.new(tracking_category_id: null,
-                                 tracking_option_id: null,
-                                 name: null,
-                                 option: null,
-                                 status: null,
-                                 options: null)
-```
-
-

data/docs/accounting/TrackingOption.md

@@ -1,23 +0,0 @@
-# XeroRuby::Accounting::TrackingOption
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**tracking_option_id** | **String** | The Xero identifier for a tracking option e.g. ae777a87-5ef3-4fa0-a4f0-d10e1f13073a | [optional] 
-**name** | **String** | The name of the tracking option e.g. Marketing, East (max length = 100) | [optional] 
-**status** | **String** | The status of a tracking option | [optional] 
-**tracking_category_id** | **String** | Filter by a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::TrackingOption.new(tracking_option_id: null,
-                                 name: null,
-                                 status: null,
-                                 tracking_category_id: null)
-```
-
-

data/docs/accounting/TrackingOptions.md

@@ -1,17 +0,0 @@
-# XeroRuby::Accounting::TrackingOptions
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**options** | [**Array<TrackingOption>**](TrackingOption.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::TrackingOptions.new(options: null)
-```
-
-

data/docs/accounting/User.md

@@ -1,29 +0,0 @@
-# XeroRuby::Accounting::User
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**user_id** | **String** | Xero identifier | [optional] 
-**email_address** | **String** | Email address of user | [optional] 
-**first_name** | **String** | First name of user | [optional] 
-**last_name** | **String** | Last name of user | [optional] 
-**updated_date_utc** | **DateTime** | Timestamp of last change to user | [optional] 
-**is_subscriber** | **Boolean** | Boolean to indicate if user is the subscriber | [optional] 
-**organisation_role** | **String** | User role that defines permissions in Xero and via API (READONLY, INVOICEONLY, STANDARD, FINANCIALADVISER, etc) | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::User.new(user_id: null,
-                                 email_address: null,
-                                 first_name: null,
-                                 last_name: null,
-                                 updated_date_utc: /Date(1573755038314)/,
-                                 is_subscriber: null,
-                                 organisation_role: null)
-```
-
-

data/docs/accounting/Users.md

@@ -1,17 +0,0 @@
-# XeroRuby::Accounting::Users
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**users** | [**Array<User>**](User.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::Users.new(users: null)
-```
-
-

data/docs/accounting/ValidationError.md

@@ -1,17 +0,0 @@
-# XeroRuby::Accounting::ValidationError
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**message** | **String** | Validation error message | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Accounting'
-
-instance = XeroRuby::Accounting::ValidationError.new(message: null)
-```
-
-

data/docs/assets/Asset.md

@@ -1,47 +0,0 @@
-# XeroRuby::Assets::Asset
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**asset_id** | **String** | The Xero-generated Id for the asset | [optional] 
-**asset_name** | **String** | The name of the asset | 
-**asset_type_id** | **String** | The Xero-generated Id for the asset type | [optional] 
-**asset_number** | **String** | Must be unique. | [optional] 
-**purchase_date** | **Date** | The date the asset was purchased YYYY-MM-DD | [optional] 
-**purchase_price** | **BigDecimal** | The purchase price of the asset | [optional] 
-**disposal_date** | **Date** | The date the asset was disposed | [optional] 
-**disposal_price** | **BigDecimal** | The price the asset was disposed at | [optional] 
-**asset_status** | [**AssetStatus**](AssetStatus.md) |  | [optional] 
-**warranty_expiry_date** | **String** | The date the asset’s warranty expires (if needed) YYYY-MM-DD | [optional] 
-**serial_number** | **String** | The asset's serial number | [optional] 
-**book_depreciation_setting** | [**BookDepreciationSetting**](BookDepreciationSetting.md) |  | [optional] 
-**book_depreciation_detail** | [**BookDepreciationDetail**](BookDepreciationDetail.md) |  | [optional] 
-**can_rollback** | **Boolean** | Boolean to indicate whether depreciation can be rolled back for this asset individually. This is true if it doesn't have 'legacy' journal entries and if there is no lock period that would prevent this asset from rolling back. | [optional] 
-**accounting_book_value** | **BigDecimal** | The accounting value of the asset | [optional] 
-**is_delete_enabled_for_date** | **Boolean** | Boolean to indicate whether delete is enabled | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Assets'
-
-instance = XeroRuby::Assets::Asset.new(asset_id: 3b5b3a38-5649-495f-87a1-14a4e5918634,
-                                 asset_name: Awesome Truck 3,
-                                 asset_type_id: 3b5b3a38-5649-495f-87a1-14a4e5918634,
-                                 asset_number: FA-0013,
-                                 purchase_date: null,
-                                 purchase_price: 1000.0000,
-                                 disposal_date: null,
-                                 disposal_price: 1.0000,
-                                 asset_status: null,
-                                 warranty_expiry_date: ca4c6b39-4f4f-43e8-98da-5e1f350a6694,
-                                 serial_number: ca4c6b39-4f4f-43e8-98da-5e1f350a6694,
-                                 book_depreciation_setting: null,
-                                 book_depreciation_detail: null,
-                                 can_rollback: true,
-                                 accounting_book_value: 0,
-                                 is_delete_enabled_for_date: true)
-```
-
-

data/docs/assets/AssetApi.md

@@ -1,426 +0,0 @@
-# XeroRuby::Assets::AssetApi
-
-All URIs are relative to *https://api.xero.com/assets.xro/1.0*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create_asset**](AssetApi.md#create_asset) | **POST** /Assets | adds a fixed asset
-[**create_asset_type**](AssetApi.md#create_asset_type) | **POST** /AssetTypes | adds a fixed asset type
-[**get_asset_by_id**](AssetApi.md#get_asset_by_id) | **GET** /Assets/{id} | retrieves fixed asset by id
-[**get_asset_settings**](AssetApi.md#get_asset_settings) | **GET** /Settings | searches fixed asset settings
-[**get_asset_types**](AssetApi.md#get_asset_types) | **GET** /AssetTypes | searches fixed asset types
-[**get_assets**](AssetApi.md#get_assets) | **GET** /Assets | searches fixed asset
-
-
-
-## create_asset
-
-> Asset create_asset(xero_tenant_id, asset)
-
-adds a fixed asset
-
-Adds an asset to the system
-
-### 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]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
-asset = { "assetName":"Computer74863", "assetNumber":"123477544", "purchaseDate":"2020-01-01", "purchasePrice":100.0, "disposalPrice":23.23, "assetStatus":"Draft", "bookDepreciationSetting":{ "depreciationMethod":"StraightLine", "averagingMethod":"ActualDays", "depreciationRate":0.5, "depreciationCalculationMethod":"None" }, "bookDepreciationDetail":{ "currentCapitalGain":5.32, "currentGainLoss":3.88, "depreciationStartDate":"2020-01-02", "costLimit":100.0, "currentAccumDepreciationAmount":2.25 }, "AccountingBookValue":99.5 } # Asset | Fixed asset you are creating
-begin
-  #adds a fixed asset
-  result = api_instance.create_asset(xero_tenant_id, asset)
-  p result
-rescue XeroRuby::Assets::ApiError => e
-  puts "Exception when calling AssetApi->create_asset: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **asset** | [**Asset**](Asset.md)| Fixed asset you are creating | 
-
-### Return type
-
-[**Asset**](Asset.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## create_asset_type
-
-> AssetType create_asset_type(xero_tenant_id, opts)
-
-adds a fixed asset type
-
-Adds an fixed asset type to the system
-
-### 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]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
-opts = {
-  asset_type: { "assetTypeName":"Machinery11004", "fixedAssetAccountId":"3d8d063a-c148-4bb8-8b3c-a5e2ad3b1e82", "depreciationExpenseAccountId":"d1602f69-f900-4616-8d34-90af393fa368", "accumulatedDepreciationAccountId":"9195cadd-8645-41e6-9f67-7bcd421defe8", "bookDepreciationSetting":{ "depreciationMethod":"DiminishingValue100", "averagingMethod":"ActualDays", "depreciationRate":0.05, "depreciationCalculationMethod":"None" } } # AssetType | Asset type to add
-}
-
-begin
-  #adds a fixed asset type
-  result = api_instance.create_asset_type(xero_tenant_id, opts)
-  p result
-rescue XeroRuby::Assets::ApiError => e
-  puts "Exception when calling AssetApi->create_asset_type: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **asset_type** | [**AssetType**](AssetType.md)| Asset type to add | [optional] 
-
-### Return type
-
-[**AssetType**](AssetType.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## get_asset_by_id
-
-> Asset get_asset_by_id(xero_tenant_id, id)
-
-retrieves fixed asset by id
-
-By passing in the appropriate asset id, you can search for a specific fixed asset in the system 
-
-### 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]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
-id = '4f7bcdcb-5ec1-4258-9558-19f662fccdfe' # String | fixed asset id for single object
-begin
-  #retrieves fixed asset by id
-  result = api_instance.get_asset_by_id(xero_tenant_id, id)
-  p result
-rescue XeroRuby::Assets::ApiError => e
-  puts "Exception when calling AssetApi->get_asset_by_id: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **id** | [**String**](.md)| fixed asset id for single object | 
-
-### Return type
-
-[**Asset**](Asset.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_asset_settings
-
-> Setting get_asset_settings(xero_tenant_id)
-
-searches fixed asset settings
-
-By passing in the appropriate options, you can search for available fixed asset types in the system
-
-### 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]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
-begin
-  #searches fixed asset settings
-  result = api_instance.get_asset_settings(xero_tenant_id)
-  p result
-rescue XeroRuby::Assets::ApiError => e
-  puts "Exception when calling AssetApi->get_asset_settings: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
-
-### Return type
-
-[**Setting**](Setting.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_asset_types
-
-> Array&lt;AssetType&gt; get_asset_types(xero_tenant_id)
-
-searches fixed asset types
-
-By passing in the appropriate options, you can search for available fixed asset types in the system
-
-### 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]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
-begin
-  #searches fixed asset types
-  result = api_instance.get_asset_types(xero_tenant_id)
-  p result
-rescue XeroRuby::Assets::ApiError => e
-  puts "Exception when calling AssetApi->get_asset_types: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
-
-### Return type
-
-[**Array&lt;AssetType&gt;**](AssetType.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_assets
-
-> Assets get_assets(xero_tenant_id, status, opts)
-
-searches fixed asset
-
-By passing in the appropriate options, you can search for available fixed asset in the system
-
-### 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]
-
-api_instance = xero_client.<api_set>
-
-
-
-xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
-status = XeroRuby::Assets::AssetStatusQueryParam.new # AssetStatusQueryParam | Required when retrieving a collection of assets. See Asset Status Codes
-opts = {
-  page: 1, # Integer | Results are paged. This specifies which page of the results to return. The default page is 1.
-
-  page_size: 5, # Integer | The number of records returned per page. By default the number of records returned is 10.
-
-  order_by: 'AssetName', # String | Requests can be ordered by AssetType, AssetName, AssetNumber, PurchaseDate and PurchasePrice. If the asset status is DISPOSED it also allows DisposalDate and DisposalPrice.
-
-  sort_direction: 'ASC', # String | ASC or DESC
-
-  filter_by: 'Draft' # String | A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields.
-}
-
-begin
-  #searches fixed asset
-  result = api_instance.get_assets(xero_tenant_id, status, opts)
-  p result
-rescue XeroRuby::Assets::ApiError => e
-  puts "Exception when calling AssetApi->get_assets: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **status** | [**AssetStatusQueryParam**](.md)| Required when retrieving a collection of assets. See Asset Status Codes | 
- **page** | **Integer**| Results are paged. This specifies which page of the results to return. The default page is 1. | [optional] 
- **page_size** | **Integer**| The number of records returned per page. By default the number of records returned is 10. | [optional] 
- **order_by** | **String**| Requests can be ordered by AssetType, AssetName, AssetNumber, PurchaseDate and PurchasePrice. If the asset status is DISPOSED it also allows DisposalDate and DisposalPrice. | [optional] 
- **sort_direction** | **String**| ASC or DESC | [optional] 
- **filter_by** | **String**| A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields. | [optional] 
-
-### Return type
-
-[**Assets**](Assets.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-