Dub.co Ruby SDK

Learn more about the Dub.co Ruby SDK in the official documentation.

Dub.co API: Dub is link management infrastructure for companies to create marketing campaigns, link sharing features, and referral programs.

• SDK Installation
• SDK Example Usage
• Available Resources and Operations
• Server Selection

The SDK can be installed using RubyGems:

gem install dub

require 'dub'


s = ::OpenApiSDK::Dub.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    token: "DUB_API_KEY",
  )
)


req = ::OpenApiSDK::Operations::CreateLinkRequestBody.new(
  url: "https://google.com",
  external_id: "123456",
  tag_ids: [
    "clux0rgak00011...",
  ],
)
    
res = s.links.create(req)

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

require 'dub'


s = ::OpenApiSDK::Dub.new
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    token: "DUB_API_KEY",
  )
)


req = ::OpenApiSDK::Operations::UpsertLinkRequestBody.new(
  url: "https://google.com",
  external_id: "123456",
  tag_ids: [
    "clux0rgak00011...",
  ],
)
    
res = s.links.upsert(req)

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

• retrieve - Retrieve analytics for a link, a domain, or the authenticated workspace.

• create - Create a domain
• list - Retrieve a list of domains
• update - Update a domain
• delete - Delete a domain

• list - Retrieve a list of events

• create - Create a new link
• list - Retrieve a list of links
• count - Retrieve links count
• get - Retrieve a link
• update - Update a link
• delete - Delete a link
• create_many - Bulk create links
• update_many - Bulk update links
• delete_many - Bulk delete links
• upsert - Upsert a link

• get - Retrieve the metatags for a URL

• get - Retrieve a QR code

• create - Create a new tag
• list - Retrieve a list of tags
• update - Update a tag
• delete - Delete a tag

• lead - Track a lead
• sale - Track a sale
• customer - Track a customer

• get - Retrieve a workspace
• update - Update a workspace

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:

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!