Class: Twilio::REST::Bulkexports::V1::ExportContext::ExportCustomJobList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Bulkexports::V1::ExportContext::ExportCustomJobList
- Defined in:
- lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb
Instance Method Summary collapse
-
#create(start_day: nil, end_day: nil, friendly_name: nil, webhook_url: :unset, webhook_method: :unset, email: :unset) ⇒ ExportCustomJobInstance
Create the ExportCustomJobInstance.
-
#each ⇒ Object
When passed a block, yields ExportCustomJobInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of ExportCustomJobInstance records from the API.
-
#initialize(version, resource_type: nil) ⇒ ExportCustomJobList
constructor
Initialize the ExportCustomJobList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists ExportCustomJobInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of ExportCustomJobInstance records from the API.
-
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, resource_type: nil) ⇒ ExportCustomJobList
Initialize the ExportCustomJobList
27 28 29 30 31 32 33 |
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 27 def initialize(version, resource_type: nil) super(version) # Path Solution @solution = { resource_type: resource_type } @uri = "/Exports/#{@solution[:resource_type]}/Jobs" end |
Instance Method Details
#create(start_day: nil, end_day: nil, friendly_name: nil, webhook_url: :unset, webhook_method: :unset, email: :unset) ⇒ ExportCustomJobInstance
Create the ExportCustomJobInstance
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 43 def create( start_day: nil, end_day: nil, friendly_name: nil, webhook_url: :unset, webhook_method: :unset, email: :unset ) data = Twilio::Values.of({ 'StartDay' => start_day, 'EndDay' => end_day, 'FriendlyName' => friendly_name, 'WebhookUrl' => webhook_url, 'WebhookMethod' => webhook_method, 'Email' => email, }) payload = @version.create('POST', @uri, data: data) ExportCustomJobInstance.new( @version, payload, resource_type: @solution[:resource_type], ) end |
#each ⇒ Object
When passed a block, yields ExportCustomJobInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
112 113 114 115 116 117 118 119 120 |
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 112 def each limits = @version.read_limits page = self.page(page_size: limits[:page_size], ) @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]).each {|x| yield x} end |
#get_page(target_url) ⇒ Page
Retrieve a single page of ExportCustomJobInstance records from the API. Request is executed immediately.
146 147 148 149 150 151 152 |
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 146 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) ExportCustomJobPage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists ExportCustomJobInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
81 82 83 84 85 86 |
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 81 def list(limit: nil, page_size: nil) self.stream( limit: limit, page_size: page_size ).entries end |
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of ExportCustomJobInstance records from the API. Request is executed immediately.
129 130 131 132 133 134 135 136 137 138 139 |
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 129 def page(page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) ExportCustomJobPage.new(@version, response, @solution) end |
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
99 100 101 102 103 104 105 106 |
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 99 def stream(limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( page_size: limits[:page_size], ) @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) end |
#to_s ⇒ Object
Provide a user friendly representation
157 158 159 |
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 157 def to_s '#<Twilio.Bulkexports.V1.ExportCustomJobList>' end |