Module: MailchimpAPI

Extended by:
Forwardable
Defined in:
lib/mailchimp-api.rb,
lib/mailchimp-api/error.rb,
lib/mailchimp-api/client.rb,
lib/mailchimp-api/config.rb,
lib/mailchimp-api/request.rb,
lib/mailchimp-api/version.rb,
lib/mailchimp-api/resource.rb,
lib/mailchimp-api/response.rb,
lib/mailchimp-api/uri_builder.rb,
lib/mailchimp-api/batch_request.rb,
lib/mailchimp-api/request_executor.rb,
lib/mailchimp-api/client/api_methods.rb,
lib/mailchimp-api/resources/audiences.rb,
lib/mailchimp-api/resources/campaigns.rb,
lib/mailchimp-api/client/batch_methods.rb,
lib/mailchimp-api/network_error_builder.rb,
lib/mailchimp-api/resources/audience/members.rb,
lib/mailchimp-api/resources/campaign/content.rb,
lib/mailchimp-api/resources/campaign_folders.rb,
lib/mailchimp-api/resources/audience/segments.rb,
lib/mailchimp-api/resources/audience/webhooks.rb,
lib/mailchimp-api/failed_request_error_builder.rb,
lib/mailchimp-api/resources/audience/interests.rb,
lib/mailchimp-api/resources/audience/member_tags.rb,
lib/mailchimp-api/pagination/prepare_query_params.rb,
lib/mailchimp-api/resources/audience/merge_fields.rb,
lib/mailchimp-api/pagination/list_each_item_helper.rb,
lib/mailchimp-api/resources/audience/segment_members.rb,
lib/mailchimp-api/resources/audience/interest_categories.rb,
lib/mailchimp-api/resources/audience/utils/subscriber_hash.rb

Overview

Main module for the Mailchimp REST API client

Defined Under Namespace

Modules: Audience, Campaign, Errors, Pagination Classes: Audiences, BatchRequest, CampaignFolders, Campaigns, Client, Config, Error, FailedRequestErrorBuilder, NetworkErrorBuilder, Request, RequestExecutor, Resource, Response, URIBuilder

Constant Summary collapse

API_VERSION =

Current Mailchimp API version

"3.0"
VERSION =

MailchimpAPI gem version

Returns:

  • (String) —

    SemVer gem version

File.read(File.join(File.dirname(__FILE__), "../../VERSION")).strip

Class Attribute Summary collapse

HTTP Methods collapse

Batch Methods collapse

API Resources collapse

Class Attribute Details

.client ⇒ Client

Returns the configured client instance

Examples:

MailchimpAPI.client # => #<MailchimpAPI::Client>

Returns:

  • (Client) —

    the configured client instance

Raises:

  • (RuntimeError) —

    if client is not configured



186
187
188
189
190
 
# File 'lib/mailchimp-api.rb', line 186

def client
  raise "#{name}.client must be set" unless @client

  @client
end

Class Method Details

.audience_interest_categories ⇒ Audience::InterestCategories

Builds audience interest categories API resource

Returns:

See Also:



100
 
# File 'lib/mailchimp-api.rb', line 100

def_delegators :@client, :audience_interest_categories

.audience_interests ⇒ Audience::Interests

Builds audience interests API resource

Returns:

See Also:



107
 
# File 'lib/mailchimp-api.rb', line 107

def_delegators :@client, :audience_interests

.audience_member_tags ⇒ Audience::MemberTags

Builds audience member tags API resource

Returns:

See Also:



114
 
# File 'lib/mailchimp-api.rb', line 114

def_delegators :@client, :audience_member_tags

.audience_members ⇒ Audience::Members

Builds audience members API resource

Returns:

See Also:



121
 
# File 'lib/mailchimp-api.rb', line 121

def_delegators :@client, :audience_members

.audience_merge_fields ⇒ Audience::MergeFields

Builds audience merge_fields API resource

Returns:

See Also:



128
 
# File 'lib/mailchimp-api.rb', line 128

def_delegators :@client, :audience_merge_fields

.audience_segment_members ⇒ Audience::SegmentMembers

Builds audience segment members API resource

Returns:

See Also:



135
 
# File 'lib/mailchimp-api.rb', line 135

def_delegators :@client, :audience_segment_members

.audience_segments ⇒ Audience::Segments

Builds audience segments API resource

Returns:

See Also:



142
 
# File 'lib/mailchimp-api.rb', line 142

def_delegators :@client, :audience_segments

.audience_webhooks ⇒ Audience::Webhooks

Builds audience webhooks API resource

Returns:

See Also:



149
 
# File 'lib/mailchimp-api.rb', line 149

def_delegators :@client, :audience_webhooks

.audiences ⇒ Audiences

Builds audiences API resource

Returns:

  • (Audiences) —

    the audiences APIs collection

See Also:



156
 
# File 'lib/mailchimp-api.rb', line 156

def_delegators :@client, :audiences

.batch ⇒ Response

Sends batch request

Returns:

See Also:



59
 
# File 'lib/mailchimp-api.rb', line 59

def_delegators :@client, :batch

.batch_delete_request ⇒ BatchRequest

Prepares a DELETE request for batch operation

Returns:

See Also:



89
 
# File 'lib/mailchimp-api.rb', line 89

def_delegators :@client, :batch_delete_request

.batch_get_request ⇒ BatchRequest

Prepares a GET request for batch operation

Returns:

See Also:



65
 
# File 'lib/mailchimp-api.rb', line 65

def_delegators :@client, :batch_get_request

.batch_patch_request ⇒ BatchRequest

Prepares a PATCH request for batch operation

Returns:

See Also:



83
 
# File 'lib/mailchimp-api.rb', line 83

def_delegators :@client, :batch_patch_request

.batch_post_request ⇒ BatchRequest

Prepares a POST request for batch operation

Returns:

See Also:



71
 
# File 'lib/mailchimp-api.rb', line 71

def_delegators :@client, :batch_post_request

.batch_put_request ⇒ BatchRequest

Prepares a PUT request for batch operation

Returns:

See Also:



77
 
# File 'lib/mailchimp-api.rb', line 77

def_delegators :@client, :batch_put_request

.campaign_content ⇒ CampaignFolders

Builds campaign_content API resource

Returns:

See Also:



163
 
# File 'lib/mailchimp-api.rb', line 163

def_delegators :@client, :campaign_content

.campaign_folders ⇒ CampaignFolders

Builds campaign_folders API resource

Returns:

See Also:



170
 
# File 'lib/mailchimp-api.rb', line 170

def_delegators :@client, :campaign_folders

.campaigns ⇒ Campaigns

Builds campaigns API resource

Returns:

  • (Campaigns) —

    the campaigns APIs collection

See Also:



177
 
# File 'lib/mailchimp-api.rb', line 177

def_delegators :@client, :campaigns

.delete ⇒ Response

Delegates DELETE requests to the client

Returns:

See Also:



49
 
# File 'lib/mailchimp-api.rb', line 49

def_delegators :@client, :delete

.get ⇒ Response

Delegates GET requests to the client

Returns:

See Also:



31
 
# File 'lib/mailchimp-api.rb', line 31

def_delegators :@client, :get

.patch ⇒ Response

Delegates PATCH requests to the client

Returns:

See Also:



37
 
# File 'lib/mailchimp-api.rb', line 37

def_delegators :@client, :patch

.post ⇒ Response

Delegates POST requests to the client

Returns:

See Also:



25
 
# File 'lib/mailchimp-api.rb', line 25

def_delegators :@client, :post

.put ⇒ Response

Delegates PUT requests to the client

Returns:

See Also:



43
 
# File 'lib/mailchimp-api.rb', line 43

def_delegators :@client, :put