class MailchimpMarketing::CampaignsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client) click to toggle source
# File lib/MailchimpMarketing/api/campaigns_api.rb, line 19
def initialize(api_client)
  @api_client = api_client
end

Public Instance Methods

add_feedback(campaign_id, body, opts = {}) click to toggle source

Add campaign feedback

# File lib/MailchimpMarketing/api/campaigns_api.rb, line 340
def add_feedback(campaign_id, body, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'body'" if body.nil?

  query_params = {}
  post_body = @api_client.object_to_http_body(body)

  local_var_path = '/campaigns/{campaign_id}/feedback'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
cancel_send(campaign_id, opts = {}) click to toggle source

Cancel campaign

# File lib/MailchimpMarketing/api/campaigns_api.rb, line 212
def cancel_send(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/actions/cancel-send'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
create(body, opts = {}) click to toggle source

Add campaign

# File lib/MailchimpMarketing/api/campaigns_api.rb, line 198
def create(body, opts = {})
  fail ArgumentError, "Missing required param: 'body'" if body.nil?

  query_params = {}
  post_body = @api_client.object_to_http_body(body)

  local_var_path = '/campaigns'
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
create_resend(campaign_id, opts = {}) click to toggle source

Resend campaign

# File lib/MailchimpMarketing/api/campaigns_api.rb, line 226
def create_resend(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/actions/create-resend'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
delete_feedback_message(campaign_id, feedback_id, opts = {}) click to toggle source

Delete campaign feedback message

# File lib/MailchimpMarketing/api/campaigns_api.rb, line 38
def delete_feedback_message(campaign_id, feedback_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'feedback_id'" if feedback_id.nil?

  query_params = {}
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/feedback/{feedback_id}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'feedback_id' + '}', feedback_id.to_s)
  data = @api_client.call_api(:DELETE, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
get(campaign_id, opts = {}) click to toggle source

Get campaign info

# File lib/MailchimpMarketing/api/campaigns_api.rb, line 86
def get(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
get_content(campaign_id, opts = {}) click to toggle source

Get campaign content

# File lib/MailchimpMarketing/api/campaigns_api.rb, line 102
def get_content(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/content'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
get_feedback(campaign_id, opts = {}) click to toggle source

List campaign feedback

# File lib/MailchimpMarketing/api/campaigns_api.rb, line 118
def get_feedback(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/feedback'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
get_feedback_message(campaign_id, feedback_id, opts = {}) click to toggle source

Get campaign feedback message

# File lib/MailchimpMarketing/api/campaigns_api.rb, line 134
def get_feedback_message(campaign_id, feedback_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'feedback_id'" if feedback_id.nil?

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/feedback/{feedback_id}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'feedback_id' + '}', feedback_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
get_send_checklist(campaign_id, opts = {}) click to toggle source

Get campaign send checklist

# File lib/MailchimpMarketing/api/campaigns_api.rb, line 151
def get_send_checklist(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/send-checklist'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
list(opts = {}) click to toggle source

List campaigns

# File lib/MailchimpMarketing/api/campaigns_api.rb, line 53
def list(opts = {})
  fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
  fail ArgumentError, 'invalid value for "type", must be one of regular, plaintext, absplit, rss, variate' if opts[:'type'] && !['regular', 'plaintext', 'absplit', 'rss', 'variate'].include?(opts[:'type'])
  fail ArgumentError, 'invalid value for "status", must be one of save, paused, schedule, sending, sent' if opts[:'status'] && !['save', 'paused', 'schedule', 'sending', 'sent'].include?(opts[:'status'])
  fail ArgumentError, 'invalid value for "sort_field", must be one of create_time, send_time' if opts[:'sort_field'] && !['create_time', 'send_time'].include?(opts[:'sort_field'])
  fail ArgumentError, 'invalid value for "sort_dir", must be one of ASC, DESC' if opts[:'sort_dir'] && !['ASC', 'DESC'].include?(opts[:'sort_dir'])

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'before_send_time'] = opts[:'before_send_time'] if !opts[:'before_send_time'].nil?
  query_params[:'since_send_time'] = opts[:'since_send_time'] if !opts[:'since_send_time'].nil?
  query_params[:'before_create_time'] = opts[:'before_create_time'] if !opts[:'before_create_time'].nil?
  query_params[:'since_create_time'] = opts[:'since_create_time'] if !opts[:'since_create_time'].nil?
  query_params[:'list_id'] = opts[:'list_id'] if !opts[:'list_id'].nil?
  query_params[:'folder_id'] = opts[:'folder_id'] if !opts[:'folder_id'].nil?
  query_params[:'member_id'] = opts[:'member_id'] if !opts[:'member_id'].nil?
  query_params[:'sort_field'] = opts[:'sort_field'] if !opts[:'sort_field'].nil?
  query_params[:'sort_dir'] = opts[:'sort_dir'] if !opts[:'sort_dir'].nil?
  post_body = nil

  local_var_path = '/campaigns'
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
pause(campaign_id, opts = {}) click to toggle source

Pause rss campaign

# File lib/MailchimpMarketing/api/campaigns_api.rb, line 240
def pause(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/actions/pause'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
remove(campaign_id, opts = {}) click to toggle source

Delete campaign

# File lib/MailchimpMarketing/api/campaigns_api.rb, line 24
def remove(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:DELETE, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
replicate(campaign_id, opts = {}) click to toggle source

Replicate campaign

# File lib/MailchimpMarketing/api/campaigns_api.rb, line 254
def replicate(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/actions/replicate'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
resume(campaign_id, opts = {}) click to toggle source

Resume rss campaign

# File lib/MailchimpMarketing/api/campaigns_api.rb, line 268
def resume(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/actions/resume'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
schedule(campaign_id, body, opts = {}) click to toggle source

Schedule campaign

# File lib/MailchimpMarketing/api/campaigns_api.rb, line 282
def schedule(campaign_id, body, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'body'" if body.nil?

  query_params = {}
  post_body = @api_client.object_to_http_body(body)

  local_var_path = '/campaigns/{campaign_id}/actions/schedule'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
send(campaign_id, opts = {}) click to toggle source

Send campaign

# File lib/MailchimpMarketing/api/campaigns_api.rb, line 297
def send(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/actions/send'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
send_test_email(campaign_id, body, opts = {}) click to toggle source

Send test email

# File lib/MailchimpMarketing/api/campaigns_api.rb, line 311
def send_test_email(campaign_id, body, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'body'" if body.nil?

  query_params = {}
  post_body = @api_client.object_to_http_body(body)

  local_var_path = '/campaigns/{campaign_id}/actions/test'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
set_content(campaign_id, body, opts = {}) click to toggle source

Set campaign content

# File lib/MailchimpMarketing/api/campaigns_api.rb, line 355
def set_content(campaign_id, body, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'body'" if body.nil?

  query_params = {}
  post_body = @api_client.object_to_http_body(body)

  local_var_path = '/campaigns/{campaign_id}/content'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:PUT, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
unschedule(campaign_id, opts = {}) click to toggle source

Unschedule campaign

# File lib/MailchimpMarketing/api/campaigns_api.rb, line 326
def unschedule(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/actions/unschedule'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
update(campaign_id, body, opts = {}) click to toggle source

Update campaign settings

# File lib/MailchimpMarketing/api/campaigns_api.rb, line 167
def update(campaign_id, body, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'body'" if body.nil?

  query_params = {}
  post_body = @api_client.object_to_http_body(body)

  local_var_path = '/campaigns/{campaign_id}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:PATCH, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
update_feedback_message(campaign_id, feedback_id, body, opts = {}) click to toggle source

Update campaign feedback message

# File lib/MailchimpMarketing/api/campaigns_api.rb, line 182
def update_feedback_message(campaign_id, feedback_id, body, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'feedback_id'" if feedback_id.nil?
  fail ArgumentError, "Missing required param: 'body'" if body.nil?

  query_params = {}
  post_body = @api_client.object_to_http_body(body)

  local_var_path = '/campaigns/{campaign_id}/feedback/{feedback_id}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'feedback_id' + '}', feedback_id.to_s)
  data = @api_client.call_api(:PATCH, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end