Class: Io::Flow::V0::Clients::Returns
- Inherits:
-
Object
- Object
- Io::Flow::V0::Clients::Returns
- 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) ⇒ Returns
constructor
A new instance of Returns.
- #post(organization, return_form) ⇒ Object
- #put_by_key(organization, key, return_form) ⇒ Object
Constructor Details
#initialize(client) ⇒ Returns
Returns a new instance of Returns.
4466 4467 4468 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4466 def initialize(client) @client = HttpClient::Preconditions.assert_class('client', client, ::Io::Flow::V0::Client) end |
Instance Method Details
#delete_by_key(organization, key) ⇒ Object
4524 4525 4526 4527 4528 4529 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4524 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)}/returns/#{CGI.escape(key)}").delete nil end |
#get(organization, incoming = {}) ⇒ Object
4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4470 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) }), :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) }), :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) }), :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) }), :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)}/returns").with_query(query).get r.map { |x| ::Io::Flow::V0::Models::Return.new(x) } end |
#get_by_key(organization, key) ⇒ Object
4509 4510 4511 4512 4513 4514 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4509 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)}/returns/#{CGI.escape(key)}").get ::Io::Flow::V0::Models::Return.new(r) end |
#get_versions(organization, incoming = {}) ⇒ Object
4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4495 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)}/returns/versions").with_query(query).get r.map { |x| ::Io::Flow::V0::Models::ReturnVersion.new(x) } end |
#post(organization, return_form) ⇒ Object
4488 4489 4490 4491 4492 4493 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4488 def post(organization, return_form) HttpClient::Preconditions.assert_class('organization', organization, String) (x = return_form; x.is_a?(::Io::Flow::V0::Models::ReturnForm) ? x : ::Io::Flow::V0::Models::ReturnForm.new(x)) r = @client.request("/#{CGI.escape(organization)}/returns").with_json(return_form.to_json).post ::Io::Flow::V0::Models::Return.new(r) end |
#put_by_key(organization, key, return_form) ⇒ Object
4516 4517 4518 4519 4520 4521 4522 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4516 def put_by_key(organization, key, return_form) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('key', key, String) (x = return_form; x.is_a?(::Io::Flow::V0::Models::ReturnForm) ? x : ::Io::Flow::V0::Models::ReturnForm.new(x)) r = @client.request("/#{CGI.escape(organization)}/returns/#{CGI.escape(key)}").with_json(return_form.to_json).put ::Io::Flow::V0::Models::Return.new(r) end |