Class: MailchimpMarketing::CampaignsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/MailchimpMarketing/api/campaigns_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client) ⇒ CampaignsApi

Returns a new instance of CampaignsApi.



19
20
21
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 19

def initialize(api_client)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_feedback(campaign_id, body, opts = {}) ⇒ Object

Add campaign feedback



340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 340

def add_feedback(campaign_id, body, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'body'" if body.nil?

  query_params = {}
  post_body = @api_client.object_to_http_body(body)

  local_var_path = '/campaigns/{campaign_id}/feedback'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#cancel_send(campaign_id, opts = {}) ⇒ Object

Cancel campaign



212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 212

def cancel_send(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/actions/cancel-send'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#create(body, opts = {}) ⇒ Object

Add campaign



198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 198

def create(body, opts = {})
  fail ArgumentError, "Missing required param: 'body'" if body.nil?

  query_params = {}
  post_body = @api_client.object_to_http_body(body)

  local_var_path = '/campaigns'
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#create_resend(campaign_id, opts = {}) ⇒ Object

Resend campaign



226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 226

def create_resend(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/actions/create-resend'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#delete_feedback_message(campaign_id, feedback_id, opts = {}) ⇒ Object

Delete campaign feedback message



38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 38

def delete_feedback_message(campaign_id, feedback_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'feedback_id'" if feedback_id.nil?

  query_params = {}
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/feedback/{feedback_id}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'feedback_id' + '}', feedback_id.to_s)
  data = @api_client.call_api(:DELETE, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get(campaign_id, opts = {}) ⇒ Object

Get campaign info



86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 86

def get(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_content(campaign_id, opts = {}) ⇒ Object

Get campaign content



102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 102

def get_content(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/content'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_feedback(campaign_id, opts = {}) ⇒ Object

List campaign feedback



118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 118

def get_feedback(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/feedback'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_feedback_message(campaign_id, feedback_id, opts = {}) ⇒ Object

Get campaign feedback message



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 134

def get_feedback_message(campaign_id, feedback_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'feedback_id'" if feedback_id.nil?

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/feedback/{feedback_id}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'feedback_id' + '}', feedback_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_send_checklist(campaign_id, opts = {}) ⇒ Object

Get campaign send checklist



151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 151

def get_send_checklist(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/send-checklist'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#list(opts = {}) ⇒ Object

List campaigns



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 53

def list(opts = {})
  fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
  fail ArgumentError, 'invalid value for "type", must be one of regular, plaintext, absplit, rss, variate' if opts[:'type'] && !['regular', 'plaintext', 'absplit', 'rss', 'variate'].include?(opts[:'type'])
  fail ArgumentError, 'invalid value for "status", must be one of save, paused, schedule, sending, sent' if opts[:'status'] && !['save', 'paused', 'schedule', 'sending', 'sent'].include?(opts[:'status'])
  fail ArgumentError, 'invalid value for "sort_field", must be one of create_time, send_time' if opts[:'sort_field'] && !['create_time', 'send_time'].include?(opts[:'sort_field'])
  fail ArgumentError, 'invalid value for "sort_dir", must be one of ASC, DESC' if opts[:'sort_dir'] && !['ASC', 'DESC'].include?(opts[:'sort_dir'])

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'before_send_time'] = opts[:'before_send_time'] if !opts[:'before_send_time'].nil?
  query_params[:'since_send_time'] = opts[:'since_send_time'] if !opts[:'since_send_time'].nil?
  query_params[:'before_create_time'] = opts[:'before_create_time'] if !opts[:'before_create_time'].nil?
  query_params[:'since_create_time'] = opts[:'since_create_time'] if !opts[:'since_create_time'].nil?
  query_params[:'list_id'] = opts[:'list_id'] if !opts[:'list_id'].nil?
  query_params[:'folder_id'] = opts[:'folder_id'] if !opts[:'folder_id'].nil?
  query_params[:'member_id'] = opts[:'member_id'] if !opts[:'member_id'].nil?
  query_params[:'sort_field'] = opts[:'sort_field'] if !opts[:'sort_field'].nil?
  query_params[:'sort_dir'] = opts[:'sort_dir'] if !opts[:'sort_dir'].nil?
  post_body = nil

  local_var_path = '/campaigns'
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#pause(campaign_id, opts = {}) ⇒ Object

Pause rss campaign



240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 240

def pause(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/actions/pause'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#remove(campaign_id, opts = {}) ⇒ Object

Delete campaign



24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 24

def remove(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:DELETE, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#replicate(campaign_id, opts = {}) ⇒ Object

Replicate campaign



254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 254

def replicate(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/actions/replicate'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#resume(campaign_id, opts = {}) ⇒ Object

Resume rss campaign



268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 268

def resume(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/actions/resume'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#schedule(campaign_id, body, opts = {}) ⇒ Object

Schedule campaign



282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 282

def schedule(campaign_id, body, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'body'" if body.nil?

  query_params = {}
  post_body = @api_client.object_to_http_body(body)

  local_var_path = '/campaigns/{campaign_id}/actions/schedule'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#send(campaign_id, opts = {}) ⇒ Object

Send campaign



297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 297

def send(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/actions/send'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#send_test_email(campaign_id, body, opts = {}) ⇒ Object

Send test email



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 311

def send_test_email(campaign_id, body, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'body'" if body.nil?

  query_params = {}
  post_body = @api_client.object_to_http_body(body)

  local_var_path = '/campaigns/{campaign_id}/actions/test'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#set_content(campaign_id, body, opts = {}) ⇒ Object

Set campaign content



355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 355

def set_content(campaign_id, body, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'body'" if body.nil?

  query_params = {}
  post_body = @api_client.object_to_http_body(body)

  local_var_path = '/campaigns/{campaign_id}/content'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:PUT, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#unschedule(campaign_id, opts = {}) ⇒ Object

Unschedule campaign



326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 326

def unschedule(campaign_id, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?

  query_params = {}
  post_body = nil

  local_var_path = '/campaigns/{campaign_id}/actions/unschedule'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#update(campaign_id, body, opts = {}) ⇒ Object

Update campaign settings



167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 167

def update(campaign_id, body, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'body'" if body.nil?

  query_params = {}
  post_body = @api_client.object_to_http_body(body)

  local_var_path = '/campaigns/{campaign_id}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s)
  data = @api_client.call_api(:PATCH, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#update_feedback_message(campaign_id, feedback_id, body, opts = {}) ⇒ Object

Update campaign feedback message



182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/MailchimpMarketing/api/campaigns_api.rb', line 182

def update_feedback_message(campaign_id, feedback_id, body, opts = {})
  fail ArgumentError, "Missing required param: 'campaign_id'" if campaign_id.nil?
  fail ArgumentError, "Missing required param: 'feedback_id'" if feedback_id.nil?
  fail ArgumentError, "Missing required param: 'body'" if body.nil?

  query_params = {}
  post_body = @api_client.object_to_http_body(body)

  local_var_path = '/campaigns/{campaign_id}/feedback/{feedback_id}'.sub('{' + 'campaign_id' + '}', campaign_id.to_s).sub('{' + 'feedback_id' + '}', feedback_id.to_s)
  data = @api_client.call_api(:PATCH, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end