stackone_hris_client 1.1.0 → 1.2.0

data/docs/Employee.md

@@ -1,4 +1,4 @@
-# StackOneHrisClient::Employee
+# StackOneHRIS::Employee
 
 ## Properties
 
@@ -9,40 +9,64 @@
 | **last_name** | **String** |  |  |
 | **name** | **String** |  |  |
 | **display_name** | **String** |  |  |
+| **gender** | **String** |  |  |
+| **ethnicity** | **String** |  | [optional] |
+| **date_of_birth** | **Time** |  | [optional] |
+| **birthday** | **Time** |  | [optional] |
+| **marital_status** | **String** |  | [optional] |
 | **avatar_url** | **String** |  | [optional] |
-| **personal_email** | **String** |  |  |
+| **personal_email** | **String** |  | [optional] |
 | **personal_phone_number** | **String** |  |  |
-| **gender** | **String** |  |  |
 | **work_email** | **String** |  |  |
 | **work_phone_number** | **String** |  |  |
-| **title** | **String** |  |  |
+| **job_title** | **String** |  | [optional] |
 | **department** | **String** |  |  |
-| **manager_id** | **String** |  |  |
-| **birth_date** | **Time** |  |  |
-| **start_date** | **Time** |  |  |
+| **manager_id** | **String** |  | [optional] |
+| **hire_date** | **Time** |  | [optional] |
+| **start_date** | **Time** |  | [optional] |
+| **tenure** | **Float** |  | [optional] |
+| **work_anniversary** | **Time** |  | [optional] |
+| **employment_type** | **String** |  | [optional] |
+| **employment_status** | **String** |  | [optional] |
+| **termination_date** | **Time** |  | [optional] |
+| **company_name** | **String** |  | [optional] |
+| **home_country_location** | **String** |  | [optional] |
+| **work_country_location** | **String** |  | [optional] |
 
 ## Example
 
 ```ruby
 require 'stackone_hris_client'
 
-instance = StackOneHrisClient::Employee.new(
+instance = StackOneHRIS::Employee.new(
   id: null,
   first_name: null,
   last_name: null,
   name: null,
   display_name: null,
+  gender: null,
+  ethnicity: null,
+  date_of_birth: null,
+  birthday: null,
+  marital_status: null,
   avatar_url: null,
   personal_email: null,
   personal_phone_number: null,
-  gender: null,
   work_email: null,
   work_phone_number: null,
-  title: null,
+  job_title: null,
   department: null,
   manager_id: null,
-  birth_date: null,
-  start_date: null
+  hire_date: null,
+  start_date: null,
+  tenure: null,
+  work_anniversary: null,
+  employment_type: null,
+  employment_status: null,
+  termination_date: null,
+  company_name: null,
+  home_country_location: null,
+  work_country_location: null
 )
 ```
 

data/docs/EmployeeResult.md

@@ -1,4 +1,4 @@
-# StackOneHrisClient::EmployeeResult
+# StackOneHRIS::EmployeeResult
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'stackone_hris_client'
 
-instance = StackOneHrisClient::EmployeeResult.new(
+instance = StackOneHRIS::EmployeeResult.new(
   data: null,
   raw: null
 )

data/docs/EmployeesApi.md

@@ -1,4 +1,4 @@
-# StackOneHrisClient::EmployeesApi
+# StackOneHRIS::EmployeesApi
 
 All URIs are relative to *http://localhost*
 
@@ -20,12 +20,13 @@ All URIs are relative to *http://localhost*
 require 'time'
 require 'stackone_hris_client'
 # setup authorization
-StackOneHrisClient.configure do |config|
+StackOneHRIS.configure do |config|
   # Configure HTTP basic authorization: basic
-  config.api_key_token = 'YOUR API KEY'
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
 end
 
-api_instance = StackOneHrisClient::EmployeesApi.new
+api_instance = StackOneHRIS::EmployeesApi.new
 id = 'id_example' # String | 
 x_account_id = 'x_account_id_example' # String | The account identifier
 opts = {
@@ -41,7 +42,7 @@ begin
   # 
   result = api_instance.employees_get(id, x_account_id, opts)
   p result
-rescue StackOneHrisClient::ApiError => e
+rescue StackOneHRIS::ApiError => e
   puts "Error when calling EmployeesApi->employees_get: #{e}"
 end
 ```
@@ -59,7 +60,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <EmployeeResult>
-rescue StackOneHrisClient::ApiError => e
+rescue StackOneHRIS::ApiError => e
   puts "Error when calling EmployeesApi->employees_get_with_http_info: #{e}"
 end
 ```
@@ -103,12 +104,13 @@ end
 require 'time'
 require 'stackone_hris_client'
 # setup authorization
-StackOneHrisClient.configure do |config|
+StackOneHRIS.configure do |config|
   # Configure HTTP basic authorization: basic
-  config.api_key_token = 'YOUR API KEY'
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
 end
 
-api_instance = StackOneHrisClient::EmployeesApi.new
+api_instance = StackOneHRIS::EmployeesApi.new
 x_account_id = 'x_account_id_example' # String | The account identifier
 opts = {
   page: 'page_example', # String | The page number of the results to fetch
@@ -123,7 +125,7 @@ begin
   # 
   result = api_instance.employees_list(x_account_id, opts)
   p result
-rescue StackOneHrisClient::ApiError => e
+rescue StackOneHRIS::ApiError => e
   puts "Error when calling EmployeesApi->employees_list: #{e}"
 end
 ```
@@ -141,7 +143,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <EmployeesPaginated>
-rescue StackOneHrisClient::ApiError => e
+rescue StackOneHRIS::ApiError => e
   puts "Error when calling EmployeesApi->employees_list_with_http_info: #{e}"
 end
 ```

data/docs/EmployeesPaginated.md

@@ -1,4 +1,4 @@
-# StackOneHrisClient::EmployeesPaginated
+# StackOneHRIS::EmployeesPaginated
 
 ## Properties
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'stackone_hris_client'
 
-instance = StackOneHrisClient::EmployeesPaginated.new(
+instance = StackOneHRIS::EmployeesPaginated.new(
   next_page: null,
   data: null,
   raw: null

data/docs/Employment.md

@@ -0,0 +1,34 @@
+# StackOneHRIS::Employment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **employee_id** | **String** |  |  |
+| **job_title** | **String** |  | [optional] |
+| **pay_rate** | **String** |  | [optional] |
+| **pay_period** | **String** |  | [optional] |
+| **pay_frequency** | **String** |  | [optional] |
+| **pay_currency** | **String** |  | [optional] |
+| **effective_date** | **Time** |  | [optional] |
+| **employment_type** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'stackone_hris_client'
+
+instance = StackOneHRIS::Employment.new(
+  id: null,
+  employee_id: null,
+  job_title: null,
+  pay_rate: null,
+  pay_period: null,
+  pay_frequency: null,
+  pay_currency: null,
+  effective_date: null,
+  employment_type: null
+)
+```
+

data/docs/EmploymentResult.md

@@ -0,0 +1,20 @@
+# StackOneHRIS::EmploymentResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Employment**](Employment.md) |  |  |
+| **raw** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'stackone_hris_client'
+
+instance = StackOneHRIS::EmploymentResult.new(
+  data: null,
+  raw: null
+)
+```
+

data/docs/EmploymentsApi.md

@@ -0,0 +1,175 @@
+# StackOneHRIS::EmploymentsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**employments_get**](EmploymentsApi.md#employments_get) | **GET** /unified/hris/employments/{id} |  |
+| [**employments_list**](EmploymentsApi.md#employments_list) | **GET** /unified/hris/employments |  |
+
+
+## employments_get
+
+> <EmploymentResult> employments_get(id, x_account_id, opts)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'stackone_hris_client'
+# setup authorization
+StackOneHRIS.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = StackOneHRIS::EmploymentsApi.new
+id = 'id_example' # String | 
+x_account_id = 'x_account_id_example' # String | The account identifier
+opts = {
+  page: 'page_example', # String | The page number of the results to fetch
+  page_size: 'page_size_example', # String | The number of results per page
+  raw: true, # Boolean | Indicates that the raw request result is returned
+  fields: ['inner_example'], # Array<String> | The list of fields to return in the response (if empty, all fields are returned)
+  expand: ['inner_example'], # Array<String> | The list of fields that will be expanded in the response
+  sync_token: 'sync_token_example' # String | The sync token to select the only updated results
+}
+
+begin
+  # 
+  result = api_instance.employments_get(id, x_account_id, opts)
+  p result
+rescue StackOneHRIS::ApiError => e
+  puts "Error when calling EmploymentsApi->employments_get: #{e}"
+end
+```
+
+#### Using the employments_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmploymentResult>, Integer, Hash)> employments_get_with_http_info(id, x_account_id, opts)
+
+```ruby
+begin
+  # 
+  data, status_code, headers = api_instance.employments_get_with_http_info(id, x_account_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmploymentResult>
+rescue StackOneHRIS::ApiError => e
+  puts "Error when calling EmploymentsApi->employments_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **x_account_id** | **String** | The account identifier |  |
+| **page** | **String** | The page number of the results to fetch | [optional] |
+| **page_size** | **String** | The number of results per page | [optional][default to &#39;25&#39;] |
+| **raw** | **Boolean** | Indicates that the raw request result is returned | [optional][default to false] |
+| **fields** | [**Array&lt;String&gt;**](String.md) | The list of fields to return in the response (if empty, all fields are returned) | [optional] |
+| **expand** | [**Array&lt;String&gt;**](String.md) | The list of fields that will be expanded in the response | [optional] |
+| **sync_token** | **String** | The sync token to select the only updated results | [optional] |
+
+### Return type
+
+[**EmploymentResult**](EmploymentResult.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## employments_list
+
+> <EmploymentsPaginated> employments_list(x_account_id, opts)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'stackone_hris_client'
+# setup authorization
+StackOneHRIS.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = StackOneHRIS::EmploymentsApi.new
+x_account_id = 'x_account_id_example' # String | The account identifier
+opts = {
+  page: 'page_example', # String | The page number of the results to fetch
+  page_size: 'page_size_example', # String | The number of results per page
+  raw: true, # Boolean | Indicates that the raw request result is returned
+  fields: ['inner_example'], # Array<String> | The list of fields to return in the response (if empty, all fields are returned)
+  expand: ['inner_example'], # Array<String> | The list of fields that will be expanded in the response
+  sync_token: 'sync_token_example' # String | The sync token to select the only updated results
+}
+
+begin
+  # 
+  result = api_instance.employments_list(x_account_id, opts)
+  p result
+rescue StackOneHRIS::ApiError => e
+  puts "Error when calling EmploymentsApi->employments_list: #{e}"
+end
+```
+
+#### Using the employments_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmploymentsPaginated>, Integer, Hash)> employments_list_with_http_info(x_account_id, opts)
+
+```ruby
+begin
+  # 
+  data, status_code, headers = api_instance.employments_list_with_http_info(x_account_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmploymentsPaginated>
+rescue StackOneHRIS::ApiError => e
+  puts "Error when calling EmploymentsApi->employments_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_id** | **String** | The account identifier |  |
+| **page** | **String** | The page number of the results to fetch | [optional] |
+| **page_size** | **String** | The number of results per page | [optional][default to &#39;25&#39;] |
+| **raw** | **Boolean** | Indicates that the raw request result is returned | [optional][default to false] |
+| **fields** | [**Array&lt;String&gt;**](String.md) | The list of fields to return in the response (if empty, all fields are returned) | [optional] |
+| **expand** | [**Array&lt;String&gt;**](String.md) | The list of fields that will be expanded in the response | [optional] |
+| **sync_token** | **String** | The sync token to select the only updated results | [optional] |
+
+### Return type
+
+[**EmploymentsPaginated**](EmploymentsPaginated.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/EmploymentsPaginated.md

@@ -0,0 +1,22 @@
+# StackOneHRIS::EmploymentsPaginated
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **next_page** | **String** |  |  |
+| **data** | [**Array<Employment>**](Employment.md) |  |  |
+| **raw** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'stackone_hris_client'
+
+instance = StackOneHRIS::EmploymentsPaginated.new(
+  next_page: null,
+  data: null,
+  raw: null
+)
+```
+

data/docs/Location.md

@@ -0,0 +1,38 @@
+# StackOneHRIS::Location
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **employee_id** | **String** |  |  |
+| **name** | **String** |  | [optional] |
+| **phone_number** | **String** |  | [optional] |
+| **street_1** | **String** |  | [optional] |
+| **street_2** | **String** |  | [optional] |
+| **city** | **String** |  | [optional] |
+| **state** | **String** |  | [optional] |
+| **zip_code** | **String** |  | [optional] |
+| **country** | **String** |  | [optional] |
+| **location_type** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'stackone_hris_client'
+
+instance = StackOneHRIS::Location.new(
+  id: null,
+  employee_id: null,
+  name: null,
+  phone_number: null,
+  street_1: null,
+  street_2: null,
+  city: null,
+  state: null,
+  zip_code: null,
+  country: null,
+  location_type: null
+)
+```
+

data/docs/LocationResult.md

@@ -0,0 +1,20 @@
+# StackOneHRIS::LocationResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Location**](Location.md) |  |  |
+| **raw** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'stackone_hris_client'
+
+instance = StackOneHRIS::LocationResult.new(
+  data: null,
+  raw: null
+)
+```
+

data/docs/LocationsApi.md

@@ -0,0 +1,175 @@
+# StackOneHRIS::LocationsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**hris_locations_get**](LocationsApi.md#hris_locations_get) | **GET** /unified/hris/locations/{id} |  |
+| [**hris_locations_list**](LocationsApi.md#hris_locations_list) | **GET** /unified/hris/locations |  |
+
+
+## hris_locations_get
+
+> <LocationResult> hris_locations_get(id, x_account_id, opts)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'stackone_hris_client'
+# setup authorization
+StackOneHRIS.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = StackOneHRIS::LocationsApi.new
+id = 'id_example' # String | 
+x_account_id = 'x_account_id_example' # String | The account identifier
+opts = {
+  page: 'page_example', # String | The page number of the results to fetch
+  page_size: 'page_size_example', # String | The number of results per page
+  raw: true, # Boolean | Indicates that the raw request result is returned
+  fields: ['inner_example'], # Array<String> | The list of fields to return in the response (if empty, all fields are returned)
+  expand: ['inner_example'], # Array<String> | The list of fields that will be expanded in the response
+  sync_token: 'sync_token_example' # String | The sync token to select the only updated results
+}
+
+begin
+  # 
+  result = api_instance.hris_locations_get(id, x_account_id, opts)
+  p result
+rescue StackOneHRIS::ApiError => e
+  puts "Error when calling LocationsApi->hris_locations_get: #{e}"
+end
+```
+
+#### Using the hris_locations_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LocationResult>, Integer, Hash)> hris_locations_get_with_http_info(id, x_account_id, opts)
+
+```ruby
+begin
+  # 
+  data, status_code, headers = api_instance.hris_locations_get_with_http_info(id, x_account_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LocationResult>
+rescue StackOneHRIS::ApiError => e
+  puts "Error when calling LocationsApi->hris_locations_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **x_account_id** | **String** | The account identifier |  |
+| **page** | **String** | The page number of the results to fetch | [optional] |
+| **page_size** | **String** | The number of results per page | [optional][default to &#39;25&#39;] |
+| **raw** | **Boolean** | Indicates that the raw request result is returned | [optional][default to false] |
+| **fields** | [**Array&lt;String&gt;**](String.md) | The list of fields to return in the response (if empty, all fields are returned) | [optional] |
+| **expand** | [**Array&lt;String&gt;**](String.md) | The list of fields that will be expanded in the response | [optional] |
+| **sync_token** | **String** | The sync token to select the only updated results | [optional] |
+
+### Return type
+
+[**LocationResult**](LocationResult.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## hris_locations_list
+
+> <LocationsPaginated> hris_locations_list(x_account_id, opts)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'stackone_hris_client'
+# setup authorization
+StackOneHRIS.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = StackOneHRIS::LocationsApi.new
+x_account_id = 'x_account_id_example' # String | The account identifier
+opts = {
+  page: 'page_example', # String | The page number of the results to fetch
+  page_size: 'page_size_example', # String | The number of results per page
+  raw: true, # Boolean | Indicates that the raw request result is returned
+  fields: ['inner_example'], # Array<String> | The list of fields to return in the response (if empty, all fields are returned)
+  expand: ['inner_example'], # Array<String> | The list of fields that will be expanded in the response
+  sync_token: 'sync_token_example' # String | The sync token to select the only updated results
+}
+
+begin
+  # 
+  result = api_instance.hris_locations_list(x_account_id, opts)
+  p result
+rescue StackOneHRIS::ApiError => e
+  puts "Error when calling LocationsApi->hris_locations_list: #{e}"
+end
+```
+
+#### Using the hris_locations_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LocationsPaginated>, Integer, Hash)> hris_locations_list_with_http_info(x_account_id, opts)
+
+```ruby
+begin
+  # 
+  data, status_code, headers = api_instance.hris_locations_list_with_http_info(x_account_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LocationsPaginated>
+rescue StackOneHRIS::ApiError => e
+  puts "Error when calling LocationsApi->hris_locations_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_id** | **String** | The account identifier |  |
+| **page** | **String** | The page number of the results to fetch | [optional] |
+| **page_size** | **String** | The number of results per page | [optional][default to &#39;25&#39;] |
+| **raw** | **Boolean** | Indicates that the raw request result is returned | [optional][default to false] |
+| **fields** | [**Array&lt;String&gt;**](String.md) | The list of fields to return in the response (if empty, all fields are returned) | [optional] |
+| **expand** | [**Array&lt;String&gt;**](String.md) | The list of fields that will be expanded in the response | [optional] |
+| **sync_token** | **String** | The sync token to select the only updated results | [optional] |
+
+### Return type
+
+[**LocationsPaginated**](LocationsPaginated.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+