class MailchimpMarketing::CampaignFoldersApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

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

Add campaign folder

# File lib/MailchimpMarketing/api/campaign_folders_api.rb, line 87
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 = '/campaign-folders'
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
get(folder_id, opts = {}) click to toggle source

Get campaign folder

# File lib/MailchimpMarketing/api/campaign_folders_api.rb, line 56
def get(folder_id, opts = {})
  fail ArgumentError, "Missing required param: 'folder_id'" if folder_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 = '/campaign-folders/{folder_id}'.sub('{' + 'folder_id' + '}', folder_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 campaign folders

# File lib/MailchimpMarketing/api/campaign_folders_api.rb, line 38
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

  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?
  post_body = nil

  local_var_path = '/campaign-folders'
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
remove(folder_id, opts = {}) click to toggle source

Delete campaign folder

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

  query_params = {}
  post_body = nil

  local_var_path = '/campaign-folders/{folder_id}'.sub('{' + 'folder_id' + '}', folder_id.to_s)
  data = @api_client.call_api(:DELETE, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end
update(folder_id, body, opts = {}) click to toggle source

Update campaign folder

# File lib/MailchimpMarketing/api/campaign_folders_api.rb, line 72
def update(folder_id, body, opts = {})
  fail ArgumentError, "Missing required param: 'folder_id'" if folder_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 = '/campaign-folders/{folder_id}'.sub('{' + 'folder_id' + '}', folder_id.to_s)
  data = @api_client.call_api(:PATCH, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end