bloomerang_api 0.2.2

data/lib/bloomerang/campaign.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Bloomerang
+  ## Bloomerang::Campaign
+  ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Campaigns
+  # Id        integer($int64)
+  # Raised    number($currency)
+  # The total amount raised for this campaign
+
+  # StartDate string($date) iso8601 format
+  # EndDate   string($date) iso8601 format
+  # Goal      number($currency)
+  # Name      string
+  # SortIndex integer($int32)
+  # IsActive  boolean
+  class Campaign < Base
+    ### Fetch all campaigns
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Campaigns/get_campaigns
+    #
+    ## Params:
+    # skip      integer, default: 0,  simple paging system
+    # take      integer, default: 50, simple paging system
+    # id        array[integer], separated by pipes: "one|two|three"
+    # IsActive  boolean
+    # search    string, returns matches on any part of name
+    # hasGoal   boolean, have either non-zero-dollar or zero-dollar goals
+    def fetch(params = {})
+      get("campaigns", params)
+    end
+
+    ### Show single campaign
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Campaigns/get_campaign__id_
+    #
+    # Params:
+    # id integer
+    def get(id)
+      get("campaign/#{id}")
+    end
+
+    ### Update single campaign
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Campaigns/put_campaign__id_
+    #
+    ## Params:
+    # id   integer
+    # body JSON object, see API for fields
+    def update(id, body)
+      put("campaign/#{id}", {}, body)
+    end
+
+    ### Create single campaign
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Campaigns/post_campaign
+    #
+    ## Params:
+    # body JSON object, see API for fields
+    def create(body)
+      post("campaign", {}, body)
+    end
+
+    ### Refresh summaries
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Campaigns/get_campaigns_refreshsummaries
+    # Refreshes campaign goals
+    # Returns: JSON: The list of campaigns that are active and have a non-zero goal.
+    #
+    ## Params: none
+    def refresh_summaries
+      get("campaigns/refreshsummaries")
+    end
+  end
+end

data/lib/bloomerang/configuration.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Bloomerang
+  class Configuration
+    attr_accessor :api_key
+  end
+end

data/lib/bloomerang/constituent.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Bloomerang
+  ### Bloomerang::Constituent
+  ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Constituents
+  # Id                            integer($int64), The ID of the constituent used in the API (not to be confused with AccountNumber)
+  # AccountNumber                 integer($int64), A user-friendly account number used in the Bloomerang CRM UI (not to be confused with ID).
+  # IsInHousehold                 boolean, Whether the Constituent is in a household
+  # IsHeadOfHousehold             boolean, Whether the Constituent is in a household and is marked as the primary
+  # IsFavorite                    boolean, True if this constituent is a favorite of the current user
+  # FullCustomProfileImageId      integer($int64), The ID of the existing file attachment for the full version of the custom profile image.
+  # FullCustomProfileImageUrl     string($url), The URL of the existing file attachment for the full version of the custom profile image.
+  # CroppedCustomProfileImageId   integer($int64), The ID of the existing file attachment for the cropped version of the custom profile image.
+  # CroppedCustomProfileImageUrl  string($url), The URL of the existing file attachment for the cropped version of the custom profile image.
+  # Type                          ConstituentType: string, Enum: [ Individual, Organization ]
+  # Status                        AccountStatus: string, Enum: [ Active, Inactive, Deceased ]
+  # FirstName                     string
+  # LastName                      string
+  # MiddleName                    string
+  # Prefix                        string, Must match a prefix in the Bloomerang CRM
+  # Suffix                        string, Must match a suffix in the Bloomerang CRM
+  # FullName                      string
+  # InformalName                  string
+  # FormalName                    string
+  # EnvelopeName                  string
+  # RecognitionName               string
+  # JobTitle                      string
+  # Employer                      string
+  # Website                       string($uri)
+  # FacebookId                    string
+  # TwitterId                     string
+  # LinkedInId                    string
+  # Gender                        Gender: string, Enum: [ Male, Female, Other ]
+  # Birthdate                     string($date)
+  # ProfilePictureType            ProfilePictureType: string, Enum: [ None, Custom, Twitter ]
+  # PrimaryEmail                  Email (object)
+  # PrimaryPhone                  Phone (object)
+  # HouseholdId                   integer($int64), The ID of the household this constituent is in (not to be confused with AccountNumber)
+  # PreferredCommunicationChannel PreferredCommunicationChannel: string, Enum: [ Email, Phone, TextMessage, Mail ]
+  # CommunicationRestrictions     array[string], Enum: [ DoNotCall, DoNotMail, DoNotSolicit ]
+  # CommunicationRestrictionsUpdateReason string, The most-recent reason for updating this constituent's communication restrictions
+  # EmailInterestType             EmailInterestType: string, Enum: [ All, Custom, OptedOut ]
+  # CustomEmailInterests          array[integer($int64)], IDs for custom email interests if the email interest type is Custom
+  # EmailInterestsUpdateReason    string, The most-recent reason for updating this constituent's email interests
+  # PrimaryAddress                Address (object)
+  # EngagementScore               EngagementScore: string, Enum: [ Low, MediumLow, Medium, MediumHigh, High ]
+  # DonorSearchInfo               DonorSearchInfo (object)
+  # AddressIds                    array[integer($int64)], The IDs of the addresses including the primary address ID
+  # EmailIds                      array[integer($int64)], The IDs of the emails including the primary email ID
+  # PhoneIds                      array[integer($int64)], The IDs of the phones including the primary phone ID
+  # CustomValues                  array[Objects], Objects are either OneValueAssignment or MultipleValueAssignments
+  # AuditTrail                    AuditTrail (Object)
+  class Constituent < Base
+    # for backwards compatability
+
+    ### Fetch all constituents
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Constituents/get_constituents
+    #
+    # Params:
+    # skip            integer, default: 0,  simple paging system
+    # take            integer, default: 50, simple paging system
+    # lastModified    string, date in iso8601 format, Filters to constituents last modified after the specified date
+    # isFavorite      boolean, Filters constituents to only constituents the user has favorited.
+    # type            string, Available values : Individual, Organization
+    # id              array[integer], separated by pipes: "1|2|3"
+    # orderBy         string, Available values : Id (default), CreatedDate, LastModifiedDate
+    # orderDirection  string, Available values : Asc, Desc
+    def fetch(params = {})
+      # TODO: BREAKING CHANGE: used to accept no arguments
+      get("constituents", params)
+    end
+
+    ### Show a constituent
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Constituents/get_constituent__id_
+    #
+    # Params:
+    # id  integer
+    def get(id)
+      get("constituent/#{id}")
+    end
+
+    ### Show a constituent's relationships
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Constituents/get_constituent__id__relationships
+    #
+    # Params:
+    # skip    integer, default: 0,  simple paging system
+    # take    integer, default: 50, simple paging system
+    # id      integer
+    #
+    # Returns: array of Relationships
+    def fetch_relationships(id, params = {})
+      get("constituent/#{id}/relationships", params)
+    end
+
+    ### Show a constituent's timeline
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Constituents/get_constituent__id__timeline
+    # Retrieves TimelineEntrySummary for the Constituent or all members of a Household (if Household ID is passed in)
+    #
+    # Params:
+    # skip    integer, default: 0,  simple paging system
+    # take    integer, default: 50, simple paging system
+    # id      integer
+    #
+    # Returns: paged list of TimelineEntrySummary models
+    def fetch_timeline(id, params = {})
+      get("constituent/#{id}/timeline", params)
+    end
+
+    ### Update a constituent's communication settings
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Constituents/put_constituent__id__updateCommunicationSettings
+    #
+    # Params:
+    # id    integer
+    # body  see API for fields
+    def update_communication_settings(id, body)
+      put("/constituent/#{id}/updateCommunicationSettings", {}, body)
+    end
+
+    ### Search for constituents and households
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Constituents/get_constituents_search
+    #
+    # Params:
+    # skip    integer, default: 0,  simple paging system
+    # take    integer, default: 50, simple paging system
+    # search  string, searches on Full Name with
+    def search(params = {})
+      get("constituents/search", params)
+    end
+
+    ### Create or update a constituent
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Constituents/post_constituent_merge
+    #
+    # Params:
+    # body  see API for fields
+    #
+    # NOTE: acts like upsert:
+    # "When merging, the database will look for a possible duplicate defined as a name
+    # plus one piece of contact info (address, email, or phone).
+    # If a duplicate is found, the data passed in will be merged into an existing constituent.
+    # If no duplicate is found, a new constituent will be created."
+    #
+    # there is a create-only endpoint, but
+    # given the risk of duplicate records, this should be the default method
+    # for create-only over merge-or-create
+    def create(body)
+      # "When merging, the database will look for a possible duplicate defined as a
+      # name plus one piece of contact info (address, email, or phone). If a duplicate
+      # is found, the data passed in will be merged into an existing constituent.
+      # If no duplicate is found, a new constituent will be created. Note that
+      # this endpoint does not accept SecondaryAddresses, SecondaryEmails, or
+      # SecondaryPhones and you will receive an exception if you pass those in.""
+      post("constituent/merge", {}, body)
+    end
+
+    ### Create a constituent, including SecondaryEmail, SecondaryAddress and SecondaryPhone fields
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Constituents/post_constituent
+    #
+    # Params:
+    # body  see API for fields
+    #
+    # NOTE: insert only, high risk of duplicates.
+    # The only benefit of this method over #create is the ability to specify
+    # secondary address, email and phone
+    #
+    # A more secure pattern would be to create the Constituent
+    # then use the returned Constituent ID to check for Emails, Addresses and Phones,
+    # and add records if necessary
+    def create_with_secondary(body)
+      post("constituent", {}, body)
+    end
+
+    ### Update a constituent
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Constituents/put_constituent__id_
+    #
+    # Params:
+    # id    integer
+    # body  see API for fields
+    def update(id, body)
+      put("constituent/#{id}", {}, body)
+    end
+
+    ### Search for duplicate constituents
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Constituents/post_constituent_duplicates
+    #
+    # Params:
+    # body  see API for fields
+    #
+    # NOTE: There is a GET version as well,
+    # but POST was chosen for future Model usage
+    # e.g. body = Constituent.duplicate_check_attributes
+    def find_duplicates(body)
+      post("constituent/duplicates", {}, body)
+    end
+
+    ### Delete a constituent
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Constituents/delete_constituent__id_
+    #
+    # Params:
+    # id  integer
+    def delete(id)
+      delete("constituent/#{id}")
+    end
+  end
+end

data/lib/bloomerang/custom_field.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Bloomerang
+  ### Bloomerang::CustomField
+  # Id          integer($int64)
+  # CategoryId  integer($int64)
+  # Name        string
+  # IsRequired  boolean
+  # IsActive    boolean
+  # DataType    CustomFieldDataType (object): string, Enum: [ Currency, Date, Decimal, Text, Year ]
+  # PickType    CustomFieldPickType (object): string, Enum: [ Freeform, PickMultiple, PickOne ]
+  # SortIndex   integer($int32)
+  class CustomField
+    ### Fetch CustomField Categories by type
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Custom%20Fields/get_customFieldCategories__type__
+    #
+    # Params:
+    # type  string, Available values: Constituent, Transaction, Interaction, Note, Benevon
+    def categories(type)
+      get("/customFieldCategories/#{type}/")
+    end
+
+    ### Fetch CustomFields by type
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Custom%20Fields/get_customFields__type__
+    #
+    # Params:
+    # type      string, Available values: Constituent, Transaction, Interaction, Note, Benevon
+    # isActive  boolean, Default value: true
+    def fields(type, params = {})
+      get("/customFields/#{type}/", params)
+    end
+
+    ### Fetch CustomValues by type
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Custom%20Fields/get_customValues__type_
+    #
+    # Params:
+    # type      string, Available values : Constituent, Transaction, Interaction, Note, Benevon
+    # isActive  boolean, Default value: true
+    def values(type, params = {})
+      get("/customValues/#{type}/", params)
+    end
+
+    ### Fetch CustomValues by type for the given field
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Custom%20Fields/get_customValues__type___fieldId_
+    #
+    # Params:
+    # type      string, Available values : Constituent, Transaction, Interaction, Note, Benevon
+    # fieldId   integer
+    # isActive  boolean, Default value: true
+    def values_by_field(type, field_id, params = {})
+      get("/customValues/#{type}/#{field_id}", params)
+    end
+  end
+end

data/lib/bloomerang/email.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Bloomerang
+  ### Bloomerang::Email
+  ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Email%20Addresses
+  # Id        integer($int64)
+  # AccountId integer($int64), The ID of the constituent used in the API (not to be confused with accountNumber)
+  # Type      EmailType string, Enum: [ Home, Work ]
+  # Value     string($email), The email address
+  # IsPrimary boolean
+  # IsBad     boolean
+  class Email < Base
+    ### Fetch all emails
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Email%20Addresses/get_emails
+    #
+    # Params:
+    # skip          integer, default: 0,  simple paging system
+    # take          integer, default: 50, simple paging system
+    # constituent   array[integer], separated by pipes: "1|2|3"
+    # id            array[integer], separated by pipes: "1|2|3"
+    def fetch(params = {})
+      get("emails", params)
+    end
+
+    ### Fetch email by ID
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Email%20Addresses/get_email__id_
+    #
+    # Params:
+    # id  integer
+    def get(id)
+      get("email/#{id}")
+    end
+
+    ### Create email
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Email%20Addresses/post_email
+    #
+    # Params:
+    # body  JSON object, see API for fields
+    def create(body)
+      post("email", {}, body)
+    end
+
+    ### Update email
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Email%20Addresses/put_email__id_
+    #
+    # Params:
+    # id    integer
+    # body  JSON object, see API for fields
+    def update(id, body)
+      put("email/#{id}", {}, body)
+    end
+
+    ### Delete email
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Email%20Addresses/delete_email__id_
+    #
+    # Params:
+    # id  integer
+    def delete(id)
+      delete("email/#{id}")
+    end
+  end
+end

data/lib/bloomerang/email_interest.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Bloomerang
+  ### Bloomerang:EmailInterest
+  ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Email%20Interests
+  # Id                    integer($int64)
+  # IsSurveyEmailInterest boolean, Is this an email interest for Bloomerang donor surveys?
+  # SortIndex             integer($int32)
+  # Name                  string
+  # IsDefault             boolean
+  # IsActive              boolean
+  class EmailInterest < Base
+    ### Fetch all email interests
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Email%20Interests/get_emailInterests
+    #
+    # Params:
+    # skip      integer, default: 0,  simple paging system
+    # take      integer, default: 50, simple paging system
+    # id        array[integer], separated by pipes: "1|2|3"
+    # isActive  boolean
+    def fetch(params = {})
+      get("emailInterests", params)
+    end
+
+    ### Fetch an email interest by ID
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Email%20Interests/get_emailInterest__id_
+    #
+    # Params:
+    # id  integer
+    def get(id)
+      get("emailInterest/#{id}")
+    end
+  end
+end

data/lib/bloomerang/fund.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Bloomerang
+  ### Bloomerang::Fund
+  # Id                          integer($int64)
+  # GeneralLedgerClass          string, The class label for this fund in the general ledger (quickbooks)
+  # DefaultQuickbooksAccountId  integer($int64), The ID of the general ledger (quickbooks) account to which this fund will default
+  # QuickbooksAccountIds        array[integer], The IDs of all general ledger (quickbooks) accounts associated with this fund
+  # SortIndex                   integer($int32)
+  # Name                        string
+  # IsDefault                   boolean
+  # IsActive                    boolean
+  class Fund < Base
+    ### Fetch all funds
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Funds/get_funds
+    #
+    # Params:
+    # skip          integer, default: 0,  simple paging system
+    # take          integer, default: 50, simple paging system
+    # id            array[integer], separated by pipes: "1|2|3"
+    # isActive      boolean
+    # search        string, Filters to funds with names that match any part of the search string
+    def fetch(params = {})
+      get("funds", params)
+    end
+
+    ### Fetch fund by ID
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Funds/get_fund__id_
+    #
+    # Params:
+    # id  integer
+    def get(id)
+      get("fund/#{id}")
+    end
+
+    ### Create fund
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Funds/post_fund
+    #
+    # Params:
+    # body  JSON object, see API for fields
+    def create(body)
+      post("fund", {}, body)
+    end
+
+    ### Update a fund
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Funds/put_fund__id_
+    #
+    # Params:
+    # id    integer
+    # body  JSON object, see API for fields
+    def update(id, body)
+      put("fund/#{id}", {}, body)
+    end
+  end
+end

data/lib/bloomerang/household.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Bloomerang
+  ### Bloomerang::Household
+  ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Households
+  # FullName                string
+  # SortName                string
+  # InformalName            string
+  # FormalName              string
+  # EnvelopeName            string
+  # RecognitionName         string
+  # Id                      integer($int64), The ID of the household used in the API (not to be confused with AccountNumber)
+  # AccountNumber           integer($int64), A user-friendly account number used in the Bloomerang CRM UI (not to be confused with ID).
+  # Type                    HouseholdType, string, Enum: [ Household ]
+  # Status                  AccountStatus, string, Enum: [ Active, Inactive, Deceased ]
+  # HeadId                  integer($int64), The ID of the head of household used in the API (not to be confused with AccountNumber)
+  # MemberIds [...]         array[integer], The IDs of the members of the household used in the API, including the head of household's ID (not to be confused with AccountNumber)
+  # CommunicationRestrictions CommunicationRestriction, string, Enum: [ DoNotCall, DoNotMail, DoNotSolicit ]
+  # AuditTrail                AuditTrail object
+  # IsFavorite                boolean, True if this constituent is a favorite of the current user
+  # EngagementScore           EngagementScore, string, Enum: [ Low, MediumLow, Medium, MediumHigh, High ]
+  class Household < Base
+    ### Fetch all households
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Households/get_households
+    #
+    # Params:
+    # skip            integer, default: 0,  simple paging system
+    # take            integer, default: 50, simple paging system
+    # lastModified    string, date in iso8601 format, Filters to constituents last modified after the specified date
+    # id              array[integer], separated by pipes: "1|2|3"
+    def fetch(params = {})
+      get("households", params)
+    end
+
+    ### Fetch a household by ID
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Households/get_household__id_
+    #
+    # Params:
+    # id  integer
+    def get(id)
+      get("household/#{id}")
+    end
+
+    ### Search for constituents and households
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Constituents/get_constituents_search
+    #
+    # Params:
+    # skip    integer, default: 0,  simple paging system
+    # take    integer, default: 50, simple paging system
+    # search  string, searches on household name and constituent full name, matches any part of string
+    def search(params = {})
+      # TODO: BREAKING CHANGE: query changed to params
+      Constituent.search(params)
+    end
+
+    ### Create a household
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Households/post_household
+    #
+    # Params:
+    # body  JSON object, see API for fields
+    def create(body)
+      post("household", {}, body)
+    end
+
+    ### Update a household
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Households/put_household__id_
+    #
+    # Params:
+    # id    integer
+    # body  JSON object, see API for fields
+    def update(id, body)
+      put("household/#{id}", {}, body)
+    end
+
+    ### Delete a household
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Households/delete_household__id_
+    #
+    # Params:
+    # id  integer
+    def delete(id)
+      delete("household/#{id}")
+    end
+
+    ### Update household communication settings
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Households/put_household__id__updateCommunicationSettings
+    #
+    # Params:
+    # id    integer
+    # body JSON object, see API for fields
+    def update_communication_settings(id, body)
+      put("household/#{id}/updateCommunicationSettings", {}, body)
+    end
+  end
+end

data/lib/bloomerang/interaction.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Bloomerang
+  ### Bloomerang::Interaction
+  ## https://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 https://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[integer], The ID of the attachments on this interaction
+  # LetterAttachmentIds         array[integer], The ID of generated letter attachments on this interaction.
+  # SurveyLapsedResponses       array[string], 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[object], oneOf -> [OneValueAssignment (object), MultipleValueAssignments (object)]
+  # AuditTrail                  AuditTrail  (object)
+  class Interaction < Base
+    ### Fetch all interactions
+    ## https://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[string], Available values : Email, MassEmail, Phone, TextMessage, Mail, InPerson, SocialMedia, Website, Twitter, Other, EngagementSurveyEmail, EngagementSurvey
+    # purpose         array[string], Available values : Acknowledgement, ImpactCultivation, Newsletter, Receipt, Solicitation, SpecialEvent, VolunteerActivity, PledgeReminder, Welcome, BenevonPointOfEntry, BenevonFollowUp, BenevonAskEvent, BenevonOneOnOneAsk, BenevonOngoingCultivation, Other
+    # constituent     array[integer], separated by pipes: "1|2|3"
+    # id              array[integer], separated by pipes: "1|2|3"
+    # orderBy         string, Available values : Id (default), CreatedDate, LastModifiedDate
+    # orderDirection  string, Available values : Asc, Desc
+    def fetch(params = {})
+      get("interactions", params)
+    end
+
+    ### Create an interaction
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Interactions/post_interaction
+    #
+    # Params:
+    # body  JSON object, see API for fields
+    def create(body)
+      post("interaction", {}, body)
+    end
+
+    ### Fetch interaction by ID
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Interactions/get_interaction__id_
+    #
+    # Params:
+    # id  integer
+    def get(id)
+      get("interaction/#{id}")
+    end
+
+    ### Update interaction
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Interactions/put_interaction__id_
+    #
+    # Params:
+    # id    integer
+    # body  JSON object, see API for fields
+    def update(id, body)
+      put("interaction/#{id}", {}, body)
+    end
+
+    ### Delete interaction
+    ## https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Interactions/delete_interaction__id_
+    #
+    # Params:
+    # id  integer
+    def delete(id)
+      delete("interaction/#{id}")
+    end
+  end
+end