Class: SibApiV3Sdk::ConversationsApi
- Inherits:
-
Object
- Object
- SibApiV3Sdk::ConversationsApi
- Defined in:
- lib/sib-api-v3-sdk/api/conversations_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#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.
-
#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.
-
#conversations_messages_id_delete(id, opts = {}) ⇒ nil
Delete a message sent by an agent Only agents’ messages can be deleted.
-
#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.
-
#conversations_messages_id_get(id, opts = {}) ⇒ ConversationsMessage
Get a message.
-
#conversations_messages_id_get_with_http_info(id, opts = {}) ⇒ Array<(ConversationsMessage, Fixnum, Hash)>
Get a message.
-
#conversations_messages_id_put(id, opts = {}) ⇒ ConversationsMessage
Update a message sent by an agent Only agents’ messages can be edited.
-
#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.
-
#conversations_messages_post(body, opts = {}) ⇒ ConversationsMessage
Send a message as an agent.
-
#conversations_messages_post_with_http_info(body, opts = {}) ⇒ Array<(ConversationsMessage, Fixnum, Hash)>
Send a message as an agent.
-
#conversations_pushed_messages_id_delete(id, opts = {}) ⇒ nil
Delete an automated message.
-
#conversations_pushed_messages_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Delete an automated message.
-
#conversations_pushed_messages_id_get(id, opts = {}) ⇒ ConversationsMessage
Get an automated message.
-
#conversations_pushed_messages_id_get_with_http_info(id, opts = {}) ⇒ Array<(ConversationsMessage, Fixnum, Hash)>
Get an automated message.
-
#conversations_pushed_messages_id_put(id, body, opts = {}) ⇒ ConversationsMessage
Update an automated message.
-
#conversations_pushed_messages_id_put_with_http_info(id, body, opts = {}) ⇒ Array<(ConversationsMessage, Fixnum, Hash)>
Update an automated message.
-
#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.
-
#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.
-
#initialize(api_client = ApiClient.default) ⇒ ConversationsApi
constructor
A new instance of ConversationsApi.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ ConversationsApi
Returns a new instance of ConversationsApi.
19 20 21 |
# File 'lib/sib-api-v3-sdk/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/sib-api-v3-sdk/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.
27 28 29 30 |
# File 'lib/sib-api-v3-sdk/api/conversations_api.rb', line 27 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.
37 38 39 40 41 42 43 44 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 |
# File 'lib/sib-api-v3-sdk/api/conversations_api.rb', line 37 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.
80 81 82 83 |
# File 'lib/sib-api-v3-sdk/api/conversations_api.rb', line 80 def (id, opts = {}) (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.
90 91 92 93 94 95 96 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 |
# File 'lib/sib-api-v3-sdk/api/conversations_api.rb', line 90 def (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
132 133 134 135 |
# File 'lib/sib-api-v3-sdk/api/conversations_api.rb', line 132 def (id, opts = {}) data, _status_code, _headers = (id, opts) data end |
#conversations_messages_id_get_with_http_info(id, opts = {}) ⇒ Array<(ConversationsMessage, Fixnum, Hash)>
Get a message
141 142 143 144 145 146 147 148 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 |
# File 'lib/sib-api-v3-sdk/api/conversations_api.rb', line 141 def (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.
186 187 188 189 |
# File 'lib/sib-api-v3-sdk/api/conversations_api.rb', line 186 def (id, opts = {}) data, _status_code, _headers = (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.
197 198 199 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 |
# File 'lib/sib-api-v3-sdk/api/conversations_api.rb', line 197 def (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
240 241 242 243 |
# File 'lib/sib-api-v3-sdk/api/conversations_api.rb', line 240 def (body, opts = {}) data, _status_code, _headers = (body, opts) data end |
#conversations_messages_post_with_http_info(body, opts = {}) ⇒ Array<(ConversationsMessage, Fixnum, Hash)>
Send a message as an agent
249 250 251 252 253 254 255 256 257 258 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 |
# File 'lib/sib-api-v3-sdk/api/conversations_api.rb', line 249 def (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
292 293 294 295 |
# File 'lib/sib-api-v3-sdk/api/conversations_api.rb', line 292 def (id, opts = {}) (id, opts) nil end |
#conversations_pushed_messages_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Delete an automated message
301 302 303 304 305 306 307 308 309 310 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 |
# File 'lib/sib-api-v3-sdk/api/conversations_api.rb', line 301 def (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
343 344 345 346 |
# File 'lib/sib-api-v3-sdk/api/conversations_api.rb', line 343 def (id, opts = {}) data, _status_code, _headers = (id, opts) data end |
#conversations_pushed_messages_id_get_with_http_info(id, opts = {}) ⇒ Array<(ConversationsMessage, Fixnum, Hash)>
Get an automated message
352 353 354 355 356 357 358 359 360 361 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 |
# File 'lib/sib-api-v3-sdk/api/conversations_api.rb', line 352 def (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
396 397 398 399 |
# File 'lib/sib-api-v3-sdk/api/conversations_api.rb', line 396 def (id, body, opts = {}) data, _status_code, _headers = (id, body, opts) data end |
#conversations_pushed_messages_id_put_with_http_info(id, body, opts = {}) ⇒ Array<(ConversationsMessage, Fixnum, Hash)>
Update an automated message
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 435 436 437 438 439 440 441 442 443 444 445 446 447 448 |
# File 'lib/sib-api-v3-sdk/api/conversations_api.rb', line 406 def (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.
454 455 456 457 |
# File 'lib/sib-api-v3-sdk/api/conversations_api.rb', line 454 def (body, opts = {}) data, _status_code, _headers = (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.
464 465 466 467 468 469 470 471 472 473 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 |
# File 'lib/sib-api-v3-sdk/api/conversations_api.rb', line 464 def (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 |