class MergeHRISClient::BenefitsApi
Attributes
Public Class Methods
# File lib/merge_hris_client/api/benefits_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Creates a `Benefit` object with the given values. @param x_account_token [String] Token identifying the end user. @param [Hash] opts the optional parameters @option opts [Boolean] :run_async Whether or not third-party updates should be run asynchronously. @option opts [BenefitRequest] :benefit_request @return [Benefit]
# File lib/merge_hris_client/api/benefits_api.rb, line 28 def benefits_create(x_account_token, opts = {}) data, _status_code, _headers = benefits_create_with_http_info(x_account_token, opts) data end
Creates a `Benefit` object with the given values. @param x_account_token [String] Token identifying the end user. @param [Hash] opts the optional parameters @option opts [Boolean] :run_async Whether or not third-party updates should be run asynchronously. @option opts [BenefitRequest] :benefit_request @return [Array<(Benefit
, Integer, Hash)>] Benefit
data, response status code and response headers
# File lib/merge_hris_client/api/benefits_api.rb, line 39 def benefits_create_with_http_info(x_account_token, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BenefitsApi.benefits_create ...' 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_create" end # resource path local_var_path = '/benefits' # query parameters query_params = opts[:query_params] || {} query_params[:'run_async'] = opts[:'run_async'] if !opts[:'run_async'].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', 'application/x-www-form-urlencoded', 'multipart/form-data']) header_params[:'X-Account-Token'] = x_account_token # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'benefit_request']) # 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_create", :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, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: BenefitsApi#benefits_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers 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]
# File lib/merge_hris_client/api/benefits_api.rb, line 105 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
# File lib/merge_hris_client/api/benefits_api.rb, line 124 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]
# File lib/merge_hris_client/api/benefits_api.rb, line 194 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 `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 [Array<(Benefit
, Integer, Hash)>] Benefit
data, response status code and response headers
# File lib/merge_hris_client/api/benefits_api.rb, line 206 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