merge_hris_client 2.0.4 → 3.2.2

data/docs/LinkedAccountsApi.md

@@ -30,7 +30,7 @@ end
 
 api_instance = MergeHRISClient::LinkedAccountsApi.new
 opts = {
-  category: 'accounting', # String | 
+  category: 'accounting', # String | Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`  * `hris` - hris * `ats` - ats * `accounting` - accounting * `ticketing` - ticketing * `crm` - crm * `mktg` - mktg * `filestorage` - filestorage * `datawarehouse` - datawarehouse
   cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
   end_user_email_address: 'end_user_email_address_example', # String | If provided, will only return linked accounts associated with the given email address.
   end_user_organization_name: 'end_user_organization_name_example', # String | If provided, will only return linked accounts associated with the given organization name.
@@ -38,6 +38,7 @@ opts = {
   end_user_origin_ids: 'end_user_origin_ids_example', # String | Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
   id: TODO, # String | 
   ids: 'ids_example', # String | Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
+  include_duplicates: true, # Boolean | 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.
   integration_name: 'integration_name_example', # String | If provided, will only return linked accounts associated with the given integration name.
   is_test_account: 'is_test_account_example', # String | If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
   page_size: 56, # Integer | Number of results to return per page.
@@ -75,7 +76,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **category** | **String** |  | [optional] |
+| **category** | **String** | Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`  * `hris` - hris * `ats` - ats * `accounting` - accounting * `ticketing` - ticketing * `crm` - crm * `mktg` - mktg * `filestorage` - filestorage * `datawarehouse` - datawarehouse | [optional] |
 | **cursor** | **String** | The pagination cursor value. | [optional] |
 | **end_user_email_address** | **String** | If provided, will only return linked accounts associated with the given email address. | [optional] |
 | **end_user_organization_name** | **String** | If provided, will only return linked accounts associated with the given organization name. | [optional] |
@@ -83,6 +84,7 @@ end
 | **end_user_origin_ids** | **String** | Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. | [optional] |
 | **id** | [**String**](.md) |  | [optional] |
 | **ids** | **String** | Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. | [optional] |
+| **include_duplicates** | **Boolean** | 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. | [optional] |
 | **integration_name** | **String** | If provided, will only return linked accounts associated with the given integration name. | [optional] |
 | **is_test_account** | **String** | If included, will only include test linked accounts. If not included, will only include non-test linked accounts. | [optional] |
 | **page_size** | **Integer** | Number of results to return per page. | [optional] |

data/docs/Location.md

@@ -6,6 +6,8 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  | [optional][readonly] |
 | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **created_at** | **Time** | The datetime that this object was created by Merge. | [optional][readonly] |
+| **modified_at** | **Time** | The datetime that this object was modified by Merge. | [optional][readonly] |
 | **name** | **String** | The location's name. | [optional] |
 | **phone_number** | **String** | The location's phone number. | [optional] |
 | **street_1** | **String** | Line 1 of the location's street address. | [optional] |
@@ -13,10 +15,11 @@
 | **city** | **String** | The location's city. | [optional] |
 | **state** | **String** | The location's state. Represents a region if outside of the US. | [optional] |
 | **zip_code** | **String** | The location's zip code or postal code. | [optional] |
-| **country** | [**CountryEnum**](CountryEnum.md) | The location's country. | [optional] |
-| **location_type** | [**LocationTypeEnum**](LocationTypeEnum.md) | The location's type. Can be either WORK or HOME | [optional] |
+| **country** | [**CountryEnum**](CountryEnum.md) | The location's country.  * `AF` - Afghanistan * `AX` - Åland Islands * `AL` - Albania * `DZ` - Algeria * `AS` - American Samoa * `AD` - Andorra * `AO` - Angola * `AI` - Anguilla * `AQ` - Antarctica * `AG` - Antigua and Barbuda * `AR` - Argentina * `AM` - Armenia * `AW` - Aruba * `AU` - Australia * `AT` - Austria * `AZ` - Azerbaijan * `BS` - Bahamas * `BH` - Bahrain * `BD` - Bangladesh * `BB` - Barbados * `BY` - Belarus * `BE` - Belgium * `BZ` - Belize * `BJ` - Benin * `BM` - Bermuda * `BT` - Bhutan * `BO` - Bolivia * `BQ` - Bonaire, Sint Eustatius and Saba * `BA` - Bosnia and Herzegovina * `BW` - Botswana * `BV` - Bouvet Island * `BR` - Brazil * `IO` - British Indian Ocean Territory * `BN` - Brunei * `BG` - Bulgaria * `BF` - Burkina Faso * `BI` - Burundi * `CV` - Cabo Verde * `KH` - Cambodia * `CM` - Cameroon * `CA` - Canada * `KY` - Cayman Islands * `CF` - Central African Republic * `TD` - Chad * `CL` - Chile * `CN` - China * `CX` - Christmas Island * `CC` - Cocos (Keeling) Islands * `CO` - Colombia * `KM` - Comoros * `CG` - Congo * `CD` - Congo (the Democratic Republic of the) * `CK` - Cook Islands * `CR` - Costa Rica * `CI` - Côte d'Ivoire * `HR` - Croatia * `CU` - Cuba * `CW` - Curaçao * `CY` - Cyprus * `CZ` - Czechia * `DK` - Denmark * `DJ` - Djibouti * `DM` - Dominica * `DO` - Dominican Republic * `EC` - Ecuador * `EG` - Egypt * `SV` - El Salvador * `GQ` - Equatorial Guinea * `ER` - Eritrea * `EE` - Estonia * `SZ` - Eswatini * `ET` - Ethiopia * `FK` - Falkland Islands (Malvinas) * `FO` - Faroe Islands * `FJ` - Fiji * `FI` - Finland * `FR` - France * `GF` - French Guiana * `PF` - French Polynesia * `TF` - French Southern Territories * `GA` - Gabon * `GM` - Gambia * `GE` - Georgia * `DE` - Germany * `GH` - Ghana * `GI` - Gibraltar * `GR` - Greece * `GL` - Greenland * `GD` - Grenada * `GP` - Guadeloupe * `GU` - Guam * `GT` - Guatemala * `GG` - Guernsey * `GN` - Guinea * `GW` - Guinea-Bissau * `GY` - Guyana * `HT` - Haiti * `HM` - Heard Island and McDonald Islands * `VA` - Holy See * `HN` - Honduras * `HK` - Hong Kong * `HU` - Hungary * `IS` - Iceland * `IN` - India * `ID` - Indonesia * `IR` - Iran * `IQ` - Iraq * `IE` - Ireland * `IM` - Isle of Man * `IL` - Israel * `IT` - Italy * `JM` - Jamaica * `JP` - Japan * `JE` - Jersey * `JO` - Jordan * `KZ` - Kazakhstan * `KE` - Kenya * `KI` - Kiribati * `KW` - Kuwait * `KG` - Kyrgyzstan * `LA` - Laos * `LV` - Latvia * `LB` - Lebanon * `LS` - Lesotho * `LR` - Liberia * `LY` - Libya * `LI` - Liechtenstein * `LT` - Lithuania * `LU` - Luxembourg * `MO` - Macao * `MG` - Madagascar * `MW` - Malawi * `MY` - Malaysia * `MV` - Maldives * `ML` - Mali * `MT` - Malta * `MH` - Marshall Islands * `MQ` - Martinique * `MR` - Mauritania * `MU` - Mauritius * `YT` - Mayotte * `MX` - Mexico * `FM` - Micronesia (Federated States of) * `MD` - Moldova * `MC` - Monaco * `MN` - Mongolia * `ME` - Montenegro * `MS` - Montserrat * `MA` - Morocco * `MZ` - Mozambique * `MM` - Myanmar * `NA` - Namibia * `NR` - Nauru * `NP` - Nepal * `NL` - Netherlands * `NC` - New Caledonia * `NZ` - New Zealand * `NI` - Nicaragua * `NE` - Niger * `NG` - Nigeria * `NU` - Niue * `NF` - Norfolk Island * `KP` - North Korea * `MK` - North Macedonia * `MP` - Northern Mariana Islands * `NO` - Norway * `OM` - Oman * `PK` - Pakistan * `PW` - Palau * `PS` - Palestine, State of * `PA` - Panama * `PG` - Papua New Guinea * `PY` - Paraguay * `PE` - Peru * `PH` - Philippines * `PN` - Pitcairn * `PL` - Poland * `PT` - Portugal * `PR` - Puerto Rico * `QA` - Qatar * `RE` - Réunion * `RO` - Romania * `RU` - Russia * `RW` - Rwanda * `BL` - Saint Barthélemy * `SH` - Saint Helena, Ascension and Tristan da Cunha * `KN` - Saint Kitts and Nevis * `LC` - Saint Lucia * `MF` - Saint Martin (French part) * `PM` - Saint Pierre and Miquelon * `VC` - Saint Vincent and the Grenadines * `WS` - Samoa * `SM` - San Marino * `ST` - Sao Tome and Principe * `SA` - Saudi Arabia * `SN` - Senegal * `RS` - Serbia * `SC` - Seychelles * `SL` - Sierra Leone * `SG` - Singapore * `SX` - Sint Maarten (Dutch part) * `SK` - Slovakia * `SI` - Slovenia * `SB` - Solomon Islands * `SO` - Somalia * `ZA` - South Africa * `GS` - South Georgia and the South Sandwich Islands * `KR` - South Korea * `SS` - South Sudan * `ES` - Spain * `LK` - Sri Lanka * `SD` - Sudan * `SR` - Suriname * `SJ` - Svalbard and Jan Mayen * `SE` - Sweden * `CH` - Switzerland * `SY` - Syria * `TW` - Taiwan * `TJ` - Tajikistan * `TZ` - Tanzania * `TH` - Thailand * `TL` - Timor-Leste * `TG` - Togo * `TK` - Tokelau * `TO` - Tonga * `TT` - Trinidad and Tobago * `TN` - Tunisia * `TR` - Turkey * `TM` - Turkmenistan * `TC` - Turks and Caicos Islands * `TV` - Tuvalu * `UG` - Uganda * `UA` - Ukraine * `AE` - United Arab Emirates * `GB` - United Kingdom * `UM` - United States Minor Outlying Islands * `US` - United States of America * `UY` - Uruguay * `UZ` - Uzbekistan * `VU` - Vanuatu * `VE` - Venezuela * `VN` - Vietnam * `VG` - Virgin Islands (British) * `VI` - Virgin Islands (U.S.) * `WF` - Wallis and Futuna * `EH` - Western Sahara * `YE` - Yemen * `ZM` - Zambia * `ZW` - Zimbabwe | [optional] |
+| **location_type** | [**LocationTypeEnum**](LocationTypeEnum.md) | The location's type. Can be either WORK or HOME  * `HOME` - HOME * `WORK` - WORK | [optional] |
+| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted in the third party platform. | [optional][readonly] |
+| **field_mappings** | **Object** |  | [optional][readonly] |
 | **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
-| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
 
 ## Example
 
@@ -26,6 +29,8 @@ require 'merge_hris_client'
 instance = MergeHRISClient::Location.new(
   id: f5e6a151-f44e-449a-afb1-8fd781905958,
   remote_id: 93018402,
+  created_at: 2021-09-15T00:00Z,
+  modified_at: 2021-10-16T00:00Z,
   name: NYC Office,
   phone_number: +1111111111,
   street_1: 2920 Broadway,
@@ -33,10 +38,11 @@ instance = MergeHRISClient::Location.new(
   city: New York ,
   state: NY,
   zip_code: 10027,
-  country: USA,
+  country: US,
   location_type: WORK,
-  remote_data: [{"path":"/locations","data":["Varies by platform"]}],
-  remote_was_deleted: null
+  remote_was_deleted: null,
+  field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
+  remote_data: [{"path":"/locations","data":["Varies by platform"]}]
 )
 ```
 

data/docs/LocationsApi.md

@@ -37,11 +37,13 @@ opts = {
   cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
   include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
   include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
-  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, 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.
+  location_type: 'HOME', # String | If provided, will only return locations with this location_type  * `HOME` - HOME * `WORK` - WORK
+  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
+  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
   page_size: 56, # Integer | Number of results to return per page.
-  remote_fields: 'location_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: 'location_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: 'location_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
@@ -81,11 +83,13 @@ end
 | **cursor** | **String** | The pagination cursor value. | [optional] |
 | **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
 | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
-| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
-| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
+| **location_type** | **String** | If provided, will only return locations with this location_type  * `HOME` - HOME * `WORK` - WORK | [optional] |
+| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
+| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
 | **page_size** | **Integer** | Number of results to return per page. | [optional] |
-| **remote_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
 
@@ -127,7 +131,8 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
 id = TODO # String | 
 opts = {
   include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
-  remote_fields: 'location_type' # String | Which fields should be returned in non-normalized form.
+  remote_fields: 'location_type', # String | Deprecated. Use show_enum_origins.
+  show_enum_origins: 'location_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
@@ -164,7 +169,8 @@ end
 | **x_account_token** | **String** | Token identifying the end user. |  |
 | **id** | [**String**](.md) |  |  |
 | **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/MetaResponse.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **request_schema** | [**Hash<String, AnyType>**](AnyType.md) |  |  |
+| **remote_field_classes** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional] |
 | **status** | [**LinkedAccountStatus**](LinkedAccountStatus.md) |  | [optional] |
 | **has_conditional_params** | **Boolean** |  |  |
 | **has_required_linked_account_params** | **Boolean** |  |  |
@@ -15,7 +16,8 @@
 require 'merge_hris_client'
 
 instance = MergeHRISClient::MetaResponse.new(
-  request_schema: null,
+  request_schema: {"type":"object","properties":{"model":{"type":"object","required":["last_name","first_name","merge_categories","new_york_city_neighborhood","favorite_tv_shows","favorite_watch"],"properties":{"email_addresses":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","title":"value"},"email_address_type":{"type":"string","title":"email_address_type"},"integration_params":{"type":"object","title":"integration_params","properties":{}},"linked_account_params":{"type":"object","title":"linked_account_params","properties":{}}}},"title":"email_addresses","description":"Array of email_addresses objects"},"urls":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","title":"value"},"url_type":{"type":"string","title":"url_type"},"integration_params":{"type":"object","title":"integration_params","properties":{}},"linked_account_params":{"type":"object","title":"linked_account_params","properties":{}}}},"title":"urls","description":"Array of urls objects"},"first_name":{"type":"string","title":"first_name","description":"The first name."},"last_name":{"type":"string","title":"last_name","description":"The last name."},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","title":"value"},"phone_number_type":{"type":"string","title":"phone_number_type"},"integration_params":{"type":"object","title":"integration_params","properties":{}},"linked_account_params":{"type":"object","title":"linked_account_params","properties":{}}}},"title":"phone_numbers","description":"Array of phone_numbers objects"},"tags":{"type":"array","items":{"type":"string","format":"uuid"},"title":"tags","description":"Array of tags names"},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","title":"id"},"file_url":{"type":"string","title":"file_url"},"file_name":{"type":"string","title":"file_name"},"attachment_type":{"type":"string","title":"attachment_type"},"integration_params":{"type":"object","title":"integration_params","properties":{}},"linked_account_params":{"type":"object","title":"linked_account_params","properties":{}}}},"title":"attachments","description":"Array of attachments objects "},"merge_categories":{"type":"array","categories":{"type":"string","enum":["HRIS","ATS","Accounting","Ticketing","File Storage","CRM","Marketing Automation"],"enum_information":[{"value":"HRIS","description":"Merge HRIS Category"},{"value":"ATS","description":"Merge ATS Category"},{"value":"Accounting","description":"Merge Accounting Category"},{"value":"Ticketing","description":"Merge Ticketing Category"},{"value":"File Storage","description":"Merge File Storage Category"},{"value":"CRM","description":"Merge CRM Category"},{"value":"Marketing Automation","description":"Merge Marketing Automation Category"}]},"title":"Merge Categories","description":"Array of Merge's Unified API Categories"},"new_york_city_neighborhood":{"type":"string","title":"Borough","description":"One of the 5 Boroughs of New York City"},"favorite_tv_shows":{"type":"array","items":{"type":"string","format":"uuid"},"title":"Favorite TV Shows","description":"Array of TV Show objects on merge.tv_shows"},"favorite_watch":{"type":"string","title":"Favorite Watch","description":"Favorite watch of all time"}}}}},
+  remote_field_classes: null,
   status: null,
   has_conditional_params: null,
   has_required_linked_account_params: null

data/docs/ModelPermissionDeserializer.md

@@ -0,0 +1,18 @@
+# MergeHRISClient::ModelPermissionDeserializer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **is_enabled** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::ModelPermissionDeserializer.new(
+  is_enabled: null
+)
+```
+

data/docs/ModelPermissionDeserializerRequest.md

@@ -0,0 +1,18 @@
+# MergeHRISClient::ModelPermissionDeserializerRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **is_enabled** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::ModelPermissionDeserializerRequest.new(
+  is_enabled: null
+)
+```
+

data/docs/MultipartFormFieldRequest.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | The name of the form field |  |
 | **data** | **String** | The data for the form field. |  |
-| **encoding** | [**EncodingEnum**](EncodingEnum.md) | The encoding of the value of `data`. Defaults to `RAW` if not defined. | [optional] |
+| **encoding** | [**EncodingEnum**](EncodingEnum.md) | The encoding of the value of `data`. Defaults to `RAW` if not defined.  * `RAW` - RAW * `BASE64` - BASE64 * `GZIP_BASE64` - GZIP_BASE64 | [optional] |
 | **file_name** | **String** | The file name of the form field, if the field is for a file. | [optional] |
 | **content_type** | **String** | The MIME type of the file, if the field is for a file. | [optional] |
 

data/docs/OperatorSchema.md

@@ -0,0 +1,20 @@
+# MergeHRISClient::OperatorSchema
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **operator** | **String** | The operator for which an operator schema is defined. | [optional][readonly] |
+| **is_unique** | **Boolean** | Whether the operator can be repeated multiple times. | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::OperatorSchema.new(
+  operator: null,
+  is_unique: null
+)
+```
+

data/docs/PaginatedAuditLogEventList.md

@@ -0,0 +1,22 @@
+# MergeHRISClient::PaginatedAuditLogEventList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<AuditLogEvent>**](AuditLogEvent.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::PaginatedAuditLogEventList.new(
+  _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
+  previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
+  results: null
+)
+```
+

data/docs/PaginatedConditionSchemaList.md

@@ -0,0 +1,22 @@
+# MergeHRISClient::PaginatedConditionSchemaList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<ConditionSchema>**](ConditionSchema.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::PaginatedConditionSchemaList.new(
+  _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
+  previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
+  results: null
+)
+```
+

data/docs/PaginatedDependentList.md

@@ -0,0 +1,22 @@
+# MergeHRISClient::PaginatedDependentList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<Dependent>**](Dependent.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::PaginatedDependentList.new(
+  _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
+  previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
+  results: null
+)
+```
+

data/docs/PaginatedEmployerBenefitList.md

@@ -0,0 +1,22 @@
+# MergeHRISClient::PaginatedEmployerBenefitList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<EmployerBenefit>**](EmployerBenefit.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::PaginatedEmployerBenefitList.new(
+  _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
+  previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
+  results: null
+)
+```
+

data/docs/PaginatedTimesheetEntryList.md

@@ -0,0 +1,22 @@
+# MergeHRISClient::PaginatedTimesheetEntryList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<TimesheetEntry>**](TimesheetEntry.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::PaginatedTimesheetEntryList.new(
+  _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
+  previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
+  results: null
+)
+```
+

data/docs/PatchedEditFieldMappingRequest.md

@@ -0,0 +1,22 @@
+# MergeHRISClient::PatchedEditFieldMappingRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **remote_field_traversal_path** | [**Array<AnyType>**](AnyType.md) | The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. | [optional] |
+| **remote_method** | **String** | The method of the remote endpoint where the remote field is coming from. | [optional] |
+| **remote_url_path** | **String** | The path of the remote endpoint where the remote field is coming from. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::PatchedEditFieldMappingRequest.new(
+  remote_field_traversal_path: ["example_remote_field_name"],
+  remote_method: GET,
+  remote_url_path: /example-url-path
+)
+```
+

data/docs/PayGroup.md

@@ -6,9 +6,12 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  | [optional][readonly] |
 | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **created_at** | **Time** | The datetime that this object was created by Merge. | [optional][readonly] |
+| **modified_at** | **Time** | The datetime that this object was modified by Merge. | [optional][readonly] |
 | **pay_group_name** | **String** | The pay group name. | [optional] |
+| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted in the third party platform. | [optional][readonly] |
+| **field_mappings** | **Object** |  | [optional][readonly] |
 | **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
-| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
 
 ## Example
 
@@ -18,9 +21,12 @@ require 'merge_hris_client'
 instance = MergeHRISClient::PayGroup.new(
   id: fd1e0fb5-8f92-4ec9-9f32-179cf732867d,
   remote_id: 800293,
+  created_at: 2021-09-15T00:00Z,
+  modified_at: 2021-10-16T00:00Z,
   pay_group_name: contractor,
-  remote_data: [{"path":"/pay-group","data":["Varies by platform"]}],
-  remote_was_deleted: null
+  remote_was_deleted: null,
+  field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
+  remote_data: [{"path":"/pay-group","data":["Varies by platform"]}]
 )
 ```
 

data/docs/PayGroupsApi.md

@@ -37,8 +37,8 @@ opts = {
   cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
   include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
   include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
-  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, 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.
   remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
 }
@@ -80,8 +80,8 @@ end
 | **cursor** | **String** | The pagination cursor value. | [optional] |
 | **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
 | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
-| **modified_after** | **Time** | If provided, 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] |
 | **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
 

data/docs/PayrollRun.md

@@ -6,13 +6,16 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  | [optional][readonly] |
 | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
-| **run_state** | [**RunStateEnum**](RunStateEnum.md) | The state of the payroll run | [optional] |
-| **run_type** | [**RunTypeEnum**](RunTypeEnum.md) | The type of the payroll run | [optional] |
+| **created_at** | **Time** | The datetime that this object was created by Merge. | [optional][readonly] |
+| **modified_at** | **Time** | The datetime that this object was modified by Merge. | [optional][readonly] |
+| **run_state** | [**RunStateEnum**](RunStateEnum.md) | The state of the payroll run  * `PAID` - PAID * `DRAFT` - DRAFT * `APPROVED` - APPROVED * `FAILED` - FAILED * `CLOSED` - CLOSED | [optional] |
+| **run_type** | [**RunTypeEnum**](RunTypeEnum.md) | The type of the payroll run  * `REGULAR` - REGULAR * `OFF_CYCLE` - OFF_CYCLE * `CORRECTION` - CORRECTION * `TERMINATION` - TERMINATION * `SIGN_ON_BONUS` - SIGN_ON_BONUS | [optional] |
 | **start_date** | **Time** | The day and time the payroll run started. | [optional] |
 | **end_date** | **Time** | The day and time the payroll run ended. | [optional] |
 | **check_date** | **Time** | The day and time the payroll run was checked. | [optional] |
+| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted in the third party platform. | [optional][readonly] |
+| **field_mappings** | **Object** |  | [optional][readonly] |
 | **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
-| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
 
 ## Example
 
@@ -22,13 +25,16 @@ require 'merge_hris_client'
 instance = MergeHRISClient::PayrollRun.new(
   id: 37336947-b3d4-4a4c-a310-ab6ab510e079,
   remote_id: 19202938,
+  created_at: 2021-09-15T00:00Z,
+  modified_at: 2021-10-16T00:00Z,
   run_state: PAID,
   run_type: REGULAR,
   start_date: 2020-11-08T00:00Z,
   end_date: 2020-11-15T00:00Z,
   check_date: 2020-11-15T00:00Z,
-  remote_data: [{"path":"/payroll","data":["Varies by platform"]}],
-  remote_was_deleted: null
+  remote_was_deleted: null,
+  field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
+  remote_data: [{"path":"/payroll","data":["Varies by platform"]}]
 )
 ```
 

data/docs/PayrollRunsApi.md

@@ -39,12 +39,13 @@ opts = {
   ended_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return payroll runs ended before this datetime.
   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.
-  remote_fields: 'run_state', # String | Which fields should be returned in non-normalized form.
+  remote_fields: 'run_state', # String | Deprecated. Use show_enum_origins.
   remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
-  run_type: 'CORRECTION', # String | If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')
+  run_type: 'CORRECTION', # String | 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
+  show_enum_origins: 'run_state', # 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)
   started_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return payroll runs started after this datetime.
   started_before: Time.parse('2013-10-20T19:20:30+01:00') # Time | If provided, will only return payroll runs started before this datetime.
 }
@@ -88,12 +89,13 @@ end
 | **ended_before** | **Time** | If provided, will only return payroll runs ended before this datetime. | [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] |
-| **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] |
-| **run_type** | **String** | If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS') | [optional] |
+| **run_type** | **String** | 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 | [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] |
 | **started_after** | **Time** | If provided, will only return payroll runs started after this datetime. | [optional] |
 | **started_before** | **Time** | If provided, will only return payroll runs started before this datetime. | [optional] |
 
@@ -137,7 +139,8 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
 id = TODO # String | 
 opts = {
   include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
-  remote_fields: 'run_state' # String | Which fields should be returned in non-normalized form.
+  remote_fields: 'run_state', # String | Deprecated. Use show_enum_origins.
+  show_enum_origins: 'run_state' # 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
@@ -174,7 +177,8 @@ end
 | **x_account_token** | **String** | Token identifying the end user. |  |
 | **id** | [**String**](.md) |  |  |
 | **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/RelationshipEnum.md

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

data/docs/RemoteData.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **path** | **String** |  |  |
-| **data** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional] |
+| **data** | [**AnyType**](.md) |  | [optional][readonly] |
 
 ## Example
 

data/docs/RemoteEndpointInfo.md

@@ -0,0 +1,22 @@
+# MergeHRISClient::RemoteEndpointInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **method** | **String** |  |  |
+| **url_path** | **String** |  |  |
+| **field_traversal_path** | [**Array<AnyType>**](AnyType.md) |  |  |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::RemoteEndpointInfo.new(
+  method: GET,
+  url_path: /example-url-path,
+  field_traversal_path: ["example_key_name"]
+)
+```
+