twilio.rest.events.v1.schema package¶
Submodules¶
twilio.rest.events.v1.schema.schema_version module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.events.v1.schema.schema_version.VersionContext(version, id, schema_version)[source]¶ Bases:
twilio.base.instance_context.InstanceContextPLEASE 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.
-
fetch()[source]¶ Fetch the VersionInstance
Returns: The fetched VersionInstance Return type: twilio.rest.events.v1.schema.schema_version.VersionInstance
-
-
class
twilio.rest.events.v1.schema.schema_version.VersionInstance(version, payload, id, schema_version=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResourcePLEASE 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.
-
date_created¶ Returns: The date the schema version was created. Return type: datetime
-
fetch()[source]¶ Fetch the VersionInstance
Returns: The fetched VersionInstance Return type: twilio.rest.events.v1.schema.schema_version.VersionInstance
-
id¶ Returns: The unique identifier of the schema. Return type: unicode
-
raw¶ Returns: The raw Return type: unicode
-
schema_version¶ Returns: The version of this schema. Return type: unicode
-
url¶ Returns: The URL of this resource. Return type: unicode
-
-
class
twilio.rest.events.v1.schema.schema_version.VersionList(version, id)[source]¶ Bases:
twilio.base.list_resource.ListResourcePLEASE 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(schema_version)[source]¶ Constructs a VersionContext
Parameters: schema_version – The version of the schema Returns: twilio.rest.events.v1.schema.schema_version.VersionContext Return type: twilio.rest.events.v1.schema.schema_version.VersionContext
-
get_page(target_url)[source]¶ Retrieve a specific page of VersionInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of VersionInstance Return type: twilio.rest.events.v1.schema.schema_version.VersionPage
-
list(limit=None, page_size=None)[source]¶ Lists VersionInstance 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.events.v1.schema.schema_version.VersionInstance]
-
page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of VersionInstance records from the API. Request is executed immediately
Parameters: Returns: Page of VersionInstance
Return type:
-
stream(limit=None, page_size=None)[source]¶ Streams VersionInstance 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.events.v1.schema.schema_version.VersionInstance]
-
-
class
twilio.rest.events.v1.schema.schema_version.VersionPage(version, response, solution)[source]¶ Bases:
twilio.base.page.PagePLEASE 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 VersionInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.events.v1.schema.schema_version.VersionInstance Return type: twilio.rest.events.v1.schema.schema_version.VersionInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.events.v1.schema.SchemaContext(version, id)[source]¶ Bases:
twilio.base.instance_context.InstanceContextPLEASE 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.
-
fetch()[source]¶ Fetch the SchemaInstance
Returns: The fetched SchemaInstance Return type: twilio.rest.events.v1.schema.SchemaInstance
-
versions¶ Access the versions
Returns: twilio.rest.events.v1.schema.schema_version.VersionList Return type: twilio.rest.events.v1.schema.schema_version.VersionList
-
-
class
twilio.rest.events.v1.schema.SchemaInstance(version, payload, id=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResourcePLEASE 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.
-
fetch()[source]¶ Fetch the SchemaInstance
Returns: The fetched SchemaInstance Return type: twilio.rest.events.v1.schema.SchemaInstance
-
id¶ Returns: Schema Identifier. Return type: unicode
-
last_created¶ Returns: The date that the last schema version was created. Return type: datetime
-
last_version¶ Returns: Last schema version. Return type: unicode
-
links¶ Returns: Nested resource URLs. Return type: unicode
-
url¶ Returns: The URL of this resource. Return type: unicode
-
versions¶ Access the versions
Returns: twilio.rest.events.v1.schema.schema_version.VersionList Return type: twilio.rest.events.v1.schema.schema_version.VersionList
-
-
class
twilio.rest.events.v1.schema.SchemaList(version)[source]¶ Bases:
twilio.base.list_resource.ListResourcePLEASE 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(id)[source]¶ Constructs a SchemaContext
Parameters: id – The unique identifier of the schema. Returns: twilio.rest.events.v1.schema.SchemaContext Return type: twilio.rest.events.v1.schema.SchemaContext
-
-
class
twilio.rest.events.v1.schema.SchemaPage(version, response, solution)[source]¶ Bases:
twilio.base.page.PagePLEASE 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 SchemaInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.events.v1.schema.SchemaInstance Return type: twilio.rest.events.v1.schema.SchemaInstance
-