stackone_hris_client 1.5.2 → 1.6.0

data/docs/EmploymentsApi.md

@@ -4,15 +4,15 @@ All URIs are relative to *https://api.stackone.com*
 
 | 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 |  |
+| [**hris_employments_get**](EmploymentsApi.md#hris_employments_get) | **GET** /unified/hris/employments/{id} | Get Employment |
+| [**hris_employments_list**](EmploymentsApi.md#hris_employments_list) | **GET** /unified/hris/employments | List Employments |
 
 
-## employments_get
-
-> <EmploymentResult> employments_get(id, x_account_id, opts)
+## hris_employments_get
 
+> <EmploymentResult> hris_employments_get(id, x_account_id, opts)
 
+Get Employment
 
 ### Examples
 
@@ -38,29 +38,29 @@ opts = {
 }
 
 begin
-  # 
-  result = api_instance.employments_get(id, x_account_id, opts)
+  # Get Employment
+  result = api_instance.hris_employments_get(id, x_account_id, opts)
   p result
 rescue StackOneHRIS::ApiError => e
-  puts "Error when calling EmploymentsApi->employments_get: #{e}"
+  puts "Error when calling EmploymentsApi->hris_employments_get: #{e}"
 end
 ```
 
-#### Using the employments_get_with_http_info variant
+#### Using the hris_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)
+> <Array(<EmploymentResult>, Integer, Hash)> hris_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)
+  # Get Employment
+  data, status_code, headers = api_instance.hris_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}"
+  puts "Error when calling EmploymentsApi->hris_employments_get_with_http_info: #{e}"
 end
 ```
 
@@ -91,11 +91,11 @@ end
 - **Accept**: application/json
 
 
-## employments_list
-
-> <EmploymentsPaginated> employments_list(x_account_id, opts)
+## hris_employments_list
 
+> <EmploymentsPaginated> hris_employments_list(x_account_id, opts)
 
+List Employments
 
 ### Examples
 
@@ -120,29 +120,29 @@ opts = {
 }
 
 begin
-  # 
-  result = api_instance.employments_list(x_account_id, opts)
+  # List Employments
+  result = api_instance.hris_employments_list(x_account_id, opts)
   p result
 rescue StackOneHRIS::ApiError => e
-  puts "Error when calling EmploymentsApi->employments_list: #{e}"
+  puts "Error when calling EmploymentsApi->hris_employments_list: #{e}"
 end
 ```
 
-#### Using the employments_list_with_http_info variant
+#### Using the hris_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)
+> <Array(<EmploymentsPaginated>, Integer, Hash)> hris_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)
+  # List Employments
+  data, status_code, headers = api_instance.hris_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}"
+  puts "Error when calling EmploymentsApi->hris_employments_list_with_http_info: #{e}"
 end
 ```
 

data/docs/LocationsApi.md

@@ -4,15 +4,15 @@ All URIs are relative to *https://api.stackone.com*
 
 | 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**](LocationsApi.md#hris_locations_get) | **GET** /unified/hris/locations/{id} | Get location |
+| [**hris_locations_list**](LocationsApi.md#hris_locations_list) | **GET** /unified/hris/locations | List locations |
 
 
 ## hris_locations_get
 
 > <LocationResult> hris_locations_get(id, x_account_id, opts)
 
-
+Get location
 
 ### Examples
 
@@ -38,7 +38,7 @@ opts = {
 }
 
 begin
-  # 
+  # Get location
   result = api_instance.hris_locations_get(id, x_account_id, opts)
   p result
 rescue StackOneHRIS::ApiError => e
@@ -54,7 +54,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # 
+  # Get location
   data, status_code, headers = api_instance.hris_locations_get_with_http_info(id, x_account_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -95,7 +95,7 @@ end
 
 > <LocationsPaginated> hris_locations_list(x_account_id, opts)
 
-
+List locations
 
 ### Examples
 
@@ -120,7 +120,7 @@ opts = {
 }
 
 begin
-  # 
+  # List locations
   result = api_instance.hris_locations_list(x_account_id, opts)
   p result
 rescue StackOneHRIS::ApiError => e
@@ -136,7 +136,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # 
+  # List locations
   data, status_code, headers = api_instance.hris_locations_list_with_http_info(x_account_id, opts)
   p status_code # => 2xx
   p headers # => { ... }

data/gem-config.yml

@@ -1,5 +1,5 @@
 generatorName: ruby
-inputSpec: https://api.eu1.stackone.com/documentation-hris-yaml
+inputSpec: https://api.stackone.com/documentation-hris-yaml
 additionalProperties:
   moduleName: "StackOneHRIS"
   gemAuthor: "StackOne"
@@ -10,5 +10,5 @@ additionalProperties:
   gemName: "stackone_hris_client"
   gemRequiredRubyVersion: ">= 2.7"
   gemSummary: "StackOne HRIS client gem"
-  gemVersion: "1.5.2"
+  gemVersion: "1.6.0"
   library: "typhoeus"

data/lib/stackone_hris_client/api/accounts_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.5.0
+OpenAPI Generator version: 6.6.0
 
 =end
 
@@ -19,7 +19,7 @@ module StackOneHRIS
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # 
+    # Delete Account
     # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Account]
@@ -28,7 +28,7 @@ module StackOneHRIS
       data
     end
 
-    # 
+    # Delete Account
     # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Account, Integer, Hash)>] Account data, response status code and response headers
@@ -80,7 +80,7 @@ module StackOneHRIS
       return data, status_code, headers
     end
 
-    # 
+    # Get Account
     # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Account]
@@ -89,7 +89,7 @@ module StackOneHRIS
       data
     end
 
-    # 
+    # Get Account
     # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Account, Integer, Hash)>] Account data, response status code and response headers
@@ -141,7 +141,7 @@ module StackOneHRIS
       return data, status_code, headers
     end
 
-    # 
+    # List Accounts
     # @param [Hash] opts the optional parameters
     # @option opts [String] :provider The provider of the results to fetch
     # @option opts [String] :origin_owner_id The origin owner identifier of the results to fetch
@@ -151,7 +151,7 @@ module StackOneHRIS
       data
     end
 
-    # 
+    # List Accounts
     # @param [Hash] opts the optional parameters
     # @option opts [String] :provider The provider of the results to fetch
     # @option opts [String] :origin_owner_id The origin owner identifier of the results to fetch

data/lib/stackone_hris_client/api/companies_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.5.0
+OpenAPI Generator version: 6.6.0
 
 =end
 
@@ -19,7 +19,7 @@ module StackOneHRIS
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # 
+    # Get Company
     # @param id [String] 
     # @param x_account_id [String] The account identifier
     # @param [Hash] opts the optional parameters
@@ -30,12 +30,12 @@ module StackOneHRIS
     # @option opts [String] :sync_token The sync token to select the only updated results
     # @option opts [String] :updated_after Use a string with a date to only select results updated after that given date
     # @return [CompanyResult]
-    def companies_get(id, x_account_id, opts = {})
-      data, _status_code, _headers = companies_get_with_http_info(id, x_account_id, opts)
+    def hris_companies_get(id, x_account_id, opts = {})
+      data, _status_code, _headers = hris_companies_get_with_http_info(id, x_account_id, opts)
       data
     end
 
-    # 
+    # Get Company
     # @param id [String] 
     # @param x_account_id [String] The account identifier
     # @param [Hash] opts the optional parameters
@@ -46,17 +46,17 @@ module StackOneHRIS
     # @option opts [String] :sync_token The sync token to select the only updated results
     # @option opts [String] :updated_after Use a string with a date to only select results updated after that given date
     # @return [Array<(CompanyResult, Integer, Hash)>] CompanyResult data, response status code and response headers
-    def companies_get_with_http_info(id, x_account_id, opts = {})
+    def hris_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 ...'
+        @api_client.config.logger.debug 'Calling API: CompaniesApi.hris_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"
+        fail ArgumentError, "Missing the required parameter 'id' when calling CompaniesApi.hris_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"
+        fail ArgumentError, "Missing the required parameter 'x_account_id' when calling CompaniesApi.hris_companies_get"
       end
       # resource path
       local_var_path = '/unified/hris/companies/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
@@ -89,7 +89,7 @@ module StackOneHRIS
       auth_names = opts[:debug_auth_names] || ['basic']
 
       new_options = opts.merge(
-        :operation => :"CompaniesApi.companies_get",
+        :operation => :"CompaniesApi.hris_companies_get",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -100,12 +100,12 @@ module StackOneHRIS
 
       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}"
+        @api_client.config.logger.debug "API called: CompaniesApi#hris_companies_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # 
+    # List Companies
     # @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
@@ -115,12 +115,12 @@ module StackOneHRIS
     # @option opts [String] :sync_token The sync token to select the only updated results
     # @option opts [String] :updated_after Use a string with a date to only select results updated after that given date
     # @return [CompaniesPaginated]
-    def companies_list(x_account_id, opts = {})
-      data, _status_code, _headers = companies_list_with_http_info(x_account_id, opts)
+    def hris_companies_list(x_account_id, opts = {})
+      data, _status_code, _headers = hris_companies_list_with_http_info(x_account_id, opts)
       data
     end
 
-    # 
+    # List Companies
     # @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
@@ -130,13 +130,13 @@ module StackOneHRIS
     # @option opts [String] :sync_token The sync token to select the only updated results
     # @option opts [String] :updated_after Use a string with a date to only select results updated after that given date
     # @return [Array<(CompaniesPaginated, Integer, Hash)>] CompaniesPaginated data, response status code and response headers
-    def companies_list_with_http_info(x_account_id, opts = {})
+    def hris_companies_list_with_http_info(x_account_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: CompaniesApi.companies_list ...'
+        @api_client.config.logger.debug 'Calling API: CompaniesApi.hris_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"
+        fail ArgumentError, "Missing the required parameter 'x_account_id' when calling CompaniesApi.hris_companies_list"
       end
       # resource path
       local_var_path = '/unified/hris/companies'
@@ -169,7 +169,7 @@ module StackOneHRIS
       auth_names = opts[:debug_auth_names] || ['basic']
 
       new_options = opts.merge(
-        :operation => :"CompaniesApi.companies_list",
+        :operation => :"CompaniesApi.hris_companies_list",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -180,7 +180,7 @@ module StackOneHRIS
 
       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}"
+        @api_client.config.logger.debug "API called: CompaniesApi#hris_companies_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end

data/lib/stackone_hris_client/api/connect_sessions_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.5.0
+OpenAPI Generator version: 6.6.0
 
 =end
 
@@ -19,7 +19,7 @@ module StackOneHRIS
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # 
+    # Authenticate Session
     # @param connect_session_authenticate [ConnectSessionAuthenticate] The parameters to authenticate
     # @param [Hash] opts the optional parameters
     # @return [ConnectSession]
@@ -28,7 +28,7 @@ module StackOneHRIS
       data
     end
 
-    # 
+    # Authenticate Session
     # @param connect_session_authenticate [ConnectSessionAuthenticate] The parameters to authenticate
     # @param [Hash] opts the optional parameters
     # @return [Array<(ConnectSession, Integer, Hash)>] ConnectSession data, response status code and response headers
@@ -85,7 +85,7 @@ module StackOneHRIS
       return data, status_code, headers
     end
 
-    # 
+    # Create Session
     # @param connect_session_create [ConnectSessionCreate] 
     # @param [Hash] opts the optional parameters
     # @return [ConnectSessionToken]
@@ -94,7 +94,7 @@ module StackOneHRIS
       data
     end
 
-    # 
+    # Create Session
     # @param connect_session_create [ConnectSessionCreate] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ConnectSessionToken, Integer, Hash)>] ConnectSessionToken data, response status code and response headers

data/lib/stackone_hris_client/api/employees_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.5.0
+OpenAPI Generator version: 6.6.0
 
 =end
 
@@ -19,7 +19,7 @@ module StackOneHRIS
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # 
+    # Get Employee
     # @param id [String] 
     # @param x_account_id [String] The account identifier
     # @param [Hash] opts the optional parameters
@@ -31,12 +31,12 @@ module StackOneHRIS
     # @option opts [String] :updated_after Use a string with a date to only select results updated after that given date
     # @option opts [String] :expand The comma separated list of fields that will be expanded in the response (default to '')
     # @return [EmployeeResult]
-    def employees_get(id, x_account_id, opts = {})
-      data, _status_code, _headers = employees_get_with_http_info(id, x_account_id, opts)
+    def hris_employees_get(id, x_account_id, opts = {})
+      data, _status_code, _headers = hris_employees_get_with_http_info(id, x_account_id, opts)
       data
     end
 
-    # 
+    # Get Employee
     # @param id [String] 
     # @param x_account_id [String] The account identifier
     # @param [Hash] opts the optional parameters
@@ -48,17 +48,17 @@ module StackOneHRIS
     # @option opts [String] :updated_after Use a string with a date to only select results updated after that given date
     # @option opts [String] :expand The comma separated list of fields that will be expanded in the response (default to '')
     # @return [Array<(EmployeeResult, Integer, Hash)>] EmployeeResult data, response status code and response headers
-    def employees_get_with_http_info(id, x_account_id, opts = {})
+    def hris_employees_get_with_http_info(id, x_account_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: EmployeesApi.employees_get ...'
+        @api_client.config.logger.debug 'Calling API: EmployeesApi.hris_employees_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 EmployeesApi.employees_get"
+        fail ArgumentError, "Missing the required parameter 'id' when calling EmployeesApi.hris_employees_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 EmployeesApi.employees_get"
+        fail ArgumentError, "Missing the required parameter 'x_account_id' when calling EmployeesApi.hris_employees_get"
       end
       # resource path
       local_var_path = '/unified/hris/employees/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
@@ -92,7 +92,7 @@ module StackOneHRIS
       auth_names = opts[:debug_auth_names] || ['basic']
 
       new_options = opts.merge(
-        :operation => :"EmployeesApi.employees_get",
+        :operation => :"EmployeesApi.hris_employees_get",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -103,12 +103,12 @@ module StackOneHRIS
 
       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: EmployeesApi#employees_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: EmployeesApi#hris_employees_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # 
+    # List Employees
     # @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
@@ -119,12 +119,12 @@ module StackOneHRIS
     # @option opts [String] :updated_after Use a string with a date to only select results updated after that given date
     # @option opts [String] :expand The comma separated list of fields that will be expanded in the response (default to '')
     # @return [EmployeesPaginated]
-    def employees_list(x_account_id, opts = {})
-      data, _status_code, _headers = employees_list_with_http_info(x_account_id, opts)
+    def hris_employees_list(x_account_id, opts = {})
+      data, _status_code, _headers = hris_employees_list_with_http_info(x_account_id, opts)
       data
     end
 
-    # 
+    # List Employees
     # @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
@@ -135,13 +135,13 @@ module StackOneHRIS
     # @option opts [String] :updated_after Use a string with a date to only select results updated after that given date
     # @option opts [String] :expand The comma separated list of fields that will be expanded in the response (default to '')
     # @return [Array<(EmployeesPaginated, Integer, Hash)>] EmployeesPaginated data, response status code and response headers
-    def employees_list_with_http_info(x_account_id, opts = {})
+    def hris_employees_list_with_http_info(x_account_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: EmployeesApi.employees_list ...'
+        @api_client.config.logger.debug 'Calling API: EmployeesApi.hris_employees_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 EmployeesApi.employees_list"
+        fail ArgumentError, "Missing the required parameter 'x_account_id' when calling EmployeesApi.hris_employees_list"
       end
       # resource path
       local_var_path = '/unified/hris/employees'
@@ -175,7 +175,7 @@ module StackOneHRIS
       auth_names = opts[:debug_auth_names] || ['basic']
 
       new_options = opts.merge(
-        :operation => :"EmployeesApi.employees_list",
+        :operation => :"EmployeesApi.hris_employees_list",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -186,7 +186,7 @@ module StackOneHRIS
 
       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: EmployeesApi#employees_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: EmployeesApi#hris_employees_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end