class Io::Flow::V0::Clients::Trackings

Public Class Methods

new(client) click to toggle source
# File lib/flow_commerce/flow_api_v0_client.rb, line 5046
def initialize(client)
  @client = HttpClient::Preconditions.assert_class('client', client, ::Io::Flow::V0::Client)
end

Public Instance Methods

get_trackings_and_versions_by_organization(organization, incoming={}) click to toggle source
# File lib/flow_commerce/flow_api_v0_client.rb, line 5078
def get_trackings_and_versions_by_organization(organization, incoming={})
  HttpClient::Preconditions.assert_class('organization', organization, String)
  opts = HttpClient::Helper.symbolize_keys(incoming)
  query = {
    :id => (x = opts.delete(:id); x.nil? ? nil : HttpClient::Preconditions.assert_class('id', x, Array).map { |v| HttpClient::Preconditions.assert_class('id', v, String) }),
    :tracking_id => (x = opts.delete(:tracking_id); x.nil? ? nil : HttpClient::Preconditions.assert_class('tracking_id', x, Array).map { |v| HttpClient::Preconditions.assert_class('tracking_id', v, String) }),
    :limit => HttpClient::Preconditions.assert_class('limit', (x = opts.delete(:limit); x.nil? ? 25 : x), Integer),
    :offset => HttpClient::Preconditions.assert_class('offset', (x = opts.delete(:offset); x.nil? ? 0 : x), Integer),
    :sort => HttpClient::Preconditions.assert_class('sort', (x = opts.delete(:sort); x.nil? ? "journal_timestamp" : x), String)
  }.delete_if { |k, v| v.nil? }
  r = @client.request("/#{CGI.escape(organization)}/trackings/versions").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::TrackingVersion.new(x) }
end
get_trackings_by_id(id) click to toggle source

Public endpoint to get all relevant information about a tracking, label(s) under it, and event(s) under those label(s)

# File lib/flow_commerce/flow_api_v0_client.rb, line 5052
def get_trackings_by_id(id)
  HttpClient::Preconditions.assert_class('id', id, String)
  r = @client.request("/trackings/#{CGI.escape(id)}").get
  ::Io::Flow::V0::Models::Tracking.new(r)
end
get_trackings_by_organization(organization, incoming={}) click to toggle source
# File lib/flow_commerce/flow_api_v0_client.rb, line 5058
def get_trackings_by_organization(organization, incoming={})
  HttpClient::Preconditions.assert_class('organization', organization, String)
  opts = HttpClient::Helper.symbolize_keys(incoming)
  query = {
    :id => (x = opts.delete(:id); x.nil? ? nil : HttpClient::Preconditions.assert_class('id', x, Array).map { |v| HttpClient::Preconditions.assert_class('id', v, String) }),
    :limit => HttpClient::Preconditions.assert_class('limit', (x = opts.delete(:limit); x.nil? ? 25 : x), Integer),
    :offset => HttpClient::Preconditions.assert_class('offset', (x = opts.delete(:offset); x.nil? ? 0 : x), Integer),
    :sort => HttpClient::Preconditions.assert_class('sort', (x = opts.delete(:sort); x.nil? ? "-created_at" : x), String)
  }.delete_if { |k, v| v.nil? }
  r = @client.request("/#{CGI.escape(organization)}/trackings").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::Tracking.new(x) }
end
post_trackings_by_organization(organization, tracking_form) click to toggle source
# File lib/flow_commerce/flow_api_v0_client.rb, line 5071
def post_trackings_by_organization(organization, tracking_form)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  (x = tracking_form; x.is_a?(::Io::Flow::V0::Models::TrackingForm) ? x : ::Io::Flow::V0::Models::TrackingForm.new(x))
  r = @client.request("/#{CGI.escape(organization)}/trackings").with_json(tracking_form.to_json).post
  ::Io::Flow::V0::Models::Tracking.new(r)
end