Class: Bloomerang::Tribute

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

Overview

Bloomerang::Tribute bloomerang.co/product/integrations-data-management/api/rest-api/#/Tributes Id integer($int64) SortIndex integer($int32) Note string TributeType TributeType, string, Enum: [ InHonorOf, InMemoryOf ] NotificantAccountIds array, The IDs of all notificants (constituents) associated with this tribute Name string IsDefault boolean, Is this the default? IsActive boolean, Is this active?

Class Method Summary collapse

Methods inherited from Base

delete, get, post, put

Class Method Details

.create(body) ⇒ Object

Create a tribute bloomerang.co/product/integrations-data-management/api/rest-api/#/Tributes/post_tribute

Params: body JSON object, see API for fields



34
35
36
 
# File 'lib/bloomerang/tribute.rb', line 34

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

.fetch(params = {}) ⇒ Object

Fetch all tributes bloomerang.co/product/integrations-data-management/api/rest-api/#/Tributes/get_tributes

Params: skip integer, default: 0, simple paging system take integer, default: 50, simple paging system id array, separated by pipes: “1|2|3”, Filters to tributes with the IDs in the list (pipe-separated) isActive boolean



25
26
27
 
# File 'lib/bloomerang/tribute.rb', line 25

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

.search_active(params = {}) ⇒ Object

Search for active tributes bloomerang.co/product/integrations-data-management/api/rest-api/#/Tributes/get_tributes_search skip integer, default: 0, simple paging system take integer, default: 50, simple paging system search string, The text to search (must be at least 3 characters)



62
63
64
 
# File 'lib/bloomerang/tribute.rb', line 62

def self.search_active(params = {})
  get("tributes/search", params)
end

.show(id) ⇒ Object

Fetch tribute by ID bloomerang.co/product/integrations-data-management/api/rest-api/#/Tributes/get_tribute_id

Params: id integer



43
44
45
 
# File 'lib/bloomerang/tribute.rb', line 43

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

.update(id, body) ⇒ Object

Update tribute bloomerang.co/product/integrations-data-management/api/rest-api/#/Tributes/put_tribute_id

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



53
54
55
 
# File 'lib/bloomerang/tribute.rb', line 53

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