Class: MailSlurpClient::SmsControllerApi
- Inherits:
-
Object
- Object
- MailSlurpClient::SmsControllerApi
- Defined in:
- lib/mailslurp_client/api/sms_controller_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#delete_sms_message(sms_id, opts = {}) ⇒ nil
Delete SMS message.
-
#delete_sms_message_with_http_info(sms_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete SMS message.
-
#delete_sms_messages(opts = {}) ⇒ nil
Delete all SMS messages Delete all SMS messages or all messages for a given phone number.
-
#delete_sms_messages_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete all SMS messages Delete all SMS messages or all messages for a given phone number.
-
#get_reply_for_sms_message(sms_id, opts = {}) ⇒ ReplyForSms
Get reply for an SMS message Get reply for an SMS message.
-
#get_reply_for_sms_message_with_http_info(sms_id, opts = {}) ⇒ Array<(ReplyForSms, Integer, Hash)>
Get reply for an SMS message Get reply for an SMS message.
-
#get_sms_count(opts = {}) ⇒ CountDto
Get SMS count Get number of SMS.
-
#get_sms_count_with_http_info(opts = {}) ⇒ Array<(CountDto, Integer, Hash)>
Get SMS count Get number of SMS.
-
#get_sms_message(sms_id, opts = {}) ⇒ SmsDto
Get SMS content including body.
-
#get_sms_message_with_http_info(sms_id, opts = {}) ⇒ Array<(SmsDto, Integer, Hash)>
Get SMS content including body.
-
#get_sms_messages_paginated(opts = {}) ⇒ PageSmsProjection
Get all SMS messages in all phone numbers in paginated form.
-
#get_sms_messages_paginated_with_http_info(opts = {}) ⇒ Array<(PageSmsProjection, Integer, Hash)>
Get all SMS messages in all phone numbers in paginated form.
-
#get_unread_sms_count(opts = {}) ⇒ UnreadCount
Get unread SMS count Get number of SMS unread.
-
#get_unread_sms_count_with_http_info(opts = {}) ⇒ Array<(UnreadCount, Integer, Hash)>
Get unread SMS count Get number of SMS unread.
-
#initialize(api_client = ApiClient.default) ⇒ SmsControllerApi
constructor
A new instance of SmsControllerApi.
-
#reply_to_sms_message(sms_id, sms_reply_options, opts = {}) ⇒ SentSmsDto
Send a reply to a received SMS message.
-
#reply_to_sms_message_with_http_info(sms_id, sms_reply_options, opts = {}) ⇒ Array<(SentSmsDto, Integer, Hash)>
Send a reply to a received SMS message.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ SmsControllerApi
Returns a new instance of SmsControllerApi.
19 20 21 |
# File 'lib/mailslurp_client/api/sms_controller_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/mailslurp_client/api/sms_controller_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#delete_sms_message(sms_id, opts = {}) ⇒ nil
Delete SMS message. Delete an SMS message
27 28 29 30 |
# File 'lib/mailslurp_client/api/sms_controller_api.rb', line 27 def (sms_id, opts = {}) (sms_id, opts) nil end |
#delete_sms_message_with_http_info(sms_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete SMS message. Delete an SMS message
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 75 76 77 78 79 80 |
# File 'lib/mailslurp_client/api/sms_controller_api.rb', line 37 def (sms_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SmsControllerApi.delete_sms_message ...' end # verify the required parameter 'sms_id' is set if @api_client.config.client_side_validation && sms_id.nil? fail ArgumentError, "Missing the required parameter 'sms_id' when calling SmsControllerApi.delete_sms_message" end # resource path local_var_path = '/sms/{smsId}'.sub('{' + 'smsId' + '}', CGI.escape(sms_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SmsControllerApi#delete_sms_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_sms_messages(opts = {}) ⇒ nil
Delete all SMS messages Delete all SMS messages or all messages for a given phone number
87 88 89 90 |
# File 'lib/mailslurp_client/api/sms_controller_api.rb', line 87 def (opts = {}) (opts) nil end |
#delete_sms_messages_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete all SMS messages Delete all SMS messages or all messages for a given phone number
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 136 137 |
# File 'lib/mailslurp_client/api/sms_controller_api.rb', line 97 def (opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SmsControllerApi.delete_sms_messages ...' end # resource path local_var_path = '/sms' # query parameters query_params = opts[:query_params] || {} query_params[:'phoneNumberId'] = opts[:'phone_number_id'] if !opts[:'phone_number_id'].nil? # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SmsControllerApi#delete_sms_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_reply_for_sms_message(sms_id, opts = {}) ⇒ ReplyForSms
Get reply for an SMS message Get reply for an SMS message.
144 145 146 147 |
# File 'lib/mailslurp_client/api/sms_controller_api.rb', line 144 def (sms_id, opts = {}) data, _status_code, _headers = (sms_id, opts) data end |
#get_reply_for_sms_message_with_http_info(sms_id, opts = {}) ⇒ Array<(ReplyForSms, Integer, Hash)>
Get reply for an SMS message Get reply for an SMS message.
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 190 191 192 193 194 195 196 197 198 199 |
# File 'lib/mailslurp_client/api/sms_controller_api.rb', line 154 def (sms_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SmsControllerApi.get_reply_for_sms_message ...' end # verify the required parameter 'sms_id' is set if @api_client.config.client_side_validation && sms_id.nil? fail ArgumentError, "Missing the required parameter 'sms_id' when calling SmsControllerApi.get_reply_for_sms_message" end # resource path local_var_path = '/sms/{smsId}/reply'.sub('{' + 'smsId' + '}', CGI.escape(sms_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'ReplyForSms' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SmsControllerApi#get_reply_for_sms_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_sms_count(opts = {}) ⇒ CountDto
Get SMS count Get number of SMS
205 206 207 208 |
# File 'lib/mailslurp_client/api/sms_controller_api.rb', line 205 def get_sms_count(opts = {}) data, _status_code, _headers = get_sms_count_with_http_info(opts) data end |
#get_sms_count_with_http_info(opts = {}) ⇒ Array<(CountDto, Integer, Hash)>
Get SMS count Get number of SMS
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 246 247 248 249 250 251 252 253 254 255 |
# File 'lib/mailslurp_client/api/sms_controller_api.rb', line 214 def get_sms_count_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SmsControllerApi.get_sms_count ...' end # resource path local_var_path = '/sms/count' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'CountDto' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SmsControllerApi#get_sms_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_sms_message(sms_id, opts = {}) ⇒ SmsDto
Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController. Returns a SMS summary object with content.
262 263 264 265 |
# File 'lib/mailslurp_client/api/sms_controller_api.rb', line 262 def (sms_id, opts = {}) data, _status_code, _headers = (sms_id, opts) data end |
#get_sms_message_with_http_info(sms_id, opts = {}) ⇒ Array<(SmsDto, Integer, Hash)>
Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController. Returns a SMS summary object with content.
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 311 312 313 314 315 316 317 |
# File 'lib/mailslurp_client/api/sms_controller_api.rb', line 272 def (sms_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SmsControllerApi.get_sms_message ...' end # verify the required parameter 'sms_id' is set if @api_client.config.client_side_validation && sms_id.nil? fail ArgumentError, "Missing the required parameter 'sms_id' when calling SmsControllerApi.get_sms_message" end # resource path local_var_path = '/sms/{smsId}'.sub('{' + 'smsId' + '}', CGI.escape(sms_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'SmsDto' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SmsControllerApi#get_sms_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_sms_messages_paginated(opts = {}) ⇒ PageSmsProjection
Get all SMS messages in all phone numbers in paginated form. . By default returns all SMS messages across all phone numbers sorted by ascending created at date. Responses are paginated. You can restrict results to a list of phone number IDs. You can also filter out read messages
330 331 332 333 |
# File 'lib/mailslurp_client/api/sms_controller_api.rb', line 330 def (opts = {}) data, _status_code, _headers = (opts) data end |
#get_sms_messages_paginated_with_http_info(opts = {}) ⇒ Array<(PageSmsProjection, Integer, Hash)>
Get all SMS messages in all phone numbers in paginated form. . By default returns all SMS messages across all phone numbers sorted by ascending created at date. Responses are paginated. You can restrict results to a list of phone number IDs. You can also filter out read messages
346 347 348 349 350 351 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 391 392 393 394 395 396 397 398 399 400 401 402 |
# File 'lib/mailslurp_client/api/sms_controller_api.rb', line 346 def (opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SmsControllerApi.get_sms_messages_paginated ...' end if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100 fail ArgumentError, 'invalid value for "opts[:"size"]" when calling SmsControllerApi.get_sms_messages_paginated, must be smaller than or equal to 100.' end allowable_values = ["ASC", "DESC"] if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort']) fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}" end # resource path local_var_path = '/sms' # query parameters query_params = opts[:query_params] || {} query_params[:'phoneNumber'] = opts[:'phone_number'] if !opts[:'phone_number'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'unreadOnly'] = opts[:'unread_only'] if !opts[:'unread_only'].nil? query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil? query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'PageSmsProjection' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SmsControllerApi#get_sms_messages_paginated\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_unread_sms_count(opts = {}) ⇒ UnreadCount
Get unread SMS count Get number of SMS unread. Unread means has not been viewed in dashboard or returned in an email API response
408 409 410 411 |
# File 'lib/mailslurp_client/api/sms_controller_api.rb', line 408 def get_unread_sms_count(opts = {}) data, _status_code, _headers = get_unread_sms_count_with_http_info(opts) data end |
#get_unread_sms_count_with_http_info(opts = {}) ⇒ Array<(UnreadCount, Integer, Hash)>
Get unread SMS count Get number of SMS unread. Unread means has not been viewed in dashboard or returned in an email API response
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/mailslurp_client/api/sms_controller_api.rb', line 417 def get_unread_sms_count_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SmsControllerApi.get_unread_sms_count ...' end # resource path local_var_path = '/sms/unreadCount' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'UnreadCount' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SmsControllerApi#get_unread_sms_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#reply_to_sms_message(sms_id, sms_reply_options, opts = {}) ⇒ SentSmsDto
Send a reply to a received SMS message. Replies are sent from the receiving number. Reply to an SMS message.
466 467 468 469 |
# File 'lib/mailslurp_client/api/sms_controller_api.rb', line 466 def (sms_id, , opts = {}) data, _status_code, _headers = (sms_id, , opts) data end |
#reply_to_sms_message_with_http_info(sms_id, sms_reply_options, opts = {}) ⇒ Array<(SentSmsDto, Integer, Hash)>
Send a reply to a received SMS message. Replies are sent from the receiving number. Reply to an SMS message.
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 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 |
# File 'lib/mailslurp_client/api/sms_controller_api.rb', line 477 def (sms_id, , opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SmsControllerApi.reply_to_sms_message ...' end # verify the required parameter 'sms_id' is set if @api_client.config.client_side_validation && sms_id.nil? fail ArgumentError, "Missing the required parameter 'sms_id' when calling SmsControllerApi.reply_to_sms_message" end # verify the required parameter 'sms_reply_options' is set if @api_client.config.client_side_validation && .nil? fail ArgumentError, "Missing the required parameter 'sms_reply_options' when calling SmsControllerApi.reply_to_sms_message" end # resource path local_var_path = '/sms/{smsId}/reply'.sub('{' + 'smsId' + '}', CGI.escape(sms_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body() # return_type return_type = opts[:return_type] || 'SentSmsDto' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SmsControllerApi#reply_to_sms_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |