twilio.rest.bulkexports.v1.export package

Submodules

twilio.rest.bulkexports.v1.export.day module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/bulkexports/v1/export/day.py:docstring of twilio.rest.bulkexports.v1.export.day, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.bulkexports.v1.export.day.DayContext(version, resource_type, day)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch()[source]

Fetch the DayInstance

Returns:The fetched DayInstance
Return type:twilio.rest.bulkexports.v1.export.day.DayInstance
class twilio.rest.bulkexports.v1.export.day.DayInstance(version, payload, resource_type, day=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

create_date
Returns:The date when resource is created
Return type:unicode
day
Returns:The date of the data in the file
Return type:unicode
fetch()[source]

Fetch the DayInstance

Returns:The fetched DayInstance
Return type:twilio.rest.bulkexports.v1.export.day.DayInstance
friendly_name
Returns:The friendly name specified when creating the job
Return type:unicode
redirect_to
Returns:The redirect_to
Return type:unicode
resource_type
Returns:The type of communication – Messages, Calls, Conferences, and Participants
Return type:unicode
size
Returns:Size of the file in bytes
Return type:unicode
class twilio.rest.bulkexports.v1.export.day.DayList(version, resource_type)[source]

Bases: twilio.base.list_resource.ListResource

get(day)[source]

Constructs a DayContext

Parameters:day – The date of the data in the file
Returns:twilio.rest.bulkexports.v1.export.day.DayContext
Return type:twilio.rest.bulkexports.v1.export.day.DayContext
get_page(target_url)[source]

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

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of DayInstance
Return type:twilio.rest.bulkexports.v1.export.day.DayPage
list(limit=None, page_size=None)[source]

Lists DayInstance 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.bulkexports.v1.export.day.DayInstance]

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

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

Return type:

twilio.rest.bulkexports.v1.export.day.DayPage

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

Streams DayInstance 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.bulkexports.v1.export.day.DayInstance]

class twilio.rest.bulkexports.v1.export.day.DayPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of DayInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.bulkexports.v1.export.day.DayInstance
Return type:twilio.rest.bulkexports.v1.export.day.DayInstance

twilio.rest.bulkexports.v1.export.export_custom_job module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/bulkexports/v1/export/export_custom_job.py:docstring of twilio.rest.bulkexports.v1.export.export_custom_job, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.bulkexports.v1.export.export_custom_job.ExportCustomJobInstance(version, payload, resource_type)[source]

Bases: twilio.base.instance_resource.InstanceResource

class Status[source]

Bases: object

COMPLETED = 'Completed'
COMPLETEDEMPTYRECORDS = 'CompletedEmptyRecords'
DELETEDBYUSERREQUEST = 'DeletedByUserRequest'
ERRORDURINGRUN = 'ErrorDuringRun'
FAILED = 'Failed'
RUNNING = 'Running'
RUNNINGTOBEDELETED = 'RunningToBeDeleted'
SUBMITTED = 'Submitted'
details
Returns:The details of a job state which is an object that contains a status string, a day count integer, and list of days in the job
Return type:dict
email
Returns:The optional email to send the completion notification to
Return type:unicode
end_day
Returns:The end day for the custom export specified as a string in the format of yyyy-MM-dd. This will be the last day exported. For instance, to export a single day, choose the same day for start and end day. To export the first 4 days of July, you would set the start date to 2020-07-01 and the end date to 2020-07-04. The end date must be the UTC day before yesterday.
Return type:unicode
estimated_completion_time
Returns:this is the time estimated until your job is complete. This is calculated each time you request the job list. The time is calculated based on the current rate of job completion (which may vary) and your job queue position
Return type:unicode
friendly_name
Returns:The friendly name specified when creating the job
Return type:unicode
job_queue_position
Returns:This is the job position from the 1st in line. Your queue position will never increase. As jobs ahead of yours in the queue are processed, the queue position number will decrease
Return type:unicode
job_sid
Returns:The unique job_sid returned when the custom export was created. This can be used to look up the status of the job.
Return type:unicode
resource_type
Returns:The type of communication – Messages, Calls, Conferences, and Participants
Return type:unicode
start_day
Returns:The start day for the custom export specified as a string in the format of yyyy-MM-dd
Return type:unicode
webhook_method
Returns:This is the method used to call the webhook
Return type:unicode
webhook_url
Returns:The optional webhook url called on completion
Return type:unicode
class twilio.rest.bulkexports.v1.export.export_custom_job.ExportCustomJobList(version, resource_type)[source]

Bases: twilio.base.list_resource.ListResource

create(start_day, end_day, friendly_name, webhook_url=<object object>, webhook_method=<object object>, email=<object object>)[source]

Create the ExportCustomJobInstance

Parameters:
  • start_day (unicode) – The start day for the custom export specified as a string in the format of yyyy-mm-dd
  • end_day (unicode) – The end day for the custom export specified as a string in the format of yyyy-mm-dd. End day is inclusive and must be 2 days earlier than the current UTC day.
  • friendly_name (unicode) – The friendly name specified when creating the job
  • webhook_url (unicode) – The optional webhook url called on completion of the job. If this is supplied, WebhookMethod must also be supplied.
  • webhook_method (unicode) – This is the method used to call the webhook on completion of the job. If this is supplied, WebhookUrl must also be supplied.
  • email (unicode) – The optional email to send the completion notification to
Returns:

The created ExportCustomJobInstance

Return type:

twilio.rest.bulkexports.v1.export.export_custom_job.ExportCustomJobInstance

get_page(target_url)[source]

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

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of ExportCustomJobInstance
Return type:twilio.rest.bulkexports.v1.export.export_custom_job.ExportCustomJobPage
list(limit=None, page_size=None)[source]

Lists ExportCustomJobInstance 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.bulkexports.v1.export.export_custom_job.ExportCustomJobInstance]

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

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

Return type:

twilio.rest.bulkexports.v1.export.export_custom_job.ExportCustomJobPage

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

Streams ExportCustomJobInstance 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.bulkexports.v1.export.export_custom_job.ExportCustomJobInstance]

class twilio.rest.bulkexports.v1.export.export_custom_job.ExportCustomJobPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of ExportCustomJobInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.bulkexports.v1.export.export_custom_job.ExportCustomJobInstance
Return type:twilio.rest.bulkexports.v1.export.export_custom_job.ExportCustomJobInstance

twilio.rest.bulkexports.v1.export.job module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/bulkexports/v1/export/job.py:docstring of twilio.rest.bulkexports.v1.export.job, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.bulkexports.v1.export.job.JobContext(version, job_sid)[source]

Bases: twilio.base.instance_context.InstanceContext

delete()[source]

Deletes the JobInstance

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

Fetch the JobInstance

Returns:The fetched JobInstance
Return type:twilio.rest.bulkexports.v1.export.job.JobInstance
class twilio.rest.bulkexports.v1.export.job.JobInstance(version, payload, job_sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

class Status[source]

Bases: object

COMPLETED = 'Completed'
COMPLETEDEMPTYRECORDS = 'CompletedEmptyRecords'
DELETEDBYUSERREQUEST = 'DeletedByUserRequest'
ERRORDURINGRUN = 'ErrorDuringRun'
FAILED = 'Failed'
RUNNING = 'Running'
RUNNINGTOBEDELETED = 'RunningToBeDeleted'
SUBMITTED = 'Submitted'
delete()[source]

Deletes the JobInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
details
Returns:The details of a job state which is an object that contains a status string, a day count integer, and list of days in the job
Return type:dict
email
Returns:The optional email to send the completion notification to
Return type:unicode
end_day
Returns:The end time for the export specified when creating the job
Return type:unicode
estimated_completion_time
Returns:this is the time estimated until your job is complete. This is calculated each time you request the job list. The time is calculated based on the current rate of job completion (which may vary) and your job queue position
Return type:unicode
fetch()[source]

Fetch the JobInstance

Returns:The fetched JobInstance
Return type:twilio.rest.bulkexports.v1.export.job.JobInstance
friendly_name
Returns:The friendly name specified when creating the job
Return type:unicode
job_queue_position
Returns:This is the job position from the 1st in line. Your queue position will never increase. As jobs ahead of yours in the queue are processed, the queue position number will decrease
Return type:unicode
job_sid
Returns:The job_sid returned when the export was created
Return type:unicode
resource_type
Returns:The type of communication – Messages, Calls, Conferences, and Participants
Return type:unicode
start_day
Returns:The start time for the export specified when creating the job
Return type:unicode
url
Returns:The url
Return type:unicode
webhook_method
Returns:This is the method used to call the webhook
Return type:unicode
webhook_url
Returns:The optional webhook url called on completion
Return type:unicode
class twilio.rest.bulkexports.v1.export.job.JobList(version)[source]

Bases: twilio.base.list_resource.ListResource

get(job_sid)[source]

Constructs a JobContext

Parameters:job_sid – The unique string that that we created to identify the Bulk Export job
Returns:twilio.rest.bulkexports.v1.export.job.JobContext
Return type:twilio.rest.bulkexports.v1.export.job.JobContext
class twilio.rest.bulkexports.v1.export.job.JobPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of JobInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.bulkexports.v1.export.job.JobInstance
Return type:twilio.rest.bulkexports.v1.export.job.JobInstance

Module contents

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

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/bulkexports/v1/export/__init__.py:docstring of twilio.rest.bulkexports.v1.export, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.bulkexports.v1.export.ExportContext(version, resource_type)[source]

Bases: twilio.base.instance_context.InstanceContext

days

Access the days

Returns:twilio.rest.bulkexports.v1.export.day.DayList
Return type:twilio.rest.bulkexports.v1.export.day.DayList
export_custom_jobs

Access the export_custom_jobs

Returns:twilio.rest.bulkexports.v1.export.export_custom_job.ExportCustomJobList
Return type:twilio.rest.bulkexports.v1.export.export_custom_job.ExportCustomJobList
fetch()[source]

Fetch the ExportInstance

Returns:The fetched ExportInstance
Return type:twilio.rest.bulkexports.v1.export.ExportInstance
class twilio.rest.bulkexports.v1.export.ExportInstance(version, payload, resource_type=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

days

Access the days

Returns:twilio.rest.bulkexports.v1.export.day.DayList
Return type:twilio.rest.bulkexports.v1.export.day.DayList
export_custom_jobs

Access the export_custom_jobs

Returns:twilio.rest.bulkexports.v1.export.export_custom_job.ExportCustomJobList
Return type:twilio.rest.bulkexports.v1.export.export_custom_job.ExportCustomJobList
fetch()[source]

Fetch the ExportInstance

Returns:The fetched ExportInstance
Return type:twilio.rest.bulkexports.v1.export.ExportInstance
Returns:Nested resource URLs.
Return type:unicode
resource_type
Returns:The type of communication – Messages, Calls, Conferences, and Participants
Return type:unicode
url
Returns:The URL of this resource.
Return type:unicode
class twilio.rest.bulkexports.v1.export.ExportList(version)[source]

Bases: twilio.base.list_resource.ListResource

get(resource_type)[source]

Constructs a ExportContext

Parameters:resource_type – The type of communication – Messages, Calls, Conferences, and Participants
Returns:twilio.rest.bulkexports.v1.export.ExportContext
Return type:twilio.rest.bulkexports.v1.export.ExportContext
jobs

Access the jobs

Returns:twilio.rest.bulkexports.v1.export.job.JobList
Return type:twilio.rest.bulkexports.v1.export.job.JobList
class twilio.rest.bulkexports.v1.export.ExportPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of ExportInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.bulkexports.v1.export.ExportInstance
Return type:twilio.rest.bulkexports.v1.export.ExportInstance