class Postmen

This is the main class, it's being used as a namespace for all related classes and modules as well.

shipper_account_id string Shipper account ID status string Manifest status Accepts: manifesting,manifested,failed. limit string Number of records per page created_at_min string Start date and time of the record created (default: 24hrs ago) created_at_max string End date and time of the record created (default: NOW()) next_token string Next token

Constants

ConnectionError: Exception raised in case of any connection error
Error: Generic Exception class, all other exceptions should inherit from this class
MaximumNumberOfRetriesReachedError: Exception raised if retriable request reached maximum number of attempts.
PAPER_SIZES
RateLimitExceeded: Exception raised if rate limit was exceeded
ResourceNotFound: Expcetion raised if resource was not found.
VERSION: SDK Version

Public Class Methods

endpoint() click to toggle source

Returns the endpoint used in all queries

@return [String] endpoint url

# File lib/postmen.rb, line 56
def self.endpoint
  config.endpoint || Connection.endpoint("#{config.region}-api", config.failover)
end

failover!() click to toggle source

Switch to failover domain

# File lib/postmen.rb, line 73
def self.failover!
  config.failover = true
end

failover?() click to toggle source

Checks wheter we're in failover mode

# File lib/postmen.rb, line 68
def self.failover?
  !!config.failover
end

root() click to toggle source

Returns path where gem is installed

@return [Pathname] path

# File lib/postmen.rb, line 63
def self.root
  Pathname.new(File.expand_path(File.join(File.dirname(__FILE__), '../')))
end