xero-ruby 1.1.0 → 5.0.0

data/docs/assets/Asset.md

@@ -1,45 +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** | **Float** | The purchase price of the asset | [optional] 
-**disposal_price** | **Float** | 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** | **Float** | 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_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,414 +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)
-
-# If using the Accounting API
-api_instance = xero_client.accounting_api
-# Or for methods in the Assets API
-api_instance = xero_client.asset_api
-
-xero_tenant_id = 'xero_tenant_id_example' # 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)
-
-# If using the Accounting API
-api_instance = xero_client.accounting_api
-# Or for methods in the Assets API
-api_instance = xero_client.asset_api
-
-xero_tenant_id = 'xero_tenant_id_example' # 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)
-
-# If using the Accounting API
-api_instance = xero_client.accounting_api
-# Or for methods in the Assets API
-api_instance = xero_client.asset_api
-
-xero_tenant_id = 'xero_tenant_id_example' # 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)
-
-# If using the Accounting API
-api_instance = xero_client.accounting_api
-# Or for methods in the Assets API
-api_instance = xero_client.asset_api
-
-xero_tenant_id = 'xero_tenant_id_example' # 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<AssetType> 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)
-
-# If using the Accounting API
-api_instance = xero_client.accounting_api
-# Or for methods in the Assets API
-api_instance = xero_client.asset_api
-
-xero_tenant_id = 'xero_tenant_id_example' # 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<AssetType>**](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)
-
-# If using the Accounting API
-api_instance = xero_client.accounting_api
-# Or for methods in the Assets API
-api_instance = xero_client.asset_api
-
-xero_tenant_id = 'xero_tenant_id_example' # 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
-

data/docs/assets/AssetStatus.md

@@ -1,16 +0,0 @@
-# XeroRuby::Assets::AssetStatus
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Assets'
-
-instance = XeroRuby::Assets::AssetStatus.new()
-```
-
-

data/docs/assets/AssetStatusQueryParam.md

@@ -1,16 +0,0 @@
-# XeroRuby::Assets::AssetStatusQueryParam
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Assets'
-
-instance = XeroRuby::Assets::AssetStatusQueryParam.new()
-```
-
-

data/docs/assets/AssetType.md

@@ -1,29 +0,0 @@
-# XeroRuby::Assets::AssetType
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**asset_type_id** | **String** | Xero generated unique identifier for asset types | 
-**asset_type_name** | **String** | The name of the asset type | 
-**fixed_asset_account_id** | **String** | The asset account for fixed assets of this type | [optional] 
-**depreciation_expense_account_id** | **String** | The expense account for the depreciation of fixed assets of this type | [optional] 
-**accumulated_depreciation_account_id** | **String** | The account for accumulated depreciation of fixed assets of this type | [optional] 
-**book_depreciation_setting** | [**BookDepreciationSetting**](BookDepreciationSetting.md) |  | 
-**locks** | **Integer** | All asset types that have accumulated depreciation for any assets that use them are deemed ‘locked’ and cannot be removed. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Assets'
-
-instance = XeroRuby::Assets::AssetType.new(asset_type_id: 5da209c5-5e19-4a43-b925-71b776c49ced,
-                                 asset_type_name: Computer Equipment,
-                                 fixed_asset_account_id: 24e260f1-bfc4-4766-ad7f-8a8ce01de879,
-                                 depreciation_expense_account_id: b23fc79b-d66b-44b0-a240-e138e086fcbc,
-                                 accumulated_depreciation_account_id: ca4c6b39-4f4f-43e8-98da-5e1f350a6694,
-                                 book_depreciation_setting: null,
-                                 locks: 33)
-```
-
-

data/docs/assets/Assets.md

@@ -1,19 +0,0 @@
-# XeroRuby::Assets::Assets
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
-**items** | [**Array<Asset>**](Asset.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Assets'
-
-instance = XeroRuby::Assets::Assets.new(pagination: null,
-                                 items: null)
-```
-
-

data/docs/assets/BookDepreciationDetail.md

@@ -1,29 +0,0 @@
-# XeroRuby::Assets::BookDepreciationDetail
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**current_capital_gain** | **Float** | When an asset is disposed, this will be the sell price minus the purchase price if a profit was made. | [optional] 
-**current_gain_loss** | **Float** | When an asset is disposed, this will be the lowest one of sell price or purchase price, minus the current book value. | [optional] 
-**depreciation_start_date** | **Date** | YYYY-MM-DD | [optional] 
-**cost_limit** | **Float** | The value of the asset you want to depreciate, if this is less than the cost of the asset. | [optional] 
-**residual_value** | **Float** | The value of the asset remaining when you've fully depreciated it. | [optional] 
-**prior_accum_depreciation_amount** | **Float** | All depreciation prior to the current financial year. | [optional] 
-**current_accum_depreciation_amount** | **Float** | All depreciation occurring in the current financial year. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Assets'
-
-instance = XeroRuby::Assets::BookDepreciationDetail.new(current_capital_gain: 5.25,
-                                 current_gain_loss: 10.5,
-                                 depreciation_start_date: null,
-                                 cost_limit: 9000.0,
-                                 residual_value: 10000.0,
-                                 prior_accum_depreciation_amount: 0.45,
-                                 current_accum_depreciation_amount: 5.0)
-```
-
-

data/docs/assets/BookDepreciationSetting.md

@@ -1,31 +0,0 @@
-# XeroRuby::Assets::BookDepreciationSetting
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**depreciation_method** | **String** | The method of depreciation applied to this asset. See Depreciation Methods | [optional] 
-**averaging_method** | **String** | The method of averaging applied to this asset. See Averaging Methods | [optional] 
-**depreciation_rate** | **Float** | The rate of depreciation (e.g. 0.05) | [optional] 
-**effective_life_years** | **Integer** | Effective life of the asset in years (e.g. 5) | [optional] 
-**depreciation_calculation_method** | **String** | See Depreciation Calculation Methods | [optional] 
-**depreciable_object_id** | **String** | Unique Xero identifier for the depreciable object | [optional] 
-**depreciable_object_type** | **String** | The type of asset object | [optional] 
-**book_effective_date_of_change_id** | **String** | Unique Xero identifier for the effective date change | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Assets'
-
-instance = XeroRuby::Assets::BookDepreciationSetting.new(depreciation_method: StraightLine,
-                                 averaging_method: ActualDays,
-                                 depreciation_rate: 0.05,
-                                 effective_life_years: 5,
-                                 depreciation_calculation_method: None,
-                                 depreciable_object_id: 68f17094-af97-4f1b-b36b-013b45b6ad3c,
-                                 depreciable_object_type: Asset,
-                                 book_effective_date_of_change_id: 68f17094-af97-4f1b-b36b-013b45b6ad3c)
-```
-
-

data/docs/assets/Error.md

@@ -1,25 +0,0 @@
-# XeroRuby::Assets::Error
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**resource_validation_errors** | [**Array<ResourceValidationErrorsElement>**](ResourceValidationErrorsElement.md) | Array of elements of resource validation errors | [optional] 
-**field_validation_errors** | [**Array<FieldValidationErrorsElement>**](FieldValidationErrorsElement.md) | Array of elements of field validation errors | [optional] 
-**type** | **String** | The internal type of error, not accessible externally | [optional] 
-**title** | **String** | Title of the error | [optional] 
-**detail** | **String** | Detail of the error | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Assets'
-
-instance = XeroRuby::Assets::Error.new(resource_validation_errors: null,
-                                 field_validation_errors: null,
-                                 type: null,
-                                 title: null,
-                                 detail: null)
-```
-
-

data/docs/assets/FieldValidationErrorsElement.md

@@ -1,27 +0,0 @@
-# XeroRuby::Assets::FieldValidationErrorsElement
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**field_name** | **String** | The field name of the erroneous field | [optional] 
-**value_provided** | **String** | The provided value | [optional] 
-**localised_message** | **String** | Explaination of the field validation error | [optional] 
-**type** | **String** | Internal type of the field validation error message | [optional] 
-**title** | **String** | Title of the field validation error | [optional] 
-**detail** | **String** | Detail of the field validation error | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Assets'
-
-instance = XeroRuby::Assets::FieldValidationErrorsElement.new(field_name: null,
-                                 value_provided: null,
-                                 localised_message: null,
-                                 type: null,
-                                 title: null,
-                                 detail: null)
-```
-
-

data/docs/assets/Pagination.md

@@ -1,23 +0,0 @@
-# XeroRuby::Assets::Pagination
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**page** | **Integer** |  | [optional] 
-**page_size** | **Integer** |  | [optional] 
-**page_count** | **Integer** |  | [optional] 
-**item_count** | **Integer** |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::Assets'
-
-instance = XeroRuby::Assets::Pagination.new(page: 1,
-                                 page_size: 10,
-                                 page_count: 1,
-                                 item_count: 2)
-```
-
-