Class: Bloomerang::Interaction

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

Overview

Bloomerang::Interaction bloomerang.co/product/integrations-data-management/api/rest-api/#/Interactions Id integer($int64) Date string($date), iso8601 format Note string Channel Channel object, string, Enum: [ Email, MassEmail, Phone, TextMessage, Mail, InPerson, SocialMedia, Website, Twitter, Other, EngagementSurveyEmail, EngagementSurvey ] Purpose Purpose, string, Enum: [ Acknowledgement, ImpactCultivation, Newsletter, Receipt, Solicitation, SpecialEvent, VolunteerActivity, PledgeReminder, Welcome, BenevonPointOfEntry, BenevonFollowUp, BenevonAskEvent, BenevonOneOnOneAsk, BenevonOngoingCultivation, Other ] Subject string IsInbound boolean AccountId integer($int64), The ID of the constituent used in the API (not to be confused with accountNumber) TweetId string, If the Channel is Twitter, this contains the ID of the tweet that can be used to display the tweet by substituting into twitter.com/anyUser/status/TweetId IsBcc boolean, Whether or not this interaction was created by an email that was sent to Bloomerang via BCC EmailAddress string($email), If the interaction is an email interaction, this is the email address of the constituent that received the email. Only populated when IsBcc is true. AttachmentIds array, The ID of the attachments on this interaction LetterAttachmentIds array, The ID of generated letter attachments on this interaction. SurveyLapsedResponses array, The list of reasons the donor lapsed, if this interaction represents a lapsed donor survey response IsEngagementSurveyResponse boolean, Whether this interaction represents a donor survey response SurveyEmailInteractionId integer($int64), The interaction ID of the survey email that was sent to the donor. Only populated when IsEngagementSurveyResponse is true IsEngagementSurveyEmail boolean, Whether this interaction represents a survey email that was sent to the donor SurveyResponseInteractionId integer($int64), The interaction ID of the survey response. Only populated when IsEngagementSurveyEmail is true. 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 an interaction bloomerang.co/product/integrations-data-management/api/rest-api/#/Interactions/post_interaction

Params: body JSON object, see API for fields



50
51
52
 
# File 'lib/bloomerang/interaction.rb', line 50

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

.delete(id) ⇒ Object

Delete interaction bloomerang.co/product/integrations-data-management/api/rest-api/#/Interactions/delete_interaction_id

Params: id integer



78
79
80
 
# File 'lib/bloomerang/interaction.rb', line 78

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

.fetch(params = {}) ⇒ Object

Fetch all interactions bloomerang.co/product/integrations-data-management/api/rest-api/#/Interactions/get_interactions

Params: skip integer, default: 0, simple paging system take integer, default: 50, simple paging system channel array, Available values : Email, MassEmail, Phone, TextMessage, Mail, InPerson, SocialMedia, Website, Twitter, Other, EngagementSurveyEmail, EngagementSurvey purpose array, Available values : Acknowledgement, ImpactCultivation, Newsletter, Receipt, Solicitation, SpecialEvent, VolunteerActivity, PledgeReminder, Welcome, BenevonPointOfEntry, BenevonFollowUp, BenevonAskEvent, BenevonOneOnOneAsk, BenevonOngoingCultivation, Other 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



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

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

.show(id) ⇒ Object

Fetch interaction by ID bloomerang.co/product/integrations-data-management/api/rest-api/#/Interactions/get_interaction_id

Params: id integer



59
60
61
 
# File 'lib/bloomerang/interaction.rb', line 59

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

.update(id, body) ⇒ Object

Update interaction bloomerang.co/product/integrations-data-management/api/rest-api/#/Interactions/put_interaction_id

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



69
70
71
 
# File 'lib/bloomerang/interaction.rb', line 69

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