xero-ruby 3.3.0 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a94136a3e2a31cc4d5c7a162116bdd8705800ac2fc2732907a80286950fa376
-  data.tar.gz: 340b78c53b08a37f04b79d642bf0fc7e4e1c109595ef86b596398aa9c2b87be3
+  metadata.gz: 9da0e17f450205612e5090cdb258485529efa412eadc1ead5c564050d68b51d9
+  data.tar.gz: f06c54f4fd72e7dd1281a6960beb82969899d9015f2e14cf737018596199cb73
 SHA512:
-  metadata.gz: 1275a668a399320fa11e6ccbcacd9eac6d4cf4ffb939108d1962ccede318376b1ee3236b4cdbb95e0db45e8e1695f860508861c4097da7c1d6a12e22cfe3672f
-  data.tar.gz: 49de788f087c577474ad556ed9188c0e75ccb46256f52ff6639e2fdf82ed732fceb9eebfb825a9d17cb2f6370c4b52c78c4b1ebc0b5484554e565089e5f5052d
+  metadata.gz: 602762907bb324d2a7f308418f3789602e077d32621b5329e3d4a83154524b0981b1876f99a655cb978b40514cfcc63fd63509e5117af567c097c4affd38655e
+  data.tar.gz: fbaddb461ba6b3db40c906e6195012b591e076ee2dc7248d4501621e4fa5dbb3c9cefa134317a4f76d3218d909ce7a302bdcaa9449fd970cc7d43d98356c08a8

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

@@ -7018,20 +7018,24 @@ module XeroRuby
       return data, status_code, headers
     end
 
-    # Retrieves a specific budgets, which includes budget lines
+    # Retrieves a specific budget, which includes budget lines
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param budget_id [String] Unique identifier for Budgets
     # @param [Hash] opts the optional parameters
+    # @option opts [Date] :date_to Filter by start date
+    # @option opts [Date] :date_from Filter by end date
     # @return [Budgets]
     def get_budget(xero_tenant_id, budget_id, opts = {})
       data, _status_code, _headers = get_budget_with_http_info(xero_tenant_id, budget_id, opts)
       data
     end
 
-    # Retrieves a specific budgets, which includes budget lines
+    # Retrieves a specific budget, which includes budget lines
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param budget_id [String] Unique identifier for Budgets
     # @param [Hash] opts the optional parameters
+    # @option opts [Date] :date_to Filter by start date
+    # @option opts [Date] :date_from Filter by end date
     # @return [Array<(Budgets, Integer, Hash)>] Budgets data, response status code and response headers
     def get_budget_with_http_info(xero_tenant_id, budget_id, options = {})
       opts = options.dup
@@ -7054,6 +7058,8 @@ module XeroRuby
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'DateTo'] = opts[:'date_to'] if !opts[:'date_to'].nil?
+      query_params[:'DateFrom'] = opts[:'date_from'] if !opts[:'date_from'].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?
@@ -7882,6 +7888,7 @@ module XeroRuby
     # @option opts [Integer] :page e.g. page&#x3D;1 - Up to 100 contacts will be returned in a single API call.
     # @option opts [Boolean] :include_archived e.g. includeArchived&#x3D;true - Contacts with a status of ARCHIVED will be included in the response
     # @option opts [Boolean] :summary_only Use summaryOnly&#x3D;true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. (default to false)
+    # @option opts [String] :search_term Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields.
     # @return [Contacts]
     def get_contacts(xero_tenant_id, opts = {})
       data, _status_code, _headers = get_contacts_with_http_info(xero_tenant_id, opts)
@@ -7898,6 +7905,7 @@ module XeroRuby
     # @option opts [Integer] :page e.g. page&#x3D;1 - Up to 100 contacts will be returned in a single API call.
     # @option opts [Boolean] :include_archived e.g. includeArchived&#x3D;true - Contacts with a status of ARCHIVED will be included in the response
     # @option opts [Boolean] :summary_only Use summaryOnly&#x3D;true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient.
+    # @option opts [String] :search_term Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields.
     # @return [Array<(Contacts, Integer, Hash)>] Contacts data, response status code and response headers
     def get_contacts_with_http_info(xero_tenant_id, options = {})
       opts = options.dup
@@ -7922,6 +7930,7 @@ module XeroRuby
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
       query_params[:'includeArchived'] = opts[:'include_archived'] if !opts[:'include_archived'].nil?
       query_params[:'summaryOnly'] = opts[:'summary_only'] if !opts[:'summary_only'].nil?
+      query_params[:'searchTerm'] = opts[:'search_term'] if !opts[:'search_term'].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?
@@ -9943,6 +9952,81 @@ module XeroRuby
       return data, status_code, headers
     end
 
+    # Retrieves a specific journal using a unique journal number.
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param journal_number [Integer] Number of a Journal
+    # @param [Hash] opts the optional parameters
+    # @return [Journals]
+    def get_journal_by_number(xero_tenant_id, journal_number, opts = {})
+      data, _status_code, _headers = get_journal_by_number_with_http_info(xero_tenant_id, journal_number, opts)
+      data
+    end
+
+    # Retrieves a specific journal using a unique journal number.
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param journal_number [Integer] Number of a Journal
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Journals, Integer, Hash)>] Journals data, response status code and response headers
+    def get_journal_by_number_with_http_info(xero_tenant_id, journal_number, options = {})
+      opts = options.dup
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountingApi.get_journal_by_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_journal_by_number"
+      end
+      # verify the required parameter 'journal_number' is set
+      if @api_client.config.client_side_validation && journal_number.nil?
+        fail ArgumentError, "Missing the required parameter 'journal_number' when calling AccountingApi.get_journal_by_number"
+      end
+      # resource path
+      local_var_path = '/Journals/{JournalNumber}'.sub('{' + 'JournalNumber' + '}', journal_number.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'])
+      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] || 'Journals' 
+
+      # 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, "AccountingApi", new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountingApi#get_journal_by_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieves journals
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param [Hash] opts the optional parameters