stackone_client

Summary

Accounting: The documentation for the StackOne API The documentation for the StackOne Unified API - HRIS The documentation for the StackOne Unified API - ATS The documentation for the StackOne Unified API - CRM The documentation for the StackOne Unified API - MARKETING The documentation for the StackOne Unified API - LMS The documentation for the StackOne Unified API - IAM The documentation for the StackOne Unified API - TICKETING The documentation for the StackOne Unified API - DOCUMENTS The documentation for the StackOne Unified API - SCREENING The documentation for the StackOne Unified API - MESSAGING The documentation for the StackOne Unified API - ACCOUNTING

Table of Contents

• stackone_client
  • SDK Installation
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Retries
  • Error Handling
  • Server Selection
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK can be installed using RubyGems:

gem install stackone_client

SDK Example Usage

List Employees

require'stackone_client'Models= ::StackOne::Modelss= ::StackOne::StackOne.new(security: Models::Shared::Security.new(password: '',username: ''))req=Models::Operations::HrisListEmployeesRequest.new(prefer: 'heartbeat',expand: 'company,employments,work_location,home_location,groups,skills',fields_: 'id,remote_id,title,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_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,company_id,remote_company_id,preferred_language,citizenships,home_location,work_location,employments,custom_fields,created_at,updated_at,benefits,employee_number,national_identity_number,national_identity_numbers,bank_details,skills,unified_custom_fields',filter: Models::Operations::HrisListEmployeesQueryParamFilter.new(updated_after: DateTime.iso8601('2020-01-01T00:00:00.000Z')),include: 'avatar_url,avatar,custom_fields,job_description,benefits,bank_details',x_account_id: '<id>')res=s.hris.list_employees(request: req)unlessres.employees_paginated.nil?# handle responseend

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
password username	http	HTTP Basic

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

require'stackone_client'Models= ::StackOne::Modelss= ::StackOne::StackOne.new(security: Models::Shared::Security.new(password: '',username: ''))res=s.accounts.delete_account(id: '<id>')unlessres.linked_account.nil?# handle responseend

Per-Operation Security Schemes

Some operations in this SDK require the security scheme to be specified at the request level. For example:

require'stackone_client'Models= ::StackOne::Modelss= ::StackOne::StackOne.newres=s.mcp.mcp_delete(security: Models::Operations::StackoneMcpDeleteSecurity.new(),mcp_session_id: '<id>',x_account_id: '<id>')ifres.status_code == 200# handle responseend

Available Resources and Operations

Available methods

Accounting

• batch_create_company_journals - Batch Create Journals
• create_company_journal - Create Journal
• get_company - Get Company
• get_company_account - Get Account
• get_company_journal - Get Journal
• get_company_tax_rate - Get Tax Rate
• list_companies - List Companies
• list_company_accounts - List Accounts
• list_company_journals - List Journals
• list_company_tax_rates - List Tax Rates

Accounts

• delete_account - Delete Account
• get_account - Get Account
• get_account_meta_info - Get Account Meta Information (Legacy) ⚠️Deprecated
• list_linked_accounts - List Accounts
• update_account - Update Account

Actions

• build_action_embeddings - Rebuild action embeddings for semantic search
• check_permissions - Check user permissions on a resource
• list_actions_meta - List all connectors & actions metadata
• rpc_action - Make an RPC call to an action
• rpc_action_synced - Read synced action data from the datasync index
• search_actions - Search connector actions by semantic similarity

Ats

• create_application - Create Application
• create_application_note - Create Application Note
• create_background_check_package - Create Background Check Package
• create_candidate - Create Candidate
• create_candidate_note - Create Candidate Note
• create_interview_note - Create Interview Note
• create_job - Create Job
• create_offer - Create Offer
• delete_background_check_package - Delete Background Check Package
• download_application_document - Download Application Document
• get_application - Get Application
• get_application_custom_field_definition - Get Application Custom Field Definition
• get_application_document - Get Application Document
• get_application_document_category - Get Application Document Category
• get_application_note - Get Application Note
• get_application_offer - Get Application Offer
• get_application_scheduled_interview - Get Applications scheduled interview
• get_application_scorecard - Get Application Scorecard
• get_application_stage - Get Application Stage
• get_assessments_package - Get Assessments Package
• get_background_check_package - Get Background Check Package
• get_candidate - Get Candidate
• get_candidate_custom_field_definition - Get Candidate Custom Field Definition
• get_candidate_note - Get Candidate Note
• get_department - Get Department
• get_interview - Get Interview
• get_interview_stage - Get Interview Stage ⚠️Deprecated
• get_job - Get Job
• get_job_application_stage - Get Job Application Stage
• get_job_custom_field_definition - Get Job Custom Field Definition
• get_job_posting - Get Job Posting
• get_list - Get List
• get_location - Get Location
• get_offer - Get Offer
• get_rejected_reason - Get Rejected Reason
• get_user - Get User
• list_application_changes - List Application Changes
• list_application_custom_field_definitions - List Application Custom Field Definitions
• list_application_document_categories - List Application Document Categories
• list_application_documents - List Application Documents
• list_application_notes - List Application Notes
• list_application_scorecards - List Application Scorecards
• list_application_stages - List Application Stages
• list_applications - List Applications
• list_applications_offers - List Application Offers
• list_applications_scheduled_interviews - List Applications scheduled interviews
• list_assessments_packages - List Assessments Packages
• list_background_check_packages - List Background Check Packages
• list_candidate_custom_field_definitions - List Candidate Custom Field Definitions
• list_candidate_notes - List Candidate Notes
• list_candidates - List Candidates
• list_departments - List Departments
• list_interview_stages - List Interview Stages ⚠️Deprecated
• list_interviews - List Interviews
• list_job_application_stages - List Job Application Stages
• list_job_custom_field_definitions - List Job Custom Field Definitions
• list_job_postings - List Job Postings
• list_jobs - List Jobs
• list_lists - Get all Lists
• list_locations - List locations
• list_offers - List Offers
• list_rejected_reasons - List Rejected Reasons
• list_users - List Users
• move_application - Move Application
• order_assessments_request - Order Assessments Request
• order_background_check_request - Order Background Check Request
• reject_application - Reject Application
• update_application - Update Application
• update_application_note - Update Application Note
• update_assessments_result - Update Assessments Result
• update_background_check_package - Update Background Check Package
• update_background_check_result - Update Background Check Result
• update_candidate - Update Candidate
• update_interview_note - Update Interview Note
• update_job - Update Job
• upload_application_document - Upload Application Document

AuthConfigs

• list_auth_configs - List Auth Configs ⚠️Deprecated

ConnectSessions

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

ConnectorProfiles

• delete_connector_profile_pinned_version - Delete Connector Profile Pinned Version
• get_connector_profile_pinned_version - Get Connector Profile Pinned Version
• list_connector_profile_versions - List Connector Profile Versions
• list_connector_profiles - List Connector Profiles
• upsert_connector_profile_pinned_version - Upsert Connector Profile Pinned Version

Connectors

• get_connector_meta - Get Connector Meta Information (Legacy) ⚠️Deprecated
• list_connectors_meta - List Connector Meta Information (Legacy) ⚠️Deprecated

Crm

• create_contact - Create Contact
• get_account - Get Account
• get_contact - Get Contact
• get_contact_custom_field_definition - Get Contact Custom Field Definition
• get_list - Get List
• list_accounts - List Accounts
• list_contact_custom_field_definitions - List Contact Custom Field Definitions
• list_contacts - List Contacts
• list_lists - Get all Lists
• update_contact - Update Contact (early access)

Documents

• download_file - Download File
• get_drive - Get Drive
• get_file - Get File
• get_folder - Get Folder
• list_drives - List Drives
• list_files - List Files
• list_folders - List Folders
• upload_file - Upload File

Hris

• batch_upload_employee_document - Batch Upload Employee Document
• cancel_employee_time_off_request - Cancel Employee Time Off Request
• create_employee - Create Employee
• create_employee_employment - Create Employee Employment
• create_employee_skill - Create Employee Skill
• create_employee_time_off_request - Create Employee Time Off Request
• create_employee_work_eligibility_request - Create Employee Work Eligibility Request
• download_employee_document - Download Employee Document
• get_benefit - Get Benefit
• get_company - Get Company
• get_company_group - Get Company Group
• get_cost_center_group - Get Cost Center Group
• get_department_group - Get Department Group
• get_division_group - Get Division Group
• get_employee - Get Employee
• get_employee_custom_field_definition - Get employee Custom Field Definition
• get_employee_document - Get Employee Document
• get_employee_document_category - Get Employee Document Category
• get_employee_employment - Get Employee Employment
• get_employee_shift - Get Employee Shift
• get_employee_skill - Get Employee Skill
• get_employee_task - Get Employee Task
• get_employee_time_off_balance - Get Employee Time Off Balance
• 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_job - Get Job
• get_location - Get Work Location
• get_position - Get Position
• get_shift - Get Shift
• get_task - Get Task
• get_team_group - Get Team Group
• get_time_entries - Get Time Entry
• get_time_off_policy - Get Time Off Policy
• get_time_off_request - Get time off request
• get_time_off_type - Get time off type ⚠️Deprecated
• invite_employee - Invite Employee
• list_benefits - List benefits
• list_companies - List Companies
• list_companies_groups - List Companies Groups
• list_cost_center_groups - List Cost Center Groups
• list_department_groups - List Department Groups
• list_division_groups - List Division Groups
• list_employee_categories - List Employee Document Categories
• list_employee_custom_field_definitions - List employee Custom Field Definitions
• list_employee_documents - List Employee Documents
• list_employee_employments - List Employee Employments
• list_employee_shifts - List Employee Shifts
• list_employee_skills - List Employee Skills
• list_employee_tasks - List Employee Tasks
• list_employee_time_off_balances - List Employee Time Off Balances
• list_employee_time_off_policies - List Assigned Time Off Policies
• 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_jobs - List Jobs
• list_locations - List Work Locations
• list_positions - List Positions
• list_shifts - List Shifts
• list_tasks - List Tasks
• list_team_groups - List Team Groups
• list_time_entries - List Time Entries
• list_time_off_policies - List Time Off Policies
• list_time_off_requests - List time off requests
• list_time_off_types - List time off types ⚠️Deprecated
• update_employee - Update Employee
• update_employee_employment - Update Employee Employment
• update_employee_task - Update Employee Task
• update_employee_time_off_request - Update Employee Time Off Request
• update_employee_work_eligibility_request - Update Employee Work Eligibility Request
• upload_employee_document - Upload Employee Document

Iam

• delete_user - Delete User
• get_group - Get Group
• get_me - Get Me
• get_organization - Get Organization
• get_policy - Get Policy
• get_role - Get Role
• get_user - Get User
• list_groups - List Groups
• list_organizations - List Organizations
• list_policies - List Policies
• list_resource_types - List Resource Types
• list_resource_users - List Resource Users
• list_roles - List Roles
• list_users - List Users
• update_user - Update User

Lms

• batch_upsert_content - Batch Upsert External Linking Learning Objects
• create_user_assignment - Create User Assignment
• create_user_completion - Create User Completion
• delete_user_completion - Delete User Completion
• get_assignment - Get Assignment
• get_category - Get Category
• get_completion - Get Completion
• get_content - Get Content
• get_course - Get Course
• get_skill - Get Skill
• get_user - Get User
• get_user_assignment - Get User Assignment
• get_user_completion - Get User Completion
• list_assignments - List Assignments
• list_categories - List Categories
• list_completions - List Completions
• list_content - List Content
• list_courses - List Courses
• list_skills - List Skills
• list_user_assignments - List User Assignments
• list_user_completions - List User Completions
• list_users - List Users
• upsert_content - Upsert External Linking Learning Objects

Logs

• get_action_advanced_log - Get Action Advanced Log
• get_action_defender_log - Get Action Defender Log
• get_action_log - Get Action Log
• get_logs_stats_aggregate - Get Logs Stats Aggregate
• get_logs_stats_dimensions - Get Logs Stats Dimensions
• get_provider_advanced_log - Get Provider Advanced Log
• get_provider_log - Get Provider Log
• get_step_advanced_log - Get Step Advanced Log
• get_step_log - Get Step Log
• get_unified_advanced_log - Get Unified Advanced Log
• get_unified_log - Get Unified Log
• list_action_logs - List Action Logs
• list_action_step_logs - List Action Step Logs
• list_logs - List Logs
• list_provider_logs - List Provider Logs
• list_step_logs - List Step Logs
• list_unified_logs - List Unified Logs
• list_unified_provider_logs - List Unified Provider Logs

Marketing

• create_content_block - Create Content Block
• create_email_template - Create Email Templates
• create_in_app_template - Create In-App Template
• create_omni_channel_template - Create Omni-Channel Template ⚠️Deprecated
• create_push_template - Create Push Template
• create_sms_template - Create SMS Template
• get_campaign - Get campaign
• get_content_block - Get Content Blocks
• get_email_template - Get Email Templates
• get_in_app_template - Get In-App Template
• get_omni_channel_template - Get Omni-Channel Template ⚠️Deprecated
• get_push_template - Get Push Template
• get_sms_template - Get SMS Template
• list_campaigns - List campaigns
• list_content_blocks - List Content Blocks
• list_email_templates - List Email Templates
• list_in_app_templates - List In-App Templates
• list_omni_channel_templates - List Omni-Channel Templates ⚠️Deprecated
• list_push_templates - List Push Templates
• list_sms_templates - List SMS Templates
• update_content_block - Update Content Block
• update_email_template - Update Email Templates
• update_in_app_template - Update In-App Template
• update_omni_channel_template - Update Omni-Channel Template ⚠️Deprecated
• update_push_template - Update Push Template
• update_sms_template - Update SMS Template

Mcp

• mcp_delete - Delete MCP session
• mcp_get - Open MCP SSE stream
• mcp_post - Send MCP JSON-RPC message

Messaging

• create_conversation - Create Conversation
• download_messaging_attachment - Download Attachment
• get_attachment - Get Attachment
• get_conversation - Get Conversation
• get_message - Get Message
• get_user - Get User
• list_attachments - List Attachments
• list_conversation_messages - List Conversation Messages
• list_conversations - List Conversations
• list_users - List Users
• send_message - Send Message

Proxy

• proxy_request - Proxy Request (Legacy) ⚠️Deprecated

RequestLogs

• get_log - Get Log ⚠️Deprecated
• list_logs_legacy - List Logs ⚠️Deprecated
• list_platform_logs - List Platform Logs ⚠️Deprecated
• list_step_logs_legacy - List Step Logs ⚠️Deprecated

Screening

• create_screening_order - Create Screening Order
• get_screening_package - Get Screening Package
• list_screening_packages - List Screening Packages
• webhook_screening_result - Webhook Screening Result

Ticketing

• create_ticket - Create Ticket
• download_ticketing_attachment - Download Attachment
• get_attachment - Get Attachment
• get_comment - Get Comment
• get_project - Get Project
• get_project_component - Get Project Component
• get_ticket - Get Ticket
• get_ticket_type - Get Ticket Type
• get_user - Get User
• list_attachments - List Attachments
• list_comments - List Comments
• list_project_components - List Project Components
• list_project_ticket_types - List Project Ticket Types
• list_projects - List Projects
• list_ticket_statuses - List Ticket Statuses
• list_ticket_types - List Ticket Types
• list_tickets - List Tickets
• list_users - List Users
• update_ticket - Update Ticket

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:

require'stackone_client'Models= ::StackOne::Modelss= ::StackOne::StackOne.new(security: Models::Shared::Security.new(password: '',username: ''))res=s.accounts.delete_account(id: '<id>')unlessres.linked_account.nil?# handle responseend

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

require'stackone_client'Models= ::StackOne::Modelss= ::StackOne::StackOne.new(retry_config: Utils::RetryConfig.new(backoff: Utils::BackoffStrategy.new(exponent: 1.1,initial_interval: 1,max_elapsed_time: 100,max_interval: 50),retry_connection_errors: false,strategy: 'backoff'),security: Models::Shared::Security.new(password: '',username: ''))res=s.accounts.delete_account(id: '<id>')unlessres.linked_account.nil?# handle responseend

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error.

By default an API error will raise a Errors::APIError, which has the following properties:

Property	Type	Description
message	string	The error message
status_code	int	The HTTP status code
raw_response	Faraday::Response	The raw HTTP response
body	string	The response content

When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the delete_account method throws the following exceptions:

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	*/*

Example

require'stackone_client'Models= ::StackOne::Modelss= ::StackOne::StackOne.new(security: Models::Shared::Security.new(password: '',username: ''))beginres=s.accounts.delete_account(id: '<id>')unlessres.linked_account.nil?# handle responseendrescueModels::Errors::BadRequestResponse=>e# handle e.container dataraiseerescueModels::Errors::UnauthorizedResponse=>e# handle e.container dataraiseerescueModels::Errors::ForbiddenResponse=>e# handle e.container dataraiseerescueModels::Errors::NotFoundResponse=>e# handle e.container dataraiseerescueModels::Errors::RequestTimedOutResponse=>e# handle e.container dataraiseerescueModels::Errors::ConflictResponse=>e# handle e.container dataraiseerescueModels::Errors::UnprocessableEntityResponse=>e# handle e.container dataraiseerescueModels::Errors::TooManyRequestsResponse=>e# handle e.container dataraiseerescueModels::Errors::InternalServerErrorResponse=>e# handle e.container dataraiseerescueModels::Errors::NotImplementedResponse=>e# handle e.container dataraiseerescueModels::Errors::BadGatewayResponse=>e# handle e.container dataraiseerescueErrors::APIError=>e# handle default exceptionraiseeend

Server Selection

Override Server URL Per-Client

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

require'stackone_client'Models= ::StackOne::Modelss= ::StackOne::StackOne.new(server_url: 'https://api.stackone.com',security: Models::Shared::Security.new(password: '',username: ''))res=s.accounts.delete_account(id: '<id>')unlessres.linked_account.nil?# handle responseend

Development

Maturity

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.

Contributions

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!

SDK Created by Speakeasy