MailchimpMarketing 3.0.2 → 3.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
 - data/Gemfile +1 -1
 - data/MailchimpMarketing.gemspec +2 -2
 - data/README.md +55 -46
 - data/lib/MailchimpMarketing.rb +5 -6
 - data/lib/MailchimpMarketing/api/activity_feed_api.rb +12 -73
 - data/lib/MailchimpMarketing/api/authorized_apps_api.rb +19 -119
 - data/lib/MailchimpMarketing/api/automations_api.rb +129 -723
 - data/lib/MailchimpMarketing/api/batch_webhooks_api.rb +32 -192
 - data/lib/MailchimpMarketing/api/batches_api.rb +25 -154
 - data/lib/MailchimpMarketing/api/campaign_folders_api.rb +32 -192
 - data/lib/MailchimpMarketing/api/campaigns_api.rb +143 -847
 - data/lib/MailchimpMarketing/api/connected_sites_api.rb +31 -189
 - data/lib/MailchimpMarketing/api/conversations_api.rb +35 -215
 - data/lib/MailchimpMarketing/api/dashboard_api.rb +31 -233
 - data/lib/MailchimpMarketing/api/ecommerce_api.rb +446 -2430
 - data/lib/MailchimpMarketing/api/external_auths_api.rb +19 -119
 - data/lib/MailchimpMarketing/api/facebook_ads_api.rb +15 -87
 - data/lib/MailchimpMarketing/api/file_manager_api.rb +70 -435
 - data/lib/MailchimpMarketing/api/landing_pages_api.rb +50 -302
 - data/lib/MailchimpMarketing/api/lists_api.rb +746 -3034
 - data/lib/MailchimpMarketing/api/ping_api.rb +6 -35
 - data/lib/MailchimpMarketing/api/postcards_api.rb +8 -43
 - data/lib/MailchimpMarketing/api/reporting_api.rb +40 -249
 - data/lib/MailchimpMarketing/api/reports_api.rb +152 -947
 - data/lib/MailchimpMarketing/api/root_api.rb +6 -39
 - data/lib/MailchimpMarketing/api/search_campaigns_api.rb +7 -41
 - data/lib/MailchimpMarketing/api/search_members_api.rb +7 -43
 - data/lib/MailchimpMarketing/api/template_folders_api.rb +32 -192
 - data/lib/MailchimpMarketing/api/templates_api.rb +39 -246
 - data/lib/MailchimpMarketing/api/verified_domains_api.rb +31 -180
 - data/lib/MailchimpMarketing/api_client.rb +34 -157
 - data/lib/MailchimpMarketing/api_error.rb +1 -1
 - data/lib/MailchimpMarketing/configuration.rb +1 -1
 - data/lib/MailchimpMarketing/version.rb +2 -2
 - metadata +5 -11
 
| 
         @@ -3,7 +3,7 @@ 
     | 
|
| 
       3 
3 
     | 
    
         | 
| 
       4 
4 
     | 
    
         
             
            #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
         
     | 
| 
       5 
5 
     | 
    
         | 
| 
       6 
     | 
    
         
            -
            OpenAPI spec version: 3.0. 
     | 
| 
      
 6 
     | 
    
         
            +
            OpenAPI spec version: 3.0.9
         
     | 
| 
       7 
7 
     | 
    
         
             
            Contact: apihelp@mailchimp.com
         
     | 
| 
       8 
8 
     | 
    
         
             
            Generated by: https://github.com/swagger-api/swagger-codegen.git
         
     | 
| 
       9 
9 
     | 
    
         
             
            Swagger Codegen version: 2.4.12
         
     | 
| 
         @@ -19,126 +19,40 @@ module MailchimpMarketing 
     | 
|
| 
       19 
19 
     | 
    
         
             
                def initialize(api_client)
         
     | 
| 
       20 
20 
     | 
    
         
             
                  @api_client = api_client
         
     | 
| 
       21 
21 
     | 
    
         
             
                end
         
     | 
| 
       22 
     | 
    
         
            -
                # Archive an automation workflow.
         
     | 
| 
       23 
     | 
    
         
            -
                # Archiving will permanently end your automation and keep the report data. You’ll be able to replicate your archived automation, but you can’t restart it.
         
     | 
| 
       24 
     | 
    
         
            -
                # @param workflow_id The unique id for the Automation workflow.
         
     | 
| 
       25 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       26 
     | 
    
         
            -
                # @return [nil]
         
     | 
| 
       27 
     | 
    
         
            -
                def archive(workflow_id = {}, opts = {})
         
     | 
| 
       28 
     | 
    
         
            -
                  archive_with_http_info(workflow_id, opts)
         
     | 
| 
       29 
     | 
    
         
            -
                  nil
         
     | 
| 
       30 
     | 
    
         
            -
                end
         
     | 
| 
       31 
22 
     | 
    
         | 
| 
       32 
     | 
    
         
            -
                # Archive  
     | 
| 
       33 
     | 
    
         
            -
                 
     | 
| 
       34 
     | 
    
         
            -
             
     | 
| 
       35 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       36 
     | 
    
         
            -
                # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
         
     | 
| 
       37 
     | 
    
         
            -
                def archive_with_http_info(workflow_id, opts = {})
         
     | 
| 
       38 
     | 
    
         
            -
                  # resource path
         
     | 
| 
       39 
     | 
    
         
            -
                  local_var_path = '/automations/{workflow_id}/actions/archive'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
         
     | 
| 
      
 23 
     | 
    
         
            +
                # Archive automation
         
     | 
| 
      
 24 
     | 
    
         
            +
                def archive(workflow_id, opts = {})
         
     | 
| 
      
 25 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil?
         
     | 
| 
       40 
26 
     | 
    
         | 
| 
       41 
     | 
    
         
            -
                  # query parameters
         
     | 
| 
       42 
27 
     | 
    
         
             
                  query_params = {}
         
     | 
| 
       43 
     | 
    
         
            -
             
     | 
| 
       44 
     | 
    
         
            -
                  # header parameters
         
     | 
| 
       45 
     | 
    
         
            -
                  header_params = {}
         
     | 
| 
       46 
     | 
    
         
            -
                  # HTTP header 'Accept' (if needed)
         
     | 
| 
       47 
     | 
    
         
            -
                  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
         
     | 
| 
       48 
     | 
    
         
            -
                  # HTTP header 'Content-Type'
         
     | 
| 
       49 
     | 
    
         
            -
                  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
         
     | 
| 
       50 
     | 
    
         
            -
             
     | 
| 
       51 
     | 
    
         
            -
                  # form parameters
         
     | 
| 
       52 
     | 
    
         
            -
                  form_params = {}
         
     | 
| 
       53 
     | 
    
         
            -
             
     | 
| 
       54 
     | 
    
         
            -
                  # http body (model)
         
     | 
| 
       55 
28 
     | 
    
         
             
                  post_body = nil
         
     | 
| 
       56 
     | 
    
         
            -
             
     | 
| 
      
 29 
     | 
    
         
            +
             
     | 
| 
      
 30 
     | 
    
         
            +
                  local_var_path = '/automations/{workflow_id}/actions/archive'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
         
     | 
| 
       57 
31 
     | 
    
         
             
                  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         
     | 
| 
       58 
     | 
    
         
            -
                    :header_params => header_params,
         
     | 
| 
       59 
32 
     | 
    
         
             
                    :query_params => query_params,
         
     | 
| 
       60 
     | 
    
         
            -
                    : 
     | 
| 
       61 
     | 
    
         
            -
                    :body => post_body,
         
     | 
| 
       62 
     | 
    
         
            -
                    :auth_names => auth_names)
         
     | 
| 
      
 33 
     | 
    
         
            +
                    :body => post_body)
         
     | 
| 
       63 
34 
     | 
    
         
             
                  return data, status_code, headers
         
     | 
| 
       64 
35 
     | 
    
         
             
                end
         
     | 
| 
       65 
     | 
    
         
            -
                # Delete a workflow email
         
     | 
| 
       66 
     | 
    
         
            -
                # Removes an individual Automation workflow email. Emails from certain workflow types, including the Abandoned Cart Email (abandonedCart) and Product Retargeting Email (abandonedBrowse) Workflows, cannot be deleted.
         
     | 
| 
       67 
     | 
    
         
            -
                # @param workflow_id The unique id for the Automation workflow.
         
     | 
| 
       68 
     | 
    
         
            -
                # @param workflow_email_id The unique id for the Automation workflow email.
         
     | 
| 
       69 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       70 
     | 
    
         
            -
                # @return [nil]
         
     | 
| 
       71 
     | 
    
         
            -
                def delete_workflow_email(workflow_id = {}, workflow_email_id = {}, opts = {})
         
     | 
| 
       72 
     | 
    
         
            -
                  delete_workflow_email_with_http_info(workflow_id, workflow_email_id, opts)
         
     | 
| 
       73 
     | 
    
         
            -
                  nil
         
     | 
| 
       74 
     | 
    
         
            -
                end
         
     | 
| 
       75 
36 
     | 
    
         | 
| 
       76 
     | 
    
         
            -
                # Delete  
     | 
| 
       77 
     | 
    
         
            -
                 
     | 
| 
       78 
     | 
    
         
            -
             
     | 
| 
       79 
     | 
    
         
            -
             
     | 
| 
       80 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       81 
     | 
    
         
            -
                # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
         
     | 
| 
       82 
     | 
    
         
            -
                def delete_workflow_email_with_http_info(workflow_id, workflow_email_id, opts = {})
         
     | 
| 
       83 
     | 
    
         
            -
                  # resource path
         
     | 
| 
       84 
     | 
    
         
            -
                  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)
         
     | 
| 
      
 37 
     | 
    
         
            +
                # Delete workflow email
         
     | 
| 
      
 38 
     | 
    
         
            +
                def delete_workflow_email(workflow_id, workflow_email_id, opts = {})
         
     | 
| 
      
 39 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil?
         
     | 
| 
      
 40 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_email_id'" if workflow_email_id.nil?
         
     | 
| 
       85 
41 
     | 
    
         | 
| 
       86 
     | 
    
         
            -
                  # query parameters
         
     | 
| 
       87 
42 
     | 
    
         
             
                  query_params = {}
         
     | 
| 
       88 
     | 
    
         
            -
             
     | 
| 
       89 
     | 
    
         
            -
                  # header parameters
         
     | 
| 
       90 
     | 
    
         
            -
                  header_params = {}
         
     | 
| 
       91 
     | 
    
         
            -
                  # HTTP header 'Accept' (if needed)
         
     | 
| 
       92 
     | 
    
         
            -
                  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
         
     | 
| 
       93 
     | 
    
         
            -
                  # HTTP header 'Content-Type'
         
     | 
| 
       94 
     | 
    
         
            -
                  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
         
     | 
| 
       95 
     | 
    
         
            -
             
     | 
| 
       96 
     | 
    
         
            -
                  # form parameters
         
     | 
| 
       97 
     | 
    
         
            -
                  form_params = {}
         
     | 
| 
       98 
     | 
    
         
            -
             
     | 
| 
       99 
     | 
    
         
            -
                  # http body (model)
         
     | 
| 
       100 
43 
     | 
    
         
             
                  post_body = nil
         
     | 
| 
       101 
     | 
    
         
            -
             
     | 
| 
      
 44 
     | 
    
         
            +
             
     | 
| 
      
 45 
     | 
    
         
            +
                  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)
         
     | 
| 
       102 
46 
     | 
    
         
             
                  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
         
     | 
| 
       103 
     | 
    
         
            -
                    :header_params => header_params,
         
     | 
| 
       104 
47 
     | 
    
         
             
                    :query_params => query_params,
         
     | 
| 
       105 
     | 
    
         
            -
                    : 
     | 
| 
       106 
     | 
    
         
            -
                    :body => post_body,
         
     | 
| 
       107 
     | 
    
         
            -
                    :auth_names => auth_names)
         
     | 
| 
      
 48 
     | 
    
         
            +
                    :body => post_body)
         
     | 
| 
       108 
49 
     | 
    
         
             
                  return data, status_code, headers
         
     | 
| 
       109 
50 
     | 
    
         
             
                end
         
     | 
| 
       110 
     | 
    
         
            -
                # Get a list of Automations
         
     | 
| 
       111 
     | 
    
         
            -
                # Get a summary of an account's Automations.
         
     | 
| 
       112 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       113 
     | 
    
         
            -
                # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
         
     | 
| 
       114 
     | 
    
         
            -
                # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
         
     | 
| 
       115 
     | 
    
         
            -
                # @option opts [DateTime] :before_create_time Restrict the response to automations created before the set time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
         
     | 
| 
       116 
     | 
    
         
            -
                # @option opts [DateTime] :since_create_time Restrict the response to automations created after the set time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
         
     | 
| 
       117 
     | 
    
         
            -
                # @option opts [DateTime] :before_send_time Restrict the response to automations sent before the set time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
         
     | 
| 
       118 
     | 
    
         
            -
                # @option opts [DateTime] :since_send_time Restrict the response to automations sent after the set time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
         
     | 
| 
       119 
     | 
    
         
            -
                # @option opts [String] :status Restrict the results to automations with the specified status.
         
     | 
| 
       120 
     | 
    
         
            -
                # @return [InlineResponse2003]
         
     | 
| 
       121 
     | 
    
         
            -
                def list(opts = {})
         
     | 
| 
       122 
     | 
    
         
            -
                  data, _status_code, _headers = list_with_http_info(opts)
         
     | 
| 
       123 
     | 
    
         
            -
                  data
         
     | 
| 
       124 
     | 
    
         
            -
                end
         
     | 
| 
       125 
51 
     | 
    
         | 
| 
       126 
     | 
    
         
            -
                #  
     | 
| 
       127 
     | 
    
         
            -
                 
     | 
| 
       128 
     | 
    
         
            -
             
     | 
| 
       129 
     | 
    
         
            -
                # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
         
     | 
| 
       130 
     | 
    
         
            -
                # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
         
     | 
| 
       131 
     | 
    
         
            -
                # @option opts [DateTime] :before_create_time Restrict the response to automations created before the set time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
         
     | 
| 
       132 
     | 
    
         
            -
                # @option opts [DateTime] :since_create_time Restrict the response to automations created after the set time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
         
     | 
| 
       133 
     | 
    
         
            -
                # @option opts [DateTime] :before_send_time Restrict the response to automations sent before the set time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
         
     | 
| 
       134 
     | 
    
         
            -
                # @option opts [DateTime] :since_send_time Restrict the response to automations sent after the set time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
         
     | 
| 
       135 
     | 
    
         
            -
                # @option opts [String] :status Restrict the results to automations with the specified status.
         
     | 
| 
       136 
     | 
    
         
            -
                # @return [Array<(InlineResponse2003, Fixnum, Hash)>] InlineResponse2003 data, response status code and response headers
         
     | 
| 
       137 
     | 
    
         
            -
                def list_with_http_info(opts = {})
         
     | 
| 
       138 
     | 
    
         
            -
                  # resource path
         
     | 
| 
       139 
     | 
    
         
            -
                  local_var_path = '/automations'
         
     | 
| 
      
 52 
     | 
    
         
            +
                # List automations
         
     | 
| 
      
 53 
     | 
    
         
            +
                def list(opts = {})
         
     | 
| 
      
 54 
     | 
    
         
            +
                  fail ArgumentError, 'invalid value for "status", must be one of save, paused, sending' if opts[:'status'] && !['save', 'paused', 'sending'].include?(opts[:'status'])
         
     | 
| 
       140 
55 
     | 
    
         | 
| 
       141 
     | 
    
         
            -
                  # query parameters
         
     | 
| 
       142 
56 
     | 
    
         
             
                  query_params = {}
         
     | 
| 
       143 
57 
     | 
    
         
             
                  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
         
     | 
| 
       144 
58 
     | 
    
         
             
                  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
         
     | 
| 
         @@ -147,759 +61,251 @@ module MailchimpMarketing 
     | 
|
| 
       147 
61 
     | 
    
         
             
                  query_params[:'before_send_time'] = opts[:'before_send_time'] if !opts[:'before_send_time'].nil?
         
     | 
| 
       148 
62 
     | 
    
         
             
                  query_params[:'since_send_time'] = opts[:'since_send_time'] if !opts[:'since_send_time'].nil?
         
     | 
| 
       149 
63 
     | 
    
         
             
                  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
         
     | 
| 
       150 
     | 
    
         
            -
             
     | 
| 
       151 
     | 
    
         
            -
                  # header parameters
         
     | 
| 
       152 
     | 
    
         
            -
                  header_params = {}
         
     | 
| 
       153 
     | 
    
         
            -
                  # HTTP header 'Accept' (if needed)
         
     | 
| 
       154 
     | 
    
         
            -
                  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
         
     | 
| 
       155 
     | 
    
         
            -
                  # HTTP header 'Content-Type'
         
     | 
| 
       156 
     | 
    
         
            -
                  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
         
     | 
| 
       157 
     | 
    
         
            -
             
     | 
| 
       158 
     | 
    
         
            -
                  # form parameters
         
     | 
| 
       159 
     | 
    
         
            -
                  form_params = {}
         
     | 
| 
       160 
     | 
    
         
            -
             
     | 
| 
       161 
     | 
    
         
            -
                  # http body (model)
         
     | 
| 
       162 
64 
     | 
    
         
             
                  post_body = nil
         
     | 
| 
       163 
     | 
    
         
            -
             
     | 
| 
      
 65 
     | 
    
         
            +
             
     | 
| 
      
 66 
     | 
    
         
            +
                  local_var_path = '/automations'
         
     | 
| 
       164 
67 
     | 
    
         
             
                  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         
     | 
| 
       165 
     | 
    
         
            -
                    :header_params => header_params,
         
     | 
| 
       166 
68 
     | 
    
         
             
                    :query_params => query_params,
         
     | 
| 
       167 
     | 
    
         
            -
                    : 
     | 
| 
       168 
     | 
    
         
            -
                    :body => post_body,
         
     | 
| 
       169 
     | 
    
         
            -
                    :auth_names => auth_names,
         
     | 
| 
       170 
     | 
    
         
            -
                    :return_type => 'InlineResponse2003')
         
     | 
| 
      
 69 
     | 
    
         
            +
                    :body => post_body)
         
     | 
| 
       171 
70 
     | 
    
         
             
                  return data, status_code, headers
         
     | 
| 
       172 
71 
     | 
    
         
             
                end
         
     | 
| 
       173 
     | 
    
         
            -
                # Get information about a specific Automation workflow
         
     | 
| 
       174 
     | 
    
         
            -
                # Get a summary of an individual Automation workflow's settings and content. The `trigger_settings` object returns information for the first email in the workflow.
         
     | 
| 
       175 
     | 
    
         
            -
                # @param workflow_id The unique id for the Automation workflow.
         
     | 
| 
       176 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       177 
     | 
    
         
            -
                # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
         
     | 
| 
       178 
     | 
    
         
            -
                # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
         
     | 
| 
       179 
     | 
    
         
            -
                # @return [AutomationWorkflow]
         
     | 
| 
       180 
     | 
    
         
            -
                def get(workflow_id = {}, opts = {})
         
     | 
| 
       181 
     | 
    
         
            -
                  data, _status_code, _headers = get_with_http_info(workflow_id, opts)
         
     | 
| 
       182 
     | 
    
         
            -
                  data
         
     | 
| 
       183 
     | 
    
         
            -
                end
         
     | 
| 
       184 
72 
     | 
    
         | 
| 
       185 
     | 
    
         
            -
                # Get  
     | 
| 
       186 
     | 
    
         
            -
                 
     | 
| 
       187 
     | 
    
         
            -
             
     | 
| 
       188 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       189 
     | 
    
         
            -
                # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
         
     | 
| 
       190 
     | 
    
         
            -
                # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
         
     | 
| 
       191 
     | 
    
         
            -
                # @return [Array<(AutomationWorkflow, Fixnum, Hash)>] AutomationWorkflow data, response status code and response headers
         
     | 
| 
       192 
     | 
    
         
            -
                def get_with_http_info(workflow_id, opts = {})
         
     | 
| 
       193 
     | 
    
         
            -
                  # resource path
         
     | 
| 
       194 
     | 
    
         
            -
                  local_var_path = '/automations/{workflow_id}'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
         
     | 
| 
      
 73 
     | 
    
         
            +
                # Get automation info
         
     | 
| 
      
 74 
     | 
    
         
            +
                def get(workflow_id, opts = {})
         
     | 
| 
      
 75 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil?
         
     | 
| 
       195 
76 
     | 
    
         | 
| 
       196 
     | 
    
         
            -
                  # query parameters
         
     | 
| 
       197 
77 
     | 
    
         
             
                  query_params = {}
         
     | 
| 
       198 
78 
     | 
    
         
             
                  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
         
     | 
| 
       199 
79 
     | 
    
         
             
                  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
         
     | 
| 
       200 
     | 
    
         
            -
             
     | 
| 
       201 
     | 
    
         
            -
                  # header parameters
         
     | 
| 
       202 
     | 
    
         
            -
                  header_params = {}
         
     | 
| 
       203 
     | 
    
         
            -
                  # HTTP header 'Accept' (if needed)
         
     | 
| 
       204 
     | 
    
         
            -
                  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
         
     | 
| 
       205 
     | 
    
         
            -
                  # HTTP header 'Content-Type'
         
     | 
| 
       206 
     | 
    
         
            -
                  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
         
     | 
| 
       207 
     | 
    
         
            -
             
     | 
| 
       208 
     | 
    
         
            -
                  # form parameters
         
     | 
| 
       209 
     | 
    
         
            -
                  form_params = {}
         
     | 
| 
       210 
     | 
    
         
            -
             
     | 
| 
       211 
     | 
    
         
            -
                  # http body (model)
         
     | 
| 
       212 
80 
     | 
    
         
             
                  post_body = nil
         
     | 
| 
       213 
     | 
    
         
            -
             
     | 
| 
      
 81 
     | 
    
         
            +
             
     | 
| 
      
 82 
     | 
    
         
            +
                  local_var_path = '/automations/{workflow_id}'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
         
     | 
| 
       214 
83 
     | 
    
         
             
                  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         
     | 
| 
       215 
     | 
    
         
            -
                    :header_params => header_params,
         
     | 
| 
       216 
84 
     | 
    
         
             
                    :query_params => query_params,
         
     | 
| 
       217 
     | 
    
         
            -
                    : 
     | 
| 
       218 
     | 
    
         
            -
                    :body => post_body,
         
     | 
| 
       219 
     | 
    
         
            -
                    :auth_names => auth_names,
         
     | 
| 
       220 
     | 
    
         
            -
                    :return_type => 'AutomationWorkflow')
         
     | 
| 
      
 85 
     | 
    
         
            +
                    :body => post_body)
         
     | 
| 
       221 
86 
     | 
    
         
             
                  return data, status_code, headers
         
     | 
| 
       222 
87 
     | 
    
         
             
                end
         
     | 
| 
       223 
     | 
    
         
            -
                # Get a list of automated emails in a workflow
         
     | 
| 
       224 
     | 
    
         
            -
                # Get a summary of the emails in an Automation workflow.
         
     | 
| 
       225 
     | 
    
         
            -
                # @param workflow_id The unique id for the Automation workflow.
         
     | 
| 
       226 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       227 
     | 
    
         
            -
                # @return [AutomationEmails]
         
     | 
| 
       228 
     | 
    
         
            -
                def list_all_workflow_emails(workflow_id = {}, opts = {})
         
     | 
| 
       229 
     | 
    
         
            -
                  data, _status_code, _headers = list_all_workflow_emails_with_http_info(workflow_id, opts)
         
     | 
| 
       230 
     | 
    
         
            -
                  data
         
     | 
| 
       231 
     | 
    
         
            -
                end
         
     | 
| 
       232 
88 
     | 
    
         | 
| 
       233 
     | 
    
         
            -
                #  
     | 
| 
       234 
     | 
    
         
            -
                 
     | 
| 
       235 
     | 
    
         
            -
             
     | 
| 
       236 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       237 
     | 
    
         
            -
                # @return [Array<(AutomationEmails, Fixnum, Hash)>] AutomationEmails data, response status code and response headers
         
     | 
| 
       238 
     | 
    
         
            -
                def list_all_workflow_emails_with_http_info(workflow_id, opts = {})
         
     | 
| 
       239 
     | 
    
         
            -
                  # resource path
         
     | 
| 
       240 
     | 
    
         
            -
                  local_var_path = '/automations/{workflow_id}/emails'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
         
     | 
| 
      
 89 
     | 
    
         
            +
                # List automated emails
         
     | 
| 
      
 90 
     | 
    
         
            +
                def list_all_workflow_emails(workflow_id, opts = {})
         
     | 
| 
      
 91 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil?
         
     | 
| 
       241 
92 
     | 
    
         | 
| 
       242 
     | 
    
         
            -
                  # query parameters
         
     | 
| 
       243 
93 
     | 
    
         
             
                  query_params = {}
         
     | 
| 
       244 
     | 
    
         
            -
             
     | 
| 
       245 
     | 
    
         
            -
                  # header parameters
         
     | 
| 
       246 
     | 
    
         
            -
                  header_params = {}
         
     | 
| 
       247 
     | 
    
         
            -
                  # HTTP header 'Accept' (if needed)
         
     | 
| 
       248 
     | 
    
         
            -
                  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
         
     | 
| 
       249 
     | 
    
         
            -
                  # HTTP header 'Content-Type'
         
     | 
| 
       250 
     | 
    
         
            -
                  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
         
     | 
| 
       251 
     | 
    
         
            -
             
     | 
| 
       252 
     | 
    
         
            -
                  # form parameters
         
     | 
| 
       253 
     | 
    
         
            -
                  form_params = {}
         
     | 
| 
       254 
     | 
    
         
            -
             
     | 
| 
       255 
     | 
    
         
            -
                  # http body (model)
         
     | 
| 
       256 
94 
     | 
    
         
             
                  post_body = nil
         
     | 
| 
       257 
     | 
    
         
            -
             
     | 
| 
      
 95 
     | 
    
         
            +
             
     | 
| 
      
 96 
     | 
    
         
            +
                  local_var_path = '/automations/{workflow_id}/emails'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
         
     | 
| 
       258 
97 
     | 
    
         
             
                  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         
     | 
| 
       259 
     | 
    
         
            -
                    :header_params => header_params,
         
     | 
| 
       260 
98 
     | 
    
         
             
                    :query_params => query_params,
         
     | 
| 
       261 
     | 
    
         
            -
                    : 
     | 
| 
       262 
     | 
    
         
            -
                    :body => post_body,
         
     | 
| 
       263 
     | 
    
         
            -
                    :auth_names => auth_names,
         
     | 
| 
       264 
     | 
    
         
            -
                    :return_type => 'AutomationEmails')
         
     | 
| 
      
 99 
     | 
    
         
            +
                    :body => post_body)
         
     | 
| 
       265 
100 
     | 
    
         
             
                  return data, status_code, headers
         
     | 
| 
       266 
101 
     | 
    
         
             
                end
         
     | 
| 
       267 
     | 
    
         
            -
                # Get information about a specific workflow email
         
     | 
| 
       268 
     | 
    
         
            -
                # Get information about an individual Automation workflow email.
         
     | 
| 
       269 
     | 
    
         
            -
                # @param workflow_id The unique id for the Automation workflow.
         
     | 
| 
       270 
     | 
    
         
            -
                # @param workflow_email_id The unique id for the Automation workflow email.
         
     | 
| 
       271 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       272 
     | 
    
         
            -
                # @return [AutomationWorkflowEmail]
         
     | 
| 
       273 
     | 
    
         
            -
                def get_workflow_email(workflow_id = {}, workflow_email_id = {}, opts = {})
         
     | 
| 
       274 
     | 
    
         
            -
                  data, _status_code, _headers = get_workflow_email_with_http_info(workflow_id, workflow_email_id, opts)
         
     | 
| 
       275 
     | 
    
         
            -
                  data
         
     | 
| 
       276 
     | 
    
         
            -
                end
         
     | 
| 
       277 
102 
     | 
    
         | 
| 
       278 
     | 
    
         
            -
                # Get  
     | 
| 
       279 
     | 
    
         
            -
                 
     | 
| 
       280 
     | 
    
         
            -
             
     | 
| 
       281 
     | 
    
         
            -
             
     | 
| 
       282 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       283 
     | 
    
         
            -
                # @return [Array<(AutomationWorkflowEmail, Fixnum, Hash)>] AutomationWorkflowEmail data, response status code and response headers
         
     | 
| 
       284 
     | 
    
         
            -
                def get_workflow_email_with_http_info(workflow_id, workflow_email_id, opts = {})
         
     | 
| 
       285 
     | 
    
         
            -
                  # resource path
         
     | 
| 
       286 
     | 
    
         
            -
                  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)
         
     | 
| 
      
 103 
     | 
    
         
            +
                # Get workflow email info
         
     | 
| 
      
 104 
     | 
    
         
            +
                def get_workflow_email(workflow_id, workflow_email_id, opts = {})
         
     | 
| 
      
 105 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil?
         
     | 
| 
      
 106 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_email_id'" if workflow_email_id.nil?
         
     | 
| 
       287 
107 
     | 
    
         | 
| 
       288 
     | 
    
         
            -
                  # query parameters
         
     | 
| 
       289 
108 
     | 
    
         
             
                  query_params = {}
         
     | 
| 
       290 
     | 
    
         
            -
             
     | 
| 
       291 
     | 
    
         
            -
                  # header parameters
         
     | 
| 
       292 
     | 
    
         
            -
                  header_params = {}
         
     | 
| 
       293 
     | 
    
         
            -
                  # HTTP header 'Accept' (if needed)
         
     | 
| 
       294 
     | 
    
         
            -
                  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
         
     | 
| 
       295 
     | 
    
         
            -
                  # HTTP header 'Content-Type'
         
     | 
| 
       296 
     | 
    
         
            -
                  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
         
     | 
| 
       297 
     | 
    
         
            -
             
     | 
| 
       298 
     | 
    
         
            -
                  # form parameters
         
     | 
| 
       299 
     | 
    
         
            -
                  form_params = {}
         
     | 
| 
       300 
     | 
    
         
            -
             
     | 
| 
       301 
     | 
    
         
            -
                  # http body (model)
         
     | 
| 
       302 
109 
     | 
    
         
             
                  post_body = nil
         
     | 
| 
       303 
     | 
    
         
            -
             
     | 
| 
      
 110 
     | 
    
         
            +
             
     | 
| 
      
 111 
     | 
    
         
            +
                  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)
         
     | 
| 
       304 
112 
     | 
    
         
             
                  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         
     | 
| 
       305 
     | 
    
         
            -
                    :header_params => header_params,
         
     | 
| 
       306 
113 
     | 
    
         
             
                    :query_params => query_params,
         
     | 
| 
       307 
     | 
    
         
            -
                    : 
     | 
| 
       308 
     | 
    
         
            -
                    :body => post_body,
         
     | 
| 
       309 
     | 
    
         
            -
                    :auth_names => auth_names,
         
     | 
| 
       310 
     | 
    
         
            -
                    :return_type => 'AutomationWorkflowEmail')
         
     | 
| 
      
 114 
     | 
    
         
            +
                    :body => post_body)
         
     | 
| 
       311 
115 
     | 
    
         
             
                  return data, status_code, headers
         
     | 
| 
       312 
116 
     | 
    
         
             
                end
         
     | 
| 
       313 
     | 
    
         
            -
                # View queued subscribers for an automated email
         
     | 
| 
       314 
     | 
    
         
            -
                # Get information about an Automation email queue.
         
     | 
| 
       315 
     | 
    
         
            -
                # @param workflow_id The unique id for the Automation workflow.
         
     | 
| 
       316 
     | 
    
         
            -
                # @param workflow_email_id The unique id for the Automation workflow email.
         
     | 
| 
       317 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       318 
     | 
    
         
            -
                # @return [InlineResponse2004]
         
     | 
| 
       319 
     | 
    
         
            -
                def get_workflow_email_subscriber_queue(workflow_id = {}, workflow_email_id = {}, opts = {})
         
     | 
| 
       320 
     | 
    
         
            -
                  data, _status_code, _headers = get_workflow_email_subscriber_queue_with_http_info(workflow_id, workflow_email_id, opts)
         
     | 
| 
       321 
     | 
    
         
            -
                  data
         
     | 
| 
       322 
     | 
    
         
            -
                end
         
     | 
| 
       323 
117 
     | 
    
         | 
| 
       324 
     | 
    
         
            -
                #  
     | 
| 
       325 
     | 
    
         
            -
                 
     | 
| 
       326 
     | 
    
         
            -
             
     | 
| 
       327 
     | 
    
         
            -
             
     | 
| 
       328 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       329 
     | 
    
         
            -
                # @return [Array<(InlineResponse2004, Fixnum, Hash)>] InlineResponse2004 data, response status code and response headers
         
     | 
| 
       330 
     | 
    
         
            -
                def get_workflow_email_subscriber_queue_with_http_info(workflow_id, workflow_email_id, opts = {})
         
     | 
| 
       331 
     | 
    
         
            -
                  # resource path
         
     | 
| 
       332 
     | 
    
         
            -
                  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)
         
     | 
| 
      
 118 
     | 
    
         
            +
                # List automated email subscribers
         
     | 
| 
      
 119 
     | 
    
         
            +
                def get_workflow_email_subscriber_queue(workflow_id, workflow_email_id, opts = {})
         
     | 
| 
      
 120 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil?
         
     | 
| 
      
 121 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_email_id'" if workflow_email_id.nil?
         
     | 
| 
       333 
122 
     | 
    
         | 
| 
       334 
     | 
    
         
            -
                  # query parameters
         
     | 
| 
       335 
123 
     | 
    
         
             
                  query_params = {}
         
     | 
| 
       336 
     | 
    
         
            -
             
     | 
| 
       337 
     | 
    
         
            -
                  # header parameters
         
     | 
| 
       338 
     | 
    
         
            -
                  header_params = {}
         
     | 
| 
       339 
     | 
    
         
            -
                  # HTTP header 'Accept' (if needed)
         
     | 
| 
       340 
     | 
    
         
            -
                  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
         
     | 
| 
       341 
     | 
    
         
            -
                  # HTTP header 'Content-Type'
         
     | 
| 
       342 
     | 
    
         
            -
                  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
         
     | 
| 
       343 
     | 
    
         
            -
             
     | 
| 
       344 
     | 
    
         
            -
                  # form parameters
         
     | 
| 
       345 
     | 
    
         
            -
                  form_params = {}
         
     | 
| 
       346 
     | 
    
         
            -
             
     | 
| 
       347 
     | 
    
         
            -
                  # http body (model)
         
     | 
| 
       348 
124 
     | 
    
         
             
                  post_body = nil
         
     | 
| 
       349 
     | 
    
         
            -
             
     | 
| 
      
 125 
     | 
    
         
            +
             
     | 
| 
      
 126 
     | 
    
         
            +
                  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)
         
     | 
| 
       350 
127 
     | 
    
         
             
                  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         
     | 
| 
       351 
     | 
    
         
            -
                    :header_params => header_params,
         
     | 
| 
       352 
128 
     | 
    
         
             
                    :query_params => query_params,
         
     | 
| 
       353 
     | 
    
         
            -
                    : 
     | 
| 
       354 
     | 
    
         
            -
                    :body => post_body,
         
     | 
| 
       355 
     | 
    
         
            -
                    :auth_names => auth_names,
         
     | 
| 
       356 
     | 
    
         
            -
                    :return_type => 'InlineResponse2004')
         
     | 
| 
      
 129 
     | 
    
         
            +
                    :body => post_body)
         
     | 
| 
       357 
130 
     | 
    
         
             
                  return data, status_code, headers
         
     | 
| 
       358 
131 
     | 
    
         
             
                end
         
     | 
| 
       359 
     | 
    
         
            -
                # View specific subscriber in email queue
         
     | 
| 
       360 
     | 
    
         
            -
                # Get information about a specific subscriber in an Automation email queue.
         
     | 
| 
       361 
     | 
    
         
            -
                # @param workflow_id The unique id for the Automation workflow.
         
     | 
| 
       362 
     | 
    
         
            -
                # @param workflow_email_id The unique id for the Automation workflow email.
         
     | 
| 
       363 
     | 
    
         
            -
                # @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
         
     | 
| 
       364 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       365 
     | 
    
         
            -
                # @return [SubscriberInAutomationQueue2]
         
     | 
| 
       366 
     | 
    
         
            -
                def get_workflow_email_subscriber(workflow_id = {}, workflow_email_id = {}, subscriber_hash = {}, opts = {})
         
     | 
| 
       367 
     | 
    
         
            -
                  data, _status_code, _headers = get_workflow_email_subscriber_with_http_info(workflow_id, workflow_email_id, subscriber_hash, opts)
         
     | 
| 
       368 
     | 
    
         
            -
                  data
         
     | 
| 
       369 
     | 
    
         
            -
                end
         
     | 
| 
       370 
132 
     | 
    
         | 
| 
       371 
     | 
    
         
            -
                #  
     | 
| 
       372 
     | 
    
         
            -
                 
     | 
| 
       373 
     | 
    
         
            -
             
     | 
| 
       374 
     | 
    
         
            -
             
     | 
| 
       375 
     | 
    
         
            -
             
     | 
| 
       376 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       377 
     | 
    
         
            -
                # @return [Array<(SubscriberInAutomationQueue2, Fixnum, Hash)>] SubscriberInAutomationQueue2 data, response status code and response headers
         
     | 
| 
       378 
     | 
    
         
            -
                def get_workflow_email_subscriber_with_http_info(workflow_id, workflow_email_id, subscriber_hash, opts = {})
         
     | 
| 
       379 
     | 
    
         
            -
                  # resource path
         
     | 
| 
       380 
     | 
    
         
            -
                  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)
         
     | 
| 
      
 133 
     | 
    
         
            +
                # Get automated email subscriber
         
     | 
| 
      
 134 
     | 
    
         
            +
                def get_workflow_email_subscriber(workflow_id, workflow_email_id, subscriber_hash, opts = {})
         
     | 
| 
      
 135 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil?
         
     | 
| 
      
 136 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_email_id'" if workflow_email_id.nil?
         
     | 
| 
      
 137 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'subscriber_hash'" if subscriber_hash.nil?
         
     | 
| 
       381 
138 
     | 
    
         | 
| 
       382 
     | 
    
         
            -
                  # query parameters
         
     | 
| 
       383 
139 
     | 
    
         
             
                  query_params = {}
         
     | 
| 
       384 
     | 
    
         
            -
             
     | 
| 
       385 
     | 
    
         
            -
                  # header parameters
         
     | 
| 
       386 
     | 
    
         
            -
                  header_params = {}
         
     | 
| 
       387 
     | 
    
         
            -
                  # HTTP header 'Accept' (if needed)
         
     | 
| 
       388 
     | 
    
         
            -
                  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
         
     | 
| 
       389 
     | 
    
         
            -
                  # HTTP header 'Content-Type'
         
     | 
| 
       390 
     | 
    
         
            -
                  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
         
     | 
| 
       391 
     | 
    
         
            -
             
     | 
| 
       392 
     | 
    
         
            -
                  # form parameters
         
     | 
| 
       393 
     | 
    
         
            -
                  form_params = {}
         
     | 
| 
       394 
     | 
    
         
            -
             
     | 
| 
       395 
     | 
    
         
            -
                  # http body (model)
         
     | 
| 
       396 
140 
     | 
    
         
             
                  post_body = nil
         
     | 
| 
       397 
     | 
    
         
            -
             
     | 
| 
      
 141 
     | 
    
         
            +
             
     | 
| 
      
 142 
     | 
    
         
            +
                  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)
         
     | 
| 
       398 
143 
     | 
    
         
             
                  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         
     | 
| 
       399 
     | 
    
         
            -
                    :header_params => header_params,
         
     | 
| 
       400 
144 
     | 
    
         
             
                    :query_params => query_params,
         
     | 
| 
       401 
     | 
    
         
            -
                    : 
     | 
| 
       402 
     | 
    
         
            -
                    :body => post_body,
         
     | 
| 
       403 
     | 
    
         
            -
                    :auth_names => auth_names,
         
     | 
| 
       404 
     | 
    
         
            -
                    :return_type => 'SubscriberInAutomationQueue2')
         
     | 
| 
      
 145 
     | 
    
         
            +
                    :body => post_body)
         
     | 
| 
       405 
146 
     | 
    
         
             
                  return data, status_code, headers
         
     | 
| 
       406 
147 
     | 
    
         
             
                end
         
     | 
| 
       407 
     | 
    
         
            -
                # View all subscribers removed from a workflow
         
     | 
| 
       408 
     | 
    
         
            -
                # Get information about subscribers who were [removed from an Automation workflow](https://mailchimp.com/help/manage-subscribers-in-an-automation/).
         
     | 
| 
       409 
     | 
    
         
            -
                # @param workflow_id The unique id for the Automation workflow.
         
     | 
| 
       410 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       411 
     | 
    
         
            -
                # @return [RemovedSubscribers]
         
     | 
| 
       412 
     | 
    
         
            -
                def list_workflow_email_subscribers_removed(workflow_id = {}, opts = {})
         
     | 
| 
       413 
     | 
    
         
            -
                  data, _status_code, _headers = list_workflow_email_subscribers_removed_with_http_info(workflow_id, opts)
         
     | 
| 
       414 
     | 
    
         
            -
                  data
         
     | 
| 
       415 
     | 
    
         
            -
                end
         
     | 
| 
       416 
148 
     | 
    
         | 
| 
       417 
     | 
    
         
            -
                #  
     | 
| 
       418 
     | 
    
         
            -
                 
     | 
| 
       419 
     | 
    
         
            -
             
     | 
| 
       420 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       421 
     | 
    
         
            -
                # @return [Array<(RemovedSubscribers, Fixnum, Hash)>] RemovedSubscribers data, response status code and response headers
         
     | 
| 
       422 
     | 
    
         
            -
                def list_workflow_email_subscribers_removed_with_http_info(workflow_id, opts = {})
         
     | 
| 
       423 
     | 
    
         
            -
                  # resource path
         
     | 
| 
       424 
     | 
    
         
            -
                  local_var_path = '/automations/{workflow_id}/removed-subscribers'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
         
     | 
| 
      
 149 
     | 
    
         
            +
                # List subscribers removed from workflow
         
     | 
| 
      
 150 
     | 
    
         
            +
                def list_workflow_email_subscribers_removed(workflow_id, opts = {})
         
     | 
| 
      
 151 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil?
         
     | 
| 
       425 
152 
     | 
    
         | 
| 
       426 
     | 
    
         
            -
                  # query parameters
         
     | 
| 
       427 
153 
     | 
    
         
             
                  query_params = {}
         
     | 
| 
       428 
     | 
    
         
            -
             
     | 
| 
       429 
     | 
    
         
            -
                  # header parameters
         
     | 
| 
       430 
     | 
    
         
            -
                  header_params = {}
         
     | 
| 
       431 
     | 
    
         
            -
                  # HTTP header 'Accept' (if needed)
         
     | 
| 
       432 
     | 
    
         
            -
                  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
         
     | 
| 
       433 
     | 
    
         
            -
                  # HTTP header 'Content-Type'
         
     | 
| 
       434 
     | 
    
         
            -
                  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
         
     | 
| 
       435 
     | 
    
         
            -
             
     | 
| 
       436 
     | 
    
         
            -
                  # form parameters
         
     | 
| 
       437 
     | 
    
         
            -
                  form_params = {}
         
     | 
| 
       438 
     | 
    
         
            -
             
     | 
| 
       439 
     | 
    
         
            -
                  # http body (model)
         
     | 
| 
       440 
154 
     | 
    
         
             
                  post_body = nil
         
     | 
| 
       441 
     | 
    
         
            -
             
     | 
| 
      
 155 
     | 
    
         
            +
             
     | 
| 
      
 156 
     | 
    
         
            +
                  local_var_path = '/automations/{workflow_id}/removed-subscribers'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
         
     | 
| 
       442 
157 
     | 
    
         
             
                  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         
     | 
| 
       443 
     | 
    
         
            -
                    :header_params => header_params,
         
     | 
| 
       444 
158 
     | 
    
         
             
                    :query_params => query_params,
         
     | 
| 
       445 
     | 
    
         
            -
                    : 
     | 
| 
       446 
     | 
    
         
            -
                    :body => post_body,
         
     | 
| 
       447 
     | 
    
         
            -
                    :auth_names => auth_names,
         
     | 
| 
       448 
     | 
    
         
            -
                    :return_type => 'RemovedSubscribers')
         
     | 
| 
      
 159 
     | 
    
         
            +
                    :body => post_body)
         
     | 
| 
       449 
160 
     | 
    
         
             
                  return data, status_code, headers
         
     | 
| 
       450 
161 
     | 
    
         
             
                end
         
     | 
| 
       451 
     | 
    
         
            -
                # View a specific subscriber who was removed from a workflow
         
     | 
| 
       452 
     | 
    
         
            -
                # Get information about a specific subscriber who was [removed from an Automation workflow](https://mailchimp.com/help/manage-subscribers-in-an-automation/).
         
     | 
| 
       453 
     | 
    
         
            -
                # @param workflow_id The unique id for the Automation workflow.
         
     | 
| 
       454 
     | 
    
         
            -
                # @param subscriber_hash The MD5 hash of the lowercase version of the list member's email address.
         
     | 
| 
       455 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       456 
     | 
    
         
            -
                # @return [SubscriberRemovedFromAutomationWorkflow]
         
     | 
| 
       457 
     | 
    
         
            -
                def get_removed_workflow_email_subscriber(workflow_id = {}, subscriber_hash = {}, opts = {})
         
     | 
| 
       458 
     | 
    
         
            -
                  data, _status_code, _headers = get_removed_workflow_email_subscriber_with_http_info(workflow_id, subscriber_hash, opts)
         
     | 
| 
       459 
     | 
    
         
            -
                  data
         
     | 
| 
       460 
     | 
    
         
            -
                end
         
     | 
| 
       461 
162 
     | 
    
         | 
| 
       462 
     | 
    
         
            -
                #  
     | 
| 
       463 
     | 
    
         
            -
                 
     | 
| 
       464 
     | 
    
         
            -
             
     | 
| 
       465 
     | 
    
         
            -
             
     | 
| 
       466 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       467 
     | 
    
         
            -
                # @return [Array<(SubscriberRemovedFromAutomationWorkflow, Fixnum, Hash)>] SubscriberRemovedFromAutomationWorkflow data, response status code and response headers
         
     | 
| 
       468 
     | 
    
         
            -
                def get_removed_workflow_email_subscriber_with_http_info(workflow_id, subscriber_hash, opts = {})
         
     | 
| 
       469 
     | 
    
         
            -
                  # resource path
         
     | 
| 
       470 
     | 
    
         
            -
                  local_var_path = '/automations/{workflow_id}/removed-subscribers/{subscriber_hash}'.sub('{' + 'workflow_id' + '}', workflow_id.to_s).sub('{' + 'subscriber_hash' + '}', subscriber_hash.to_s)
         
     | 
| 
      
 163 
     | 
    
         
            +
                # Get subscriber removed from workflow
         
     | 
| 
      
 164 
     | 
    
         
            +
                def get_removed_workflow_email_subscriber(workflow_id, subscriber_hash, opts = {})
         
     | 
| 
      
 165 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil?
         
     | 
| 
      
 166 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'subscriber_hash'" if subscriber_hash.nil?
         
     | 
| 
       471 
167 
     | 
    
         | 
| 
       472 
     | 
    
         
            -
                  # query parameters
         
     | 
| 
       473 
168 
     | 
    
         
             
                  query_params = {}
         
     | 
| 
       474 
     | 
    
         
            -
             
     | 
| 
       475 
     | 
    
         
            -
                  # header parameters
         
     | 
| 
       476 
     | 
    
         
            -
                  header_params = {}
         
     | 
| 
       477 
     | 
    
         
            -
                  # HTTP header 'Accept' (if needed)
         
     | 
| 
       478 
     | 
    
         
            -
                  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
         
     | 
| 
       479 
     | 
    
         
            -
                  # HTTP header 'Content-Type'
         
     | 
| 
       480 
     | 
    
         
            -
                  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
         
     | 
| 
       481 
     | 
    
         
            -
             
     | 
| 
       482 
     | 
    
         
            -
                  # form parameters
         
     | 
| 
       483 
     | 
    
         
            -
                  form_params = {}
         
     | 
| 
       484 
     | 
    
         
            -
             
     | 
| 
       485 
     | 
    
         
            -
                  # http body (model)
         
     | 
| 
       486 
169 
     | 
    
         
             
                  post_body = nil
         
     | 
| 
       487 
     | 
    
         
            -
             
     | 
| 
      
 170 
     | 
    
         
            +
             
     | 
| 
      
 171 
     | 
    
         
            +
                  local_var_path = '/automations/{workflow_id}/removed-subscribers/{subscriber_hash}'.sub('{' + 'workflow_id' + '}', workflow_id.to_s).sub('{' + 'subscriber_hash' + '}', subscriber_hash.to_s)
         
     | 
| 
       488 
172 
     | 
    
         
             
                  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         
     | 
| 
       489 
     | 
    
         
            -
                    :header_params => header_params,
         
     | 
| 
       490 
173 
     | 
    
         
             
                    :query_params => query_params,
         
     | 
| 
       491 
     | 
    
         
            -
                    : 
     | 
| 
       492 
     | 
    
         
            -
                    :body => post_body,
         
     | 
| 
       493 
     | 
    
         
            -
                    :auth_names => auth_names,
         
     | 
| 
       494 
     | 
    
         
            -
                    :return_type => 'SubscriberRemovedFromAutomationWorkflow')
         
     | 
| 
      
 174 
     | 
    
         
            +
                    :body => post_body)
         
     | 
| 
       495 
175 
     | 
    
         
             
                  return data, status_code, headers
         
     | 
| 
       496 
176 
     | 
    
         
             
                end
         
     | 
| 
       497 
     | 
    
         
            -
                # Update an Automation workflow email
         
     | 
| 
       498 
     | 
    
         
            -
                # Update settings for a Automation workflow email
         
     | 
| 
       499 
     | 
    
         
            -
                # @param workflow_id The unique id for the Automation workflow.
         
     | 
| 
       500 
     | 
    
         
            -
                # @param workflow_email_id The unique id for the Automation workflow email.
         
     | 
| 
       501 
     | 
    
         
            -
                # @param body 
         
     | 
| 
       502 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       503 
     | 
    
         
            -
                # @return [AutomationWorkflowEmail]
         
     | 
| 
       504 
     | 
    
         
            -
                def update_workflow_email(workflow_id = {}, workflow_email_id = {}, body = {}, opts = {})
         
     | 
| 
       505 
     | 
    
         
            -
                  data, _status_code, _headers = update_workflow_email_with_http_info(workflow_id, workflow_email_id, body, opts)
         
     | 
| 
       506 
     | 
    
         
            -
                  data
         
     | 
| 
       507 
     | 
    
         
            -
                end
         
     | 
| 
       508 
177 
     | 
    
         | 
| 
       509 
     | 
    
         
            -
                # Update  
     | 
| 
       510 
     | 
    
         
            -
                 
     | 
| 
       511 
     | 
    
         
            -
             
     | 
| 
       512 
     | 
    
         
            -
             
     | 
| 
       513 
     | 
    
         
            -
             
     | 
| 
       514 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       515 
     | 
    
         
            -
                # @return [Array<(AutomationWorkflowEmail, Fixnum, Hash)>] AutomationWorkflowEmail data, response status code and response headers
         
     | 
| 
       516 
     | 
    
         
            -
                def update_workflow_email_with_http_info(workflow_id, workflow_email_id, body, opts = {})
         
     | 
| 
       517 
     | 
    
         
            -
                  # resource path
         
     | 
| 
       518 
     | 
    
         
            -
                  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)
         
     | 
| 
      
 178 
     | 
    
         
            +
                # Update workflow email
         
     | 
| 
      
 179 
     | 
    
         
            +
                def update_workflow_email(workflow_id, workflow_email_id, body, opts = {})
         
     | 
| 
      
 180 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil?
         
     | 
| 
      
 181 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_email_id'" if workflow_email_id.nil?
         
     | 
| 
      
 182 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'body'" if body.nil?
         
     | 
| 
       519 
183 
     | 
    
         | 
| 
       520 
     | 
    
         
            -
                  # query parameters
         
     | 
| 
       521 
184 
     | 
    
         
             
                  query_params = {}
         
     | 
| 
       522 
     | 
    
         
            -
             
     | 
| 
       523 
     | 
    
         
            -
                  # header parameters
         
     | 
| 
       524 
     | 
    
         
            -
                  header_params = {}
         
     | 
| 
       525 
     | 
    
         
            -
                  # HTTP header 'Accept' (if needed)
         
     | 
| 
       526 
     | 
    
         
            -
                  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
         
     | 
| 
       527 
     | 
    
         
            -
                  # HTTP header 'Content-Type'
         
     | 
| 
       528 
     | 
    
         
            -
                  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
         
     | 
| 
       529 
     | 
    
         
            -
             
     | 
| 
       530 
     | 
    
         
            -
                  # form parameters
         
     | 
| 
       531 
     | 
    
         
            -
                  form_params = {}
         
     | 
| 
       532 
     | 
    
         
            -
             
     | 
| 
       533 
     | 
    
         
            -
                  # http body (model)
         
     | 
| 
       534 
185 
     | 
    
         
             
                  post_body = @api_client.object_to_http_body(body)
         
     | 
| 
       535 
     | 
    
         
            -
             
     | 
| 
      
 186 
     | 
    
         
            +
             
     | 
| 
      
 187 
     | 
    
         
            +
                  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)
         
     | 
| 
       536 
188 
     | 
    
         
             
                  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
         
     | 
| 
       537 
     | 
    
         
            -
                    :header_params => header_params,
         
     | 
| 
       538 
189 
     | 
    
         
             
                    :query_params => query_params,
         
     | 
| 
       539 
     | 
    
         
            -
                    : 
     | 
| 
       540 
     | 
    
         
            -
                    :body => post_body,
         
     | 
| 
       541 
     | 
    
         
            -
                    :auth_names => auth_names,
         
     | 
| 
       542 
     | 
    
         
            -
                    :return_type => 'AutomationWorkflowEmail')
         
     | 
| 
      
 190 
     | 
    
         
            +
                    :body => post_body)
         
     | 
| 
       543 
191 
     | 
    
         
             
                  return data, status_code, headers
         
     | 
| 
       544 
192 
     | 
    
         
             
                end
         
     | 
| 
       545 
     | 
    
         
            -
                # Update an Automation
         
     | 
| 
       546 
     | 
    
         
            -
                # Update some or all of the settings for a Automation
         
     | 
| 
       547 
     | 
    
         
            -
                # @param workflow_id The unique id for the Automation workflow.
         
     | 
| 
       548 
     | 
    
         
            -
                # @param body 
         
     | 
| 
       549 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       550 
     | 
    
         
            -
                # @return [AutomationWorkflow]
         
     | 
| 
       551 
     | 
    
         
            -
                def update(workflow_id = {}, body = {}, opts = {})
         
     | 
| 
       552 
     | 
    
         
            -
                  data, _status_code, _headers = update_with_http_info(workflow_id, body, opts)
         
     | 
| 
       553 
     | 
    
         
            -
                  data
         
     | 
| 
       554 
     | 
    
         
            -
                end
         
     | 
| 
       555 
193 
     | 
    
         | 
| 
       556 
     | 
    
         
            -
                # Update  
     | 
| 
       557 
     | 
    
         
            -
                 
     | 
| 
       558 
     | 
    
         
            -
             
     | 
| 
       559 
     | 
    
         
            -
             
     | 
| 
       560 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       561 
     | 
    
         
            -
                # @return [Array<(AutomationWorkflow, Fixnum, Hash)>] AutomationWorkflow data, response status code and response headers
         
     | 
| 
       562 
     | 
    
         
            -
                def update_with_http_info(workflow_id, body, opts = {})
         
     | 
| 
       563 
     | 
    
         
            -
                  # resource path
         
     | 
| 
       564 
     | 
    
         
            -
                  local_var_path = '/automations/{workflow_id}'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
         
     | 
| 
      
 194 
     | 
    
         
            +
                # Update automation
         
     | 
| 
      
 195 
     | 
    
         
            +
                def update(workflow_id, body, opts = {})
         
     | 
| 
      
 196 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil?
         
     | 
| 
      
 197 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'body'" if body.nil?
         
     | 
| 
       565 
198 
     | 
    
         | 
| 
       566 
     | 
    
         
            -
                  # query parameters
         
     | 
| 
       567 
199 
     | 
    
         
             
                  query_params = {}
         
     | 
| 
       568 
     | 
    
         
            -
             
     | 
| 
       569 
     | 
    
         
            -
                  # header parameters
         
     | 
| 
       570 
     | 
    
         
            -
                  header_params = {}
         
     | 
| 
       571 
     | 
    
         
            -
                  # HTTP header 'Accept' (if needed)
         
     | 
| 
       572 
     | 
    
         
            -
                  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
         
     | 
| 
       573 
     | 
    
         
            -
                  # HTTP header 'Content-Type'
         
     | 
| 
       574 
     | 
    
         
            -
                  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
         
     | 
| 
       575 
     | 
    
         
            -
             
     | 
| 
       576 
     | 
    
         
            -
                  # form parameters
         
     | 
| 
       577 
     | 
    
         
            -
                  form_params = {}
         
     | 
| 
       578 
     | 
    
         
            -
             
     | 
| 
       579 
     | 
    
         
            -
                  # http body (model)
         
     | 
| 
       580 
200 
     | 
    
         
             
                  post_body = @api_client.object_to_http_body(body)
         
     | 
| 
       581 
     | 
    
         
            -
             
     | 
| 
      
 201 
     | 
    
         
            +
             
     | 
| 
      
 202 
     | 
    
         
            +
                  local_var_path = '/automations/{workflow_id}'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
         
     | 
| 
       582 
203 
     | 
    
         
             
                  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
         
     | 
| 
       583 
     | 
    
         
            -
                    :header_params => header_params,
         
     | 
| 
       584 
204 
     | 
    
         
             
                    :query_params => query_params,
         
     | 
| 
       585 
     | 
    
         
            -
                    : 
     | 
| 
       586 
     | 
    
         
            -
                    :body => post_body,
         
     | 
| 
       587 
     | 
    
         
            -
                    :auth_names => auth_names,
         
     | 
| 
       588 
     | 
    
         
            -
                    :return_type => 'AutomationWorkflow')
         
     | 
| 
      
 205 
     | 
    
         
            +
                    :body => post_body)
         
     | 
| 
       589 
206 
     | 
    
         
             
                  return data, status_code, headers
         
     | 
| 
       590 
207 
     | 
    
         
             
                end
         
     | 
| 
       591 
     | 
    
         
            -
                # Create a new Automation
         
     | 
| 
       592 
     | 
    
         
            -
                # Create a new Automation in your Mailchimp account.
         
     | 
| 
       593 
     | 
    
         
            -
                # @param body 
         
     | 
| 
       594 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       595 
     | 
    
         
            -
                # @return [AutomationWorkflow]
         
     | 
| 
       596 
     | 
    
         
            -
                def create(body = {}, opts = {})
         
     | 
| 
       597 
     | 
    
         
            -
                  data, _status_code, _headers = create_with_http_info(body, opts)
         
     | 
| 
       598 
     | 
    
         
            -
                  data
         
     | 
| 
       599 
     | 
    
         
            -
                end
         
     | 
| 
       600 
208 
     | 
    
         | 
| 
       601 
     | 
    
         
            -
                #  
     | 
| 
       602 
     | 
    
         
            -
                 
     | 
| 
       603 
     | 
    
         
            -
             
     | 
| 
       604 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       605 
     | 
    
         
            -
                # @return [Array<(AutomationWorkflow, Fixnum, Hash)>] AutomationWorkflow data, response status code and response headers
         
     | 
| 
       606 
     | 
    
         
            -
                def create_with_http_info(body, opts = {})
         
     | 
| 
       607 
     | 
    
         
            -
                  # resource path
         
     | 
| 
       608 
     | 
    
         
            -
                  local_var_path = '/automations'
         
     | 
| 
      
 209 
     | 
    
         
            +
                # Add automation
         
     | 
| 
      
 210 
     | 
    
         
            +
                def create(body, opts = {})
         
     | 
| 
      
 211 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'body'" if body.nil?
         
     | 
| 
       609 
212 
     | 
    
         | 
| 
       610 
     | 
    
         
            -
                  # query parameters
         
     | 
| 
       611 
213 
     | 
    
         
             
                  query_params = {}
         
     | 
| 
       612 
     | 
    
         
            -
             
     | 
| 
       613 
     | 
    
         
            -
                  # header parameters
         
     | 
| 
       614 
     | 
    
         
            -
                  header_params = {}
         
     | 
| 
       615 
     | 
    
         
            -
                  # HTTP header 'Accept' (if needed)
         
     | 
| 
       616 
     | 
    
         
            -
                  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
         
     | 
| 
       617 
     | 
    
         
            -
                  # HTTP header 'Content-Type'
         
     | 
| 
       618 
     | 
    
         
            -
                  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
         
     | 
| 
       619 
     | 
    
         
            -
             
     | 
| 
       620 
     | 
    
         
            -
                  # form parameters
         
     | 
| 
       621 
     | 
    
         
            -
                  form_params = {}
         
     | 
| 
       622 
     | 
    
         
            -
             
     | 
| 
       623 
     | 
    
         
            -
                  # http body (model)
         
     | 
| 
       624 
214 
     | 
    
         
             
                  post_body = @api_client.object_to_http_body(body)
         
     | 
| 
       625 
     | 
    
         
            -
             
     | 
| 
      
 215 
     | 
    
         
            +
             
     | 
| 
      
 216 
     | 
    
         
            +
                  local_var_path = '/automations'
         
     | 
| 
       626 
217 
     | 
    
         
             
                  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         
     | 
| 
       627 
     | 
    
         
            -
                    :header_params => header_params,
         
     | 
| 
       628 
218 
     | 
    
         
             
                    :query_params => query_params,
         
     | 
| 
       629 
     | 
    
         
            -
                    : 
     | 
| 
       630 
     | 
    
         
            -
                    :body => post_body,
         
     | 
| 
       631 
     | 
    
         
            -
                    :auth_names => auth_names,
         
     | 
| 
       632 
     | 
    
         
            -
                    :return_type => 'AutomationWorkflow')
         
     | 
| 
      
 219 
     | 
    
         
            +
                    :body => post_body)
         
     | 
| 
       633 
220 
     | 
    
         
             
                  return data, status_code, headers
         
     | 
| 
       634 
221 
     | 
    
         
             
                end
         
     | 
| 
       635 
     | 
    
         
            -
                # Pause all emails in an Automation workflow
         
     | 
| 
       636 
     | 
    
         
            -
                # Pause all emails in a specific Automation workflow.
         
     | 
| 
       637 
     | 
    
         
            -
                # @param workflow_id The unique id for the Automation workflow.
         
     | 
| 
       638 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       639 
     | 
    
         
            -
                # @return [nil]
         
     | 
| 
       640 
     | 
    
         
            -
                def pause_all_emails(workflow_id = {}, opts = {})
         
     | 
| 
       641 
     | 
    
         
            -
                  pause_all_emails_with_http_info(workflow_id, opts)
         
     | 
| 
       642 
     | 
    
         
            -
                  nil
         
     | 
| 
       643 
     | 
    
         
            -
                end
         
     | 
| 
       644 
222 
     | 
    
         | 
| 
       645 
     | 
    
         
            -
                # Pause  
     | 
| 
       646 
     | 
    
         
            -
                 
     | 
| 
       647 
     | 
    
         
            -
             
     | 
| 
       648 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       649 
     | 
    
         
            -
                # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
         
     | 
| 
       650 
     | 
    
         
            -
                def pause_all_emails_with_http_info(workflow_id, opts = {})
         
     | 
| 
       651 
     | 
    
         
            -
                  # resource path
         
     | 
| 
       652 
     | 
    
         
            -
                  local_var_path = '/automations/{workflow_id}/actions/pause-all-emails'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
         
     | 
| 
      
 223 
     | 
    
         
            +
                # Pause automation emails
         
     | 
| 
      
 224 
     | 
    
         
            +
                def pause_all_emails(workflow_id, opts = {})
         
     | 
| 
      
 225 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil?
         
     | 
| 
       653 
226 
     | 
    
         | 
| 
       654 
     | 
    
         
            -
                  # query parameters
         
     | 
| 
       655 
227 
     | 
    
         
             
                  query_params = {}
         
     | 
| 
       656 
     | 
    
         
            -
             
     | 
| 
       657 
     | 
    
         
            -
                  # header parameters
         
     | 
| 
       658 
     | 
    
         
            -
                  header_params = {}
         
     | 
| 
       659 
     | 
    
         
            -
                  # HTTP header 'Accept' (if needed)
         
     | 
| 
       660 
     | 
    
         
            -
                  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
         
     | 
| 
       661 
     | 
    
         
            -
                  # HTTP header 'Content-Type'
         
     | 
| 
       662 
     | 
    
         
            -
                  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
         
     | 
| 
       663 
     | 
    
         
            -
             
     | 
| 
       664 
     | 
    
         
            -
                  # form parameters
         
     | 
| 
       665 
     | 
    
         
            -
                  form_params = {}
         
     | 
| 
       666 
     | 
    
         
            -
             
     | 
| 
       667 
     | 
    
         
            -
                  # http body (model)
         
     | 
| 
       668 
228 
     | 
    
         
             
                  post_body = nil
         
     | 
| 
       669 
     | 
    
         
            -
             
     | 
| 
      
 229 
     | 
    
         
            +
             
     | 
| 
      
 230 
     | 
    
         
            +
                  local_var_path = '/automations/{workflow_id}/actions/pause-all-emails'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
         
     | 
| 
       670 
231 
     | 
    
         
             
                  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         
     | 
| 
       671 
     | 
    
         
            -
                    :header_params => header_params,
         
     | 
| 
       672 
232 
     | 
    
         
             
                    :query_params => query_params,
         
     | 
| 
       673 
     | 
    
         
            -
                    : 
     | 
| 
       674 
     | 
    
         
            -
                    :body => post_body,
         
     | 
| 
       675 
     | 
    
         
            -
                    :auth_names => auth_names)
         
     | 
| 
      
 233 
     | 
    
         
            +
                    :body => post_body)
         
     | 
| 
       676 
234 
     | 
    
         
             
                  return data, status_code, headers
         
     | 
| 
       677 
235 
     | 
    
         
             
                end
         
     | 
| 
       678 
     | 
    
         
            -
                # Start all emails in an Automation workflow
         
     | 
| 
       679 
     | 
    
         
            -
                # Start all emails in an Automation workflow.
         
     | 
| 
       680 
     | 
    
         
            -
                # @param workflow_id The unique id for the Automation workflow.
         
     | 
| 
       681 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       682 
     | 
    
         
            -
                # @return [nil]
         
     | 
| 
       683 
     | 
    
         
            -
                def start_all_emails(workflow_id = {}, opts = {})
         
     | 
| 
       684 
     | 
    
         
            -
                  start_all_emails_with_http_info(workflow_id, opts)
         
     | 
| 
       685 
     | 
    
         
            -
                  nil
         
     | 
| 
       686 
     | 
    
         
            -
                end
         
     | 
| 
       687 
236 
     | 
    
         | 
| 
       688 
     | 
    
         
            -
                # Start  
     | 
| 
       689 
     | 
    
         
            -
                 
     | 
| 
       690 
     | 
    
         
            -
             
     | 
| 
       691 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       692 
     | 
    
         
            -
                # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
         
     | 
| 
       693 
     | 
    
         
            -
                def start_all_emails_with_http_info(workflow_id, opts = {})
         
     | 
| 
       694 
     | 
    
         
            -
                  # resource path
         
     | 
| 
       695 
     | 
    
         
            -
                  local_var_path = '/automations/{workflow_id}/actions/start-all-emails'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
         
     | 
| 
      
 237 
     | 
    
         
            +
                # Start automation emails
         
     | 
| 
      
 238 
     | 
    
         
            +
                def start_all_emails(workflow_id, opts = {})
         
     | 
| 
      
 239 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil?
         
     | 
| 
       696 
240 
     | 
    
         | 
| 
       697 
     | 
    
         
            -
                  # query parameters
         
     | 
| 
       698 
241 
     | 
    
         
             
                  query_params = {}
         
     | 
| 
       699 
     | 
    
         
            -
             
     | 
| 
       700 
     | 
    
         
            -
                  # header parameters
         
     | 
| 
       701 
     | 
    
         
            -
                  header_params = {}
         
     | 
| 
       702 
     | 
    
         
            -
                  # HTTP header 'Accept' (if needed)
         
     | 
| 
       703 
     | 
    
         
            -
                  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
         
     | 
| 
       704 
     | 
    
         
            -
                  # HTTP header 'Content-Type'
         
     | 
| 
       705 
     | 
    
         
            -
                  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
         
     | 
| 
       706 
     | 
    
         
            -
             
     | 
| 
       707 
     | 
    
         
            -
                  # form parameters
         
     | 
| 
       708 
     | 
    
         
            -
                  form_params = {}
         
     | 
| 
       709 
     | 
    
         
            -
             
     | 
| 
       710 
     | 
    
         
            -
                  # http body (model)
         
     | 
| 
       711 
242 
     | 
    
         
             
                  post_body = nil
         
     | 
| 
       712 
     | 
    
         
            -
             
     | 
| 
      
 243 
     | 
    
         
            +
             
     | 
| 
      
 244 
     | 
    
         
            +
                  local_var_path = '/automations/{workflow_id}/actions/start-all-emails'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
         
     | 
| 
       713 
245 
     | 
    
         
             
                  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         
     | 
| 
       714 
     | 
    
         
            -
                    :header_params => header_params,
         
     | 
| 
       715 
246 
     | 
    
         
             
                    :query_params => query_params,
         
     | 
| 
       716 
     | 
    
         
            -
                    : 
     | 
| 
       717 
     | 
    
         
            -
                    :body => post_body,
         
     | 
| 
       718 
     | 
    
         
            -
                    :auth_names => auth_names)
         
     | 
| 
      
 247 
     | 
    
         
            +
                    :body => post_body)
         
     | 
| 
       719 
248 
     | 
    
         
             
                  return data, status_code, headers
         
     | 
| 
       720 
249 
     | 
    
         
             
                end
         
     | 
| 
       721 
     | 
    
         
            -
                # Pause an automated email
         
     | 
| 
       722 
     | 
    
         
            -
                # Pause an automated email.
         
     | 
| 
       723 
     | 
    
         
            -
                # @param workflow_id The unique id for the Automation workflow.
         
     | 
| 
       724 
     | 
    
         
            -
                # @param workflow_email_id The unique id for the Automation workflow email.
         
     | 
| 
       725 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       726 
     | 
    
         
            -
                # @return [nil]
         
     | 
| 
       727 
     | 
    
         
            -
                def pause_workflow_email(workflow_id = {}, workflow_email_id = {}, opts = {})
         
     | 
| 
       728 
     | 
    
         
            -
                  pause_workflow_email_with_http_info(workflow_id, workflow_email_id, opts)
         
     | 
| 
       729 
     | 
    
         
            -
                  nil
         
     | 
| 
       730 
     | 
    
         
            -
                end
         
     | 
| 
       731 
250 
     | 
    
         | 
| 
       732 
     | 
    
         
            -
                # Pause  
     | 
| 
       733 
     | 
    
         
            -
                 
     | 
| 
       734 
     | 
    
         
            -
             
     | 
| 
       735 
     | 
    
         
            -
             
     | 
| 
       736 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       737 
     | 
    
         
            -
                # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
         
     | 
| 
       738 
     | 
    
         
            -
                def pause_workflow_email_with_http_info(workflow_id, workflow_email_id, opts = {})
         
     | 
| 
       739 
     | 
    
         
            -
                  # resource path
         
     | 
| 
       740 
     | 
    
         
            -
                  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)
         
     | 
| 
      
 251 
     | 
    
         
            +
                # Pause automated email
         
     | 
| 
      
 252 
     | 
    
         
            +
                def pause_workflow_email(workflow_id, workflow_email_id, opts = {})
         
     | 
| 
      
 253 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil?
         
     | 
| 
      
 254 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_email_id'" if workflow_email_id.nil?
         
     | 
| 
       741 
255 
     | 
    
         | 
| 
       742 
     | 
    
         
            -
                  # query parameters
         
     | 
| 
       743 
256 
     | 
    
         
             
                  query_params = {}
         
     | 
| 
       744 
     | 
    
         
            -
             
     | 
| 
       745 
     | 
    
         
            -
                  # header parameters
         
     | 
| 
       746 
     | 
    
         
            -
                  header_params = {}
         
     | 
| 
       747 
     | 
    
         
            -
                  # HTTP header 'Accept' (if needed)
         
     | 
| 
       748 
     | 
    
         
            -
                  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
         
     | 
| 
       749 
     | 
    
         
            -
                  # HTTP header 'Content-Type'
         
     | 
| 
       750 
     | 
    
         
            -
                  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
         
     | 
| 
       751 
     | 
    
         
            -
             
     | 
| 
       752 
     | 
    
         
            -
                  # form parameters
         
     | 
| 
       753 
     | 
    
         
            -
                  form_params = {}
         
     | 
| 
       754 
     | 
    
         
            -
             
     | 
| 
       755 
     | 
    
         
            -
                  # http body (model)
         
     | 
| 
       756 
257 
     | 
    
         
             
                  post_body = nil
         
     | 
| 
       757 
     | 
    
         
            -
             
     | 
| 
      
 258 
     | 
    
         
            +
             
     | 
| 
      
 259 
     | 
    
         
            +
                  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)
         
     | 
| 
       758 
260 
     | 
    
         
             
                  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         
     | 
| 
       759 
     | 
    
         
            -
                    :header_params => header_params,
         
     | 
| 
       760 
261 
     | 
    
         
             
                    :query_params => query_params,
         
     | 
| 
       761 
     | 
    
         
            -
                    : 
     | 
| 
       762 
     | 
    
         
            -
                    :body => post_body,
         
     | 
| 
       763 
     | 
    
         
            -
                    :auth_names => auth_names)
         
     | 
| 
      
 262 
     | 
    
         
            +
                    :body => post_body)
         
     | 
| 
       764 
263 
     | 
    
         
             
                  return data, status_code, headers
         
     | 
| 
       765 
264 
     | 
    
         
             
                end
         
     | 
| 
       766 
     | 
    
         
            -
                # Start an automated email
         
     | 
| 
       767 
     | 
    
         
            -
                # Start an automated email.
         
     | 
| 
       768 
     | 
    
         
            -
                # @param workflow_id The unique id for the Automation workflow.
         
     | 
| 
       769 
     | 
    
         
            -
                # @param workflow_email_id The unique id for the Automation workflow email.
         
     | 
| 
       770 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       771 
     | 
    
         
            -
                # @return [nil]
         
     | 
| 
       772 
     | 
    
         
            -
                def start_workflow_email(workflow_id = {}, workflow_email_id = {}, opts = {})
         
     | 
| 
       773 
     | 
    
         
            -
                  start_workflow_email_with_http_info(workflow_id, workflow_email_id, opts)
         
     | 
| 
       774 
     | 
    
         
            -
                  nil
         
     | 
| 
       775 
     | 
    
         
            -
                end
         
     | 
| 
       776 
265 
     | 
    
         | 
| 
       777 
     | 
    
         
            -
                # Start  
     | 
| 
       778 
     | 
    
         
            -
                 
     | 
| 
       779 
     | 
    
         
            -
             
     | 
| 
       780 
     | 
    
         
            -
             
     | 
| 
       781 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       782 
     | 
    
         
            -
                # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
         
     | 
| 
       783 
     | 
    
         
            -
                def start_workflow_email_with_http_info(workflow_id, workflow_email_id, opts = {})
         
     | 
| 
       784 
     | 
    
         
            -
                  # resource path
         
     | 
| 
       785 
     | 
    
         
            -
                  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)
         
     | 
| 
      
 266 
     | 
    
         
            +
                # Start automated email
         
     | 
| 
      
 267 
     | 
    
         
            +
                def start_workflow_email(workflow_id, workflow_email_id, opts = {})
         
     | 
| 
      
 268 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil?
         
     | 
| 
      
 269 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_email_id'" if workflow_email_id.nil?
         
     | 
| 
       786 
270 
     | 
    
         | 
| 
       787 
     | 
    
         
            -
                  # query parameters
         
     | 
| 
       788 
271 
     | 
    
         
             
                  query_params = {}
         
     | 
| 
       789 
     | 
    
         
            -
             
     | 
| 
       790 
     | 
    
         
            -
                  # header parameters
         
     | 
| 
       791 
     | 
    
         
            -
                  header_params = {}
         
     | 
| 
       792 
     | 
    
         
            -
                  # HTTP header 'Accept' (if needed)
         
     | 
| 
       793 
     | 
    
         
            -
                  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
         
     | 
| 
       794 
     | 
    
         
            -
                  # HTTP header 'Content-Type'
         
     | 
| 
       795 
     | 
    
         
            -
                  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
         
     | 
| 
       796 
     | 
    
         
            -
             
     | 
| 
       797 
     | 
    
         
            -
                  # form parameters
         
     | 
| 
       798 
     | 
    
         
            -
                  form_params = {}
         
     | 
| 
       799 
     | 
    
         
            -
             
     | 
| 
       800 
     | 
    
         
            -
                  # http body (model)
         
     | 
| 
       801 
272 
     | 
    
         
             
                  post_body = nil
         
     | 
| 
       802 
     | 
    
         
            -
             
     | 
| 
      
 273 
     | 
    
         
            +
             
     | 
| 
      
 274 
     | 
    
         
            +
                  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)
         
     | 
| 
       803 
275 
     | 
    
         
             
                  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         
     | 
| 
       804 
     | 
    
         
            -
                    :header_params => header_params,
         
     | 
| 
       805 
276 
     | 
    
         
             
                    :query_params => query_params,
         
     | 
| 
       806 
     | 
    
         
            -
                    : 
     | 
| 
       807 
     | 
    
         
            -
                    :body => post_body,
         
     | 
| 
       808 
     | 
    
         
            -
                    :auth_names => auth_names)
         
     | 
| 
      
 277 
     | 
    
         
            +
                    :body => post_body)
         
     | 
| 
       809 
278 
     | 
    
         
             
                  return data, status_code, headers
         
     | 
| 
       810 
279 
     | 
    
         
             
                end
         
     | 
| 
       811 
     | 
    
         
            -
                # Add a subscriber to a workflow email
         
     | 
| 
       812 
     | 
    
         
            -
                # Manually add a subscriber to a workflow, bypassing the default trigger settings. You can also use this endpoint to trigger a series of automated emails in an [API 3.0 workflow type](https://mailchimp.com/help/automation-types/) or add subscribers to an automated email queue that uses the [API request delay type](https://mailchimp.com/help/automation-types/).
         
     | 
| 
       813 
     | 
    
         
            -
                # @param workflow_id The unique id for the Automation workflow.
         
     | 
| 
       814 
     | 
    
         
            -
                # @param workflow_email_id The unique id for the Automation workflow email.
         
     | 
| 
       815 
     | 
    
         
            -
                # @param body 
         
     | 
| 
       816 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       817 
     | 
    
         
            -
                # @return [SubscriberInAutomationQueue2]
         
     | 
| 
       818 
     | 
    
         
            -
                def add_workflow_email_subscriber(workflow_id = {}, workflow_email_id = {}, body = {}, opts = {})
         
     | 
| 
       819 
     | 
    
         
            -
                  data, _status_code, _headers = add_workflow_email_subscriber_with_http_info(workflow_id, workflow_email_id, body, opts)
         
     | 
| 
       820 
     | 
    
         
            -
                  data
         
     | 
| 
       821 
     | 
    
         
            -
                end
         
     | 
| 
       822 
280 
     | 
    
         | 
| 
       823 
     | 
    
         
            -
                # Add  
     | 
| 
       824 
     | 
    
         
            -
                 
     | 
| 
       825 
     | 
    
         
            -
             
     | 
| 
       826 
     | 
    
         
            -
             
     | 
| 
       827 
     | 
    
         
            -
             
     | 
| 
       828 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       829 
     | 
    
         
            -
                # @return [Array<(SubscriberInAutomationQueue2, Fixnum, Hash)>] SubscriberInAutomationQueue2 data, response status code and response headers
         
     | 
| 
       830 
     | 
    
         
            -
                def add_workflow_email_subscriber_with_http_info(workflow_id, workflow_email_id, body, opts = {})
         
     | 
| 
       831 
     | 
    
         
            -
                  # resource path
         
     | 
| 
       832 
     | 
    
         
            -
                  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)
         
     | 
| 
      
 281 
     | 
    
         
            +
                # Add subscriber to workflow email
         
     | 
| 
      
 282 
     | 
    
         
            +
                def add_workflow_email_subscriber(workflow_id, workflow_email_id, body, opts = {})
         
     | 
| 
      
 283 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil?
         
     | 
| 
      
 284 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_email_id'" if workflow_email_id.nil?
         
     | 
| 
      
 285 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'body'" if body.nil?
         
     | 
| 
       833 
286 
     | 
    
         | 
| 
       834 
     | 
    
         
            -
                  # query parameters
         
     | 
| 
       835 
287 
     | 
    
         
             
                  query_params = {}
         
     | 
| 
       836 
     | 
    
         
            -
             
     | 
| 
       837 
     | 
    
         
            -
                  # header parameters
         
     | 
| 
       838 
     | 
    
         
            -
                  header_params = {}
         
     | 
| 
       839 
     | 
    
         
            -
                  # HTTP header 'Accept' (if needed)
         
     | 
| 
       840 
     | 
    
         
            -
                  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
         
     | 
| 
       841 
     | 
    
         
            -
                  # HTTP header 'Content-Type'
         
     | 
| 
       842 
     | 
    
         
            -
                  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
         
     | 
| 
       843 
     | 
    
         
            -
             
     | 
| 
       844 
     | 
    
         
            -
                  # form parameters
         
     | 
| 
       845 
     | 
    
         
            -
                  form_params = {}
         
     | 
| 
       846 
     | 
    
         
            -
             
     | 
| 
       847 
     | 
    
         
            -
                  # http body (model)
         
     | 
| 
       848 
288 
     | 
    
         
             
                  post_body = @api_client.object_to_http_body(body)
         
     | 
| 
       849 
     | 
    
         
            -
             
     | 
| 
      
 289 
     | 
    
         
            +
             
     | 
| 
      
 290 
     | 
    
         
            +
                  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)
         
     | 
| 
       850 
291 
     | 
    
         
             
                  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         
     | 
| 
       851 
     | 
    
         
            -
                    :header_params => header_params,
         
     | 
| 
       852 
292 
     | 
    
         
             
                    :query_params => query_params,
         
     | 
| 
       853 
     | 
    
         
            -
                    : 
     | 
| 
       854 
     | 
    
         
            -
                    :body => post_body,
         
     | 
| 
       855 
     | 
    
         
            -
                    :auth_names => auth_names,
         
     | 
| 
       856 
     | 
    
         
            -
                    :return_type => 'SubscriberInAutomationQueue2')
         
     | 
| 
      
 293 
     | 
    
         
            +
                    :body => post_body)
         
     | 
| 
       857 
294 
     | 
    
         
             
                  return data, status_code, headers
         
     | 
| 
       858 
295 
     | 
    
         
             
                end
         
     | 
| 
       859 
     | 
    
         
            -
                # Remove subscriber from a workflow
         
     | 
| 
       860 
     | 
    
         
            -
                # [Remove a subscriber](https://mailchimp.com/help/manage-subscribers-in-an-automation/) from a specific Automation workflow. You can remove a subscriber at any point in an Automation workflow, regardless of how many emails they've been sent from that workflow. Once they're removed, they can never be added back to the same workflow.
         
     | 
| 
       861 
     | 
    
         
            -
                # @param workflow_id The unique id for the Automation workflow.
         
     | 
| 
       862 
     | 
    
         
            -
                # @param body 
         
     | 
| 
       863 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       864 
     | 
    
         
            -
                # @return [SubscriberRemovedFromAutomationWorkflow]
         
     | 
| 
       865 
     | 
    
         
            -
                def remove_workflow_email_subscriber(workflow_id = {}, body = {}, opts = {})
         
     | 
| 
       866 
     | 
    
         
            -
                  data, _status_code, _headers = remove_workflow_email_subscriber_with_http_info(workflow_id, body, opts)
         
     | 
| 
       867 
     | 
    
         
            -
                  data
         
     | 
| 
       868 
     | 
    
         
            -
                end
         
     | 
| 
       869 
296 
     | 
    
         | 
| 
       870 
     | 
    
         
            -
                # Remove subscriber from  
     | 
| 
       871 
     | 
    
         
            -
                 
     | 
| 
       872 
     | 
    
         
            -
             
     | 
| 
       873 
     | 
    
         
            -
             
     | 
| 
       874 
     | 
    
         
            -
                # @param [Hash] opts the optional parameters
         
     | 
| 
       875 
     | 
    
         
            -
                # @return [Array<(SubscriberRemovedFromAutomationWorkflow, Fixnum, Hash)>] SubscriberRemovedFromAutomationWorkflow data, response status code and response headers
         
     | 
| 
       876 
     | 
    
         
            -
                def remove_workflow_email_subscriber_with_http_info(workflow_id, body, opts = {})
         
     | 
| 
       877 
     | 
    
         
            -
                  # resource path
         
     | 
| 
       878 
     | 
    
         
            -
                  local_var_path = '/automations/{workflow_id}/removed-subscribers'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
         
     | 
| 
      
 297 
     | 
    
         
            +
                # Remove subscriber from workflow
         
     | 
| 
      
 298 
     | 
    
         
            +
                def remove_workflow_email_subscriber(workflow_id, body, opts = {})
         
     | 
| 
      
 299 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'workflow_id'" if workflow_id.nil?
         
     | 
| 
      
 300 
     | 
    
         
            +
                  fail ArgumentError, "Missing required param: 'body'" if body.nil?
         
     | 
| 
       879 
301 
     | 
    
         | 
| 
       880 
     | 
    
         
            -
                  # query parameters
         
     | 
| 
       881 
302 
     | 
    
         
             
                  query_params = {}
         
     | 
| 
       882 
     | 
    
         
            -
             
     | 
| 
       883 
     | 
    
         
            -
                  # header parameters
         
     | 
| 
       884 
     | 
    
         
            -
                  header_params = {}
         
     | 
| 
       885 
     | 
    
         
            -
                  # HTTP header 'Accept' (if needed)
         
     | 
| 
       886 
     | 
    
         
            -
                  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
         
     | 
| 
       887 
     | 
    
         
            -
                  # HTTP header 'Content-Type'
         
     | 
| 
       888 
     | 
    
         
            -
                  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
         
     | 
| 
       889 
     | 
    
         
            -
             
     | 
| 
       890 
     | 
    
         
            -
                  # form parameters
         
     | 
| 
       891 
     | 
    
         
            -
                  form_params = {}
         
     | 
| 
       892 
     | 
    
         
            -
             
     | 
| 
       893 
     | 
    
         
            -
                  # http body (model)
         
     | 
| 
       894 
303 
     | 
    
         
             
                  post_body = @api_client.object_to_http_body(body)
         
     | 
| 
       895 
     | 
    
         
            -
             
     | 
| 
      
 304 
     | 
    
         
            +
             
     | 
| 
      
 305 
     | 
    
         
            +
                  local_var_path = '/automations/{workflow_id}/removed-subscribers'.sub('{' + 'workflow_id' + '}', workflow_id.to_s)
         
     | 
| 
       896 
306 
     | 
    
         
             
                  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         
     | 
| 
       897 
     | 
    
         
            -
                    :header_params => header_params,
         
     | 
| 
       898 
307 
     | 
    
         
             
                    :query_params => query_params,
         
     | 
| 
       899 
     | 
    
         
            -
                    : 
     | 
| 
       900 
     | 
    
         
            -
                    :body => post_body,
         
     | 
| 
       901 
     | 
    
         
            -
                    :auth_names => auth_names,
         
     | 
| 
       902 
     | 
    
         
            -
                    :return_type => 'SubscriberRemovedFromAutomationWorkflow')
         
     | 
| 
      
 308 
     | 
    
         
            +
                    :body => post_body)
         
     | 
| 
       903 
309 
     | 
    
         
             
                  return data, status_code, headers
         
     | 
| 
       904 
310 
     | 
    
         
             
                end
         
     | 
| 
       905 
311 
     | 
    
         
             
              end
         
     |