Class: Io::Flow::V0::Clients::ShippingNotifications
- Inherits:
-
Object
- Object
- Io::Flow::V0::Clients::ShippingNotifications
- Defined in:
- lib/flow_commerce/flow_api_v0_client.rb
Instance Method Summary collapse
- #delete_by_key(organization, key) ⇒ Object
- #get(organization, incoming = {}) ⇒ Object
- #get_by_key(organization, key) ⇒ Object
- #get_versions(organization, incoming = {}) ⇒ Object
-
#initialize(client) ⇒ ShippingNotifications
constructor
A new instance of ShippingNotifications.
- #post(organization, shipping_notification_form) ⇒ Object
- #put_by_key(organization, key, shipping_notification_form) ⇒ Object
Constructor Details
#initialize(client) ⇒ ShippingNotifications
Returns a new instance of ShippingNotifications.
4897 4898 4899 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4897 def initialize(client) @client = HttpClient::Preconditions.assert_class('client', client, ::Io::Flow::V0::Client) end |
Instance Method Details
#delete_by_key(organization, key) ⇒ Object
4955 4956 4957 4958 4959 4960 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4955 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
4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4901 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
4940 4941 4942 4943 4944 4945 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4940 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
4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4926 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
4919 4920 4921 4922 4923 4924 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4919 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, shipping_notification_form) ⇒ Object
4947 4948 4949 4950 4951 4952 4953 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4947 def put_by_key(organization, key, shipping_notification_form) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('key', key, 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/#{CGI.escape(key)}").with_json(shipping_notification_form.to_json).put ::Io::Flow::V0::Models::ShippingNotification.new(r) end |