xero-ruby 12.0.0 → 13.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e488e1adff016f80f18367fc53e80a858bb3ab7719dfaf5e78da8d46fb366a2a
-  data.tar.gz: 918b57b88bdb2715b2a3d9f477f141ebf8eac39c394a0aeeed5cdd32e30b09bd
+  metadata.gz: 6dda81594e89032bf34006263f7fbd8c76dcf11df1450d7e3b4529b1df51911c
+  data.tar.gz: 39e28ee3024a995490eca726cc916ad695ebfda803ab1b427ece493ad55c165d
 SHA512:
-  metadata.gz: 22a58366e82f0a35f45d9692da6618f67de7de7ffc00f90fbeef6e7fae3e4f8ec3d22199eb23cf950924b38485cc0cce8bf5ba83fe7634728586a8390a5c70cf
-  data.tar.gz: 3912b2d3873f102f27bedb611b059579d27958442fe7fe72552f9f5c1223dd19a5c77cb89af0a49830d9d0c57d3ab9fe598be41285bc1434d34037ac2a6bb7f4
+  metadata.gz: 6819305dd617c7deb75f086a031c8d418caab5f1099f6c6837597e6a038fbee49bb5a5c3a8d48544e2df4718ca59dce4ab79c2e0cf976ad38175de9d23e34318
+  data.tar.gz: be178680ee893e90a5a30b8c21fa223c24cb6c215eb3e97cb2c66721bb8118a6505445522b861537140316cb72d158363d67db84dca1b0a21624e7824f7ac7ce

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

@@ -1825,6 +1825,7 @@ module XeroRuby
     end
 
     # Creates new employees used in Xero payrun
+    # This endpoint is deprecated and will be removed April 28, 2026
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param employees [Employees] Employees with array of Employee object in body of request
     # @param [Hash] opts the optional parameters
@@ -1837,6 +1838,7 @@ module XeroRuby
     end
 
     # Creates new employees used in Xero payrun
+    # This endpoint is deprecated and will be removed April 28, 2026
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param employees [Employees] Employees with array of Employee object in body of request
     # @param [Hash] opts the optional parameters
@@ -9357,6 +9359,7 @@ module XeroRuby
     end
 
     # Retrieves a specific employee used in Xero payrun using a unique employee Id
+    # This endpoint is deprecated and will be removed April 28, 2026
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param employee_id [String] Unique identifier for a Employee
     # @param [Hash] opts the optional parameters
@@ -9367,6 +9370,7 @@ module XeroRuby
     end
 
     # Retrieves a specific employee used in Xero payrun using a unique employee Id
+    # This endpoint is deprecated and will be removed April 28, 2026
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param employee_id [String] Unique identifier for a Employee
     # @param [Hash] opts the optional parameters
@@ -9432,6 +9436,7 @@ module XeroRuby
     end
 
     # Retrieves employees used in Xero payrun
+    # This endpoint is deprecated and will be removed April 28, 2026
     # @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
@@ -9444,6 +9449,7 @@ module XeroRuby
     end
 
     # Retrieves employees used in Xero payrun
+    # This endpoint is deprecated and will be removed April 28, 2026
     # @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
@@ -11952,6 +11958,7 @@ module XeroRuby
     # @option opts [Integer] :page e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment
     # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
     # @option opts [Integer] :page_size Number of records to retrieve per page
+    # @option opts [Array<String>] :references Filter by a comma-separated list of References
     # @return [Overpayments]
     def get_overpayments(xero_tenant_id, opts = {})
       data, _status_code, _headers = get_overpayments_with_http_info(xero_tenant_id, opts)
@@ -11967,6 +11974,7 @@ module XeroRuby
     # @option opts [Integer] :page e.g. page&#x3D;1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment
     # @option opts [Integer] :unitdp e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
     # @option opts [Integer] :page_size Number of records to retrieve per page
+    # @option opts [Array<String>] :references Filter by a comma-separated list of References
     # @return [Array<(Overpayments, Integer, Hash)>] Overpayments data, response status code and response headers
     def get_overpayments_with_http_info(xero_tenant_id, options = {})
       opts = options.dup
@@ -11990,6 +11998,7 @@ module XeroRuby
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
       query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
       query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'References'] = @api_client.build_collection_param(opts[:'references'], :csv) if !opts[:'references'].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?
@@ -17938,6 +17947,7 @@ module XeroRuby
     end
 
     # Creates a single new employees used in Xero payrun
+    # This endpoint is deprecated and will be removed April 28, 2026
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param employees [Employees] Employees with array of Employee object in body of request
     # @param [Hash] opts the optional parameters
@@ -17950,6 +17960,7 @@ module XeroRuby
     end
 
     # Creates a single new employees used in Xero payrun
+    # This endpoint is deprecated and will be removed April 28, 2026
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param employees [Employees] Employees with array of Employee object in body of request
     # @param [Hash] opts the optional parameters

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

@@ -16,305 +16,6 @@ module XeroRuby
     def initialize(api_client = ApiClient.new)
       @api_client = api_client
     end
-    # Get account usage
-    # A summary of how each account is being transacted on exposing the level of detail and amounts attributable to manual adjustments.
-    # @param xero_tenant_id [String] Xero identifier for Tenant
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :start_month date, yyyy-MM                 If no parameter is provided, the month 12 months prior to the end month will be used.                Account usage for up to 12 months from this date will be returned.
-    # @option opts [String] :end_month date, yyyy-MM                 If no parameter is provided, the current month will be used.                Account usage for up to 12 months prior to this date will be returned.
-    # @return [AccountUsageResponse]
-    def get_accounting_activity_account_usage(xero_tenant_id, opts = {})
-      data, _status_code, _headers = get_accounting_activity_account_usage_with_http_info(xero_tenant_id, opts)
-      data
-    end
-
-    # Get account usage
-    # A summary of how each account is being transacted on exposing the level of detail and amounts attributable to manual adjustments.
-    # @param xero_tenant_id [String] Xero identifier for Tenant
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :start_month date, yyyy-MM                 If no parameter is provided, the month 12 months prior to the end month will be used.                Account usage for up to 12 months from this date will be returned.
-    # @option opts [String] :end_month date, yyyy-MM                 If no parameter is provided, the current month will be used.                Account usage for up to 12 months prior to this date will be returned.
-    # @return [Array<(AccountUsageResponse, Integer, Hash)>] AccountUsageResponse data, response status code and response headers
-    def get_accounting_activity_account_usage_with_http_info(xero_tenant_id, options = {})
-      opts = options.dup
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: FinanceApi.get_accounting_activity_account_usage ...'
-      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 FinanceApi.get_accounting_activity_account_usage"
-      end
-      # resource path
-      local_var_path = '/AccountingActivities/AccountUsage'
-
-      # 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[:'startMonth'] = opts[:'start_month'] if !opts[:'start_month'].nil?
-      query_params[:'endMonth'] = opts[:'end_month'] if !opts[:'end_month'].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'])
-      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] || 'AccountUsageResponse' 
-
-      # 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, "FinanceApi", new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: FinanceApi#get_accounting_activity_account_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Get lock history
-    # Provides a history of locking of accounting books. Locking may be an indicator of good accounting practices that could reduce the risk of changes to accounting records in prior periods.
-    # @param xero_tenant_id [String] Xero identifier for Tenant
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :end_date date, yyyy-MM-dd                 If no parameter is provided, the current date will be used.                Any changes to hard or soft lock dates that were made within the period up to 12 months before this date will be returned.                Please be aware that there may be a delay of up to 3 days before a change is visible from this API.
-    # @return [LockHistoryResponse]
-    def get_accounting_activity_lock_history(xero_tenant_id, opts = {})
-      data, _status_code, _headers = get_accounting_activity_lock_history_with_http_info(xero_tenant_id, opts)
-      data
-    end
-
-    # Get lock history
-    # Provides a history of locking of accounting books. Locking may be an indicator of good accounting practices that could reduce the risk of changes to accounting records in prior periods.
-    # @param xero_tenant_id [String] Xero identifier for Tenant
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :end_date date, yyyy-MM-dd                 If no parameter is provided, the current date will be used.                Any changes to hard or soft lock dates that were made within the period up to 12 months before this date will be returned.                Please be aware that there may be a delay of up to 3 days before a change is visible from this API.
-    # @return [Array<(LockHistoryResponse, Integer, Hash)>] LockHistoryResponse data, response status code and response headers
-    def get_accounting_activity_lock_history_with_http_info(xero_tenant_id, options = {})
-      opts = options.dup
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: FinanceApi.get_accounting_activity_lock_history ...'
-      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 FinanceApi.get_accounting_activity_lock_history"
-      end
-      # resource path
-      local_var_path = '/AccountingActivities/LockHistory'
-
-      # 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[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].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'])
-      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] || 'LockHistoryResponse' 
-
-      # 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, "FinanceApi", new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: FinanceApi#get_accounting_activity_lock_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Get report history
-    # For a specified organisation, provides a summary of all the reports published within a given period, which may be an indicator for good business management and oversight.
-    # @param xero_tenant_id [String] Xero identifier for Tenant
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :end_date date, yyyy-MM-dd                 If no parameter is provided, the current date will be used.                Any reports that were published within the period up to 12 months before this date will be returned.                Please be aware that there may be a delay of up to 3 days before a published report is visible from this API.
-    # @return [ReportHistoryResponse]
-    def get_accounting_activity_report_history(xero_tenant_id, opts = {})
-      data, _status_code, _headers = get_accounting_activity_report_history_with_http_info(xero_tenant_id, opts)
-      data
-    end
-
-    # Get report history
-    # For a specified organisation, provides a summary of all the reports published within a given period, which may be an indicator for good business management and oversight.
-    # @param xero_tenant_id [String] Xero identifier for Tenant
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :end_date date, yyyy-MM-dd                 If no parameter is provided, the current date will be used.                Any reports that were published within the period up to 12 months before this date will be returned.                Please be aware that there may be a delay of up to 3 days before a published report is visible from this API.
-    # @return [Array<(ReportHistoryResponse, Integer, Hash)>] ReportHistoryResponse data, response status code and response headers
-    def get_accounting_activity_report_history_with_http_info(xero_tenant_id, options = {})
-      opts = options.dup
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: FinanceApi.get_accounting_activity_report_history ...'
-      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 FinanceApi.get_accounting_activity_report_history"
-      end
-      # resource path
-      local_var_path = '/AccountingActivities/ReportHistory'
-
-      # 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[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].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'])
-      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] || 'ReportHistoryResponse' 
-
-      # 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, "FinanceApi", new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: FinanceApi#get_accounting_activity_report_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Get user activities
-    # For a specified organisation, provides a list of all the users registered, and a history of their accounting transactions. Also identifies the existence of an external accounting advisor and the level of interaction.
-    # @param xero_tenant_id [String] Xero identifier for Tenant
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :data_month date, yyyy-MM                 The specified month must be complete (in the past); The current month cannot be specified since it is not complete.                If no parameter is provided, the month immediately previous to the current month will be used.                Any user activities occurring within the specified month will be returned.                Please be aware that there may be a delay of up to 3 days before a user activity is visible from this API.
-    # @return [UserActivitiesResponse]
-    def get_accounting_activity_user_activities(xero_tenant_id, opts = {})
-      data, _status_code, _headers = get_accounting_activity_user_activities_with_http_info(xero_tenant_id, opts)
-      data
-    end
-
-    # Get user activities
-    # For a specified organisation, provides a list of all the users registered, and a history of their accounting transactions. Also identifies the existence of an external accounting advisor and the level of interaction.
-    # @param xero_tenant_id [String] Xero identifier for Tenant
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :data_month date, yyyy-MM                 The specified month must be complete (in the past); The current month cannot be specified since it is not complete.                If no parameter is provided, the month immediately previous to the current month will be used.                Any user activities occurring within the specified month will be returned.                Please be aware that there may be a delay of up to 3 days before a user activity is visible from this API.
-    # @return [Array<(UserActivitiesResponse, Integer, Hash)>] UserActivitiesResponse data, response status code and response headers
-    def get_accounting_activity_user_activities_with_http_info(xero_tenant_id, options = {})
-      opts = options.dup
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: FinanceApi.get_accounting_activity_user_activities ...'
-      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 FinanceApi.get_accounting_activity_user_activities"
-      end
-      # resource path
-      local_var_path = '/AccountingActivities/UserActivities'
-
-      # 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[:'dataMonth'] = opts[:'data_month'] if !opts[:'data_month'].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'])
-      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] || 'UserActivitiesResponse' 
-
-      # 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, "FinanceApi", new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: FinanceApi#get_accounting_activity_user_activities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Get Bank Statement Accounting
     # For lenders that prefer using bank statement data as the source of truth.  We provide a data point that will allow access to customer bank statements, plus for reconciled bank transactions the matching accounting, invoice and billing data as well.  As customers reconcile bank statements to invoices and bills, this transaction detail will provide valuable insight for lender's assessment measures. 
     # @param xero_tenant_id [String] Xero identifier for Tenant