Class: Io::Flow::V0::Clients::ReturnPolicies

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ReturnPolicies

Returns a new instance of ReturnPolicies.



7634
7635
7636
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7634

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

Instance Method Details

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

Returns a list of return policies



7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7639

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) }),
    :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)}/return/policies").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::ReturnPolicy.new(x) }
end

#get_by_id(organization, id) ⇒ Object 



7673
7674
7675
7676
7677
7678
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7673

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)}/return/policies/#{CGI.escape(id)}").get
  ::Io::Flow::V0::Models::ReturnPolicy.new(r)
end

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



7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7659

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) }),
    :return_policy_id => (x = opts.delete(:return_policy_id); x.nil? ? nil : HttpClient::Preconditions.assert_class('return_policy_id', x, Array).map { |v| HttpClient::Preconditions.assert_class('return_policy_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)}/return/policies/versions").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::ReturnPolicyVersion.new(x) }
end

#post(organization, return_policy_form) ⇒ Object 



7652
7653
7654
7655
7656
7657
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7652

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

#put_by_id(organization, id, return_policy_form) ⇒ Object

Updates the specified return policy.



7681
7682
7683
7684
7685
7686
7687
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7681

def put_by_id(organization, id, return_policy_form)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('id', id, String)
  (x = return_policy_form; x.is_a?(::Io::Flow::V0::Models::ReturnPolicyForm) ? x : ::Io::Flow::V0::Models::ReturnPolicyForm.new(x))
  r = @client.request("/#{CGI.escape(organization)}/return/policies/#{CGI.escape(id)}").with_json(return_policy_form.to_json).put
  ::Io::Flow::V0::Models::ReturnPolicy.new(r)
end

#put_deletion_by_id(organization, id) ⇒ Object

Marks the return policy deleted. Once updated, the policy itself will be deleted.



7691
7692
7693
7694
7695
7696
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7691

def put_deletion_by_id(organization, id)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('id', id, String)
  r = @client.request("/#{CGI.escape(organization)}/return/policies/#{CGI.escape(id)}/deletion").put
  ::Io::Flow::V0::Models::ReturnPolicy.new(r)
end