Class: Twilio::REST::Bulkexports::V1::ExportContext::ExportCustomJobList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, resource_type: nil) ⇒ ExportCustomJobList

Initialize the ExportCustomJobList



23
24
25
26
27
28
29
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 23

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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 128

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.



69
70
71
72
73
74
75
76
77
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 69

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.



103
104
105
106
107
108
109
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 103

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.



42
43
44
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 42

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.



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 86

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 ExportCustomJobInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



57
58
59
60
61
62
63
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 57

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



145
146
147
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 145

def to_s
  '#<Twilio.Bulkexports.V1.ExportCustomJobList>'
end