cpaas-sdk 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +11 -0
- data/.rspec +3 -0
- data/.travis.yml +7 -0
- data/CHANGELOG.md +11 -0
- data/Gemfile +4 -0
- data/LICENSE.md +1 -0
- data/README.md +25 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/cpaas-sdk.gemspec +32 -0
- data/docs/Cpaas.html +446 -0
- data/docs/Cpaas/Conversation.html +1742 -0
- data/docs/Cpaas/Notification.html +301 -0
- data/docs/Cpaas/TwoFactor.html +908 -0
- data/docs/_index.html +146 -0
- data/docs/_index.md +21 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +496 -0
- data/docs/file.README.html +102 -0
- data/docs/file._index.html +94 -0
- data/docs/file_list.html +56 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +94 -0
- data/docs/js/app.js +303 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +251 -0
- data/docs/mv_index.html +102 -0
- data/docs/top-level-namespace.html +663 -0
- data/examples/2fa/.env.example +6 -0
- data/examples/2fa/.gitignore +159 -0
- data/examples/2fa/.ruby-gemset +1 -0
- data/examples/2fa/.ruby-version +1 -0
- data/examples/2fa/Gemfile +8 -0
- data/examples/2fa/README.md +34 -0
- data/examples/2fa/app.rb +134 -0
- data/examples/2fa/config.ru +10 -0
- data/examples/2fa/helper.rb +37 -0
- data/examples/2fa/public/stylesheets/forms.css +28 -0
- data/examples/2fa/public/stylesheets/global.css +7 -0
- data/examples/2fa/public/stylesheets/layout.css +45 -0
- data/examples/2fa/public/stylesheets/main.css +3 -0
- data/examples/2fa/views/alert.erb +5 -0
- data/examples/2fa/views/dashboard.erb +4 -0
- data/examples/2fa/views/index.erb +17 -0
- data/examples/2fa/views/login.erb +13 -0
- data/examples/2fa/views/verify.erb +8 -0
- data/examples/sms/.env.example +4 -0
- data/examples/sms/.gitignore +159 -0
- data/examples/sms/.ruby-gemset +1 -0
- data/examples/sms/.ruby-version +1 -0
- data/examples/sms/Gemfile +8 -0
- data/examples/sms/README.md +80 -0
- data/examples/sms/app.rb +87 -0
- data/examples/sms/config.ru +10 -0
- data/examples/sms/helper.rb +33 -0
- data/examples/sms/public/scripts/notification.js +46 -0
- data/examples/sms/public/stylesheets/forms.css +28 -0
- data/examples/sms/public/stylesheets/global.css +7 -0
- data/examples/sms/public/stylesheets/layout.css +74 -0
- data/examples/sms/public/stylesheets/main.css +3 -0
- data/examples/sms/views/alert.erb +5 -0
- data/examples/sms/views/index.erb +48 -0
- data/lib/cpaas-sdk.rb +30 -0
- data/lib/cpaas-sdk/api.rb +139 -0
- data/lib/cpaas-sdk/config.rb +9 -0
- data/lib/cpaas-sdk/resources.rb +4 -0
- data/lib/cpaas-sdk/resources/conversation.rb +268 -0
- data/lib/cpaas-sdk/resources/notification.rb +62 -0
- data/lib/cpaas-sdk/resources/notification_channel.rb +39 -0
- data/lib/cpaas-sdk/resources/twofactor.rb +136 -0
- data/lib/cpaas-sdk/util.rb +93 -0
- data/lib/cpaas-sdk/version.rb +3 -0
- data/tutorials/2FA.md +109 -0
- data/tutorials/2fa-flow.png +0 -0
- data/tutorials/GetStarted.md +86 -0
- data/tutorials/SMSMessaging.md +132 -0
- data/tutorials/index.html +86 -0
- data/tutorials/quickstarts.yml +15 -0
- metadata +238 -0
|
@@ -0,0 +1,1742 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: Cpaas::Conversation
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.20
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "Cpaas::Conversation";
|
|
19
|
+
relpath = '../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../_index.html">Index (C)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../Cpaas.html" title="Cpaas (module)">Cpaas</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Conversation</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: Cpaas::Conversation
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">Cpaas::Conversation</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/cpaas/resources/conversation.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>CPaaS conversation.</p>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</div>
|
|
109
|
+
</div>
|
|
110
|
+
<div class="tags">
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
</div>
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
<h2>
|
|
122
|
+
Class Method Summary
|
|
123
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
124
|
+
</h2>
|
|
125
|
+
|
|
126
|
+
<ul class="summary">
|
|
127
|
+
|
|
128
|
+
<li class="public ">
|
|
129
|
+
<span class="summary_signature">
|
|
130
|
+
|
|
131
|
+
<a href="#create_message-class_method" title="create_message (class method)">.<strong>create_message</strong>(params) ⇒ Object </a>
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
</span>
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
<span class="summary_desc"><div class='inline'>
|
|
146
|
+
<p>Send a new outbound message.</p>
|
|
147
|
+
</div></span>
|
|
148
|
+
|
|
149
|
+
</li>
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
<li class="public ">
|
|
153
|
+
<span class="summary_signature">
|
|
154
|
+
|
|
155
|
+
<a href="#delete_message-class_method" title="delete_message (class method)">.<strong>delete_message</strong>(params) ⇒ Object </a>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
</span>
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
<span class="summary_desc"><div class='inline'>
|
|
170
|
+
<p>Delete conversation message.</p>
|
|
171
|
+
</div></span>
|
|
172
|
+
|
|
173
|
+
</li>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
<li class="public ">
|
|
177
|
+
<span class="summary_signature">
|
|
178
|
+
|
|
179
|
+
<a href="#get_messages-class_method" title="get_messages (class method)">.<strong>get_messages</strong>(params) ⇒ Object </a>
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
</span>
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
<span class="summary_desc"><div class='inline'>
|
|
194
|
+
<p>Gets all messages.</p>
|
|
195
|
+
</div></span>
|
|
196
|
+
|
|
197
|
+
</li>
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
<li class="public ">
|
|
201
|
+
<span class="summary_signature">
|
|
202
|
+
|
|
203
|
+
<a href="#get_messages_in_thread-class_method" title="get_messages_in_thread (class method)">.<strong>get_messages_in_thread</strong>(params) ⇒ Object </a>
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
</span>
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
<span class="summary_desc"><div class='inline'>
|
|
218
|
+
<p>Read all messages in a thread.</p>
|
|
219
|
+
</div></span>
|
|
220
|
+
|
|
221
|
+
</li>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
<li class="public ">
|
|
225
|
+
<span class="summary_signature">
|
|
226
|
+
|
|
227
|
+
<a href="#get_status-class_method" title="get_status (class method)">.<strong>get_status</strong>(params) ⇒ Object </a>
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
</span>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
<span class="summary_desc"><div class='inline'>
|
|
242
|
+
<p>Read a conversation message status.</p>
|
|
243
|
+
</div></span>
|
|
244
|
+
|
|
245
|
+
</li>
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
<li class="public ">
|
|
249
|
+
<span class="summary_signature">
|
|
250
|
+
|
|
251
|
+
<a href="#get_subscription-class_method" title="get_subscription (class method)">.<strong>get_subscription</strong>(params) ⇒ Object </a>
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
</span>
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
<span class="summary_desc"><div class='inline'>
|
|
266
|
+
<p>Read active subscription.</p>
|
|
267
|
+
</div></span>
|
|
268
|
+
|
|
269
|
+
</li>
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
<li class="public ">
|
|
273
|
+
<span class="summary_signature">
|
|
274
|
+
|
|
275
|
+
<a href="#get_subscriptions-class_method" title="get_subscriptions (class method)">.<strong>get_subscriptions</strong>(params) ⇒ Object </a>
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
</span>
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
<span class="summary_desc"><div class='inline'>
|
|
290
|
+
<p>Read all active subscriptions.</p>
|
|
291
|
+
</div></span>
|
|
292
|
+
|
|
293
|
+
</li>
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
<li class="public ">
|
|
297
|
+
<span class="summary_signature">
|
|
298
|
+
|
|
299
|
+
<a href="#subscribe-class_method" title="subscribe (class method)">.<strong>subscribe</strong>(params) ⇒ Object </a>
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
</span>
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
<span class="summary_desc"><div class='inline'>
|
|
314
|
+
<p>Create a new subscription.</p>
|
|
315
|
+
</div></span>
|
|
316
|
+
|
|
317
|
+
</li>
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
<li class="public ">
|
|
321
|
+
<span class="summary_signature">
|
|
322
|
+
|
|
323
|
+
<a href="#unsubscribe-class_method" title="unsubscribe (class method)">.<strong>unsubscribe</strong>(params = {}) ⇒ Object </a>
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
</span>
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
<span class="summary_desc"><div class='inline'>
|
|
338
|
+
<p>Unsubscription from conversation notification.</p>
|
|
339
|
+
</div></span>
|
|
340
|
+
|
|
341
|
+
</li>
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
</ul>
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
<div id="class_method_details" class="method_details_list">
|
|
350
|
+
<h2>Class Method Details</h2>
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
<div class="method_details first">
|
|
354
|
+
<h3 class="signature first" id="create_message-class_method">
|
|
355
|
+
|
|
356
|
+
.<strong>create_message</strong>(params) ⇒ <tt>Object</tt>
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
</h3><div class="docstring">
|
|
363
|
+
<div class="discussion">
|
|
364
|
+
|
|
365
|
+
<p>Send a new outbound message</p>
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
</div>
|
|
369
|
+
</div>
|
|
370
|
+
<div class="tags">
|
|
371
|
+
<p class="tag_title">Parameters:</p>
|
|
372
|
+
<ul class="param">
|
|
373
|
+
|
|
374
|
+
<li>
|
|
375
|
+
|
|
376
|
+
<span class='name'>params</span>
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
</li>
|
|
384
|
+
|
|
385
|
+
</ul>
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
|
391
|
+
<ul class="option">
|
|
392
|
+
|
|
393
|
+
<li>
|
|
394
|
+
<span class="name">:type</span>
|
|
395
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
396
|
+
<span class="default">
|
|
397
|
+
|
|
398
|
+
</span>
|
|
399
|
+
|
|
400
|
+
— <div class='inline'>
|
|
401
|
+
<p>Type of conversation. Possible values - 'sms'. Check
|
|
402
|
+
Conversation.types for more options</p>
|
|
403
|
+
</div>
|
|
404
|
+
|
|
405
|
+
</li>
|
|
406
|
+
|
|
407
|
+
<li>
|
|
408
|
+
<span class="name">:sender_address</span>
|
|
409
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
410
|
+
<span class="default">
|
|
411
|
+
|
|
412
|
+
</span>
|
|
413
|
+
|
|
414
|
+
— <div class='inline'>
|
|
415
|
+
<p>Sender address information, basically the from address. E164 formatted DID
|
|
416
|
+
number passed as a value, which is owned by the user. If the user wants to
|
|
417
|
+
let CPaaS uses the default assigned DID number, this field can either has
|
|
418
|
+
“default” value or the same value as the userId.</p>
|
|
419
|
+
</div>
|
|
420
|
+
|
|
421
|
+
</li>
|
|
422
|
+
|
|
423
|
+
<li>
|
|
424
|
+
<span class="name">:destination_address</span>
|
|
425
|
+
<span class="type">(<tt>Array[string]|String</tt>)</span>
|
|
426
|
+
<span class="default">
|
|
427
|
+
|
|
428
|
+
</span>
|
|
429
|
+
|
|
430
|
+
</li>
|
|
431
|
+
|
|
432
|
+
<li>
|
|
433
|
+
<span class="name">:message</span>
|
|
434
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
435
|
+
<span class="default">
|
|
436
|
+
|
|
437
|
+
</span>
|
|
438
|
+
|
|
439
|
+
— <div class='inline'>
|
|
440
|
+
<p>text message</p>
|
|
441
|
+
</div>
|
|
442
|
+
|
|
443
|
+
</li>
|
|
444
|
+
|
|
445
|
+
</ul>
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
</div><table class="source_code">
|
|
450
|
+
<tr>
|
|
451
|
+
<td>
|
|
452
|
+
<pre class="lines">
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
18
|
|
456
|
+
19
|
|
457
|
+
20
|
|
458
|
+
21
|
|
459
|
+
22
|
|
460
|
+
23
|
|
461
|
+
24
|
|
462
|
+
25
|
|
463
|
+
26
|
|
464
|
+
27
|
|
465
|
+
28
|
|
466
|
+
29
|
|
467
|
+
30
|
|
468
|
+
31
|
|
469
|
+
32
|
|
470
|
+
33
|
|
471
|
+
34
|
|
472
|
+
35
|
|
473
|
+
36
|
|
474
|
+
37
|
|
475
|
+
38
|
|
476
|
+
39
|
|
477
|
+
40
|
|
478
|
+
41
|
|
479
|
+
42
|
|
480
|
+
43
|
|
481
|
+
44
|
|
482
|
+
45</pre>
|
|
483
|
+
</td>
|
|
484
|
+
<td>
|
|
485
|
+
<pre class="code"><span class="info file"># File 'lib/cpaas/resources/conversation.rb', line 18</span>
|
|
486
|
+
|
|
487
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_create_message'>create_message</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
488
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_types'>types</span><span class='lbracket'>[</span><span class='symbol'>:SMS</span><span class='rbracket'>]</span>
|
|
489
|
+
<span class='id identifier rubyid_address'>address</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:destination_address</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>String</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='lbracket'>[</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:destination_address</span><span class='rbracket'>]</span> <span class='rbracket'>]</span> <span class='op'>:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:destination_address</span><span class='rbracket'>]</span>
|
|
490
|
+
|
|
491
|
+
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
492
|
+
<span class='label'>body:</span> <span class='lbrace'>{</span>
|
|
493
|
+
<span class='label'>outboundSMSMessageRequest:</span> <span class='lbrace'>{</span>
|
|
494
|
+
<span class='label'>address:</span> <span class='id identifier rubyid_address'>address</span><span class='comma'>,</span>
|
|
495
|
+
<span class='label'>clientCorrelator:</span> <span class='const'><span class='object_link'><a href="../Cpaas.html" title="Cpaas (module)">Cpaas</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api'><span class='object_link'><a href="../Cpaas.html#api-class_method" title="Cpaas.api (method)">api</a></span></span><span class='period'>.</span><span class='id identifier rubyid_client_correlator'>client_correlator</span><span class='comma'>,</span>
|
|
496
|
+
<span class='label'>outboundSMSTextMessage:</span> <span class='lbrace'>{</span>
|
|
497
|
+
<span class='label'>message:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:message</span><span class='rbracket'>]</span>
|
|
498
|
+
<span class='rbrace'>}</span>
|
|
499
|
+
<span class='rbrace'>}</span>
|
|
500
|
+
<span class='rbrace'>}</span>
|
|
501
|
+
<span class='rbrace'>}</span>
|
|
502
|
+
|
|
503
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Cpaas.html" title="Cpaas (module)">Cpaas</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api'><span class='object_link'><a href="../Cpaas.html#api-class_method" title="Cpaas.api (method)">api</a></span></span><span class='period'>.</span><span class='id identifier rubyid_send_request'>send_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_base_url'>base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/outbound/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:sender_address</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>/requests</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='comma'>,</span> <span class='symbol'>:post</span><span class='rparen'>)</span>
|
|
504
|
+
<span class='id identifier rubyid_process_response'><span class='object_link'><a href="../top-level-namespace.html#process_response-instance_method" title="#process_response (method)">process_response</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_res'>res</span><span class='op'>|</span>
|
|
505
|
+
<span class='id identifier rubyid_outboundSMS'>outboundSMS</span> <span class='op'>=</span> <span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='symbol'>:outbound_sms_message_request</span><span class='rparen'>)</span>
|
|
506
|
+
|
|
507
|
+
<span class='lbrace'>{</span>
|
|
508
|
+
<span class='label'>message:</span> <span class='id identifier rubyid_outboundSMS'>outboundSMS</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='symbol'>:outbound_sms_text_message</span><span class='comma'>,</span> <span class='symbol'>:message</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
509
|
+
<span class='label'>senderAddress:</span> <span class='id identifier rubyid_outboundSMS'>outboundSMS</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='symbol'>:sender_address</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
510
|
+
<span class='label'>deliveryInfo:</span> <span class='id identifier rubyid_outboundSMS'>outboundSMS</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='symbol'>:delivery_info_list</span><span class='comma'>,</span> <span class='symbol'>:delivery_info</span><span class='rparen'>)</span>
|
|
511
|
+
<span class='rbrace'>}</span>
|
|
512
|
+
<span class='kw'>end</span>
|
|
513
|
+
<span class='kw'>end</span>
|
|
514
|
+
<span class='kw'>end</span></pre>
|
|
515
|
+
</td>
|
|
516
|
+
</tr>
|
|
517
|
+
</table>
|
|
518
|
+
</div>
|
|
519
|
+
|
|
520
|
+
<div class="method_details ">
|
|
521
|
+
<h3 class="signature " id="delete_message-class_method">
|
|
522
|
+
|
|
523
|
+
.<strong>delete_message</strong>(params) ⇒ <tt>Object</tt>
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
</h3><div class="docstring">
|
|
530
|
+
<div class="discussion">
|
|
531
|
+
|
|
532
|
+
<p>Delete conversation message</p>
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
</div>
|
|
536
|
+
</div>
|
|
537
|
+
<div class="tags">
|
|
538
|
+
<p class="tag_title">Parameters:</p>
|
|
539
|
+
<ul class="param">
|
|
540
|
+
|
|
541
|
+
<li>
|
|
542
|
+
|
|
543
|
+
<span class='name'>params</span>
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
</li>
|
|
551
|
+
|
|
552
|
+
</ul>
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
|
558
|
+
<ul class="option">
|
|
559
|
+
|
|
560
|
+
<li>
|
|
561
|
+
<span class="name">:type</span>
|
|
562
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
563
|
+
<span class="default">
|
|
564
|
+
|
|
565
|
+
</span>
|
|
566
|
+
|
|
567
|
+
— <div class='inline'>
|
|
568
|
+
<p>Type of conversation. Possible values - 'sms'. Check
|
|
569
|
+
Conversation.types for more options</p>
|
|
570
|
+
</div>
|
|
571
|
+
|
|
572
|
+
</li>
|
|
573
|
+
|
|
574
|
+
<li>
|
|
575
|
+
<span class="name">:remote_address</span>
|
|
576
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
577
|
+
<span class="default">
|
|
578
|
+
|
|
579
|
+
</span>
|
|
580
|
+
|
|
581
|
+
— <div class='inline'>
|
|
582
|
+
<p>Remote address information while retrieving the conversation history,
|
|
583
|
+
basically the destination telephone number that user exchanged message
|
|
584
|
+
before. E164 formatted DID number passed as a value.</p>
|
|
585
|
+
</div>
|
|
586
|
+
|
|
587
|
+
</li>
|
|
588
|
+
|
|
589
|
+
<li>
|
|
590
|
+
<span class="name">:local_address</span>
|
|
591
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
592
|
+
<span class="default">
|
|
593
|
+
|
|
594
|
+
</span>
|
|
595
|
+
|
|
596
|
+
— <div class='inline'>
|
|
597
|
+
<p>Local address information while retrieving the conversation history,
|
|
598
|
+
basically the source telephone number that user exchanged message before.</p>
|
|
599
|
+
</div>
|
|
600
|
+
|
|
601
|
+
</li>
|
|
602
|
+
|
|
603
|
+
<li>
|
|
604
|
+
<span class="name">:message_id</span>
|
|
605
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
606
|
+
<span class="default">
|
|
607
|
+
|
|
608
|
+
</span>
|
|
609
|
+
|
|
610
|
+
— <div class='inline'>
|
|
611
|
+
<p><code>optional</code> Identification of the message. If messeageId is not
|
|
612
|
+
passsed then the conversation thread is deleted with all messages.</p>
|
|
613
|
+
</div>
|
|
614
|
+
|
|
615
|
+
</li>
|
|
616
|
+
|
|
617
|
+
</ul>
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
</div><table class="source_code">
|
|
622
|
+
<tr>
|
|
623
|
+
<td>
|
|
624
|
+
<pre class="lines">
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
97
|
|
628
|
+
98
|
|
629
|
+
99
|
|
630
|
+
100
|
|
631
|
+
101
|
|
632
|
+
102
|
|
633
|
+
103
|
|
634
|
+
104
|
|
635
|
+
105</pre>
|
|
636
|
+
</td>
|
|
637
|
+
<td>
|
|
638
|
+
<pre class="code"><span class="info file"># File 'lib/cpaas/resources/conversation.rb', line 97</span>
|
|
639
|
+
|
|
640
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_delete_message'>delete_message</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
641
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_types'>types</span><span class='lbracket'>[</span><span class='symbol'>:SMS</span><span class='rbracket'>]</span>
|
|
642
|
+
<span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_base_url'>base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/remoteAddresses/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:remote_address</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>/localAddresses/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:local_address</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
|
643
|
+
|
|
644
|
+
<span class='id identifier rubyid_url'>url</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/messages/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:message_id</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:message_id</span><span class='rbracket'>]</span>
|
|
645
|
+
|
|
646
|
+
<span class='const'><span class='object_link'><a href="../Cpaas.html" title="Cpaas (module)">Cpaas</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api'><span class='object_link'><a href="../Cpaas.html#api-class_method" title="Cpaas.api (method)">api</a></span></span><span class='period'>.</span><span class='id identifier rubyid_send_request'>send_request</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='symbol'>:delete</span><span class='rparen'>)</span>
|
|
647
|
+
<span class='kw'>end</span>
|
|
648
|
+
<span class='kw'>end</span></pre>
|
|
649
|
+
</td>
|
|
650
|
+
</tr>
|
|
651
|
+
</table>
|
|
652
|
+
</div>
|
|
653
|
+
|
|
654
|
+
<div class="method_details ">
|
|
655
|
+
<h3 class="signature " id="get_messages-class_method">
|
|
656
|
+
|
|
657
|
+
.<strong>get_messages</strong>(params) ⇒ <tt>Object</tt>
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
</h3><div class="docstring">
|
|
664
|
+
<div class="discussion">
|
|
665
|
+
|
|
666
|
+
<p>Gets all messages.</p>
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
</div>
|
|
670
|
+
</div>
|
|
671
|
+
<div class="tags">
|
|
672
|
+
<p class="tag_title">Parameters:</p>
|
|
673
|
+
<ul class="param">
|
|
674
|
+
|
|
675
|
+
<li>
|
|
676
|
+
|
|
677
|
+
<span class='name'>params</span>
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
</li>
|
|
685
|
+
|
|
686
|
+
</ul>
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
|
692
|
+
<ul class="option">
|
|
693
|
+
|
|
694
|
+
<li>
|
|
695
|
+
<span class="name">:type</span>
|
|
696
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
697
|
+
<span class="default">
|
|
698
|
+
|
|
699
|
+
</span>
|
|
700
|
+
|
|
701
|
+
— <div class='inline'>
|
|
702
|
+
<p>Type of conversation. Possible values - 'sms'. Check
|
|
703
|
+
Conversation.types for more options</p>
|
|
704
|
+
</div>
|
|
705
|
+
|
|
706
|
+
</li>
|
|
707
|
+
|
|
708
|
+
<li>
|
|
709
|
+
<span class="name">:remote_address</span>
|
|
710
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
711
|
+
<span class="default">
|
|
712
|
+
|
|
713
|
+
</span>
|
|
714
|
+
|
|
715
|
+
— <div class='inline'>
|
|
716
|
+
<p><code>optional</code> Remote address information while retrieving the
|
|
717
|
+
conversation history, basically the destination telephone number that user
|
|
718
|
+
exchanged message before. E164 formatted DID number passed as a value.</p>
|
|
719
|
+
</div>
|
|
720
|
+
|
|
721
|
+
</li>
|
|
722
|
+
|
|
723
|
+
<li>
|
|
724
|
+
<span class="name">:local_address</span>
|
|
725
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
726
|
+
<span class="default">
|
|
727
|
+
|
|
728
|
+
</span>
|
|
729
|
+
|
|
730
|
+
— <div class='inline'>
|
|
731
|
+
<p><code>optional</code> Local address information while retrieving the
|
|
732
|
+
conversation history, basically the source telephone number that user
|
|
733
|
+
exchanged message before.</p>
|
|
734
|
+
</div>
|
|
735
|
+
|
|
736
|
+
</li>
|
|
737
|
+
|
|
738
|
+
<li>
|
|
739
|
+
<span class="name">:query[:name]</span>
|
|
740
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
741
|
+
<span class="default">
|
|
742
|
+
|
|
743
|
+
</span>
|
|
744
|
+
|
|
745
|
+
— <div class='inline'>
|
|
746
|
+
<p><code>optional</code> - Performs search operation on firstName and lastName
|
|
747
|
+
fields.</p>
|
|
748
|
+
</div>
|
|
749
|
+
|
|
750
|
+
</li>
|
|
751
|
+
|
|
752
|
+
<li>
|
|
753
|
+
<span class="name">:query[:first_name]</span>
|
|
754
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
755
|
+
<span class="default">
|
|
756
|
+
|
|
757
|
+
</span>
|
|
758
|
+
|
|
759
|
+
— <div class='inline'>
|
|
760
|
+
<p><code>optional</code> - Performs search for the first_name field of the
|
|
761
|
+
directory items.</p>
|
|
762
|
+
</div>
|
|
763
|
+
|
|
764
|
+
</li>
|
|
765
|
+
|
|
766
|
+
<li>
|
|
767
|
+
<span class="name">:query[:last_name]</span>
|
|
768
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
769
|
+
<span class="default">
|
|
770
|
+
|
|
771
|
+
</span>
|
|
772
|
+
|
|
773
|
+
— <div class='inline'>
|
|
774
|
+
<p><code>optional</code> - Performs search for the last_name field of the
|
|
775
|
+
directory items.</p>
|
|
776
|
+
</div>
|
|
777
|
+
|
|
778
|
+
</li>
|
|
779
|
+
|
|
780
|
+
<li>
|
|
781
|
+
<span class="name">:query[:user_name]</span>
|
|
782
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
783
|
+
<span class="default">
|
|
784
|
+
|
|
785
|
+
</span>
|
|
786
|
+
|
|
787
|
+
— <div class='inline'>
|
|
788
|
+
<p><code>optional</code> - Performs search for the user_name field of the
|
|
789
|
+
directory items.</p>
|
|
790
|
+
</div>
|
|
791
|
+
|
|
792
|
+
</li>
|
|
793
|
+
|
|
794
|
+
<li>
|
|
795
|
+
<span class="name">:query[:phone_number]</span>
|
|
796
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
797
|
+
<span class="default">
|
|
798
|
+
|
|
799
|
+
</span>
|
|
800
|
+
|
|
801
|
+
— <div class='inline'>
|
|
802
|
+
<p><code>optional</code> - Performs search for the fields containing a phone
|
|
803
|
+
number, like businessPhoneNumber, homePhoneNumber, mobile, pager, fax.</p>
|
|
804
|
+
</div>
|
|
805
|
+
|
|
806
|
+
</li>
|
|
807
|
+
|
|
808
|
+
<li>
|
|
809
|
+
<span class="name">:query[:order]</span>
|
|
810
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
811
|
+
<span class="default">
|
|
812
|
+
|
|
813
|
+
</span>
|
|
814
|
+
|
|
815
|
+
— <div class='inline'>
|
|
816
|
+
<p><code>optional</code> - Ordering the contact results based on the requested
|
|
817
|
+
sortBy value, order query parameter should be accompanied by sortBy query
|
|
818
|
+
parameter.</p>
|
|
819
|
+
</div>
|
|
820
|
+
|
|
821
|
+
</li>
|
|
822
|
+
|
|
823
|
+
<li>
|
|
824
|
+
<span class="name">:query[:sort_by]</span>
|
|
825
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
826
|
+
<span class="default">
|
|
827
|
+
|
|
828
|
+
</span>
|
|
829
|
+
|
|
830
|
+
— <div class='inline'>
|
|
831
|
+
<p><code>optional</code> - sort_by value is used to detect sorting the contact
|
|
832
|
+
results based on which attribute. If order is not provided with that,
|
|
833
|
+
ascending order is used.</p>
|
|
834
|
+
</div>
|
|
835
|
+
|
|
836
|
+
</li>
|
|
837
|
+
|
|
838
|
+
<li>
|
|
839
|
+
<span class="name">:query[:max]</span>
|
|
840
|
+
<span class="type">(<tt>Number</tt>)</span>
|
|
841
|
+
<span class="default">
|
|
842
|
+
|
|
843
|
+
</span>
|
|
844
|
+
|
|
845
|
+
— <div class='inline'>
|
|
846
|
+
<p><code>optional</code> - Maximum number of contact results that has been
|
|
847
|
+
requested from CPaaS for this query.</p>
|
|
848
|
+
</div>
|
|
849
|
+
|
|
850
|
+
</li>
|
|
851
|
+
|
|
852
|
+
<li>
|
|
853
|
+
<span class="name">:query[:next]</span>
|
|
854
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
855
|
+
<span class="default">
|
|
856
|
+
|
|
857
|
+
</span>
|
|
858
|
+
|
|
859
|
+
— <div class='inline'>
|
|
860
|
+
<p><code>optional</code> - Pointer for the next chunk of contacts, should be
|
|
861
|
+
gathered from the previous query results.</p>
|
|
862
|
+
</div>
|
|
863
|
+
|
|
864
|
+
</li>
|
|
865
|
+
|
|
866
|
+
</ul>
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
</div><table class="source_code">
|
|
871
|
+
<tr>
|
|
872
|
+
<td>
|
|
873
|
+
<pre class="lines">
|
|
874
|
+
|
|
875
|
+
|
|
876
|
+
64
|
|
877
|
+
65
|
|
878
|
+
66
|
|
879
|
+
67
|
|
880
|
+
68
|
|
881
|
+
69
|
|
882
|
+
70
|
|
883
|
+
71
|
|
884
|
+
72
|
|
885
|
+
73
|
|
886
|
+
74
|
|
887
|
+
75
|
|
888
|
+
76
|
|
889
|
+
77
|
|
890
|
+
78
|
|
891
|
+
79
|
|
892
|
+
80
|
|
893
|
+
81
|
|
894
|
+
82
|
|
895
|
+
83
|
|
896
|
+
84
|
|
897
|
+
85
|
|
898
|
+
86</pre>
|
|
899
|
+
</td>
|
|
900
|
+
<td>
|
|
901
|
+
<pre class="code"><span class="info file"># File 'lib/cpaas/resources/conversation.rb', line 64</span>
|
|
902
|
+
|
|
903
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_messages'>get_messages</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
904
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_types'>types</span><span class='lbracket'>[</span><span class='symbol'>:SMS</span><span class='rbracket'>]</span>
|
|
905
|
+
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
906
|
+
<span class='label'>query:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:query</span><span class='rbracket'>]</span>
|
|
907
|
+
<span class='rbrace'>}</span>
|
|
908
|
+
|
|
909
|
+
<span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_base_url'>base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/remoteAddresses</span><span class='tstring_end'>"</span></span>
|
|
910
|
+
<span class='id identifier rubyid_url'>url</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:remote_address</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:remote_address</span><span class='rbracket'>]</span>
|
|
911
|
+
<span class='id identifier rubyid_url'>url</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/localAddresses/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:local_address</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:local_address</span><span class='rbracket'>]</span>
|
|
912
|
+
|
|
913
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Cpaas.html" title="Cpaas (module)">Cpaas</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api'><span class='object_link'><a href="../Cpaas.html#api-class_method" title="Cpaas.api (method)">api</a></span></span><span class='period'>.</span><span class='id identifier rubyid_send_request'>send_request</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
914
|
+
|
|
915
|
+
<span class='id identifier rubyid_process_response'><span class='object_link'><a href="../top-level-namespace.html#process_response-instance_method" title="#process_response (method)">process_response</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_res'>res</span><span class='op'>|</span>
|
|
916
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:local_address</span><span class='rbracket'>]</span>
|
|
917
|
+
<span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='symbol'>:sms_thread_list</span><span class='comma'>,</span> <span class='symbol'>:sms_thread</span><span class='rparen'>)</span>
|
|
918
|
+
<span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span> <span class='id identifier rubyid_reject'><span class='object_link'><a href="../top-level-namespace.html#reject-instance_method" title="#reject (method)">reject</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_l'>l</span><span class='comma'>,</span> <span class='symbol'>:resource_url</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
919
|
+
<span class='kw'>else</span>
|
|
920
|
+
<span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='symbol'>:sms_thread</span><span class='rparen'>)</span>
|
|
921
|
+
<span class='id identifier rubyid_reject'><span class='object_link'><a href="../top-level-namespace.html#reject-instance_method" title="#reject (method)">reject</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='symbol'>:resource_url</span><span class='rparen'>)</span>
|
|
922
|
+
<span class='kw'>end</span>
|
|
923
|
+
<span class='kw'>end</span>
|
|
924
|
+
<span class='kw'>end</span>
|
|
925
|
+
<span class='kw'>end</span></pre>
|
|
926
|
+
</td>
|
|
927
|
+
</tr>
|
|
928
|
+
</table>
|
|
929
|
+
</div>
|
|
930
|
+
|
|
931
|
+
<div class="method_details ">
|
|
932
|
+
<h3 class="signature " id="get_messages_in_thread-class_method">
|
|
933
|
+
|
|
934
|
+
.<strong>get_messages_in_thread</strong>(params) ⇒ <tt>Object</tt>
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
|
|
938
|
+
|
|
939
|
+
|
|
940
|
+
</h3><div class="docstring">
|
|
941
|
+
<div class="discussion">
|
|
942
|
+
|
|
943
|
+
<p>Read all messages in a thread</p>
|
|
944
|
+
|
|
945
|
+
|
|
946
|
+
</div>
|
|
947
|
+
</div>
|
|
948
|
+
<div class="tags">
|
|
949
|
+
<p class="tag_title">Parameters:</p>
|
|
950
|
+
<ul class="param">
|
|
951
|
+
|
|
952
|
+
<li>
|
|
953
|
+
|
|
954
|
+
<span class='name'>params</span>
|
|
955
|
+
|
|
956
|
+
|
|
957
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
958
|
+
|
|
959
|
+
|
|
960
|
+
|
|
961
|
+
</li>
|
|
962
|
+
|
|
963
|
+
</ul>
|
|
964
|
+
|
|
965
|
+
|
|
966
|
+
|
|
967
|
+
|
|
968
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
|
969
|
+
<ul class="option">
|
|
970
|
+
|
|
971
|
+
<li>
|
|
972
|
+
<span class="name">:type</span>
|
|
973
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
974
|
+
<span class="default">
|
|
975
|
+
|
|
976
|
+
</span>
|
|
977
|
+
|
|
978
|
+
— <div class='inline'>
|
|
979
|
+
<p>Type of conversation. Possible values - 'sms'. Check
|
|
980
|
+
Conversation.types for more options</p>
|
|
981
|
+
</div>
|
|
982
|
+
|
|
983
|
+
</li>
|
|
984
|
+
|
|
985
|
+
<li>
|
|
986
|
+
<span class="name">:remote_address</span>
|
|
987
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
988
|
+
<span class="default">
|
|
989
|
+
|
|
990
|
+
</span>
|
|
991
|
+
|
|
992
|
+
— <div class='inline'>
|
|
993
|
+
<p>Remote address information while retrieving the conversation history,
|
|
994
|
+
basically the destination telephone number that user exchanged message
|
|
995
|
+
before. E164 formatted DID number passed as a value.</p>
|
|
996
|
+
</div>
|
|
997
|
+
|
|
998
|
+
</li>
|
|
999
|
+
|
|
1000
|
+
<li>
|
|
1001
|
+
<span class="name">:local_address</span>
|
|
1002
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
1003
|
+
<span class="default">
|
|
1004
|
+
|
|
1005
|
+
</span>
|
|
1006
|
+
|
|
1007
|
+
— <div class='inline'>
|
|
1008
|
+
<p>Local address information while retrieving the conversation history,
|
|
1009
|
+
basically the source telephone number that user exchanged message before.</p>
|
|
1010
|
+
</div>
|
|
1011
|
+
|
|
1012
|
+
</li>
|
|
1013
|
+
|
|
1014
|
+
<li>
|
|
1015
|
+
<span class="name">:query[:next]</span>
|
|
1016
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
1017
|
+
<span class="default">
|
|
1018
|
+
|
|
1019
|
+
</span>
|
|
1020
|
+
|
|
1021
|
+
— <div class='inline'>
|
|
1022
|
+
<p><code>optional</code> - Pointer for the next page to retrieve for the
|
|
1023
|
+
messages, provided by CPaaS in previous GET response.</p>
|
|
1024
|
+
</div>
|
|
1025
|
+
|
|
1026
|
+
</li>
|
|
1027
|
+
|
|
1028
|
+
<li>
|
|
1029
|
+
<span class="name">:query[:max]</span>
|
|
1030
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
1031
|
+
<span class="default">
|
|
1032
|
+
|
|
1033
|
+
</span>
|
|
1034
|
+
|
|
1035
|
+
— <div class='inline'>
|
|
1036
|
+
<p><code>optional</code> - Number of messages that is requested from CPaaS.</p>
|
|
1037
|
+
</div>
|
|
1038
|
+
|
|
1039
|
+
</li>
|
|
1040
|
+
|
|
1041
|
+
<li>
|
|
1042
|
+
<span class="name">:query[:new]</span>
|
|
1043
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
1044
|
+
<span class="default">
|
|
1045
|
+
|
|
1046
|
+
</span>
|
|
1047
|
+
|
|
1048
|
+
— <div class='inline'>
|
|
1049
|
+
<p><code>optional</code> - Filters the messages or threads having messages
|
|
1050
|
+
that are not received by the user yet.</p>
|
|
1051
|
+
</div>
|
|
1052
|
+
|
|
1053
|
+
</li>
|
|
1054
|
+
|
|
1055
|
+
<li>
|
|
1056
|
+
<span class="name">:query[:last_Message_Time]</span>
|
|
1057
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
1058
|
+
<span class="default">
|
|
1059
|
+
|
|
1060
|
+
</span>
|
|
1061
|
+
|
|
1062
|
+
— <div class='inline'>
|
|
1063
|
+
<p><code>optional</code> - Filters the messages or threads having messages
|
|
1064
|
+
that are sent/received after provided Epoch time</p>
|
|
1065
|
+
</div>
|
|
1066
|
+
|
|
1067
|
+
</li>
|
|
1068
|
+
|
|
1069
|
+
</ul>
|
|
1070
|
+
|
|
1071
|
+
|
|
1072
|
+
|
|
1073
|
+
</div><table class="source_code">
|
|
1074
|
+
<tr>
|
|
1075
|
+
<td>
|
|
1076
|
+
<pre class="lines">
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
119
|
|
1080
|
+
120
|
|
1081
|
+
121
|
|
1082
|
+
122
|
|
1083
|
+
123
|
|
1084
|
+
124
|
|
1085
|
+
125
|
|
1086
|
+
126
|
|
1087
|
+
127
|
|
1088
|
+
128
|
|
1089
|
+
129
|
|
1090
|
+
130
|
|
1091
|
+
131
|
|
1092
|
+
132</pre>
|
|
1093
|
+
</td>
|
|
1094
|
+
<td>
|
|
1095
|
+
<pre class="code"><span class="info file"># File 'lib/cpaas/resources/conversation.rb', line 119</span>
|
|
1096
|
+
|
|
1097
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_messages_in_thread'>get_messages_in_thread</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
1098
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_types'>types</span><span class='lbracket'>[</span><span class='symbol'>:SMS</span><span class='rbracket'>]</span>
|
|
1099
|
+
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1100
|
+
<span class='label'>query:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:query</span><span class='rbracket'>]</span>
|
|
1101
|
+
<span class='rbrace'>}</span>
|
|
1102
|
+
|
|
1103
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Cpaas.html" title="Cpaas (module)">Cpaas</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api'><span class='object_link'><a href="../Cpaas.html#api-class_method" title="Cpaas.api (method)">api</a></span></span><span class='period'>.</span><span class='id identifier rubyid_send_request'>send_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_base_url'>base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/remoteAddresses/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:remote_address</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>/localAddresses/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:local_address</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>/messages</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
1104
|
+
|
|
1105
|
+
<span class='id identifier rubyid_process_response'><span class='object_link'><a href="../top-level-namespace.html#process_response-instance_method" title="#process_response (method)">process_response</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_res'>res</span><span class='op'>|</span>
|
|
1106
|
+
<span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='symbol'>:sms_message_list</span><span class='comma'>,</span> <span class='symbol'>:sms_message</span><span class='rparen'>)</span>
|
|
1107
|
+
<span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_m'>m</span><span class='op'>|</span> <span class='id identifier rubyid_reject'><span class='object_link'><a href="../top-level-namespace.html#reject-instance_method" title="#reject (method)">reject</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_m'>m</span><span class='comma'>,</span> <span class='symbol'>:resource_url</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
1108
|
+
<span class='kw'>end</span>
|
|
1109
|
+
<span class='kw'>end</span>
|
|
1110
|
+
<span class='kw'>end</span></pre>
|
|
1111
|
+
</td>
|
|
1112
|
+
</tr>
|
|
1113
|
+
</table>
|
|
1114
|
+
</div>
|
|
1115
|
+
|
|
1116
|
+
<div class="method_details ">
|
|
1117
|
+
<h3 class="signature " id="get_status-class_method">
|
|
1118
|
+
|
|
1119
|
+
.<strong>get_status</strong>(params) ⇒ <tt>Object</tt>
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
</h3><div class="docstring">
|
|
1126
|
+
<div class="discussion">
|
|
1127
|
+
|
|
1128
|
+
<p>Read a conversation message status</p>
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
</div>
|
|
1132
|
+
</div>
|
|
1133
|
+
<div class="tags">
|
|
1134
|
+
<p class="tag_title">Parameters:</p>
|
|
1135
|
+
<ul class="param">
|
|
1136
|
+
|
|
1137
|
+
<li>
|
|
1138
|
+
|
|
1139
|
+
<span class='name'>params</span>
|
|
1140
|
+
|
|
1141
|
+
|
|
1142
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1143
|
+
|
|
1144
|
+
|
|
1145
|
+
|
|
1146
|
+
</li>
|
|
1147
|
+
|
|
1148
|
+
</ul>
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
|
|
1152
|
+
|
|
1153
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
|
1154
|
+
<ul class="option">
|
|
1155
|
+
|
|
1156
|
+
<li>
|
|
1157
|
+
<span class="name">:type</span>
|
|
1158
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
1159
|
+
<span class="default">
|
|
1160
|
+
|
|
1161
|
+
</span>
|
|
1162
|
+
|
|
1163
|
+
— <div class='inline'>
|
|
1164
|
+
<p>Type of conversation. Possible values - 'sms'. Check
|
|
1165
|
+
Conversation.types for more options</p>
|
|
1166
|
+
</div>
|
|
1167
|
+
|
|
1168
|
+
</li>
|
|
1169
|
+
|
|
1170
|
+
<li>
|
|
1171
|
+
<span class="name">:remote_address</span>
|
|
1172
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
1173
|
+
<span class="default">
|
|
1174
|
+
|
|
1175
|
+
</span>
|
|
1176
|
+
|
|
1177
|
+
— <div class='inline'>
|
|
1178
|
+
<p>Remote address information while retrieving the conversation history,
|
|
1179
|
+
basically the destination telephone number that user exchanged message
|
|
1180
|
+
before. E164 formatted DID number passed as a value.</p>
|
|
1181
|
+
</div>
|
|
1182
|
+
|
|
1183
|
+
</li>
|
|
1184
|
+
|
|
1185
|
+
<li>
|
|
1186
|
+
<span class="name">:local_address</span>
|
|
1187
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
1188
|
+
<span class="default">
|
|
1189
|
+
|
|
1190
|
+
</span>
|
|
1191
|
+
|
|
1192
|
+
— <div class='inline'>
|
|
1193
|
+
<p>Local address information while retrieving the conversation history,
|
|
1194
|
+
basically the source telephone number that user exchanged message before.</p>
|
|
1195
|
+
</div>
|
|
1196
|
+
|
|
1197
|
+
</li>
|
|
1198
|
+
|
|
1199
|
+
<li>
|
|
1200
|
+
<span class="name">:message_id</span>
|
|
1201
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
1202
|
+
<span class="default">
|
|
1203
|
+
|
|
1204
|
+
</span>
|
|
1205
|
+
|
|
1206
|
+
— <div class='inline'>
|
|
1207
|
+
<p>Identification of the message. If messeageId is not passsed then the
|
|
1208
|
+
conversation thread is deleted with all messages.</p>
|
|
1209
|
+
</div>
|
|
1210
|
+
|
|
1211
|
+
</li>
|
|
1212
|
+
|
|
1213
|
+
</ul>
|
|
1214
|
+
|
|
1215
|
+
|
|
1216
|
+
|
|
1217
|
+
</div><table class="source_code">
|
|
1218
|
+
<tr>
|
|
1219
|
+
<td>
|
|
1220
|
+
<pre class="lines">
|
|
1221
|
+
|
|
1222
|
+
|
|
1223
|
+
143
|
|
1224
|
+
144
|
|
1225
|
+
145
|
|
1226
|
+
146
|
|
1227
|
+
147</pre>
|
|
1228
|
+
</td>
|
|
1229
|
+
<td>
|
|
1230
|
+
<pre class="code"><span class="info file"># File 'lib/cpaas/resources/conversation.rb', line 143</span>
|
|
1231
|
+
|
|
1232
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_status'>get_status</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
1233
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_types'>types</span><span class='lbracket'>[</span><span class='symbol'>:SMS</span><span class='rbracket'>]</span>
|
|
1234
|
+
<span class='const'><span class='object_link'><a href="../Cpaas.html" title="Cpaas (module)">Cpaas</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api'><span class='object_link'><a href="../Cpaas.html#api-class_method" title="Cpaas.api (method)">api</a></span></span><span class='period'>.</span><span class='id identifier rubyid_send_request'>send_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_base_url'>base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/remoteAddresses/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:remote_address</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>/localAddresses/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:local_address</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>/messages/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:message_id</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>/status</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1235
|
+
<span class='kw'>end</span>
|
|
1236
|
+
<span class='kw'>end</span></pre>
|
|
1237
|
+
</td>
|
|
1238
|
+
</tr>
|
|
1239
|
+
</table>
|
|
1240
|
+
</div>
|
|
1241
|
+
|
|
1242
|
+
<div class="method_details ">
|
|
1243
|
+
<h3 class="signature " id="get_subscription-class_method">
|
|
1244
|
+
|
|
1245
|
+
.<strong>get_subscription</strong>(params) ⇒ <tt>Object</tt>
|
|
1246
|
+
|
|
1247
|
+
|
|
1248
|
+
|
|
1249
|
+
|
|
1250
|
+
|
|
1251
|
+
</h3><div class="docstring">
|
|
1252
|
+
<div class="discussion">
|
|
1253
|
+
|
|
1254
|
+
<p>Read active subscription</p>
|
|
1255
|
+
|
|
1256
|
+
|
|
1257
|
+
</div>
|
|
1258
|
+
</div>
|
|
1259
|
+
<div class="tags">
|
|
1260
|
+
<p class="tag_title">Parameters:</p>
|
|
1261
|
+
<ul class="param">
|
|
1262
|
+
|
|
1263
|
+
<li>
|
|
1264
|
+
|
|
1265
|
+
<span class='name'>params</span>
|
|
1266
|
+
|
|
1267
|
+
|
|
1268
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1269
|
+
|
|
1270
|
+
|
|
1271
|
+
|
|
1272
|
+
</li>
|
|
1273
|
+
|
|
1274
|
+
</ul>
|
|
1275
|
+
|
|
1276
|
+
|
|
1277
|
+
|
|
1278
|
+
|
|
1279
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
|
1280
|
+
<ul class="option">
|
|
1281
|
+
|
|
1282
|
+
<li>
|
|
1283
|
+
<span class="name">:type</span>
|
|
1284
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
1285
|
+
<span class="default">
|
|
1286
|
+
|
|
1287
|
+
</span>
|
|
1288
|
+
|
|
1289
|
+
— <div class='inline'>
|
|
1290
|
+
<p>Type of conversation. Possible values - 'sms'. Check
|
|
1291
|
+
Conversation.types for more options</p>
|
|
1292
|
+
</div>
|
|
1293
|
+
|
|
1294
|
+
</li>
|
|
1295
|
+
|
|
1296
|
+
<li>
|
|
1297
|
+
<span class="name">:subscription_id</span>
|
|
1298
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
1299
|
+
<span class="default">
|
|
1300
|
+
|
|
1301
|
+
</span>
|
|
1302
|
+
|
|
1303
|
+
— <div class='inline'>
|
|
1304
|
+
<p>Resource ID of the subscription</p>
|
|
1305
|
+
</div>
|
|
1306
|
+
|
|
1307
|
+
</li>
|
|
1308
|
+
|
|
1309
|
+
</ul>
|
|
1310
|
+
|
|
1311
|
+
|
|
1312
|
+
|
|
1313
|
+
</div><table class="source_code">
|
|
1314
|
+
<tr>
|
|
1315
|
+
<td>
|
|
1316
|
+
<pre class="lines">
|
|
1317
|
+
|
|
1318
|
+
|
|
1319
|
+
179
|
|
1320
|
+
180
|
|
1321
|
+
181
|
|
1322
|
+
182
|
|
1323
|
+
183
|
|
1324
|
+
184
|
|
1325
|
+
185
|
|
1326
|
+
186
|
|
1327
|
+
187
|
|
1328
|
+
188
|
|
1329
|
+
189
|
|
1330
|
+
190
|
|
1331
|
+
191
|
|
1332
|
+
192
|
|
1333
|
+
193</pre>
|
|
1334
|
+
</td>
|
|
1335
|
+
<td>
|
|
1336
|
+
<pre class="code"><span class="info file"># File 'lib/cpaas/resources/conversation.rb', line 179</span>
|
|
1337
|
+
|
|
1338
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_subscription'>get_subscription</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
1339
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_types'>types</span><span class='lbracket'>[</span><span class='symbol'>:SMS</span><span class='rbracket'>]</span>
|
|
1340
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Cpaas.html" title="Cpaas (module)">Cpaas</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api'><span class='object_link'><a href="../Cpaas.html#api-class_method" title="Cpaas.api (method)">api</a></span></span><span class='period'>.</span><span class='id identifier rubyid_send_request'>send_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_base_url'>base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/inbound/subscriptions/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:subscription_id</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1341
|
+
|
|
1342
|
+
<span class='id identifier rubyid_process_response'><span class='object_link'><a href="../top-level-namespace.html#process_response-instance_method" title="#process_response (method)">process_response</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_res'>res</span><span class='op'>|</span>
|
|
1343
|
+
<span class='id identifier rubyid_subscription'>subscription</span> <span class='op'>=</span> <span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='symbol'>:subscription</span><span class='rparen'>)</span>
|
|
1344
|
+
|
|
1345
|
+
<span class='lbrace'>{</span>
|
|
1346
|
+
<span class='label'>notify_url:</span> <span class='id identifier rubyid_subscription'>subscription</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='symbol'>:callback_reference</span><span class='comma'>,</span> <span class='symbol'>:notify_url</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
1347
|
+
<span class='label'>destination_address:</span> <span class='id identifier rubyid_subscription'>subscription</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='symbol'>:destination_address</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
1348
|
+
<span class='label'>subscription_id:</span> <span class='id identifier rubyid_id_from'><span class='object_link'><a href="../top-level-namespace.html#id_from-instance_method" title="#id_from (method)">id_from</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_subscription'>subscription</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='symbol'>:resource_url</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
1349
|
+
<span class='rbrace'>}</span>
|
|
1350
|
+
<span class='kw'>end</span>
|
|
1351
|
+
<span class='kw'>end</span>
|
|
1352
|
+
<span class='kw'>end</span></pre>
|
|
1353
|
+
</td>
|
|
1354
|
+
</tr>
|
|
1355
|
+
</table>
|
|
1356
|
+
</div>
|
|
1357
|
+
|
|
1358
|
+
<div class="method_details ">
|
|
1359
|
+
<h3 class="signature " id="get_subscriptions-class_method">
|
|
1360
|
+
|
|
1361
|
+
.<strong>get_subscriptions</strong>(params) ⇒ <tt>Object</tt>
|
|
1362
|
+
|
|
1363
|
+
|
|
1364
|
+
|
|
1365
|
+
|
|
1366
|
+
|
|
1367
|
+
</h3><div class="docstring">
|
|
1368
|
+
<div class="discussion">
|
|
1369
|
+
|
|
1370
|
+
<p>Read all active subscriptions</p>
|
|
1371
|
+
|
|
1372
|
+
|
|
1373
|
+
</div>
|
|
1374
|
+
</div>
|
|
1375
|
+
<div class="tags">
|
|
1376
|
+
<p class="tag_title">Parameters:</p>
|
|
1377
|
+
<ul class="param">
|
|
1378
|
+
|
|
1379
|
+
<li>
|
|
1380
|
+
|
|
1381
|
+
<span class='name'>params</span>
|
|
1382
|
+
|
|
1383
|
+
|
|
1384
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1385
|
+
|
|
1386
|
+
|
|
1387
|
+
|
|
1388
|
+
—
|
|
1389
|
+
<div class='inline'>
|
|
1390
|
+
<p>a customizable set of options</p>
|
|
1391
|
+
</div>
|
|
1392
|
+
|
|
1393
|
+
</li>
|
|
1394
|
+
|
|
1395
|
+
</ul>
|
|
1396
|
+
|
|
1397
|
+
|
|
1398
|
+
|
|
1399
|
+
|
|
1400
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
|
1401
|
+
<ul class="option">
|
|
1402
|
+
|
|
1403
|
+
<li>
|
|
1404
|
+
<span class="name">:type</span>
|
|
1405
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
1406
|
+
<span class="default">
|
|
1407
|
+
|
|
1408
|
+
</span>
|
|
1409
|
+
|
|
1410
|
+
— <div class='inline'>
|
|
1411
|
+
<p>Type of conversation. Possible values - 'sms'. Check
|
|
1412
|
+
Conversation.types for more options</p>
|
|
1413
|
+
</div>
|
|
1414
|
+
|
|
1415
|
+
</li>
|
|
1416
|
+
|
|
1417
|
+
</ul>
|
|
1418
|
+
|
|
1419
|
+
|
|
1420
|
+
|
|
1421
|
+
</div><table class="source_code">
|
|
1422
|
+
<tr>
|
|
1423
|
+
<td>
|
|
1424
|
+
<pre class="lines">
|
|
1425
|
+
|
|
1426
|
+
|
|
1427
|
+
155
|
|
1428
|
+
156
|
|
1429
|
+
157
|
|
1430
|
+
158
|
|
1431
|
+
159
|
|
1432
|
+
160
|
|
1433
|
+
161
|
|
1434
|
+
162
|
|
1435
|
+
163
|
|
1436
|
+
164
|
|
1437
|
+
165
|
|
1438
|
+
166
|
|
1439
|
+
167
|
|
1440
|
+
168
|
|
1441
|
+
169
|
|
1442
|
+
170</pre>
|
|
1443
|
+
</td>
|
|
1444
|
+
<td>
|
|
1445
|
+
<pre class="code"><span class="info file"># File 'lib/cpaas/resources/conversation.rb', line 155</span>
|
|
1446
|
+
|
|
1447
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_get_subscriptions'>get_subscriptions</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
1448
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_types'>types</span><span class='lbracket'>[</span><span class='symbol'>:SMS</span><span class='rbracket'>]</span>
|
|
1449
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Cpaas.html" title="Cpaas (module)">Cpaas</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api'><span class='object_link'><a href="../Cpaas.html#api-class_method" title="Cpaas.api (method)">api</a></span></span><span class='period'>.</span><span class='id identifier rubyid_send_request'>send_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_base_url'>base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/inbound/subscriptions</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1450
|
+
|
|
1451
|
+
<span class='id identifier rubyid_process_response'><span class='object_link'><a href="../top-level-namespace.html#process_response-instance_method" title="#process_response (method)">process_response</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_res'>res</span><span class='op'>|</span>
|
|
1452
|
+
<span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='symbol'>:subscription_list</span><span class='comma'>,</span> <span class='symbol'>:subscription</span><span class='rparen'>)</span>
|
|
1453
|
+
<span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_subscriptions'>subscriptions</span><span class='op'>|</span>
|
|
1454
|
+
<span class='lbrace'>{</span>
|
|
1455
|
+
<span class='label'>notify_url:</span> <span class='id identifier rubyid_subscription'>subscription</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='symbol'>:callback_reference</span><span class='comma'>,</span> <span class='symbol'>:notify_url</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
1456
|
+
<span class='label'>destination_address:</span> <span class='id identifier rubyid_subscription'>subscription</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='symbol'>:destination_address</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
1457
|
+
<span class='label'>subscription_id:</span> <span class='id identifier rubyid_id_from'><span class='object_link'><a href="../top-level-namespace.html#id_from-instance_method" title="#id_from (method)">id_from</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_subscription'>subscription</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='symbol'>:resource_url</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
1458
|
+
<span class='rbrace'>}</span>
|
|
1459
|
+
<span class='kw'>end</span>
|
|
1460
|
+
<span class='kw'>end</span>
|
|
1461
|
+
<span class='kw'>end</span>
|
|
1462
|
+
<span class='kw'>end</span></pre>
|
|
1463
|
+
</td>
|
|
1464
|
+
</tr>
|
|
1465
|
+
</table>
|
|
1466
|
+
</div>
|
|
1467
|
+
|
|
1468
|
+
<div class="method_details ">
|
|
1469
|
+
<h3 class="signature " id="subscribe-class_method">
|
|
1470
|
+
|
|
1471
|
+
.<strong>subscribe</strong>(params) ⇒ <tt>Object</tt>
|
|
1472
|
+
|
|
1473
|
+
|
|
1474
|
+
|
|
1475
|
+
|
|
1476
|
+
|
|
1477
|
+
</h3><div class="docstring">
|
|
1478
|
+
<div class="discussion">
|
|
1479
|
+
|
|
1480
|
+
<p>Create a new subscription</p>
|
|
1481
|
+
|
|
1482
|
+
|
|
1483
|
+
</div>
|
|
1484
|
+
</div>
|
|
1485
|
+
<div class="tags">
|
|
1486
|
+
<p class="tag_title">Parameters:</p>
|
|
1487
|
+
<ul class="param">
|
|
1488
|
+
|
|
1489
|
+
<li>
|
|
1490
|
+
|
|
1491
|
+
<span class='name'>params</span>
|
|
1492
|
+
|
|
1493
|
+
|
|
1494
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
|
|
1498
|
+
</li>
|
|
1499
|
+
|
|
1500
|
+
</ul>
|
|
1501
|
+
|
|
1502
|
+
|
|
1503
|
+
|
|
1504
|
+
|
|
1505
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
|
1506
|
+
<ul class="option">
|
|
1507
|
+
|
|
1508
|
+
<li>
|
|
1509
|
+
<span class="name">:type</span>
|
|
1510
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
1511
|
+
<span class="default">
|
|
1512
|
+
|
|
1513
|
+
</span>
|
|
1514
|
+
|
|
1515
|
+
— <div class='inline'>
|
|
1516
|
+
<p>Type of conversation. Possible values - 'sms'. Check
|
|
1517
|
+
Conversation.types for more options</p>
|
|
1518
|
+
</div>
|
|
1519
|
+
|
|
1520
|
+
</li>
|
|
1521
|
+
|
|
1522
|
+
<li>
|
|
1523
|
+
<span class="name">:webhook_url</span>
|
|
1524
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
1525
|
+
<span class="default">
|
|
1526
|
+
|
|
1527
|
+
</span>
|
|
1528
|
+
|
|
1529
|
+
— <div class='inline'>
|
|
1530
|
+
<p>The notification channel ID that has been acquired during
|
|
1531
|
+
/notificationchannel API subscription, either websockets, mobile push or
|
|
1532
|
+
webhooks type, which the incoming notifications supposed to be sent to.</p>
|
|
1533
|
+
</div>
|
|
1534
|
+
|
|
1535
|
+
</li>
|
|
1536
|
+
|
|
1537
|
+
<li>
|
|
1538
|
+
<span class="name">:destination_address</span>
|
|
1539
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
1540
|
+
<span class="default">
|
|
1541
|
+
|
|
1542
|
+
</span>
|
|
1543
|
+
|
|
1544
|
+
— <div class='inline'>
|
|
1545
|
+
<p><code>optional</code> The address that incoming messages are received for
|
|
1546
|
+
this subscription. If does not exist, CPaaS uses the default assigned DID
|
|
1547
|
+
number to subscribe against. It is suggested to provide the intended E164
|
|
1548
|
+
formatted DID number within this parameter.</p>
|
|
1549
|
+
</div>
|
|
1550
|
+
|
|
1551
|
+
</li>
|
|
1552
|
+
|
|
1553
|
+
</ul>
|
|
1554
|
+
|
|
1555
|
+
|
|
1556
|
+
|
|
1557
|
+
</div><table class="source_code">
|
|
1558
|
+
<tr>
|
|
1559
|
+
<td>
|
|
1560
|
+
<pre class="lines">
|
|
1561
|
+
|
|
1562
|
+
|
|
1563
|
+
204
|
|
1564
|
+
205
|
|
1565
|
+
206
|
|
1566
|
+
207
|
|
1567
|
+
208
|
|
1568
|
+
209
|
|
1569
|
+
210
|
|
1570
|
+
211
|
|
1571
|
+
212
|
|
1572
|
+
213
|
|
1573
|
+
214
|
|
1574
|
+
215
|
|
1575
|
+
216
|
|
1576
|
+
217
|
|
1577
|
+
218
|
|
1578
|
+
219
|
|
1579
|
+
220
|
|
1580
|
+
221
|
|
1581
|
+
222
|
|
1582
|
+
223
|
|
1583
|
+
224
|
|
1584
|
+
225
|
|
1585
|
+
226
|
|
1586
|
+
227
|
|
1587
|
+
228
|
|
1588
|
+
229
|
|
1589
|
+
230
|
|
1590
|
+
231
|
|
1591
|
+
232</pre>
|
|
1592
|
+
</td>
|
|
1593
|
+
<td>
|
|
1594
|
+
<pre class="code"><span class="info file"># File 'lib/cpaas/resources/conversation.rb', line 204</span>
|
|
1595
|
+
|
|
1596
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_subscribe'>subscribe</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
1597
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_types'>types</span><span class='lbracket'>[</span><span class='symbol'>:SMS</span><span class='rbracket'>]</span>
|
|
1598
|
+
<span class='id identifier rubyid_channel'>channel</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Cpaas.html" title="Cpaas (module)">Cpaas</a></span></span><span class='op'>::</span><span class='const'>NotificationChannel</span><span class='period'>.</span><span class='id identifier rubyid_create_channel'>create_channel</span><span class='lparen'>(</span><span class='label'>webhook_url:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:webhook_url</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
1599
|
+
|
|
1600
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_channel'>channel</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_channel'>channel</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='symbol'>:exception_id</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
1601
|
+
|
|
1602
|
+
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1603
|
+
<span class='label'>body:</span> <span class='lbrace'>{</span>
|
|
1604
|
+
<span class='label'>subscription:</span> <span class='lbrace'>{</span>
|
|
1605
|
+
<span class='label'>callbackReference:</span> <span class='lbrace'>{</span>
|
|
1606
|
+
<span class='label'>notifyURL:</span> <span class='id identifier rubyid_channel'>channel</span><span class='lbracket'>[</span><span class='symbol'>:channel_id</span><span class='rbracket'>]</span>
|
|
1607
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
1608
|
+
<span class='label'>clientCorrelator:</span> <span class='const'><span class='object_link'><a href="../Cpaas.html" title="Cpaas (module)">Cpaas</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api'><span class='object_link'><a href="../Cpaas.html#api-class_method" title="Cpaas.api (method)">api</a></span></span><span class='period'>.</span><span class='id identifier rubyid_client_correlator'>client_correlator</span><span class='comma'>,</span>
|
|
1609
|
+
<span class='label'>destinationAddress:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:destination_address</span><span class='rbracket'>]</span>
|
|
1610
|
+
<span class='rbrace'>}</span>
|
|
1611
|
+
<span class='rbrace'>}</span>
|
|
1612
|
+
<span class='rbrace'>}</span>
|
|
1613
|
+
|
|
1614
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Cpaas.html" title="Cpaas (module)">Cpaas</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api'><span class='object_link'><a href="../Cpaas.html#api-class_method" title="Cpaas.api (method)">api</a></span></span><span class='period'>.</span><span class='id identifier rubyid_send_request'>send_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_base_url'>base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/inbound/subscriptions</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='comma'>,</span> <span class='symbol'>:post</span><span class='rparen'>)</span>
|
|
1615
|
+
|
|
1616
|
+
<span class='id identifier rubyid_process_response'><span class='object_link'><a href="../top-level-namespace.html#process_response-instance_method" title="#process_response (method)">process_response</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_res'>res</span><span class='op'>|</span>
|
|
1617
|
+
<span class='lbrace'>{</span>
|
|
1618
|
+
<span class='label'>webhook_url:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:webhook_url</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
1619
|
+
<span class='label'>destination_address:</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='symbol'>:subscription</span><span class='comma'>,</span> <span class='symbol'>:destination_address</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
1620
|
+
<span class='label'>subscription_id:</span> <span class='id identifier rubyid_id_from'><span class='object_link'><a href="../top-level-namespace.html#id_from-instance_method" title="#id_from (method)">id_from</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='symbol'>:subscription</span><span class='comma'>,</span> <span class='symbol'>:resource_url</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
1621
|
+
<span class='rbrace'>}</span>
|
|
1622
|
+
<span class='kw'>end</span>
|
|
1623
|
+
<span class='kw'>end</span>
|
|
1624
|
+
<span class='kw'>end</span></pre>
|
|
1625
|
+
</td>
|
|
1626
|
+
</tr>
|
|
1627
|
+
</table>
|
|
1628
|
+
</div>
|
|
1629
|
+
|
|
1630
|
+
<div class="method_details ">
|
|
1631
|
+
<h3 class="signature " id="unsubscribe-class_method">
|
|
1632
|
+
|
|
1633
|
+
.<strong>unsubscribe</strong>(params = {}) ⇒ <tt>Object</tt>
|
|
1634
|
+
|
|
1635
|
+
|
|
1636
|
+
|
|
1637
|
+
|
|
1638
|
+
|
|
1639
|
+
</h3><div class="docstring">
|
|
1640
|
+
<div class="discussion">
|
|
1641
|
+
|
|
1642
|
+
<p>Unsubscription from conversation notification</p>
|
|
1643
|
+
|
|
1644
|
+
|
|
1645
|
+
</div>
|
|
1646
|
+
</div>
|
|
1647
|
+
<div class="tags">
|
|
1648
|
+
<p class="tag_title">Parameters:</p>
|
|
1649
|
+
<ul class="param">
|
|
1650
|
+
|
|
1651
|
+
<li>
|
|
1652
|
+
|
|
1653
|
+
<span class='name'>params</span>
|
|
1654
|
+
|
|
1655
|
+
|
|
1656
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1657
|
+
|
|
1658
|
+
|
|
1659
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
1660
|
+
|
|
1661
|
+
|
|
1662
|
+
</li>
|
|
1663
|
+
|
|
1664
|
+
</ul>
|
|
1665
|
+
|
|
1666
|
+
|
|
1667
|
+
|
|
1668
|
+
|
|
1669
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
|
1670
|
+
<ul class="option">
|
|
1671
|
+
|
|
1672
|
+
<li>
|
|
1673
|
+
<span class="name">:subscription_id</span>
|
|
1674
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
1675
|
+
<span class="default">
|
|
1676
|
+
|
|
1677
|
+
</span>
|
|
1678
|
+
|
|
1679
|
+
— <div class='inline'>
|
|
1680
|
+
<p>Resource ID of the subscription.</p>
|
|
1681
|
+
</div>
|
|
1682
|
+
|
|
1683
|
+
</li>
|
|
1684
|
+
|
|
1685
|
+
</ul>
|
|
1686
|
+
|
|
1687
|
+
|
|
1688
|
+
|
|
1689
|
+
</div><table class="source_code">
|
|
1690
|
+
<tr>
|
|
1691
|
+
<td>
|
|
1692
|
+
<pre class="lines">
|
|
1693
|
+
|
|
1694
|
+
|
|
1695
|
+
241
|
|
1696
|
+
242
|
|
1697
|
+
243
|
|
1698
|
+
244
|
|
1699
|
+
245
|
|
1700
|
+
246
|
|
1701
|
+
247
|
|
1702
|
+
248
|
|
1703
|
+
249
|
|
1704
|
+
250
|
|
1705
|
+
251
|
|
1706
|
+
252
|
|
1707
|
+
253</pre>
|
|
1708
|
+
</td>
|
|
1709
|
+
<td>
|
|
1710
|
+
<pre class="code"><span class="info file"># File 'lib/cpaas/resources/conversation.rb', line 241</span>
|
|
1711
|
+
|
|
1712
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_unsubscribe'>unsubscribe</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1713
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_types'>types</span><span class='lbracket'>[</span><span class='symbol'>:SMS</span><span class='rbracket'>]</span>
|
|
1714
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Cpaas.html" title="Cpaas (module)">Cpaas</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api'><span class='object_link'><a href="../Cpaas.html#api-class_method" title="Cpaas.api (method)">api</a></span></span><span class='period'>.</span><span class='id identifier rubyid_send_request'>send_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_base_url'>base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/inbound/subscriptions/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:subscription_id</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='symbol'>:delete</span><span class='rparen'>)</span>
|
|
1715
|
+
|
|
1716
|
+
<span class='id identifier rubyid_process_response'><span class='object_link'><a href="../top-level-namespace.html#process_response-instance_method" title="#process_response (method)">process_response</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_res'>res</span><span class='op'>|</span>
|
|
1717
|
+
<span class='lbrace'>{</span>
|
|
1718
|
+
<span class='label'>subscription_id:</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:subscription_id</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
1719
|
+
<span class='label'>success:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
|
1720
|
+
<span class='label'>message:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Unsubscribed from </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'> conversation notification</span><span class='tstring_end'>"</span></span>
|
|
1721
|
+
<span class='rbrace'>}</span>
|
|
1722
|
+
<span class='kw'>end</span>
|
|
1723
|
+
<span class='kw'>end</span>
|
|
1724
|
+
<span class='kw'>end</span></pre>
|
|
1725
|
+
</td>
|
|
1726
|
+
</tr>
|
|
1727
|
+
</table>
|
|
1728
|
+
</div>
|
|
1729
|
+
|
|
1730
|
+
</div>
|
|
1731
|
+
|
|
1732
|
+
</div>
|
|
1733
|
+
|
|
1734
|
+
<div id="footer">
|
|
1735
|
+
Generated on Thu Oct 17 17:28:29 2019 by
|
|
1736
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1737
|
+
0.9.20 (ruby-2.5.0).
|
|
1738
|
+
</div>
|
|
1739
|
+
|
|
1740
|
+
</div>
|
|
1741
|
+
</body>
|
|
1742
|
+
</html>
|