SDK Installation

gem install specific_install
gem specific_install https://github.com/unified-to/unified-ruby-sdk 

SDK Example Usage

Example

require_relative unified_ruby_sdk


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  security=Shared::Security.new(
    jwt="<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.create_accounting_account(connection_id="string", accounting_account=Shared::AccountingAccount.new(
    name="string",
    raw={
      "Executive": "string",
    },
  ))

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

Available Resources and Operations

Accounting

• create_accounting_account - Create an account
• create_accounting_contact - Create a contact
• create_accounting_invoice - Create a invoice
• create_accounting_item - Create an item
• create_accounting_payment - Create a payment
• create_accounting_taxrate - Create a taxrate
• create_accounting_transaction - Create a transaction
• get_accounting_account - Retrieve an account
• get_accounting_contact - Retrieve a contact
• get_accounting_invoice - Retrieve a invoice
• get_accounting_item - Retrieve an item
• get_accounting_organization - Retrieve an organization
• get_accounting_payment - Retrieve a payment
• get_accounting_taxrate - Retrieve a taxrate
• get_accounting_transaction - Retrieve a transaction
• list_accounting_accounts - List all accounts
• list_accounting_contacts - List all contacts
• list_accounting_invoices - List all invoices
• list_accounting_items - List all items
• list_accounting_organizations - List all organizations
• list_accounting_payments - List all payments
• list_accounting_taxrates - List all taxrates
• list_accounting_transactions - List all transactions
• patch_accounting_account - Update an account
• patch_accounting_contact - Update a contact
• patch_accounting_invoice - Update a invoice
• patch_accounting_item - Update an item
• patch_accounting_payment - Update a payment
• patch_accounting_taxrate - Update a taxrate
• patch_accounting_transaction - Update a transaction
• remove_accounting_account - Remove an account
• remove_accounting_contact - Remove a contact
• remove_accounting_invoice - Remove a invoice
• remove_accounting_item - Remove an item
• remove_accounting_payment - Remove a payment
• remove_accounting_taxrate - Remove a taxrate
• remove_accounting_transaction - Remove a transaction
• update_accounting_account - Update an account
• update_accounting_contact - Update a contact
• update_accounting_invoice - Update a invoice
• update_accounting_item - Update an item
• update_accounting_payment - Update a payment
• update_accounting_taxrate - Update a taxrate
• update_accounting_transaction - Update a transaction

Account

• create_accounting_account - Create an account
• get_accounting_account - Retrieve an account
• list_accounting_accounts - List all accounts
• patch_accounting_account - Update an account
• remove_accounting_account - Remove an account
• update_accounting_account - Update an account

Contact

• create_accounting_contact - Create a contact
• create_crm_contact - Create a contact
• create_uc_contact - Create a contact
• get_accounting_contact - Retrieve a contact
• get_crm_contact - Retrieve a contact
• get_uc_contact - Retrieve a contact
• list_accounting_contacts - List all contacts
• list_crm_contacts - List all contacts
• list_uc_contacts - List all contacts
• patch_accounting_contact - Update a contact
• patch_crm_contact - Update a contact
• patch_uc_contact - Update a contact
• remove_accounting_contact - Remove a contact
• remove_crm_contact - Remove a contact
• remove_uc_contact - Remove a contact
• update_accounting_contact - Update a contact
• update_crm_contact - Update a contact
• update_uc_contact - Update a contact

Invoice

• create_accounting_invoice - Create a invoice
• get_accounting_invoice - Retrieve a invoice
• list_accounting_invoices - List all invoices
• patch_accounting_invoice - Update a invoice
• remove_accounting_invoice - Remove a invoice
• update_accounting_invoice - Update a invoice

Item

• create_accounting_item - Create an item
• get_accounting_item - Retrieve an item
• list_accounting_items - List all items
• patch_accounting_item - Update an item
• remove_accounting_item - Remove an item
• update_accounting_item - Update an item

Organization

• get_accounting_organization - Retrieve an organization
• list_accounting_organizations - List all organizations

Payment

• create_accounting_payment - Create a payment
• get_accounting_payment - Retrieve a payment
• list_accounting_payments - List all payments
• patch_accounting_payment - Update a payment
• remove_accounting_payment - Remove a payment
• update_accounting_payment - Update a payment

Taxrate

• create_accounting_taxrate - Create a taxrate
• get_accounting_taxrate - Retrieve a taxrate
• list_accounting_taxrates - List all taxrates
• patch_accounting_taxrate - Update a taxrate
• remove_accounting_taxrate - Remove a taxrate
• update_accounting_taxrate - Update a taxrate

Transaction

• create_accounting_transaction - Create a transaction
• get_accounting_transaction - Retrieve a transaction
• list_accounting_transactions - List all transactions
• patch_accounting_transaction - Update a transaction
• remove_accounting_transaction - Remove a transaction
• update_accounting_transaction - Update a transaction

Ats

• create_ats_application - Create an application
• create_ats_candidate - Create a candidate
• create_ats_document - Create a document
• create_ats_interview - Create a interview
• create_ats_job - Create a job
• create_ats_scorecard - Create a scorecard
• get_ats_application - Retrieve an application
• get_ats_candidate - Retrieve a candidate
• get_ats_document - Retrieve a document
• get_ats_interview - Retrieve a interview
• get_ats_job - Retrieve a job
• get_ats_scorecard - Retrieve a scorecard
• list_ats_applications - List all applications
• list_ats_applicationstatuses - List all application statuses
• list_ats_candidates - List all candidates
• list_ats_documents - List all documents
• list_ats_interviews - List all interviews
• list_ats_jobs - List all jobs
• list_ats_scorecards - List all scorecards
• patch_ats_application - Update an application
• patch_ats_candidate - Update a candidate
• patch_ats_document - Update a document
• patch_ats_interview - Update a interview
• patch_ats_job - Update a job
• patch_ats_scorecard - Update a scorecard
• remove_ats_application - Remove an application
• remove_ats_candidate - Remove a candidate
• remove_ats_document - Remove a document
• remove_ats_interview - Remove a interview
• remove_ats_job - Remove a job
• remove_ats_scorecard - Remove a scorecard
• update_ats_application - Update an application
• update_ats_candidate - Update a candidate
• update_ats_document - Update a document
• update_ats_interview - Update a interview
• update_ats_job - Update a job
• update_ats_scorecard - Update a scorecard

Application

• create_ats_application - Create an application
• get_ats_application - Retrieve an application
• list_ats_applications - List all applications
• patch_ats_application - Update an application
• remove_ats_application - Remove an application
• update_ats_application - Update an application

Applicationstatus

• list_ats_applicationstatuses - List all application statuses

Candidate

• create_ats_candidate - Create a candidate
• get_ats_candidate - Retrieve a candidate
• list_ats_candidates - List all candidates
• patch_ats_candidate - Update a candidate
• remove_ats_candidate - Remove a candidate
• update_ats_candidate - Update a candidate

Document

• create_ats_document - Create a document
• get_ats_document - Retrieve a document
• list_ats_documents - List all documents
• patch_ats_document - Update a document
• remove_ats_document - Remove a document
• update_ats_document - Update a document

Interview

• create_ats_interview - Create a interview
• get_ats_interview - Retrieve a interview
• list_ats_interviews - List all interviews
• patch_ats_interview - Update a interview
• remove_ats_interview - Remove a interview
• update_ats_interview - Update a interview

Job

• create_ats_job - Create a job
• get_ats_job - Retrieve a job
• list_ats_jobs - List all jobs
• patch_ats_job - Update a job
• remove_ats_job - Remove a job
• update_ats_job - Update a job

Scorecard

• create_ats_scorecard - Create a scorecard
• get_ats_scorecard - Retrieve a scorecard
• list_ats_scorecards - List all scorecards
• patch_ats_scorecard - Update a scorecard
• remove_ats_scorecard - Remove a scorecard
• update_ats_scorecard - Update a scorecard

Crm

• create_crm_company - Create a company
• create_crm_contact - Create a contact
• create_crm_deal - Create a deal
• create_crm_event - Create a event
• create_crm_lead - Create a lead
• create_crm_pipeline - Create a pipeline
• get_crm_company - Retrieve a company
• get_crm_contact - Retrieve a contact
• get_crm_deal - Retrieve a deal
• get_crm_event - Retrieve a event
• get_crm_lead - Retrieve a lead
• get_crm_pipeline - Retrieve a pipeline
• list_crm_companies - List all companies
• list_crm_contacts - List all contacts
• list_crm_deals - List all deals
• list_crm_events - List all events
• list_crm_leads - List all leads
• list_crm_pipelines - List all pipelines
• patch_crm_company - Update a company
• patch_crm_contact - Update a contact
• patch_crm_deal - Update a deal
• patch_crm_event - Update a event
• patch_crm_lead - Update a lead
• patch_crm_pipeline - Update a pipeline
• remove_crm_company - Remove a company
• remove_crm_contact - Remove a contact
• remove_crm_deal - Remove a deal
• remove_crm_event - Remove a event
• remove_crm_lead - Remove a lead
• remove_crm_pipeline - Remove a pipeline
• update_crm_company - Update a company
• update_crm_contact - Update a contact
• update_crm_deal - Update a deal
• update_crm_event - Update a event
• update_crm_lead - Update a lead
• update_crm_pipeline - Update a pipeline

Company

• create_crm_company - Create a company
• get_crm_company - Retrieve a company
• list_crm_companies - List all companies
• list_enrich_companies - Retrieve enrichment information for a company
• patch_crm_company - Update a company
• remove_crm_company - Remove a company
• update_crm_company - Update a company

Deal

• create_crm_deal - Create a deal
• get_crm_deal - Retrieve a deal
• list_crm_deals - List all deals
• patch_crm_deal - Update a deal
• remove_crm_deal - Remove a deal
• update_crm_deal - Update a deal

Event

• create_crm_event - Create a event
• get_crm_event - Retrieve a event
• list_crm_events - List all events
• patch_crm_event - Update a event
• remove_crm_event - Remove a event
• update_crm_event - Update a event

Lead

• create_crm_lead - Create a lead
• get_crm_lead - Retrieve a lead
• list_crm_leads - List all leads
• patch_crm_lead - Update a lead
• remove_crm_lead - Remove a lead
• update_crm_lead - Update a lead

Pipeline

• create_crm_pipeline - Create a pipeline
• get_crm_pipeline - Retrieve a pipeline
• list_crm_pipelines - List all pipelines
• patch_crm_pipeline - Update a pipeline
• remove_crm_pipeline - Remove a pipeline
• update_crm_pipeline - Update a pipeline

Enrich

• list_enrich_companies - Retrieve enrichment information for a company
• list_enrich_people - Retrieve enrichment information for a person

Person

• list_enrich_people - Retrieve enrichment information for a person

Hris

• create_hris_employee - Create an employee
• create_hris_group - Create a group
• get_hris_employee - Retrieve an employee
• get_hris_group - Retrieve a group
• list_hris_employees - List all employees
• list_hris_groups - List all groups
• patch_hris_employee - Update an employee
• patch_hris_group - Update a group
• remove_hris_employee - Remove an employee
• remove_hris_group - Remove a group
• update_hris_employee - Update an employee
• update_hris_group - Update a group

Employee

• create_hris_employee - Create an employee
• get_hris_employee - Retrieve an employee
• list_hris_employees - List all employees
• patch_hris_employee - Update an employee
• remove_hris_employee - Remove an employee
• update_hris_employee - Update an employee

Group

• create_hris_group - Create a group
• get_hris_group - Retrieve a group
• list_hris_groups - List all groups
• patch_hris_group - Update a group
• remove_hris_group - Remove a group
• update_hris_group - Update a group

Martech

• create_martech_list - Create a list
• create_martech_member - Create a member
• get_martech_list - Retrieve a list
• get_martech_member - Retrieve a member
• list_martech_lists - List all lists
• list_martech_members - List all members
• patch_martech_list - Update a list
• patch_martech_member - Update a member
• remove_martech_list - Remove a list
• remove_martech_member - Remove member
• update_martech_list - Update a list
• update_martech_member - Update a member

List

• create_martech_list - Create a list
• get_martech_list - Retrieve a list
• list_martech_lists - List all lists
• patch_martech_list - Update a list
• remove_martech_list - Remove a list
• update_martech_list - Update a list

Member

• create_martech_member - Create a member
• get_martech_member - Retrieve a member
• list_martech_members - List all members
• patch_martech_member - Update a member
• remove_martech_member - Remove member
• update_martech_member - Update a member

Passthrough

• create_passthrough - Passthrough POST
• list_passthroughs - Passthrough GET
• patch_passthrough - Passthrough PUT
• remove_passthrough - Passthrough DELETE
• update_passthrough - Passthrough PUT

Storage

• create_storage_file - Create a file
• get_storage_file - Retrieve a file
• list_storage_files - List all files
• patch_storage_file - Update a file
• remove_storage_file - Remove a file
• update_storage_file - Update a file

File

• create_storage_file - Create a file
• get_storage_file - Retrieve a file
• list_storage_files - List all files
• patch_storage_file - Update a file
• remove_storage_file - Remove a file
• update_storage_file - Update a file

Ticketing

• create_ticketing_customer - Create a customer
• create_ticketing_note - Create a note
• create_ticketing_ticket - Create a ticket
• get_ticketing_customer - Retrieve a customer
• get_ticketing_note - Retrieve a note
• get_ticketing_ticket - Retrieve a ticket
• list_ticketing_customers - List all customers
• list_ticketing_notes - List all notes
• list_ticketing_tickets - List all tickets
• patch_ticketing_customer - Update a customer
• patch_ticketing_note - Update a note
• patch_ticketing_ticket - Update a ticket
• remove_ticketing_customer - Remove a customer
• remove_ticketing_note - Remove a note
• remove_ticketing_ticket - Remove a ticket
• update_ticketing_customer - Update a customer
• update_ticketing_note - Update a note
• update_ticketing_ticket - Update a ticket

Customer

• create_ticketing_customer - Create a customer
• get_ticketing_customer - Retrieve a customer
• list_ticketing_customers - List all customers
• patch_ticketing_customer - Update a customer
• remove_ticketing_customer - Remove a customer
• update_ticketing_customer - Update a customer

Note

• create_ticketing_note - Create a note
• get_ticketing_note - Retrieve a note
• list_ticketing_notes - List all notes
• patch_ticketing_note - Update a note
• remove_ticketing_note - Remove a note
• update_ticketing_note - Update a note

Ticket

• create_ticketing_ticket - Create a ticket
• get_ticketing_ticket - Retrieve a ticket
• list_ticketing_tickets - List all tickets
• patch_ticketing_ticket - Update a ticket
• remove_ticketing_ticket - Remove a ticket
• update_ticketing_ticket - Update a ticket

Uc

• create_uc_contact - Create a contact
• get_uc_contact - Retrieve a contact
• list_uc_calls - List all calls
• list_uc_contacts - List all contacts
• patch_uc_contact - Update a contact
• remove_uc_contact - Remove a contact
• update_uc_contact - Update a contact

Call

• list_uc_calls - List all calls

Unified

• create_unified_connection - Create connection
• create_unified_webhook - Create webhook subscription
• get_unified_apicall - Retrieve specific API Call by its ID
• get_unified_connection - Retrieve connection
• get_unified_integration_auth - Create connection indirectly
• get_unified_webhook - Retrieve webhook by its ID
• list_unified_apicalls - Returns API Calls
• list_unified_connections - List all connections
• list_unified_integration_workspaces - Returns all activated integrations in a workspace
• list_unified_integrations - Returns all integrations
• list_unified_webhooks - Returns all registered webhooks
• patch_unified_connection - Update connection
• patch_unified_webhook_trigger - Trigger webhook
• remove_unified_connection - Remove connection
• remove_unified_webhook - Remove webhook subscription
• update_unified_connection - Update connection
• update_unified_webhook_trigger - Trigger webhook

Apicall

• get_unified_apicall - Retrieve specific API Call by its ID
• list_unified_apicalls - Returns API Calls

Connection

• create_unified_connection - Create connection
• get_unified_connection - Retrieve connection
• list_unified_connections - List all connections
• patch_unified_connection - Update connection
• remove_unified_connection - Remove connection
• update_unified_connection - Update connection

Integration

• get_unified_integration_auth - Create connection indirectly
• list_unified_integration_workspaces - Returns all activated integrations in a workspace
• list_unified_integrations - Returns all integrations

Auth

• get_unified_integration_auth - Create connection indirectly
• get_unified_integration_login - Sign in a user

Login

• get_unified_integration_login - Sign in a user

Webhook

• create_unified_webhook - Create webhook subscription
• get_unified_webhook - Retrieve webhook by its ID
• list_unified_webhooks - Returns all registered webhooks
• patch_unified_webhook_trigger - Trigger webhook
• remove_unified_webhook - Remove webhook subscription
• update_unified_webhook_trigger - Trigger webhook

Server Selection

Server Selection

Select Server by Index

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:

#	Server	Variables
0	https://api.unified.to	None
1	https://api-eu.unified.to	None

Override Server URL Per-Client

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:

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