Class: Brevo::WhatsAppCampaignsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo/api/whats_app_campaigns_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WhatsAppCampaignsApi

Returns a new instance of WhatsAppCampaignsApi.



19
20
21
 
# File 'lib/brevo/api/whats_app_campaigns_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/brevo/api/whats_app_campaigns_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_whats_app_campaign(whats_app_campaigns, opts = {}) ⇒ CreateModel

Create and Send a WhatsApp campaign

Parameters:

  • whats_app_campaigns —

    Values to create a campaign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



36
37
38
39
 
# File 'lib/brevo/api/whats_app_campaigns_api.rb', line 36

def create_whats_app_campaign(whats_app_campaigns, opts = {})
  data, _status_code, _headers = create_whats_app_campaign_with_http_info(whats_app_campaigns, opts)
  data
end

#create_whats_app_campaign_with_http_info(whats_app_campaigns, opts = {}) ⇒ Array<(CreateModel, Fixnum, Hash)>

Create and Send a WhatsApp campaign

Parameters:

  • whats_app_campaigns —

    Values to create a campaign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CreateModel, Fixnum, Hash)>) —

    CreateModel data, response status code and response headers



45
46
47
48
49
50
51
52
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/brevo/api/whats_app_campaigns_api.rb', line 45

def create_whats_app_campaign_with_http_info(whats_app_campaigns, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WhatsAppCampaignsApi.create_whats_app_campaign ...'
  end
  # verify the required parameter 'whats_app_campaigns' is set
  if @api_client.config.client_side_validation && whats_app_campaigns.nil?
    fail ArgumentError, "Missing the required parameter 'whats_app_campaigns' when calling WhatsAppCampaignsApi.create_whats_app_campaign"
  end
  # resource path
  local_var_path = '/whatsappCampaigns'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(whats_app_campaigns)
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CreateModel')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WhatsAppCampaignsApi#create_whats_app_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_whats_app_template(whats_app_templates, opts = {}) ⇒ CreateModel

Create a WhatsApp template

Parameters:

  • whats_app_templates —

    Values to create a template

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



88
89
90
91
 
# File 'lib/brevo/api/whats_app_campaigns_api.rb', line 88

def create_whats_app_template(whats_app_templates, opts = {})
  data, _status_code, _headers = create_whats_app_template_with_http_info(whats_app_templates, opts)
  data
end

#create_whats_app_template_with_http_info(whats_app_templates, opts = {}) ⇒ Array<(CreateModel, Fixnum, Hash)>

Create a WhatsApp template

Parameters:

  • whats_app_templates —

    Values to create a template

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CreateModel, Fixnum, Hash)>) —

    CreateModel data, response status code and response headers



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/brevo/api/whats_app_campaigns_api.rb', line 97

def create_whats_app_template_with_http_info(whats_app_templates, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WhatsAppCampaignsApi.create_whats_app_template ...'
  end
  # verify the required parameter 'whats_app_templates' is set
  if @api_client.config.client_side_validation && whats_app_templates.nil?
    fail ArgumentError, "Missing the required parameter 'whats_app_templates' when calling WhatsAppCampaignsApi.create_whats_app_template"
  end
  # resource path
  local_var_path = '/whatsppCampaigns/template'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(whats_app_templates)
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CreateModel')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WhatsAppCampaignsApi#create_whats_app_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_whats_app_campaign(campaign_id, opts = {}) ⇒ nil

Delete a WhatsApp campaign

Parameters:

  • campaign_id —

    id of the campaign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


140
141
142
143
 
# File 'lib/brevo/api/whats_app_campaigns_api.rb', line 140

def delete_whats_app_campaign(campaign_id, opts = {})
  delete_whats_app_campaign_with_http_info(campaign_id, opts)
  nil
end

#delete_whats_app_campaign_with_http_info(campaign_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a WhatsApp campaign

Parameters:

  • campaign_id —

    id of the campaign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/brevo/api/whats_app_campaigns_api.rb', line 149

def delete_whats_app_campaign_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WhatsAppCampaignsApi.delete_whats_app_campaign ...'
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling WhatsAppCampaignsApi.delete_whats_app_campaign"
  end
  # resource path
  local_var_path = '/whatsappCampaigns/{campaignId}'.sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WhatsAppCampaignsApi#delete_whats_app_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_whats_app_campaign(campaign_id, opts = {}) ⇒ GetWhatsappCampaignOverview

Get a WhatsApp campaign

Parameters:

  • campaign_id —

    Id of the campaign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



191
192
193
194
 
# File 'lib/brevo/api/whats_app_campaigns_api.rb', line 191

def get_whats_app_campaign(campaign_id, opts = {})
  data, _status_code, _headers = get_whats_app_campaign_with_http_info(campaign_id, opts)
  data
end

#get_whats_app_campaign_with_http_info(campaign_id, opts = {}) ⇒ Array<(GetWhatsappCampaignOverview, Fixnum, Hash)>

Get a WhatsApp campaign

Parameters:

  • campaign_id —

    Id of the campaign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/brevo/api/whats_app_campaigns_api.rb', line 200

def get_whats_app_campaign_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WhatsAppCampaignsApi.get_whats_app_campaign ...'
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling WhatsAppCampaignsApi.get_whats_app_campaign"
  end
  # resource path
  local_var_path = '/whatsappCampaigns/{campaignId}'.sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GetWhatsappCampaignOverview')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WhatsAppCampaignsApi#get_whats_app_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_whats_app_campaigns(opts = {}) ⇒ GetWhatsappCampaigns

Return all your created WhatsApp campaigns

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :start_date (String) —

    **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result**

  • :end_date (String) —

    **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result**

  • :limit (Integer) —

    Number of documents per page (default to 50)

  • :offset (Integer) —

    Index of the first document in the page (default to 0)

  • :sort (String) —

    Sort the results in the ascending/descending order of record modification. Default order is descending if &#x60;sort&#x60; is not passed (default to desc)

Returns:



247
248
249
250
 
# File 'lib/brevo/api/whats_app_campaigns_api.rb', line 247

def get_whats_app_campaigns(opts = {})
  data, _status_code, _headers = get_whats_app_campaigns_with_http_info(opts)
  data
end

#get_whats_app_campaigns_with_http_info(opts = {}) ⇒ Array<(GetWhatsappCampaigns, Fixnum, Hash)>

Return all your created WhatsApp campaigns

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :start_date (String) —

    **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result**

  • :end_date (String) —

    **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result**

  • :limit (Integer) —

    Number of documents per page

  • :offset (Integer) —

    Index of the first document in the page

  • :sort (String) —

    Sort the results in the ascending/descending order of record modification. Default order is descending if &#x60;sort&#x60; is not passed

Returns:

  • (Array<(GetWhatsappCampaigns, Fixnum, Hash)>) —

    GetWhatsappCampaigns data, response status code and response headers



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/brevo/api/whats_app_campaigns_api.rb', line 260

def get_whats_app_campaigns_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WhatsAppCampaignsApi.get_whats_app_campaigns ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling WhatsAppCampaignsApi.get_whats_app_campaigns, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling WhatsAppCampaignsApi.get_whats_app_campaigns, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
    fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
  end
  # resource path
  local_var_path = '/whatsappCampaigns'

  # query parameters
  query_params = {}
  query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GetWhatsappCampaigns')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WhatsAppCampaignsApi#get_whats_app_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_whats_app_config(opts = {}) ⇒ GetWhatsAppConfig

Get your WhatsApp API account information

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



314
315
316
317
 
# File 'lib/brevo/api/whats_app_campaigns_api.rb', line 314

def get_whats_app_config(opts = {})
  data, _status_code, _headers = get_whats_app_config_with_http_info(opts)
  data
end

#get_whats_app_config_with_http_info(opts = {}) ⇒ Array<(GetWhatsAppConfig, Fixnum, Hash)>

Get your WhatsApp API account information

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GetWhatsAppConfig, Fixnum, Hash)>) —

    GetWhatsAppConfig data, response status code and response headers



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/brevo/api/whats_app_campaigns_api.rb', line 322

def get_whats_app_config_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WhatsAppCampaignsApi.get_whats_app_config ...'
  end
  # resource path
  local_var_path = '/whatsappCampaigns/config'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GetWhatsAppConfig')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WhatsAppCampaignsApi#get_whats_app_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_whats_app_templates(opts = {}) ⇒ GetWATemplates

Return all your created WhatsApp templates

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :start_date (String) —

    **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result**

  • :end_date (String) —

    **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result**

  • :limit (Integer) —

    Number of documents per page (default to 50)

  • :offset (Integer) —

    Index of the first document in the page (default to 0)

  • :sort (String) —

    Sort the results in the ascending/descending order of record modification. Default order is descending if &#x60;sort&#x60; is not passed (default to desc)

  • :source (String) —

    source of the template

Returns:



366
367
368
369
 
# File 'lib/brevo/api/whats_app_campaigns_api.rb', line 366

def get_whats_app_templates(opts = {})
  data, _status_code, _headers = get_whats_app_templates_with_http_info(opts)
  data
end

#get_whats_app_templates_with_http_info(opts = {}) ⇒ Array<(GetWATemplates, Fixnum, Hash)>

Return all your created WhatsApp templates

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :start_date (String) —

    **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result**

  • :end_date (String) —

    **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result**

  • :limit (Integer) —

    Number of documents per page

  • :offset (Integer) —

    Index of the first document in the page

  • :sort (String) —

    Sort the results in the ascending/descending order of record modification. Default order is descending if &#x60;sort&#x60; is not passed

  • :source (String) —

    source of the template

Returns:

  • (Array<(GetWATemplates, Fixnum, Hash)>) —

    GetWATemplates data, response status code and response headers



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/brevo/api/whats_app_campaigns_api.rb', line 380

def get_whats_app_templates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WhatsAppCampaignsApi.get_whats_app_templates ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling WhatsAppCampaignsApi.get_whats_app_templates, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling WhatsAppCampaignsApi.get_whats_app_templates, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
    fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
  end
  if @api_client.config.client_side_validation && opts[:'source'] && !['Automation', 'Conversations'].include?(opts[:'source'])
    fail ArgumentError, 'invalid value for "source", must be one of Automation, Conversations'
  end
  # resource path
  local_var_path = '/whatsappCampaigns/template-list'

  # query parameters
  query_params = {}
  query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GetWATemplates')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WhatsAppCampaignsApi#get_whats_app_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_whats_app_template_approval(template_id, opts = {}) ⇒ nil

Send your WhatsApp template for approval

Parameters:

  • template_id —

    id of the campaign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


439
440
441
442
 
# File 'lib/brevo/api/whats_app_campaigns_api.rb', line 439

def send_whats_app_template_approval(template_id, opts = {})
  send_whats_app_template_approval_with_http_info(template_id, opts)
  nil
end

#send_whats_app_template_approval_with_http_info(template_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Send your WhatsApp template for approval

Parameters:

  • template_id —

    id of the campaign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/brevo/api/whats_app_campaigns_api.rb', line 448

def send_whats_app_template_approval_with_http_info(template_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WhatsAppCampaignsApi.send_whats_app_template_approval ...'
  end
  # verify the required parameter 'template_id' is set
  if @api_client.config.client_side_validation && template_id.nil?
    fail ArgumentError, "Missing the required parameter 'template_id' when calling WhatsAppCampaignsApi.send_whats_app_template_approval"
  end
  # resource path
  local_var_path = '/whatsappCampaigns/template/approval/{templateId}'.sub('{' + 'templateId' + '}', template_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WhatsAppCampaignsApi#send_whats_app_template_approval\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#setUserAgent(user_agent) ⇒ Object

Set custom user_agent if explicitly passed in api default will still remain Swagger-Codegen/#VERSION/ruby



25
26
27
28
29
30
 
# File 'lib/brevo/api/whats_app_campaigns_api.rb', line 25

def setUserAgent(user_agent)
  @user_agent = user_agent
  if user_agent.is_a?(String) && user_agent.downcase.start_with?('brevo_')
    @api_client.default_headers['User-Agent'] = @user_agent
  end
end

#update_whats_app_campaign(campaign_id, opts = {}) ⇒ nil

Update a WhatsApp campaign

Parameters:

  • campaign_id —

    Id of the campaign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


491
492
493
494
 
# File 'lib/brevo/api/whats_app_campaigns_api.rb', line 491

def update_whats_app_campaign(campaign_id, opts = {})
  update_whats_app_campaign_with_http_info(campaign_id, opts)
  nil
end

#update_whats_app_campaign_with_http_info(campaign_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update a WhatsApp campaign

Parameters:

  • campaign_id —

    Id of the campaign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/brevo/api/whats_app_campaigns_api.rb', line 501

def update_whats_app_campaign_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WhatsAppCampaignsApi.update_whats_app_campaign ...'
  end
  # verify the required parameter 'campaign_id' is set
  if @api_client.config.client_side_validation && campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'campaign_id' when calling WhatsAppCampaignsApi.update_whats_app_campaign"
  end
  # resource path
  local_var_path = '/whatsappCampaigns/{campaignId}'.sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'whats_app_campaign'])
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WhatsAppCampaignsApi#update_whats_app_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end