Class: Bloomerang::Refund

Inherits:
Base
  • Object
show all
Defined in:
lib/bloomerang/refund.rb

Overview

Bloomerang::Refund bloomerang.co/product/integrations-data-management/api/rest-api/#/Refunds Id integer($int64), The ID of the refund TransactionId integer($int64), The ID of the transaction used in the API (not to be confused with transactionNumber) Note string, The reason for making this refund Date string($date), iso8601 format Amount number($currency) AuditTrail AuditTrail (object)

Class Method Summary collapse

Methods inherited from Base

get, post, put

Class Method Details

.create(body) ⇒ Object

Create a refund bloomerang.co/product/integrations-data-management/api/rest-api/#/Refunds/post_refund

Params: body JSON object, see API for fields



32
33
34
 
# File 'lib/bloomerang/refund.rb', line 32

def self.create(body)
  post("refund", {}, body)
end

.delete(id) ⇒ Object

Delete a refund bloomerang.co/product/integrations-data-management/api/rest-api/#/Refunds/delete_refund_id

Params: id integer



60
61
62
 
# File 'lib/bloomerang/refund.rb', line 60

def self.delete(id)
  delete("refund/#{id}")
end

.fetch(params = {}) ⇒ Object

Fetch all refunds bloomerang.co/product/integrations-data-management/api/rest-api/#/Refunds/get_refunds

Params: skip integer, default: 0, simple paging system take integer, default: 50, simple paging system transactionId array, separated by pipes: “1|2|3”, Filters results based on the transaction ID for the refund. id array, separated by pipes: “1|2|3” orderBy string, Available values : Id (default), CreatedDate, LastModifiedDate orderDirection string, Available values : Asc, Desc



23
24
25
 
# File 'lib/bloomerang/refund.rb', line 23

def self.fetch(params = {})
  get("refunds", params)
end

.show(id) ⇒ Object

Fetch a refund bloomerang.co/product/integrations-data-management/api/rest-api/#/Refunds/get_refund_id

Params: id integer



41
42
43
 
# File 'lib/bloomerang/refund.rb', line 41

def self.show(id)
  get("refund/#{id}")
end

.update(id, body) ⇒ Object

Update a refund bloomerang.co/product/integrations-data-management/api/rest-api/#/Refunds/put_refund_id

Params: id integer body JSON object, see API for fields



51
52
53
 
# File 'lib/bloomerang/refund.rb', line 51

def self.update(id, body)
  put("refund/#{id}", {}, body)
end