Module: MailchimpAPI::CampaignFolders::APIs

Includes:
Pagination::ListEachItemHelper
Included in:
MailchimpAPI::CampaignFolders, MailchimpAPI::CampaignFolders
Defined in:
lib/mailchimp-api/resources/campaign_folders.rb

Overview

Module with endpoints for CampaignFolders APIs

Instance Method Summary collapse

Instance Method Details

#create(query: nil, body: nil, headers: nil) ⇒ Response

Create a new campaign folder

Examples:

Create a new folder

campaign_folders.create(body: {name: 'Product Updates'})

Parameters:

  • query (Hash) (defaults to: nil) —

    Optional query parameters

  • body (Hash) (defaults to: nil) —

    Campaign folder attributes

  • headers (Hash) (defaults to: nil) —

    Optional request headers

Options Hash (body:):

  • :name (String) —

    The name of the folder

Returns:

  • (Response) —

    API response containing the created folder



31
32
33
34
 
# File 'lib/mailchimp-api/resources/campaign_folders.rb', line 31

def create(query: nil, body: nil, headers: nil)
  path = "/campaign-folders"
  client.post(path, query: query, body: body, headers: headers)
end

#delete(folder_id, query: nil, body: nil, headers: nil) ⇒ Response

Delete a campaign folder

Examples:

Delete a campaign folder

campaign_folders.delete('folder789')

Parameters:

  • folder_id (String) —

    The ID of the folder

  • query (Hash) (defaults to: nil) —

    Optional query parameters

  • body (Hash) (defaults to: nil) —

    Optional request body

  • headers (Hash) (defaults to: nil) —

    Optional request headers

Returns:



57
58
59
60
 
# File 'lib/mailchimp-api/resources/campaign_folders.rb', line 57

def delete(folder_id, query: nil, body: nil, headers: nil)
  path = "/campaign-folders/#{folder_id}"
  client.delete(path, query: query, body: body, headers: headers)
end

#each(query: nil, body: nil, headers: nil) {|Hash| ... } ⇒ Object

Iterate through all campaign folders

Examples:

Iterate through all campaign folders

campaign_folders.each do |folder|
  puts interest[:name]
end

Parameters:

  • list_id (String) —

    The ID of the campaign folders

  • query (Hash) (defaults to: nil) —

    Optional query parameters

  • body (Hash) (defaults to: nil) —

    Optional request body

  • headers (Hash) (defaults to: nil) —

    Optional request headers

Yields:

  • (Hash) —

    Each campaign folder



87
88
89
 
# File 'lib/mailchimp-api/resources/campaign_folders.rb', line 87

def each(query: nil, body: nil, headers: nil, &block)
  list_each_item(:folders, query: query, body: body, headers: headers, &block)
end

#list(query: nil, body: nil, headers: nil) ⇒ Response

List campaign folders

Examples:

Get campaign folders

campaign_folders.list

Parameters:

  • query (Hash) (defaults to: nil) —

    Optional query parameters

  • body (Hash) (defaults to: nil) —

    Optional request body

  • headers (Hash) (defaults to: nil) —

    Optional request headers

Returns:

  • (Response) —

    API response containing campaign folders



18
19
20
21
 
# File 'lib/mailchimp-api/resources/campaign_folders.rb', line 18

def list(query: nil, body: nil, headers: nil)
  path = "/campaign-folders"
  client.get(path, query: query, body: body, headers: headers)
end

#show(folder_id, query: nil, body: nil, headers: nil) ⇒ Response

Show details for a specific campaign folder

Examples:

Get details for a campaign folder

campaign_folders.show('folder789')

Parameters:

  • folder_id (String) —

    The ID of the campaign folder

  • query (Hash) (defaults to: nil) —

    Optional query parameters

  • body (Hash) (defaults to: nil) —

    Optional request body

  • headers (Hash) (defaults to: nil) —

    Optional request headers

Returns:

  • (Response) —

    API response containing campaign folder details



44
45
46
47
 
# File 'lib/mailchimp-api/resources/campaign_folders.rb', line 44

def show(folder_id, query: nil, body: nil, headers: nil)
  path = "/campaign-folders/#{folder_id}"
  client.get(path, query: query, body: body, headers: headers)
end

#update(folder_id, query: nil, body: nil, headers: nil) ⇒ Response

Update a campaign folder

Examples:

Update a campaign folder name

campaign_folders.update('folder789', body: {
  name: 'Updated Interest Name'
})

Parameters:

  • folder_id (String) —

    The ID of the folder

  • query (Hash) (defaults to: nil) —

    Optional query parameters

  • body (Hash) (defaults to: nil) —

    Updated campaign folder attributes

  • headers (Hash) (defaults to: nil) —

    Optional request headers

Returns:

  • (Response) —

    API response containing updated campaign folder



72
73
74
75
 
# File 'lib/mailchimp-api/resources/campaign_folders.rb', line 72

def update(folder_id, query: nil, body: nil, headers: nil)
  path = "/campaign-folders/#{folder_id}"
  client.patch(path, query: query, body: body, headers: headers)
end