8000 Use correct rtype for enum properties · jmctwilio/twilio-python@b471f3a · GitHub
[go: up one dir, main page]
Skip to content

Commit b471f3a

Browse files
jingmingjingming
committed
Use correct rtype for enum properties
1 parent 2bb4909 commit b471f3a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+181
-181
lines changed

‎twilio/rest/api/v2010/account/__init__.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ def stream(self, friendly_name=values.unset, status=values.unset, limit=None,
8787
The results are returned as a generator, so this operation is memory efficient.
8888
8989
:param unicode friendly_name: FriendlyName to filter on
90-
:param account.status status: Status to filter on
90+
:param AccountInstance.Status status: Status to filter on
9191
:param int limit: Upper limit for the number of records to return. stream()
9292
guarantees to never return more than limit. Default is no limit
9393
:param int page_size: Number of records to fetch per request, when not set will use
@@ -116,7 +116,7 @@ def list(self, friendly_name=values.unset, status=values.unset, limit=None,
116116
memory before returning.
117117
118118
:param unicode friendly_name: FriendlyName to filter on
119-
:param account.status status: Status to filter on
119+
:param AccountInstance.Status status: Status to filter on
120120
:param int limit: Upper limit for the number of records to return. list() guarantees
121121
never to return more than limit. Default is no limit
122122
:param int page_size: Number of records to fetch per request, when not set will use
@@ -142,7 +142,7 @@ def page(self, friendly_name=values.unset, status=values.unset,
142142
Request is executed immediately
143143
144144
:param unicode friendly_name: FriendlyName to filter on
145-
:param account.status status: Status to filter on
145+
:param AccountInstance.Status status: Status to filter on
146146
:param str page_token: PageToken provided by the API
147147
:param int page_number: Page Number, this value is simply for client state
148148
:param int page_size: Number of records to return, defaults to 50
@@ -316,7 +316,7 @@ def update(self, friendly_name=values.unset, status=values.unset):
316316
Update the AccountInstance
317317
318318
:param unicode friendly_name: FriendlyName to update
319-
:param account.status status: Status to update the Account with
319+
:param AccountInstance.Status status: Status to update the Account with
320320
321321
:returns: Updated AccountInstance
322322
:rtype: twilio.rest.api.v2010.account.AccountInstance
@@ -802,7 +802,7 @@ def sid(self):
802802
def status(self):
803803
"""
804804
:returns: The status of this account
805-
:rtype: account.status
805+
:rtype: AccountInstance.Status
806806
"""
807807
return self._properties['status']
808808

@@ -818,7 +818,7 @@ def subresource_uris(self):
818818
def type(self):
819819
"""
820820
:returns: The type of this account
821-
:rtype: account.type
821+
:rtype: AccountInstance.Type
822822
"""
823823
return self._properties['type']
824824

@@ -844,7 +844,7 @@ def update(self, friendly_name=values.unset, status=values.unset):
844844
Update the AccountInstance
845845
846846
:param unicode friendly_name: FriendlyName to update
847-
:param account.status status: Status to update the Account with
847+
:param AccountInstance.Status status: Status to update the Account with
848848
849849
:returns: Updated AccountInstance
850850
:rtype: twilio.rest.api.v2010.account.AccountInstance

‎twilio/rest/api/v2010/account/authorized_connect_app.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -366,7 +366,7 @@ def date_updated(self):
366366
def permissions(self):
367367
"""
368368
:returns: Permissions authorized to this app
369-
:rtype: authorized_connect_app.permission
369+
:rtype: AuthorizedConnectAppInstance.Permission
370370
"""
371371
return self._properties['permissions']
372372

‎twilio/rest/api/v2010/account/call/__init__.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ def stream(self, to=values.unset, from_=values.unset,
127127
:param unicode to: Phone number or Client identifier to filter `to` on
128128
:param unicode from_: Phone number or Client identifier to filter `from` on
129129
:param unicode parent_call_sid: Parent Call Sid to filter on
130-
:param call.status status: Status to filter on
130+
:param CallInstance.Status status: Status to filter on
131131
:param datetime start_time_before: StartTime to filter on
132132
:param datetime start_time: StartTime to filter on
133133
:param datetime start_time_after: StartTime to filter on
@@ -176,7 +176,7 @@ def list(self, to=values.unset, from_=values.unset,
176176
:param unicode to: Phone number or Client identifier to filter `to` on
177177
:param unicode from_: Phone number or Client identifier to filter `from` on
178178
:param unicode parent_call_sid: Parent Call Sid to filter on
179-
:param call.status status: Status to filter on
179+
:param CallInstance.Status status: Status to filter on
180180
:param datetime start_time_before: StartTime to filter on
181181
:param datetime start_time: StartTime to filter on
182182
:param datetime start_time_after: StartTime to filter on
@@ -222,7 +222,7 @@ def page(self, to=values.unset, from_=values.unset,
222222
:param unicode to: Phone number or Client identifier to filter `to` on
223223
:param unicode from_: Phone number or Client identifier to filter `from` on
224224
:param unicode parent_call_sid: Parent Call Sid to filter on
225-
:param call.status status: Status to filter on
225+
:param CallInstance.Status status: Status to filter on
226226
:param datetime start_time_before: StartTime to filter on
227227
:param datetime start_time: StartTime to filter on
228228
:param datetime start_time_after: StartTime to filter on
@@ -424,7 +424,7 @@ def update(self, url=values.unset, method=values.unset, status=values.unset,
424424
425425
:param unicode url: URL that returns TwiML
426426
:param unicode method: HTTP method to use to fetch TwiML
427-
:param call.update_status status: Status to update the Call with
427+
:param CallInstance.UpdateStatus status: Status to update the Call with
428428
:param unicode fallback_url: Fallback URL in case of error
429429
:param unicode fallback_method: HTTP Method to use with FallbackUrl
430430
:param unicode status_callback: Status Callback URL
@@ -825,7 +825,7 @@ def update(self, url=values.unset, method=values.unset, status=values.unset,
825825
826826
:param unicode url: URL that returns TwiML
827827
:param unicode method: HTTP method to use to fetch TwiML
828-
:param call.update_status status: Status to update the Call with
828+
:param CallInstance.UpdateStatus status: Status to update the Call with
829829
:param unicode fallback_url: Fallback URL in case of error
830830
:param unicode fallback_method: HTTP Method to use with FallbackUrl
831831
:param unicode status_callback: Status Callback URL

‎twilio/rest/api/v2010/account/call/feedback.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ def create(self, quality_score, issue=values.unset):
143143
Create a new FeedbackInstance
144144
145145
:param unicode quality_score: The quality_score
146-
:param feedback.issues issue: The issue
146+
:param FeedbackInstance.Issues issue: The issue
147147
148148
:returns: Newly created FeedbackInstance
149149
:rtype: twilio.rest.api.v2010.account.call.feedback.FeedbackInstance
@@ -193,7 +193,7 @@ def update(self, quality_score, issue=values.unset):
193193
Update the FeedbackInstance
194194
195195
:param unicode quality_score: An integer from 1 to 5
196-
:param feedback.issues issue: Issues experienced during the call
196+
:param FeedbackInstance.Issues issue: Issues experienced during the call
197197
198198
:returns: Updated FeedbackInstance
199199
:rtype: twilio.rest.api.v2010.account.call.feedback.FeedbackInstance
@@ -310,7 +310,7 @@ def date_updated(self):
310310
def issues(self):
311311
"""
312312
:returns: The issues
313-
:rtype: feedback.issues
313+
:rtype: FeedbackInstance.Issues
314314
"""
315315
return self._properties['issues']
316316

@@ -335,7 +335,7 @@ def create(self, quality_score, issue=values.unset):
335335
Create a new FeedbackInstance
336336
337337
:param unicode quality_score: The quality_score
338-
:param feedback.issues issue: The issue
338+
:param FeedbackInstance.Issues issue: The issue
339339
340340
:returns: Newly created FeedbackInstance
341341
:rtype: twilio.rest.api.v2010.account.call.feedback.FeedbackInstance
@@ -359,7 +359,7 @@ def update(self, quality_score, issue=values.unset):
359359
Update the FeedbackInstance
360360
361361
:param unicode quality_score: An integer from 1 to 5
362-
:param feedback.issues issue: Issues experienced during the call
362+
:param FeedbackInstance.Issues issue: Issues experienced during the call
363363
364364
:returns: Updated FeedbackInstance
365365
:rtype: twilio.rest.api.v2010.account.call.feedback.FeedbackInstance

‎twilio/rest/api/v2010/account/call/feedback_summary.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@ def start_date(self):
383383
def status(self):
384384
"""
385385
:returns: The status
386-
:rtype: feedback_summary.status
386+
:rtype: FeedbackSummaryInstance.Status
387387
"""
388388
return self._properties['status']
389389

‎twilio/rest/api/v2010/account/conference/__init__.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ def stream(self, date_created_before=values.unset, date_created=values.unset,
5454
:param date date_updated: Filter by date updated
5555
:param date date_updated_after: Filter by date updated
5656
:param unicode friendly_name: Filter by friendly name
57-
:param conference.status status: The status of the conference
57+
:param ConferenceInstance.Status status: The status of the conference
5858
:param int limit: Upper limit for the number of records to return. stream()
5959
guarantees to never return more than limit. Default is no limit
6060
:param int page_size: Number of records to fetch per request, when not set will use
@@ -98,7 +98,7 @@ def list(self, date_created_before=values.unset, date_created=values.unset,
9898
:param date date_updated: Filter by date updated
9999
:param date date_updated_after: Filter by date updated
100100
:param unicode friendly_name: Filter by friendly name
101-
:param conference.status status: The status of the conference
101+
:param ConferenceInstance.Status status: The status of the conference
102102
:param int limit: Upper limit for the number of records to return. list() guarantees
103103
never to return more than limit. Default is no limit
104104
:param int page_size: Number of records to fetch per request, when not set will use
@@ -139,7 +139,7 @@ def page(self, date_created_before=values.unset, date_created=values.unset,
139139
:param date date_updated: Filter by date updated
140140
:param date date_updated_after: Filter by date updated
141141
:param unicode friendly_name: Filter by friendly name
142-
:param conference.status status: The status of the conference
142+
:param ConferenceInstance.Status status: The status of the conference
143143
:param str page_token: PageToken provided by the API
144144
:param int page_number: Page Number, this value is simply for client state
145145
:param int page_size: Number of records to return, defaults to 50
@@ -303,7 +303,7 @@ def update(self, status=values.unset):
303303
"""
304304
Update the ConferenceInstance
305305
306-
:param conference.update_status status: The status
306+
:param ConferenceInstance.UpdateStatus status: The status
307307
308308
:returns: Updated ConferenceInstance
309309
:rtype: twilio.rest.api.v2010.account.conference.ConferenceInstance
@@ -469,7 +469,7 @@ def sid(self):
469469
def status(self):
470470
"""
471471
:returns: The status of the conference
472-
:rtype: conference.status
472+
:rtype: ConferenceInstance.Status
473473
"""
474474
return self._properties['status']
475475

@@ -502,7 +502,7 @@ def update(self, status=values.unset):
502502
"""
503503
Update the ConferenceInstance
504504
505-
:param conference.update_status status: The status
505+
:param ConferenceInstance.UpdateStatus status: The status
506506
507507
:returns: Updated ConferenceInstance
508508
:rtype: twilio.rest.api.v2010.account.conference.ConferenceInstance

‎twilio/rest/api/v2010/account/conference/participant.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,14 @@ def create(self, from_, to, status_callback=values.unset,
5959
:param unicode timeout: The timeout
6060
:param bool record: The record
6161
:param bool muted: The muted
62-
:param participant.beep beep: The beep
62+
:param ParticipantInstance.Beep beep: The beep
6363
:param bool start_conference_on_enter: The start_conference_on_enter
6464
:param bool end_conference_on_exit: The end_conference_on_exit
6565
:param unicode wait_url: The wait_url
6666
:param unicode wait_method: The wait_method
6767
:param bool early_media: The early_media
6868
:param unicode max_participants: The max_participants
69-
:param participant.conference_record conference_record: The conference_record
69+
:param ParticipantInstance.ConferenceRecord conference_record: The conference_record
7070
:param unicode conference_trim: The conference_trim
7171
:param unicode conference_status_callback: The conference_status_callback
7272
:param unicode conference_status_callback_method: The conference_status_callback_method
@@ -533,7 +533,7 @@ def start_conference_on_enter(self):
533533
def status(self):
534534
"""
535535
:returns: The status
536-
:rtype: participant.status
536+
:rtype: ParticipantInstance.Status
537537
"""
538538
return self._properties['status']
539539

‎twilio/rest/api/v2010/account/connect_app.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ def update(self, authorize_redirect_url=values.unset, company_name=values.unset,
248248
:param unicode description: A more detailed human readable description
249249
:param unicode friendly_name: A human readable name for the Connect App.
250250
:param unicode homepage_url: The URL users can obtain more information
251-
:param connect_app.permission permissions: The set of permissions that your ConnectApp requests.
251+
:param ConnectAppInstance.Permission permissions: The set of permissions that your ConnectApp requests.
252252
253253
:returns: Updated ConnectAppInstance
254254
:rtype: twilio.rest.api.v2010.account.connect_app.ConnectAppInstance
@@ -410,7 +410,7 @@ def homepage_url(self):
410410
def permissions(self):
411411
"""
412412
:returns: The set of permissions that your ConnectApp requests.
413-
:rtype: connect_app.permission
413+
:rtype: ConnectAppInstance.Permission
414414
"""
415415
return self._properties['permissions']
416416

@@ -454,7 +454,7 @@ def update(self, authorize_redirect_url=values.unset, company_name=values.unset,
454454
:param unicode description: A more detailed human readable description
455455
:param unicode friendly_name: A human readable name for the Connect App.
456456
:param unicode homepage_url: The URL users can obtain more information
457-
:param connect_app.permission permissions: The set of permissions that your ConnectApp requests.
457+
:param ConnectAppInstance.Permission permissions: The set of permissions that your ConnectApp requests.
458458
459459
:returns: Updated ConnectAppInstance
460460
:rtype: twilio.rest.api.v2010.account.connect_app.ConnectAppInstance

‎twilio/rest/api/v2010/account/incoming_phone_number/__init__.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ def create(self, api_version=values.unset, friendly_name=values.unset,
167167
:param unicode voice_fallback_url: URL Twilio will request when an error occurs in TwiML
168168
:param unicode voice_method: HTTP method used with the voice url
169169
:param unicode voice_url: URL Twilio will request when receiving a call
170-
:param incoming_phone_number.emergency_status emergency_status: The emergency_status
170+
:param IncomingPhoneNumberInstance.EmergencyStatus emergency_status: The emergency_status
171171
:param unicode emergency_address_sid: The emergency_address_sid
172172
:param unicode trunk_sid: Unique string to identify the trunk
173173
:param unicode phone_number: The phone number
@@ -394,7 +394,7 @@ def update(self, account_sid=values.unset, api_version=values.unset,
394394
:param unicode voice_fallback_url: URL Twilio will request when an error occurs in TwiML
395395
:param unicode voice_method: HTTP method used with the voice url
396396
:param unicode voice_url: URL Twilio will request when receiving a call
397-
:param incoming_phone_number.emergency_status emergency_status: The emergency_status
397+
:param IncomingPhoneNumberInstance.EmergencyStatus emergency_status: The emergency_status
398398
:param unicode emergency_address_sid: The emergency_address_sid
399399
:param unicode trunk_sid: Unique string to identify the trunk
400400
@@ -582,7 +582,7 @@ def account_sid(self):
582582
def address_requirements(self):
583583
"""
584584
:returns: Indicates if the customer requires an address
585-
:rtype: incoming_phone_number.address_requirement
585+
:rtype: IncomingPhoneNumberInstance.AddressRequirement
586586
"""
587587
return self._properties['address_requirements']
588588

@@ -774,7 +774,7 @@ def voice_url(self):
774774
def emergency_status(self):
775775
"""
776776
:returns: The emergency_status
777-
:rtype: incoming_phone_number.emergency_status
777+
:rtype: IncomingPhoneNumberInstance.EmergencyStatus
778778
"""
779779
return self._properties['emergency_status']
780780

@@ -816,7 +816,7 @@ def update(self, account_sid=values.unset, api_version=values.unset,
816816
:param unicode voice_fallback_url: URL Twilio will request when an error occurs in TwiML
817817
:param unicode voice_method: HTTP method used with the voice url
818818
:param unicode voice_url: URL Twilio will request when receiving a call
819-
:param incoming_phone_number.emergency_status emergency_status: The emergency_status
819+
:param IncomingPhoneNumberInstance.EmergencyStatus emergency_status: The emergency_status
820820
:param unicode emergency_address_sid: The emergency_address_sid
821821
:param unicode trunk_sid: Unique string to identify the trunk
822822

‎twilio/rest/api/v2010/account/incoming_phone_number/local.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,7 @@ def account_sid(self):
307307
def address_requirements(self):
308308
"""
309309
:returns: The address_requirements
310-
:rtype: local.address_requirement
310+
:rtype: LocalInstance.AddressRequirement
311311
"""
312312
return self._properties['address_requirements']
313313

‎twilio/rest/api/v2010/account/incoming_phone_number/mobile.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,7 @@ def account_sid(self):
307307
def address_requirements(self):
308308
"""
309309
:returns: The address_requirements
310-
:rtype: mobile.address_requirement
310+
:rtype: MobileInstance.AddressRequirement
311311
"""
312312
return self._properties['address_requirements']
313313

‎twilio/rest/api/v2010/account/incoming_phone_number/toll_free.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,7 @@ def account_sid(self):
307307
def address_requirements(self):
308308
"""
309309
:returns: The address_requirements
310-
:rtype: toll_free.address_requirement
310+
:rtype: TollFreeInstance.AddressRequirement
311311
"""
312312
return self._properties['address_requirements']
313313

‎twilio/rest/api/v2010/account/message/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -526,7 +526,7 @@ def date_sent(self):
526526
def direction(self):
527527
"""
528528
:returns: The direction of the message
529-
:rtype: message.direction
529+
:rtype: MessageInstance.Direction
530530
"""
531531
return self._properties['direction']
532532

@@ -606,7 +606,7 @@ def sid(self):
606606
def status(self):
607607
"""
608608
:returns: The status of this message
609-
:rtype: message.status
609+
:rtype: MessageInstance.Status
610610
"""
611611
return self._properties['status']
612612

‎twilio/rest/api/v2010/account/message/feedback.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ def create(self, outcome=values.unset):
3939
"""
4040
Create a new FeedbackInstance
4141
42-
:param feedback.outcome outcome: The outcome
42+
:param FeedbackInstance.Outcome outcome: The outcome
4343
4444
:returns: Newly created FeedbackInstance
4545
:rtype: twilio.rest.api.v2010.account.message.feedback.FeedbackInstance
@@ -168,7 +168,7 @@ def message_sid(self):
168168
def outcome(self):
169169
"""
170170
:returns: The outcome
171-
:rtype: feedback.outcome
171+
:rtype: FeedbackInstance.Outcome
172172
"""
173173
return self._properties['outcome']
174174

0 commit comments

Comments
 (0)
0