twilio.rest.preview.sync.service.document package

Submodules

twilio.rest.preview.sync.service.document.document_permission module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.preview.sync.service.document.document_permission.DocumentPermissionContext(version, service_sid, document_sid, identity)[source]

Bases: twilio.base.instance_context.InstanceContext

PLEASE 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.

delete()[source]

Deletes the DocumentPermissionInstance

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

Fetch the DocumentPermissionInstance

Returns:The fetched DocumentPermissionInstance
Return type:twilio.rest.preview.sync.service.document.document_permission.DocumentPermissionInstance
update(read, write, manage)[source]

Update the DocumentPermissionInstance

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

The updated DocumentPermissionInstance

Return type:

twilio.rest.preview.sync.service.document.document_permission.DocumentPermissionInstance

class twilio.rest.preview.sync.service.document.document_permission.DocumentPermissionInstance(version, payload, service_sid, document_sid, identity=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

PLEASE 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.

account_sid
Returns:Twilio Account SID.
Return type:unicode
delete()[source]

Deletes the DocumentPermissionInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
document_sid
Returns:Sync Document SID.
Return type:unicode
fetch()[source]

Fetch the DocumentPermissionInstance

Returns:The fetched DocumentPermissionInstance
Return type:twilio.rest.preview.sync.service.document.document_permission.DocumentPermissionInstance
identity
Returns:Identity of the user to whom the Sync Document Permission applies.
Return type:unicode
manage
Returns:Manage access.
Return type:bool
read
Returns:Read access.
Return type:bool
service_sid
Returns:Sync Service Instance SID.
Return type:unicode
update(read, write, manage)[source]

Update the DocumentPermissionInstance

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

The updated DocumentPermissionInstance

Return type:

twilio.rest.preview.sync.service.document.document_permission.DocumentPermissionInstance

url
Returns:URL of this Sync Document Permission.
Return type:unicode
write
Returns:Write access.
Return type:bool
class twilio.rest.preview.sync.service.document.document_permission.DocumentPermissionList(version, service_sid, document_sid)[source]

Bases: twilio.base.list_resource.ListResource

PLEASE 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(identity)[source]

Constructs a DocumentPermissionContext

Parameters:identity – Identity of the user to whom the Sync Document Permission applies.
Returns:twilio.rest.preview.sync.service.document.document_permission.DocumentPermissionContext
Return type:twilio.rest.preview.sync.service.document.document_permission.DocumentPermissionContext
get_page(target_url)[source]

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

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of DocumentPermissionInstance
Return type:twilio.rest.preview.sync.service.document.document_permission.DocumentPermissionPage
list(limit=None, page_size=None)[source]

Lists DocumentPermissionInstance 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.preview.sync.service.document.document_permission.DocumentPermissionInstance]

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

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

Return type:

twilio.rest.preview.sync.service.document.document_permission.DocumentPermissionPage

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

Streams DocumentPermissionInstance 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.preview.sync.service.document.document_permission.DocumentPermissionInstance]

class twilio.rest.preview.sync.service.document.document_permission.DocumentPermissionPage(version, response, solution)[source]

Bases: twilio.base.page.Page

PLEASE 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 DocumentPermissionInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.preview.sync.service.document.document_permission.DocumentPermissionInstance
Return type:twilio.rest.preview.sync.service.document.document_permission.DocumentPermissionInstance

Module contents

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

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

Bases: twilio.base.instance_context.InstanceContext

PLEASE 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.

delete()[source]

Deletes the DocumentInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
document_permissions

Access the document_permissions

Returns:twilio.rest.preview.sync.service.document.document_permission.DocumentPermissionList
Return type:twilio.rest.preview.sync.service.document.document_permission.DocumentPermissionList
fetch()[source]

Fetch the DocumentInstance

Returns:The fetched DocumentInstance
Return type:twilio.rest.preview.sync.service.document.DocumentInstance
update(data, if_match=<object object>)[source]

Update the DocumentInstance

Parameters:
  • data (dict) – The data
  • if_match (unicode) – The If-Match HTTP request header
Returns:

The updated DocumentInstance

Return type:

twilio.rest.preview.sync.service.document.DocumentInstance

class twilio.rest.preview.sync.service.document.DocumentInstance(version, payload, service_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

PLEASE 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.

account_sid
Returns:The account_sid
Return type:unicode
created_by
Returns:The created_by
Return type:unicode
data
Returns:The data
Return type:dict
date_created
Returns:The date_created
Return type:datetime
date_updated
Returns:The date_updated
Return type:datetime
delete()[source]

Deletes the DocumentInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
document_permissions

Access the document_permissions

Returns:twilio.rest.preview.sync.service.document.document_permission.DocumentPermissionList
Return type:twilio.rest.preview.sync.service.document.document_permission.DocumentPermissionList
fetch()[source]

Fetch the DocumentInstance

Returns:The fetched DocumentInstance
Return type:twilio.rest.preview.sync.service.document.DocumentInstance
Returns:The links
Return type:unicode
revision
Returns:The revision
Return type:unicode
service_sid
Returns:The service_sid
Return type:unicode
sid
Returns:The sid
Return type:unicode
unique_name
Returns:The unique_name
Return type:unicode
update(data, if_match=<object object>)[source]

Update the DocumentInstance

Parameters:
  • data (dict) – The data
  • if_match (unicode) – The If-Match HTTP request header
Returns:

The updated DocumentInstance

Return type:

twilio.rest.preview.sync.service.document.DocumentInstance

url
Returns:The url
Return type:unicode
class twilio.rest.preview.sync.service.document.DocumentList(version, service_sid)[source]

Bases: twilio.base.list_resource.ListResource

PLEASE 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.

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

Create the DocumentInstance

Parameters:
  • unique_name (unicode) – The unique_name
  • data (dict) – The data
Returns:

The created DocumentInstance

Return type:

twilio.rest.preview.sync.service.document.DocumentInstance

get(sid)[source]

Constructs a DocumentContext

Parameters:sid – The sid
Returns:twilio.rest.preview.sync.service.document.DocumentContext
Return type:twilio.rest.preview.sync.service.document.DocumentContext
get_page(target_url)[source]

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

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

Lists DocumentInstance 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.preview.sync.service.document.DocumentInstance]

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

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

Return type:

twilio.rest.preview.sync.service.document.DocumentPage

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

Streams DocumentInstance 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.preview.sync.service.document.DocumentInstance]

class twilio.rest.preview.sync.service.document.DocumentPage(version, response, solution)[source]

Bases: twilio.base.page.Page

PLEASE 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 DocumentInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.preview.sync.service.document.DocumentInstance
Return type:twilio.rest.preview.sync.service.document.DocumentInstance