Class: Bloomerang::Household

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

Overview

Bloomerang::Household 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, 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 Method Summary collapse

Methods inherited from Base

get, post, put

Class Method Details

.create(body) ⇒ Object

Create a household bloomerang.co/product/integrations-data-management/api/rest-api/#/Households/post_household

Params: body JSON object, see API for fields



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

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

.delete(id) ⇒ Object

Delete a household bloomerang.co/product/integrations-data-management/api/rest-api/#/Households/delete_household_id

Params: id integer



79
80
81
 
# File 'lib/bloomerang/household.rb', line 79

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

.fetch(params = {}) ⇒ Object

Fetch all households 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, separated by pipes: “1|2|3”



31
32
33
 
# File 'lib/bloomerang/household.rb', line 31

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

.search(params = {}) ⇒ Object

Search for constituents and households 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



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

def self.search(params = {})
  Constituent.search(params)
end

.show(id) ⇒ Object

Fetch a household by ID bloomerang.co/product/integrations-data-management/api/rest-api/#/Households/get_household_id

Params: id integer



40
41
42
 
# File 'lib/bloomerang/household.rb', line 40

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

.update(id, body) ⇒ Object

Update a household bloomerang.co/product/integrations-data-management/api/rest-api/#/Households/put_household_id

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



70
71
72
 
# File 'lib/bloomerang/household.rb', line 70

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

.update_communication_settings(id, body) ⇒ Object

Update household communication settings bloomerang.co/product/integrations-data-management/api/rest-api/#/Households/put_household__id__updateCommunicationSettings

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



89
90
91
 
# File 'lib/bloomerang/household.rb', line 89

def self.update_communication_settings(id, body)
  put("household/#{id}/updateCommunicationSettings", {}, body)
end