xero-ruby 1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a033e0dc82c3b83a0662fe4fe36f66bf63db4ce7fc852c64391cdc27bc2bb2d7
-  data.tar.gz: cea9c4e74270eb1cbb7d569ce27f6d228e2cb57ffeba9d6338ff3aaa173a6fb3
+  metadata.gz: 65af5017576aaf31ef6a26339ad1cbfba7a791eefc8c783ceeb7612557c75fbe
+  data.tar.gz: 241b41ed8c63069d40d5353fb8dbe08f28ad55460cac749011c1a5806f76db01
 SHA512:
-  metadata.gz: 152f472bda343f20ed114f3f2401ae73f47871b170c4be15590c8c89769a8b0e4553bf5e6a0b2bde95de7e6f452881305c1ec00a6926a332cc4a5dc2a08ebd39
-  data.tar.gz: 54c72cc4ed946102514399163be735c24644d89ca2fe2101884fd8f0f4ee5d832aa52219942a56d5daa60074d317b9cfa5cf9b9a1569de6741fad45043bfb987
+  metadata.gz: 827f168c87bc22a291c61b69d314ed2f770140ca2092c23110b48e86087f3fdb25ac924caa97b8735e2bc2ef02e7fa12cf8deaf091c824004fc8a3932f6e8f27
+  data.tar.gz: 9a2478528144ec670dbea5a2a635a33fce483437abed5575c6b4226f2c198ac0a314ca48e2503096aba760d4509422b4fb5987e5608a14635e0993f32b0b3f0d

data/docs/accounting/AccountingApi.md

@@ -88,7 +88,7 @@ Method | HTTP request | Description
 [**get_branding_theme**](AccountingApi.md#get_branding_theme) | **GET** /BrandingThemes/{BrandingThemeID} | Allows you to retrieve a specific BrandingThemes
 [**get_branding_theme_payment_services**](AccountingApi.md#get_branding_theme_payment_services) | **GET** /BrandingThemes/{BrandingThemeID}/PaymentServices | Allows you to retrieve the Payment services for a Branding Theme
 [**get_branding_themes**](AccountingApi.md#get_branding_themes) | **GET** /BrandingThemes | Allows you to retrieve all the BrandingThemes
-[**get_contact**](AccountingApi.md#get_contact) | **GET** /Contacts/{ContactID} | Allows you to retrieve, add and update contacts in a Xero organisation
+[**get_contact**](AccountingApi.md#get_contact) | **GET** /Contacts/{ContactID} | Allows you to retrieve a single contacts in a Xero organisation
 [**get_contact_attachment_by_file_name**](AccountingApi.md#get_contact_attachment_by_file_name) | **GET** /Contacts/{ContactID}/Attachments/{FileName} | Allows you to retrieve Attachments on Contacts by file name
 [**get_contact_attachment_by_id**](AccountingApi.md#get_contact_attachment_by_id) | **GET** /Contacts/{ContactID}/Attachments/{AttachmentID} | Allows you to retrieve Attachments on Contacts
 [**get_contact_attachments**](AccountingApi.md#get_contact_attachments) | **GET** /Contacts/{ContactID}/Attachments | Allows you to retrieve, add and update contacts in a Xero organisation
@@ -96,7 +96,7 @@ Method | HTTP request | Description
 [**get_contact_group**](AccountingApi.md#get_contact_group) | **GET** /ContactGroups/{ContactGroupID} | Allows you to retrieve a unique Contact Group by ID
 [**get_contact_groups**](AccountingApi.md#get_contact_groups) | **GET** /ContactGroups | Allows you to retrieve the ContactID and Name of all the contacts in a contact group
 [**get_contact_history**](AccountingApi.md#get_contact_history) | **GET** /Contacts/{ContactID}/History | Allows you to retrieve a history records of an Contact
-[**get_contacts**](AccountingApi.md#get_contacts) | **GET** /Contacts | Allows you to retrieve, add and update contacts in a Xero organisation
+[**get_contacts**](AccountingApi.md#get_contacts) | **GET** /Contacts | Allows you to retrieve all contacts in a Xero organisation
 [**get_credit_note**](AccountingApi.md#get_credit_note) | **GET** /CreditNotes/{CreditNoteID} | Allows you to retrieve a specific credit note
 [**get_credit_note_as_pdf**](AccountingApi.md#get_credit_note_as_pdf) | **GET** /CreditNotes/{CreditNoteID}/pdf | Allows you to retrieve Credit Note as PDF files
 [**get_credit_note_attachment_by_file_name**](AccountingApi.md#get_credit_note_attachment_by_file_name) | **GET** /CreditNotes/{CreditNoteID}/Attachments/{FileName} | Allows you to retrieve Attachments on CreditNote by file name
@@ -141,6 +141,7 @@ Method | HTTP request | Description
 [**get_payment_services**](AccountingApi.md#get_payment_services) | **GET** /PaymentServices | Allows you to retrieve payment services
 [**get_payments**](AccountingApi.md#get_payments) | **GET** /Payments | Allows you to retrieve payments for invoices and credit notes
 [**get_prepayment**](AccountingApi.md#get_prepayment) | **GET** /Prepayments/{PrepaymentID} | Allows you to retrieve a specified prepayments
+[**get_prepayment_as_pdf**](AccountingApi.md#get_prepayment_as_pdf) | **GET** /Prepayments/{PrepaymentID}/pdf | Allows you to retrieve prepayments as PDF files
 [**get_prepayment_history**](AccountingApi.md#get_prepayment_history) | **GET** /Prepayments/{PrepaymentID}/History | Allows you to retrieve a history records of an Prepayment
 [**get_prepayments**](AccountingApi.md#get_prepayments) | **GET** /Prepayments | Allows you to retrieve prepayments
 [**get_purchase_order**](AccountingApi.md#get_purchase_order) | **GET** /PurchaseOrders/{PurchaseOrderID} | Allows you to retrieve a specified purchase orders
@@ -2658,7 +2659,7 @@ Name | Type | Description  | Notes
 
 ## create_payments
 
-> Payments create_payments(xero_tenant_id, payments)
+> Payments create_payments(xero_tenant_id, payments, opts)
 
 Allows you to create multiple payments for invoices or credit notes
 
@@ -2687,10 +2688,13 @@ api_instance = xero_client.asset_api
 
 xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
 payments = { payments:[ { invoice:{ invoiceID:"00000000-0000-0000-000-000000000000", lineItems:[], contact: {}, type: Invoice.TypeEnum.ACCPAY }, account:{ code:"970" }, date:"2019-03-12", amount:1.0 } ] } # Payments | Payments array with Payment object in body of request
+opts = {
+  summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created obejcts and any with validation errors
+}
 
 begin
   #Allows you to create multiple payments for invoices or credit notes
-  result = api_instance.create_payments(xero_tenant_id, payments)
+  result = api_instance.create_payments(xero_tenant_id, payments, opts)
   p result
 rescue XeroRuby::Accounting::ApiError => e
   puts "Exception when calling AccountingApi->create_payments: #{e}"
@@ -2704,6 +2708,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **xero_tenant_id** | **String**| Xero identifier for Tenant | 
  **payments** | [**Payments**](Payments.md)| Payments array with Payment object in body of request | 
+ **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created obejcts and any with validation errors | [optional] [default to false]
 
 ### Return type
 
@@ -5720,7 +5725,7 @@ Name | Type | Description  | Notes
 
 > Contacts get_contact(xero_tenant_id, contact_id)
 
-Allows you to retrieve, add and update contacts in a Xero organisation
+Allows you to retrieve a single contacts in a Xero organisation
 
 ### Example
 
@@ -5749,7 +5754,7 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
 contact_id = '00000000-0000-0000-000-000000000000' # String | Unique identifier for a Contact
 
 begin
-  #Allows you to retrieve, add and update contacts in a Xero organisation
+  #Allows you to retrieve a single contacts in a Xero organisation
   result = api_instance.get_contact(xero_tenant_id, contact_id)
   p result
 rescue XeroRuby::Accounting::ApiError => e
@@ -6236,7 +6241,7 @@ Name | Type | Description  | Notes
 
 > Contacts get_contacts(xero_tenant_id, opts)
 
-Allows you to retrieve, add and update contacts in a Xero organisation
+Allows you to retrieve all contacts in a Xero organisation
 
 ### Example
 
@@ -6272,7 +6277,7 @@ opts = {
 }
 
 begin
-  #Allows you to retrieve, add and update contacts in a Xero organisation
+  #Allows you to retrieve all contacts in a Xero organisation
   result = api_instance.get_contacts(xero_tenant_id, opts)
   p result
 rescue XeroRuby::Accounting::ApiError => e
@@ -9207,6 +9212,69 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## get_prepayment_as_pdf
+
+> File get_prepayment_as_pdf(xero_tenant_id, prepayment_id)
+
+Allows you to retrieve prepayments as PDF files
+
+### 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 = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
+prepayment_id = '00000000-0000-0000-000-000000000000' # String | Unique identifier for a PrePayment
+
+begin
+  #Allows you to retrieve prepayments as PDF files
+  result = api_instance.get_prepayment_as_pdf(xero_tenant_id, prepayment_id)
+  p result
+rescue XeroRuby::Accounting::ApiError => e
+  puts "Exception when calling AccountingApi->get_prepayment_as_pdf: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **xero_tenant_id** | **String**| Xero identifier for Tenant | 
+ **prepayment_id** | [**String**](.md)| Unique identifier for a PrePayment | 
+
+### Return type
+
+**File**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/pdf
+
+
 ## get_prepayment_history
 
 > HistoryRecords get_prepayment_history(xero_tenant_id, prepayment_id)

data/docs/accounting/Journal.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **journal_id** | **String** | Xero identifier | [optional] 
 **journal_date** | **Date** | Date the journal was posted | [optional] 
-**journal_number** | **String** | Xero generated journal number | [optional] 
+**journal_number** | **Integer** | Xero generated journal number | [optional] 
 **created_date_utc** | **DateTime** | Created date UTC format | [optional] 
 **reference** | **String** | reference field for additional indetifying information | [optional] 
 **source_id** | **String** | The identifier for the source transaction (e.g. InvoiceID) | [optional] 

data/docs/accounting/Payment.md

@@ -26,6 +26,7 @@ Name | Type | Description | Notes
 **details** | **String** | The information to appear on the supplier's bank account | [optional] 
 **has_account** | **Boolean** | A boolean to indicate if a contact has an validation errors | [optional] 
 **has_validation_errors** | **Boolean** | A boolean to indicate if a contact has an validation errors | [optional] 
+**status_attribute_string** | **String** | A string to indicate if a invoice status | [optional] 
 **validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional] 
 
 ## Code Sample
@@ -55,6 +56,7 @@ instance = XeroRuby::Accounting::Payment.new(invoice: null,
                                  details: null,
                                  has_account: null,
                                  has_validation_errors: null,
+                                 status_attribute_string: null,
                                  validation_errors: null)
 ```
 

data/lib/xero-ruby.rb

@@ -3,7 +3,7 @@
 
 #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.1.3
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.0

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

@@ -3,7 +3,7 @@
 
 #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.1.3
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.0
@@ -2781,6 +2781,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 +2792,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 +2811,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 +6170,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 +6180,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
@@ -6729,7 +6732,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 +6747,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
@@ -9906,6 +9909,73 @@ module XeroRuby
       return data, status_code, headers
     end
 
+    # Allows you to retrieve prepayments as PDF files
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param prepayment_id [String] Unique identifier for a PrePayment
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def get_prepayment_as_pdf(xero_tenant_id, prepayment_id, opts = {})
+      data, _status_code, _headers = get_prepayment_as_pdf_with_http_info(xero_tenant_id, prepayment_id, opts)
+      data
+    end
+
+    # Allows you to retrieve prepayments as PDF files
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param prepayment_id [String] Unique identifier for a PrePayment
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def get_prepayment_as_pdf_with_http_info(xero_tenant_id, prepayment_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountingApi.get_prepayment_as_pdf ...'
+      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_prepayment_as_pdf"
+      end
+      # verify the required parameter 'prepayment_id' is set
+      if @api_client.config.client_side_validation && prepayment_id.nil?
+        fail ArgumentError, "Missing the required parameter 'prepayment_id' when calling AccountingApi.get_prepayment_as_pdf"
+      end
+      # resource path
+      local_var_path = '/Prepayments/{PrepaymentID}'.sub('{' + 'PrepaymentID' + '}', prepayment_id.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/pdf'])
+      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] || 'File' 
+
+      # 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_prepayment_as_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Allows you to retrieve a history records of an Prepayment
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param prepayment_id [String] Unique identifier for a PrePayment

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

@@ -3,7 +3,7 @@
 
 #This is the Xero Assets API
 
-The version of the OpenAPI document: 2.1.0
+The version of the OpenAPI document: 2.1.3
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.0

data/lib/xero-ruby/api_client.rb

@@ -3,7 +3,7 @@
 
 #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.1.3
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.0

data/lib/xero-ruby/api_error.rb

@@ -3,7 +3,7 @@
 
 #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.1.3
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.0

data/lib/xero-ruby/configuration.rb

@@ -3,7 +3,7 @@
 
 #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.1.3
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.0

data/lib/xero-ruby/models/accounting/account.rb

@@ -3,7 +3,7 @@
 
 #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.1.3
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.0

data/lib/xero-ruby/models/accounting/account_type.rb

@@ -3,7 +3,7 @@
 
 #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.1.3
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.0

data/lib/xero-ruby/models/accounting/accounts.rb

@@ -3,7 +3,7 @@
 
 #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.1.3
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.0

data/lib/xero-ruby/models/accounting/accounts_payable.rb

@@ -3,7 +3,7 @@
 
 #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.1.3
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.0

data/lib/xero-ruby/models/accounting/accounts_receivable.rb

@@ -3,7 +3,7 @@
 
 #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.1.3
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.0

data/lib/xero-ruby/models/accounting/address.rb

@@ -3,7 +3,7 @@
 
 #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.1.3
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.0

data/lib/xero-ruby/models/accounting/allocation.rb

@@ -3,7 +3,7 @@
 
 #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.1.3
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.0