Class: Io::Flow::V0::Clients::Payments

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Payments

Returns a new instance of Payments.



2645
2646
2647
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2645

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

Instance Method Details

#delete_by_id(organization, id) ⇒ Object

Deletes the specified payment



2681
2682
2683
2684
2685
2686
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2681

def delete_by_id(organization, id)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('id', id, String)
  r = @client.request("/#{CGI.escape(organization)}/payments/#{CGI.escape(id)}").delete
  nil
end

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



2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2649

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) }),
    :payment_method => (x = opts.delete(:payment_method); x.nil? ? nil : HttpClient::Preconditions.assert_class('payment_method', x, 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)}/payments").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::Payment.from_json(x) }
end

#get_by_id(organization, id) ⇒ Object

Returns information about a specific payment.



2673
2674
2675
2676
2677
2678
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2673

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)}/payments/#{CGI.escape(id)}").get
  ::Io::Flow::V0::Models::Payment.from_json(r)
end

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

Provides visibility into recent changes of each object, including deletion



2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2689

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

#post(organization, payment_form) ⇒ Object

Create a new payment. Note that when using JSONP to submit a payment, you do not need to authenticate.



2665
2666
2667
2668
2669
2670
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2665

def post(organization, payment_form)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  (x = payment_form; x.is_a?(::Io::Flow::V0::Models::PaymentForm) ? x : ::Io::Flow::V0::Models::PaymentForm.from_json(x))
  r = @client.request("/#{CGI.escape(organization)}/payments").with_json(payment_form.to_json).post
  ::Io::Flow::V0::Models::Payment.from_json(r)
end