stackone_hris_client 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7b2ece4daf0c6a163d20b7c8877108df22c5acdf86d03b27986582d11547f73
-  data.tar.gz: af71cf660e66e3fb0d461c113169c448d65bd3949265d76a9f5b47e1dc46888c
+  metadata.gz: 223a9e04960e5c4a198b29a40b4d05f436d28af77c5e8c9f07bee1b154ec2f22
+  data.tar.gz: 632b53d0447304594ec1b8aadd78ec097d1996f5620f558d951baf237e090be6
 SHA512:
-  metadata.gz: 041a04aee60c707b15864abef862a4daf83685b3a853d664aea9219e57a7e8cd04ff534a6310e0eb24a704adedaece1b99af0c8a55d0075cec2c153cfb354f54
-  data.tar.gz: 5f238823713f3cad99b24dd073ba23d47d319a5edd703f743d2a484c5f7dfa9bb9c1cb9699fa92b49130229fa2adfd5d6473149a49bb5c018383642a106d5c98
+  metadata.gz: 21b69b0150336543e1efef0ab6ba96faf03e1ec4ef30eaf21d1002a9322f70459183f73c32b449612879aba93428d42e0b0197b36c71f0c7f78cae4fd44110a3
+  data.tar.gz: 76d184526e89488bd6b616340dec8b5ff995ecfe85649d93b6045efdd149949db535c32fb4da521c182cc4c257d02efcf40041f45c3873524ca709a8593c0912

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stackone_hris_client (1.0.0)
+    stackone_hris_client (1.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/README.md

@@ -1,13 +1,13 @@
 # stackone_hris_client
 
-StackOneHrisClient - the Ruby gem for the StackOne Unified API
+StackOneHRIS - the Ruby gem for the StackOne Unified API - HRIS
 
-The documentation for the StackOne Unified API
+The documentation for the StackOne Unified API - HRIS
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 1.0
-- Package version: 1.0.0
+- API version: 1.0.0
+- Package version: 1.2.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,16 +23,16 @@ gem build stackone_hris_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./stackone_hris_client-1.0.0.gem
+gem install ./stackone_hris_client-1.2.0.gem
 ```
 
-(for development, run `gem install --dev ./stackone_hris_client-1.0.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./stackone_hris_client-1.2.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'stackone_hris_client', '~> 1.0.0'
+    gem 'stackone_hris_client', '~> 1.2.0'
 
 ### Install from Git
 
@@ -57,12 +57,12 @@ Please follow the [installation](#installation) procedure and then run the follo
 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'
 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 = {
@@ -77,7 +77,7 @@ begin
   #
   result = api_instance.employees_get(id, x_account_id, opts)
   p result
-rescue StackOneHrisClient::ApiError => e
+rescue StackOneHRIS::ApiError => e
   puts "Exception when calling EmployeesApi->employees_get: #{e}"
 end
 
@@ -89,14 +89,41 @@ All URIs are relative to *http://localhost*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*StackOneHrisClient::EmployeesApi* | [**employees_get**](docs/EmployeesApi.md#employees_get) | **GET** /unified/hris/employees/{id} | 
-*StackOneHrisClient::EmployeesApi* | [**employees_list**](docs/EmployeesApi.md#employees_list) | **GET** /unified/hris/employees | 
+*StackOneHRIS::AccountsApi* | [**accounts_delete**](docs/AccountsApi.md#accounts_delete) | **DELETE** /accounts/{id} | 
+*StackOneHRIS::AccountsApi* | [**accounts_get**](docs/AccountsApi.md#accounts_get) | **GET** /accounts/{id} | 
+*StackOneHRIS::AccountsApi* | [**accounts_list**](docs/AccountsApi.md#accounts_list) | **GET** /accounts | 
+*StackOneHRIS::CompaniesApi* | [**companies_get**](docs/CompaniesApi.md#companies_get) | **GET** /unified/hris/companies/{id} | 
+*StackOneHRIS::CompaniesApi* | [**companies_list**](docs/CompaniesApi.md#companies_list) | **GET** /unified/hris/companies | 
+*StackOneHRIS::ConnectSessionsApi* | [**connect_sessions_authenticate**](docs/ConnectSessionsApi.md#connect_sessions_authenticate) | **POST** /connect_sessions/authenticate | 
+*StackOneHRIS::ConnectSessionsApi* | [**connect_sessions_create**](docs/ConnectSessionsApi.md#connect_sessions_create) | **POST** /connect_sessions | 
+*StackOneHRIS::EmployeesApi* | [**employees_get**](docs/EmployeesApi.md#employees_get) | **GET** /unified/hris/employees/{id} | 
+*StackOneHRIS::EmployeesApi* | [**employees_list**](docs/EmployeesApi.md#employees_list) | **GET** /unified/hris/employees | 
+*StackOneHRIS::EmploymentsApi* | [**employments_get**](docs/EmploymentsApi.md#employments_get) | **GET** /unified/hris/employments/{id} | 
+*StackOneHRIS::EmploymentsApi* | [**employments_list**](docs/EmploymentsApi.md#employments_list) | **GET** /unified/hris/employments | 
+*StackOneHRIS::LocationsApi* | [**hris_locations_get**](docs/LocationsApi.md#hris_locations_get) | **GET** /unified/hris/locations/{id} | 
+*StackOneHRIS::LocationsApi* | [**hris_locations_list**](docs/LocationsApi.md#hris_locations_list) | **GET** /unified/hris/locations | 
+
 
 ## Documentation for Models
 
- - [StackOneHrisClient::Employee](docs/Employee.md)
- - [StackOneHrisClient::EmployeeResult](docs/EmployeeResult.md)
- - [StackOneHrisClient::EmployeesPaginated](docs/EmployeesPaginated.md)
+ - [StackOneHRIS::Account](docs/Account.md)
+ - [StackOneHRIS::CompaniesPaginated](docs/CompaniesPaginated.md)
+ - [StackOneHRIS::Company](docs/Company.md)
+ - [StackOneHRIS::CompanyResult](docs/CompanyResult.md)
+ - [StackOneHRIS::ConnectSession](docs/ConnectSession.md)
+ - [StackOneHRIS::ConnectSessionAuthenticate](docs/ConnectSessionAuthenticate.md)
+ - [StackOneHRIS::ConnectSessionCreate](docs/ConnectSessionCreate.md)
+ - [StackOneHRIS::ConnectSessionToken](docs/ConnectSessionToken.md)
+ - [StackOneHRIS::Employee](docs/Employee.md)
+ - [StackOneHRIS::EmployeeResult](docs/EmployeeResult.md)
+ - [StackOneHRIS::EmployeesPaginated](docs/EmployeesPaginated.md)
+ - [StackOneHRIS::Employment](docs/Employment.md)
+ - [StackOneHRIS::EmploymentResult](docs/EmploymentResult.md)
+ - [StackOneHRIS::EmploymentsPaginated](docs/EmploymentsPaginated.md)
+ - [StackOneHRIS::Location](docs/Location.md)
+ - [StackOneHRIS::LocationResult](docs/LocationResult.md)
+ - [StackOneHRIS::LocationsPaginated](docs/LocationsPaginated.md)
+
 
 ## Documentation for Authorization
 

data/docs/Account.md

@@ -0,0 +1,32 @@
+# StackOneHRIS::Account
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **provider** | **String** |  |  |
+| **origin_owner_id** | **String** |  |  |
+| **origin_owner_name** | **String** |  |  |
+| **origin_username** | **String** |  |  |
+| **credentials** | **Object** |  |  |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'stackone_hris_client'
+
+instance = StackOneHRIS::Account.new(
+  id: null,
+  provider: null,
+  origin_owner_id: null,
+  origin_owner_name: null,
+  origin_username: null,
+  credentials: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/AccountsApi.md

@@ -0,0 +1,218 @@
+# StackOneHRIS::AccountsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**accounts_delete**](AccountsApi.md#accounts_delete) | **DELETE** /accounts/{id} |  |
+| [**accounts_get**](AccountsApi.md#accounts_get) | **GET** /accounts/{id} |  |
+| [**accounts_list**](AccountsApi.md#accounts_list) | **GET** /accounts |  |
+
+
+## accounts_delete
+
+> <Account> accounts_delete(id)
+
+
+
+### 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::AccountsApi.new
+id = 'id_example' # String | 
+
+begin
+  # 
+  result = api_instance.accounts_delete(id)
+  p result
+rescue StackOneHRIS::ApiError => e
+  puts "Error when calling AccountsApi->accounts_delete: #{e}"
+end
+```
+
+#### Using the accounts_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Account>, Integer, Hash)> accounts_delete_with_http_info(id)
+
+```ruby
+begin
+  # 
+  data, status_code, headers = api_instance.accounts_delete_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Account>
+rescue StackOneHRIS::ApiError => e
+  puts "Error when calling AccountsApi->accounts_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**Account**](Account.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## accounts_get
+
+> <Account> accounts_get(id)
+
+
+
+### 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::AccountsApi.new
+id = 'id_example' # String | 
+
+begin
+  # 
+  result = api_instance.accounts_get(id)
+  p result
+rescue StackOneHRIS::ApiError => e
+  puts "Error when calling AccountsApi->accounts_get: #{e}"
+end
+```
+
+#### Using the accounts_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Account>, Integer, Hash)> accounts_get_with_http_info(id)
+
+```ruby
+begin
+  # 
+  data, status_code, headers = api_instance.accounts_get_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Account>
+rescue StackOneHRIS::ApiError => e
+  puts "Error when calling AccountsApi->accounts_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**Account**](Account.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## accounts_list
+
+> <Array<Account>> accounts_list(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::AccountsApi.new
+opts = {
+  provider: 'provider_example', # String | The provider of the results to fetch
+  origin_owner_id: 'origin_owner_id_example' # String | The origin owner identifier of the results to fetch
+}
+
+begin
+  # 
+  result = api_instance.accounts_list(opts)
+  p result
+rescue StackOneHRIS::ApiError => e
+  puts "Error when calling AccountsApi->accounts_list: #{e}"
+end
+```
+
+#### Using the accounts_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Account>>, Integer, Hash)> accounts_list_with_http_info(opts)
+
+```ruby
+begin
+  # 
+  data, status_code, headers = api_instance.accounts_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Account>>
+rescue StackOneHRIS::ApiError => e
+  puts "Error when calling AccountsApi->accounts_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** | The provider of the results to fetch | [optional] |
+| **origin_owner_id** | **String** | The origin owner identifier of the results to fetch | [optional] |
+
+### Return type
+
+[**Array&lt;Account&gt;**](Account.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CompaniesApi.md

@@ -0,0 +1,175 @@
+# StackOneHRIS::CompaniesApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**companies_get**](CompaniesApi.md#companies_get) | **GET** /unified/hris/companies/{id} |  |
+| [**companies_list**](CompaniesApi.md#companies_list) | **GET** /unified/hris/companies |  |
+
+
+## companies_get
+
+> <CompanyResult> companies_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::CompaniesApi.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.companies_get(id, x_account_id, opts)
+  p result
+rescue StackOneHRIS::ApiError => e
+  puts "Error when calling CompaniesApi->companies_get: #{e}"
+end
+```
+
+#### Using the companies_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CompanyResult>, Integer, Hash)> companies_get_with_http_info(id, x_account_id, opts)
+
+```ruby
+begin
+  # 
+  data, status_code, headers = api_instance.companies_get_with_http_info(id, x_account_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CompanyResult>
+rescue StackOneHRIS::ApiError => e
+  puts "Error when calling CompaniesApi->companies_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
+
+[**CompanyResult**](CompanyResult.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_list
+
+> <CompaniesPaginated> companies_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::CompaniesApi.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.companies_list(x_account_id, opts)
+  p result
+rescue StackOneHRIS::ApiError => e
+  puts "Error when calling CompaniesApi->companies_list: #{e}"
+end
+```
+
+#### Using the companies_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CompaniesPaginated>, Integer, Hash)> companies_list_with_http_info(x_account_id, opts)
+
+```ruby
+begin
+  # 
+  data, status_code, headers = api_instance.companies_list_with_http_info(x_account_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CompaniesPaginated>
+rescue StackOneHRIS::ApiError => e
+  puts "Error when calling CompaniesApi->companies_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
+
+[**CompaniesPaginated**](CompaniesPaginated.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CompaniesPaginated.md

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

data/docs/Company.md

@@ -0,0 +1,22 @@
+# StackOneHRIS::Company
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **display_name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'stackone_hris_client'
+
+instance = StackOneHRIS::Company.new(
+  id: null,
+  name: null,
+  display_name: null
+)
+```
+

data/docs/CompanyResult.md

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

data/docs/ConnectSession.md

@@ -0,0 +1,34 @@
+# StackOneHRIS::ConnectSession
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **organization_id** | **String** |  |  |
+| **project_id** | **String** |  |  |
+| **categories** | **Array<String>** |  | [optional] |
+| **provider** | **String** |  |  |
+| **origin_owner_id** | **String** |  |  |
+| **origin_owner_name** | **String** |  |  |
+| **origin_username** | **String** |  | [optional] |
+| **created_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'stackone_hris_client'
+
+instance = StackOneHRIS::ConnectSession.new(
+  id: null,
+  organization_id: null,
+  project_id: null,
+  categories: ["ats","hris","crm"],
+  provider: null,
+  origin_owner_id: null,
+  origin_owner_name: null,
+  origin_username: null,
+  created_at: null
+)
+```
+

data/docs/ConnectSessionAuthenticate.md

@@ -0,0 +1,18 @@
+# StackOneHRIS::ConnectSessionAuthenticate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | The token to authenticate with |  |
+
+## Example
+
+```ruby
+require 'stackone_hris_client'
+
+instance = StackOneHRIS::ConnectSessionAuthenticate.new(
+  token: null
+)
+```
+