xero-ruby 3.9.0 → 3.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9da0e17f450205612e5090cdb258485529efa412eadc1ead5c564050d68b51d9
-  data.tar.gz: f06c54f4fd72e7dd1281a6960beb82969899d9015f2e14cf737018596199cb73
+  metadata.gz: eca22a65d6cd11bc3848d37259562279cb05874c8eb659acea215a5e72f3fb88
+  data.tar.gz: 13e577c274b99dd0ef74b33e648e821f8b5d9bdfe6c7550ffe4585ba282de3fa
 SHA512:
-  metadata.gz: 602762907bb324d2a7f308418f3789602e077d32621b5329e3d4a83154524b0981b1876f99a655cb978b40514cfcc63fd63509e5117af567c097c4affd38655e
-  data.tar.gz: fbaddb461ba6b3db40c906e6195012b591e076ee2dc7248d4501621e4fa5dbb3c9cefa134317a4f76d3218d909ce7a302bdcaa9449fd970cc7d43d98356c08a8
+  metadata.gz: 19a28bc6110af2ea9a80a5099b932bcd08109832d05e4938636c63c5bb6d45e5d63a7e8d4ec54a335b4283d43a887c87a5d9cf4acc63807c5558abee14a5bf87
+  data.tar.gz: 92d5d4b03239e8ca5739057d353ee7fb5f9b46d1f81d5a28ffb0824ebd34909c604ffb71fdb6387739ecd5af1b44fc54304a87a3d171c864cab1f3f0fcf1451a

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

@@ -4337,6 +4337,86 @@ module XeroRuby
       return data, status_code, headers
     end
 
+    # Creates one or more repeating invoice templates
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param repeating_invoices [RepeatingInvoices] RepeatingInvoices with an array of repeating invoice objects 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 objects and any with validation errors (default to false)
+    # @return [RepeatingInvoices]
+    def create_repeating_invoices(xero_tenant_id, repeating_invoices, opts = {})
+      data, _status_code, _headers = create_repeating_invoices_with_http_info(xero_tenant_id, repeating_invoices, opts)
+      data
+    end
+
+    # Creates one or more repeating invoice templates
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param repeating_invoices [RepeatingInvoices] RepeatingInvoices with an array of repeating invoice objects 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 objects and any with validation errors
+    # @return [Array<(RepeatingInvoices, Integer, Hash)>] RepeatingInvoices data, response status code and response headers
+    def create_repeating_invoices_with_http_info(xero_tenant_id, repeating_invoices, options = {})
+      opts = options.dup
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountingApi.create_repeating_invoices ...'
+      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.create_repeating_invoices"
+      end
+      # verify the required parameter 'repeating_invoices' is set
+      if @api_client.config.client_side_validation && repeating_invoices.nil?
+        fail ArgumentError, "Missing the required parameter 'repeating_invoices' when calling AccountingApi.create_repeating_invoices"
+      end
+      # resource path
+      local_var_path = '/RepeatingInvoices'
+
+      # camelize keys of incoming `where` opts
+      opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
+      
+      # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
+      query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
+      query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      header_params[:'xero-tenant-id'] = xero_tenant_id
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(repeating_invoices) 
+
+      # return_type
+      return_type = opts[:return_type] || 'RepeatingInvoices' 
+
+      # 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(:PUT, local_var_path, "AccountingApi", new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountingApi#create_repeating_invoices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Creates one or more tax rates
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param tax_rates [TaxRates] TaxRates array with TaxRate object in body of request
@@ -4649,6 +4729,166 @@ module XeroRuby
       return data, status_code, headers
     end
 
+    # Updates a specific batch payment for invoices and credit notes
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param batch_payment_delete [BatchPaymentDelete] 
+    # @param [Hash] opts the optional parameters
+    # @return [BatchPayments]
+    def delete_batch_payment(xero_tenant_id, batch_payment_delete, opts = {})
+      data, _status_code, _headers = delete_batch_payment_with_http_info(xero_tenant_id, batch_payment_delete, opts)
+      data
+    end
+
+    # Updates a specific batch payment for invoices and credit notes
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param batch_payment_delete [BatchPaymentDelete] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BatchPayments, Integer, Hash)>] BatchPayments data, response status code and response headers
+    def delete_batch_payment_with_http_info(xero_tenant_id, batch_payment_delete, options = {})
+      opts = options.dup
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountingApi.delete_batch_payment ...'
+      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.delete_batch_payment"
+      end
+      # verify the required parameter 'batch_payment_delete' is set
+      if @api_client.config.client_side_validation && batch_payment_delete.nil?
+        fail ArgumentError, "Missing the required parameter 'batch_payment_delete' when calling AccountingApi.delete_batch_payment"
+      end
+      # resource path
+      local_var_path = '/BatchPayments'
+
+      # camelize keys of incoming `where` opts
+      opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      
+      # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
+      query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
+      query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      header_params[:'xero-tenant-id'] = xero_tenant_id
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(batch_payment_delete) 
+
+      # return_type
+      return_type = opts[:return_type] || 'BatchPayments' 
+
+      # 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(:POST, local_var_path, "AccountingApi", new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountingApi#delete_batch_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Updates a specific batch payment for invoices and credit notes
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param batch_payment_id [String] Unique identifier for BatchPayment
+    # @param batch_payment_delete_by_url_param [BatchPaymentDeleteByUrlParam] 
+    # @param [Hash] opts the optional parameters
+    # @return [BatchPayments]
+    def delete_batch_payment_by_url_param(xero_tenant_id, batch_payment_id, batch_payment_delete_by_url_param, opts = {})
+      data, _status_code, _headers = delete_batch_payment_by_url_param_with_http_info(xero_tenant_id, batch_payment_id, batch_payment_delete_by_url_param, opts)
+      data
+    end
+
+    # Updates a specific batch payment for invoices and credit notes
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param batch_payment_id [String] Unique identifier for BatchPayment
+    # @param batch_payment_delete_by_url_param [BatchPaymentDeleteByUrlParam] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BatchPayments, Integer, Hash)>] BatchPayments data, response status code and response headers
+    def delete_batch_payment_by_url_param_with_http_info(xero_tenant_id, batch_payment_id, batch_payment_delete_by_url_param, options = {})
+      opts = options.dup
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountingApi.delete_batch_payment_by_url_param ...'
+      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.delete_batch_payment_by_url_param"
+      end
+      # verify the required parameter 'batch_payment_id' is set
+      if @api_client.config.client_side_validation && batch_payment_id.nil?
+        fail ArgumentError, "Missing the required parameter 'batch_payment_id' when calling AccountingApi.delete_batch_payment_by_url_param"
+      end
+      # verify the required parameter 'batch_payment_delete_by_url_param' is set
+      if @api_client.config.client_side_validation && batch_payment_delete_by_url_param.nil?
+        fail ArgumentError, "Missing the required parameter 'batch_payment_delete_by_url_param' when calling AccountingApi.delete_batch_payment_by_url_param"
+      end
+      # resource path
+      local_var_path = '/BatchPayments/{BatchPaymentID}'.sub('{' + 'BatchPaymentID' + '}', batch_payment_id.to_s)
+
+      # camelize keys of incoming `where` opts
+      opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      
+      # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
+      query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
+      query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      header_params[:'xero-tenant-id'] = xero_tenant_id
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(batch_payment_delete_by_url_param) 
+
+      # return_type
+      return_type = opts[:return_type] || 'BatchPayments' 
+
+      # 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(:POST, local_var_path, "AccountingApi", new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountingApi#delete_batch_payment_by_url_param\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Deletes a specific contact from a contact group using a unique contact Id
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param contact_group_id [String] Unique identifier for a Contact Group
@@ -17520,6 +17760,86 @@ module XeroRuby
       return data, status_code, headers
     end
 
+    # Creates or deletes one or more repeating invoice templates
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param repeating_invoices [RepeatingInvoices] RepeatingInvoices with an array of repeating invoice objects 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 objects and any with validation errors (default to false)
+    # @return [RepeatingInvoices]
+    def update_or_create_repeating_invoices(xero_tenant_id, repeating_invoices, opts = {})
+      data, _status_code, _headers = update_or_create_repeating_invoices_with_http_info(xero_tenant_id, repeating_invoices, opts)
+      data
+    end
+
+    # Creates or deletes one or more repeating invoice templates
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param repeating_invoices [RepeatingInvoices] RepeatingInvoices with an array of repeating invoice objects 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 objects and any with validation errors
+    # @return [Array<(RepeatingInvoices, Integer, Hash)>] RepeatingInvoices data, response status code and response headers
+    def update_or_create_repeating_invoices_with_http_info(xero_tenant_id, repeating_invoices, options = {})
+      opts = options.dup
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountingApi.update_or_create_repeating_invoices ...'
+      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.update_or_create_repeating_invoices"
+      end
+      # verify the required parameter 'repeating_invoices' is set
+      if @api_client.config.client_side_validation && repeating_invoices.nil?
+        fail ArgumentError, "Missing the required parameter 'repeating_invoices' when calling AccountingApi.update_or_create_repeating_invoices"
+      end
+      # resource path
+      local_var_path = '/RepeatingInvoices'
+
+      # camelize keys of incoming `where` opts
+      opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
+      
+      # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
+      query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
+      query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      header_params[:'xero-tenant-id'] = xero_tenant_id
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(repeating_invoices) 
+
+      # return_type
+      return_type = opts[:return_type] || 'RepeatingInvoices' 
+
+      # 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(:POST, local_var_path, "AccountingApi", new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountingApi#update_or_create_repeating_invoices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Updates a specific purchase order
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param purchase_order_id [String] Unique identifier for an Purchase Order
@@ -18039,6 +18359,89 @@ module XeroRuby
       return data, status_code, headers
     end
 
+    # Deletes a specific repeating invoice template
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param repeating_invoice_id [String] Unique identifier for a Repeating Invoice
+    # @param repeating_invoices [RepeatingInvoices] 
+    # @param [Hash] opts the optional parameters
+    # @return [RepeatingInvoices]
+    def update_repeating_invoice(xero_tenant_id, repeating_invoice_id, repeating_invoices, opts = {})
+      data, _status_code, _headers = update_repeating_invoice_with_http_info(xero_tenant_id, repeating_invoice_id, repeating_invoices, opts)
+      data
+    end
+
+    # Deletes a specific repeating invoice template
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param repeating_invoice_id [String] Unique identifier for a Repeating Invoice
+    # @param repeating_invoices [RepeatingInvoices] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RepeatingInvoices, Integer, Hash)>] RepeatingInvoices data, response status code and response headers
+    def update_repeating_invoice_with_http_info(xero_tenant_id, repeating_invoice_id, repeating_invoices, options = {})
+      opts = options.dup
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountingApi.update_repeating_invoice ...'
+      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.update_repeating_invoice"
+      end
+      # verify the required parameter 'repeating_invoice_id' is set
+      if @api_client.config.client_side_validation && repeating_invoice_id.nil?
+        fail ArgumentError, "Missing the required parameter 'repeating_invoice_id' when calling AccountingApi.update_repeating_invoice"
+      end
+      # verify the required parameter 'repeating_invoices' is set
+      if @api_client.config.client_side_validation && repeating_invoices.nil?
+        fail ArgumentError, "Missing the required parameter 'repeating_invoices' when calling AccountingApi.update_repeating_invoice"
+      end
+      # resource path
+      local_var_path = '/RepeatingInvoices/{RepeatingInvoiceID}'.sub('{' + 'RepeatingInvoiceID' + '}', repeating_invoice_id.to_s)
+
+      # camelize keys of incoming `where` opts
+      opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      
+      # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
+      query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
+      query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      header_params[:'xero-tenant-id'] = xero_tenant_id
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(repeating_invoices) 
+
+      # return_type
+      return_type = opts[:return_type] || 'RepeatingInvoices' 
+
+      # 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(:POST, local_var_path, "AccountingApi", new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountingApi#update_repeating_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Updates a specific attachment from a specific repeating invoices by file name
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param repeating_invoice_id [String] Unique identifier for a Repeating Invoice