twilio.rest.events.v1 package¶
Subpackages¶
Submodules¶
twilio.rest.events.v1.event_type module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.events.v1.event_type.
EventTypeContext
(version, type)[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 EventTypeInstance
Returns: The fetched EventTypeInstance Return type: twilio.rest.events.v1.event_type.EventTypeInstance
-
-
class
twilio.rest.events.v1.event_type.
EventTypeInstance
(version, payload, type=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 this Event Type was created. Return type: datetime
-
date_updated
¶ Returns: The date this Event Type was updated. Return type: datetime
-
description
¶ Returns: Event Type description. Return type: unicode
-
fetch
()[source]¶ Fetch the EventTypeInstance
Returns: The fetched EventTypeInstance Return type: twilio.rest.events.v1.event_type.EventTypeInstance
-
links
¶ Returns: The links Return type: unicode
-
schema_id
¶ Returns: The Schema identifier for this Event Type. Return type: unicode
-
type
¶ Returns: The Event Type identifier. Return type: unicode
-
url
¶ Returns: The URL of this resource. Return type: unicode
-
-
class
twilio.rest.events.v1.event_type.
EventTypeList
(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
(type)[source]¶ Constructs a EventTypeContext
Parameters: type – A string that uniquely identifies this Event Type. Returns: twilio.rest.events.v1.event_type.EventTypeContext Return type: twilio.rest.events.v1.event_type.EventTypeContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of EventTypeInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of EventTypeInstance Return type: twilio.rest.events.v1.event_type.EventTypePage
-
list
(schema_id=<object object>, limit=None, page_size=None)[source]¶ Lists EventTypeInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - schema_id (unicode) – A string to filter Event Types by schema.
- 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:
-
page
(schema_id=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of EventTypeInstance records from the API. Request is executed immediately
Parameters: Returns: Page of EventTypeInstance
Return type:
-
stream
(schema_id=<object object>, limit=None, page_size=None)[source]¶ Streams EventTypeInstance 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: - schema_id (unicode) – A string to filter Event Types by schema.
- 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:
-
-
class
twilio.rest.events.v1.event_type.
EventTypePage
(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 EventTypeInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.events.v1.event_type.EventTypeInstance Return type: twilio.rest.events.v1.event_type.EventTypeInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.events.v1.
V1
(domain)[source]¶ Bases:
twilio.base.version.Version
-
event_types
¶ Return type: twilio.rest.events.v1.event_type.EventTypeList
-
schemas
¶ Return type: twilio.rest.events.v1.schema.SchemaList
-
sinks
¶ Return type: twilio.rest.events.v1.sink.SinkList
-
subscriptions
¶ Return type: twilio.rest.events.v1.subscription.SubscriptionList
-