xero-ruby 1.0 → 2.0.3

data/docs/projects/ProjectCreateOrUpdate.md

@@ -0,0 +1,23 @@
+# XeroRuby::Projects::ProjectCreateOrUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contact_id** | **String** | Identifier of the contact this project was created for. | [optional] 
+**name** | **String** | Name of the project. | 
+**estimate_amount** | **Float** |  | [optional] 
+**deadline_utc** | **DateTime** | Deadline for the project. UTC Date Time in ISO-8601 format. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Projects'
+
+instance = XeroRuby::Projects::ProjectCreateOrUpdate.new(contact_id: 01234567-89ab-cdef-0123-456789abcdef,
+                                 name: New Kitchen,
+                                 estimate_amount: 1.0,
+                                 deadline_utc: 2019-12-10T12:59:59Z)
+```
+
+

data/docs/projects/ProjectPatch.md

@@ -0,0 +1,17 @@
+# XeroRuby::Projects::ProjectPatch
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | [**ProjectStatus**](ProjectStatus.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Projects'
+
+instance = XeroRuby::Projects::ProjectPatch.new(status: null)
+```
+
+

data/docs/projects/ProjectStatus.md

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

data/docs/projects/ProjectUser.md

@@ -0,0 +1,21 @@
+# XeroRuby::Projects::ProjectUser
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_id** | **String** | Identifier of the user of the project. | [optional] 
+**name** | **String** | Full name of the user. | [optional] 
+**email** | **String** | Email address of the user. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Projects'
+
+instance = XeroRuby::Projects::ProjectUser.new(user_id: 254553fa-2be8-4991-bd5e-70a97ea12ef8,
+                                 name: Sidney Allen,
+                                 email: sidneyallen@xero.com)
+```
+
+

data/docs/projects/ProjectUsers.md

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

data/docs/projects/Projects.md

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

data/docs/projects/Task.md

@@ -0,0 +1,45 @@
+# XeroRuby::Projects::Task
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**task_id** | **String** | Identifier of the task. | [optional] 
+**name** | **String** | Name of the task. | [optional] 
+**rate** | [**Amount**](Amount.md) |  | [optional] 
+**charge_type** | [**ChargeType**](ChargeType.md) |  | [optional] 
+**estimate_minutes** | **Float** | An estimated time to perform the task | [optional] 
+**project_id** | **String** | Identifier of the project task belongs to. | [optional] 
+**total_minutes** | **Float** | Total minutes which have been logged against the task. Logged by assigning a time entry to a task | [optional] 
+**total_amount** | [**Amount**](Amount.md) |  | [optional] 
+**minutes_invoiced** | **Float** | Minutes on this task which have been invoiced. | [optional] 
+**minutes_to_be_invoiced** | **Float** | Minutes on this task which have not been invoiced. | [optional] 
+**fixed_minutes** | **Float** | Minutes logged against this task if its charge type is `FIXED`. | [optional] 
+**non_chargeable_minutes** | **Float** | Minutes logged against this task if its charge type is `NON_CHARGEABLE`. | [optional] 
+**amount_to_be_invoiced** | [**Amount**](Amount.md) |  | [optional] 
+**amount_invoiced** | [**Amount**](Amount.md) |  | [optional] 
+**status** | **String** | Status of the task. When a task of ChargeType is `FIXED` and the rate amount is invoiced the status will be set to `INVOICED` and can't be modified. A task with ChargeType of `TIME` or `NON_CHARGEABLE` cannot have a status of `INVOICED`. A `LOCKED` state indicates that the task is currently changing state (for example being invoiced) and can't be modified. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Projects'
+
+instance = XeroRuby::Projects::Task.new(task_id: 00000000-0000-0000-0000-000000000000,
+                                 name: null,
+                                 rate: null,
+                                 charge_type: null,
+                                 estimate_minutes: null,
+                                 project_id: 00000000-0000-0000-0000-000000000000,
+                                 total_minutes: null,
+                                 total_amount: null,
+                                 minutes_invoiced: null,
+                                 minutes_to_be_invoiced: null,
+                                 fixed_minutes: null,
+                                 non_chargeable_minutes: null,
+                                 amount_to_be_invoiced: null,
+                                 amount_invoiced: null,
+                                 status: null)
+```
+
+

data/docs/projects/TaskCreateOrUpdate.md

@@ -0,0 +1,23 @@
+# XeroRuby::Projects::TaskCreateOrUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the task. Max length 100 characters. | 
+**rate** | [**Amount**](Amount.md) |  | 
+**charge_type** | [**ChargeType**](ChargeType.md) |  | 
+**estimate_minutes** | **Integer** | Estimated time to perform the task. EstimateMinutes has to be greater than 0 if provided. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Projects'
+
+instance = XeroRuby::Projects::TaskCreateOrUpdate.new(name: null,
+                                 rate: null,
+                                 charge_type: null,
+                                 estimate_minutes: null)
+```
+
+

data/docs/projects/Tasks.md

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

data/docs/projects/TimeEntries.md

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

data/docs/projects/TimeEntry.md

@@ -0,0 +1,33 @@
+# XeroRuby::Projects::TimeEntry
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**time_entry_id** | **String** | Identifier of the time entry. | [optional] 
+**user_id** | **String** | The xero user identifier of the person who logged time. | [optional] 
+**project_id** | **String** | Identifier of the project, that the task (which the time entry is logged against) belongs to. | [optional] 
+**task_id** | **String** | Identifier of the task that time entry is logged against. | [optional] 
+**date_utc** | **DateTime** | The date time that time entry is logged on. UTC Date Time in ISO-8601 format. | [optional] 
+**date_entered_utc** | **DateTime** | The date time that time entry is created. UTC Date Time in ISO-8601 format. By default it is set to server time. | [optional] 
+**duration** | **Integer** | The duration of logged minutes. | [optional] 
+**description** | **String** | A description of the time entry. | [optional] 
+**status** | **String** | Status of the time entry. By default a time entry is created with status of `ACTIVE`. A `LOCKED` state indicates that the time entry is currently changing state (for example being invoiced). Updates are not allowed when in this state. It will have a status of INVOICED once it is invoiced. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Projects'
+
+instance = XeroRuby::Projects::TimeEntry.new(time_entry_id: 00000000-0000-0000-0000-000000000000,
+                                 user_id: 00000000-0000-0000-0000-000000000000,
+                                 project_id: 00000000-0000-0000-0000-000000000000,
+                                 task_id: 00000000-0000-0000-0000-000000000000,
+                                 date_utc: null,
+                                 date_entered_utc: null,
+                                 duration: null,
+                                 description: null,
+                                 status: null)
+```
+
+

data/docs/projects/TimeEntryCreateOrUpdate.md

@@ -0,0 +1,25 @@
+# XeroRuby::Projects::TimeEntryCreateOrUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_id** | **String** | The xero user identifier of the person logging the time. | 
+**task_id** | **String** | Identifier of the task that time entry is logged against. | 
+**date_utc** | **DateTime** | Date time entry is logged on. UTC Date Time in ISO-8601 format. | 
+**duration** | **Integer** | Number of minutes to be logged. Duration is between 1 and 59940 inclusively. | 
+**description** | **String** | An optional description of the time entry, will be set to null if not provided during update. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Projects'
+
+instance = XeroRuby::Projects::TimeEntryCreateOrUpdate.new(user_id: 00000000-0000-0000-0000-000000000000,
+                                 task_id: 00000000-0000-0000-0000-000000000000,
+                                 date_utc: null,
+                                 duration: null,
+                                 description: null)
+```
+
+

data/lib/xero-ruby.rb

@@ -3,10 +3,10 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.1.0
+The version of the OpenAPI document: 2.2.11
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -17,6 +17,24 @@ require 'xero-ruby/version'
 require 'xero-ruby/configuration'
 
 # Models
+require 'xero-ruby/models/projects/amount'
+require 'xero-ruby/models/projects/charge_type'
+require 'xero-ruby/models/projects/currency_code'
+require 'xero-ruby/models/projects/error'
+require 'xero-ruby/models/projects/pagination'
+require 'xero-ruby/models/projects/project'
+require 'xero-ruby/models/projects/project_create_or_update'
+require 'xero-ruby/models/projects/project_patch'
+require 'xero-ruby/models/projects/project_status'
+require 'xero-ruby/models/projects/project_user'
+require 'xero-ruby/models/projects/project_users'
+require 'xero-ruby/models/projects/projects'
+require 'xero-ruby/models/projects/task'
+require 'xero-ruby/models/projects/task_create_or_update'
+require 'xero-ruby/models/projects/tasks'
+require 'xero-ruby/models/projects/time_entries'
+require 'xero-ruby/models/projects/time_entry'
+require 'xero-ruby/models/projects/time_entry_create_or_update'
 require 'xero-ruby/models/assets/asset'
 require 'xero-ruby/models/assets/asset_status'
 require 'xero-ruby/models/assets/asset_status_query_param'
@@ -134,7 +152,7 @@ require 'xero-ruby/models/accounting/tax_component'
 require 'xero-ruby/models/accounting/tax_rate'
 require 'xero-ruby/models/accounting/tax_rates'
 require 'xero-ruby/models/accounting/tax_type'
-require 'xero-ruby/models/accounting/ten_nintey_nine_contact'
+require 'xero-ruby/models/accounting/ten_ninety_nine_contact'
 require 'xero-ruby/models/accounting/time_zone'
 require 'xero-ruby/models/accounting/tracking_categories'
 require 'xero-ruby/models/accounting/tracking_category'
@@ -145,6 +163,7 @@ require 'xero-ruby/models/accounting/users'
 require 'xero-ruby/models/accounting/validation_error'
 
 # APIs
+require 'xero-ruby/api/project_api'
 require 'xero-ruby/api/asset_api'
 require 'xero-ruby/api/accounting_api'
 

data/lib/xero-ruby/api/accounting_api.rb

@@ -3,10 +3,10 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.1.0
+The version of the OpenAPI document: 2.2.11
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -16,7 +16,7 @@ module XeroRuby
   class AccountingApi
     attr_accessor :api_client
 
-    def initialize(api_client = ApiClient.default)
+    def initialize(api_client = ApiClient.new)
       @api_client = api_client
     end
     # Allows you to create a new chart of accounts
@@ -169,7 +169,7 @@ module XeroRuby
       return data, status_code, headers
     end
 
-    # Allows you to createa an Attachment on BankTransaction by Filename
+    # Allows you to create an Attachment on BankTransaction by Filename
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param bank_transaction_id [String] Xero generated unique identifier for a bank transaction
     # @param file_name [String] The name of the file being attached
@@ -181,7 +181,7 @@ module XeroRuby
       data
     end
 
-    # Allows you to createa an Attachment on BankTransaction by Filename
+    # Allows you to create an Attachment on BankTransaction by Filename
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param bank_transaction_id [String] Xero generated unique identifier for a bank transaction
     # @param file_name [String] The name of the file being attached
@@ -1218,6 +1218,7 @@ module XeroRuby
     # @param credit_note_id [String] Unique identifier for a Credit Note
     # @param allocations [Allocations] Allocations with array of Allocation object in body of request.
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)
     # @return [Allocations]
     def create_credit_note_allocation(xero_tenant_id, credit_note_id, allocations, opts = {})
       data, _status_code, _headers = create_credit_note_allocation_with_http_info(xero_tenant_id, credit_note_id, allocations, opts)
@@ -1229,6 +1230,7 @@ module XeroRuby
     # @param credit_note_id [String] Unique identifier for a Credit Note
     # @param allocations [Allocations] Allocations with array of Allocation object in body of request.
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created obejcts and any with validation errors
     # @return [Array<(Allocations, Integer, Hash)>] Allocations data, response status code and response headers
     def create_credit_note_allocation_with_http_info(xero_tenant_id, credit_note_id, allocations, opts = {})
       if @api_client.config.debugging
@@ -1251,6 +1253,7 @@ module XeroRuby
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -2781,6 +2784,7 @@ module XeroRuby
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param payments [Payments] Payments array with Payment object in body of request
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)
     # @return [Payments]
     def create_payments(xero_tenant_id, payments, opts = {})
       data, _status_code, _headers = create_payments_with_http_info(xero_tenant_id, payments, opts)
@@ -2791,6 +2795,7 @@ module XeroRuby
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param payments [Payments] Payments array with Payment object in body of request
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created obejcts and any with validation errors
     # @return [Array<(Payments, Integer, Hash)>] Payments data, response status code and response headers
     def create_payments_with_http_info(xero_tenant_id, payments, opts = {})
       if @api_client.config.debugging
@@ -2809,6 +2814,7 @@ module XeroRuby
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -6167,7 +6173,7 @@ module XeroRuby
       return data, status_code, headers
     end
 
-    # Allows you to retrieve, add and update contacts in a Xero organisation
+    # Allows you to retrieve a single contacts in a Xero organisation
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param contact_id [String] Unique identifier for a Contact
     # @param [Hash] opts the optional parameters
@@ -6177,7 +6183,7 @@ module XeroRuby
       data
     end
 
-    # Allows you to retrieve, add and update contacts in a Xero organisation
+    # Allows you to retrieve a single contacts in a Xero organisation
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param contact_id [String] Unique identifier for a Contact
     # @param [Hash] opts the optional parameters
@@ -6461,6 +6467,73 @@ module XeroRuby
       return data, status_code, headers
     end
 
+    # Allows you to retrieve a single contact by Contact Number in a Xero organisation
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param contact_number [String] This field is read only on the Xero contact screen, used to identify contacts in external systems (max length &#x3D; 50).
+    # @param [Hash] opts the optional parameters
+    # @return [Contacts]
+    def get_contact_by_contact_number(xero_tenant_id, contact_number, opts = {})
+      data, _status_code, _headers = get_contact_by_contact_number_with_http_info(xero_tenant_id, contact_number, opts)
+      data
+    end
+
+    # Allows you to retrieve a single contact by Contact Number in a Xero organisation
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param contact_number [String] This field is read only on the Xero contact screen, used to identify contacts in external systems (max length &#x3D; 50).
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Contacts, Integer, Hash)>] Contacts data, response status code and response headers
+    def get_contact_by_contact_number_with_http_info(xero_tenant_id, contact_number, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountingApi.get_contact_by_contact_number ...'
+      end
+      # verify the required parameter 'xero_tenant_id' is set
+      if @api_client.config.client_side_validation && xero_tenant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_contact_by_contact_number"
+      end
+      # verify the required parameter 'contact_number' is set
+      if @api_client.config.client_side_validation && contact_number.nil?
+        fail ArgumentError, "Missing the required parameter 'contact_number' when calling AccountingApi.get_contact_by_contact_number"
+      end
+      # resource path
+      local_var_path = '/Contacts/{ContactNumber}'.sub('{' + 'ContactNumber' + '}', contact_number.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'xero-tenant-id'] = xero_tenant_id
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Contacts' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountingApi#get_contact_by_contact_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Allows you to retrieve CISSettings for a contact in a Xero organisation
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param contact_id [String] Unique identifier for a Contact
@@ -6729,7 +6802,7 @@ module XeroRuby
       return data, status_code, headers
     end
 
-    # Allows you to retrieve, add and update contacts in a Xero organisation
+    # Allows you to retrieve all contacts in a Xero organisation
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param [Hash] opts the optional parameters
     # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned
@@ -6744,7 +6817,7 @@ module XeroRuby
       data
     end
 
-    # Allows you to retrieve, add and update contacts in a Xero organisation
+    # Allows you to retrieve all contacts in a Xero organisation
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param [Hash] opts the optional parameters
     # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned
@@ -9775,6 +9848,7 @@ module XeroRuby
     # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned
     # @option opts [String] :where Filter by an any element
     # @option opts [String] :order Order by an any element
+    # @option opts [Integer] :page Up to 100 payments will be returned in a single API call
     # @return [Payments]
     def get_payments(xero_tenant_id, opts = {})
       data, _status_code, _headers = get_payments_with_http_info(xero_tenant_id, opts)
@@ -9787,6 +9861,7 @@ module XeroRuby
     # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned
     # @option opts [String] :where Filter by an any element
     # @option opts [String] :order Order by an any element
+    # @option opts [Integer] :page Up to 100 payments will be returned in a single API call
     # @return [Array<(Payments, Integer, Hash)>] Payments data, response status code and response headers
     def get_payments_with_http_info(xero_tenant_id, opts = {})
       if @api_client.config.debugging
@@ -9803,6 +9878,7 @@ module XeroRuby
       query_params = opts[:query_params] || {}
       query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
       query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}