class MailchimpTransactional::TagsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/MailchimpTransactional/api/tags_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

all_time_series(body = {}) click to toggle source

View all tags history Return the recent history (hourly stats for the last 30 days) for all tags. @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20028>, Fixnum, Hash)>] Array<InlineResponse20028> data, response status code and response headers

# File lib/MailchimpTransactional/api/tags_api.rb, line 28
def all_time_series(body = {})
  data = @api_client.call_api(:POST, '/tags/all-time-series', body)
  data
end
delete(body = {}) click to toggle source

Delete tag Deletes a tag permanently. Deleting a tag removes the tag from any messages that have been sent, and also deletes the tag&#39;s stats. There is no way to undo this operation, so use it carefully. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20055, Fixnum, Hash)>] InlineResponse20055 data, response status code and response headers

# File lib/MailchimpTransactional/api/tags_api.rb, line 38
def delete(body = {})
  data = @api_client.call_api(:POST, '/tags/delete', body)
  data
end
info(body = {}) click to toggle source

Get tag info Return more detailed information about a single tag, including aggregates of recent stats. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20056, Fixnum, Hash)>] InlineResponse20056 data, response status code and response headers

# File lib/MailchimpTransactional/api/tags_api.rb, line 48
def info(body = {})
  data = @api_client.call_api(:POST, '/tags/info', body)
  data
end
list(body = {}) click to toggle source

List tags Return all of the user-defined tag information. @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20054>, Fixnum, Hash)>] Array<InlineResponse20054> data, response status code and response headers

# File lib/MailchimpTransactional/api/tags_api.rb, line 58
def list(body = {})
  data = @api_client.call_api(:POST, '/tags/list', body)
  data
end
time_series(body = {}) click to toggle source

View tag history Return the recent history (hourly stats for the last 30 days) for a tag. @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20028>, Fixnum, Hash)>] Array<InlineResponse20028> data, response status code and response headers

# File lib/MailchimpTransactional/api/tags_api.rb, line 68
def time_series(body = {})
  data = @api_client.call_api(:POST, '/tags/time-series', body)
  data
end