Class: Bloomerang::CustomField

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

Overview

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 Method Summary collapse

Methods inherited from Base

delete, get, post, put

Class Method Details

.categories(type) ⇒ Object

Fetch CustomField Categories by type bloomerang.co/product/integrations-data-management/api/rest-api/#/Custom%20Fields/get_customFieldCategories__type__

Params: type string, Available values: Constituent, Transaction, Interaction, Note, Benevon



21
22
23
 
# File 'lib/bloomerang/custom_field.rb', line 21

def self.categories(type)
  get("customFieldCategories/#{type}/")
end

.fields(type, params = {}) ⇒ Object

Fetch CustomFields by type 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



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

def self.fields(type, params = {})
  get("customFields/#{type}/", params)
end

.values(type, params = {}) ⇒ Object

Fetch CustomValues by type 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



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

def self.values(type, params = {})
  get("customValues/#{type}/", params)
end

.values_by_field(type, field_id, params = {}) ⇒ Object

Fetch CustomValues by type for the given field 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



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

def self.values_by_field(type, field_id, params = {})
  get("customValues/#{type}/#{field_id}", params)
end