merge_hris_client 3.2.1 → 3.2.2

data/docs/Group.md

@@ -6,12 +6,14 @@
 | ---- | ---- | ----------- | ----- |
 | **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] |
 | **parent_group** | **String** | The parent group for this group. | [optional] |
 | **name** | **String** | The group name. | [optional] |
-| **type** | [**GroupTypeEnum**](GroupTypeEnum.md) | The group type  * `TEAM` - TEAM * `DEPARTMENT` - DEPARTMENT * `COST_CENTER` - COST_CENTER * `BUSINESS_UNIT` - BUSINESS_UNIT * `GROUP` - GROUP | [optional] |
-| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
-| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
-| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional][readonly] |
+| **type** | [**GroupTypeEnum**](GroupTypeEnum.md) | The Group type returned directly from the third-party.  * `TEAM` - TEAM * `DEPARTMENT` - DEPARTMENT * `COST_CENTER` - COST_CENTER * `BUSINESS_UNIT` - BUSINESS_UNIT * `GROUP` - GROUP | [optional] |
+| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted in the third party platform. | [optional][readonly] |
+| **is_commonly_used_as_team** | **Boolean** | Indicates whether the Group refers to a team in the third party platform. Note that this is an opinionated view based on how Merge observes most organizations representing teams in each third party platform. If your customer uses a platform different from most, there is a chance this will not be correct. | [optional] |
+| **field_mappings** | **Object** |  | [optional][readonly] |
 | **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
 
 ## Example
@@ -22,11 +24,13 @@ require 'merge_hris_client'
 instance = MergeHRISClient::Group.new(
   id: 134e0111-0f67-44f6-98f0-597000290bb3,
   remote_id: 800293,
+  created_at: 2021-09-15T00:00Z,
+  modified_at: 2021-10-16T00:00Z,
   parent_group: 2ef51b11-2c4e-4b02-8d1d-50592d9e96ef,
   name: COST_CENTER_US,
   type: COST_CENTER,
   remote_was_deleted: null,
-  modified_at: 2021-10-16T00:00Z,
+  is_commonly_used_as_team: true,
   field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
   remote_data: [{"path":"/group","data":["Varies by platform"]}]
 )

data/docs/GroupsApi.md

@@ -37,12 +37,14 @@ 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.
+  is_commonly_used_as_team: 'is_commonly_used_as_team_example', # String | If provided, specifies whether to return only Group objects which refer to a team in the third party platform. Note that this is an opinionated view based on how a team may be represented in the third party platform.
   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.
+  names: 'names_example', # String | If provided, will only return groups with these names. Multiple values can be separated by commas.
   page_size: 56, # Integer | Number of results to return per page.
   remote_fields: '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: 'type', # String | Which fields should be returned in non-normalized form.
+  show_enum_origins: '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)
   types: 'types_example' # String | If provided, will only return groups of these types. Multiple values can be separated by commas.
 }
 
@@ -83,12 +85,14 @@ 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] |
+| **is_commonly_used_as_team** | **String** | If provided, specifies whether to return only Group objects which refer to a team in the third party platform. Note that this is an opinionated view based on how a team may be represented in the third party platform. | [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] |
+| **names** | **String** | If provided, will only return groups with these names. Multiple values can be separated by commas. | [optional] |
 | **page_size** | **Integer** | Number of results to return per page. | [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] |
+| **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] |
 | **types** | **String** | If provided, will only return groups of these types. Multiple values can be separated by commas. | [optional] |
 
 ### Return type
@@ -132,7 +136,7 @@ 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: 'type', # String | Deprecated. Use show_enum_origins.
-  show_enum_origins: 'type' # String | Which fields should be returned in non-normalized form.
+  show_enum_origins: '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
@@ -170,7 +174,7 @@ end
 | **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** | Deprecated. Use show_enum_origins. | [optional] |
-| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [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/IndividualCommonModelScopeDeserializer.md

@@ -0,0 +1,22 @@
+# MergeHRISClient::IndividualCommonModelScopeDeserializer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model_name** | **String** |  |  |
+| **model_permissions** | [**Hash<String, ModelPermissionDeserializer>**](ModelPermissionDeserializer.md) |  | [optional] |
+| **field_permissions** | [**FieldPermissionDeserializer**](FieldPermissionDeserializer.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::IndividualCommonModelScopeDeserializer.new(
+  model_name: null,
+  model_permissions: null,
+  field_permissions: null
+)
+```
+

data/docs/IndividualCommonModelScopeDeserializerRequest.md

@@ -0,0 +1,22 @@
+# MergeHRISClient::IndividualCommonModelScopeDeserializerRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model_name** | **String** |  |  |
+| **model_permissions** | [**Hash<String, ModelPermissionDeserializerRequest>**](ModelPermissionDeserializerRequest.md) |  | [optional] |
+| **field_permissions** | [**FieldPermissionDeserializerRequest**](FieldPermissionDeserializerRequest.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::IndividualCommonModelScopeDeserializerRequest.new(
+  model_name: null,
+  model_permissions: null,
+  field_permissions: null
+)
+```
+

data/docs/Issue.md

@@ -21,7 +21,7 @@ require 'merge_hris_client'
 instance = MergeHRISClient::Issue.new(
   id: 3fa85f64-5717-4562-b3fc-2c963f66afa6,
   status: ONGOING,
-  error_description: string,
+  error_description: Missing Permissions,
   end_user: b82302de-852e-4e60-b050-edf9da3b7c02,
   first_incident_time: 2022-12-05T16:19:15.161Z,
   last_incident_time: 2022-12-05T16:19:15.161Z,

data/docs/IssuesApi.md

@@ -14,7 +14,7 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
 
 
 
-Gets issues.
+Gets all issues for Organization.
 
 ### Examples
 
@@ -37,10 +37,11 @@ opts = {
   end_user_organization_name: 'end_user_organization_name_example', # String | 
   first_incident_time_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was after this datetime.
   first_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was before this datetime.
-  include_muted: 'include_muted_example', # String | If True, will include muted issues
+  include_muted: 'include_muted_example', # String | If true, will include muted issues
   integration_name: 'integration_name_example', # String | 
   last_incident_time_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose last incident time was after this datetime.
   last_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose last incident time was before this datetime.
+  linked_account_id: 'linked_account_id_example', # String | If provided, will only include issues pertaining to the linked account passed in.
   page_size: 56, # Integer | Number of results to return per page.
   start_date: 'start_date_example', # String | If included, will only include issues whose most recent action occurred after this time
   status: 'ONGOING' # String | Status of the issue. Options: ('ONGOING', 'RESOLVED')  * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED
@@ -83,10 +84,11 @@ end
 | **end_user_organization_name** | **String** |  | [optional] |
 | **first_incident_time_after** | **Time** | If provided, will only return issues whose first incident time was after this datetime. | [optional] |
 | **first_incident_time_before** | **Time** | If provided, will only return issues whose first incident time was before this datetime. | [optional] |
-| **include_muted** | **String** | If True, will include muted issues | [optional] |
+| **include_muted** | **String** | If true, will include muted issues | [optional] |
 | **integration_name** | **String** |  | [optional] |
 | **last_incident_time_after** | **Time** | If provided, will only return issues whose last incident time was after this datetime. | [optional] |
 | **last_incident_time_before** | **Time** | If provided, will only return issues whose last incident time was before this datetime. | [optional] |
+| **linked_account_id** | **String** | If provided, will only include issues pertaining to the linked account passed in. | [optional] |
 | **page_size** | **Integer** | Number of results to return per page. | [optional] |
 | **start_date** | **String** | If included, will only include issues whose most recent action occurred after this time | [optional] |
 | **status** | **String** | Status of the issue. Options: ('ONGOING', 'RESOLVED')  * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED | [optional] |

data/docs/LinkTokenApi.md

@@ -29,7 +29,7 @@ MergeHRISClient.configure do |config|
 end
 
 api_instance = MergeHRISClient::LinkTokenApi.new
-end_user_details_request = MergeHRISClient::EndUserDetailsRequest.new({end_user_email_address: 'end_user_email_address_example', end_user_organization_name: 'end_user_organization_name_example', end_user_origin_id: 'end_user_origin_id_example', categories: [MergeHRISClient::CategoriesEnum::HRIS]}) # EndUserDetailsRequest | 
+end_user_details_request = MergeHRISClient::EndUserDetailsRequest.new({end_user_email_address: 'example@gmail.com', end_user_organization_name: 'Test Organization', end_user_origin_id: '12345', categories: [MergeHRISClient::CategoriesEnum::HRIS]}) # EndUserDetailsRequest | 
 
 begin
   

data/docs/LinkedAccountCommonModelScopeDeserializerRequest.md

@@ -0,0 +1,18 @@
+# MergeHRISClient::LinkedAccountCommonModelScopeDeserializerRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **common_models** | [**Array<IndividualCommonModelScopeDeserializerRequest>**](IndividualCommonModelScopeDeserializerRequest.md) | The common models you want to update the scopes for |  |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::LinkedAccountCommonModelScopeDeserializerRequest.new(
+  common_models: [{"model_name":"Employee","model_permissions":{"READ":{"is_enabled":true},"WRITE":{"is_enabled":false}},"field_permissions":{"enabled_fields":["avatar","home_location"],"disabled_fields":["work_location"]}},{"model_name":"Benefit","model_permissions":{"WRITE":{"is_enabled":false}}}]
+)
+```
+

data/docs/LinkedAccountsApi.md

@@ -30,7 +30,7 @@ end
 
 api_instance = MergeHRISClient::LinkedAccountsApi.new
 opts = {
-  category: 'accounting', # String | Options: ('hris', 'ats', 'accounting', 'ticketing', 'crm', 'mktg', 'filestorage')  * `hris` - hris * `ats` - ats * `accounting` - accounting * `ticketing` - ticketing * `crm` - crm * `mktg` - mktg * `filestorage` - filestorage
+  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.
@@ -76,7 +76,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **category** | **String** | Options: ('hris', 'ats', 'accounting', 'ticketing', 'crm', 'mktg', 'filestorage')  * `hris` - hris * `ats` - ats * `accounting` - accounting * `ticketing` - ticketing * `crm` - crm * `mktg` - mktg * `filestorage` - filestorage | [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] |

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] |
@@ -15,9 +17,8 @@
 | **zip_code** | **String** | The location's zip code or postal code. | [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 by third party webhooks. | [optional][readonly] |
-| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
-| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional][readonly] |
+| **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] |
 
 ## Example
@@ -28,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,
@@ -38,7 +41,6 @@ instance = MergeHRISClient::Location.new(
   country: US,
   location_type: WORK,
   remote_was_deleted: null,
-  modified_at: 2021-10-16T00:00Z,
   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,12 +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.
+  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 | 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 | Which fields should be returned in non-normalized form.
+  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
@@ -82,12 +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] |
+| **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** | 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] |
+| **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
 
@@ -130,7 +132,7 @@ 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 | Deprecated. Use show_enum_origins.
-  show_enum_origins: 'location_type' # String | Which fields should be returned in non-normalized form.
+  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
@@ -168,7 +170,7 @@ end
 | **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** | Deprecated. Use show_enum_origins. | [optional] |
-| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [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

@@ -16,7 +16,7 @@
 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,

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/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/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,10 +6,11 @@
 | ---- | ---- | ----------- | ----- |
 | **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 by third party webhooks. | [optional][readonly] |
-| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
-| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional][readonly] |
+| **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] |
 
 ## Example
@@ -20,9 +21,10 @@ 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_was_deleted: null,
-  modified_at: 2021-10-16T00:00Z,
   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/PayrollRun.md

@@ -6,14 +6,15 @@
 | ---- | ---- | ----------- | ----- |
 | **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] |
 | **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 by third party webhooks. | [optional][readonly] |
-| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
-| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional][readonly] |
+| **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] |
 
 ## Example
@@ -24,13 +25,14 @@ 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_was_deleted: null,
-  modified_at: 2021-10-16T00:00Z,
   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

@@ -45,7 +45,7 @@ opts = {
   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')  * `REGULAR` - REGULAR * `OFF_CYCLE` - OFF_CYCLE * `CORRECTION` - CORRECTION * `TERMINATION` - TERMINATION * `SIGN_ON_BONUS` - SIGN_ON_BONUS
-  show_enum_origins: 'run_state', # String | Which fields should be returned in non-normalized form.
+  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.
 }
@@ -95,7 +95,7 @@ end
 | **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')  * `REGULAR` - REGULAR * `OFF_CYCLE` - OFF_CYCLE * `CORRECTION` - CORRECTION * `TERMINATION` - TERMINATION * `SIGN_ON_BONUS` - SIGN_ON_BONUS | [optional] |
-| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [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] |
 
@@ -140,7 +140,7 @@ 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 | Deprecated. Use show_enum_origins.
-  show_enum_origins: 'run_state' # String | Which fields should be returned in non-normalized form.
+  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
@@ -178,7 +178,7 @@ end
 | **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** | Deprecated. Use show_enum_origins. | [optional] |
-| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [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/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"]
+)
+```
+