stackone_hris_client 1.5.2 → 1.7.0

data/docs/HrisCreateEmployeeRequestDto.md

@@ -0,0 +1,80 @@
+# StackOneHRIS::HrisCreateEmployeeRequestDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The employee ID | [optional] |
+| **first_name** | **String** | The employee first name | [optional] |
+| **last_name** | **String** | The employee last name | [optional] |
+| **name** | **String** | The employee name | [optional] |
+| **display_name** | **String** | The employee display name | [optional] |
+| **avatar_url** | **String** | The employee avatar Url | [optional] |
+| **personal_email** | **String** | The employee personal email | [optional] |
+| **personal_phone_number** | **String** | The employee personal phone number | [optional] |
+| **work_email** | **String** | The employee work email | [optional] |
+| **work_phone_number** | **String** | The employee work phone number | [optional] |
+| **job_title** | **String** | The employee job title | [optional] |
+| **department** | **String** | The employee department | [optional] |
+| **manager_id** | **String** | The employee manager ID | [optional] |
+| **gender** | [**EmployeeApiModelGender**](EmployeeApiModelGender.md) |  | [optional] |
+| **ethnicity** | [**EmployeeApiModelEthnicity**](EmployeeApiModelEthnicity.md) |  | [optional] |
+| **date_of_birth** | **String** | The employee date_of_birth | [optional] |
+| **birthday** | **String** | The employee birthday | [optional] |
+| **marital_status** | [**EmployeeApiModelMaritalStatus**](EmployeeApiModelMaritalStatus.md) |  | [optional] |
+| **avatar** | [**EmployeeApiModelAvatar**](EmployeeApiModelAvatar.md) |  | [optional] |
+| **hire_date** | **String** | The employee hire date | [optional] |
+| **start_date** | **String** | The employee start date | [optional] |
+| **tenure** | **String** | The employee tenure | [optional] |
+| **work_anniversary** | **String** | The employee work anniversary | [optional] |
+| **employment_type** | [**EmployeeApiModelEmploymentType**](EmployeeApiModelEmploymentType.md) |  | [optional] |
+| **employment_contract_type** | [**EmploymentEmploymentContractType**](EmploymentEmploymentContractType.md) |  | [optional] |
+| **employment_status** | [**EmployeeApiModelEmploymentStatus**](EmployeeApiModelEmploymentStatus.md) |  | [optional] |
+| **termination_date** | **String** | The employee termination date | [optional] |
+| **home_location** | [**EmployeeApiModelHomeLocation**](EmployeeApiModelHomeLocation.md) |  | [optional] |
+| **work_location** | [**EmployeeApiModelWorkLocation**](EmployeeApiModelWorkLocation.md) |  | [optional] |
+| **company_name** | **String** | The employee company name | [optional] |
+| **employments** | [**Array<Employment>**](Employment.md) | The employee employments | [optional] |
+| **custom_fields** | [**Array<EmployeeCustomFields>**](EmployeeCustomFields.md) | The employee custom fields | [optional] |
+
+## Example
+
+```ruby
+require 'stackone_hris_client'
+
+instance = StackOneHRIS::HrisCreateEmployeeRequestDto.new(
+  id: 1687-3,
+  first_name: Issac,
+  last_name: Newton,
+  name: Issac Newton,
+  display_name: Sir Issac Newton,
+  avatar_url: https://example.com/avatar.png,
+  personal_email: isaac.newton@example.com,
+  personal_phone_number: +1234567890,
+  work_email: newton@example.com,
+  work_phone_number: +1234567890,
+  job_title: Physicist,
+  department: Physics,
+  manager_id: 67890,
+  gender: null,
+  ethnicity: null,
+  date_of_birth: 1990-01-01,
+  birthday: 2023-06-14T00:00:00Z,
+  marital_status: null,
+  avatar: null,
+  hire_date: 2022-01-01,
+  start_date: 2022-01-01,
+  tenure: 2,
+  work_anniversary: 2022-06-14T00:00:00Z,
+  employment_type: null,
+  employment_contract_type: null,
+  employment_status: null,
+  termination_date: 2023-06-14T00:00:00Z,
+  home_location: null,
+  work_location: null,
+  company_name: Example Corp,
+  employments: null,
+  custom_fields: null
+)
+```
+

data/docs/Location.md

@@ -4,17 +4,17 @@
 
 | 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** | [**CountryCodeEnum**](CountryCodeEnum.md) |  | [optional] |
-| **location_type** | [**LocationTypeEnum**](LocationTypeEnum.md) |  | [optional] |
+| **id** | **String** | The unique ID of the location | [optional] |
+| **employee_id** | **String** | The employee ID | [optional] |
+| **name** | **String** | The name of the location | [optional] |
+| **phone_number** | **String** | The phone number of the location | [optional] |
+| **street_1** | **String** | The first line of the address | [optional] |
+| **street_2** | **String** | The second line of the address | [optional] |
+| **city** | **String** | The city where the location is situated | [optional] |
+| **state** | **String** | The state where the location is situated | [optional] |
+| **zip_code** | **String** | The ZIP code/Postal code of the location | [optional] |
+| **country** | [**LocationCountry**](LocationCountry.md) |  | [optional] |
+| **location_type** | [**LocationLocationType**](LocationLocationType.md) |  | [optional] |
 
 ## Example
 
@@ -22,15 +22,15 @@
 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,
+  id: 123456,
+  employee_id: 1687-3,
+  name: Woolsthorpe Manor,
+  phone_number: +44 1476 860 364,
+  street_1: Water Lane,
+  street_2: Woolsthorpe by Colsterworth,
+  city: Grantham,
+  state: Lincolnshire,
+  zip_code: NG33 5NR,
   country: null,
   location_type: null
 )

data/docs/LocationCountry.md

@@ -0,0 +1,20 @@
+# StackOneHRIS::LocationCountry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **String** |  |  |
+| **source_value** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'stackone_hris_client'
+
+instance = StackOneHRIS::LocationCountry.new(
+  value: null,
+  source_value: null
+)
+```
+

data/docs/LocationLocationType.md

@@ -0,0 +1,20 @@
+# StackOneHRIS::LocationLocationType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **String** |  |  |
+| **source_value** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'stackone_hris_client'
+
+instance = StackOneHRIS::LocationLocationType.new(
+  value: null,
+  source_value: null
+)
+```
+

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
 
@@ -26,7 +26,7 @@ StackOneHRIS.configure do |config|
 end
 
 api_instance = StackOneHRIS::LocationsApi.new
-id = 'id_example' # String | 
+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
@@ -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://api2.eu1.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.7.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
@@ -201,5 +201,66 @@ module StackOneHRIS
       end
       return data, status_code, headers
     end
+
+    # Get meta information of the account
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [AccountMeta]
+    def accounts_meta_get(id, opts = {})
+      data, _status_code, _headers = accounts_meta_get_with_http_info(id, opts)
+      data
+    end
+
+    # Get meta information of the account
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountMeta, Integer, Hash)>] AccountMeta data, response status code and response headers
+    def accounts_meta_get_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountsApi.accounts_meta_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 AccountsApi.accounts_meta_get"
+      end
+      # resource path
+      local_var_path = '/accounts/{id}/meta'.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] || 'AccountMeta'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basic']
+
+      new_options = opts.merge(
+        :operation => :"AccountsApi.accounts_meta_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: AccountsApi#accounts_meta_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

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