twilio.rest.events.v1.schema package¶
Submodules¶
twilio.rest.events.v1.schema.version module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.events.v1.schema.version.
SchemaVersionContext
(version, id, schema_version)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
fetch
()[source]¶ Fetch the SchemaVersionInstance
Returns: The fetched SchemaVersionInstance Return type: twilio.rest.events.v1.schema.version.SchemaVersionInstance
-
-
class
twilio.rest.events.v1.schema.version.
SchemaVersionInstance
(version, payload, id, schema_version=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
date_created
¶ Returns: The date the schema version was created. Return type: datetime
-
fetch
()[source]¶ Fetch the SchemaVersionInstance
Returns: The fetched SchemaVersionInstance Return type: twilio.rest.events.v1.schema.version.SchemaVersionInstance
-
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.version.
SchemaVersionList
(version, id)[source]¶ Bases:
twilio.base.list_resource.ListResource
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
get
(schema_version)[source]¶ Constructs a SchemaVersionContext
Parameters: schema_version – The version of the schema Returns: twilio.rest.events.v1.schema.version.SchemaVersionContext Return type: twilio.rest.events.v1.schema.version.SchemaVersionContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of SchemaVersionInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of SchemaVersionInstance Return type: twilio.rest.events.v1.schema.version.SchemaVersionPage
-
list
(limit=None, page_size=None)[source]¶ Lists SchemaVersionInstance 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.version.SchemaVersionInstance]
-
page
(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of SchemaVersionInstance records from the API. Request is executed immediately
Parameters: Returns: Page of SchemaVersionInstance
Return type:
-
stream
(limit=None, page_size=None)[source]¶ Streams SchemaVersionInstance 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.version.SchemaVersionInstance]
-
-
class
twilio.rest.events.v1.schema.version.
SchemaVersionPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
get_instance
(payload)[source]¶ Build an instance of SchemaVersionInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.events.v1.schema.version.SchemaVersionInstance Return type: twilio.rest.events.v1.schema.version.SchemaVersionInstance
-
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.InstanceContext
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
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.version.SchemaVersionList Return type: twilio.rest.events.v1.schema.version.SchemaVersionList
-
-
class
twilio.rest.events.v1.schema.
SchemaInstance
(version, payload, id=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
fetch
()[source]¶ Fetch the SchemaInstance
Returns: The fetched SchemaInstance Return type: twilio.rest.events.v1.schema.SchemaInstance
-
id
¶ Returns: Schema Identifier. Return type: unicode
-
latest_version
¶ Returns: Latest schema version. Return type: unicode
-
latest_version_date_created
¶ Returns: The date that the latest schema version was created. Return type: datetime
-
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.version.SchemaVersionList Return type: twilio.rest.events.v1.schema.version.SchemaVersionList
-
-
class
twilio.rest.events.v1.schema.
SchemaList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
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.Page
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
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
-