stackone_hris_client 1.1.0 → 1.2.1

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
+

data/docs/LocationsPaginated.md

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

data/gem-config.yml

@@ -1,14 +1,14 @@
 generatorName: ruby
-inputSpec: https://api.eu1.stackone.com/documentation-yaml
+inputSpec: https://api.eu1.stackone.com/documentation-hris-yaml
 additionalProperties:
-  moduleName: "StackOneHrisClient"
+  moduleName: "StackOneHRIS"
   gemAuthor: "StackOne"
-  gemAuthorEmail: "developer-support@stackone.comm"
+  gemAuthorEmail: "developer-support@stackone.com"
   gemDescription: "StackOne Unified API client for enhanced integrations with HRIS systems"
   gemHomepage: "https://stackone.com"
   gemLicense: "MIT"
   gemName: "stackone_hris_client"
   gemRequiredRubyVersion: ">= 2.7"
   gemSummary: "StackOne HRIS client gem"
-  gemVersion: "1.1.0"
+  gemVersion: "1.2.1"
   library: "typhoeus"

data/lib/stackone_hris_client/api/accounts_api.rb

@@ -1,9 +1,9 @@
 =begin
-#StackOne Unified API
+#StackOne Unified API - HRIS
 
-#The documentation for the StackOne Unified API
+#The documentation for the StackOne Unified API - HRIS
 
-The version of the OpenAPI document: 1.0
+The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.4.0
@@ -12,13 +12,74 @@ OpenAPI Generator version: 6.4.0
 
 require 'cgi'
 
-module StackOneHrisClient
+module StackOneHRIS
   class AccountsApi
     attr_accessor :api_client
 
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # 
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Account]
+    def accounts_delete(id, opts = {})
+      data, _status_code, _headers = accounts_delete_with_http_info(id, opts)
+      data
+    end
+
+    # 
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Account, Integer, Hash)>] Account data, response status code and response headers
+    def accounts_delete_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountsApi.accounts_delete ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling AccountsApi.accounts_delete"
+      end
+      # resource path
+      local_var_path = '/accounts/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Account'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basic']
+
+      new_options = opts.merge(
+        :operation => :"AccountsApi.accounts_delete",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountsApi#accounts_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # 
     # @param id [String] 
     # @param [Hash] opts the optional parameters

data/lib/stackone_hris_client/api/companies_api.rb

@@ -0,0 +1,188 @@
+=begin
+#StackOne Unified API - HRIS
+
+#The documentation for the StackOne Unified API - HRIS
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.4.0
+
+=end
+
+require 'cgi'
+
+module StackOneHRIS
+  class CompaniesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 
+    # @param id [String] 
+    # @param x_account_id [String] The account identifier
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :page The page number of the results to fetch
+    # @option opts [String] :page_size The number of results per page (default to '25')
+    # @option opts [Boolean] :raw Indicates that the raw request result is returned (default to false)
+    # @option opts [Array<String>] :fields The list of fields to return in the response (if empty, all fields are returned)
+    # @option opts [Array<String>] :expand The list of fields that will be expanded in the response
+    # @option opts [String] :sync_token The sync token to select the only updated results
+    # @return [CompanyResult]
+    def companies_get(id, x_account_id, opts = {})
+      data, _status_code, _headers = companies_get_with_http_info(id, x_account_id, opts)
+      data
+    end
+
+    # 
+    # @param id [String] 
+    # @param x_account_id [String] The account identifier
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :page The page number of the results to fetch
+    # @option opts [String] :page_size The number of results per page (default to '25')
+    # @option opts [Boolean] :raw Indicates that the raw request result is returned (default to false)
+    # @option opts [Array<String>] :fields The list of fields to return in the response (if empty, all fields are returned)
+    # @option opts [Array<String>] :expand The list of fields that will be expanded in the response
+    # @option opts [String] :sync_token The sync token to select the only updated results
+    # @return [Array<(CompanyResult, Integer, Hash)>] CompanyResult data, response status code and response headers
+    def companies_get_with_http_info(id, x_account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CompaniesApi.companies_get ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling CompaniesApi.companies_get"
+      end
+      # verify the required parameter 'x_account_id' is set
+      if @api_client.config.client_side_validation && x_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'x_account_id' when calling CompaniesApi.companies_get"
+      end
+      # resource path
+      local_var_path = '/unified/hris/companies/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'raw'] = opts[:'raw'] if !opts[:'raw'].nil?
+      query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if !opts[:'expand'].nil?
+      query_params[:'sync_token'] = opts[:'sync_token'] if !opts[:'sync_token'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'x-account-id'] = x_account_id
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CompanyResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basic']
+
+      new_options = opts.merge(
+        :operation => :"CompaniesApi.companies_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CompaniesApi#companies_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 
+    # @param x_account_id [String] The account identifier
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :page The page number of the results to fetch
+    # @option opts [String] :page_size The number of results per page (default to '25')
+    # @option opts [Boolean] :raw Indicates that the raw request result is returned (default to false)
+    # @option opts [Array<String>] :fields The list of fields to return in the response (if empty, all fields are returned)
+    # @option opts [Array<String>] :expand The list of fields that will be expanded in the response
+    # @option opts [String] :sync_token The sync token to select the only updated results
+    # @return [CompaniesPaginated]
+    def companies_list(x_account_id, opts = {})
+      data, _status_code, _headers = companies_list_with_http_info(x_account_id, opts)
+      data
+    end
+
+    # 
+    # @param x_account_id [String] The account identifier
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :page The page number of the results to fetch
+    # @option opts [String] :page_size The number of results per page (default to '25')
+    # @option opts [Boolean] :raw Indicates that the raw request result is returned (default to false)
+    # @option opts [Array<String>] :fields The list of fields to return in the response (if empty, all fields are returned)
+    # @option opts [Array<String>] :expand The list of fields that will be expanded in the response
+    # @option opts [String] :sync_token The sync token to select the only updated results
+    # @return [Array<(CompaniesPaginated, Integer, Hash)>] CompaniesPaginated data, response status code and response headers
+    def companies_list_with_http_info(x_account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CompaniesApi.companies_list ...'
+      end
+      # verify the required parameter 'x_account_id' is set
+      if @api_client.config.client_side_validation && x_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'x_account_id' when calling CompaniesApi.companies_list"
+      end
+      # resource path
+      local_var_path = '/unified/hris/companies'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'raw'] = opts[:'raw'] if !opts[:'raw'].nil?
+      query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if !opts[:'expand'].nil?
+      query_params[:'sync_token'] = opts[:'sync_token'] if !opts[:'sync_token'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'x-account-id'] = x_account_id
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CompaniesPaginated'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basic']
+
+      new_options = opts.merge(
+        :operation => :"CompaniesApi.companies_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CompaniesApi#companies_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/stackone_hris_client/api/connect_sessions_api.rb

@@ -1,9 +1,9 @@
 =begin
-#StackOne Unified API
+#StackOne Unified API - HRIS
 
-#The documentation for the StackOne Unified API
+#The documentation for the StackOne Unified API - HRIS
 
-The version of the OpenAPI document: 1.0
+The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.4.0
@@ -12,7 +12,7 @@ OpenAPI Generator version: 6.4.0
 
 require 'cgi'
 
-module StackOneHrisClient
+module StackOneHRIS
   class ConnectSessionsApi
     attr_accessor :api_client
 

data/lib/stackone_hris_client/api/employees_api.rb

@@ -1,9 +1,9 @@
 =begin
-#StackOne Unified API
+#StackOne Unified API - HRIS
 
-#The documentation for the StackOne Unified API
+#The documentation for the StackOne Unified API - HRIS
 
-The version of the OpenAPI document: 1.0
+The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.4.0
@@ -12,7 +12,7 @@ OpenAPI Generator version: 6.4.0
 
 require 'cgi'
 
-module StackOneHrisClient
+module StackOneHRIS
   class EmployeesApi
     attr_accessor :api_client