Class: Twilio::REST::Preview::BulkExports::ExportList::JobInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/bulk_exports/export/job.rb

Overview

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 [email protected].

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, job_sid: nil) ⇒ JobInstance

Initialize the JobInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • job_sid (String) (defaults to: nil) —

    The job_sid



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export/job.rb', line 122

def initialize(version, payload, job_sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'resource_type' => payload['resource_type'],
      'friendly_name' => payload['friendly_name'],
      'details' => payload['details'],
      'start_day' => payload['start_day'],
      'end_day' => payload['end_day'],
      'job_sid' => payload['job_sid'],
      'webhook_url' => payload['webhook_url'],
      'webhook_method' => payload['webhook_method'],
      'email' => payload['email'],
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {'job_sid' => job_sid || @properties['job_sid'], }
end

Instance Method Details

#context ⇒ JobContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:

  • (JobContext) —

    JobContext for this JobInstance



148
149
150
151
152
153
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export/job.rb', line 148

def context
  unless @instance_context
    @instance_context = JobContext.new(@version, @params['job_sid'], )
  end
  @instance_context
end

#delete ⇒ Boolean

Delete the JobInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



225
226
227
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export/job.rb', line 225

def delete
  context.delete
end

#details ⇒ Hash

Returns This is a list of the completed, pending, or errored dates within the export time range, with one entry for each status with more than one day in that status.

Returns:

  • (Hash) —

    This is a list of the completed, pending, or errored dates within the export time range, with one entry for each status with more than one day in that status



169
170
171
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export/job.rb', line 169

def details
  @properties['details']
end

#email ⇒ String

Returns The optional email to send the completion notification to.

Returns:

  • (String) —

    The optional email to send the completion notification to



205
206
207
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export/job.rb', line 205

def email
  @properties['email']
end

#end_day ⇒ String

Returns The end time for the export specified when creating the job.

Returns:

  • (String) —

    The end time for the export specified when creating the job



181
182
183
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export/job.rb', line 181

def end_day
  @properties['end_day']
end

#fetch ⇒ JobInstance

Fetch the JobInstance

Returns:



218
219
220
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export/job.rb', line 218

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The friendly name specified when creating the job.

Returns:

  • (String) —

    The friendly name specified when creating the job



163
164
165
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export/job.rb', line 163

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



238
239
240
241
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export/job.rb', line 238

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Preview.BulkExports.JobInstance #{values}>"
end

#job_sid ⇒ String

Returns The job_sid returned when the export was created.

Returns:

  • (String) —

    The job_sid returned when the export was created



187
188
189
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export/job.rb', line 187

def job_sid
  @properties['job_sid']
end

#resource_type ⇒ String

Returns The type of communication – Messages, Calls.

Returns:

  • (String) —

    The type of communication – Messages, Calls



157
158
159
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export/job.rb', line 157

def resource_type
  @properties['resource_type']
end

#start_day ⇒ String

Returns The start time for the export specified when creating the job.

Returns:

  • (String) —

    The start time for the export specified when creating the job



175
176
177
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export/job.rb', line 175

def start_day
  @properties['start_day']
end

#to_s ⇒ Object

Provide a user friendly representation



231
232
233
234
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export/job.rb', line 231

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Preview.BulkExports.JobInstance #{values}>"
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



211
212
213
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export/job.rb', line 211

def url
  @properties['url']
end

#webhook_method ⇒ String

Returns This is the method used to call the webhook.

Returns:

  • (String) —

    This is the method used to call the webhook



199
200
201
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export/job.rb', line 199

def webhook_method
  @properties['webhook_method']
end

#webhook_url ⇒ String

Returns The optional webhook url called on completion.

Returns:

  • (String) —

    The optional webhook url called on completion



193
194
195
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export/job.rb', line 193

def webhook_url
  @properties['webhook_url']
end