Class: Io::Flow::V0::Clients::Reversals

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Reversals

Returns a new instance of Reversals.



3181
3182
3183
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3181

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

Instance Method Details

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



3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3185

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) }),
    :authorization_id => (x = opts.delete(:authorization_id); x.nil? ? nil : HttpClient::Preconditions.assert_class('authorization_id', x, String)),
    :authorization_key => (x = opts.delete(:authorization_key); x.nil? ? nil : HttpClient::Preconditions.assert_class('authorization_key', 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)}/reversals").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::Reversal.new(x) }
end

#get_by_key(organization, key) ⇒ Object 



3208
3209
3210
3211
3212
3213
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3208

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)}/reversals/#{CGI.escape(key)}").get
  ::Io::Flow::V0::Models::Reversal.new(r)
end

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



3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3225

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

#post(organization, reversal_form) ⇒ Object 



3201
3202
3203
3204
3205
3206
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3201

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

#put_by_key(organization, key, reversal_put_form) ⇒ Object

Try inserting or updating a new reversal. Useful for retrying pending reversals



3217
3218
3219
3220
3221
3222
3223
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3217

def put_by_key(organization, key, reversal_put_form)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('key', key, String)
  (x = reversal_put_form; x.is_a?(::Io::Flow::V0::Models::ReversalPutForm) ? x : ::Io::Flow::V0::Models::ReversalPutForm.new(x))
  r = @client.request("/#{CGI.escape(organization)}/reversals/#{CGI.escape(key)}").with_json(reversal_put_form.to_json).put
  ::Io::Flow::V0::Models::Reversal.new(r)
end