merge_hris_client 2.0.4 → 3.2.2

data/lib/merge_hris_client/api/issues_api.rb

@@ -19,7 +19,7 @@ module MergeHRISClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Gets issues.
+    # Gets all issues for Organization.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :account_token 
     # @option opts [String] :cursor The pagination cursor value.
@@ -27,20 +27,21 @@ module MergeHRISClient
     # @option opts [String] :end_user_organization_name 
     # @option opts [Time] :first_incident_time_after If provided, will only return issues whose first incident time was after this datetime.
     # @option opts [Time] :first_incident_time_before If provided, will only return issues whose first incident time was before this datetime.
-    # @option opts [String] :include_muted If True, will include muted issues
+    # @option opts [String] :include_muted If true, will include muted issues
     # @option opts [String] :integration_name 
-    # @option opts [Time] :last_incident_time_after If provided, will only return issues whose first incident time was after this datetime.
-    # @option opts [Time] :last_incident_time_before If provided, will only return issues whose first incident time was before this datetime.
+    # @option opts [Time] :last_incident_time_after If provided, will only return issues whose last incident time was after this datetime.
+    # @option opts [Time] :last_incident_time_before If provided, will only return issues whose last incident time was before this datetime.
+    # @option opts [String] :linked_account_id If provided, will only include issues pertaining to the linked account passed in.
     # @option opts [Integer] :page_size Number of results to return per page.
     # @option opts [String] :start_date If included, will only include issues whose most recent action occurred after this time
-    # @option opts [String] :status 
+    # @option opts [String] :status Status of the issue. Options: ('ONGOING', 'RESOLVED')  * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED
     # @return [PaginatedIssueList]
     def issues_list(opts = {})
       data, _status_code, _headers = issues_list_with_http_info(opts)
       data
     end
 
-    # Gets issues.
+    # Gets all issues for Organization.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :account_token 
     # @option opts [String] :cursor The pagination cursor value.
@@ -48,13 +49,14 @@ module MergeHRISClient
     # @option opts [String] :end_user_organization_name 
     # @option opts [Time] :first_incident_time_after If provided, will only return issues whose first incident time was after this datetime.
     # @option opts [Time] :first_incident_time_before If provided, will only return issues whose first incident time was before this datetime.
-    # @option opts [String] :include_muted If True, will include muted issues
+    # @option opts [String] :include_muted If true, will include muted issues
     # @option opts [String] :integration_name 
-    # @option opts [Time] :last_incident_time_after If provided, will only return issues whose first incident time was after this datetime.
-    # @option opts [Time] :last_incident_time_before If provided, will only return issues whose first incident time was before this datetime.
+    # @option opts [Time] :last_incident_time_after If provided, will only return issues whose last incident time was after this datetime.
+    # @option opts [Time] :last_incident_time_before If provided, will only return issues whose last incident time was before this datetime.
+    # @option opts [String] :linked_account_id If provided, will only include issues pertaining to the linked account passed in.
     # @option opts [Integer] :page_size Number of results to return per page.
     # @option opts [String] :start_date If included, will only include issues whose most recent action occurred after this time
-    # @option opts [String] :status 
+    # @option opts [String] :status Status of the issue. Options: ('ONGOING', 'RESOLVED')  * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED
     # @return [Array<(PaginatedIssueList, Integer, Hash)>] PaginatedIssueList data, response status code and response headers
     def issues_list_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -79,6 +81,7 @@ module MergeHRISClient
       query_params[:'integration_name'] = opts[:'integration_name'] if !opts[:'integration_name'].nil?
       query_params[:'last_incident_time_after'] = opts[:'last_incident_time_after'] if !opts[:'last_incident_time_after'].nil?
       query_params[:'last_incident_time_before'] = opts[:'last_incident_time_before'] if !opts[:'last_incident_time_before'].nil?
+      query_params[:'linked_account_id'] = opts[:'linked_account_id'] if !opts[:'linked_account_id'].nil?
       query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
       query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
       query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?

data/lib/merge_hris_client/api/linked_accounts_api.rb

@@ -21,7 +21,7 @@ module MergeHRISClient
     end
     # List linked accounts for your organization.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :category 
+    # @option opts [String] :category Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`  * `hris` - hris * `ats` - ats * `accounting` - accounting * `ticketing` - ticketing * `crm` - crm * `mktg` - mktg * `filestorage` - filestorage * `datawarehouse` - datawarehouse
     # @option opts [String] :cursor The pagination cursor value.
     # @option opts [String] :end_user_email_address If provided, will only return linked accounts associated with the given email address.
     # @option opts [String] :end_user_organization_name If provided, will only return linked accounts associated with the given organization name.
@@ -29,6 +29,7 @@ module MergeHRISClient
     # @option opts [String] :end_user_origin_ids Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
     # @option opts [String] :id 
     # @option opts [String] :ids Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
+    # @option opts [Boolean] :include_duplicates If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
     # @option opts [String] :integration_name If provided, will only return linked accounts associated with the given integration name.
     # @option opts [String] :is_test_account If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
     # @option opts [Integer] :page_size Number of results to return per page.
@@ -41,7 +42,7 @@ module MergeHRISClient
 
     # List linked accounts for your organization.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :category 
+    # @option opts [String] :category Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`  * `hris` - hris * `ats` - ats * `accounting` - accounting * `ticketing` - ticketing * `crm` - crm * `mktg` - mktg * `filestorage` - filestorage * `datawarehouse` - datawarehouse
     # @option opts [String] :cursor The pagination cursor value.
     # @option opts [String] :end_user_email_address If provided, will only return linked accounts associated with the given email address.
     # @option opts [String] :end_user_organization_name If provided, will only return linked accounts associated with the given organization name.
@@ -49,6 +50,7 @@ module MergeHRISClient
     # @option opts [String] :end_user_origin_ids Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
     # @option opts [String] :id 
     # @option opts [String] :ids Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
+    # @option opts [Boolean] :include_duplicates If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
     # @option opts [String] :integration_name If provided, will only return linked accounts associated with the given integration name.
     # @option opts [String] :is_test_account If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
     # @option opts [Integer] :page_size Number of results to return per page.
@@ -58,7 +60,7 @@ module MergeHRISClient
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: LinkedAccountsApi.linked_accounts_list ...'
       end
-      allowable_values = ["accounting", "ats", "crm", "hris", "ticketing"]
+      allowable_values = ["accounting", "ats", "crm", "datawarehouse", "filestorage", "hris", "mktg", "ticketing"]
       if @api_client.config.client_side_validation && opts[:'category'] && !allowable_values.include?(opts[:'category'])
         fail ArgumentError, "invalid value for \"category\", must be one of #{allowable_values}"
       end
@@ -75,6 +77,7 @@ module MergeHRISClient
       query_params[:'end_user_origin_ids'] = opts[:'end_user_origin_ids'] if !opts[:'end_user_origin_ids'].nil?
       query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
       query_params[:'ids'] = opts[:'ids'] if !opts[:'ids'].nil?
+      query_params[:'include_duplicates'] = opts[:'include_duplicates'] if !opts[:'include_duplicates'].nil?
       query_params[:'integration_name'] = opts[:'integration_name'] if !opts[:'integration_name'].nil?
       query_params[:'is_test_account'] = opts[:'is_test_account'] if !opts[:'is_test_account'].nil?
       query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

data/lib/merge_hris_client/api/locations_api.rb

@@ -27,11 +27,13 @@ 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 [String] :location_type If provided, will only return locations with this location_type  * `HOME` - HOME * `WORK` - WORK
+    # @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_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 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)
     # @return [PaginatedLocationList]
     def locations_list(x_account_token, opts = {})
       data, _status_code, _headers = locations_list_with_http_info(x_account_token, opts)
@@ -46,11 +48,13 @@ 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 [String] :location_type If provided, will only return locations with this location_type  * `HOME` - HOME * `WORK` - WORK
+    # @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_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 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)
     # @return [Array<(PaginatedLocationList, Integer, Hash)>] PaginatedLocationList data, response status code and response headers
     def locations_list_with_http_info(x_account_token, opts = {})
       if @api_client.config.debugging
@@ -60,10 +64,18 @@ module MergeHRISClient
       if @api_client.config.client_side_validation && x_account_token.nil?
         fail ArgumentError, "Missing the required parameter 'x_account_token' when calling LocationsApi.locations_list"
       end
+      allowable_values = ["HOME", "WORK"]
+      if @api_client.config.client_side_validation && opts[:'location_type'] && !allowable_values.include?(opts[:'location_type'])
+        fail ArgumentError, "invalid value for \"location_type\", must be one of #{allowable_values}"
+      end
       allowable_values = ["location_type"]
       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 = ["location_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 = '/locations'
 
@@ -74,11 +86,13 @@ module MergeHRISClient
       query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].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[:'location_type'] = opts[:'location_type'] if !opts[:'location_type'].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_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] || {}
@@ -120,7 +134,8 @@ module MergeHRISClient
     # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
-    # @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 A comma separated list of enum field names for which you&#39;d like the original values to be returned, instead of Merge&#39;s normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
     # @return [Location]
     def locations_retrieve(x_account_token, id, opts = {})
       data, _status_code, _headers = locations_retrieve_with_http_info(x_account_token, id, opts)
@@ -132,7 +147,8 @@ module MergeHRISClient
     # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
-    # @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 A comma separated list of enum field names for which you&#39;d like the original values to be returned, instead of Merge&#39;s normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
     # @return [Array<(Location, Integer, Hash)>] Location data, response status code and response headers
     def locations_retrieve_with_http_info(x_account_token, id, opts = {})
       if @api_client.config.debugging
@@ -150,6 +166,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 = ["location_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 = '/locations/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
 
@@ -157,6 +177,7 @@ module MergeHRISClient
       query_params = opts[:query_params] || {}
       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/pay_groups_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 [PaginatedPayGroupList]
@@ -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<(PaginatedPayGroupList, Integer, Hash)>] PaginatedPayGroupList data, response status code and response headers

data/lib/merge_hris_client/api/payroll_runs_api.rb

@@ -29,12 +29,13 @@ module MergeHRISClient
     # @option opts [Time] :ended_before If provided, will only return payroll runs ended before this datetime.
     # @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_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] :run_type If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')
+    # @option opts [String] :run_type If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')  * `REGULAR` - REGULAR * `OFF_CYCLE` - OFF_CYCLE * `CORRECTION` - CORRECTION * `TERMINATION` - TERMINATION * `SIGN_ON_BONUS` - SIGN_ON_BONUS
+    # @option opts [String] :show_enum_origins 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)
     # @option opts [Time] :started_after If provided, will only return payroll runs started after this datetime.
     # @option opts [Time] :started_before If provided, will only return payroll runs started before this datetime.
     # @return [PaginatedPayrollRunList]
@@ -53,12 +54,13 @@ module MergeHRISClient
     # @option opts [Time] :ended_before If provided, will only return payroll runs ended before this datetime.
     # @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_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] :run_type If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')
+    # @option opts [String] :run_type If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')  * `REGULAR` - REGULAR * `OFF_CYCLE` - OFF_CYCLE * `CORRECTION` - CORRECTION * `TERMINATION` - TERMINATION * `SIGN_ON_BONUS` - SIGN_ON_BONUS
+    # @option opts [String] :show_enum_origins 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)
     # @option opts [Time] :started_after If provided, will only return payroll runs started after this datetime.
     # @option opts [Time] :started_before If provided, will only return payroll runs started before this datetime.
     # @return [Array<(PaginatedPayrollRunList, Integer, Hash)>] PaginatedPayrollRunList data, response status code and response headers
@@ -78,6 +80,10 @@ module MergeHRISClient
       if @api_client.config.client_side_validation && opts[:'run_type'] && !allowable_values.include?(opts[:'run_type'])
         fail ArgumentError, "invalid value for \"run_type\", must be one of #{allowable_values}"
       end
+      allowable_values = ["run_state", "run_state,run_type", "run_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 = '/payroll-runs'
 
@@ -96,6 +102,7 @@ module MergeHRISClient
       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[:'run_type'] = opts[:'run_type'] if !opts[:'run_type'].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?
 
@@ -139,7 +146,8 @@ module MergeHRISClient
     # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
-    # @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 A comma separated list of enum field names for which you&#39;d like the original values to be returned, instead of Merge&#39;s normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
     # @return [PayrollRun]
     def payroll_runs_retrieve(x_account_token, id, opts = {})
       data, _status_code, _headers = payroll_runs_retrieve_with_http_info(x_account_token, id, opts)
@@ -151,7 +159,8 @@ module MergeHRISClient
     # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
-    # @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 A comma separated list of enum field names for which you&#39;d like the original values to be returned, instead of Merge&#39;s normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
     # @return [Array<(PayrollRun, Integer, Hash)>] PayrollRun data, response status code and response headers
     def payroll_runs_retrieve_with_http_info(x_account_token, id, opts = {})
       if @api_client.config.debugging
@@ -169,6 +178,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 = ["run_state", "run_state,run_type", "run_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 = '/payroll-runs/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
 
@@ -176,6 +189,7 @@ module MergeHRISClient
       query_params = opts[:query_params] || {}
       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/scopes_api.rb

@@ -0,0 +1,209 @@
+=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 ScopesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+    # @param [Hash] opts the optional parameters
+    # @return [CommonModelScopeAPI]
+    def default_scopes_retrieve(opts = {})
+      data, _status_code, _headers = default_scopes_retrieve_with_http_info(opts)
+      data
+    end
+
+    # Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CommonModelScopeAPI, Integer, Hash)>] CommonModelScopeAPI data, response status code and response headers
+    def default_scopes_retrieve_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ScopesApi.default_scopes_retrieve ...'
+      end
+      # resource path
+      local_var_path = '/default-scopes'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CommonModelScopeAPI'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"ScopesApi.default_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: ScopesApi#default_scopes_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes)
+    # @param x_account_token [String] Token identifying the end user.
+    # @param linked_account_common_model_scope_deserializer_request [LinkedAccountCommonModelScopeDeserializerRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CommonModelScopeAPI]
+    def linked_account_scopes_create(x_account_token, linked_account_common_model_scope_deserializer_request, opts = {})
+      data, _status_code, _headers = linked_account_scopes_create_with_http_info(x_account_token, linked_account_common_model_scope_deserializer_request, opts)
+      data
+    end
+
+    # Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes)
+    # @param x_account_token [String] Token identifying the end user.
+    # @param linked_account_common_model_scope_deserializer_request [LinkedAccountCommonModelScopeDeserializerRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CommonModelScopeAPI, Integer, Hash)>] CommonModelScopeAPI data, response status code and response headers
+    def linked_account_scopes_create_with_http_info(x_account_token, linked_account_common_model_scope_deserializer_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ScopesApi.linked_account_scopes_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 ScopesApi.linked_account_scopes_create"
+      end
+      # verify the required parameter 'linked_account_common_model_scope_deserializer_request' is set
+      if @api_client.config.client_side_validation && linked_account_common_model_scope_deserializer_request.nil?
+        fail ArgumentError, "Missing the required parameter 'linked_account_common_model_scope_deserializer_request' when calling ScopesApi.linked_account_scopes_create"
+      end
+      # resource path
+      local_var_path = '/linked-account-scopes'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # 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(linked_account_common_model_scope_deserializer_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CommonModelScopeAPI'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"ScopesApi.linked_account_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: ScopesApi#linked_account_scopes_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @return [CommonModelScopeAPI]
+    def linked_account_scopes_retrieve(x_account_token, opts = {})
+      data, _status_code, _headers = linked_account_scopes_retrieve_with_http_info(x_account_token, opts)
+      data
+    end
+
+    # Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CommonModelScopeAPI, Integer, Hash)>] CommonModelScopeAPI data, response status code and response headers
+    def linked_account_scopes_retrieve_with_http_info(x_account_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ScopesApi.linked_account_scopes_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 ScopesApi.linked_account_scopes_retrieve"
+      end
+      # resource path
+      local_var_path = '/linked-account-scopes'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'X-Account-Token'] = x_account_token
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CommonModelScopeAPI'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"ScopesApi.linked_account_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: ScopesApi#linked_account_scopes_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end