Class: Mailgun::AnalyticsTags

Inherits:
Object
  • Object
show all
Includes:
ApiVersionChecker
Defined in:
lib/mailgun/tags/analytics_tags.rb

Overview

A Mailgun::AnalyticsTags object is a simple CRUD interface to Mailgun Tags. Uses Mailgun

Instance Method Summary collapse

Methods included from ApiVersionChecker

included

Constructor Details

#initialize(client = Mailgun::Client.new(Mailgun.api_key, Mailgun.api_host || 'api.mailgun.net', 'v1')) ⇒ AnalyticsTags

Public: creates a new Mailgun::AnalyticsTags instance. Defaults to Mailgun::Client



10
11
12
 
# File 'lib/mailgun/tags/analytics_tags.rb', line 10

def initialize(client = Mailgun::Client.new(Mailgun.api_key, Mailgun.api_host || 'api.mailgun.net', 'v1'))
  @client = client
end

Instance Method Details

#limits ⇒ Object 



26
27
28
 
# File 'lib/mailgun/tags/analytics_tags.rb', line 26

def limits
  @client.get('analytics/tags/limits').to_h
end

#list(options = {}) ⇒ Object 



18
19
20
 
# File 'lib/mailgun/tags/analytics_tags.rb', line 18

def list(options = {})
  @client.post('analytics/tags', options).to_h['items']
end

#remove(tag) ⇒ Object 



22
23
24
 
# File 'lib/mailgun/tags/analytics_tags.rb', line 22

def remove(tag)
  @client.delete('analytics/tags', { tag: tag }, body_params: true).to_h['message'] == 'Tag deleted'
end

#update(tag, description) ⇒ Object 



14
15
16
 
# File 'lib/mailgun/tags/analytics_tags.rb', line 14

def update(tag, description)
  @client.put('analytics/tags', { tag: tag, description: description }, body_params: true ).to_h['message'] == 'Tag updated'
end