Class: Mailtrap::ContactEventsAPI

Inherits:

Object

• Object
• Mailtrap::ContactEventsAPI

Includes:

BaseAPI

Defined in:

lib/mailtrap/contact_events_api.rb

Instance Attribute Summary

Attributes included from BaseAPI

#account_id, #client

Instance Method Summary

• #create(contact_identifier, options) ⇒ ContactEvent

  Creates a contact event.

Methods included from BaseAPI

included, #initialize

Instance Method Details

#create(contact_identifier, options) ⇒ ContactEvent

Creates a contact event

Parameters:

• contact_identifier (String) —

  The contact UUID or email address

• options (Hash) —

  The event parameters

Options Hash (options):

• :name (String) —

  The event name (max 255 characters)

• :params (Hash) —

  A hash of string keys and scalar values

Returns:

• (ContactEvent) —

  Created contact event object

Raises:

• (Mailtrap::Error) —

  If the API request fails with a client or server error

• (Mailtrap::AuthorizationError) —

  If the API key is invalid

• (Mailtrap::RejectionError) —

  If the server refuses to process the request

• (Mailtrap::RateLimitError) —

  If too many requests are made

• (ArgumentError) —

  If invalid options are provided

# File 'lib/mailtrap/contact_events_api.rb', line 22

def create(contact_identifier, options)
  validate_options!(options, supported_options)
  response = client.post(base_path(contact_identifier), options)
  build_entity(response, ContactEvent)
end