Developer-friendly & type-safe Ruby SDK specifically catered to leverage openapi API.

• openapi
  • SDK Installation
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Global Parameters
  • Error Handling
  • Server Selection
• Development
  • Maturity
  • Contributions

The SDK can be installed using RubyGems:

gem install kombo

require 'kombo'

Models = ::OpenApiSDK::Models
s = ::OpenApiSDK::Kombo.new(
      security: Models::Shared::Security.new(
        api_key: '<YOUR_BEARER_TOKEN_HERE>',
      ),
    )

res = s.general.check_api_key()

unless res.get_check_api_key_positive_response.nil?
  # handle response
end

This SDK supports the following security scheme globally:

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

require 'kombo'

Models = ::OpenApiSDK::Models
s = ::OpenApiSDK::Kombo.new(
      security: Models::Shared::Security.new(
        api_key: '<YOUR_BEARER_TOKEN_HERE>',
      ),
    )

res = s.general.check_api_key()

unless res.get_check_api_key_positive_response.nil?
  # handle response
end

• get_packages - Get packages
• set_packages - Set packages
• get_open_orders - Get open orders
• update_order_result - Update order result

• get_applications - Get applications
• move_application_to_stage - Move application to stage
• add_application_result_link - Add result link to application
• add_application_note - Add note to application
• get_application_attachments - Get application attachments
• add_application_attachment - Add attachment to application
• reject_application - Reject application
• get_candidates - Get candidates
• create_candidate - Create candidate
• get_candidate_attachments - Get candidate attachments
• add_candidate_attachment - Add attachment to candidate
• add_candidate_result_link - Add result link to candidate
• add_candidate_tag - Add tag to candidate
• remove_candidate_tag - Remove tag from candidate
• get_tags - Get tags
• get_application_stages - Get application stages
• get_jobs - Get jobs
• create_application - Create application
• get_users - Get users
• get_offers - Get offers
• get_rejection_reasons - Get rejection reasons
• get_interviews - Get interviews
• import_tracked_application - Import tracked application

• create_connection_link - Create connection link
• get_integration_by_token - Get integration by token

• check_api_key - Check API key
• trigger_sync - Trigger sync
• send_passthrough_request - Send passthrough request
• delete_integration - Delete integration
• get_integration_details - Get integration details
• set_integration_enabled - Set integration enabled
• create_reconnection_link - Create reconnection link
• get_integration_fields - Get integration fields
• update_integration_field - Updates an integration fields passthrough setting
• get_custom_fields - Get custom fields with current mappings
• update_custom_field_mapping - Put custom field mappings
• get_tools - Get tools

• get_employees - Get employees
• get_employee_form - Get employee form
• create_employee_with_form - Create employee with form
• add_employee_document - Add document to employee
• get_employee_document_categories - Get employee document categories
• get_groups - Get groups
• get_employments - Get employments
• get_locations - Get work locations
• get_absence_types - Get absence types
• get_time_off_balances - Get time off balances
• get_absences - Get absences
• create_absence - Create absence
• delete_absence - Delete absence
• get_legal_entities - Get legal entities
• get_timesheets - Get timesheets
• get_performance_review_cycles - Get performance review cycles
• get_performance_reviews - Get performance reviews

A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.

For example, you can set integration_id to 'workday:HWUTwvyx2wLoSUHphiWVrp28' at SDK initialization and then you do not have to pass the same value on calls to operations like delete_integration. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.

The following global parameter is available.

require 'kombo'

Models = ::OpenApiSDK::Models
s = ::OpenApiSDK::Kombo.new(
      integration_id: 'workday:HWUTwvyx2wLoSUHphiWVrp28',
      security: Models::Shared::Security.new(
        api_key: '<YOUR_BEARER_TOKEN_HERE>',
      ),
    )

res = s.general.delete_integration(integration_id: '<id>', body: Models::Shared::DeleteIntegrationsIntegrationIdRequestBody.new())

unless res.delete_integrations_integration_id_positive_response.nil?
  # handle response
end

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:

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 check_api_key method throws the following exceptions:

require 'kombo'

Models = ::OpenApiSDK::Models
s = ::OpenApiSDK::Kombo.new(
      security: Models::Shared::Security.new(
        api_key: '<YOUR_BEARER_TOKEN_HERE>',
      ),
    )

begin
    res = s.general.check_api_key()

    unless res.get_check_api_key_positive_response.nil?
      # handle response
    end
rescue Models::Errors::KomboGeneralError => e
  # handle e.container data
  raise e
rescue Errors::APIError => e
  # handle default exception
  raise e
end

You can override the default server globally by passing a server name to the server (Symbol) 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 names associated with the available servers:

require 'kombo'

Models = ::OpenApiSDK::Models
s = ::OpenApiSDK::Kombo.new(
      server: "eu",
      security: Models::Shared::Security.new(
        api_key: '<YOUR_BEARER_TOKEN_HERE>',
      ),
    )

res = s.general.check_api_key()

unless res.get_check_api_key_positive_response.nil?
  # handle response
end

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

require 'kombo'

Models = ::OpenApiSDK::Models
s = ::OpenApiSDK::Kombo.new(
      server_url: 'https://api.kombo.dev/v1',
      security: Models::Shared::Security.new(
        api_key: '<YOUR_BEARER_TOKEN_HERE>',
      ),
    )

res = s.general.check_api_key()

unless res.get_check_api_key_positive_response.nil?
  # handle response
end

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. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.