Terminal Ruby API library

The Terminal Ruby library provides convenient access to the Terminal REST API from any Ruby 3.0.0+ application.

It is generated with Stainless.

Documentation for released of this gem can be found on RubyDoc.

The underlying REST API documentation can be found on terminal.shop.

To use this gem during the beta, install directly from GitHub with Bundler by adding the following to your application's Gemfile:

gem "terminal-shop", git: "https://github.com/terminaldotshop/terminal-sdk-ruby", branch: "main"

To fetch an initial copy of the gem:

bundle install

To update the version used by your application when updates are pushed to GitHub:

bundle update terminal-shop

require "bundler/setup"
require "terminal-shop"

terminal = TerminalShop::Client.new(
  bearer_token: "My Bearer Token", # defaults to ENV["TERMINAL_BEARER_TOKEN"]
  environment: "dev" # defaults to "production"
)

product = terminal.product.list

puts(product.data)

When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of TerminalShop::Error will be thrown:

begin
  product = terminal.product.list
rescue TerminalShop::Error => e
  puts(e.status) # 400
end

Error codes are as followed:

Certain errors will be automatically retried 2 times by default, with a short exponential backoff.

Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.

You can use the max_retries option to configure or disable this:

# Configure the default for all requests:
terminal = TerminalShop::Client.new(
  max_retries: 0 # default is 2
)

# Or, configure per-request:
terminal.product.list(request_options: {max_retries: 5})

By default, requests will time out after 60 seconds.

Timeouts are applied separately to the initial connection and the overall request time, so in some cases a request could wait 2*timeout seconds before it fails.

You can use the timeout option to configure or disable this:

# Configure the default for all requests:
terminal = TerminalShop::Client.new(
  timeout: nil # default is 60
)

# Or, configure per-request:
terminal.product.list(request_options: {timeout: 5})

This library is written with Sorbet type definitions. However, there is no runtime dependency on the sorbet-runtime.

What this means is that while you can use Sorbet to type check your code statically, and benefit from the Sorbet Language Server in your editor, there is no runtime type checking and execution overhead from Sorbet itself.

Due to limitations with the Sorbet type system, where a method otherwise can take an instance of TerminalShop::BaseModel class, you will need to use the ** splat operator to pass the arguments:

Please follow Sorbet's setup guides for best experience.

model = ProductListParams.new

terminal.product.list(**model)

This package follows SemVer conventions. As the library is in initial development and has a major version of 0, APIs may change at any time.

This package considers improvements to the (non-runtime) *.rbi and *.rbs type definitions to be non-breaking changes.

Ruby 3.0.0 or higher.