Class: Io::Flow::V0::Clients::Trackings

Inherits:
Object
  • Object
show all
Defined in:
lib/flow_commerce/flow_api_v0_client.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Trackings

Returns a new instance of Trackings.



3516
3517
3518
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3516

def initialize(client)
  @client = HttpClient::Preconditions.assert_class('client', client, ::Io::Flow::V0::Client)
end

Instance Method Details

#get_trackings_and_versions_by_organization(organization, incoming = {}) ⇒ Object 



3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3540

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) ⇒ Object

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



3556
3557
3558
3559
3560
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3556

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 = {}) ⇒ Object 



3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3520

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) ⇒ Object 



3533
3534
3535
3536
3537
3538
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3533

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