gem install stackone_client

require 'stackone_client'


s = ::StackOne::StackOne.new
s.config_security(
  ::StackOne::Shared::Security.new(
    password: "<YOUR_PASSWORD_HERE>",
  )
)


req = ::StackOne::Operations::HrisListEmployeesRequest.new(
  expand: "company,employments,work_location,home_location,custom_fields,groups",
  fields_: "id,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_title,job_description,department,cost_centers,benefits,manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,preferred_language,citizenships,home_location,work_location,employments,custom_fields,documents,created_at,updated_at,employee_number",
  filter: ::StackOne::Operations::HrisListEmployeesQueryParamFilter.new(
    updated_after: "2020-01-01T00:00:00.000Z",
  ),
  include: "avatar_url,avatar,custom_fields,job_description,benefits",
  x_account_id: "<value>",
)
    
res = s.hris.list_employees(req)

if ! res.employees_paginated.nil?
  # handle response
end

• delete_account - Delete Account
• get_account - Get Account
• get_account_meta_info - Get meta information of the account
• list_linked_accounts - List Accounts
• update_account - Update Account

• authenticate_connect_session - Authenticate Connect Session
• create_connect_session - Create Connect Session

• get_connector_meta - Get Connector Meta information for the given provider key
• list_connectors_meta - List Connectors Meta Information for all providers

• create_application - Create Application
• create_candidate - Create Candidate
• create_candidate_note - Create Candidate Note
• create_offer - Creates an offer
• download_application_document - Download Application Document
• get_application - Get Application
• get_application_document - Get Application Document
• get_application_offer - Get Application Offer
• get_application_scorecard - Get Application Scorecard
• get_candidate - Get Candidate
• get_candidate_note - Get Candidate Note
• get_department - Get Department
• get_interview - Get Interview
• get_interview_stage - Get Interview Stage
• get_job - Get Job
• get_job_posting - Get Job Posting
• get_location - Get Location
• get_offer - Get Offer
• get_rejected_reason - Get Rejected Reason
• get_user - Get User
• list_application_documents - List Application Documents
• list_application_scorecards - List Application Scorecards
• list_applications - List Applications
• list_applications_offers - List Application Offers
• list_candidate_notes - List Candidate Notes
• list_candidates - List Candidates
• list_departments - List Departments
• list_interview_stages - List Interview Stages
• list_interviews - List Interviews
• list_job_postings - List Job Postings
• list_jobs - List Jobs
• list_locations - List locations
• list_offers - List Offers
• list_rejected_reasons - List Rejected Reasons
• list_users - List Users
• update_application - Update an Application
• update_candidate - Update Candidate
• upload_application_document - Upload Application Document

• create_contact - Creates a new Contact
• get_account - Get Account
• get_contact - Get Contact
• get_list - Get List
• list_accounts - List Accounts
• list_contacts - List Contacts
• list_lists - Get all Lists
• update_contact - Update Contact (early access)

• create_employee - Creates an employee
• create_employee_time_off_request - Create Employee Time Off Request
• create_employee_work_eligibility_request - Create Employee Work Eligibility Request
• create_time_off_request - Creates a time off request
• download_employee_document - Download Employee Document
• get_benefit - Get Benefit
• get_company - Get Company
• get_employee - Get Employee
• get_employee_document - Get Employee Document
• get_employees_time_off_request - Get Employees Time Off Request
• get_employees_work_eligibility - Get Employees Work Eligibility
• get_employment - Get Employment
• get_group - Get Group
• get_location - Get Location
• get_time_off_request - Get time off request
• list_benefits - List benefits
• list_companies - List Companies
• list_employee_documents - List Employee Documents
• list_employee_time_off_requests - List Employee Time Off Requests
• list_employee_work_eligibility - List Employee Work Eligibility
• list_employees - List Employees
• list_employments - List Employments
• list_groups - List Groups
• list_locations - List locations
• list_time_off_requests - List time off requests
• update_employee - Updates an employee
• update_employee_work_eligibility_request - Update Employee Work Eligibility Request
• update_time_off_request - Update time off request
• upload_employee_document - Upload Employee Document

• create_email_template - Create email template
• create_omni_channel_template - Create omni-channel template
• create_push_template - Create push template
• get_campaign - Get campaign
• get_email_template - Get email template
• get_omni_channel_template - Get omni-channel template
• get_push_template - Get push template
• list_campaigns - List campaigns
• list_email_templates - List email templates
• list_omni_channel_templates - List omni-channel templates
• list_push_templates - List push templates
• update_email_template - Update email template
• update_omni_channel_template - Update omni-channel template
• update_push_template - Update push template

• proxy_request - Proxy Request

You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!