Class: Io::Flow::V0::Clients::Refunds
- Inherits:
-
Object
- Object
- Io::Flow::V0::Clients::Refunds
- Defined in:
- lib/flow_commerce/flow_api_v0_client.rb
Instance Method Summary collapse
- #delete_identifiers_by_key_and_identifier(organization, key, identifier) ⇒ Object
- #get(organization, incoming = {}) ⇒ Object
-
#get_by_key(organization, key) ⇒ Object
Returns information about a specific refund.
- #get_identifiers_by_key(organization, key, incoming = {}) ⇒ Object
-
#get_summary_by_order_number(organization, order_number) ⇒ Object
Returns a refund order summary for the specified order.
-
#get_versions(organization, incoming = {}) ⇒ Object
Provides visibility into recent changes of each object, including deletion.
-
#initialize(client) ⇒ Refunds
constructor
A new instance of Refunds.
-
#post(organization, refund_form) ⇒ Object
Create a new refund.
-
#put_identifiers_by_key_and_identifier(organization, key, identifier, identifier_form) ⇒ Object
Create a new identifier for this refund.
Constructor Details
#initialize(client) ⇒ Refunds
Returns a new instance of Refunds.
3187 3188 3189 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3187 def initialize(client) @client = HttpClient::Preconditions.assert_class('client', client, ::Io::Flow::V0::Client) end |
Instance Method Details
#delete_identifiers_by_key_and_identifier(organization, key, identifier) ⇒ Object
3274 3275 3276 3277 3278 3279 3280 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3274 def delete_identifiers_by_key_and_identifier(organization, key, identifier) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('key', key, String) HttpClient::Preconditions.assert_class('identifier', identifier, String) r = @client.request("/#{CGI.escape(organization)}/refunds/#{CGI.escape(key)}/identifiers/#{CGI.escape(identifier)}").delete nil end |
#get(organization, incoming = {}) ⇒ Object
3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3191 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) }), :identifier => (x = opts.delete(:identifier); x.nil? ? nil : HttpClient::Preconditions.assert_class('identifier', x, 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)), :capture_id => (x = opts.delete(:capture_id); x.nil? ? nil : HttpClient::Preconditions.assert_class('capture_id', x, String)), :capture_key => (x = opts.delete(:capture_key); x.nil? ? nil : HttpClient::Preconditions.assert_class('capture_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)}/refunds").with_query(query).get r.map { |x| ::Io::Flow::V0::Models::Refund.new(x) } end |
#get_by_key(organization, key) ⇒ Object
Returns information about a specific refund.
3242 3243 3244 3245 3246 3247 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3242 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)}/refunds/#{CGI.escape(key)}").get ::Io::Flow::V0::Models::Refund.new(r) end |
#get_identifiers_by_key(organization, key, incoming = {}) ⇒ Object
3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3249 def get_identifiers_by_key(organization, key, incoming={}) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('key', key, 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) }), :identifier => (x = opts.delete(:identifier); x.nil? ? nil : HttpClient::Preconditions.assert_class('identifier', 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? ? "name" : x), String) }.delete_if { |k, v| v.nil? } r = @client.request("/#{CGI.escape(organization)}/refunds/#{CGI.escape(key)}/identifiers").with_query(query).get r.map { |x| ::Io::Flow::V0::Models::RefundIdentifier.new(x) } end |
#get_summary_by_order_number(organization, order_number) ⇒ Object
Returns a refund order summary for the specified order.
3219 3220 3221 3222 3223 3224 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3219 def get_summary_by_order_number(organization, order_number) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('order_number', order_number, String) r = @client.request("/#{CGI.escape(organization)}/refunds/summary/#{CGI.escape(order_number)}").get ::Io::Flow::V0::Models::RefundOrderSummary.new(r) end |
#get_versions(organization, incoming = {}) ⇒ Object
Provides visibility into recent changes of each object, including deletion
3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3227 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) }), :refund_id => (x = opts.delete(:refund_id); x.nil? ? nil : HttpClient::Preconditions.assert_class('refund_id', x, Array).map { |v| HttpClient::Preconditions.assert_class('refund_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)}/refunds/versions").with_query(query).get r.map { |x| ::Io::Flow::V0::Models::RefundVersion.new(x) } end |
#post(organization, refund_form) ⇒ Object
Create a new refund.
3211 3212 3213 3214 3215 3216 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3211 def post(organization, refund_form) HttpClient::Preconditions.assert_class('organization', organization, String) (x = refund_form; x.is_a?(::Io::Flow::V0::Models::RefundForm) ? x : ::Io::Flow::V0::Models::RefundForm.new(x)) r = @client.request("/#{CGI.escape(organization)}/refunds").with_json(refund_form.to_json).post ::Io::Flow::V0::Models::Refund.new(r) end |
#put_identifiers_by_key_and_identifier(organization, key, identifier, identifier_form) ⇒ Object
Create a new identifier for this refund
3265 3266 3267 3268 3269 3270 3271 3272 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3265 def put_identifiers_by_key_and_identifier(organization, key, identifier, identifier_form) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('key', key, String) HttpClient::Preconditions.assert_class('identifier', identifier, String) (x = identifier_form; x.is_a?(::Io::Flow::V0::Models::IdentifierForm) ? x : ::Io::Flow::V0::Models::IdentifierForm.new(x)) r = @client.request("/#{CGI.escape(organization)}/refunds/#{CGI.escape(key)}/identifiers/#{CGI.escape(identifier)}").with_json(identifier_form.to_json).put ::Io::Flow::V0::Models::RefundIdentifier.new(r) end |