xero-ruby 0.2.3 → 1.2.0

data/docs/{CurrencyCode.md → assets/AssetStatus.md}

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

data/docs/assets/AssetStatusQueryParam.md

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

data/docs/assets/AssetType.md

@@ -0,0 +1,29 @@
+# XeroRuby::Assets::AssetType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**asset_type_id** | **String** | Xero generated unique identifier for asset types | [optional] 
+**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

@@ -0,0 +1,19 @@
+# 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

@@ -0,0 +1,29 @@
+# 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

@@ -0,0 +1,31 @@
+# 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

@@ -0,0 +1,25 @@
+# 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

@@ -0,0 +1,27 @@
+# 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

@@ -0,0 +1,23 @@
+# 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)
+```
+
+

data/docs/assets/ResourceValidationErrorsElement.md

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

data/docs/assets/Setting.md

@@ -0,0 +1,31 @@
+# XeroRuby::Assets::Setting
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**asset_number_prefix** | **String** | The prefix used for fixed asset numbers (“FA-” by default) | [optional] 
+**asset_number_sequence** | **String** | The next available sequence number | [optional] 
+**asset_start_date** | **Date** | The date depreciation calculations started on registered fixed assets in Xero | [optional] 
+**last_depreciation_date** | **Date** | The last depreciation date | [optional] 
+**default_gain_on_disposal_account_id** | **String** | Default account that gains are posted to | [optional] 
+**default_loss_on_disposal_account_id** | **String** | Default account that losses are posted to | [optional] 
+**default_capital_gain_on_disposal_account_id** | **String** | Default account that capital gains are posted to | [optional] 
+**opt_in_for_tax** | **Boolean** | opt in for tax calculation | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Assets'
+
+instance = XeroRuby::Assets::Setting.new(asset_number_prefix: FA-,
+                                 asset_number_sequence: 0022,
+                                 asset_start_date: null,
+                                 last_depreciation_date: null,
+                                 default_gain_on_disposal_account_id: 346ddb97-739a-4274-b43b-66aa3218d17c,
+                                 default_loss_on_disposal_account_id: 1b798541-24e2-4855-9309-c023a0b576f3,
+                                 default_capital_gain_on_disposal_account_id: 6d6a0bdb-e118-45d8-a023-2ad617ec1cb7,
+                                 opt_in_for_tax: false)
+```
+
+

data/docs/projects/Amount.md

@@ -0,0 +1,19 @@
+# XeroRuby::Projects::Amount
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency** | [**CurrencyCode**](CurrencyCode.md) |  | [optional] 
+**value** | **Float** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Projects'
+
+instance = XeroRuby::Projects::Amount.new(currency: null,
+                                 value: 1.0)
+```
+
+

data/docs/{AccountType.md → projects/ChargeType.md}

@@ -1,4 +1,4 @@
-# XeroRuby::AccountType
+# XeroRuby::Projects::ChargeType
 
 ## Properties
 
@@ -8,9 +8,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'XeroRuby'
+require 'XeroRuby::Projects'
 
-instance = XeroRuby::AccountType.new()
+instance = XeroRuby::Projects::ChargeType.new()
 ```
 
 

data/docs/{CountryCode.md → projects/CurrencyCode.md}

@@ -1,4 +1,4 @@
-# XeroRuby::CountryCode
+# XeroRuby::Projects::CurrencyCode
 
 ## Properties
 
@@ -8,9 +8,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'XeroRuby'
+require 'XeroRuby::Projects'
 
-instance = XeroRuby::CountryCode.new()
+instance = XeroRuby::Projects::CurrencyCode.new()
 ```
 
 

data/docs/projects/Error.md

@@ -0,0 +1,19 @@
+# XeroRuby::Projects::Error
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** | Exception message | [optional] 
+**model_state** | [**Object**](.md) | Array of Elements of validation Errors | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Projects'
+
+instance = XeroRuby::Projects::Error.new(message: null,
+                                 model_state: null)
+```
+
+

data/docs/projects/Pagination.md

@@ -0,0 +1,23 @@
+# XeroRuby::Projects::Pagination
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page** | **Integer** | Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. | [optional] 
+**page_size** | **Integer** | Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. | [optional] 
+**page_count** | **Integer** | Number of pages available | [optional] 
+**item_count** | **Integer** | Number of items returned | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Projects'
+
+instance = XeroRuby::Projects::Pagination.new(page: 1,
+                                 page_size: 10,
+                                 page_count: 1,
+                                 item_count: 2)
+```
+
+

data/docs/projects/Project.md

@@ -0,0 +1,59 @@
+# XeroRuby::Projects::Project
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**project_id** | **String** | Identifier of the project. | [optional] 
+**contact_id** | **String** | Identifier of the contact this project was created for. | [optional] 
+**name** | **String** | Name of the project. | 
+**currency_code** | [**CurrencyCode**](CurrencyCode.md) |  | [optional] 
+**minutes_logged** | **Integer** | A total of minutes logged against all tasks on the Project. | [optional] 
+**total_task_amount** | [**Amount**](Amount.md) |  | [optional] 
+**total_expense_amount** | [**Amount**](Amount.md) |  | [optional] 
+**estimate_amount** | [**Amount**](Amount.md) |  | [optional] 
+**minutes_to_be_invoiced** | **Integer** | Minutes which have not been invoiced across all chargeable tasks in the project. | [optional] 
+**task_amount_to_be_invoiced** | [**Amount**](Amount.md) |  | [optional] 
+**task_amount_invoiced** | [**Amount**](Amount.md) |  | [optional] 
+**expense_amount_to_be_invoiced** | [**Amount**](Amount.md) |  | [optional] 
+**expense_amount_invoiced** | [**Amount**](Amount.md) |  | [optional] 
+**project_amount_invoiced** | [**Amount**](Amount.md) |  | [optional] 
+**deposit** | [**Amount**](Amount.md) |  | [optional] 
+**deposit_applied** | [**Amount**](Amount.md) |  | [optional] 
+**credit_note_amount** | [**Amount**](Amount.md) |  | [optional] 
+**deadline_utc** | **DateTime** | Deadline for the project. UTC Date Time in ISO-8601 format. | [optional] 
+**total_invoiced** | [**Amount**](Amount.md) |  | [optional] 
+**total_to_be_invoiced** | [**Amount**](Amount.md) |  | [optional] 
+**estimate** | [**Amount**](Amount.md) |  | [optional] 
+**status** | [**ProjectStatus**](ProjectStatus.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Projects'
+
+instance = XeroRuby::Projects::Project.new(project_id: 254553fa-2be8-4991-bd5e-70a97ea12ef8,
+                                 contact_id: 01234567-89ab-cdef-0123-456789abcdef,
+                                 name: New Kitchen,
+                                 currency_code: null,
+                                 minutes_logged: 0,
+                                 total_task_amount: null,
+                                 total_expense_amount: null,
+                                 estimate_amount: null,
+                                 minutes_to_be_invoiced: 0,
+                                 task_amount_to_be_invoiced: null,
+                                 task_amount_invoiced: null,
+                                 expense_amount_to_be_invoiced: null,
+                                 expense_amount_invoiced: null,
+                                 project_amount_invoiced: null,
+                                 deposit: null,
+                                 deposit_applied: null,
+                                 credit_note_amount: null,
+                                 deadline_utc: 2019-12-10T12:59:59Z,
+                                 total_invoiced: null,
+                                 total_to_be_invoiced: null,
+                                 estimate: null,
+                                 status: null)
+```
+
+