class Myparcel::Client

Represents a client for the API

Attributes

authentication[RW]

Public Class Methods

new(api_key = nil) click to toggle source
# File lib/myparcel/client.rb, line 6
def initialize(api_key = nil)
  @authentication = Myparcel::Authentication.new(api_key)
  raise 'No credentials provided' if @authentication.invalid?
end

Public Instance Methods

delivery_options() click to toggle source

Get delivery options for an address

Usage:

“‘ruby client.delivery_options.find({…}) “`

# File lib/myparcel/client.rb, line 18
def delivery_options
  @delivery_options ||= Myparcel::API::DeliveryOptions.new(authentication)
end
shipments() click to toggle source

Shipments management endpoint

Usage:

Create shipments:

“‘ruby client = Myparcel.client(’api_key’) client.shipments.create(shipments: [{…}]) “‘

Find shipments:

“‘ruby # returns all available shipments: client.shipments.find

# returns shipments by id client.shipments.find(shipment_ids: [1, 2]) “‘

# File lib/myparcel/client.rb, line 42
def shipments
  @shipments ||= Myparcel::API::Shipments.new(authentication)
end
tracktraces() click to toggle source
# File lib/myparcel/client.rb, line 46
def tracktraces
  @tracktraces ||= Myparcel::API::Tracktraces.new(authentication)
end
webhooks() click to toggle source
# File lib/myparcel/client.rb, line 50
def webhooks
  @webhooks ||= Myparcel::API::WebhookSubscriptions.new(authentication)
end