Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Fixing documentation for list parameter types #555

Merged
merged 1 commit into from
Jan 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion twilio/rest/api/v2010/account/authorized_connect_app.py
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@ def date_updated(self):
def permissions(self):
"""
:returns: Permissions authorized to the app
:rtype: AuthorizedConnectAppInstance.Permission
:rtype: list[AuthorizedConnectAppInstance.Permission]
"""
return self._properties['permissions']

Expand Down
4 changes: 2 additions & 2 deletions twilio/rest/api/v2010/account/call/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ def create(self, to, from_, method=values.unset, fallback_url=values.unset,
:param unicode fallback_url: Fallback URL in case of error
:param unicode fallback_method: HTTP Method to use with fallback_url
:param unicode status_callback: The URL we should call to send status information to your application
:param unicode status_callback_event: The call progress events that we send to the `status_callback` URL.
:param list[unicode] status_callback_event: The call progress events that we send to the `status_callback` URL.
:param unicode status_callback_method: HTTP Method to use with status_callback
:param unicode send_digits: The digits to dial after connecting to the number
:param unicode timeout: Number of seconds to wait for an answer
Expand All @@ -83,7 +83,7 @@ def create(self, to, from_, method=values.unset, fallback_url=values.unset,
:param unicode sip_auth_password: The password required to authenticate the user account specified in `sip_auth_username`.
:param unicode machine_detection: Enable machine detection or end of greeting detection
:param unicode machine_detection_timeout: Number of seconds to wait for machine detection
:param unicode recording_status_callback_event: The recording status events that will trigger calls to the URL specified in `recording_status_callback`
:param list[unicode] recording_status_callback_event: The recording status events that will trigger calls to the URL specified in `recording_status_callback`
:param unicode trim: Set this parameter to control trimming of silence on the recording.
: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 `[email protected]`.
:param unicode machine_detection_speech_threshold: Number of milliseconds for measuring stick for the length of the speech activity
Expand Down
10 changes: 5 additions & 5 deletions twilio/rest/api/v2010/account/call/feedback.py
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ def create(self, quality_score, issue=values.unset):
Create the FeedbackInstance

:param unicode quality_score: The call quality expressed as an integer from 1 to 5
:param FeedbackInstance.Issues issue: Issues experienced during the call
:param list[FeedbackInstance.Issues] issue: Issues experienced during the call

:returns: The created FeedbackInstance
:rtype: twilio.rest.api.v2010.account.call.feedback.FeedbackInstance
Expand Down Expand Up @@ -175,7 +175,7 @@ def update(self, quality_score, issue=values.unset):
Update the FeedbackInstance

:param unicode quality_score: The call quality expressed as an integer from 1 to 5
:param FeedbackInstance.Issues issue: Issues experienced during the call
:param list[FeedbackInstance.Issues] issue: Issues experienced during the call

:returns: The updated FeedbackInstance
:rtype: twilio.rest.api.v2010.account.call.feedback.FeedbackInstance
Expand Down Expand Up @@ -282,7 +282,7 @@ def date_updated(self):
def issues(self):
"""
:returns: Issues experienced during the call
:rtype: FeedbackInstance.Issues
:rtype: list[FeedbackInstance.Issues]
"""
return self._properties['issues']

Expand All @@ -307,7 +307,7 @@ def create(self, quality_score, issue=values.unset):
Create the FeedbackInstance

:param unicode quality_score: The call quality expressed as an integer from 1 to 5
:param FeedbackInstance.Issues issue: Issues experienced during the call
:param list[FeedbackInstance.Issues] issue: Issues experienced during the call

:returns: The created FeedbackInstance
:rtype: twilio.rest.api.v2010.account.call.feedback.FeedbackInstance
Expand All @@ -328,7 +328,7 @@ def update(self, quality_score, issue=values.unset):
Update the FeedbackInstance

:param unicode quality_score: The call quality expressed as an integer from 1 to 5
:param FeedbackInstance.Issues issue: Issues experienced during the call
:param list[FeedbackInstance.Issues] issue: Issues experienced during the call

:returns: The updated FeedbackInstance
:rtype: twilio.rest.api.v2010.account.call.feedback.FeedbackInstance
Expand Down
2 changes: 1 addition & 1 deletion twilio/rest/api/v2010/account/call/feedback_summary.py
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ def include_subaccounts(self):
def issues(self):
"""
:returns: Issues experienced during the call
:rtype: unicode
:rtype: list[unicode]
"""
return self._properties['issues']

Expand Down
2 changes: 1 addition & 1 deletion twilio/rest/api/v2010/account/call/recording.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ def create(self, recording_status_callback_event=values.unset,
"""
Create the RecordingInstance

:param unicode recording_status_callback_event: The recording status changes that should generate a callback
:param list[unicode] recording_status_callback_event: The recording status changes that should generate a callback
:param unicode recording_status_callback: The callback URL on each selected recording event
:param unicode recording_status_callback_method: The HTTP method we should use to call `recording_status_callback`
:param unicode trim: Whether to trim the silence in the recording
Expand Down
8 changes: 4 additions & 4 deletions twilio/rest/api/v2010/account/conference/participant.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ def create(self, from_, to, status_callback=values.unset,
:param unicode to: The phone number, SIP address or Client identifier that received this call.
:param unicode status_callback: The URL we should call to send status information to your application
:param unicode status_callback_method: The HTTP method we should use to call `status_callback`
:param unicode status_callback_event: Set state change events that will trigger a callback
:param list[unicode] status_callback_event: Set state change events that will trigger a callback
:param unicode label: The label of this participant
:param unicode timeout: he number of seconds that we should wait for an answer
:param bool record: Whether to record the participant and their conferences
Expand All @@ -82,7 +82,7 @@ def create(self, from_, to, status_callback=values.unset,
:param unicode conference_trim: Whether to trim leading and trailing silence from your recorded conference audio files
:param unicode conference_status_callback: The callback URL for conference events
:param unicode conference_status_callback_method: HTTP method for requesting `conference_status_callback` URL
:param unicode conference_status_callback_event: The conference state changes that should generate a call to `conference_status_callback`
:param list[unicode] conference_status_callback_event: The conference state changes that should generate a call to `conference_status_callback`
:param unicode recording_channels: Specify `mono` or `dual` recording channels
:param unicode recording_status_callback: The URL that we should call using the `recording_status_callback_method` when the recording status changes
:param unicode recording_status_callback_method: The HTTP method we should use when we call `recording_status_callback`
Expand All @@ -91,8 +91,8 @@ def create(self, from_, to, status_callback=values.unset,
:param unicode region: The region where we should mix the conference audio
:param unicode conference_recording_status_callback: The URL we should call using the `conference_recording_status_callback_method` when the conference recording is available
:param unicode conference_recording_status_callback_method: The HTTP method we should use to call `conference_recording_status_callback`
:param unicode recording_status_callback_event: The recording state changes that should generate a call to `recording_status_callback`
:param unicode conference_recording_status_callback_event: The conference recording state changes that should generate a call to `conference_recording_status_callback`
:param list[unicode] recording_status_callback_event: The recording state changes that should generate a call to `recording_status_callback`
:param list[unicode] conference_recording_status_callback_event: The conference recording state changes that should generate a call to `conference_recording_status_callback`
:param bool coaching: Indicates if the participant changed to coach
:param unicode call_sid_to_coach: The SID of the participant who is being `coached`
:param unicode jitter_buffer_size: Jitter Buffer size for the connecting participant
Expand Down
6 changes: 3 additions & 3 deletions twilio/rest/api/v2010/account/connect_app.py
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ def update(self, authorize_redirect_url=values.unset, company_name=values.unset,
:param unicode description: A description of the Connect App
:param unicode friendly_name: A string to describe the resource
:param unicode homepage_url: A public URL where users can obtain more information
:param ConnectAppInstance.Permission permissions: The set of permissions that your ConnectApp will request
:param list[ConnectAppInstance.Permission] permissions: The set of permissions that your ConnectApp will request

:returns: The updated ConnectAppInstance
:rtype: twilio.rest.api.v2010.account.connect_app.ConnectAppInstance
Expand Down Expand Up @@ -394,7 +394,7 @@ def homepage_url(self):
def permissions(self):
"""
:returns: The set of permissions that your ConnectApp requests
:rtype: ConnectAppInstance.Permission
:rtype: list[ConnectAppInstance.Permission]
"""
return self._properties['permissions']

Expand Down Expand Up @@ -438,7 +438,7 @@ def update(self, authorize_redirect_url=values.unset, company_name=values.unset,
:param unicode description: A description of the Connect App
:param unicode friendly_name: A string to describe the resource
:param unicode homepage_url: A public URL where users can obtain more information
:param ConnectAppInstance.Permission permissions: The set of permissions that your ConnectApp will request
:param list[ConnectAppInstance.Permission] permissions: The set of permissions that your ConnectApp will request

:returns: The updated ConnectAppInstance
:rtype: twilio.rest.api.v2010.account.connect_app.ConnectAppInstance
Expand Down
4 changes: 2 additions & 2 deletions twilio/rest/api/v2010/account/message/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,11 @@ def create(self, to, status_callback=values.unset, application_sid=values.unset,
:param MessageInstance.ContentRetention content_retention: Determines if the message content can be stored or redacted based on privacy settings
:param MessageInstance.AddressRetention address_retention: Determines if the address can be stored or obfuscated based on privacy settings
:param bool smart_encoded: Whether to detect Unicode characters that have a similar GSM-7 character and replace them
:param unicode persistent_action: Rich actions for Channels Messages.
:param list[unicode] persistent_action: Rich actions for Channels Messages.
:param unicode from_: The phone number that initiated the message
:param unicode messaging_service_sid: The SID of the Messaging Service you want to associate with the message.
:param unicode body: The text of the message you want to send. Can be up to 1,600 characters in length.
:param unicode media_url: The URL of the media to send with the message
:param list[unicode] media_url: The URL of the media to send with the message

:returns: The created MessageInstance
:rtype: twilio.rest.api.v2010.account.message.MessageInstance
Expand Down
2 changes: 1 addition & 1 deletion twilio/rest/api/v2010/account/token.py
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ def date_updated(self):
def ice_servers(self):
"""
:returns: An array representing the ephemeral credentials
:rtype: unicode
:rtype: list[unicode]
"""
return self._properties['ice_servers']

Expand Down
6 changes: 3 additions & 3 deletions twilio/rest/chat/v1/service/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ def update(self, friendly_name=values.unset,
:param unicode pre_webhook_url: The webhook URL for pre-event webhooks
:param unicode post_webhook_url: The URL for post-event webhooks
:param unicode webhook_method: The HTTP method to use for both PRE and POST webhooks
:param unicode webhook_filters: The list of WebHook events that are enabled for this Service instance
:param list[unicode] webhook_filters: The list of WebHook events that are enabled for this Service instance
:param unicode webhooks_on_message_send_url: The URL of the webhook to call in response to the on_message_send event
:param unicode webhooks_on_message_send_method: The HTTP method to use when calling the webhooks.on_message_send.url
:param unicode webhooks_on_message_update_url: The URL of the webhook to call in response to the on_message_update event
Expand Down Expand Up @@ -653,7 +653,7 @@ def webhook_method(self):
def webhook_filters(self):
"""
:returns: The list of WebHook events that are enabled for this Service instance
:rtype: unicode
:rtype: list[unicode]
"""
return self._properties['webhook_filters']

Expand Down Expand Up @@ -772,7 +772,7 @@ def update(self, friendly_name=values.unset,
:param unicode pre_webhook_url: The webhook URL for pre-event webhooks
:param unicode post_webhook_url: The URL for post-event webhooks
:param unicode webhook_method: The HTTP method to use for both PRE and POST webhooks
:param unicode webhook_filters: The list of WebHook events that are enabled for this Service instance
:param list[unicode] webhook_filters: The list of WebHook events that are enabled for this Service instance
:param unicode webhooks_on_message_send_url: The URL of the webhook to call in response to the on_message_send event
:param unicode webhooks_on_message_send_method: The HTTP method to use when calling the webhooks.on_message_send.url
:param unicode webhooks_on_message_update_url: The URL of the webhook to call in response to the on_message_update event
Expand Down
6 changes: 3 additions & 3 deletions twilio/rest/chat/v1/service/channel/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ def stream(self, type=values.unset, limit=None, page_size=None):
is reached.
The results are returned as a generator, so this operation is memory efficient.

:param ChannelInstance.ChannelType type: The visibility of the channel to read
:param list[ChannelInstance.ChannelType] type: The visibility of the channel to read
:param int limit: Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
:param int page_size: Number of records to fetch per request, when not set will use
Expand All @@ -90,7 +90,7 @@ def list(self, type=values.unset, limit=None, page_size=None):
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.

:param ChannelInstance.ChannelType type: The visibility of the channel to read
:param list[ChannelInstance.ChannelType] type: The visibility of the channel to read
:param int limit: Upper limit for the number of records to return. list() guarantees
never to return more than limit. Default is no limit
:param int page_size: Number of records to fetch per request, when not set will use
Expand All @@ -109,7 +109,7 @@ def page(self, type=values.unset, page_token=values.unset,
Retrieve a single page of ChannelInstance records from the API.
Request is executed immediately

:param ChannelInstance.ChannelType type: The visibility of the channel to read
:param list[ChannelInstance.ChannelType] type: The visibility of the channel to read
:param str page_token: PageToken provided by the API
:param int page_number: Page Number, this value is simply for client state
:param int page_size: Number of records to return, defaults to 50
Expand Down
6 changes: 3 additions & 3 deletions twilio/rest/chat/v1/service/channel/invite.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ def stream(self, identity=values.unset, limit=None, page_size=None):
is reached.
The results are returned as a generator, so this operation is memory efficient.

:param unicode identity: The `identity` value of the resources to read
:param list[unicode] identity: The `identity` value of the resources to read
:param int limit: Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
:param int page_size: Number of records to fetch per request, when not set will use
Expand All @@ -85,7 +85,7 @@ def list(self, identity=values.unset, limit=None, page_size=None):
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.

:param unicode identity: The `identity` value of the resources to read
:param list[unicode] identity: The `identity` value of the resources to read
:param int limit: Upper limit for the number of records to return. list() guarantees
never to return more than limit. Default is no limit
:param int page_size: Number of records to fetch per request, when not set will use
Expand All @@ -104,7 +104,7 @@ def page(self, identity=values.unset, page_token=values.unset,
Retrieve a single page of InviteInstance records from the API.
Request is executed immediately

:param unicode identity: The `identity` value of the resources to read
:param list[unicode] identity: The `identity` value of the resources to read
:param str page_token: PageToken provided by the API
:param int page_number: Page Number, this value is simply for client state
:param int page_size: Number of records to return, defaults to 50
Expand Down
6 changes: 3 additions & 3 deletions twilio/rest/chat/v1/service/channel/member.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ def stream(self, identity=values.unset, limit=None, page_size=None):
is reached.
The results are returned as a generator, so this operation is memory efficient.

:param unicode identity: The `identity` value of the resources to read
:param list[unicode] identity: The `identity` value of the resources to read
:param int limit: Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
:param int page_size: Number of records to fetch per request, when not set will use
Expand All @@ -85,7 +85,7 @@ def list(self, identity=values.unset, limit=None, page_size=None):
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.

:param unicode identity: The `identity` value of the resources to read
:param list[unicode] identity: The `identity` value of the resources to read
:param int limit: Upper limit for the number of records to return. list() guarantees
never to return more than limit. Default is no limit
:param int page_size: Number of records to fetch per request, when not set will use
Expand All @@ -104,7 +104,7 @@ def page(self, identity=values.unset, page_token=values.unset,
Retrieve a single page of MemberInstance records from the API.
Request is executed immediately

:param unicode identity: The `identity` value of the resources to read
:param list[unicode] identity: The `identity` value of the resources to read
:param str page_token: PageToken provided by the API
:param int page_number: Page Number, this value is simply for client state
:param int page_size: Number of records to return, defaults to 50
Expand Down
Loading