Class: Io::Flow::V0::Clients::ShippingNotifications

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ShippingNotifications

Returns a new instance of ShippingNotifications.



4349
4350
4351
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4349

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

Instance Method Details

#delete_by_key(organization, key) ⇒ Object 



4407
4408
4409
4410
4411
4412
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4407

def delete_by_key(organization, key)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('key', key, String)
  r = @client.request("/#{CGI.escape(organization)}/shipping-notifications/#{CGI.escape(key)}").delete
  nil
end

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



4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4353

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) }),
    :key => (x = opts.delete(:key); x.nil? ? nil : HttpClient::Preconditions.assert_class('key', x, Array).map { |v| HttpClient::Preconditions.assert_class('key', 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) }),
    :order_number => (x = opts.delete(:order_number); x.nil? ? nil : HttpClient::Preconditions.assert_class('order_number', x, Array).map { |v| HttpClient::Preconditions.assert_class('order_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)}/shipping-notifications").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::ShippingNotification.new(x) }
end

#get_by_key(organization, key) ⇒ Object 



4392
4393
4394
4395
4396
4397
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4392

def get_by_key(organization, key)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('key', key, String)
  r = @client.request("/#{CGI.escape(organization)}/shipping-notifications/#{CGI.escape(key)}").get
  ::Io::Flow::V0::Models::ShippingNotification.new(r)
end

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



4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4378

def get_versions(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) }),
    :key => (x = opts.delete(:key); x.nil? ? nil : HttpClient::Preconditions.assert_class('key', x, Array).map { |v| HttpClient::Preconditions.assert_class('key', 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)}/shipping-notifications/versions").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::ShippingNotificationVersion.new(x) }
end

#post(organization, shipping_notification_form) ⇒ Object 



4371
4372
4373
4374
4375
4376
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4371

def post(organization, shipping_notification_form)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  (x = shipping_notification_form; x.is_a?(::Io::Flow::V0::Models::ShippingNotificationForm) ? x : ::Io::Flow::V0::Models::ShippingNotificationForm.from_json(x))
  r = @client.request("/#{CGI.escape(organization)}/shipping-notifications").with_json(shipping_notification_form.to_json).post
  ::Io::Flow::V0::Models::ShippingNotification.new(r)
end

#put_by_key(organization, key, detailed_shipping_notification_form) ⇒ Object 



4399
4400
4401
4402
4403
4404
4405
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4399

def put_by_key(organization, key, detailed_shipping_notification_form)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('key', key, String)
  (x = detailed_shipping_notification_form; x.is_a?(::Io::Flow::V0::Models::DetailedShippingNotificationForm) ? x : ::Io::Flow::V0::Models::DetailedShippingNotificationForm.new(x))
  r = @client.request("/#{CGI.escape(organization)}/shipping-notifications/#{CGI.escape(key)}").with_json(detailed_shipping_notification_form.to_json).put
  ::Io::Flow::V0::Models::ShippingNotification.new(r)
end