merge_hris_client 2.0.4 → 3.2.2

data/docs/EmploymentsApi.md

@@ -39,12 +39,13 @@ opts = {
   expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
   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, will only return objects modified after this datetime.
-  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
-  order_by: '-effective_date', # String | Overrides the default ordering for this endpoint.
+  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.
+  order_by: '-effective_date', # String | Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date.
   page_size: 56, # Integer | Number of results to return per page.
-  remote_fields: 'employment_type', # String | Which fields should be returned in non-normalized form.
-  remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
+  remote_fields: 'employment_type', # String | Deprecated. Use show_enum_origins.
+  remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
+  show_enum_origins: 'employment_type' # String | A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
 }
 
 begin
@@ -86,12 +87,13 @@ end
 | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [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, will only return objects modified after this datetime. | [optional] |
-| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
-| **order_by** | **String** | Overrides the default ordering for this endpoint. | [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] |
+| **order_by** | **String** | Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date. | [optional] |
 | **page_size** | **Integer** | Number of results to return per page. | [optional] |
-| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
+| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
 | **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
+| **show_enum_origins** | **String** | A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) | [optional] |
 
 ### Return type
 
@@ -134,7 +136,8 @@ id = TODO # String |
 opts = {
   expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
   include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
-  remote_fields: 'employment_type' # String | Which fields should be returned in non-normalized form.
+  remote_fields: 'employment_type', # String | Deprecated. Use show_enum_origins.
+  show_enum_origins: 'employment_type' # String | A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
 }
 
 begin
@@ -172,7 +175,8 @@ end
 | **id** | [**String**](.md) |  |  |
 | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
 | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
-| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
+| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
+| **show_enum_origins** | **String** | A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) | [optional] |
 
 ### Return type
 

data/docs/EnabledActionsEnum.md

@@ -0,0 +1,15 @@
+# MergeHRISClient::EnabledActionsEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::EnabledActionsEnum.new()
+```
+

data/docs/EndUserDetailsRequest.md

@@ -4,12 +4,17 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **end_user_email_address** | **String** |  |  |
-| **end_user_organization_name** | **String** |  |  |
-| **end_user_origin_id** | **String** |  |  |
-| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) |  |  |
-| **integration** | **String** | The slug of a specific pre-selected integration for this linking flow token, for examples of slugs see https://www.merge.dev/docs/basics/integration-metadata | [optional] |
-| **link_expiry_mins** | **Integer** | An integer number of minutes between [30, 720] for how long this token is valid. Defaults to 30 | [optional][default to 30] |
+| **end_user_email_address** | **String** | Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent. |  |
+| **end_user_organization_name** | **String** | Your end user's organization. |  |
+| **end_user_origin_id** | **String** | This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers. |  |
+| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | The integration categories to show in Merge Link. |  |
+| **integration** | **String** | The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/. | [optional] |
+| **link_expiry_mins** | **Integer** | An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30. | [optional][default to 30] |
+| **should_create_magic_link_url** | **Boolean** | Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. | [optional][default to false] |
+| **common_models** | [**Array<CommonModelScopesBodyRequest>**](CommonModelScopesBodyRequest.md) | An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account. | [optional] |
+| **category_common_model_scopes** | **Hash<String, Array<IndividualCommonModelScopeDeserializerRequest>>** | When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings. | [optional] |
+| **language** | **String** | The language code for the language to localize Merge Link to. | [optional] |
+| **integration_specific_config** | [**Hash<String, AnyType>**](AnyType.md) | A JSON object containing integration-specific configuration options. | [optional] |
 
 ## Example
 
@@ -17,12 +22,17 @@
 require 'merge_hris_client'
 
 instance = MergeHRISClient::EndUserDetailsRequest.new(
-  end_user_email_address: null,
-  end_user_organization_name: null,
-  end_user_origin_id: null,
-  categories: null,
-  integration: null,
-  link_expiry_mins: null
+  end_user_email_address: example@gmail.com,
+  end_user_organization_name: Test Organization,
+  end_user_origin_id: 12345,
+  categories: ["hris","ats"],
+  integration: bamboohr,
+  link_expiry_mins: null,
+  should_create_magic_link_url: null,
+  common_models: null,
+  category_common_model_scopes: {"hris":[{"model_name":"Employee","model_permissions":{"READ":{"is_enabled":true},"WRITE":{"is_enabled":true}},"field_permissions":{"enabled":["first_name","last_name","personal_email"],"disabled":["preferred_name"]}},{"model_name":"Employment","model_permissions":{"READ":{"is_enabled":false},"WRITE":{"is_enabled":false}},"field_permissions":{"enabled":["effective_date"]}}],"ats":[{"model_name":"Job","model_permissions":{"READ":{"is_enabled":true},"WRITE":{"is_enabled":true}},"field_permissions":{"enabled":["name"],"disabled":["description"]}},{"model_name":"Department","model_permissions":{"READ":{"is_enabled":true},"WRITE":{"is_enabled":true}}}]},
+  language: null,
+  integration_specific_config: {"rippling":{"oauth_code":"3h1jj8ssdf31dfji3o1jjdfjasd"}}
 )
 ```
 

data/docs/EventTypeEnum.md

@@ -0,0 +1,15 @@
+# MergeHRISClient::EventTypeEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::EventTypeEnum.new()
+```
+

data/docs/ExternalTargetFieldAPI.md

@@ -0,0 +1,22 @@
+# MergeHRISClient::ExternalTargetFieldAPI
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional][readonly] |
+| **description** | **String** |  | [optional][readonly] |
+| **is_mapped** | **String** |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::ExternalTargetFieldAPI.new(
+  name: example_target_field_name,
+  description: this is a example description of a target field,
+  is_mapped: true
+)
+```
+

data/docs/ExternalTargetFieldAPIResponse.md

@@ -0,0 +1,48 @@
+# MergeHRISClient::ExternalTargetFieldAPIResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **benefit** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **employer_benefit** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **company** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **employee_payroll_run** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **employee** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **employment** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **location** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **payroll_run** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **team** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **time_off** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **time_off_balance** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **bank_info** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **pay_group** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **group** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **dependent** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **timesheet_entry** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::ExternalTargetFieldAPIResponse.new(
+  benefit: null,
+  employer_benefit: null,
+  company: null,
+  employee_payroll_run: null,
+  employee: null,
+  employment: null,
+  location: null,
+  payroll_run: null,
+  team: null,
+  time_off: null,
+  time_off_balance: null,
+  bank_info: null,
+  pay_group: null,
+  group: null,
+  dependent: null,
+  timesheet_entry: null
+)
+```
+

data/docs/FieldMappingApi.md

@@ -0,0 +1,455 @@
+# MergeHRISClient::FieldMappingApi
+
+All URIs are relative to *https://api.merge.dev/api/hris/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**field_mappings_create**](FieldMappingApi.md#field_mappings_create) | **POST** /field-mappings |  |
+| [**field_mappings_destroy**](FieldMappingApi.md#field_mappings_destroy) | **DELETE** /field-mappings/{field_mapping_id} |  |
+| [**field_mappings_partial_update**](FieldMappingApi.md#field_mappings_partial_update) | **PATCH** /field-mappings/{field_mapping_id} |  |
+| [**field_mappings_retrieve**](FieldMappingApi.md#field_mappings_retrieve) | **GET** /field-mappings |  |
+| [**remote_fields_retrieve**](FieldMappingApi.md#remote_fields_retrieve) | **GET** /remote-fields |  |
+| [**target_fields_retrieve**](FieldMappingApi.md#target_fields_retrieve) | **GET** /target-fields |  |
+
+
+## field_mappings_create
+
+> <FieldMappingInstanceResponse> field_mappings_create(x_account_token, create_field_mapping_request)
+
+
+
+Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+### Examples
+
+```ruby
+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::FieldMappingApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+create_field_mapping_request = MergeHRISClient::CreateFieldMappingRequest.new({target_field_name: 'example_target_field_name', target_field_description: 'this is a example description of the target field', remote_field_traversal_path: [TODO], remote_method: 'GET', remote_url_path: '/example-url-path', common_model_name: 'ExampleCommonModel'}) # CreateFieldMappingRequest | 
+
+begin
+  
+  result = api_instance.field_mappings_create(x_account_token, create_field_mapping_request)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling FieldMappingApi->field_mappings_create: #{e}"
+end
+```
+
+#### Using the field_mappings_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FieldMappingInstanceResponse>, Integer, Hash)> field_mappings_create_with_http_info(x_account_token, create_field_mapping_request)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.field_mappings_create_with_http_info(x_account_token, create_field_mapping_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FieldMappingInstanceResponse>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling FieldMappingApi->field_mappings_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **create_field_mapping_request** | [**CreateFieldMappingRequest**](CreateFieldMappingRequest.md) |  |  |
+
+### Return type
+
+[**FieldMappingInstanceResponse**](FieldMappingInstanceResponse.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## field_mappings_destroy
+
+> <FieldMappingInstanceResponse> field_mappings_destroy(x_account_token, field_mapping_id)
+
+
+
+Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+### Examples
+
+```ruby
+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::FieldMappingApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+field_mapping_id = TODO # String | 
+
+begin
+  
+  result = api_instance.field_mappings_destroy(x_account_token, field_mapping_id)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling FieldMappingApi->field_mappings_destroy: #{e}"
+end
+```
+
+#### Using the field_mappings_destroy_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FieldMappingInstanceResponse>, Integer, Hash)> field_mappings_destroy_with_http_info(x_account_token, field_mapping_id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.field_mappings_destroy_with_http_info(x_account_token, field_mapping_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FieldMappingInstanceResponse>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling FieldMappingApi->field_mappings_destroy_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **field_mapping_id** | [**String**](.md) |  |  |
+
+### Return type
+
+[**FieldMappingInstanceResponse**](FieldMappingInstanceResponse.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## field_mappings_partial_update
+
+> <FieldMappingInstanceResponse> field_mappings_partial_update(x_account_token, field_mapping_id, opts)
+
+
+
+Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+### Examples
+
+```ruby
+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::FieldMappingApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+field_mapping_id = TODO # String | 
+opts = {
+  patched_edit_field_mapping_request: MergeHRISClient::PatchedEditFieldMappingRequest.new # PatchedEditFieldMappingRequest | 
+}
+
+begin
+  
+  result = api_instance.field_mappings_partial_update(x_account_token, field_mapping_id, opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling FieldMappingApi->field_mappings_partial_update: #{e}"
+end
+```
+
+#### Using the field_mappings_partial_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FieldMappingInstanceResponse>, Integer, Hash)> field_mappings_partial_update_with_http_info(x_account_token, field_mapping_id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.field_mappings_partial_update_with_http_info(x_account_token, field_mapping_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FieldMappingInstanceResponse>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling FieldMappingApi->field_mappings_partial_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **field_mapping_id** | [**String**](.md) |  |  |
+| **patched_edit_field_mapping_request** | [**PatchedEditFieldMappingRequest**](PatchedEditFieldMappingRequest.md) |  | [optional] |
+
+### Return type
+
+[**FieldMappingInstanceResponse**](FieldMappingInstanceResponse.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## field_mappings_retrieve
+
+> <FieldMappingApiInstanceResponse> field_mappings_retrieve(x_account_token)
+
+
+
+Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+
+### Examples
+
+```ruby
+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::FieldMappingApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+
+begin
+  
+  result = api_instance.field_mappings_retrieve(x_account_token)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling FieldMappingApi->field_mappings_retrieve: #{e}"
+end
+```
+
+#### Using the field_mappings_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FieldMappingApiInstanceResponse>, Integer, Hash)> field_mappings_retrieve_with_http_info(x_account_token)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.field_mappings_retrieve_with_http_info(x_account_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FieldMappingApiInstanceResponse>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling FieldMappingApi->field_mappings_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+
+### Return type
+
+[**FieldMappingApiInstanceResponse**](FieldMappingApiInstanceResponse.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## remote_fields_retrieve
+
+> <RemoteFieldAPIResponse> remote_fields_retrieve(x_account_token, opts)
+
+
+
+Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+
+### Examples
+
+```ruby
+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::FieldMappingApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  common_models: 'common_models_example', # String | A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
+  include_example_values: 'include_example_values_example' # String | If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
+}
+
+begin
+  
+  result = api_instance.remote_fields_retrieve(x_account_token, opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling FieldMappingApi->remote_fields_retrieve: #{e}"
+end
+```
+
+#### Using the remote_fields_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RemoteFieldAPIResponse>, Integer, Hash)> remote_fields_retrieve_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.remote_fields_retrieve_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RemoteFieldAPIResponse>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling FieldMappingApi->remote_fields_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **common_models** | **String** | A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. | [optional] |
+| **include_example_values** | **String** | If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers. | [optional] |
+
+### Return type
+
+[**RemoteFieldAPIResponse**](RemoteFieldAPIResponse.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## target_fields_retrieve
+
+> <ExternalTargetFieldAPIResponse> target_fields_retrieve(x_account_token)
+
+
+
+Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+
+### Examples
+
+```ruby
+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::FieldMappingApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+
+begin
+  
+  result = api_instance.target_fields_retrieve(x_account_token)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling FieldMappingApi->target_fields_retrieve: #{e}"
+end
+```
+
+#### Using the target_fields_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ExternalTargetFieldAPIResponse>, Integer, Hash)> target_fields_retrieve_with_http_info(x_account_token)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.target_fields_retrieve_with_http_info(x_account_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ExternalTargetFieldAPIResponse>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling FieldMappingApi->target_fields_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+
+### Return type
+
+[**ExternalTargetFieldAPIResponse**](ExternalTargetFieldAPIResponse.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+