Class: PostmarkClient::Client::Base Abstract

Inherits:

Object

• Object
• PostmarkClient::Client::Base

Defined in:

lib/postmark_client/client/base.rb

Overview

This class is abstract.

Subclass and implement specific API resource methods

Base client class for all Postmark API interactions. Provides common HTTP functionality using Faraday.

Examples:

Creating a custom resource client

class MyResource < PostmarkClient::Client::Base
  def fetch(id)
    get("/my-resource/#{id}")
  end
end

Direct Known Subclasses

Resources::Emails

Constant Summary

API_BASE_URL =

Postmark API base URL

"https://api.postmarkapp.com"

Instance Attribute Summary

• #api_token ⇒ String readonly

  The API token for authentication.

• #options ⇒ Hash readonly

  Additional options passed to the client.

Instance Method Summary

• #initialize(api_token: nil, **options) ⇒ Base constructor

  Initialize a new API client.

Constructor Details

#initialize(api_token: nil, **options) ⇒ Base

Initialize a new API client

Parameters:

• api_token (String, nil) (defaults to: nil) —

  the Postmark server API token. Falls back to PostmarkClient.configuration.api_token if not provided.

• options (Hash) —

  additional configuration options

Options Hash (**options):

• :timeout (Integer) —

  request timeout in seconds (default: 30)

• :open_timeout (Integer) —

  connection open timeout in seconds (default: 10)

• :base_url (String) —

  override the default API base URL

Raises:

• (PostmarkClient::ConfigurationError) —

  if no API token is available

# File 'lib/postmark_client/client/base.rb', line 39

def initialize(api_token: nil, **options)
  @api_token = api_token || PostmarkClient.configuration.api_token
  @options = options

  raise ConfigurationError, "API token is required" if @api_token.nil? || @api_token.empty?
end

Instance Attribute Details

#api_token ⇒ String (readonly)

Returns the API token for authentication.

Returns:

• (String) —

  the API token for authentication

# File 'lib/postmark_client/client/base.rb', line 24

def api_token
  @api_token
end

#options ⇒ Hash (readonly)

Returns additional options passed to the client.

Returns:

• (Hash) —

  additional options passed to the client

# File 'lib/postmark_client/client/base.rb', line 27

def options
  @options
end