8000 Fixing documentation for list parameter types (#555) · githubib/twilio-python@edb1911 · GitHub
[go: up one dir, main page]
Skip to content

Commit edb1911

Browse files
shwetha-manvinkurkeshwetha-manvinkurke
authored
Fixing documentation for list parameter types (twilio#555)
1 parent 4358ddf commit edb1911

File tree

94 files changed

+277
-277
lines changed

Some content is hidden

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

94 files changed

+277
-277
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ def date_updated(self):
359359
def permissions(self):
360 F438 360
"""
361361
:returns: Permissions authorized to the app
362-
:rtype: AuthorizedConnectAppInstance.Permission
362+
:rtype: list[AuthorizedConnectAppInstance.Permission]
363363
"""
364364
return self._properties['permissions']
365365

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ def create(self, to, from_, method=values.unset, fallback_url=values.unset,
7171
:param unicode fallback_url: Fallback URL in case of error
7272
:param unicode fallback_method: HTTP Method to use with fallback_url
7373
:param unicode status_callback: The URL we should call to send status information to your application
74-
:param unicode status_callback_event: The call progress events that we send to the `status_callback` URL.
74+
:param list[unicode] status_callback_event: The call progress events that we send to the `status_callback` URL.
7575
:param unicode status_callback_method: HTTP Method to use with status_callback
7676
:param unicode send_digits: The digits to dial after connecting to the number
7777
:param unicode timeout: Number of seconds to wait for an answer
@@ -83,7 +83,7 @@ def create(self, to, from_, method=values.unset, fallback_url=values.unset,
8383
:param unicode sip_auth_password: The password required to authenticate the user account specified in `sip_auth_username`.
8484
:param unicode machine_detection: Enable machine detection or end of greeting detection
8585
:param unicode machine_detection_timeout: Number of seconds to wait for machine detection
86-
:param unicode recording_status_callback_event: The recording status events that will trigger calls to the URL specified in `recording_status_callback`
86+
:param list[unicode] recording_status_callback_event: The recording status events that will trigger calls to the URL specified in `recording_status_callback`
8787
:param unicode trim: Set this parameter to control trimming of silence on the recording.
8888
:param unicode caller_id: The phone number, SIP address, or Client identifier that made this call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`.
8989
:param unicode machine_detection_speech_threshold: Number of milliseconds for measuring stick for the length of the speech activity

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ def create(self, quality_score, issue=values.unset):
138138
Create the FeedbackInstance
139139
140140
:param unicode quality_score: The call quality expressed as an integer from 1 to 5
141-
:param FeedbackInstance.Issues issue: Issues experienced during the call
141+
:param list[FeedbackInstance.Issues] issue: Issues experienced during the call
142142
143143
:returns: The created FeedbackInstance
144144
10000 :rtype: twilio.rest.api.v2010.account.call.feedback.FeedbackInstance
@@ -175,7 +175,7 @@ def update(self, quality_score, issue=values.unset):
175175
Update the FeedbackInstance
176176
177177
:param unicode quality_score: The call quality expressed as an integer from 1 to 5
178-
:param FeedbackInstance.Issues issue: Issues experienced during the call
178+
:param list[FeedbackInstance.Issues] issue: Issues experienced during the call
179179
180180
:returns: The updated FeedbackInstance
181181
:rtype: twilio.rest.api.v2010.account.call.feedback.FeedbackInstance
@@ -282,7 +282,7 @@ def date_updated(self):
282282
def issues(self):
283283
"""
284284
:returns: Issues experienced during the call
285-
:rtype: FeedbackInstance.Issues
285+
:rtype: list[FeedbackInstance.Issues]
286286
"""
287287
return self._properties['issues']
288288

@@ -307,7 +307,7 @@ def create(self, quality_score, issue=values.unset):
307307
Create the FeedbackInstance
308308
309309
:param unicode quality_score: The call quality expressed as an integer from 1 to 5
310-
:param FeedbackInstance.Issues issue: Issues experienced during the call
310+
:param list[FeedbackInstance.Issues] issue: Issues experienced during the call
311311
312312
:returns: The created FeedbackInstance
313313
:rtype: twilio.rest.api.v2010.account.call.feedback.FeedbackInstance
@@ -328,7 +328,7 @@ def update(self, quality_score, issue=values.unset):
328328
Update the FeedbackInstance
329329
330330
:param unicode quality_score: The call quality expressed as an integer from 1 to 5
331-
:param FeedbackInstance.Issues issue: Issues experienced during the call
331+
:param list[FeedbackInstance.Issues] issue: Issues experienced during the call
332332
333333
:returns: The updated FeedbackInstance
334334
: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
@@ -301,7 +301,7 @@ def include_subaccounts(self):
301301
def issues(self):
302302
"""
303303
:returns: Issues experienced during the call
304-
:rtype: unicode
304+
:rtype: list[unicode]
305305
"""
306306
return self._properties['issues']
307307

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ def create(self, recording_status_callback_event=values.unset,
4141
"""
4242
Create the RecordingInstance
4343
44-
:param unicode recording_status_callback_event: The recording status changes that should generate a callback
44+
:param list[unicode] recording_status_callback_event: The recording status changes that should generate a callback
4545
:param unicode recording_status_callback: The callback URL on each selected recording event
4646
:param unicode recording_status_callback_method: The HTTP method we should use to call `recording_status_callback`
4747
:param unicode trim: Whether to trim the silence in the recording

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ def create(self, from_, to, status_callback=values.unset,
6666
:param unicode to: The phone number, SIP address or Client identifier that received this call.
6767
:param unicode status_callback: The URL we should call to send status information to your application
6868
:param unicode status_callback_method: The HTTP method we should use to call `status_callback`
69-
:param unicode status_callback_event: Set state change events that will trigger a callback
69+
:param list[unicode] status_callback_event: Set state change events that will trigger a callback
7070
:param unicode label: The label of this participant
7171
:param unicode timeout: he number of seconds that we should wait for an answer
7272
:param bool record: Whether to record the participant and their conferences
@@ -82,7 +82,7 @@ def create(self, from_, to, status_callback=values.unset,
8282
:param unicode conference_trim: Whether to trim leading and trailing silence from your recorded conference audio files
8383
:param unicode conference_status_callback: The callback URL for conference events
8484
:param unicode conference_status_callback_method: HTTP method for requesting `conference_status_callback` URL
85-
:param unicode conference_status_callback_event: The conference state changes that should generate a call to `conference_status_callback`
85+
:param list[unicode] conference_status_callback_event: The conference state changes that should generate a call to `conference_status_callback`
8686
:param unicode recording_channels: Specify `mono` or `dual` recording channels
8787
:param unicode recording_status_callback: The URL that we should call using the `recording_status_callback_method` when the recording status changes
8888
:param unicode recording_status_callback_method: The HTTP method we should use when we call `recording_status_callback`
@@ -91,8 +91,8 @@ def create(self, from_, to, status_callback=values.unset,
9191
:param unicode region: The region where we should mix the conference audio
9292
:param unicode conference_recording_status_callback: The URL we should call using the `conference_recording_status_callback_method` when the conference recording is available
9393
:param unicode conference_recording_status_callback_method: The HTTP method we should use to call `conference_recording_status_callback`
94-
:param unicode recording_status_callback_event: The recording state changes that should generate a call to `recording_status_callback`
95-
:param unicode conference_recording_status_callback_event: The conference recording state changes that should generate a call to `conference_recording_status_callback`
94+
:param list[unicode] recording_status_callback_event: The recording state changes that should generate a call to `recording_status_callback`
95+
:param list[unicode] conference_recording_status_callback_event: The conference recording state changes that should generate a call to `conference_recording_status_callback`
9696
:param bool coaching: Indicates if the participant changed to coach
9797
:param unicode call_sid_to_coach: The SID of the participant who is being `coached`
9898
:param unicode jitter_buffer_size: Jitter Buffer size for the connecting participant

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ def update(self, authorize_redirect_url=values.unset, company_name=values.unset,
230230
:param unicode description: A description of the Connect App
231231
:param unicode friendly_name: A string to describe the resource
232232
:param unicode homepage_url: A public URL where users can obtain more information
233-
:param ConnectAppInstance.Permission permissions: The set of permissions that your ConnectApp will request
233+
:param list[ConnectAppInstance.Permission] permissions: The set of permissions that your ConnectApp will request
234234
235235
:returns: The updated ConnectAppInstance
236236
:rtype: twilio.rest.api.v2010.account.connect_app.ConnectAppInstance
@@ -394,7 +394,7 @@ def homepage_url(self):
394394
def permissions(self):
395395
"""
396396
:returns: The set of permissions that your ConnectApp requests
397-
:rtype: ConnectAppInstance.Permission
397+
:rtype: list[ConnectAppInstance.Permission]
398398
"""
399399
return self._properties['permissions']
400400

@@ -438,7 +438,7 @@ def update(self, authorize_redirect_url=values.unset, company_name=values.unset,
438438
:param unicode description: A description of the Connect App
439439
:param unicode friendly_name: A string to describe the resource
440440
:param unicode homepage_url: A public URL where users can obtain more information
441-
:param ConnectAppInstance.Permission permissions: The set of permissions that your ConnectApp will request
441+
:param list[ConnectAppInstance.Permission] permissions: The set of permissions that your ConnectApp will request
442442
443443
:returns: The updated ConnectAppInstance
444444
:rtype: twilio.rest.api.v2010.account.connect_app.ConnectAppInstance

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,11 @@ def create(self, to, status_callback=values.unset, application_sid=values.unset,
5757
:param MessageInstance.ContentRetention content_retention: Determines if the message content can be stored or redacted based on privacy settings
5858
:param MessageInstance.AddressRetention address_retention: Determines if the address can be stored or obfuscated based on privacy settings
5959
:param bool smart_encoded: Whether to detect Unicode characters that have a similar GSM-7 character and replace them
60-
:param unicode persistent_action: Rich actions for Channels Messages.
60+
:param list[unicode] persistent_action: Rich actions for Channels Messages.
6161
:param unicode from_: The phone number that initiated the message
6262
:param unicode messaging_service_sid: The SID of the Messaging Service you want to associate with the message.
6363
:param unicode body: The text of the message you want to send. Can be up to 1,600 characters in length.
64-
:param unicode media_url: The URL of the media to send with the message
64+
:param list[unicode] media_url: The URL of the media to send with the message
6565
6666
:returns: The created MessageInstance
6767
:rtype: twilio.rest.api.v2010.account.message.MessageInstance

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ def date_updated(self):
149149
def ice_servers(self):
150150
"""
151151
:returns: An array representing the ephemeral credentials
152-
:rtype: unicode
152+
:rtype: list[unicode]
153153
"""
154154
return self._properties['ice_servers']
155155

‎twilio/rest/chat/v1/service/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ def update(self, friendly_name=values.unset,
313313
:param unicode pre_webhook_url: The webhook URL for pre-event webhooks
314314
:param unicode post_webhook_url: The URL for post-event webhooks
315315
:param unicode webhook_method: The HTTP method to use for both PRE and POST webhooks
316-
:param unicode webhook_filters: The list of WebHook events that are enabled for this Service instance
316+
:param list[unicode] webhook_filters: The list of WebHook events that are enabled for this Service instance
317317
:param unicode webhooks_on_message_send_url: The URL of the webhook to call in response to the on_message_send event
318318
:param unicode webhooks_on_message_send_method: The HTTP method to use when calling the webhooks.on_message_send.url
319319
:param unicode webhooks_on_message_update_url: The URL of the webhook to call in response to the on_message_update event
@@ -653,7 +653,7 @@ def webhook_method(self):
653653
def webhook_filters(self):
654654
"""
655655
:returns: The list of WebHook events that are enabled for this Service instance
656-
:rtype: unicode
656+
:rtype: list[unicode]
657657
"""
658658
return self._properties['webhook_filters']
659659

@@ -772,7 +772,7 @@ def update(self, friendly_name=values.unset,
772772
:param unicode pre_webhook_url: The webhook URL for pre-event webhooks
773773
:param unicode post_webhook_url: The URL for post-event webhooks
774774
:param unicode webhook_method: The HTTP method to use for both PRE and POST webhooks
775-
:param unicode webhook_filters: The list of WebHook events that are enabled for this Service instance
775+
:param list[unicode] webhook_filters: The list of WebHook events that are enabled for this Service instance
776776
:param unicode webhooks_on_message_send_url: The URL of the webhook to call in response to the on_message_send event
777777
:param unicode webhooks_on_message_send_method: The HTTP method to use when calling the webhooks.on_message_send.url
778778
:param unicode webhooks_on_message_update_url: The URL of the webhook to call in response to the on_message_update event

‎twilio/rest/chat/v1/service/channel/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ def stream(self, type=values.unset, limit=None, page_size=None):
6767
is reached.
6868
The results are returned as a generator, so this operation is memory efficient.
6969
70-
:param ChannelInstance.ChannelType type: The visibility of the channel to read
70+
:param list[ChannelInstance.ChannelType] type: The visibility of the channel to read
7171
:param int limit: Upper limit for the number of records to return. stream()
7272
guarantees to never return more than limit. Default is no limit
7373
:param int page_size: Number of records to fetch per request, when not set will use
@@ -90,7 +90,7 @@ def list(self, type=values.unset, limit=None, page_size=None):
9090
Unlike stream(), this operation is eager and will load `limit` records into
9191
memory before returning.
9292
93-
:param ChannelInstance.ChannelType type: The visibility of the channel to read
93+
:param list[ChannelInstance.ChannelType] type: The visibility of the channel to read
9494
:param int limit: Upper limit for the number of records to return. list() guarantees
9595
never to return more than limit. Default is no limit
9696
:param int page_size: Number of records to fetch per request, when not set will use
@@ -109,7 +109,7 @@ def page(self, type=values.unset, page_token=values.unset,
109109
Retrieve a single page of ChannelInstance records from the API.
110110
Request is executed immediately
111111
112-
:param ChannelInstance.ChannelType type: The visibility of the channel to read
112+
:param list[ChannelInstance.ChannelType] type: The visibility of the channel to read
113113
:param str page_token: PageToken provided by the API
114114
:param int page_number: Page Number, this value is simply for client state
115115
:param int page_size: Number of records to return, defaults to 50

‎twilio/rest/chat/v1/service/channel/invite.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ def stream(self, identity=values.unset, limit=None, page_size=None):
6262
is reached.
6363
The results are returned as a generator, so this operation is memory efficient.
6464
65-
:param unicode identity: The `identity` value of the resources to read
65+
:param list[unicode] identity: The `identity` value of the resources to read
6666
:param int limit: Upper limit for the number of records to return. stream()
6767
guarantees to never return more than limit. Default is no limit
6868
:param int page_size: Number of records to fetch per request, when not set will use
@@ -85,7 +85,7 @@ def list(self, identity=values.unset, limit=None, page_size=None):
8585
Unlike stream(), this operation is eager and will load `limit` records into
8686
memory before returning.
8787
88-
:param unicode identity: The `identity` value of the resources to read
88+
:param list[unicode] identity: The `identity` value of the resources to read
8989
:param int limit: Upper limit for the number of records to return. list() guarantees
9090
never to return more than limit. Default is no limit
9191
:param int page_size: Number of records to fetch per request, when not set will use
@@ -104,7 +104,7 @@ def page(self, identity=values.unset, page_token=values.unset,
104104
Retrieve a single page of InviteInstance records from the API.
105105
Request is executed immediately
106106
107-
:param unicode identity: The `identity` value of the resources to read
107+
:param list[unicode] identity: The `identity` value of the resources to read
108108
:param str page_token: PageToken provided by the API
109109
:param int page_number: Page Number, this value is simply for client state
110110
:param int page_size: Number of records to return, defaults to 50

‎twilio/rest/chat/v1/service/channel/member.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ def stream(self, identity=values.unset, limit=None, page_size=None):
6262
is reached.
6363
The results are returned as a generator, so this operation is memory efficient.
6464
65-
:param unicode identity: The `identity` value of the resources to read
65+
:param list[unicode] identity: The `identity` value of the resources to read
6666
:param int limit: Upper limit for the number of records to return. stream()
6767
guarantees to never return more than limit. Default is no limit
6868
:param int page_size: Number of records to fetch per request, when not set will use
@@ -85,7 +85,7 @@ def list(self, identity=values.unset, limit=None, page_size=None):
8585
Unlike stream(), this operation is eager and will load `limit` records into
8686
memory before returning.
8787
88-
:param unicode identity: The `identity` value of the resources to read
88+
:param list[unicode] identity: The `identity` value of the resources to read
8989
:param int limit: Upper limit for the number of records to return. list() guarantees
9090
never to return more than limit. Default is no limit
9191
:param int page_size: Number of records to fetch per request, when not set will use
@@ -104,7 +104,7 @@ def page(self, identity=values.unset, page_token=values.unset,
104104
Retrieve a single page of MemberInstance records from the API.
105105
Request is executed immediately
106106
107-
:param unicode identity: The `identity` value of the resources to read
107+
:param list[unicode] identity: The `identity` value of the resources to read
108108
:param str page_token: PageToken provided by the API
109109
:param int page_number: Page Number, this value is simply for client state
110110
:param int page_size: Number of records to return, defaults to 50

0 commit comments

Comments
 (0)
0