class Twilio::REST::Preview::BulkExports::ExportContext::ExportCustomJobList
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.
Public Class Methods
Initialize the ExportCustomJobList
@param [Version] version Version
that contains the resource @param [String] resource_type The type of communication – Messages, Calls,
Conferences, and Participants
@return [ExportCustomJobList] ExportCustomJobList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb 23 def initialize(version, resource_type: nil) 24 super(version) 25 26 # Path Solution 27 @solution = {resource_type: resource_type} 28 @uri = "/Exports/#{@solution[:resource_type]}/Jobs" 29 end
Public Instance Methods
Create the ExportCustomJobInstance
@param [String] start_day The start day for the custom export specified as a
string in the format of yyyy-mm-dd
@param [String] end_day 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.
@param [String] friendly_name The friendly name specified when creating the job @param [String] webhook_url The optional webhook url called on completion of the
job. If this is supplied, `WebhookMethod` must also be supplied.
@param [String] webhook_method This is the method used to call the webhook on
completion of the job. If this is supplied, `WebhookUrl` must also be supplied.
@param [String] email The optional email to send the completion notification to @return [ExportCustomJobInstance] Created ExportCustomJobInstance
# File lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb 125 def create(start_day: nil, end_day: nil, friendly_name: nil, webhook_url: :unset, webhook_method: :unset, email: :unset) 126 data = Twilio::Values.of({ 127 'StartDay' => start_day, 128 'EndDay' => end_day, 129 'FriendlyName' => friendly_name, 130 'WebhookUrl' => webhook_url, 131 'WebhookMethod' => webhook_method, 132 'Email' => email, 133 }) 134 135 payload = @version.create('POST', @uri, data: data) 136 137 ExportCustomJobInstance.new(@version, payload, resource_type: @solution[:resource_type], ) 138 end
When passed a block, yields ExportCustomJobInstance
records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
# File lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb 69 def each 70 limits = @version.read_limits 71 72 page = self.page(page_size: limits[:page_size], ) 73 74 @version.stream(page, 75 limit: limits[:limit], 76 page_limit: limits[:page_limit]).each {|x| yield x} 77 end
Retrieve a single page of ExportCustomJobInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of ExportCustomJobInstance
# File lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb 103 def get_page(target_url) 104 response = @version.domain.request( 105 'GET', 106 target_url 107 ) 108 ExportCustomJobPage.new(@version, response, @solution) 109 end
Lists ExportCustomJobInstance
records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
@param [Integer] page_size 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)
@return [Array] Array of up to limit results
# File lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb 42 def list(limit: nil, page_size: nil) 43 self.stream(limit: limit, page_size: page_size).entries 44 end
Retrieve a single page of ExportCustomJobInstance
records from the API. Request
is executed immediately. @param [String] page_token PageToken provided by the API @param [Integer] page_number Page
Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page
of ExportCustomJobInstance
# File lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb 86 def page(page_token: :unset, page_number: :unset, page_size: :unset) 87 params = Twilio::Values.of({ 88 'PageToken' => page_token, 89 'Page' => page_number, 90 'PageSize' => page_size, 91 }) 92 93 response = @version.page('GET', @uri, params: params) 94 95 ExportCustomJobPage.new(@version, response, @solution) 96 end
Streams ExportCustomJobInstance
records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit.
@param [Integer] page_size 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)
@return [Enumerable] Enumerable that will yield up to limit results
# File lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb 57 def stream(limit: nil, page_size: nil) 58 limits = @version.read_limits(limit, page_size) 59 60 page = self.page(page_size: limits[:page_size], ) 61 62 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 63 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb 142 def to_s 143 '#<Twilio.Preview.BulkExports.ExportCustomJobList>' 144 end