Class: Io::Flow::V0::Clients::Manifests

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Manifests

Returns a new instance of Manifests.



4175
4176
4177
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4175

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

Instance Method Details

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



4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4179

def get(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) }),
    :carrier_tracking_number => (x = opts.delete(:carrier_tracking_number); x.nil? ? nil : HttpClient::Preconditions.assert_class('carrier_tracking_number', x, Array).map { |v| HttpClient::Preconditions.assert_class('carrier_tracking_number', v, String) }),
    :flow_tracking_number => (x = opts.delete(:flow_tracking_number); x.nil? ? nil : HttpClient::Preconditions.assert_class('flow_tracking_number', x, Array).map { |v| HttpClient::Preconditions.assert_class('flow_tracking_number', v, String) }),
    :service => (x = opts.delete(:service); x.nil? ? nil : HttpClient::Preconditions.assert_class('service', x, Array).map { |v| HttpClient::Preconditions.assert_class('service', 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)}/manifests").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::Manifest.new(x) }
end

#get_by_id(organization, id) ⇒ Object 



4213
4214
4215
4216
4217
4218
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4213

def get_by_id(organization, id)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('id', id, String)
  r = @client.request("/#{CGI.escape(organization)}/manifests/#{CGI.escape(id)}").get
  ::Io::Flow::V0::Models::Manifest.new(r)
end

#get_services_and_outstanding_by_service(organization, service) ⇒ Object

Generates a new manifest with all outstanding labels and redirects to a downloadable PDF of carrier-generated manifest or bill of lading (BOL). If no outstanding labels, this will generate a 422 error.



4206
4207
4208
4209
4210
4211
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4206

def get_services_and_outstanding_by_service(organization, service)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('service', service, String)
  r = @client.request("/#{CGI.escape(organization)}/manifests/services/#{CGI.escape(service)}/outstanding").get
  r
end

#post(organization, manifest_form) ⇒ Object

Creates a new manifest/carrier BOL with specific tracking numbers



4196
4197
4198
4199
4200
4201
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4196

def post(organization, manifest_form)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  (x = manifest_form; x.is_a?(::Io::Flow::V0::Models::ManifestForm) ? x : ::Io::Flow::V0::Models::ManifestForm.new(x))
  r = @client.request("/#{CGI.escape(organization)}/manifests").with_json(manifest_form.to_json).post
  ::Io::Flow::V0::Models::Manifest.new(r)
end