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

Instance Method Summary collapse

Constructor Details

#initialize(version, resource_type: nil) ⇒ ExportCustomJobList

Initialize the ExportCustomJobList

Parameters:

  • version (Version)

    Version that contains the resource

  • resource_type (String) (defaults to: nil)

    The type of communication – Messages, Calls, Conferences, and Participants


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

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

Parameters:

  • start_day (String) (defaults to: nil)

    The start day for the custom export specified as a string in the format of yyyy-mm-dd

  • end_day (String) (defaults to: nil)

    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 (String) (defaults to: nil)

    The friendly name specified when creating the job

  • webhook_url (String) (defaults to: :unset)

    The optional webhook url called on completion of the job. If this is supplied, `WebhookMethod` must also be supplied. If you set neither webhook nor email, you will have to check your job's status manually.

  • webhook_method (String) (defaults to: :unset)

    This is the method used to call the webhook on completion of the job. If this is supplied, `WebhookUrl` must also be supplied.

  • email (String) (defaults to: :unset)

    The optional email to send the completion notification to. You can set both webhook, and email, or one or the other. If you set neither, the job will run but you will have to query to determine your job's status.

Returns:


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

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

#eachObject

When passed a block, yields ExportCustomJobInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.


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

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.

Parameters:

  • target_url (String)

    API-generated URL for the requested results page

Returns:

  • (Page)

    Page of ExportCustomJobInstance


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

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.

Parameters:

  • limit (Integer) (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil)

    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:

  • (Array)

    Array of up to limit results


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

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.

Parameters:

  • page_token (String) (defaults to: :unset)

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset)

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset)

    Number of records to return, defaults to 50

Returns:

  • (Page)

    Page of ExportCustomJobInstance


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

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.

Parameters:

  • limit (Integer) (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil)

    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:

  • (Enumerable)

    Enumerable that will yield up to limit results


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

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_sObject

Provide a user friendly representation


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

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