Class: Bloomerang::Address

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

Overview

Bloomerang::Address bloomerang.co/product/integrations-data-management/api/rest-api/#/Addresses Id integer($int64) AccountId integer($int64) The ID of the constituent used in the API (not to be confused with accountNumber) Type AddressType Enum: [ Home, Vacation, Work ] Street string City string State string Must match a state in the Bloomerang CRM PostalCode string Country string Must match a country in the Bloomerang CRM IsPrimary boolean IsBad boolean StateAbbreviation string The 2-3 letter abbreviation for the state/province CountryCode string The 2 letter ISO code for the country

Class Method Summary collapse

Methods inherited from Base

get, post, put

Class Method Details

.create(body) ⇒ Object

Create an address bloomerang.co/product/integrations-data-management/api/rest-api/#/Addresses/post_address

Params: body see API for fields



47
48
49
 
# File 'lib/bloomerang/address.rb', line 47

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

.delete(id) ⇒ Object

Delete an address bloomerang.co/product/integrations-data-management/api/rest-api/#/Addresses/delete_address_id

Params: id integer



66
67
68
 
# File 'lib/bloomerang/address.rb', line 66

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

.fetch(params = {}) ⇒ Object

Fetch all addresses bloomerang.co/product/integrations-data-management/api/rest-api/#/Addresses/get_addresses

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”



29
30
31
 
# File 'lib/bloomerang/address.rb', line 29

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

.show(id) ⇒ Object

Show an address bloomerang.co/product/integrations-data-management/api/rest-api/#/Addresses/get_address_id

Params: id integer



38
39
40
 
# File 'lib/bloomerang/address.rb', line 38

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

.update(id, body) ⇒ Object

Update an address bloomerang.co/product/integrations-data-management/api/rest-api/#/Addresses/put_address_id

Params: id integer body see API for fields



57
58
59
 
# File 'lib/bloomerang/address.rb', line 57

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