merge_hris_client 1.0.1 → 1.0.2

data/docs/Location.md

@@ -10,7 +10,7 @@
 | **street_1** | **String** | Line 1 of the location's street address. | [optional] |
 | **street_2** | **String** | Line 2 of the location's street address. | [optional] |
 | **city** | **String** | The location's city. | [optional] |
-| **state** | [**StateEnum**](StateEnum.md) | The location's state. | [optional] |
+| **state** | **String** | The location's state. Represents a region if outside of the US. | [optional] |
 | **zip_code** | **String** | The location's zip code. | [optional] |
 | **country** | [**CountryEnum**](CountryEnum.md) | The location's country. | [optional] |
 | **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |

data/docs/ModelOperation.md

@@ -7,6 +7,7 @@
 | **model_name** | **String** |  |  |
 | **available_operations** | **Array<String>** |  |  |
 | **required_post_parameters** | **Array<String>** |  |  |
+| **supported_fields** | **Array<String>** |  |  |
 
 ## Example
 
@@ -16,7 +17,8 @@ require 'merge_hris_client'
 instance = MergeHRISClient::ModelOperation.new(
   model_name: Candidate,
   available_operations: ["FETCH","CREATE"],
-  required_post_parameters: ["remote_user_id"]
+  required_post_parameters: ["remote_user_id"],
+  supported_fields: ["first_name","last_name","company","title"]
 )
 ```
 

data/docs/PaginatedIssueList.md

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

data/docs/PaginatedSyncStatusList.md

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

data/docs/PaginatedTimeOffBalanceList.md

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

data/docs/RemoteDataRequest.md

@@ -0,0 +1,20 @@
+# MergeHRISClient::RemoteDataRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **path** | **String** |  |  |
+| **data** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::RemoteDataRequest.new(
+  path: null,
+  data: null
+)
+```
+

data/docs/SyncStatus.md

@@ -8,7 +8,7 @@
 | **model_id** | **String** |  |  |
 | **last_sync_start** | **Time** |  |  |
 | **next_sync_start** | **Time** |  |  |
-| **status** | **String** |  |  |
+| **status** | [**SyncStatusStatusEnum**](SyncStatusStatusEnum.md) |  |  |
 | **is_initial_sync** | **Boolean** |  |  |
 
 ## Example

data/docs/SyncStatusApi.md

@@ -4,12 +4,13 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**sync_status_retrieve**](SyncStatusApi.md#sync_status_retrieve) | **GET** /sync-status |  |
+| [**sync_status_list**](SyncStatusApi.md#sync_status_list) | **GET** /sync-status |  |
+| [**sync_status_resync_create**](SyncStatusApi.md#sync_status_resync_create) | **POST** /sync-status/resync |  |
 
 
-## sync_status_retrieve
+## sync_status_list
 
-> <SyncStatus> sync_status_retrieve(x_account_token)
+> <PaginatedSyncStatusList> sync_status_list(x_account_token, opts)
 
 
 
@@ -23,38 +24,115 @@ require 'merge_hris_client'
 # setup authorization
 MergeHRISClient.configure do |config|
   # Configure API key authorization: tokenAuth
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key['tokenAuth'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['Authorization'] = 'Bearer'
+  # config.api_key_prefix['tokenAuth'] = 'Bearer'
 end
 
 api_instance = MergeHRISClient::SyncStatusApi.new
 x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  cursor: 56, # Integer | The pagination cursor value.
+  page_size: 56 # Integer | Number of results to return per page.
+}
 
 begin
   
-  result = api_instance.sync_status_retrieve(x_account_token)
+  result = api_instance.sync_status_list(x_account_token, opts)
   p result
 rescue MergeHRISClient::ApiError => e
-  puts "Error when calling SyncStatusApi->sync_status_retrieve: #{e}"
+  puts "Error when calling SyncStatusApi->sync_status_list: #{e}"
 end
 ```
 
-#### Using the sync_status_retrieve_with_http_info variant
+#### Using the sync_status_list_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<SyncStatus>, Integer, Hash)> sync_status_retrieve_with_http_info(x_account_token)
+> <Array(<PaginatedSyncStatusList>, Integer, Hash)> sync_status_list_with_http_info(x_account_token, opts)
 
 ```ruby
 begin
   
-  data, status_code, headers = api_instance.sync_status_retrieve_with_http_info(x_account_token)
+  data, status_code, headers = api_instance.sync_status_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedSyncStatusList>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling SyncStatusApi->sync_status_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **cursor** | **Integer** | The pagination cursor value. | [optional] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+
+### Return type
+
+[**PaginatedSyncStatusList**](PaginatedSyncStatusList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## sync_status_resync_create
+
+> <SyncStatus> sync_status_resync_create(x_account_token)
+
+
+
+Force resync of all models.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_hris_client'
+# setup authorization
+MergeHRISClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['tokenAuth'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['tokenAuth'] = 'Bearer'
+end
+
+api_instance = MergeHRISClient::SyncStatusApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+
+begin
+  
+  result = api_instance.sync_status_resync_create(x_account_token)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling SyncStatusApi->sync_status_resync_create: #{e}"
+end
+```
+
+#### Using the sync_status_resync_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SyncStatus>, Integer, Hash)> sync_status_resync_create_with_http_info(x_account_token)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.sync_status_resync_create_with_http_info(x_account_token)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <SyncStatus>
 rescue MergeHRISClient::ApiError => e
-  puts "Error when calling SyncStatusApi->sync_status_retrieve_with_http_info: #{e}"
+  puts "Error when calling SyncStatusApi->sync_status_resync_create_with_http_info: #{e}"
 end
 ```
 

data/docs/SyncStatusStatusEnum.md

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

data/docs/Team.md

@@ -7,6 +7,7 @@
 | **id** | **String** |  | [optional][readonly] |
 | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
 | **name** | **String** | The team's name. | [optional] |
+| **parent_team** | **String** | The team's parent team. | [optional] |
 | **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
 
 ## Example
@@ -18,6 +19,7 @@ instance = MergeHRISClient::Team.new(
   id: 13a72919-9fae-4f54-81ca-ddfd8712a1ba,
   remote_id: 19202938,
   name: Engineering,
+  parent_team: 1b998423-db0a-4037-a4cf-f79c60cb67b3,
   remote_data: [{"path":"/teams","data":["Varies by platform"]}]
 )
 ```

data/docs/TeamsApi.md

@@ -39,6 +39,7 @@ opts = {
   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.
   page_size: 56, # Integer | Number of results to return per page.
+  parent_team_id: TODO, # String | If provided, will only return teams with this parent team.
   remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
 }
 
@@ -81,6 +82,7 @@ end
 | **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] |
 | **page_size** | **Integer** | Number of results to return per page. | [optional] |
+| **parent_team_id** | [**String**](.md) | If provided, will only return teams with this parent team. | [optional] |
 | **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
 
 ### Return type

data/docs/TimeOff.md

@@ -13,6 +13,8 @@
 | **units** | [**UnitsEnum**](UnitsEnum.md) | The unit of time requested. | [optional] |
 | **amount** | **Float** | The number of time off units requested. | [optional] |
 | **request_type** | [**RequestTypeEnum**](RequestTypeEnum.md) | The type of time off request. | [optional] |
+| **start_time** | **Time** | The day and time of the start of the time requested off. | [optional] |
+| **end_time** | **Time** | The day and time of the end of the time requested off. | [optional] |
 | **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
 
 ## Example
@@ -30,6 +32,8 @@ instance = MergeHRISClient::TimeOff.new(
   units: DAYS,
   amount: 13,
   request_type: VACATION,
+  start_time: null,
+  end_time: null,
   remote_data: [{"path":"/leave","data":["Varies by platform"]}]
 )
 ```

data/docs/TimeOffBalance.md

@@ -0,0 +1,28 @@
+# MergeHRISClient::TimeOffBalance
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **employee** | **String** | The employee the balance belongs to. | [optional] |
+| **balance** | **Float** | The current PTO balance. | [optional] |
+| **used** | **Float** | The amount of PTO used. | [optional] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::TimeOffBalance.new(
+  id: 91b2b905-e866-40c8-8be2-efe53827a0aa,
+  remote_id: 19202938,
+  employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
+  balance: 60.0,
+  used: 45.0,
+  remote_data: [{"path":"/leave","data":["Varies by platform"]}]
+)
+```
+

data/docs/TimeOffBalanceApi.md

@@ -0,0 +1,181 @@
+# MergeHRISClient::TimeOffBalanceApi
+
+All URIs are relative to *https://api.merge.dev/api/hris/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**time_off_balance_list**](TimeOffBalanceApi.md#time_off_balance_list) | **GET** /time-off-balance |  |
+| [**time_off_balance_retrieve**](TimeOffBalanceApi.md#time_off_balance_retrieve) | **GET** /time-off-balance/{id} |  |
+
+
+## time_off_balance_list
+
+> <PaginatedTimeOffBalanceList> time_off_balance_list(x_account_token, opts)
+
+
+
+Returns a list of `TimeOffBalance` objects.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_hris_client'
+# setup authorization
+MergeHRISClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['tokenAuth'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['tokenAuth'] = 'Bearer'
+end
+
+api_instance = MergeHRISClient::TimeOffBalanceApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
+  created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
+  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
+  employee_id: 'employee_id_example', # String | If provided, will only return time off balances for this employee.
+  expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+  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.
+  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.
+}
+
+begin
+  
+  result = api_instance.time_off_balance_list(x_account_token, opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling TimeOffBalanceApi->time_off_balance_list: #{e}"
+end
+```
+
+#### Using the time_off_balance_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedTimeOffBalanceList>, Integer, Hash)> time_off_balance_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.time_off_balance_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedTimeOffBalanceList>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling TimeOffBalanceApi->time_off_balance_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
+| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
+| **cursor** | **String** | The pagination cursor value. | [optional] |
+| **employee_id** | **String** | If provided, will only return time off balances for this employee. | [optional] |
+| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+| **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] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+| **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
+
+### Return type
+
+[**PaginatedTimeOffBalanceList**](PaginatedTimeOffBalanceList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## time_off_balance_retrieve
+
+> <TimeOffBalance> time_off_balance_retrieve(x_account_token, id, opts)
+
+
+
+Returns an `TimeOffBalance` object with the given `id`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_hris_client'
+# setup authorization
+MergeHRISClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['tokenAuth'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['tokenAuth'] = 'Bearer'
+end
+
+api_instance = MergeHRISClient::TimeOffBalanceApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+opts = {
+  expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+  include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+}
+
+begin
+  
+  result = api_instance.time_off_balance_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling TimeOffBalanceApi->time_off_balance_retrieve: #{e}"
+end
+```
+
+#### Using the time_off_balance_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TimeOffBalance>, Integer, Hash)> time_off_balance_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.time_off_balance_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TimeOffBalance>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling TimeOffBalanceApi->time_off_balance_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **id** | [**String**](.md) |  |  |
+| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+
+### Return type
+
+[**TimeOffBalance**](TimeOffBalance.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+