stackone_hris_client 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7b2ece4daf0c6a163d20b7c8877108df22c5acdf86d03b27986582d11547f73
-  data.tar.gz: af71cf660e66e3fb0d461c113169c448d65bd3949265d76a9f5b47e1dc46888c
+  metadata.gz: 1e3fcb0d1dde740779af40d971309c57e698435f3cf1204cfa64a70c5aab1003
+  data.tar.gz: 3357889e461742ed18574323cc7525054afc452a394e8f0d603495818dc6f1de
 SHA512:
-  metadata.gz: 041a04aee60c707b15864abef862a4daf83685b3a853d664aea9219e57a7e8cd04ff534a6310e0eb24a704adedaece1b99af0c8a55d0075cec2c153cfb354f54
-  data.tar.gz: 5f238823713f3cad99b24dd073ba23d47d319a5edd703f743d2a484c5f7dfa9bb9c1cb9699fa92b49130229fa2adfd5d6473149a49bb5c018383642a106d5c98
+  metadata.gz: aa13bc5f05a3f1ea7446c02e51c39752e2f19107a3251d8de90274ee1c7d20dbab7e297138822339ad19e79f52f74d966ca0e9b03c2dd949e48a122951cc4712
+  data.tar.gz: de6d30d22dd7b25fd5b81de49e4cd6a391e323b95d3950126df96652e58e29c39f19d451fdddaf992fa54abe227f948f87961d49a54e8cdf5d3431c6e5929a01

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

@@ -7,7 +7,7 @@ The documentation for the StackOne Unified API
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0
-- Package version: 1.0.0
+- Package version: 1.1.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.1.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.1.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.1.0'
 
 ### Install from Git
 
@@ -89,15 +89,26 @@ All URIs are relative to *http://localhost*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*StackOneHrisClient::AccountsApi* | [**accounts_get**](docs/AccountsApi.md#accounts_get) | **GET** /accounts/{id} | 
+*StackOneHrisClient::AccountsApi* | [**accounts_list**](docs/AccountsApi.md#accounts_list) | **GET** /accounts | 
+*StackOneHrisClient::ConnectSessionsApi* | [**connect_sessions_authenticate**](docs/ConnectSessionsApi.md#connect_sessions_authenticate) | **POST** /connect_sessions/authenticate | 
+*StackOneHrisClient::ConnectSessionsApi* | [**connect_sessions_create**](docs/ConnectSessionsApi.md#connect_sessions_create) | **POST** /connect_sessions | 
 *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 | 
 
+
 ## Documentation for Models
 
+ - [StackOneHrisClient::Account](docs/Account.md)
+ - [StackOneHrisClient::ConnectSession](docs/ConnectSession.md)
+ - [StackOneHrisClient::ConnectSessionAuthenticate](docs/ConnectSessionAuthenticate.md)
+ - [StackOneHrisClient::ConnectSessionCreate](docs/ConnectSessionCreate.md)
+ - [StackOneHrisClient::ConnectSessionToken](docs/ConnectSessionToken.md)
  - [StackOneHrisClient::Employee](docs/Employee.md)
  - [StackOneHrisClient::EmployeeResult](docs/EmployeeResult.md)
  - [StackOneHrisClient::EmployeesPaginated](docs/EmployeesPaginated.md)
 
+
 ## Documentation for Authorization
 
 

data/docs/Account.md

@@ -0,0 +1,32 @@
+# StackOneHrisClient::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 = StackOneHrisClient::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,147 @@
+# StackOneHrisClient::AccountsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**accounts_get**](AccountsApi.md#accounts_get) | **GET** /accounts/{id} |  |
+| [**accounts_list**](AccountsApi.md#accounts_list) | **GET** /accounts |  |
+
+
+## accounts_get
+
+> <Account> accounts_get(id)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'stackone_hris_client'
+# setup authorization
+StackOneHrisClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.api_key_token = 'YOUR API KEY'
+end
+
+api_instance = StackOneHrisClient::AccountsApi.new
+id = 'id_example' # String | 
+
+begin
+  # 
+  result = api_instance.accounts_get(id)
+  p result
+rescue StackOneHrisClient::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 StackOneHrisClient::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
+StackOneHrisClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.api_key_token = 'YOUR API KEY'
+end
+
+api_instance = StackOneHrisClient::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 StackOneHrisClient::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 StackOneHrisClient::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/ConnectSession.md

@@ -0,0 +1,34 @@
+# StackOneHrisClient::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 = StackOneHrisClient::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 @@
+# StackOneHrisClient::ConnectSessionAuthenticate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | The token to authenticate with |  |
+
+## Example
+
+```ruby
+require 'stackone_hris_client'
+
+instance = StackOneHrisClient::ConnectSessionAuthenticate.new(
+  token: null
+)
+```
+

data/docs/ConnectSessionCreate.md

@@ -0,0 +1,28 @@
+# StackOneHrisClient::ConnectSessionCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **categories** | **Array<String>** | The categories of the provider to connect to | [optional] |
+| **provider** | **String** | The provider to connect to | [optional] |
+| **origin_owner_id** | **String** | The origin owner identifier |  |
+| **origin_owner_name** | **String** | The origin owner name |  |
+| **origin_username** | **String** | The origin username | [optional] |
+| **metadata** | **Object** | The metadata for the connection | [optional] |
+
+## Example
+
+```ruby
+require 'stackone_hris_client'
+
+instance = StackOneHrisClient::ConnectSessionCreate.new(
+  categories: ["ats","hris","crm"],
+  provider: null,
+  origin_owner_id: null,
+  origin_owner_name: null,
+  origin_username: null,
+  metadata: null
+)
+```
+

data/docs/ConnectSessionToken.md

@@ -0,0 +1,36 @@
+# StackOneHrisClient::ConnectSessionToken
+
+## 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** |  |  |
+| **token** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'stackone_hris_client'
+
+instance = StackOneHrisClient::ConnectSessionToken.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,
+  token: null
+)
+```
+

data/docs/ConnectSessionsApi.md

@@ -0,0 +1,143 @@
+# StackOneHrisClient::ConnectSessionsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**connect_sessions_authenticate**](ConnectSessionsApi.md#connect_sessions_authenticate) | **POST** /connect_sessions/authenticate |  |
+| [**connect_sessions_create**](ConnectSessionsApi.md#connect_sessions_create) | **POST** /connect_sessions |  |
+
+
+## connect_sessions_authenticate
+
+> <ConnectSession> connect_sessions_authenticate(connect_session_authenticate)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'stackone_hris_client'
+# setup authorization
+StackOneHrisClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.api_key_token = 'YOUR API KEY'
+end
+
+api_instance = StackOneHrisClient::ConnectSessionsApi.new
+connect_session_authenticate = StackOneHrisClient::ConnectSessionAuthenticate.new({token: 'token_example'}) # ConnectSessionAuthenticate | The parameters to authenticate
+
+begin
+  # 
+  result = api_instance.connect_sessions_authenticate(connect_session_authenticate)
+  p result
+rescue StackOneHrisClient::ApiError => e
+  puts "Error when calling ConnectSessionsApi->connect_sessions_authenticate: #{e}"
+end
+```
+
+#### Using the connect_sessions_authenticate_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConnectSession>, Integer, Hash)> connect_sessions_authenticate_with_http_info(connect_session_authenticate)
+
+```ruby
+begin
+  # 
+  data, status_code, headers = api_instance.connect_sessions_authenticate_with_http_info(connect_session_authenticate)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConnectSession>
+rescue StackOneHrisClient::ApiError => e
+  puts "Error when calling ConnectSessionsApi->connect_sessions_authenticate_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **connect_session_authenticate** | [**ConnectSessionAuthenticate**](ConnectSessionAuthenticate.md) | The parameters to authenticate |  |
+
+### Return type
+
+[**ConnectSession**](ConnectSession.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## connect_sessions_create
+
+> <ConnectSessionToken> connect_sessions_create(connect_session_create)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'stackone_hris_client'
+# setup authorization
+StackOneHrisClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.api_key_token = 'YOUR API KEY'
+end
+
+api_instance = StackOneHrisClient::ConnectSessionsApi.new
+connect_session_create = StackOneHrisClient::ConnectSessionCreate.new({origin_owner_id: 'origin_owner_id_example', origin_owner_name: 'origin_owner_name_example'}) # ConnectSessionCreate | 
+
+begin
+  # 
+  result = api_instance.connect_sessions_create(connect_session_create)
+  p result
+rescue StackOneHrisClient::ApiError => e
+  puts "Error when calling ConnectSessionsApi->connect_sessions_create: #{e}"
+end
+```
+
+#### Using the connect_sessions_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConnectSessionToken>, Integer, Hash)> connect_sessions_create_with_http_info(connect_session_create)
+
+```ruby
+begin
+  # 
+  data, status_code, headers = api_instance.connect_sessions_create_with_http_info(connect_session_create)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConnectSessionToken>
+rescue StackOneHrisClient::ApiError => e
+  puts "Error when calling ConnectSessionsApi->connect_sessions_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **connect_session_create** | [**ConnectSessionCreate**](ConnectSessionCreate.md) |  |  |
+
+### Return type
+
+[**ConnectSessionToken**](ConnectSessionToken.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/EmployeesApi.md

@@ -33,7 +33,8 @@ opts = {
   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
+  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
@@ -74,6 +75,7 @@ end
 | **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
 
@@ -113,7 +115,8 @@ opts = {
   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
+  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
@@ -153,6 +156,7 @@ end
 | **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
 

data/gem-config.yml

@@ -10,5 +10,5 @@ additionalProperties:
   gemName: "stackone_hris_client"
   gemRequiredRubyVersion: ">= 2.7"
   gemSummary: "StackOne HRIS client gem"
-  gemVersion: "1.0.0"
+  gemVersion: "1.1.0"
   library: "typhoeus"