twilio.rest.sync.v1.service.sync_list package

Submodules

twilio.rest.sync.v1.service.sync_list.sync_list_item module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.sync.v1.service.sync_list.sync_list_item.SyncListItemContext(version, service_sid, list_sid, index)[source]

Bases: twilio.base.instance_context.InstanceContext

delete(if_match=<object object>)[source]

Deletes the SyncListItemInstance

Parameters:if_match (unicode) – The If-Match HTTP request header
Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the SyncListItemInstance

Returns:The fetched SyncListItemInstance
Return type:twilio.rest.sync.v1.service.sync_list.sync_list_item.SyncListItemInstance
update(data=<object object>, ttl=<object object>, item_ttl=<object object>, collection_ttl=<object object>, if_match=<object object>)[source]

Update the SyncListItemInstance

Parameters:
  • data (dict) – A JSON string that represents an arbitrary, schema-less object that the List Item stores
  • ttl (unicode) – An alias for item_ttl
  • item_ttl (unicode) – How long, in seconds, before the List Item expires
  • collection_ttl (unicode) – How long, in seconds, before the List Item’s parent Sync List expires
  • if_match (unicode) – The If-Match HTTP request header
Returns:

The updated SyncListItemInstance

Return type:

twilio.rest.sync.v1.service.sync_list.sync_list_item.SyncListItemInstance

class twilio.rest.sync.v1.service.sync_list.sync_list_item.SyncListItemInstance(version, payload, service_sid, list_sid, index=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

class QueryFromBoundType[source]

Bases: object

EXCLUSIVE = 'exclusive'
INCLUSIVE = 'inclusive'
class QueryResultOrder[source]

Bases: object

ASC = 'asc'
DESC = 'desc'
account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
created_by
Returns:The identity of the List Item’s creator
Return type:unicode
data
Returns:An arbitrary, schema-less object that the List Item stores
Return type:dict
date_created
Returns:The ISO 8601 date and time in GMT when the resource was created
Return type:datetime
date_expires
Returns:The ISO 8601 date and time in GMT when the List Item expires
Return type:datetime
date_updated
Returns:The ISO 8601 date and time in GMT when the resource was last updated
Return type:datetime
delete(if_match=<object object>)[source]

Deletes the SyncListItemInstance

Parameters:if_match (unicode) – The If-Match HTTP request header
Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the SyncListItemInstance

Returns:The fetched SyncListItemInstance
Return type:twilio.rest.sync.v1.service.sync_list.sync_list_item.SyncListItemInstance
index
Returns:The automatically generated index of the List Item
Return type:unicode
list_sid
Returns:The SID of the Sync List that contains the List Item
Return type:unicode
revision
Returns:The current revision of the item, represented as a string
Return type:unicode
service_sid
Returns:The SID of the Sync Service that the resource is associated with
Return type:unicode
update(data=<object object>, ttl=<object object>, item_ttl=<object object>, collection_ttl=<object object>, if_match=<object object>)[source]

Update the SyncListItemInstance

Parameters:
  • data (dict) – A JSON string that represents an arbitrary, schema-less object that the List Item stores
  • ttl (unicode) – An alias for item_ttl
  • item_ttl (unicode) – How long, in seconds, before the List Item expires
  • collection_ttl (unicode) – How long, in seconds, before the List Item’s parent Sync List expires
  • if_match (unicode) – The If-Match HTTP request header
Returns:

The updated SyncListItemInstance

Return type:

twilio.rest.sync.v1.service.sync_list.sync_list_item.SyncListItemInstance

url
Returns:The absolute URL of the List Item resource
Return type:unicode
class twilio.rest.sync.v1.service.sync_list.sync_list_item.SyncListItemList(version, service_sid, list_sid)[source]

Bases: twilio.base.list_resource.ListResource

create(data, ttl=<object object>, item_ttl=<object object>, collection_ttl=<object object>)[source]

Create the SyncListItemInstance

Parameters:
  • data (dict) – A JSON string that represents an arbitrary, schema-less object that the List Item stores
  • ttl (unicode) – An alias for item_ttl
  • item_ttl (unicode) – How long, in seconds, before the List Item expires
  • collection_ttl (unicode) – How long, in seconds, before the List Item’s parent Sync List expires
Returns:

The created SyncListItemInstance

Return type:

twilio.rest.sync.v1.service.sync_list.sync_list_item.SyncListItemInstance

get(index)[source]

Constructs a SyncListItemContext

Parameters:index – The index of the Sync List Item resource to fetch
Returns:twilio.rest.sync.v1.service.sync_list.sync_list_item.SyncListItemContext
Return type:twilio.rest.sync.v1.service.sync_list.sync_list_item.SyncListItemContext
get_page(target_url)[source]

Retrieve a specific page of SyncListItemInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of SyncListItemInstance
Return type:twilio.rest.sync.v1.service.sync_list.sync_list_item.SyncListItemPage
list(order=<object object>, from_=<object object>, bounds=<object object>, limit=None, page_size=None)[source]

Lists SyncListItemInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • order (SyncListItemInstance.QueryResultOrder) – The order to return the List Items
  • from (unicode) – The index of the first Sync List Item resource to read
  • bounds (SyncListItemInstance.QueryFromBoundType) – Whether to include the List Item referenced by the from parameter
  • 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.sync.v1.service.sync_list.sync_list_item.SyncListItemInstance]

page(order=<object object>, from_=<object object>, bounds=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

Retrieve a single page of SyncListItemInstance records from the API. Request is executed immediately

Parameters:
  • order (SyncListItemInstance.QueryResultOrder) – The order to return the List Items
  • from (unicode) – The index of the first Sync List Item resource to read
  • bounds (SyncListItemInstance.QueryFromBoundType) – Whether to include the List Item referenced by the from parameter
  • page_token (str) – PageToken provided by the API
  • page_number (int) – Page Number, this value is simply for client state
  • page_size (int) – Number of records to return, defaults to 50
Returns:

Page of SyncListItemInstance

Return type:

twilio.rest.sync.v1.service.sync_list.sync_list_item.SyncListItemPage

stream(order=<object object>, from_=<object object>, bounds=<object object>, limit=None, page_size=None)[source]

Streams SyncListItemInstance 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:
  • order (SyncListItemInstance.QueryResultOrder) – The order to return the List Items
  • from (unicode) – The index of the first Sync List Item resource to read
  • bounds (SyncListItemInstance.QueryFromBoundType) – Whether to include the List Item referenced by the from parameter
  • 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.sync.v1.service.sync_list.sync_list_item.SyncListItemInstance]

class twilio.rest.sync.v1.service.sync_list.sync_list_item.SyncListItemPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of SyncListItemInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.sync.v1.service.sync_list.sync_list_item.SyncListItemInstance
Return type:twilio.rest.sync.v1.service.sync_list.sync_list_item.SyncListItemInstance

twilio.rest.sync.v1.service.sync_list.sync_list_permission module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.sync.v1.service.sync_list.sync_list_permission.SyncListPermissionContext(version, service_sid, list_sid, identity)[source]

Bases: twilio.base.instance_context.InstanceContext

delete()[source]

Deletes the SyncListPermissionInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the SyncListPermissionInstance

Returns:The fetched SyncListPermissionInstance
Return type:twilio.rest.sync.v1.service.sync_list.sync_list_permission.SyncListPermissionInstance
update(read, write, manage)[source]

Update the SyncListPermissionInstance

Parameters:
  • read (bool) – Read access
  • write (bool) – Write access
  • manage (bool) – Manage access
Returns:

The updated SyncListPermissionInstance

Return type:

twilio.rest.sync.v1.service.sync_list.sync_list_permission.SyncListPermissionInstance

class twilio.rest.sync.v1.service.sync_list.sync_list_permission.SyncListPermissionInstance(version, payload, service_sid, list_sid, identity=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
delete()[source]

Deletes the SyncListPermissionInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the SyncListPermissionInstance

Returns:The fetched SyncListPermissionInstance
Return type:twilio.rest.sync.v1.service.sync_list.sync_list_permission.SyncListPermissionInstance
identity
Returns:The identity of the user to whom the Sync List Permission applies
Return type:unicode
list_sid
Returns:The SID of the Sync List to which the Permission applies
Return type:unicode
manage
Returns:Manage access
Return type:bool
read
Returns:Read access
Return type:bool
service_sid
Returns:The SID of the Sync Service that the resource is associated with
Return type:unicode
update(read, write, manage)[source]

Update the SyncListPermissionInstance

Parameters:
  • read (bool) – Read access
  • write (bool) – Write access
  • manage (bool) – Manage access
Returns:

The updated SyncListPermissionInstance

Return type:

twilio.rest.sync.v1.service.sync_list.sync_list_permission.SyncListPermissionInstance

url
Returns:The absolute URL of the Sync List Permission resource
Return type:unicode
write
Returns:Write access
Return type:bool
class twilio.rest.sync.v1.service.sync_list.sync_list_permission.SyncListPermissionList(version, service_sid, list_sid)[source]

Bases: twilio.base.list_resource.ListResource

get(identity)[source]

Constructs a SyncListPermissionContext

Parameters:identity – The application-defined string that uniquely identifies the User’s Sync List Permission resource to fetch
Returns:twilio.rest.sync.v1.service.sync_list.sync_list_permission.SyncListPermissionContext
Return type:twilio.rest.sync.v1.service.sync_list.sync_list_permission.SyncListPermissionContext
get_page(target_url)[source]

Retrieve a specific page of SyncListPermissionInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of SyncListPermissionInstance
Return type:twilio.rest.sync.v1.service.sync_list.sync_list_permission.SyncListPermissionPage
list(limit=None, page_size=None)[source]

Lists SyncListPermissionInstance 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.sync.v1.service.sync_list.sync_list_permission.SyncListPermissionInstance]

page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

Retrieve a single page of SyncListPermissionInstance records from the API. Request is executed immediately

Parameters:
  • page_token (str) – PageToken provided by the API
  • page_number (int) – Page Number, this value is simply for client state
  • page_size (int) – Number of records to return, defaults to 50
Returns:

Page of SyncListPermissionInstance

Return type:

twilio.rest.sync.v1.service.sync_list.sync_list_permission.SyncListPermissionPage

stream(limit=None, page_size=None)[source]

Streams SyncListPermissionInstance 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.sync.v1.service.sync_list.sync_list_permission.SyncListPermissionInstance]

class twilio.rest.sync.v1.service.sync_list.sync_list_permission.SyncListPermissionPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of SyncListPermissionInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.sync.v1.service.sync_list.sync_list_permission.SyncListPermissionInstance
Return type:twilio.rest.sync.v1.service.sync_list.sync_list_permission.SyncListPermissionInstance

Module contents

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.sync.v1.service.sync_list.SyncListContext(version, service_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

delete()[source]

Deletes the SyncListInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the SyncListInstance

Returns:The fetched SyncListInstance
Return type:twilio.rest.sync.v1.service.sync_list.SyncListInstance
sync_list_items

Access the sync_list_items

Returns:twilio.rest.sync.v1.service.sync_list.sync_list_item.SyncListItemList
Return type:twilio.rest.sync.v1.service.sync_list.sync_list_item.SyncListItemList
sync_list_permissions

Access the sync_list_permissions

Returns:twilio.rest.sync.v1.service.sync_list.sync_list_permission.SyncListPermissionList
Return type:twilio.rest.sync.v1.service.sync_list.sync_list_permission.SyncListPermissionList
update(ttl=<object object>, collection_ttl=<object object>)[source]

Update the SyncListInstance

Parameters:
  • ttl (unicode) – An alias for collection_ttl
  • collection_ttl (unicode) – How long, in seconds, before the Sync List expires and is deleted
Returns:

The updated SyncListInstance

Return type:

twilio.rest.sync.v1.service.sync_list.SyncListInstance

class twilio.rest.sync.v1.service.sync_list.SyncListInstance(version, payload, service_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
created_by
Returns:The identity of the Sync List’s creator
Return type:unicode
date_created
Returns:The ISO 8601 date and time in GMT when the resource was created
Return type:datetime
date_expires
Returns:The ISO 8601 date and time in GMT when the Sync List expires
Return type:datetime
date_updated
Returns:The ISO 8601 date and time in GMT when the resource was last updated
Return type:datetime
delete()[source]

Deletes the SyncListInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the SyncListInstance

Returns:The fetched SyncListInstance
Return type:twilio.rest.sync.v1.service.sync_list.SyncListInstance
Returns:The URLs of the Sync List’s nested resources
Return type:unicode
revision
Returns:The current revision of the Sync List, represented as a string
Return type:unicode
service_sid
Returns:The SID of the Sync Service that the resource is associated with
Return type:unicode
sid
Returns:The unique string that identifies the resource
Return type:unicode
sync_list_items

Access the sync_list_items

Returns:twilio.rest.sync.v1.service.sync_list.sync_list_item.SyncListItemList
Return type:twilio.rest.sync.v1.service.sync_list.sync_list_item.SyncListItemList
sync_list_permissions

Access the sync_list_permissions

Returns:twilio.rest.sync.v1.service.sync_list.sync_list_permission.SyncListPermissionList
Return type:twilio.rest.sync.v1.service.sync_list.sync_list_permission.SyncListPermissionList
unique_name
Returns:An application-defined string that uniquely identifies the resource
Return type:unicode
update(ttl=<object object>, collection_ttl=<object object>)[source]

Update the SyncListInstance

Parameters:
  • ttl (unicode) – An alias for collection_ttl
  • collection_ttl (unicode) – How long, in seconds, before the Sync List expires and is deleted
Returns:

The updated SyncListInstance

Return type:

twilio.rest.sync.v1.service.sync_list.SyncListInstance

url
Returns:The absolute URL of the Sync List resource
Return type:unicode
class twilio.rest.sync.v1.service.sync_list.SyncListList(version, service_sid)[source]

Bases: twilio.base.list_resource.ListResource

create(unique_name=<object object>, ttl=<object object>, collection_ttl=<object object>)[source]

Create the SyncListInstance

Parameters:
  • unique_name (unicode) – An application-defined string that uniquely identifies the resource
  • ttl (unicode) – Alias for collection_ttl
  • collection_ttl (unicode) – How long, in seconds, before the Sync List expires and is deleted
Returns:

The created SyncListInstance

Return type:

twilio.rest.sync.v1.service.sync_list.SyncListInstance

get(sid)[source]

Constructs a SyncListContext

Parameters:sid – The SID of the Sync List resource to fetch
Returns:twilio.rest.sync.v1.service.sync_list.SyncListContext
Return type:twilio.rest.sync.v1.service.sync_list.SyncListContext
get_page(target_url)[source]

Retrieve a specific page of SyncListInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of SyncListInstance
Return type:twilio.rest.sync.v1.service.sync_list.SyncListPage
list(limit=None, page_size=None)[source]

Lists SyncListInstance 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.sync.v1.service.sync_list.SyncListInstance]

page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

Retrieve a single page of SyncListInstance records from the API. Request is executed immediately

Parameters:
  • page_token (str) – PageToken provided by the API
  • page_number (int) – Page Number, this value is simply for client state
  • page_size (int) – Number of records to return, defaults to 50
Returns:

Page of SyncListInstance

Return type:

twilio.rest.sync.v1.service.sync_list.SyncListPage

stream(limit=None, page_size=None)[source]

Streams SyncListInstance 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.sync.v1.service.sync_list.SyncListInstance]

class twilio.rest.sync.v1.service.sync_list.SyncListPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of SyncListInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.sync.v1.service.sync_list.SyncListInstance
Return type:twilio.rest.sync.v1.service.sync_list.SyncListInstance