twilio.rest.preview.understand.assistant.field_type package¶
Submodules¶
twilio.rest.preview.understand.assistant.field_type.field_value module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.preview.understand.assistant.field_type.field_value.
FieldValueContext
(version, assistant_sid, field_type_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-
delete
()[source]¶ Deletes the FieldValueInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the FieldValueInstance
Returns: The fetched FieldValueInstance Return type: twilio.rest.preview.understand.assistant.field_type.field_value.FieldValueInstance
-
-
class
twilio.rest.preview.understand.assistant.field_type.field_value.
FieldValueInstance
(version, payload, assistant_sid, field_type_sid, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-
account_sid
¶ Returns: The unique ID of the Account that created this Field Value. Return type: unicode
-
assistant_sid
¶ Returns: The unique ID of the Assistant. Return type: unicode
-
date_created
¶ Returns: The date that this resource was created Return type: datetime
-
date_updated
¶ Returns: The date that this resource was last updated Return type: datetime
-
delete
()[source]¶ Deletes the FieldValueInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the FieldValueInstance
Returns: The fetched FieldValueInstance Return type: twilio.rest.preview.understand.assistant.field_type.field_value.FieldValueInstance
-
field_type_sid
¶ Returns: The unique ID of the Field Type associated with this Field Value. Return type: unicode
-
language
¶ Returns: An ISO language-country string of the value. Return type: unicode
-
sid
¶ Returns: A 34 character string that uniquely identifies this resource. Return type: unicode
-
synonym_of
¶ Returns: A value that indicates this field value is a synonym of. Empty if the value is not a synonym. Return type: unicode
-
url
¶ Returns: The url Return type: unicode
-
value
¶ Returns: The Field Value itself. Return type: unicode
-
-
class
twilio.rest.preview.understand.assistant.field_type.field_value.
FieldValueList
(version, assistant_sid, field_type_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-
create
(language, value, synonym_of=<object object>)[source]¶ Create the FieldValueInstance
Parameters: - language (unicode) – An ISO language-country string of the value.
- value (unicode) – A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.
- synonym_of (unicode) – A value that indicates this field value is a synonym of. Empty if the value is not a synonym.
Returns: The created FieldValueInstance
Return type: twilio.rest.preview.understand.assistant.field_type.field_value.FieldValueInstance
-
get
(sid)[source]¶ Constructs a FieldValueContext
Parameters: sid – The sid Returns: twilio.rest.preview.understand.assistant.field_type.field_value.FieldValueContext Return type: twilio.rest.preview.understand.assistant.field_type.field_value.FieldValueContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of FieldValueInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of FieldValueInstance Return type: twilio.rest.preview.understand.assistant.field_type.field_value.FieldValuePage
-
list
(language=<object object>, limit=None, page_size=None)[source]¶ Lists FieldValueInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - language (unicode) – An ISO language-country string of the value. For example: en-US
- limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
- page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns: Generator that will yield up to limit results
Return type: list[twilio.rest.preview.understand.assistant.field_type.field_value.FieldValueInstance]
-
page
(language=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of FieldValueInstance records from the API. Request is executed immediately
Parameters: Returns: Page of FieldValueInstance
Return type: twilio.rest.preview.understand.assistant.field_type.field_value.FieldValuePage
-
stream
(language=<object object>, limit=None, page_size=None)[source]¶ Streams FieldValueInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.
Parameters: - language (unicode) – An ISO language-country string of the value. For example: en-US
- limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
- page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns: Generator that will yield up to limit results
Return type: list[twilio.rest.preview.understand.assistant.field_type.field_value.FieldValueInstance]
-
-
class
twilio.rest.preview.understand.assistant.field_type.field_value.
FieldValuePage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-
get_instance
(payload)[source]¶ Build an instance of FieldValueInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.preview.understand.assistant.field_type.field_value.FieldValueInstance Return type: twilio.rest.preview.understand.assistant.field_type.field_value.FieldValueInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.preview.understand.assistant.field_type.
FieldTypeContext
(version, assistant_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-
delete
()[source]¶ Deletes the FieldTypeInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the FieldTypeInstance
Returns: The fetched FieldTypeInstance Return type: twilio.rest.preview.understand.assistant.field_type.FieldTypeInstance
-
field_values
¶ Access the field_values
Returns: twilio.rest.preview.understand.assistant.field_type.field_value.FieldValueList Return type: twilio.rest.preview.understand.assistant.field_type.field_value.FieldValueList
-
update
(friendly_name=<object object>, unique_name=<object object>)[source]¶ Update the FieldTypeInstance
Parameters: - friendly_name (unicode) – A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.
- unique_name (unicode) – A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.
Returns: The updated FieldTypeInstance
Return type: twilio.rest.preview.understand.assistant.field_type.FieldTypeInstance
-
-
class
twilio.rest.preview.understand.assistant.field_type.
FieldTypeInstance
(version, payload, assistant_sid, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-
account_sid
¶ Returns: The unique ID of the Account that created this Field Type. Return type: unicode
-
assistant_sid
¶ Returns: The unique ID of the Assistant. Return type: unicode
-
date_created
¶ Returns: The date that this resource was created Return type: datetime
-
date_updated
¶ Returns: The date that this resource was last updated Return type: datetime
-
delete
()[source]¶ Deletes the FieldTypeInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the FieldTypeInstance
Returns: The fetched FieldTypeInstance Return type: twilio.rest.preview.understand.assistant.field_type.FieldTypeInstance
-
field_values
¶ Access the field_values
Returns: twilio.rest.preview.understand.assistant.field_type.field_value.FieldValueList Return type: twilio.rest.preview.understand.assistant.field_type.field_value.FieldValueList
-
friendly_name
¶ Returns: A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long. Return type: unicode
-
links
¶ Returns: The links Return type: unicode
-
sid
¶ Returns: A 34 character string that uniquely identifies this resource. Return type: unicode
-
unique_name
¶ Returns: A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. Return type: unicode
-
update
(friendly_name=<object object>, unique_name=<object object>)[source]¶ Update the FieldTypeInstance
Parameters: - friendly_name (unicode) – A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.
- unique_name (unicode) – A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.
Returns: The updated FieldTypeInstance
Return type: twilio.rest.preview.understand.assistant.field_type.FieldTypeInstance
-
url
¶ Returns: The url Return type: unicode
-
-
class
twilio.rest.preview.understand.assistant.field_type.
FieldTypeList
(version, assistant_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-
create
(unique_name, friendly_name=<object object>)[source]¶ Create the FieldTypeInstance
Parameters: - unique_name (unicode) – A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.
- friendly_name (unicode) – A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.
Returns: The created FieldTypeInstance
Return type: twilio.rest.preview.understand.assistant.field_type.FieldTypeInstance
-
get
(sid)[source]¶ Constructs a FieldTypeContext
Parameters: sid – The sid Returns: twilio.rest.preview.understand.assistant.field_type.FieldTypeContext Return type: twilio.rest.preview.understand.assistant.field_type.FieldTypeContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of FieldTypeInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of FieldTypeInstance Return type: twilio.rest.preview.understand.assistant.field_type.FieldTypePage
-
list
(limit=None, page_size=None)[source]¶ Lists FieldTypeInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
- page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns: Generator that will yield up to limit results
Return type: list[twilio.rest.preview.understand.assistant.field_type.FieldTypeInstance]
-
page
(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of FieldTypeInstance records from the API. Request is executed immediately
Parameters: Returns: Page of FieldTypeInstance
Return type: twilio.rest.preview.understand.assistant.field_type.FieldTypePage
-
stream
(limit=None, page_size=None)[source]¶ Streams FieldTypeInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.
Parameters: - limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
- page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns: Generator that will yield up to limit results
Return type: list[twilio.rest.preview.understand.assistant.field_type.FieldTypeInstance]
-
-
class
twilio.rest.preview.understand.assistant.field_type.
FieldTypePage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-
get_instance
(payload)[source]¶ Build an instance of FieldTypeInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.preview.understand.assistant.field_type.FieldTypeInstance Return type: twilio.rest.preview.understand.assistant.field_type.FieldTypeInstance
-