merge_hris_client 1.0.1

data/lib/merge_hris_client/api/available_actions_api.rb

@@ -0,0 +1,84 @@
+=begin
+#Merge HRIS API
+
+#The unified API for building rich integrations with multiple HR Information System platforms.
+
+The version of the OpenAPI document: 1.0
+Contact: hello@merge.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.0
+
+=end
+
+require 'cgi'
+
+module MergeHRISClient
+  class AvailableActionsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Returns a list of models and actions available for an account.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @return [AvailableActions]
+    def available_actions_retrieve(x_account_token, opts = {})
+      data, _status_code, _headers = available_actions_retrieve_with_http_info(x_account_token, opts)
+      data
+    end
+
+    # Returns a list of models and actions available for an account.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AvailableActions, Integer, Hash)>] AvailableActions data, response status code and response headers
+    def available_actions_retrieve_with_http_info(x_account_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AvailableActionsApi.available_actions_retrieve ...'
+      end
+      # verify the required parameter 'x_account_token' is set
+      if @api_client.config.client_side_validation && x_account_token.nil?
+        fail ArgumentError, "Missing the required parameter 'x_account_token' when calling AvailableActionsApi.available_actions_retrieve"
+      end
+      # resource path
+      local_var_path = '/available-actions'
+
+      # 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[:'X-Account-Token'] = x_account_token
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AvailableActions'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"AvailableActionsApi.available_actions_retrieve",
+        :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: AvailableActionsApi#available_actions_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/merge_hris_client/api/benefits_api.rb

@@ -0,0 +1,196 @@
+=begin
+#Merge HRIS API
+
+#The unified API for building rich integrations with multiple HR Information System platforms.
+
+The version of the OpenAPI document: 1.0
+Contact: hello@merge.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.0
+
+=end
+
+require 'cgi'
+
+module MergeHRISClient
+  class BenefitsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Returns a list of `Benefit` objects.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
+    # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
+    # @option opts [String] :cursor The pagination cursor value.
+    # @option opts [String] :employee_id If provided, will only return time off for this employee.
+    # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+    # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
+    # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
+    # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
+    # @option opts [Integer] :page_size Number of results to return per page.
+    # @option opts [String] :remote_id The API provider's ID for the given object.
+    # @return [PaginatedBenefitList]
+    def benefits_list(x_account_token, opts = {})
+      data, _status_code, _headers = benefits_list_with_http_info(x_account_token, opts)
+      data
+    end
+
+    # Returns a list of `Benefit` objects.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
+    # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
+    # @option opts [String] :cursor The pagination cursor value.
+    # @option opts [String] :employee_id If provided, will only return time off for this employee.
+    # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+    # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
+    # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
+    # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
+    # @option opts [Integer] :page_size Number of results to return per page.
+    # @option opts [String] :remote_id The API provider's ID for the given object.
+    # @return [Array<(PaginatedBenefitList, Integer, Hash)>] PaginatedBenefitList data, response status code and response headers
+    def benefits_list_with_http_info(x_account_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BenefitsApi.benefits_list ...'
+      end
+      # verify the required parameter 'x_account_token' is set
+      if @api_client.config.client_side_validation && x_account_token.nil?
+        fail ArgumentError, "Missing the required parameter 'x_account_token' when calling BenefitsApi.benefits_list"
+      end
+      allowable_values = ["employee"]
+      if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
+        fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/benefits'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
+      query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'employee_id'] = opts[:'employee_id'] if !opts[:'employee_id'].nil?
+      query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
+      query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
+      query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
+      query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].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[:'X-Account-Token'] = x_account_token
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PaginatedBenefitList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"BenefitsApi.benefits_list",
+        :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: BenefitsApi#benefits_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns a `Benefit` object with the given `id`.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+    # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
+    # @return [Benefit]
+    def benefits_retrieve(x_account_token, id, opts = {})
+      data, _status_code, _headers = benefits_retrieve_with_http_info(x_account_token, id, opts)
+      data
+    end
+
+    # Returns a &#x60;Benefit&#x60; object with the given &#x60;id&#x60;.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+    # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
+    # @return [Array<(Benefit, Integer, Hash)>] Benefit data, response status code and response headers
+    def benefits_retrieve_with_http_info(x_account_token, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BenefitsApi.benefits_retrieve ...'
+      end
+      # verify the required parameter 'x_account_token' is set
+      if @api_client.config.client_side_validation && x_account_token.nil?
+        fail ArgumentError, "Missing the required parameter 'x_account_token' when calling BenefitsApi.benefits_retrieve"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling BenefitsApi.benefits_retrieve"
+      end
+      allowable_values = ["employee"]
+      if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
+        fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/benefits/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
+      query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].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[:'X-Account-Token'] = x_account_token
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Benefit'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"BenefitsApi.benefits_retrieve",
+        :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: BenefitsApi#benefits_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/merge_hris_client/api/companies_api.rb

@@ -0,0 +1,179 @@
+=begin
+#Merge HRIS API
+
+#The unified API for building rich integrations with multiple HR Information System platforms.
+
+The version of the OpenAPI document: 1.0
+Contact: hello@merge.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.0
+
+=end
+
+require 'cgi'
+
+module MergeHRISClient
+  class CompaniesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Returns a list of `Company` objects.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
+    # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
+    # @option opts [String] :cursor The pagination cursor value.
+    # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
+    # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
+    # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
+    # @option opts [Integer] :page_size Number of results to return per page.
+    # @option opts [String] :remote_id The API provider's ID for the given object.
+    # @return [PaginatedCompanyList]
+    def companies_list(x_account_token, opts = {})
+      data, _status_code, _headers = companies_list_with_http_info(x_account_token, opts)
+      data
+    end
+
+    # Returns a list of `Company` objects.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
+    # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
+    # @option opts [String] :cursor The pagination cursor value.
+    # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
+    # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
+    # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
+    # @option opts [Integer] :page_size Number of results to return per page.
+    # @option opts [String] :remote_id The API provider's ID for the given object.
+    # @return [Array<(PaginatedCompanyList, Integer, Hash)>] PaginatedCompanyList data, response status code and response headers
+    def companies_list_with_http_info(x_account_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CompaniesApi.companies_list ...'
+      end
+      # verify the required parameter 'x_account_token' is set
+      if @api_client.config.client_side_validation && x_account_token.nil?
+        fail ArgumentError, "Missing the required parameter 'x_account_token' when calling CompaniesApi.companies_list"
+      end
+      # resource path
+      local_var_path = '/companies'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
+      query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
+      query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
+      query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].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[:'X-Account-Token'] = x_account_token
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PaginatedCompanyList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"CompaniesApi.companies_list",
+        :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: CompaniesApi#companies_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns a `Company` object with the given `id`.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
+    # @return [Company]
+    def companies_retrieve(x_account_token, id, opts = {})
+      data, _status_code, _headers = companies_retrieve_with_http_info(x_account_token, id, opts)
+      data
+    end
+
+    # Returns a &#x60;Company&#x60; object with the given &#x60;id&#x60;.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
+    # @return [Array<(Company, Integer, Hash)>] Company data, response status code and response headers
+    def companies_retrieve_with_http_info(x_account_token, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CompaniesApi.companies_retrieve ...'
+      end
+      # verify the required parameter 'x_account_token' is set
+      if @api_client.config.client_side_validation && x_account_token.nil?
+        fail ArgumentError, "Missing the required parameter 'x_account_token' when calling CompaniesApi.companies_retrieve"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling CompaniesApi.companies_retrieve"
+      end
+      # resource path
+      local_var_path = '/companies/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].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[:'X-Account-Token'] = x_account_token
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Company'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"CompaniesApi.companies_retrieve",
+        :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: CompaniesApi#companies_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end