Module: Crm::Core::Mixins::Modifiable

Extended by:

ActiveSupport::Concern, ClassMethods

Included in:

Account, Activity, Crm::Collection, Crm::Contact, Event, EventContact, Mailing, Type

Defined in:

lib/crm/core/mixins/modifiable.rb

Overview

Modifiable is a collection of methods that are used to .create, #update and #delete a JustRelate WebCRM item.

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary

• #delete ⇒ Object (also: #destroy)

  Deletes this item.

• #update(attributes = {}) ⇒ self

  Updates the attributes of this item.

Methods included from ClassMethods

create

Instance Method Details

#delete ⇒ Object Also known as: destroy

Deletes this item.

Raises:

• (Errors::ResourceConflict) —

  if the item has been changed concurrently. Reload it, review the changes and retry.

# File 'lib/crm/core/mixins/modifiable.rb', line 62

def delete
  RestApi.instance.delete(path, nil, if_match_header)
  nil
end

#update(attributes = {}) ⇒ self

Updates the attributes of this item.

Examples:

contact.last_name
# => 'Smith'

contact.locality
# => 'New York'

contact.update({locality: 'Boston'})
# => Crm::Contact

contact.last_name
# => 'Smith'

contact.locality
# => 'Boston'

Parameters:

• attributes (Hash{String, Symbol => String}) (defaults to: {}) —

  the new attributes.

Returns:

• (self) —

  the updated item.

Raises:

• (Errors::InvalidKeys) —

  if attributes contains unknown attribute names.

• (Errors::InvalidValues) —

  if attributes contains incorrect values.

• (Errors::ResourceConflict) —

  if the item has been changed concurrently. Reload it, review the changes and retry.

# File 'lib/crm/core/mixins/modifiable.rb', line 53

def update(attributes = {})
  load_attributes(RestApi.instance.put(path, attributes, if_match_header))
end