README.md

Unified

(unified)

Overview

Available Operations

• 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_issues - List support issues
• list_unified_webhooks - Returns all registered webhooks
• patch_unified_connection - Update connection
• patch_unified_webhook - Update webhook subscription
• 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 - Update webhook subscription
• update_unified_webhook_trigger - Trigger webhook

create_unified_connection

Used only to import existing customer credentials; use "Create connection indirectly" instead

Example Usage

require 'unified_ruby_sdk'


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


req = ::UnifiedRubySDK::Shared::Connection.new(
  categories: [
    ::UnifiedRubySDK::Shared::PropertyConnectionCategories::REPO,
  ],
  integration_type: "<value>",
  permissions: [
    ::UnifiedRubySDK::Shared::PropertyConnectionPermissions::CRM_LEAD_READ,
  ],
)
    
res = s.unified.create_unified_connection(req)

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

Parameters

Parameter	Type	Required	Description
request	::UnifiedRubySDK::Shared::Connection	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::CreateUnifiedConnectionResponse)

create_unified_webhook

The data payload received by your server is described at https://docs.unified.to/unified/overview. The interval field can be set as low as 1 minute for paid accounts, and 60 minutes for free accounts.

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.unified.create_unified_webhook(webhook=::UnifiedRubySDK::Shared::Webhook.new(
  connection_id: "<id>",
  event: ::UnifiedRubySDK::Shared::Event::CREATED,
  hook_url: "https://blind-platypus.org/",
  object_type: ::UnifiedRubySDK::Shared::ObjectType::CRM_DEAL,
), include_all=false)

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

Parameters

Parameter	Type	Required	Description
webhook	T.nilable(::UnifiedRubySDK::Shared::Webhook)	➖	A webhook is used to POST new/updated information to your server.
include_all	T.nilable(T::Boolean)	➖	When set, all of the existing data will sent back to your server.

Response

T.nilable(::UnifiedRubySDK::Operations::CreateUnifiedWebhookResponse)

get_unified_apicall

Retrieve specific API Call by its ID

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.unified.get_unified_apicall(id="<id>")

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

Parameters

Parameter	Type	Required	Description
id	::String	✔️	ID of the Apicall

Response

T.nilable(::UnifiedRubySDK::Operations::GetUnifiedApicallResponse)

get_unified_connection

Retrieve connection

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.unified.get_unified_connection(id="<id>")

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

Parameters

Parameter	Type	Required	Description
id	::String	✔️	ID of the Connection

Response

T.nilable(::UnifiedRubySDK::Operations::GetUnifiedConnectionResponse)

get_unified_integration_auth

Returns an authorization URL for the specified integration. Once a successful authorization occurs, a new connection is created.

Example Usage

require 'unified_ruby_sdk'


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


req = ::UnifiedRubySDK::Operations::GetUnifiedIntegrationAuthRequest.new(
  integration_type: "<value>",
  workspace_id: "<id>",
)
    
res = s.unified.get_unified_integration_auth(req)

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

Parameters

Parameter	Type	Required	Description
request	::UnifiedRubySDK::Operations::GetUnifiedIntegrationAuthRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::GetUnifiedIntegrationAuthResponse)

get_unified_webhook

Retrieve webhook by its ID

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.unified.get_unified_webhook(id="<id>")

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

Parameters

Parameter	Type	Required	Description
id	::String	✔️	ID of the Webhook

Response

T.nilable(::UnifiedRubySDK::Operations::GetUnifiedWebhookResponse)

list_unified_apicalls

Returns API Calls

Example Usage

require 'unified_ruby_sdk'


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


req = ::UnifiedRubySDK::Operations::ListUnifiedApicallsRequest.new()
    
res = s.unified.list_unified_apicalls(req)

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

Parameters

Parameter	Type	Required	Description
request	::UnifiedRubySDK::Operations::ListUnifiedApicallsRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListUnifiedApicallsResponse)

list_unified_connections

List all connections

Example Usage

require 'unified_ruby_sdk'


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


req = ::UnifiedRubySDK::Operations::ListUnifiedConnectionsRequest.new()
    
res = s.unified.list_unified_connections(req)

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

Parameters

Parameter	Type	Required	Description
request	::UnifiedRubySDK::Operations::ListUnifiedConnectionsRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListUnifiedConnectionsResponse)

list_unified_integration_workspaces

No authentication required as this is to be used by front-end interface

Example Usage

require 'unified_ruby_sdk'


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


req = ::UnifiedRubySDK::Operations::ListUnifiedIntegrationWorkspacesRequest.new(
  workspace_id: "<id>",
)
    
res = s.unified.list_unified_integration_workspaces(req)

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

Parameters

Parameter	Type	Required	Description
request	::UnifiedRubySDK::Operations::ListUnifiedIntegrationWorkspacesRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListUnifiedIntegrationWorkspacesResponse)

list_unified_integrations

Returns all integrations

Example Usage

require 'unified_ruby_sdk'


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


req = ::UnifiedRubySDK::Operations::ListUnifiedIntegrationsRequest.new()
    
res = s.unified.list_unified_integrations(req)

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

Parameters

Parameter	Type	Required	Description
request	::UnifiedRubySDK::Operations::ListUnifiedIntegrationsRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListUnifiedIntegrationsResponse)

list_unified_issues

List support issues

Example Usage

require 'unified_ruby_sdk'


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


req = ::UnifiedRubySDK::Operations::ListUnifiedIssuesRequest.new()
    
res = s.unified.list_unified_issues(req)

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

Parameters

Parameter	Type	Required	Description
request	::UnifiedRubySDK::Operations::ListUnifiedIssuesRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListUnifiedIssuesResponse)

list_unified_webhooks

Returns all registered webhooks

Example Usage

require 'unified_ruby_sdk'


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


req = ::UnifiedRubySDK::Operations::ListUnifiedWebhooksRequest.new()
    
res = s.unified.list_unified_webhooks(req)

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

Parameters

Parameter	Type	Required	Description
request	::UnifiedRubySDK::Operations::ListUnifiedWebhooksRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListUnifiedWebhooksResponse)

patch_unified_connection

Update connection

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.unified.patch_unified_connection(id="<id>", connection=::UnifiedRubySDK::Shared::Connection.new(
  categories: [
    ::UnifiedRubySDK::Shared::PropertyConnectionCategories::GENAI,
  ],
  integration_type: "<value>",
  permissions: [
    ::UnifiedRubySDK::Shared::PropertyConnectionPermissions::METADATA_METADATA_WRITE,
  ],
))

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

Parameters

Parameter	Type	Required	Description
id	::String	✔️	ID of the Connection
connection	T.nilable(::UnifiedRubySDK::Shared::Connection)	➖	A connection represents a specific authentication of an integration.

Response

T.nilable(::UnifiedRubySDK::Operations::PatchUnifiedConnectionResponse)

patch_unified_webhook

Update webhook subscription

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.unified.patch_unified_webhook(id="<id>", webhook=::UnifiedRubySDK::Shared::Webhook.new(
  connection_id: "<id>",
  event: ::UnifiedRubySDK::Shared::Event::DELETED,
  hook_url: "https://calculating-habit.name/",
  object_type: ::UnifiedRubySDK::Shared::ObjectType::COMMERCE_COLLECTION,
))

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

Parameters

Parameter	Type	Required	Description
id	::String	✔️	ID of the Webhook
webhook	T.nilable(::UnifiedRubySDK::Shared::Webhook)	➖	A webhook is used to POST new/updated information to your server.

Response

T.nilable(::UnifiedRubySDK::Operations::PatchUnifiedWebhookResponse)

patch_unified_webhook_trigger

Trigger webhook

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.unified.patch_unified_webhook_trigger(id="<id>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
id	::String	✔️	ID of the Webhook

Response

T.nilable(::UnifiedRubySDK::Operations::PatchUnifiedWebhookTriggerResponse)

remove_unified_connection

Remove connection

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.unified.remove_unified_connection(id="<id>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
id	::String	✔️	ID of the Connection

Response

T.nilable(::UnifiedRubySDK::Operations::RemoveUnifiedConnectionResponse)

remove_unified_webhook

Remove webhook subscription

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.unified.remove_unified_webhook(id="<id>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
id	::String	✔️	ID of the Webhook

Response

T.nilable(::UnifiedRubySDK::Operations::RemoveUnifiedWebhookResponse)

update_unified_connection

Update connection

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.unified.update_unified_connection(id="<id>", connection=::UnifiedRubySDK::Shared::Connection.new(
  categories: [
    ::UnifiedRubySDK::Shared::PropertyConnectionCategories::TASK,
  ],
  integration_type: "<value>",
  permissions: [
    ::UnifiedRubySDK::Shared::PropertyConnectionPermissions::REPO_PULLREQUEST_WRITE,
  ],
))

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

Parameters

Parameter	Type	Required	Description
id	::String	✔️	ID of the Connection
connection	T.nilable(::UnifiedRubySDK::Shared::Connection)	➖	A connection represents a specific authentication of an integration.

Response

T.nilable(::UnifiedRubySDK::Operations::UpdateUnifiedConnectionResponse)

update_unified_webhook

Update webhook subscription

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.unified.update_unified_webhook(id="<id>", webhook=::UnifiedRubySDK::Shared::Webhook.new(
  connection_id: "<id>",
  event: ::UnifiedRubySDK::Shared::Event::CREATED,
  hook_url: "https://glaring-postbox.info/",
  object_type: ::UnifiedRubySDK::Shared::ObjectType::LMS_COURSE,
))

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

Parameters

Parameter	Type	Required	Description
id	::String	✔️	ID of the Webhook
webhook	T.nilable(::UnifiedRubySDK::Shared::Webhook)	➖	A webhook is used to POST new/updated information to your server.

Response

T.nilable(::UnifiedRubySDK::Operations::UpdateUnifiedWebhookResponse)

update_unified_webhook_trigger

Trigger webhook

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.unified.update_unified_webhook_trigger(id="<id>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
id	::String	✔️	ID of the Webhook

Response

T.nilable(::UnifiedRubySDK::Operations::UpdateUnifiedWebhookTriggerResponse)