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: convert markdown links to rst formatted links #538

Merged
merged 5 commits into from
Aug 26, 2020
Merged
Show file tree
Hide file tree
Changes from 3 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
4 changes: 2 additions & 2 deletions twilio/rest/autopilot/v1/assistant/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ def update(self, friendly_name=values.unset, log_queries=values.unset,
:param unicode callback_url: Reserved
:param unicode callback_events: Reserved
:param dict style_sheet: A JSON string that defines the Assistant's style sheet
:param dict defaults: A JSON object that defines the Assistant's [default tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) for various scenarios
:param dict defaults: A JSON object that defines the Assistant's .. _default tasks https://www.twilio.com/docs/autopilot/api/assistant/defaults for various scenarios
thinkingserious marked this conversation as resolved.
Show resolved Hide resolved
:param unicode development_stage: A string describing the state of the assistant.

:returns: The updated AssistantInstance
Expand Down Expand Up @@ -600,7 +600,7 @@ def update(self, friendly_name=values.unset, log_queries=values.unset,
:param unicode callback_url: Reserved
:param unicode callback_events: Reserved
:param dict style_sheet: A JSON string that defines the Assistant's style sheet
:param dict defaults: A JSON object that defines the Assistant's [default tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) for various scenarios
:param dict defaults: A JSON object that defines the Assistant's .. _default tasks https://www.twilio.com/docs/autopilot/api/assistant/defaults for various scenarios
:param unicode development_stage: A string describing the state of the assistant.

:returns: The updated AssistantInstance
Expand Down
10 changes: 5 additions & 5 deletions twilio/rest/autopilot/v1/assistant/query.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ def stream(self, language=values.unset, model_build=values.unset,
:param unicode language: The ISO language-country string that specifies the language used by the Query resources to read
:param unicode model_build: The SID or unique name of the Model Build to be queried
:param unicode status: The status of the resources to read
:param unicode dialogue_sid: The SID of the [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue).
:param unicode dialogue_sid: The SID of the .. _Dialogue https://www.twilio.com/docs/autopilot/api/dialogue.
: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 Down Expand Up @@ -81,7 +81,7 @@ def list(self, language=values.unset, model_build=values.unset,
:param unicode language: The ISO language-country string that specifies the language used by the Query resources to read
:param unicode model_build: The SID or unique name of the Model Build to be queried
:param unicode status: The status of the resources to read
:param unicode dialogue_sid: The SID of the [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue).
:param unicode dialogue_sid: The SID of the .. _Dialogue https://www.twilio.com/docs/autopilot/api/dialogue.
: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 Down Expand Up @@ -112,7 +112,7 @@ def page(self, language=values.unset, model_build=values.unset,
:param unicode language: The ISO language-country string that specifies the language used by the Query resources to read
:param unicode model_build: The SID or unique name of the Model Build to be queried
:param unicode status: The status of the resources to read
:param unicode dialogue_sid: The SID of the [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue).
:param unicode dialogue_sid: The SID of the .. _Dialogue https://www.twilio.com/docs/autopilot/api/dialogue.
: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 Expand Up @@ -418,7 +418,7 @@ def language(self):
@property
def model_build_sid(self):
"""
:returns: The SID of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) queried
:returns: The SID of the .. _Model Build https://www.twilio.com/docs/autopilot/api/model-build queried
:rtype: unicode
"""
return self._properties['model_build_sid']
Expand Down Expand Up @@ -482,7 +482,7 @@ def source_channel(self):
@property
def dialogue_sid(self):
"""
:returns: The SID of the [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue).
:returns: The SID of the .. _Dialogue https://www.twilio.com/docs/autopilot/api/dialogue.
:rtype: unicode
"""
return self._properties['dialogue_sid']
Expand Down
8 changes: 4 additions & 4 deletions twilio/rest/autopilot/v1/assistant/task/field.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ def __init__(self, version, assistant_sid, task_sid):

:param Version version: Version that contains the resource
:param assistant_sid: The SID of the Assistant that is the parent of the Task associated with the resource
:param task_sid: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with this Field
:param task_sid: The SID of the .. _Task https://www.twilio.com/docs/autopilot/api/task resource associated with this Field

:returns: twilio.rest.autopilot.v1.assistant.task.field.FieldList
:rtype: twilio.rest.autopilot.v1.assistant.task.field.FieldList
Expand Down Expand Up @@ -188,7 +188,7 @@ def __init__(self, version, response, solution):
:param Version version: Version that contains the resource
:param Response response: Response from the API
:param assistant_sid: The SID of the Assistant that is the parent of the Task associated with the resource
:param task_sid: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with this Field
:param task_sid: The SID of the .. _Task https://www.twilio.com/docs/autopilot/api/task resource associated with this Field

:returns: twilio.rest.autopilot.v1.assistant.task.field.FieldPage
:rtype: twilio.rest.autopilot.v1.assistant.task.field.FieldPage
Expand Down Expand Up @@ -235,7 +235,7 @@ def __init__(self, version, assistant_sid, task_sid, sid):

:param Version version: Version that contains the resource
:param assistant_sid: The SID of the Assistant that is the parent of the Task associated with the resource to fetch
:param task_sid: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with the Field resource to fetch
:param task_sid: The SID of the .. _Task https://www.twilio.com/docs/autopilot/api/task resource associated with the Field resource to fetch
:param sid: The unique string that identifies the resource

:returns: twilio.rest.autopilot.v1.assistant.task.field.FieldContext
Expand Down Expand Up @@ -372,7 +372,7 @@ def field_type(self):
@property
def task_sid(self):
"""
:returns: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with this Field
:returns: The SID of the .. _Task https://www.twilio.com/docs/autopilot/api/task resource associated with this Field
:rtype: unicode
"""
return self._properties['task_sid']
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ def status(self):
@property
def error_code(self):
"""
:returns: The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) for a `failed` status
:returns: The message .. _delivery error code https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors for a `failed` status
:rtype: unicode
"""
return self._properties['error_code']
Expand Down
6 changes: 3 additions & 3 deletions twilio/rest/video/v1/composition/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ def stream(self, status=values.unset, date_created_after=values.unset,
The results are returned as a generator, so this operation is memory efficient.

:param CompositionInstance.Status status: Read only Composition resources with this status
:param datetime date_created_after: Read only Composition resources created on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time zone
:param datetime date_created_after: Read only Composition resources created on or after this .. _ISO 8601 https://en.wikipedia.org/wiki/ISO_8601 date-time with time zone
:param datetime date_created_before: Read only Composition resources created before this ISO 8601 date-time with time zone
:param unicode room_sid: Read only Composition resources with this Room SID
:param int limit: Upper limit for the number of records to return. stream()
Expand Down Expand Up @@ -79,7 +79,7 @@ def list(self, status=values.unset, date_created_after=values.unset,
memory before returning.

:param CompositionInstance.Status status: Read only Composition resources with this status
:param datetime date_created_after: Read only Composition resources created on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time zone
:param datetime date_created_after: Read only Composition resources created on or after this .. _ISO 8601 https://en.wikipedia.org/wiki/ISO_8601 date-time with time zone
:param datetime date_created_before: Read only Composition resources created before this ISO 8601 date-time with time zone
:param unicode room_sid: Read only Composition resources with this Room SID
:param int limit: Upper limit for the number of records to return. list() guarantees
Expand Down Expand Up @@ -110,7 +110,7 @@ def page(self, status=values.unset, date_created_after=values.unset,
Request is executed immediately

:param CompositionInstance.Status status: Read only Composition resources with this status
:param datetime date_created_after: Read only Composition resources created on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time zone
:param datetime date_created_after: Read only Composition resources created on or after this .. _ISO 8601 https://en.wikipedia.org/wiki/ISO_8601 date-time with time zone
:param datetime date_created_before: Read only Composition resources created before this ISO 8601 date-time with time zone
:param unicode room_sid: Read only Composition resources with this Room SID
:param str page_token: PageToken provided by the API
Expand Down
12 changes: 6 additions & 6 deletions twilio/rest/video/v1/recording/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ def stream(self, status=values.unset, source_sid=values.unset,
:param RecordingInstance.Status status: Read only the recordings that have this status
:param unicode source_sid: Read only the recordings that have this source_sid
:param unicode grouping_sid: Read only recordings that have this grouping_sid
:param datetime date_created_after: Read only recordings that started on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time zone
:param datetime date_created_before: Read only recordings that started before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time zone
:param datetime date_created_after: Read only recordings that started on or after this .. _ISO 8601 https://en.wikipedia.org/wiki/ISO_8601 date-time with time zone
:param datetime date_created_before: Read only recordings that started before this .. _ISO 8601 https://en.wikipedia.org/wiki/ISO_8601 date-time with time zone
:param RecordingInstance.Type media_type: Read only recordings that have this media type
:param int limit: Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
Expand Down Expand Up @@ -85,8 +85,8 @@ def list(self, status=values.unset, source_sid=values.unset,
:param RecordingInstance.Status status: Read only the recordings that have this status
:param unicode source_sid: Read only the recordings that have this source_sid
:param unicode grouping_sid: Read only recordings that have this grouping_sid
:param datetime date_created_after: Read only recordings that started on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time zone
:param datetime date_created_before: Read only recordings that started before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time zone
:param datetime date_created_after: Read only recordings that started on or after this .. _ISO 8601 https://en.wikipedia.org/wiki/ISO_8601 date-time with time zone
:param datetime date_created_before: Read only recordings that started before this .. _ISO 8601 https://en.wikipedia.org/wiki/ISO_8601 date-time with time zone
:param RecordingInstance.Type media_type: Read only recordings that have this media type
:param int limit: Upper limit for the number of records to return. list() guarantees
never to return more than limit. Default is no limit
Expand Down Expand Up @@ -121,8 +121,8 @@ def page(self, status=values.unset, source_sid=values.unset,
:param RecordingInstance.Status status: Read only the recordings that have this status
:param unicode source_sid: Read only the recordings that have this source_sid
:param unicode grouping_sid: Read only recordings that have this grouping_sid
:param datetime date_created_after: Read only recordings that started on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time zone
:param datetime date_created_before: Read only recordings that started before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time zone
:param datetime date_created_after: Read only recordings that started on or after this .. _ISO 8601 https://en.wikipedia.org/wiki/ISO_8601 date-time with time zone
:param datetime date_created_before: Read only recordings that started before this .. _ISO 8601 https://en.wikipedia.org/wiki/ISO_8601 date-time with time zone
:param RecordingInstance.Type media_type: Read only recordings that have this media type
:param str page_token: PageToken provided by the API
:param int page_number: Page Number, this value is simply for client state
Expand Down
4 changes: 2 additions & 2 deletions twilio/rest/voice/v1/ip_record.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ def create(self, ip_address, friendly_name=values.unset,

:param unicode ip_address: An IP address in dotted decimal notation, IPv4 only.
:param unicode friendly_name: A string to describe the resource
:param unicode cidr_prefix_length: An integer representing the length of the [CIDR](https://tools.ietf.org/html/rfc4632) prefix to use with this IP address. By default the entire IP address is used, which for IPv4 is value 32.
:param unicode cidr_prefix_length: An integer representing the length of the .. _CIDR https://tools.ietf.org/html/rfc4632 prefix to use with this IP address. By default the entire IP address is used, which for IPv4 is value 32.

:returns: The created IpRecordInstance
:rtype: twilio.rest.voice.v1.ip_record.IpRecordInstance
Expand Down Expand Up @@ -343,7 +343,7 @@ def ip_address(self):
@property
def cidr_prefix_length(self):
"""
:returns: An integer representing the length of the [CIDR](https://tools.ietf.org/html/rfc4632) prefix to use with this IP address. By default the entire IP address is used, which for IPv4 is value 32.
:returns: An integer representing the length of the .. _CIDR https://tools.ietf.org/html/rfc4632 prefix to use with this IP address. By default the entire IP address is used, which for IPv4 is value 32.
:rtype: unicode
"""
return self._properties['cidr_prefix_length']
Expand Down