Class: Bloomerang::Note

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

Overview

Bloomerang::Note bloomerang.co/product/integrations-data-management/api/rest-api/#/Notes Id integer($int64) AttachmentIds array, The ID of the attachments on this interaction AccountId integer($int64), The ID of the constituent used in the API (not to be confused with accountNumber) Date string($date), iso8601 format Note string CustomValues array, oneOf -> [OneValueAssignment (object), MultipleValueAssignments (object)] AuditTrail AuditTrail (object)

Class Method Summary collapse

Methods inherited from Base

get, post, put

Class Method Details

.create(body) ⇒ Object

Create a note bloomerang.co/product/integrations-data-management/api/rest-api/#/Notes/post_note

Params: body JSON object, see API for fields



33
34
35
 
# File 'lib/bloomerang/note.rb', line 33

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

.delete(id) ⇒ Object

Delete a note by ID bloomerang.co/product/integrations-data-management/api/rest-api/#/Notes/delete_note_id

Params: id integer



61
62
63
 
# File 'lib/bloomerang/note.rb', line 61

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

.fetch(params = {}) ⇒ Object

Fetch all notes bloomerang.co/product/integrations-data-management/api/rest-api/#/Notes/get_notes

Params: skip integer, default: 0, simple paging system take integer, default: 50, simple paging system constituent array, separated by pipes: “1|2|3” id array, separated by pipes: “1|2|3” orderBy string, Available values : Id (default), CreatedDate, LastModifiedDate orderDirection string, Available values : Asc, Desc



24
25
26
 
# File 'lib/bloomerang/note.rb', line 24

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

.show(id) ⇒ Object

Fetch a note by ID bloomerang.co/product/integrations-data-management/api/rest-api/#/Notes/get_note_id

Params: id integer



42
43
44
 
# File 'lib/bloomerang/note.rb', line 42

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

.update(id, body) ⇒ Object

Update a note bloomerang.co/product/integrations-data-management/api/rest-api/#/Notes/put_note_id

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



52
53
54
 
# File 'lib/bloomerang/note.rb', line 52

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