Skip to main content

Ruby Client

We maintain a ruby client here

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation​

bundle add katapult-ruby

Getting Started​

# Load the gem
require 'katapult-ruby'

# Setup authorization
KatapultAPI.configure do |config|
  # Configure Bearer authorization: Authenticator
  config.access_token = 'YOUR_BEARER_TOKEN'
  # Configure a proc to get access tokens in lieu of the static access_token configuration
  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
end

api_instance = KatapultAPI::CoreApi.new
opts = {
  delete_address_list_request: KatapultAPI::DeleteAddressListRequest.new({address_list: KatapultAPI::AddressListLookup.new}) # DeleteAddressListRequest | 
}

begin
  result = api_instance.delete_address_list(opts)
  p result
rescue KatapultAPI::ApiError => e
  puts "Exception when calling CoreApi->delete_address_list: #{e}"
end