Class: Crm::Type

Inherits:

Core::BasicResource

• Object
• Core::BasicResource
• Crm::Type

Extended by:

Core::Mixins::Findable::ClassMethods, Core::Mixins::Modifiable::ClassMethods

Includes:

Core::Mixins::ChangeLoggable, Core::Mixins::Findable, Core::Mixins::Inspectable, Core::Mixins::Modifiable

Defined in:

lib/crm/type.rb

Overview

An Infopark WebCRM type defines a set of attributes associated with every instance of the type.

Examples:

Listing all attributes of a type

account_type = Crm::Type.find('account')
# => Crm::Type

# Listing all standard attributes
account_type.standard_attribute_definitions.keys
# => ['name', 'created_at', 'updated_at', ...]

# Listing all custom attributes
account_type.attribute_definitions.keys
# => ['custom_plan', ...]

Inspecting an attribute definition of a type

account_type.standard_attribute_definitions["name"]
# => {
#  'attribute_type' => 'string',
#  'create'         => true,
#  'mandatory'      => true,
#  'read'           => true,
#  'title'          => 'Name',
#  'update'         => true,
# }

Adding a new custom attribute to a type

account_type.attribute_definitions.keys
# => ['custom_plan']

# Add a new custom attribute named "custom_shipping_details"
attr_defs = account_type.attribute_definitions.merge({
  custom_shipping_details: {
    attribute_type: 'text',
    title: 'Shipping Details',
  }
})
account_type.update({
  attribute_definitions: attr_defs,
})
# => Crm::Type

account_type.attribute_definitions.keys
# => ['custom_plan', 'custom_shipping_details']

Removing a custom attribute from a type

account_type.attribute_definitions.keys
# => ['custom_plan', 'custom_shipping_details']

attr_defs = account_type.attribute_definitions.except('custom_shipping_details')
account_type.update({
  attribute_definitions: attr_defs,
})
# => Crm::Type

account_type.attribute_definitions.keys
# => ['custom_plan']

Class Method Summary

• .all(include_deleted: false) ⇒ Array<Type>

  Returns all types.

Methods included from Core::Mixins::Findable::ClassMethods

find

Methods included from Core::Mixins::Modifiable::ClassMethods

create

Methods included from Core::Mixins::Inspectable

#inspect

Methods included from Core::Mixins::ChangeLoggable

#changes

Methods included from Core::Mixins::Modifiable

#delete, #deleted?, #undelete, #update

Methods inherited from Core::BasicResource

base_type, #eql?, #id, path, #path, #reload, resource_name, #type

Methods included from Core::Mixins::AttributeProvider

#[], #attributes, #initialize, #method_missing, #methods, #raw, #respond_to_missing?

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Crm::Core::Mixins::AttributeProvider

Class Method Details

.all(include_deleted: false) ⇒ Array<Type>

Returns all types.

# File 'lib/crm/type.rb', line 72

def self.all(include_deleted: false)
  Core::RestApi.instance.get('types', { include_deleted: include_deleted }).map do |item|
    new(item)
  end
end