Class: BrevoRuby::ConversationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo-ruby/api/conversations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConversationsApi 



19
20
21
 
# File 'lib/brevo-ruby/api/conversations_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-ruby/api/conversations_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#conversations_agent_online_ping_post(body, opts = {}) ⇒ nil

Sets agent’s status to online for 2-3 minutes We recommend pinging this endpoint every minute for as long as the agent has to be considered online.



37
38
39
40
 
# File 'lib/brevo-ruby/api/conversations_api.rb', line 37

def conversations_agent_online_ping_post(body, opts = {})
  conversations_agent_online_ping_post_with_http_info(body, opts)
  nil
end

#conversations_agent_online_ping_post_with_http_info(body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Sets agent’s status to online for 2-3 minutes We recommend pinging this endpoint every minute for as long as the agent has to be considered online.



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
84
 
# File 'lib/brevo-ruby/api/conversations_api.rb', line 47

def conversations_agent_online_ping_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationsApi.conversations_agent_online_ping_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.conversations_agent_online_ping_post"
  end
  # resource path
  local_var_path = '/conversations/agentOnlinePing'

  # 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(body)
  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: ConversationsApi#conversations_agent_online_ping_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#conversations_messages_id_delete(id, opts = {}) ⇒ nil

Delete a message sent by an agent Only agents’ messages can be deleted.



90
91
92
93
 
# File 'lib/brevo-ruby/api/conversations_api.rb', line 90

def conversations_messages_id_delete(id, opts = {})
  conversations_messages_id_delete_with_http_info(id, opts)
  nil
end

#conversations_messages_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a message sent by an agent Only agents’ messages can be deleted.



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
136
137
 
# File 'lib/brevo-ruby/api/conversations_api.rb', line 100

def conversations_messages_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationsApi.conversations_messages_id_delete ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ConversationsApi.conversations_messages_id_delete"
  end
  # resource path
  local_var_path = '/conversations/messages/{id}'.sub('{' + 'id' + '}', 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: ConversationsApi#conversations_messages_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#conversations_messages_id_get(id, opts = {}) ⇒ ConversationsMessage

Get a message



142
143
144
145
 
# File 'lib/brevo-ruby/api/conversations_api.rb', line 142

def conversations_messages_id_get(id, opts = {})
  data, _status_code, _headers = conversations_messages_id_get_with_http_info(id, opts)
  data
end

#conversations_messages_id_get_with_http_info(id, opts = {}) ⇒ Array<(ConversationsMessage, Fixnum, Hash)>

Get a message



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
187
188
189
 
# File 'lib/brevo-ruby/api/conversations_api.rb', line 151

def conversations_messages_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationsApi.conversations_messages_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ConversationsApi.conversations_messages_id_get"
  end
  # resource path
  local_var_path = '/conversations/messages/{id}'.sub('{' + 'id' + '}', 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 => 'ConversationsMessage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#conversations_messages_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#conversations_messages_id_put(id, opts = {}) ⇒ ConversationsMessage

Update a message sent by an agent Only agents’ messages can be edited.

Options Hash (opts):



196
197
198
199
 
# File 'lib/brevo-ruby/api/conversations_api.rb', line 196

def conversations_messages_id_put(id, opts = {})
  data, _status_code, _headers = conversations_messages_id_put_with_http_info(id, opts)
  data
end

#conversations_messages_id_put_with_http_info(id, opts = {}) ⇒ Array<(ConversationsMessage, Fixnum, Hash)>

Update a message sent by an agent Only agents’ messages can be edited.

Options Hash (opts):



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
239
240
241
242
243
244
245
 
# File 'lib/brevo-ruby/api/conversations_api.rb', line 207

def conversations_messages_id_put_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationsApi.conversations_messages_id_put ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ConversationsApi.conversations_messages_id_put"
  end
  # resource path
  local_var_path = '/conversations/messages/{id}'.sub('{' + 'id' + '}', 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[:'body'])
  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,
    :return_type => 'ConversationsMessage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#conversations_messages_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#conversations_messages_post(body, opts = {}) ⇒ ConversationsMessage

Send a message as an agent



250
251
252
253
 
# File 'lib/brevo-ruby/api/conversations_api.rb', line 250

def conversations_messages_post(body, opts = {})
  data, _status_code, _headers = conversations_messages_post_with_http_info(body, opts)
  data
end

#conversations_messages_post_with_http_info(body, opts = {}) ⇒ Array<(ConversationsMessage, Fixnum, Hash)>

Send a message as an agent



259
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
 
# File 'lib/brevo-ruby/api/conversations_api.rb', line 259

def conversations_messages_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationsApi.conversations_messages_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.conversations_messages_post"
  end
  # resource path
  local_var_path = '/conversations/messages'

  # 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(body)
  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 => 'ConversationsMessage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#conversations_messages_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#conversations_pushed_messages_id_delete(id, opts = {}) ⇒ nil

Delete an automated message



302
303
304
305
 
# File 'lib/brevo-ruby/api/conversations_api.rb', line 302

def conversations_pushed_messages_id_delete(id, opts = {})
  conversations_pushed_messages_id_delete_with_http_info(id, opts)
  nil
end

#conversations_pushed_messages_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an automated message



311
312
313
314
315
316
317
318
319
320
321
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
 
# File 'lib/brevo-ruby/api/conversations_api.rb', line 311

def conversations_pushed_messages_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationsApi.conversations_pushed_messages_id_delete ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ConversationsApi.conversations_pushed_messages_id_delete"
  end
  # resource path
  local_var_path = '/conversations/pushedMessages/{id}'.sub('{' + 'id' + '}', 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: ConversationsApi#conversations_pushed_messages_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#conversations_pushed_messages_id_get(id, opts = {}) ⇒ ConversationsMessage

Get an automated message



353
354
355
356
 
# File 'lib/brevo-ruby/api/conversations_api.rb', line 353

def conversations_pushed_messages_id_get(id, opts = {})
  data, _status_code, _headers = conversations_pushed_messages_id_get_with_http_info(id, opts)
  data
end

#conversations_pushed_messages_id_get_with_http_info(id, opts = {}) ⇒ Array<(ConversationsMessage, Fixnum, Hash)>

Get an automated message



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/brevo-ruby/api/conversations_api.rb', line 362

def conversations_pushed_messages_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationsApi.conversations_pushed_messages_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ConversationsApi.conversations_pushed_messages_id_get"
  end
  # resource path
  local_var_path = '/conversations/pushedMessages/{id}'.sub('{' + 'id' + '}', 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 => 'ConversationsMessage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#conversations_pushed_messages_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#conversations_pushed_messages_id_put(id, body, opts = {}) ⇒ ConversationsMessage

Update an automated message



406
407
408
409
 
# File 'lib/brevo-ruby/api/conversations_api.rb', line 406

def conversations_pushed_messages_id_put(id, body, opts = {})
  data, _status_code, _headers = conversations_pushed_messages_id_put_with_http_info(id, body, opts)
  data
end

#conversations_pushed_messages_id_put_with_http_info(id, body, opts = {}) ⇒ Array<(ConversationsMessage, Fixnum, Hash)>

Update an automated message



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/brevo-ruby/api/conversations_api.rb', line 416

def conversations_pushed_messages_id_put_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationsApi.conversations_pushed_messages_id_put ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ConversationsApi.conversations_pushed_messages_id_put"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.conversations_pushed_messages_id_put"
  end
  # resource path
  local_var_path = '/conversations/pushedMessages/{id}'.sub('{' + 'id' + '}', 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(body)
  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,
    :return_type => 'ConversationsMessage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#conversations_pushed_messages_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#conversations_pushed_messages_post(body, opts = {}) ⇒ ConversationsMessage

Send an automated message to a visitor Example of automated messages: order status, announce new features in your web app, etc.



464
465
466
467
 
# File 'lib/brevo-ruby/api/conversations_api.rb', line 464

def conversations_pushed_messages_post(body, opts = {})
  data, _status_code, _headers = conversations_pushed_messages_post_with_http_info(body, opts)
  data
end

#conversations_pushed_messages_post_with_http_info(body, opts = {}) ⇒ Array<(ConversationsMessage, Fixnum, Hash)>

Send an automated message to a visitor Example of automated messages: order status, announce new features in your web app, etc.



474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/brevo-ruby/api/conversations_api.rb', line 474

def conversations_pushed_messages_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversationsApi.conversations_pushed_messages_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.conversations_pushed_messages_post"
  end
  # resource path
  local_var_path = '/conversations/pushedMessages'

  # 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(body)
  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 => 'ConversationsMessage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConversationsApi#conversations_pushed_messages_post\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-ruby/api/conversations_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