8000 Merge pull request #355 from twilio/issue-341_update_twiml_documentat… · chiewxia/twilio-python@3d32449 · GitHub
[go: up one dir, main page]
Skip to content

Commit 3d32449

Browse files
dougblackdougblack
authored
Merge pull request twilio#355 from twilio/issue-341_update_twiml_documentation_return_values
Issue 341: Update return values for TwiML code.
2 parents 0f95f99 + d64a9bb commit 3d32449

File tree

2 files changed

+27
-24
lines changed

2 files changed

+27
-24
lines changed

‎twilio/twiml/messaging_response.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ def message(self,
3030
:param action: action URL
3131
:param status_callback: callback URL
3232
:param kwargs: other attributes
33-
:return: <Message> element
33+
:return: <Response> element
3434
"""
3535
return self.append(Message(
3636
body=body,
@@ -49,7 +49,7 @@ def redirect(self, url, method=None, **kwargs):
4949
:param url: URL to redirect to
5050
:param method: HTTP method
5151
:param kwargs: other attributes
52-
:return: <Redirect> element
52+
:return: <Response> element
5353
"""
5454
return self.append(Redirect(
5555
method=method,
@@ -78,7 +78,7 @@ def body(self, body):
7878
Add a <Body> element
7979
8080
:param body: body of message
81-
:return: <Body> element
81+
:return: <Message> element
8282
"""
8383
return self.append(Body(body))
8484

@@ -87,7 +87,7 @@ def media(self, url):
8787
Add a <Media> element
8888
8989
:param url: media URL
90-
:return: <Media> element
90+
:return: <Message> element
9191
"""
9292
return self.append(Media(url))
9393

‎twilio/twiml/voice_response.py

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ def dial(self,
4343
:param recording_status_callback: status callback URL
4444
:param recording_status_callback_method: status callback URL method
4545
:param kwargs: additional attributes
46-
:return: <Dial> element
46+
:return: <Response> element
4747
"""
4848
return self.append(Dial(
4949
number=number,
@@ -64,6 +64,8 @@ def echo(self,
6464
**kwargs):
6565
"""
6666
Add a new <Echo> element
67+
68+
:return: <Response> element
6769
"""
6870
return self.append(Echo(
6971
**kwargs
@@ -87,7 +89,7 @@ def enqueue(self,
8789
:param wait_url_method: wait URL method
8890
:param workflow_sid: TaskRouter workflow SID
8991
:param kwargs: additional attributes
90-
:return: <Enqueue> element
92+
:return: <Response> element
9193
"""
9294
return self.append(Enqueue(
9395
name,
@@ -127,7 +129,7 @@ def gather(self,
127129
:param barge_in: stop playing media upon speech
128130
:param acknowledge_sound_url: url to hit when sound starts
129131
:param kwargs: additional attributes
130-
:return: <Gather> element
132+
:return: <Response> element
131133
"""
132134
return self.append(Gather(
133135
action=action,
@@ -142,15 +144,15 @@ def hangup(self):
142144
"""
143145
Add a new <Hangup> element
144146
145-
:return: <Hangup> element
147+
:return: <Response> element
146148
"""
147149
return self.append(Hangup())
148150

149151
def leave(self):
150152
"""
151153
Add a new <Leave> element
152154
153-
:return: <Leave> element
155+
:return: <Response> element
154156
"""
155157
return self.append(Leave())
156158

@@ -159,7 +161,7 @@ def pause(self, length=None):
159161
Add a new <Pause> element
160162
161163
:param length: time in seconds to pause
162-
:return: <Pause> element
164+
:return: <Response> element
163165
"""
164166
return self.append(Pause(length=length))
165167

@@ -175,7 +177,7 @@ def play(self,
175177
:param loop: times to loop
176178
:param digits: play DTMF tones during a call
177179
:param kwargs: additional attributes
178-
:return: <Play> element
180+
:return: <Response> element
179181
"""
180182
return self.append(Play(
181183
url=url,
@@ -212,7 +214,7 @@ def record(self,
212214
:param transcribe: transcribe the recording
213215
:param transcribe_callback: transcribe callback URL
214216
:param kwargs: additional attributes
215-
:return: <Record> element
217+
:return: <Response> element
216218
"""
217219
return self.append(Record(
218220
action=action,
@@ -236,7 +238,7 @@ def redirect(self, url, method=None, **kwargs):
236238
:param url: redirect url
237239
:param method: redirect method
238240
:param kwargs: additional attributes
239-
:return: <Redirect> element
241+
:return: <Response> element
240242
"""
241243
return self.append(Redirect(url, method=method, **kwargs))
242244

@@ -246,7 +248,7 @@ def reject(self, reason=None, **kwargs):
246248
247249
:param reason: rejection reason
248250
:param kwargs: additional attributes
249-
:return: <Reject> element
251+
:return: <Response> element
250252
"""
251253
return self.append(Reject(reason=reason, **kwargs))
252254

@@ -264,7 +266,7 @@ def say(self,
264266
:param language: language of message
265267
:param voice: voice to use
266268
:param kwargs: additional attributes
267-
:return: <Say> element
269+
:return: <Response> element
268270
"""
269271
return self.append(Say(
270272
body,
@@ -292,7 +294,7 @@ def sms(self,
292294
:param action: action URL
293295
:param status_callback: status callback URL
294296
:param kwargs: additional attributes
295-
:return: <Sms> element
297+
:return: <Response> element
296298
"""
297299
return self.append(Sms(
298300
body,
@@ -338,7 +340,7 @@ def client(self,
338340
:param status_callback_method: status callback URL method
339341
:param status_callback: status callback URL
340342
:param kwargs: additional attributes
341-
:return: <Client> element
343+
:return: <Dial> element
342344
"""
343345
return self.append(Client(
344346
name,
@@ -388,7 +390,7 @@ def conference(self,
388390
:param recording_status_callback: recording status callback URL
389391
:param recording_status_callback_method: recording status callback URL method
390392
:param kwargs: additional attributes
391-
:return: <Conference> element
393+
:return: <Dial> element
392394
"""
393395
return self.append(Conference(
394396
name,
@@ -430,7 +432,7 @@ def number(self,
430432
:param status_callback: status callback URL
431433
:param status_callback_method: status callback URL method
432434
:param kwargs: additional attributes
433-
:return: <Number> element
435+
:return: <Dial> element
434436
"""
435437
return self.append(Number(
436438
number,
@@ -459,7 +461,7 @@ def queue(self,
459461
:param reservation_sid: TaskRouter reservation SID
460462
:param post_work_activity_sid: TaskRouter activity SID
461463
:param kwargs: additional attributes
462-
:return: <Queue> element
464+
:return: <Dial> element
463465
"""
464466
return self.append(Queue(
465467
queue_name,
@@ -477,6 +479,7 @@ def sim(self,
477479
Add a <Sim> element
478480
479481
:param sid: sim sid
482+
:return: <Dial> element
480483
"""
481484
return self.append(Sim(
482485
sid,
@@ -505,7 +508,7 @@ def sip(self,
505508
:param status_callback: status callback URL
506509
:param status_callback_method: status callback URL method
507510
:param kwargs: additional attributes
508-
:return: <Sip> element
511+
:return: <Dial> element
509512
"""
510513
return self.append(Sip(
511514
uri,
@@ -686,7 +689,7 @@ def say(self,
686689
:param language: message language
687690
:param voice: voice to use
688691
:param kwargs: additional attributes
689-
:return: <Say> element
692+
:return: <Gather> element
690693
"""
691694
return self.append(Say(
692695
body,
@@ -708,7 +711,7 @@ def play(self,
708711
:param loop: times to loop
709712
:param digits: digits to simulate
710713
:param kwargs: additional attributes
711-
:return: <Play> element
714+
:return: <Gather> element
712715
"""
713716
return self.append(Play(
714717
url=url,
@@ -722,7 +725,7 @@ def pause(self, length=None):
722725
Add a new <Pause> element
723726
724727
:param length: time to pause
725-
:return: <Pause> element
728+
:return: <Gather> element
726729
"""
727730
return self.append(Pause(length=length))
728731

0 commit comments

Comments
 (0)
0