Class: Mailtrap::ContactExportsAPI

Inherits:

Object

• Object
• Mailtrap::ContactExportsAPI

Includes:

BaseAPI

Defined in:

lib/mailtrap/contact_exports_api.rb

Instance Attribute Summary

Attributes included from BaseAPI

#account_id, #client

Instance Method Summary

• #create(options) ⇒ ContactExport

  Creates a new contact export.

• #get(export_id) ⇒ ContactExport

  Retrieves a specific contact export.

Methods included from BaseAPI

included, #initialize

Instance Method Details

#create(options) ⇒ ContactExport

Creates a new contact export

Parameters:

• options (Hash) —

  The export parameters

Options Hash (options):

• :filters (Array<Hash>) —

  Filters to apply to the export

  • ‘{ name: ’list_id’, operator: ‘equal’, value: [Integer, …] }‘

  • ‘{ name: ’subscription_status’, operator: ‘equal’, value: ‘subscribed’ | ‘unsubscribed’ }‘

Returns:

• (ContactExport) —

  Created contact export 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_exports_api.rb', line 30

def create(options)
  base_create(options)
end

#get(export_id) ⇒ ContactExport

Retrieves a specific contact export

Parameters:

• export_id (Integer) —

  The contact export ID

Returns:

• (ContactExport) —

  Contact export 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

# File 'lib/mailtrap/contact_exports_api.rb', line 18

def get(export_id)
  base_get(export_id)
end