class MailchimpMarketing::AutomationsApi
Attributes
api_client[RW]
Public Class Methods
new(api_client)
click to toggle source
# File lib/MailchimpMarketing/api/automations_api.rb, line 19 def initialize(api_client) @api_client = api_client end
Public Instance Methods
add_workflow_email_subscriber(workflow_id, workflow_email_id, body, opts = {})
click to toggle source
Add subscriber to workflow email
# File lib/MailchimpMarketing/api/automations_api.rb, line 270 def add_workflow_email_subscriber(workflow_id, workflow_email_id, body, opts = {}) fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil? fail ArgumentError, "Missing required param: 'workflow_email_id'" if workflow_email_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 = '/automations/{workflow_id}/emails/{workflow_email_id}/queue'.sub('{' + 'workflow_id' + '}', workflow_id.to_s).sub('{' + 'workflow_email_id' + '}', workflow_email_id.to_s) data = @api_client.call_api(:POST, local_var_path, :query_params => query_params, :body => post_body) return data end
archive(workflow_id, opts = {})
click to toggle source
Archive automation
# File lib/MailchimpMarketing/api/automations_api.rb, line 24 def archive(workflow_id, opts = {}) fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil? query_params = {} post_body = nil local_var_path = '/automations/{workflow_id}/actions/archive'.sub('{' + 'workflow_id' + '}', workflow_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 automation
# File lib/MailchimpMarketing/api/automations_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 = '/automations' data = @api_client.call_api(:POST, local_var_path, :query_params => query_params, :body => post_body) return data end
delete_workflow_email(workflow_id, workflow_email_id, opts = {})
click to toggle source
Delete workflow email
# File lib/MailchimpMarketing/api/automations_api.rb, line 38 def delete_workflow_email(workflow_id, workflow_email_id, opts = {}) fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil? fail ArgumentError, "Missing required param: 'workflow_email_id'" if workflow_email_id.nil? query_params = {} post_body = nil local_var_path = '/automations/{workflow_id}/emails/{workflow_email_id}'.sub('{' + 'workflow_id' + '}', workflow_id.to_s).sub('{' + 'workflow_email_id' + '}', workflow_email_id.to_s) data = @api_client.call_api(:DELETE, local_var_path, :query_params => query_params, :body => post_body) return data end
get(workflow_id, opts = {})
click to toggle source
Get automation info
# File lib/MailchimpMarketing/api/automations_api.rb, line 77 def get(workflow_id, opts = {}) fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_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 = '/automations/{workflow_id}'.sub('{' + 'workflow_id' + '}', workflow_id.to_s) data = @api_client.call_api(:GET, local_var_path, :query_params => query_params, :body => post_body) return data end
get_removed_workflow_email_subscriber(workflow_id, subscriber_hash, opts = {})
click to toggle source
Get subscriber removed from workflow
# File lib/MailchimpMarketing/api/automations_api.rb, line 167 def get_removed_workflow_email_subscriber(workflow_id, subscriber_hash, opts = {}) fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil? fail ArgumentError, "Missing required param: 'subscriber_hash'" if subscriber_hash.nil? query_params = {} post_body = nil local_var_path = '/automations/{workflow_id}/removed-subscribers/{subscriber_hash}'.sub('{' + 'workflow_id' + '}', workflow_id.to_s).sub('{' + 'subscriber_hash' + '}', subscriber_hash.to_s) data = @api_client.call_api(:GET, local_var_path, :query_params => query_params, :body => post_body) return data end
get_workflow_email(workflow_id, workflow_email_id, opts = {})
click to toggle source
Get workflow email info
# File lib/MailchimpMarketing/api/automations_api.rb, line 107 def get_workflow_email(workflow_id, workflow_email_id, opts = {}) fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil? fail ArgumentError, "Missing required param: 'workflow_email_id'" if workflow_email_id.nil? query_params = {} post_body = nil local_var_path = '/automations/{workflow_id}/emails/{workflow_email_id}'.sub('{' + 'workflow_id' + '}', workflow_id.to_s).sub('{' + 'workflow_email_id' + '}', workflow_email_id.to_s) data = @api_client.call_api(:GET, local_var_path, :query_params => query_params, :body => post_body) return data end
get_workflow_email_subscriber(workflow_id, workflow_email_id, subscriber_hash, opts = {})
click to toggle source
Get automated email subscriber
# File lib/MailchimpMarketing/api/automations_api.rb, line 137 def get_workflow_email_subscriber(workflow_id, workflow_email_id, subscriber_hash, opts = {}) fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil? fail ArgumentError, "Missing required param: 'workflow_email_id'" if workflow_email_id.nil? fail ArgumentError, "Missing required param: 'subscriber_hash'" if subscriber_hash.nil? query_params = {} post_body = nil local_var_path = '/automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash}'.sub('{' + 'workflow_id' + '}', workflow_id.to_s).sub('{' + 'workflow_email_id' + '}', workflow_email_id.to_s).sub('{' + 'subscriber_hash' + '}', subscriber_hash.to_s) data = @api_client.call_api(:GET, local_var_path, :query_params => query_params, :body => post_body) return data end
get_workflow_email_subscriber_queue(workflow_id, workflow_email_id, opts = {})
click to toggle source
List automated email subscribers
# File lib/MailchimpMarketing/api/automations_api.rb, line 122 def get_workflow_email_subscriber_queue(workflow_id, workflow_email_id, opts = {}) fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil? fail ArgumentError, "Missing required param: 'workflow_email_id'" if workflow_email_id.nil? query_params = {} post_body = nil local_var_path = '/automations/{workflow_id}/emails/{workflow_email_id}/queue'.sub('{' + 'workflow_id' + '}', workflow_id.to_s).sub('{' + 'workflow_email_id' + '}', workflow_email_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 automations
# File lib/MailchimpMarketing/api/automations_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 "status", must be one of save, paused, sending' if opts[:'status'] && !['save', 'paused', 'sending'].include?(opts[:'status']) query_params = {} query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? 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[:'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[:'before_start_time'] = opts[:'before_start_time'] if !opts[:'before_start_time'].nil? query_params[:'since_start_time'] = opts[:'since_start_time'] if !opts[:'since_start_time'].nil? query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil? post_body = nil local_var_path = '/automations' data = @api_client.call_api(:GET, local_var_path, :query_params => query_params, :body => post_body) return data end
list_all_workflow_emails(workflow_id, opts = {})
click to toggle source
List automated emails
# File lib/MailchimpMarketing/api/automations_api.rb, line 93 def list_all_workflow_emails(workflow_id, opts = {}) fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil? query_params = {} post_body = nil local_var_path = '/automations/{workflow_id}/emails'.sub('{' + 'workflow_id' + '}', workflow_id.to_s) data = @api_client.call_api(:GET, local_var_path, :query_params => query_params, :body => post_body) return data end
list_workflow_email_subscribers_removed(workflow_id, opts = {})
click to toggle source
List subscribers removed from workflow
# File lib/MailchimpMarketing/api/automations_api.rb, line 153 def list_workflow_email_subscribers_removed(workflow_id, opts = {}) fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil? query_params = {} post_body = nil local_var_path = '/automations/{workflow_id}/removed-subscribers'.sub('{' + 'workflow_id' + '}', workflow_id.to_s) data = @api_client.call_api(:GET, local_var_path, :query_params => query_params, :body => post_body) return data end
pause_all_emails(workflow_id, opts = {})
click to toggle source
Pause automation emails
# File lib/MailchimpMarketing/api/automations_api.rb, line 212 def pause_all_emails(workflow_id, opts = {}) fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil? query_params = {} post_body = nil local_var_path = '/automations/{workflow_id}/actions/pause-all-emails'.sub('{' + 'workflow_id' + '}', workflow_id.to_s) data = @api_client.call_api(:POST, local_var_path, :query_params => query_params, :body => post_body) return data end
pause_workflow_email(workflow_id, workflow_email_id, opts = {})
click to toggle source
Pause automated email
# File lib/MailchimpMarketing/api/automations_api.rb, line 240 def pause_workflow_email(workflow_id, workflow_email_id, opts = {}) fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil? fail ArgumentError, "Missing required param: 'workflow_email_id'" if workflow_email_id.nil? query_params = {} post_body = nil local_var_path = '/automations/{workflow_id}/emails/{workflow_email_id}/actions/pause'.sub('{' + 'workflow_id' + '}', workflow_id.to_s).sub('{' + 'workflow_email_id' + '}', workflow_email_id.to_s) data = @api_client.call_api(:POST, local_var_path, :query_params => query_params, :body => post_body) return data end
remove_workflow_email_subscriber(workflow_id, body, opts = {})
click to toggle source
Remove subscriber from workflow
# File lib/MailchimpMarketing/api/automations_api.rb, line 286 def remove_workflow_email_subscriber(workflow_id, body, opts = {}) fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_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 = '/automations/{workflow_id}/removed-subscribers'.sub('{' + 'workflow_id' + '}', workflow_id.to_s) data = @api_client.call_api(:POST, local_var_path, :query_params => query_params, :body => post_body) return data end
start_all_emails(workflow_id, opts = {})
click to toggle source
Start automation emails
# File lib/MailchimpMarketing/api/automations_api.rb, line 226 def start_all_emails(workflow_id, opts = {}) fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil? query_params = {} post_body = nil local_var_path = '/automations/{workflow_id}/actions/start-all-emails'.sub('{' + 'workflow_id' + '}', workflow_id.to_s) data = @api_client.call_api(:POST, local_var_path, :query_params => query_params, :body => post_body) return data end
start_workflow_email(workflow_id, workflow_email_id, opts = {})
click to toggle source
Start automated email
# File lib/MailchimpMarketing/api/automations_api.rb, line 255 def start_workflow_email(workflow_id, workflow_email_id, opts = {}) fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil? fail ArgumentError, "Missing required param: 'workflow_email_id'" if workflow_email_id.nil? query_params = {} post_body = nil local_var_path = '/automations/{workflow_id}/emails/{workflow_email_id}/actions/start'.sub('{' + 'workflow_id' + '}', workflow_id.to_s).sub('{' + 'workflow_email_id' + '}', workflow_email_id.to_s) data = @api_client.call_api(:POST, local_var_path, :query_params => query_params, :body => post_body) return data end
update_workflow_email(workflow_id, workflow_email_id, body, opts = {})
click to toggle source
Update workflow email
# File lib/MailchimpMarketing/api/automations_api.rb, line 182 def update_workflow_email(workflow_id, workflow_email_id, body, opts = {}) fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil? fail ArgumentError, "Missing required param: 'workflow_email_id'" if workflow_email_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 = '/automations/{workflow_id}/emails/{workflow_email_id}'.sub('{' + 'workflow_id' + '}', workflow_id.to_s).sub('{' + 'workflow_email_id' + '}', workflow_email_id.to_s) data = @api_client.call_api(:PATCH, local_var_path, :query_params => query_params, :body => post_body) return data end