twilio.rest.sync.v1.service.sync_map package

Submodules

twilio.rest.sync.v1.service.sync_map.sync_map_item module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.sync.v1.service.sync_map.sync_map_item.SyncMapItemContext(version, service_sid, map_sid, key)[source]

Bases: twilio.base.instance_context.InstanceContext

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

Deletes the SyncMapItemInstance

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

Fetch the SyncMapItemInstance

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

Update the SyncMapItemInstance

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

The updated SyncMapItemInstance

Return type:

twilio.rest.sync.v1.service.sync_map.sync_map_item.SyncMapItemInstance

class twilio.rest.sync.v1.service.sync_map.sync_map_item.SyncMapItemInstance(version, payload, service_sid, map_sid, key=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 Map Item’s creator
Return type:unicode
data
Returns:An arbitrary, schema-less object that the Map 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 Map 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 SyncMapItemInstance

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

Fetch the SyncMapItemInstance

Returns:The fetched SyncMapItemInstance
Return type:twilio.rest.sync.v1.service.sync_map.sync_map_item.SyncMapItemInstance
key
Returns:The unique, user-defined key for the Map Item
Return type:unicode
map_sid
Returns:The SID of the Sync Map that contains the Map Item
Return type:unicode
revision
Returns:The current revision of the Map 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 SyncMapItemInstance

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

The updated SyncMapItemInstance

Return type:

twilio.rest.sync.v1.service.sync_map.sync_map_item.SyncMapItemInstance

url
Returns:The absolute URL of the Map Item resource
Return type:unicode
class twilio.rest.sync.v1.service.sync_map.sync_map_item.SyncMapItemList(version, service_sid, map_sid)[source]

Bases: twilio.base.list_resource.ListResource

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

Create the SyncMapItemInstance

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

The created SyncMapItemInstance

Return type:

twilio.rest.sync.v1.service.sync_map.sync_map_item.SyncMapItemInstance

get(key)[source]

Constructs a SyncMapItemContext

Parameters:key – The key value of the Sync Map Item resource to fetch
Returns:twilio.rest.sync.v1.service.sync_map.sync_map_item.SyncMapItemContext
Return type:twilio.rest.sync.v1.service.sync_map.sync_map_item.SyncMapItemContext
get_page(target_url)[source]

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

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

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

Parameters:
  • order (SyncMapItemInstance.QueryResultOrder) – How to order the Map Items returned by their key value
  • from (unicode) – The index of the first Sync Map Item resource to read
  • bounds (SyncMapItemInstance.QueryFromBoundType) – Whether to include the Map 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_map.sync_map_item.SyncMapItemInstance]

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 SyncMapItemInstance records from the API. Request is executed immediately

Parameters:
  • order (SyncMapItemInstance.QueryResultOrder) – How to order the Map Items returned by their key value
  • from (unicode) – The index of the first Sync Map Item resource to read
  • bounds (SyncMapItemInstance.QueryFromBoundType) – Whether to include the Map 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 SyncMapItemInstance

Return type:

twilio.rest.sync.v1.service.sync_map.sync_map_item.SyncMapItemPage

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

Streams SyncMapItemInstance 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 (SyncMapItemInstance.QueryResultOrder) – How to order the Map Items returned by their key value
  • from (unicode) – The index of the first Sync Map Item resource to read
  • bounds (SyncMapItemInstance.QueryFromBoundType) – Whether to include the Map 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_map.sync_map_item.SyncMapItemInstance]

class twilio.rest.sync.v1.service.sync_map.sync_map_item.SyncMapItemPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of SyncMapItemInstance

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

twilio.rest.sync.v1.service.sync_map.sync_map_permission module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.sync.v1.service.sync_map.sync_map_permission.SyncMapPermissionContext(version, service_sid, map_sid, identity)[source]

Bases: twilio.base.instance_context.InstanceContext

delete()[source]

Deletes the SyncMapPermissionInstance

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

Fetch the SyncMapPermissionInstance

Returns:The fetched SyncMapPermissionInstance
Return type:twilio.rest.sync.v1.service.sync_map.sync_map_permission.SyncMapPermissionInstance
update(read, write, manage)[source]

Update the SyncMapPermissionInstance

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

The updated SyncMapPermissionInstance

Return type:

twilio.rest.sync.v1.service.sync_map.sync_map_permission.SyncMapPermissionInstance

class twilio.rest.sync.v1.service.sync_map.sync_map_permission.SyncMapPermissionInstance(version, payload, service_sid, map_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 SyncMapPermissionInstance

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

Fetch the SyncMapPermissionInstance

Returns:The fetched SyncMapPermissionInstance
Return type:twilio.rest.sync.v1.service.sync_map.sync_map_permission.SyncMapPermissionInstance
identity
Returns:The identity of the user to whom the Sync Document Permission applies
Return type:unicode
manage
Returns:Manage access
Return type:bool
map_sid
Returns:Sync Map SID
Return type:unicode
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 SyncMapPermissionInstance

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

The updated SyncMapPermissionInstance

Return type:

twilio.rest.sync.v1.service.sync_map.sync_map_permission.SyncMapPermissionInstance

url
Returns:The absolute URL of the Sync Map Permission resource
Return type:unicode
write
Returns:Write access
Return type:bool
class twilio.rest.sync.v1.service.sync_map.sync_map_permission.SyncMapPermissionList(version, service_sid, map_sid)[source]

Bases: twilio.base.list_resource.ListResource

get(identity)[source]

Constructs a SyncMapPermissionContext

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

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

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

Lists SyncMapPermissionInstance 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_map.sync_map_permission.SyncMapPermissionInstance]

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

Retrieve a single page of SyncMapPermissionInstance 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 SyncMapPermissionInstance

Return type:

twilio.rest.sync.v1.service.sync_map.sync_map_permission.SyncMapPermissionPage

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

Streams SyncMapPermissionInstance 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_map.sync_map_permission.SyncMapPermissionInstance]

class twilio.rest.sync.v1.service.sync_map.sync_map_permission.SyncMapPermissionPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of SyncMapPermissionInstance

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

Module contents

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

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

Bases: twilio.base.instance_context.InstanceContext

delete()[source]

Deletes the SyncMapInstance

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

Fetch the SyncMapInstance

Returns:The fetched SyncMapInstance
Return type:twilio.rest.sync.v1.service.sync_map.SyncMapInstance
sync_map_items

Access the sync_map_items

Returns:twilio.rest.sync.v1.service.sync_map.sync_map_item.SyncMapItemList
Return type:twilio.rest.sync.v1.service.sync_map.sync_map_item.SyncMapItemList
sync_map_permissions

Access the sync_map_permissions

Returns:twilio.rest.sync.v1.service.sync_map.sync_map_permission.SyncMapPermissionList
Return type:twilio.rest.sync.v1.service.sync_map.sync_map_permission.SyncMapPermissionList
update(ttl=<object object>, collection_ttl=<object object>)[source]

Update the SyncMapInstance

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

The updated SyncMapInstance

Return type:

twilio.rest.sync.v1.service.sync_map.SyncMapInstance

class twilio.rest.sync.v1.service.sync_map.SyncMapInstance(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 Map’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 Map 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 SyncMapInstance

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

Fetch the SyncMapInstance

Returns:The fetched SyncMapInstance
Return type:twilio.rest.sync.v1.service.sync_map.SyncMapInstance
Returns:The URLs of the Sync Map’s nested resources
Return type:unicode
revision
Returns:The current revision of the Sync Map, 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_map_items

Access the sync_map_items

Returns:twilio.rest.sync.v1.service.sync_map.sync_map_item.SyncMapItemList
Return type:twilio.rest.sync.v1.service.sync_map.sync_map_item.SyncMapItemList
sync_map_permissions

Access the sync_map_permissions

Returns:twilio.rest.sync.v1.service.sync_map.sync_map_permission.SyncMapPermissionList
Return type:twilio.rest.sync.v1.service.sync_map.sync_map_permission.SyncMapPermissionList
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 SyncMapInstance

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

The updated SyncMapInstance

Return type:

twilio.rest.sync.v1.service.sync_map.SyncMapInstance

url
Returns:The absolute URL of the Sync Map resource
Return type:unicode
class twilio.rest.sync.v1.service.sync_map.SyncMapList(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 SyncMapInstance

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

The created SyncMapInstance

Return type:

twilio.rest.sync.v1.service.sync_map.SyncMapInstance

get(sid)[source]

Constructs a SyncMapContext

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

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

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

Lists SyncMapInstance 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_map.SyncMapInstance]

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

Retrieve a single page of SyncMapInstance 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 SyncMapInstance

Return type:

twilio.rest.sync.v1.service.sync_map.SyncMapPage

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

Streams SyncMapInstance 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_map.SyncMapInstance]

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

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of SyncMapInstance

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