merge_hris_client 3.0.0 → 3.1.0

data/docs/TimeOffBalancesApi.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.
+  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.
-  policy_type: 'BEREAVEMENT', # String | If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
-  remote_fields: 'policy_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.
+  policy_type: 'BEREAVEMENT', # String | If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')  * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT
+  remote_fields: 'policy_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: 'policy_type' # String | Which fields should be returned in non-normalized form.
 }
 
 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] |
+| **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] |
-| **policy_type** | **String** | If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') | [optional] |
-| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
+| **policy_type** | **String** | If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')  * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT | [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** | Which fields should be returned in non-normalized form. | [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: 'policy_type' # String | Which fields should be returned in non-normalized form.
+  remote_fields: 'policy_type', # String | Deprecated. Use show_enum_origins.
+  show_enum_origins: 'policy_type' # String | Which fields should be returned in non-normalized form.
 }
 
 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** | Which fields should be returned in non-normalized form. | [optional] |
 
 ### Return type
 

data/docs/TimeOffRequest.md

@@ -4,16 +4,17 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
-| **employee** | **String** |  | [optional] |
-| **approver** | **String** |  | [optional] |
-| **status** | [**TimeOffStatusEnum**](TimeOffStatusEnum.md) | The status of this time off request. | [optional] |
+| **employee** | **String** | The employee requesting time off. | [optional] |
+| **approver** | **String** | The Merge ID of the employee with the ability to approve the time off request. | [optional] |
+| **status** | [**TimeOffStatusEnum**](TimeOffStatusEnum.md) | The status of this time off request.  * `REQUESTED` - REQUESTED * `APPROVED` - APPROVED * `DECLINED` - DECLINED * `CANCELLED` - CANCELLED * `DELETED` - DELETED | [optional] |
 | **employee_note** | **String** | The employee note for this time off request. | [optional] |
-| **units** | [**UnitsEnum**](UnitsEnum.md) | The unit of time requested. | [optional] |
-| **amount** | **Float** | The number of time off units requested. | [optional] |
-| **request_type** | [**RequestTypeEnum**](RequestTypeEnum.md) | The type of time off request. | [optional] |
+| **units** | [**UnitsEnum**](UnitsEnum.md) | The measurement that the third-party integration uses to count time requested.  * `HOURS` - HOURS * `DAYS` - DAYS | [optional] |
+| **amount** | **Float** | The time off quantity measured by the prescribed “units”. | [optional] |
+| **request_type** | [**RequestTypeEnum**](RequestTypeEnum.md) | The type of time off request.  * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT | [optional] |
 | **start_time** | **Time** | The day and time of the start of the time requested off. | [optional] |
 | **end_time** | **Time** | The day and time of the end of the time requested off. | [optional] |
+| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional] |
+| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional] |
 
 ## Example
 
@@ -21,7 +22,6 @@
 require 'merge_hris_client'
 
 instance = MergeHRISClient::TimeOffRequest.new(
-  remote_id: 19202938,
   employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
   approver: 9efbc633-3387-4306-aa55-e2c635e6bb4f,
   status: APPROVED,
@@ -30,7 +30,9 @@ instance = MergeHRISClient::TimeOffRequest.new(
   amount: 3,
   request_type: VACATION,
   start_time: 2020-11-10T00:00Z,
-  end_time: 2020-11-17T00:00Z
+  end_time: 2020-11-17T00:00Z,
+  integration_params: {"unique_integration_field":"unique_integration_field_value"},
+  linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
 )
 ```
 

data/lib/merge_hris_client/api/bank_info_api.rb

@@ -22,7 +22,7 @@ module MergeHRISClient
     # Returns a list of `BankInfo` objects.
     # @param x_account_token [String] Token identifying the end user.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :account_type If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')
+    # @option opts [String] :account_type If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')  * `SAVINGS` - SAVINGS * `CHECKING` - CHECKING
     # @option opts [String] :bank_name If provided, will only return BankInfo's with this bank name.
     # @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.
@@ -31,12 +31,13 @@ module MergeHRISClient
     # @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_deleted_data Whether to include data that was marked as deleted by third party webhooks.
     # @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 [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
+    # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
     # @option opts [String] :order_by Overrides the default ordering for this endpoint.
     # @option opts [Integer] :page_size Number of results to return per page.
-    # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
+    # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
     # @option opts [String] :remote_id The API provider's ID for the given object.
+    # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
     # @return [PaginatedBankInfoList]
     def bank_info_list(x_account_token, opts = {})
       data, _status_code, _headers = bank_info_list_with_http_info(x_account_token, opts)
@@ -46,7 +47,7 @@ module MergeHRISClient
     # Returns a list of `BankInfo` objects.
     # @param x_account_token [String] Token identifying the end user.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :account_type If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')
+    # @option opts [String] :account_type If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')  * `SAVINGS` - SAVINGS * `CHECKING` - CHECKING
     # @option opts [String] :bank_name If provided, will only return BankInfo's with this bank name.
     # @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.
@@ -55,12 +56,13 @@ module MergeHRISClient
     # @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_deleted_data Whether to include data that was marked as deleted by third party webhooks.
     # @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 [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
+    # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
     # @option opts [String] :order_by Overrides the default ordering for this endpoint.
     # @option opts [Integer] :page_size Number of results to return per page.
-    # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
+    # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
     # @option opts [String] :remote_id The API provider's ID for the given object.
+    # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
     # @return [Array<(PaginatedBankInfoList, Integer, Hash)>] PaginatedBankInfoList data, response status code and response headers
     def bank_info_list_with_http_info(x_account_token, opts = {})
       if @api_client.config.debugging
@@ -86,6 +88,10 @@ module MergeHRISClient
       if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
         fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
       end
+      allowable_values = ["account_type"]
+      if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
+        fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
+      end
       # resource path
       local_var_path = '/bank-info'
 
@@ -106,6 +112,7 @@ module MergeHRISClient
       query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
       query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
       query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
+      query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -148,7 +155,8 @@ module MergeHRISClient
     # @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.
-    # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
+    # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
+    # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
     # @return [BankInfo]
     def bank_info_retrieve(x_account_token, id, opts = {})
       data, _status_code, _headers = bank_info_retrieve_with_http_info(x_account_token, id, opts)
@@ -161,7 +169,8 @@ module MergeHRISClient
     # @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.
-    # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
+    # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
+    # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
     # @return [Array<(BankInfo, Integer, Hash)>] BankInfo data, response status code and response headers
     def bank_info_retrieve_with_http_info(x_account_token, id, opts = {})
       if @api_client.config.debugging
@@ -183,6 +192,10 @@ module MergeHRISClient
       if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
         fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
       end
+      allowable_values = ["account_type"]
+      if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
+        fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
+      end
       # resource path
       local_var_path = '/bank-info/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
 
@@ -191,6 +204,7 @@ module MergeHRISClient
       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[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
+      query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/merge_hris_client/api/benefits_api.rb

@@ -25,12 +25,12 @@ module MergeHRISClient
     # @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] :employee_id If provided, will return the benefits associated with the 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_deleted_data Whether to include data that was marked as deleted by third party webhooks.
     # @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 [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
+    # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
     # @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]
@@ -45,12 +45,12 @@ module MergeHRISClient
     # @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] :employee_id If provided, will return the benefits associated with the 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_deleted_data Whether to include data that was marked as deleted by third party webhooks.
     # @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 [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
+    # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
     # @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

data/lib/merge_hris_client/api/common_model_scopes_api.rb

@@ -0,0 +1,146 @@
+=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.1.1
+
+=end
+
+require 'cgi'
+
+module MergeHRISClient
+  class CommonModelScopesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Update the configuration of what data is saved by Merge when syncing. Common model scopes are set as a default across all linked accounts, but can be updated to have greater granularity per account.
+    # @param common_model_scopes_update_serializer [CommonModelScopesUpdateSerializer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :linked_account_id ID of specific linked account to fetch
+    # @return [CommonModelScopes]
+    def common_model_scopes_create(common_model_scopes_update_serializer, opts = {})
+      data, _status_code, _headers = common_model_scopes_create_with_http_info(common_model_scopes_update_serializer, opts)
+      data
+    end
+
+    # Update the configuration of what data is saved by Merge when syncing. Common model scopes are set as a default across all linked accounts, but can be updated to have greater granularity per account.
+    # @param common_model_scopes_update_serializer [CommonModelScopesUpdateSerializer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :linked_account_id ID of specific linked account to fetch
+    # @return [Array<(CommonModelScopes, Integer, Hash)>] CommonModelScopes data, response status code and response headers
+    def common_model_scopes_create_with_http_info(common_model_scopes_update_serializer, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CommonModelScopesApi.common_model_scopes_create ...'
+      end
+      # verify the required parameter 'common_model_scopes_update_serializer' is set
+      if @api_client.config.client_side_validation && common_model_scopes_update_serializer.nil?
+        fail ArgumentError, "Missing the required parameter 'common_model_scopes_update_serializer' when calling CommonModelScopesApi.common_model_scopes_create"
+      end
+      # resource path
+      local_var_path = '/common-model-scopes'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'linked_account_id'] = opts[:'linked_account_id'] if !opts[:'linked_account_id'].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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(common_model_scopes_update_serializer)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CommonModelScopes'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"CommonModelScopesApi.common_model_scopes_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: CommonModelScopesApi#common_model_scopes_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Fetch the configuration of what data is saved by Merge when syncing. Common model scopes are set as a default across all linked accounts, but can be updated to have greater granularity per account.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :linked_account_id ID of specific linked account to fetch
+    # @return [CommonModelScopes]
+    def common_model_scopes_retrieve(opts = {})
+      data, _status_code, _headers = common_model_scopes_retrieve_with_http_info(opts)
+      data
+    end
+
+    # Fetch the configuration of what data is saved by Merge when syncing. Common model scopes are set as a default across all linked accounts, but can be updated to have greater granularity per account.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :linked_account_id ID of specific linked account to fetch
+    # @return [Array<(CommonModelScopes, Integer, Hash)>] CommonModelScopes data, response status code and response headers
+    def common_model_scopes_retrieve_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CommonModelScopesApi.common_model_scopes_retrieve ...'
+      end
+      # resource path
+      local_var_path = '/common-model-scopes'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'linked_account_id'] = opts[:'linked_account_id'] if !opts[:'linked_account_id'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CommonModelScopes'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"CommonModelScopesApi.common_model_scopes_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: CommonModelScopesApi#common_model_scopes_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

@@ -27,8 +27,8 @@ module MergeHRISClient
     # @option opts [String] :cursor The pagination cursor value.
     # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
     # @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 [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
+    # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
     # @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]
@@ -45,8 +45,8 @@ module MergeHRISClient
     # @option opts [String] :cursor The pagination cursor value.
     # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
     # @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 [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
+    # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
     # @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

data/lib/merge_hris_client/api/employee_payroll_runs_api.rb

@@ -31,8 +31,8 @@ module MergeHRISClient
     # @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_deleted_data Whether to include data that was marked as deleted by third party webhooks.
     # @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 [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
+    # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
     # @option opts [Integer] :page_size Number of results to return per page.
     # @option opts [String] :payroll_run_id If provided, will only return employee payroll runs for this employee.
     # @option opts [String] :remote_id The API provider's ID for the given object.
@@ -56,8 +56,8 @@ module MergeHRISClient
     # @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_deleted_data Whether to include data that was marked as deleted by third party webhooks.
     # @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 [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
+    # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
     # @option opts [Integer] :page_size Number of results to return per page.
     # @option opts [String] :payroll_run_id If provided, will only return employee payroll runs for this employee.
     # @option opts [String] :remote_id The API provider's ID for the given object.

data/lib/merge_hris_client/api/employees_api.rb

@@ -100,10 +100,10 @@ module MergeHRISClient
     # @param model_id [String] 
     # @param ignore_common_model_request [IgnoreCommonModelRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [IgnoreCommonModel]
+    # @return [nil]
     def employees_ignore_create(x_account_token, model_id, ignore_common_model_request, opts = {})
-      data, _status_code, _headers = employees_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request, opts)
-      data
+      employees_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request, opts)
+      nil
     end
 
     # Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The \"reason\" and \"message\" fields in the request body will be stored for audit purposes.
@@ -111,7 +111,7 @@ module MergeHRISClient
     # @param model_id [String] 
     # @param ignore_common_model_request [IgnoreCommonModelRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(IgnoreCommonModel, Integer, Hash)>] IgnoreCommonModel data, response status code and response headers
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def employees_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: EmployeesApi.employees_ignore_create ...'
@@ -136,8 +136,6 @@ module MergeHRISClient
 
       # 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
@@ -149,7 +147,7 @@ module MergeHRISClient
       post_body = opts[:debug_body] || @api_client.object_to_http_body(ignore_common_model_request)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'IgnoreCommonModel'
+      return_type = opts[:debug_return_type]
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['tokenAuth']
@@ -179,22 +177,28 @@ module MergeHRISClient
     # @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] :display_full_name If provided, will only return employees with this display name.
-    # @option opts [String] :employment_status If provided, will only return employees with this employment status.
+    # @option opts [String] :employment_status If provided, will only return employees with this employment status.  * &#x60;ACTIVE&#x60; - ACTIVE * &#x60;PENDING&#x60; - PENDING * &#x60;INACTIVE&#x60; - INACTIVE
     # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
     # @option opts [String] :first_name If provided, will only return employees with this first name.
+    # @option opts [String] :groups If provided, will only return employees matching the group ids; multiple groups can be separated by commas.
     # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
     # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
     # @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
     # @option opts [String] :last_name If provided, will only return employees with this last name.
     # @option opts [String] :manager_id If provided, will only return employees for this manager.
-    # @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 [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
+    # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
     # @option opts [Integer] :page_size Number of results to return per page.
     # @option opts [String] :pay_group_id If provided, will only return employees for this pay group
     # @option opts [String] :personal_email If provided, will only return Employees with this personal email
-    # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
+    # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
     # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
+    # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
+    # @option opts [Time] :started_after If provided, will only return employees that started after this datetime.
+    # @option opts [Time] :started_before If provided, will only return employees that started before this datetime.
     # @option opts [String] :team_id If provided, will only return employees for this team.
+    # @option opts [Time] :terminated_after If provided, will only return employees that were terminated after this datetime.
+    # @option opts [Time] :terminated_before If provided, will only return employees that were terminated before this datetime.
     # @option opts [String] :work_email If provided, will only return Employees with this work email
     # @option opts [String] :work_location_id If provided, will only return employees for this location.
     # @return [PaginatedEmployeeList]
@@ -211,22 +215,28 @@ module MergeHRISClient
     # @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] :display_full_name If provided, will only return employees with this display name.
-    # @option opts [String] :employment_status If provided, will only return employees with this employment status.
+    # @option opts [String] :employment_status If provided, will only return employees with this employment status.  * &#x60;ACTIVE&#x60; - ACTIVE * &#x60;PENDING&#x60; - PENDING * &#x60;INACTIVE&#x60; - INACTIVE
     # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
     # @option opts [String] :first_name If provided, will only return employees with this first name.
+    # @option opts [String] :groups If provided, will only return employees matching the group ids; multiple groups can be separated by commas.
     # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
     # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
     # @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
     # @option opts [String] :last_name If provided, will only return employees with this last name.
     # @option opts [String] :manager_id If provided, will only return employees for this manager.
-    # @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 [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
+    # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
     # @option opts [Integer] :page_size Number of results to return per page.
     # @option opts [String] :pay_group_id If provided, will only return employees for this pay group
     # @option opts [String] :personal_email If provided, will only return Employees with this personal email
-    # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
+    # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
     # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
+    # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
+    # @option opts [Time] :started_after If provided, will only return employees that started after this datetime.
+    # @option opts [Time] :started_before If provided, will only return employees that started before this datetime.
     # @option opts [String] :team_id If provided, will only return employees for this team.
+    # @option opts [Time] :terminated_after If provided, will only return employees that were terminated after this datetime.
+    # @option opts [Time] :terminated_before If provided, will only return employees that were terminated before this datetime.
     # @option opts [String] :work_email If provided, will only return Employees with this work email
     # @option opts [String] :work_location_id If provided, will only return employees for this location.
     # @return [Array<(PaginatedEmployeeList, Integer, Hash)>] PaginatedEmployeeList data, response status code and response headers
@@ -250,6 +260,10 @@ module MergeHRISClient
       if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
         fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
       end
+      allowable_values = ["employment_status", "employment_status,ethnicity", "employment_status,ethnicity,gender", "employment_status,ethnicity,gender,marital_status", "employment_status,ethnicity,marital_status", "employment_status,gender", "employment_status,gender,marital_status", "employment_status,marital_status", "ethnicity", "ethnicity,gender", "ethnicity,gender,marital_status", "ethnicity,marital_status", "gender", "gender,marital_status", "marital_status"]
+      if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
+        fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
+      end
       # resource path
       local_var_path = '/employees'
 
@@ -263,6 +277,7 @@ module MergeHRISClient
       query_params[:'employment_status'] = opts[:'employment_status'] if !opts[:'employment_status'].nil?
       query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
       query_params[:'first_name'] = opts[:'first_name'] if !opts[:'first_name'].nil?
+      query_params[:'groups'] = opts[:'groups'] if !opts[:'groups'].nil?
       query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
       query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
       query_params[:'include_sensitive_fields'] = opts[:'include_sensitive_fields'] if !opts[:'include_sensitive_fields'].nil?
@@ -275,7 +290,12 @@ module MergeHRISClient
       query_params[:'personal_email'] = opts[:'personal_email'] if !opts[:'personal_email'].nil?
       query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
       query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
+      query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?
+      query_params[:'started_after'] = opts[:'started_after'] if !opts[:'started_after'].nil?
+      query_params[:'started_before'] = opts[:'started_before'] if !opts[:'started_before'].nil?
       query_params[:'team_id'] = opts[:'team_id'] if !opts[:'team_id'].nil?
+      query_params[:'terminated_after'] = opts[:'terminated_after'] if !opts[:'terminated_after'].nil?
+      query_params[:'terminated_before'] = opts[:'terminated_before'] if !opts[:'terminated_before'].nil?
       query_params[:'work_email'] = opts[:'work_email'] if !opts[:'work_email'].nil?
       query_params[:'work_location_id'] = opts[:'work_location_id'] if !opts[:'work_location_id'].nil?
 
@@ -383,7 +403,8 @@ module MergeHRISClient
     # @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 [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
-    # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
+    # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
+    # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
     # @return [Employee]
     def employees_retrieve(x_account_token, id, opts = {})
       data, _status_code, _headers = employees_retrieve_with_http_info(x_account_token, id, opts)
@@ -397,7 +418,8 @@ module MergeHRISClient
     # @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 [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
-    # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
+    # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
+    # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
     # @return [Array<(Employee, Integer, Hash)>] Employee data, response status code and response headers
     def employees_retrieve_with_http_info(x_account_token, id, opts = {})
       if @api_client.config.debugging
@@ -419,6 +441,10 @@ module MergeHRISClient
       if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
         fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
       end
+      allowable_values = ["employment_status", "employment_status,ethnicity", "employment_status,ethnicity,gender", "employment_status,ethnicity,gender,marital_status", "employment_status,ethnicity,marital_status", "employment_status,gender", "employment_status,gender,marital_status", "employment_status,marital_status", "ethnicity", "ethnicity,gender", "ethnicity,gender,marital_status", "ethnicity,marital_status", "gender", "gender,marital_status", "marital_status"]
+      if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
+        fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
+      end
       # resource path
       local_var_path = '/employees/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
 
@@ -428,6 +454,7 @@ module MergeHRISClient
       query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
       query_params[:'include_sensitive_fields'] = opts[:'include_sensitive_fields'] if !opts[:'include_sensitive_fields'].nil?
       query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
+      query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}