Skip to content

Latest commit

 

History

History
177 lines (126 loc) · 6.57 KB

EmployerBenefitsApi.md

File metadata and controls

177 lines (126 loc) · 6.57 KB
Raw

MergeHRISClient::EmployerBenefitsApi

All URIs are relative to https://api.merge.dev/api/hris/v1

Method HTTP request Description
employer_benefits_list GET /employer-benefits
employer_benefits_retrieve GET /employer-benefits/{id}

employer_benefits_list

employer_benefits_list(x_account_token, opts)

Returns a list of EmployerBenefit objects.

Examples

require 'time'
require 'merge_hris_client'
# setup authorization
MergeHRISClient.configure do |config|
  # Configure API key authorization: tokenAuth
  config.api_key['tokenAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['tokenAuth'] = 'Bearer'
end

api_instance = MergeHRISClient::EmployerBenefitsApi.new
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
opts = {
  created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
  created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
  include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
  page_size: 56, # Integer | Number of results to return per page.
  remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
}

begin
  
  result = api_instance.employer_benefits_list(x_account_token, opts)
  p result
rescue MergeHRISClient::ApiError => e
  puts "Error when calling EmployerBenefitsApi->employer_benefits_list: #{e}"
end

Using the employer_benefits_list_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> employer_benefits_list_with_http_info(x_account_token, opts)

begin
  
  data, status_code, headers = api_instance.employer_benefits_list_with_http_info(x_account_token, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PaginatedEmployerBenefitList>
rescue MergeHRISClient::ApiError => e
  puts "Error when calling EmployerBenefitsApi->employer_benefits_list_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
x_account_token String Token identifying the end user.
created_after Time If provided, will only return objects created after this datetime. [optional]
created_before Time If provided, will only return objects created before this datetime. [optional]
cursor String The pagination cursor value. [optional]
include_deleted_data Boolean Whether to include data that was marked as deleted by third party webhooks. [optional]
include_remote_data Boolean Whether to include the original data Merge fetched from the third-party to produce these models. [optional]
modified_after Time If provided, only objects synced by Merge after this date time will be returned. [optional]
modified_before Time If provided, only objects synced by Merge before this date time will be returned. [optional]
page_size Integer Number of results to return per page. [optional]
remote_id String The API provider's ID for the given object. [optional]

Return type

PaginatedEmployerBenefitList

Authorization

tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

employer_benefits_retrieve

employer_benefits_retrieve(x_account_token, id, opts)

Returns an EmployerBenefit object with the given id.

Examples

require 'time'
require 'merge_hris_client'
# setup authorization
MergeHRISClient.configure do |config|
  # Configure API key authorization: tokenAuth
  config.api_key['tokenAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['tokenAuth'] = 'Bearer'
end

api_instance = MergeHRISClient::EmployerBenefitsApi.new
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
id = TODO # String | 
opts = {
  include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
}

begin
  
  result = api_instance.employer_benefits_retrieve(x_account_token, id, opts)
  p result
rescue MergeHRISClient::ApiError => e
  puts "Error when calling EmployerBenefitsApi->employer_benefits_retrieve: #{e}"
end

Using the employer_benefits_retrieve_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> employer_benefits_retrieve_with_http_info(x_account_token, id, opts)

begin
  
  data, status_code, headers = api_instance.employer_benefits_retrieve_with_http_info(x_account_token, id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EmployerBenefit>
rescue MergeHRISClient::ApiError => e
  puts "Error when calling EmployerBenefitsApi->employer_benefits_retrieve_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
x_account_token String Token identifying the end user.
id String
include_remote_data Boolean Whether to include the original data Merge fetched from the third-party to produce these models. [optional]

Return type

EmployerBenefit

Authorization

tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json