xero-ruby 2.5.0 → 2.5.1

data/docs/payroll_uk/TimesheetEarningsLine.md

@@ -1,27 +0,0 @@
-# XeroRuby::PayrollUk::TimesheetEarningsLine
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**earnings_rate_id** | **String** | Xero identifier for payroll timesheet earnings rate | [optional] 
-**rate_per_unit** | **Float** | Rate per unit for timesheet earnings line | [optional] 
-**number_of_units** | **Float** | Timesheet earnings number of units | [optional] 
-**fixed_amount** | **Float** | Timesheet earnings fixed amount. Only applicable if the EarningsRate RateType is Fixed | [optional] 
-**amount** | **Float** | The amount of the timesheet earnings line. | [optional] 
-**is_linked_to_timesheet** | **Boolean** | Identifies if the timesheet earnings is taken from the timesheet. False for leave earnings line | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::TimesheetEarningsLine.new(earnings_rate_id: null,
-                                 rate_per_unit: null,
-                                 number_of_units: null,
-                                 fixed_amount: null,
-                                 amount: null,
-                                 is_linked_to_timesheet: null)
-```
-
-

data/docs/payroll_uk/TimesheetLine.md

@@ -1,25 +0,0 @@
-# XeroRuby::PayrollUk::TimesheetLine
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**timesheet_line_id** | **String** | The Xero identifier for a Timesheet Line | [optional] 
-**date** | **Date** | The Date that this Timesheet Line is for (YYYY-MM-DD) | 
-**earnings_rate_id** | **String** | The Xero identifier for the Earnings Rate that the Timesheet is for | 
-**tracking_item_id** | **String** | The Xero identifier for the Tracking Item that the Timesheet is for | [optional] 
-**number_of_units** | **Float** | The Number of Units of the Timesheet Line | 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::TimesheetLine.new(timesheet_line_id: null,
-                                 date: null,
-                                 earnings_rate_id: null,
-                                 tracking_item_id: null,
-                                 number_of_units: null)
-```
-
-

data/docs/payroll_uk/TimesheetLineObject.md

@@ -1,21 +0,0 @@
-# XeroRuby::PayrollUk::TimesheetLineObject
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
-**problem** | [**Problem**](Problem.md) |  | [optional] 
-**timesheet_line** | [**TimesheetLine**](TimesheetLine.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::TimesheetLineObject.new(pagination: null,
-                                 problem: null,
-                                 timesheet_line: null)
-```
-
-

data/docs/payroll_uk/TimesheetObject.md

@@ -1,21 +0,0 @@
-# XeroRuby::PayrollUk::TimesheetObject
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
-**problem** | [**Problem**](Problem.md) |  | [optional] 
-**timesheet** | [**Timesheet**](Timesheet.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::TimesheetObject.new(pagination: null,
-                                 problem: null,
-                                 timesheet: null)
-```
-
-

data/docs/payroll_uk/Timesheets.md

@@ -1,21 +0,0 @@
-# XeroRuby::PayrollUk::Timesheets
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
-**problem** | [**Problem**](Problem.md) |  | [optional] 
-**timesheets** | [**Array<Timesheet>**](Timesheet.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::Timesheets.new(pagination: null,
-                                 problem: null,
-                                 timesheets: null)
-```
-
-

data/docs/payroll_uk/TrackingCategories.md

@@ -1,21 +0,0 @@
-# XeroRuby::PayrollUk::TrackingCategories
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
-**problem** | [**Problem**](Problem.md) |  | [optional] 
-**tracking_categories** | [**TrackingCategory**](TrackingCategory.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::TrackingCategories.new(pagination: null,
-                                 problem: null,
-                                 tracking_categories: null)
-```
-
-

data/docs/payroll_uk/TrackingCategory.md

@@ -1,19 +0,0 @@
-# XeroRuby::PayrollUk::TrackingCategory
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**employee_groups_tracking_category_id** | **String** | The Xero identifier for Employee groups tracking category. | [optional] 
-**timesheet_tracking_category_id** | **String** | The Xero identifier for Timesheet tracking category. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'XeroRuby::PayrollUk'
-
-instance = XeroRuby::PayrollUk::TrackingCategory.new(employee_groups_tracking_category_id: null,
-                                 timesheet_tracking_category_id: null)
-```
-
-

data/docs/projects/Amount.md

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

data/docs/projects/ChargeType.md

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

data/docs/projects/CurrencyCode.md

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

data/docs/projects/Error.md

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

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

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

data/docs/projects/ProjectApi.md

@@ -1,956 +0,0 @@
-# XeroRuby::Projects::ProjectApi
-
-All URIs are relative to *https://api.xero.com/projects.xro/2.0*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create_project**](ProjectApi.md#create_project) | **POST** /projects | create one or more new projects
-[**create_time_entry**](ProjectApi.md#create_time_entry) | **POST** /projects/{projectId}/time | Allows you to create a task
-[**delete_time_entry**](ProjectApi.md#delete_time_entry) | **DELETE** /projects/{projectId}/time/{timeEntryId} | Allows you to delete a time entry
-[**get_project**](ProjectApi.md#get_project) | **GET** /projects/{projectId} | Allows you to retrieve a single project
-[**get_project_users**](ProjectApi.md#get_project_users) | **GET** /projectsusers | list all project users
-[**get_projects**](ProjectApi.md#get_projects) | **GET** /projects | list all projects
-[**get_task**](ProjectApi.md#get_task) | **GET** /projects/{projectId}/tasks/{taskId} | Allows you to retrieve a single project
-[**get_tasks**](ProjectApi.md#get_tasks) | **GET** /projects/{projectId}/tasks | Allows you to retrieve a single project
-[**get_time_entries**](ProjectApi.md#get_time_entries) | **GET** /projects/{projectId}/time | Allows you to retrieve the time entries associated with a specific project
-[**get_time_entry**](ProjectApi.md#get_time_entry) | **GET** /projects/{projectId}/time/{timeEntryId} | Allows you to get a single time entry in a project
-[**patch_project**](ProjectApi.md#patch_project) | **PATCH** /projects/{projectId} | creates a project for the specified contact
-[**update_project**](ProjectApi.md#update_project) | **PUT** /projects/{projectId} | update a specific project
-[**update_time_entry**](ProjectApi.md#update_time_entry) | **PUT** /projects/{projectId}/time/{timeEntryId} | Allows you to update time entry in a project
-
-
-
-## create_project
-
-> Project create_project(xero_tenant_id, project_create_or_update)
-
-create one or more new projects
-
-### 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 = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-project_create_or_update = { "contactId":"00000000-0000-0000-000-000000000000", "name":"New Kitchen", "deadlineUtc":"2019-12-10T12:59:59Z", "estimateAmount":"99.99" } # ProjectCreateOrUpdate | Create a new project with ProjectCreateOrUpdate object
-begin
-  #create one or more new projects
-  result = api_instance.create_project(xero_tenant_id, project_create_or_update)
-  p result
-rescue XeroRuby::Projects::ApiError => e
-  puts "Exception when calling ProjectApi->create_project: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **project_create_or_update** | [**ProjectCreateOrUpdate**](ProjectCreateOrUpdate.md)| Create a new project with ProjectCreateOrUpdate object | 
-
-### Return type
-
-[**Project**](Project.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## create_time_entry
-
-> TimeEntry create_time_entry(xero_tenant_id, project_id, time_entry_create_or_update)
-
-Allows you to create a task
-
-Allows you to create a specific task
-
-### 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 = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint
-time_entry_create_or_update = { "userId":"740add2a-a703-4b8a-a670-1093919c2040", "taskId":"7be77337-feec-4458-bb1b-dbaa5a4aafce", "dateUtc":"2020-02-26T15:00:00Z", "duration":30, "description":"My description" } # TimeEntryCreateOrUpdate | The time entry object you are creating
-begin
-  #Allows you to create a task
-  result = api_instance.create_time_entry(xero_tenant_id, project_id, time_entry_create_or_update)
-  p result
-rescue XeroRuby::Projects::ApiError => e
-  puts "Exception when calling ProjectApi->create_time_entry: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint | 
- **time_entry_create_or_update** | [**TimeEntryCreateOrUpdate**](TimeEntryCreateOrUpdate.md)| The time entry object you are creating | 
-
-### Return type
-
-[**TimeEntry**](TimeEntry.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## delete_time_entry
-
-> delete_time_entry(xero_tenant_id, project_id, time_entry_id)
-
-Allows you to delete a time entry
-
-Allows you to delete a specific time entry
-
-### 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 = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint
-time_entry_id = 'time_entry_id_example' # String | You can specify an individual task by appending the id to the endpoint
-begin
-  #Allows you to delete a time entry
-  api_instance.delete_time_entry(xero_tenant_id, project_id, time_entry_id)
-rescue XeroRuby::Projects::ApiError => e
-  puts "Exception when calling ProjectApi->delete_time_entry: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint | 
- **time_entry_id** | [**String**](.md)| You can specify an individual task by appending the id to the endpoint | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: Not defined
-
-
-## get_project
-
-> Project get_project(xero_tenant_id, project_id)
-
-Allows you to retrieve a single project
-
-Allows you to retrieve a specific project
-
-### 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 = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint
-begin
-  #Allows you to retrieve a single project
-  result = api_instance.get_project(xero_tenant_id, project_id)
-  p result
-rescue XeroRuby::Projects::ApiError => e
-  puts "Exception when calling ProjectApi->get_project: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint | 
-
-### Return type
-
-[**Project**](Project.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_project_users
-
-> ProjectUsers get_project_users(xero_tenant_id, opts)
-
-list all project users
-
-Allows you to retrieve the users on a projects.
-
-### 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 = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-opts = {
-  page: 1, # Integer | set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0.
-
-  page_size: 50 # 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.
-}
-
-begin
-  #list all project users
-  result = api_instance.get_project_users(xero_tenant_id, opts)
-  p result
-rescue XeroRuby::Projects::ApiError => e
-  puts "Exception when calling ProjectApi->get_project_users: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **page** | **Integer**| set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. | [optional] [default to 1]
- **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] [default to 50]
-
-### Return type
-
-[**ProjectUsers**](ProjectUsers.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_projects
-
-> Projects get_projects(xero_tenant_id, opts)
-
-list all projects
-
-Allows you to retrieve, create and update projects.
-
-### 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 = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-opts = {
-  project_ids: ['project_ids_example'], # Array<String> | Search for all projects that match a comma separated list of projectIds
-
-  contact_id: 'contact_id_example', # String | Filter for projects for a specific contact
-
-  states: 'states_example', # String | Filter for projects in a particular state (INPROGRESS or CLOSED)
-
-  page: 1, # Integer | set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0.
-
-  page_size: 50 # 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.
-}
-
-begin
-  #list all projects
-  result = api_instance.get_projects(xero_tenant_id, opts)
-  p result
-rescue XeroRuby::Projects::ApiError => e
-  puts "Exception when calling ProjectApi->get_projects: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **project_ids** | [**Array&lt;String&gt;**](String.md)| Search for all projects that match a comma separated list of projectIds | [optional] 
- **contact_id** | [**String**](.md)| Filter for projects for a specific contact | [optional] 
- **states** | **String**| Filter for projects in a particular state (INPROGRESS or CLOSED) | [optional] 
- **page** | **Integer**| set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. | [optional] [default to 1]
- **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] [default to 50]
-
-### Return type
-
-[**Projects**](Projects.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_task
-
-> Task get_task(xero_tenant_id, project_id, task_id)
-
-Allows you to retrieve a single project
-
-Allows you to retrieve a specific project
-
-### 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 = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint
-task_id = 'task_id_example' # String | You can specify an individual task by appending the taskId to the endpoint, i.e. GET https://.../tasks/{taskId}
-begin
-  #Allows you to retrieve a single project
-  result = api_instance.get_task(xero_tenant_id, project_id, task_id)
-  p result
-rescue XeroRuby::Projects::ApiError => e
-  puts "Exception when calling ProjectApi->get_task: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint | 
- **task_id** | [**String**](.md)| You can specify an individual task by appending the taskId to the endpoint, i.e. GET https://.../tasks/{taskId} | 
-
-### Return type
-
-[**Task**](Task.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_tasks
-
-> Tasks get_tasks(xero_tenant_id, project_id, opts)
-
-Allows you to retrieve a single project
-
-Allows you to retrieve a specific project
-
-### 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 = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint
-opts = {
-  page: 1, # Integer | Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0.
-
-  page_size: 10, # 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.
-
-  task_ids: 'task_ids_example', # String | taskIdsSearch for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskId},{taskId}
-
-  charge_type: XeroRuby::Projects::ChargeType.new # ChargeType | 
-}
-
-begin
-  #Allows you to retrieve a single project
-  result = api_instance.get_tasks(xero_tenant_id, project_id, opts)
-  p result
-rescue XeroRuby::Projects::ApiError => e
-  puts "Exception when calling ProjectApi->get_tasks: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint | 
- **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] 
- **task_ids** | **String**| taskIdsSearch for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds&#x3D;{taskId},{taskId} | [optional] 
- **charge_type** | [**ChargeType**](.md)|  | [optional] 
-
-### Return type
-
-[**Tasks**](Tasks.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_time_entries
-
-> TimeEntries get_time_entries(xero_tenant_id, project_id, opts)
-
-Allows you to retrieve the time entries associated with a specific project
-
-Allows you to retrieve the time entries associated with a specific project
-
-### 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 = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-project_id = 'project_id_example' # String | Identifier of the project, that the task (which the time entry is logged against) belongs to.
-opts = {
-  user_id: 'user_id_example', # String | The xero user identifier of the person who logged time.
-
-  task_id: 'task_id_example', # String | Identifier of the task that time entry is logged against.
-
-  invoice_id: 'invoice_id_example', # String | Finds all time entries for this invoice.
-
-  contact_id: 'contact_id_example', # String | Finds all time entries for this contact identifier.
-
-  page: 1, # Integer | Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0.
-
-  page_size: 10, # 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.
-
-  states: ['states_example'], # Array<String> | Comma-separated list of states to find. Will find all time entries that are in the status of whatever’s specified.
-
-  is_chargeable: true, # Boolean | Finds all time entries which relate to tasks with the charge type `TIME` or `FIXED`.
-
-  date_after_utc: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | ISO 8601 UTC date. Finds all time entries on or after this date filtered on the `dateUtc` field.
-
-  date_before_utc: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | ISO 8601 UTC date. Finds all time entries on or before this date filtered on the `dateUtc` field.
-}
-
-begin
-  #Allows you to retrieve the time entries associated with a specific project
-  result = api_instance.get_time_entries(xero_tenant_id, project_id, opts)
-  p result
-rescue XeroRuby::Projects::ApiError => e
-  puts "Exception when calling ProjectApi->get_time_entries: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **project_id** | [**String**](.md)| Identifier of the project, that the task (which the time entry is logged against) belongs to. | 
- **user_id** | [**String**](.md)| The xero user identifier of the person who logged time. | [optional] 
- **task_id** | [**String**](.md)| Identifier of the task that time entry is logged against. | [optional] 
- **invoice_id** | [**String**](.md)| Finds all time entries for this invoice. | [optional] 
- **contact_id** | [**String**](.md)| Finds all time entries for this contact identifier. | [optional] 
- **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] 
- **states** | [**Array&lt;String&gt;**](String.md)| Comma-separated list of states to find. Will find all time entries that are in the status of whatever’s specified. | [optional] 
- **is_chargeable** | **Boolean**| Finds all time entries which relate to tasks with the charge type &#x60;TIME&#x60; or &#x60;FIXED&#x60;. | [optional] 
- **date_after_utc** | **DateTime**| ISO 8601 UTC date. Finds all time entries on or after this date filtered on the &#x60;dateUtc&#x60; field. | [optional] 
- **date_before_utc** | **DateTime**| ISO 8601 UTC date. Finds all time entries on or before this date filtered on the &#x60;dateUtc&#x60; field. | [optional] 
-
-### Return type
-
-[**TimeEntries**](TimeEntries.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_time_entry
-
-> TimeEntry get_time_entry(xero_tenant_id, project_id, time_entry_id)
-
-Allows you to get a single time entry in a project
-
-Allows you to upget a single time entry in a project
-
-### 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 = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint
-time_entry_id = 'time_entry_id_example' # String | You can specify an individual time entry by appending the id to the endpoint
-begin
-  #Allows you to get a single time entry in a project
-  result = api_instance.get_time_entry(xero_tenant_id, project_id, time_entry_id)
-  p result
-rescue XeroRuby::Projects::ApiError => e
-  puts "Exception when calling ProjectApi->get_time_entry: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint | 
- **time_entry_id** | [**String**](.md)| You can specify an individual time entry by appending the id to the endpoint | 
-
-### Return type
-
-[**TimeEntry**](TimeEntry.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## patch_project
-
-> patch_project(xero_tenant_id, project_id, project_patch)
-
-creates a project for the specified contact
-
-Allows you to update a specific projects.
-
-### 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 = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint
-project_patch = { "status": "INPROGRESS" } # ProjectPatch | Update the status of an existing Project
-begin
-  #creates a project for the specified contact
-  api_instance.patch_project(xero_tenant_id, project_id, project_patch)
-rescue XeroRuby::Projects::ApiError => e
-  puts "Exception when calling ProjectApi->patch_project: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint | 
- **project_patch** | [**ProjectPatch**](ProjectPatch.md)| Update the status of an existing Project | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## update_project
-
-> update_project(xero_tenant_id, project_id, project_create_or_update)
-
-update a specific project
-
-Allows you to update a specific projects.
-
-### 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 = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint
-project_create_or_update = { "name": "New Kitchen", "deadlineUtc": "2017-04-23T18:25:43.511Z", "estimateAmount": 99.99 } # ProjectCreateOrUpdate | Request of type ProjectCreateOrUpdate
-begin
-  #update a specific project
-  api_instance.update_project(xero_tenant_id, project_id, project_create_or_update)
-rescue XeroRuby::Projects::ApiError => e
-  puts "Exception when calling ProjectApi->update_project: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint | 
- **project_create_or_update** | [**ProjectCreateOrUpdate**](ProjectCreateOrUpdate.md)| Request of type ProjectCreateOrUpdate | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## update_time_entry
-
-> update_time_entry(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update)
-
-Allows you to update time entry in a project
-
-Allows you to update time entry in a project
-
-### 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 = 'xero_tenant_id_example' # String | Xero identifier for Tenant
-project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint
-time_entry_id = 'time_entry_id_example' # String | You can specify an individual time entry by appending the id to the endpoint
-time_entry_create_or_update = { "userId":"740add2a-a703-4b8a-a670-1093919c2040", "taskId":"7be77337-feec-4458-bb1b-dbaa5a4aafce", "dateUtc":"2020-02-27T15:00:00Z", "duration":45, "description":"My UPDATED description" } # TimeEntryCreateOrUpdate | The time entry object you are updating
-begin
-  #Allows you to update time entry in a project
-  api_instance.update_time_entry(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update)
-rescue XeroRuby::Projects::ApiError => e
-  puts "Exception when calling ProjectApi->update_time_entry: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint | 
- **time_entry_id** | [**String**](.md)| You can specify an individual time entry by appending the id to the endpoint | 
- **time_entry_create_or_update** | [**TimeEntryCreateOrUpdate**](TimeEntryCreateOrUpdate.md)| The time entry object you are updating | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: Not defined
-