StackOneHRIS - the Ruby gem for the StackOne Unified API - HRIS
The documentation for the StackOne Unified API - HRIS
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.7.1
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
To build the Ruby code into a gem:
gem build stackone_hris_client.gemspecThen either install the gem locally:
gem install ./stackone_hris_client-1.7.1.gem(for development, run gem install --dev ./stackone_hris_client-1.7.1.gem to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'stackone_hris_client', '~> 1.7.1'
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 using -I as follows:
ruby -Ilib script.rbPlease follow the installation procedure and then run the following code:
# Load the gem
require 'stackone_hris_client'
# Setup authorization
StackOneHRIS.configure do |config|
# Configure HTTP basic authorization: basic
config.api_key_token = 'YOUR API KEY'
end
api_instance = StackOneHRIS::AccountsApi.new
id = 'id_example' # String |
begin
#Delete Account
result = api_instance.accounts_delete(id)
p result
rescue StackOneHRIS::ApiError => e
puts "Exception when calling AccountsApi->accounts_delete: #{e}"
endAll URIs are relative to https://api.stackone.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| StackOneHRIS::AccountsApi | accounts_delete | DELETE /accounts/{id} | Delete Account |
| StackOneHRIS::AccountsApi | accounts_get | GET /accounts/{id} | Get Account |
| StackOneHRIS::AccountsApi | accounts_list | GET /accounts | List Accounts |
| StackOneHRIS::AccountsApi | accounts_meta_get | GET /accounts/{id}/meta | Get meta information of the account |
| StackOneHRIS::CompaniesApi | hris_companies_get | GET /unified/hris/companies/{id} | Get Company |
| StackOneHRIS::CompaniesApi | hris_companies_list | GET /unified/hris/companies | List Companies |
| StackOneHRIS::ConnectSessionsApi | connect_sessions_authenticate | POST /connect_sessions/authenticate | Authenticate Session |
| StackOneHRIS::ConnectSessionsApi | connect_sessions_create | POST /connect_sessions | Create Session |
| StackOneHRIS::EmployeesApi | employee_create | POST /unified/hris/employees | Creates an employee |
| StackOneHRIS::EmployeesApi | employee_replace | PUT /unified/hris/employees/{id} | Replaces an employee |
| StackOneHRIS::EmployeesApi | employee_update | PATCH /unified/hris/employees/{id} | Updates an employee |
| StackOneHRIS::EmployeesApi | hris_employees_get | GET /unified/hris/employees/{id} | Get Employee |
| StackOneHRIS::EmployeesApi | hris_employees_list | GET /unified/hris/employees | List Employees |
| StackOneHRIS::EmploymentsApi | hris_employments_get | GET /unified/hris/employments/{id} | Get Employment |
| StackOneHRIS::EmploymentsApi | hris_employments_list | GET /unified/hris/employments | List Employments |
| StackOneHRIS::LocationsApi | hris_locations_get | GET /unified/hris/locations/{id} | Get location |
| StackOneHRIS::LocationsApi | hris_locations_list | GET /unified/hris/locations | List locations |
- StackOneHRIS::Account
- StackOneHRIS::AccountMeta
- StackOneHRIS::CompaniesPaginated
- StackOneHRIS::Company
- StackOneHRIS::CompanyResult
- StackOneHRIS::ConnectSession
- StackOneHRIS::ConnectSessionAuthenticate
- StackOneHRIS::ConnectSessionCreate
- StackOneHRIS::ConnectSessionToken
- StackOneHRIS::CountryCodeEnum
- StackOneHRIS::CreateEmployeeResult
- StackOneHRIS::Employee
- StackOneHRIS::EmployeeApiModel
- StackOneHRIS::EmployeeApiModelAvatar
- StackOneHRIS::EmployeeApiModelEmploymentStatus
- StackOneHRIS::EmployeeApiModelEmploymentType
- StackOneHRIS::EmployeeApiModelEthnicity
- StackOneHRIS::EmployeeApiModelGender
- StackOneHRIS::EmployeeApiModelHomeLocation
- StackOneHRIS::EmployeeApiModelMaritalStatus
- StackOneHRIS::EmployeeApiModelWorkLocation
- StackOneHRIS::EmployeeCustomFieldTypeEnum
- StackOneHRIS::EmployeeCustomFields
- StackOneHRIS::EmployeeCustomFieldsType
- StackOneHRIS::EmployeeResult
- StackOneHRIS::EmployeesPaginated
- StackOneHRIS::Employment
- StackOneHRIS::EmploymentEmploymentContractType
- StackOneHRIS::EmploymentEmploymentType
- StackOneHRIS::EmploymentPayFrequency
- StackOneHRIS::EmploymentPayPeriod
- StackOneHRIS::EmploymentResult
- StackOneHRIS::EmploymentScheduleTypeEnum
- StackOneHRIS::EmploymentStatusEnum
- StackOneHRIS::EmploymentTypeEnum
- StackOneHRIS::EmploymentsPaginated
- StackOneHRIS::EthnicityEnum
- StackOneHRIS::GenderEnum
- StackOneHRIS::HrisCreateEmployeeRequestDto
- StackOneHRIS::Image
- StackOneHRIS::Location
- StackOneHRIS::LocationCountry
- StackOneHRIS::LocationLocationType
- StackOneHRIS::LocationResult
- StackOneHRIS::LocationTypeEnum
- StackOneHRIS::LocationsPaginated
- StackOneHRIS::MaritalStatusEnum
- StackOneHRIS::PayFrequencyEnum
- StackOneHRIS::PayPeriodEnum
Authentication schemes defined for the API:
- Type: HTTP basic authentication