stackone_hris_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b7b2ece4daf0c6a163d20b7c8877108df22c5acdf86d03b27986582d11547f73
+  data.tar.gz: af71cf660e66e3fb0d461c113169c448d65bd3949265d76a9f5b47e1dc46888c
+SHA512:
+  metadata.gz: 041a04aee60c707b15864abef862a4daf83685b3a853d664aea9219e57a7e8cd04ff534a6310e0eb24a704adedaece1b99af0c8a55d0075cec2c153cfb354f54
+  data.tar.gz: 5f238823713f3cad99b24dd073ba23d47d319a5edd703f743d2a484c5f7dfa9bb9c1cb9699fa92b49130229fa2adfd5d6473149a49bb5c018383642a106d5c98

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 1.48.0'
+end

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    stackone_hris_client (1.0.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.5)
+    json (2.6.3)
+    method_source (1.0.0)
+    parallel (1.22.1)
+    parser (3.2.1.1)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.48.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  pry-byebug
+  rake (~> 13.0.1)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 1.48.0)
+  stackone_hris_client!
+
+BUNDLED WITH
+   2.4.7

data/README.md

@@ -0,0 +1,107 @@
+# stackone_hris_client
+
+StackOneHrisClient - the Ruby gem for the StackOne Unified API
+
+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
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build stackone_hris_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./stackone_hris_client-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./stackone_hris_client-1.0.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'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'stackone_hris_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+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::EmployeesApi.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
+}
+
+begin
+  #
+  result = api_instance.employees_get(id, x_account_id, opts)
+  p result
+rescue StackOneHrisClient::ApiError => e
+  puts "Exception when calling EmployeesApi->employees_get: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+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 | 
+
+## Documentation for Models
+
+ - [StackOneHrisClient::Employee](docs/Employee.md)
+ - [StackOneHrisClient::EmployeeResult](docs/EmployeeResult.md)
+ - [StackOneHrisClient::EmployeesPaginated](docs/EmployeesPaginated.md)
+
+## Documentation for Authorization
+
+
+### basic
+
+- **Type**: HTTP basic authentication
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/Employee.md

@@ -0,0 +1,48 @@
+# StackOneHrisClient::Employee
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **first_name** | **String** |  |  |
+| **last_name** | **String** |  |  |
+| **name** | **String** |  |  |
+| **display_name** | **String** |  |  |
+| **avatar_url** | **String** |  | [optional] |
+| **personal_email** | **String** |  |  |
+| **personal_phone_number** | **String** |  |  |
+| **gender** | **String** |  |  |
+| **work_email** | **String** |  |  |
+| **work_phone_number** | **String** |  |  |
+| **title** | **String** |  |  |
+| **department** | **String** |  |  |
+| **manager_id** | **String** |  |  |
+| **birth_date** | **Time** |  |  |
+| **start_date** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'stackone_hris_client'
+
+instance = StackOneHrisClient::Employee.new(
+  id: null,
+  first_name: null,
+  last_name: null,
+  name: null,
+  display_name: null,
+  avatar_url: null,
+  personal_email: null,
+  personal_phone_number: null,
+  gender: null,
+  work_email: null,
+  work_phone_number: null,
+  title: null,
+  department: null,
+  manager_id: null,
+  birth_date: null,
+  start_date: null
+)
+```
+

data/docs/EmployeeResult.md

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

data/docs/EmployeesApi.md

@@ -0,0 +1,169 @@
+# StackOneHrisClient::EmployeesApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**employees_get**](EmployeesApi.md#employees_get) | **GET** /unified/hris/employees/{id} |  |
+| [**employees_list**](EmployeesApi.md#employees_list) | **GET** /unified/hris/employees |  |
+
+
+## employees_get
+
+> <EmployeeResult> employees_get(id, x_account_id, 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::EmployeesApi.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
+}
+
+begin
+  # 
+  result = api_instance.employees_get(id, x_account_id, opts)
+  p result
+rescue StackOneHrisClient::ApiError => e
+  puts "Error when calling EmployeesApi->employees_get: #{e}"
+end
+```
+
+#### Using the employees_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmployeeResult>, Integer, Hash)> employees_get_with_http_info(id, x_account_id, opts)
+
+```ruby
+begin
+  # 
+  data, status_code, headers = api_instance.employees_get_with_http_info(id, x_account_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmployeeResult>
+rescue StackOneHrisClient::ApiError => e
+  puts "Error when calling EmployeesApi->employees_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] |
+
+### Return type
+
+[**EmployeeResult**](EmployeeResult.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## employees_list
+
+> <EmployeesPaginated> employees_list(x_account_id, 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::EmployeesApi.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
+}
+
+begin
+  # 
+  result = api_instance.employees_list(x_account_id, opts)
+  p result
+rescue StackOneHrisClient::ApiError => e
+  puts "Error when calling EmployeesApi->employees_list: #{e}"
+end
+```
+
+#### Using the employees_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmployeesPaginated>, Integer, Hash)> employees_list_with_http_info(x_account_id, opts)
+
+```ruby
+begin
+  # 
+  data, status_code, headers = api_instance.employees_list_with_http_info(x_account_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmployeesPaginated>
+rescue StackOneHrisClient::ApiError => e
+  puts "Error when calling EmployeesApi->employees_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] |
+
+### Return type
+
+[**EmployeesPaginated**](EmployeesPaginated.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/EmployeesPaginated.md

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

data/gem-config.yml

@@ -0,0 +1,14 @@
+generatorName: ruby
+inputSpec: https://api.eu1.stackone.com/documentation-yaml
+additionalProperties:
+  moduleName: "StackOneHrisClient"
+  gemAuthor: "StackOne"
+  gemAuthorEmail: "developer-support@stackone.comm"
+  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.0.0"
+  library: "typhoeus"

data/generate_gem.sh

@@ -0,0 +1 @@
+openapi-generator generate -c gem-config.yml

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'