Class: Twilio::REST::Bulkexports::V1::ExportContext::ExportCustomJobInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, resource_type: nil) ⇒ ExportCustomJobInstance

Initialize the ExportCustomJobInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this ExportCustomJob resource.

  • sid (String) —

    The SID of the Call resource to fetch.



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 201

def initialize(version, payload , resource_type: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'friendly_name' => payload['friendly_name'],
        'resource_type' => payload['resource_type'],
        'start_day' => payload['start_day'],
        'end_day' => payload['end_day'],
        'webhook_url' => payload['webhook_url'],
        'webhook_method' => payload['webhook_method'],
        'email' => payload['email'],
        'job_sid' => payload['job_sid'],
        'details' => payload['details'],
        'job_queue_position' => payload['job_queue_position'],
        'estimated_completion_time' => payload['estimated_completion_time'],
    }
end

Instance Method Details

#details ⇒ Hash

Returns The details of a job which is an object that contains an array of status grouped by ‘status` state. Each `status` object has a `status` string, a count which is the number of days in that `status`, and list of days in that `status`. The day strings are in the format yyyy-MM-dd. As an example, a currently running job may have a status object for COMPLETED and a `status` object for SUBMITTED each with its own count and list of days.

Returns:

  • (Hash) —

    The details of a job which is an object that contains an array of status grouped by ‘status` state. Each `status` object has a `status` string, a count which is the number of days in that `status`, and list of days in that `status`. The day strings are in the format yyyy-MM-dd. As an example, a currently running job may have a status object for COMPLETED and a `status` object for SUBMITTED each with its own count and list of days.



271
272
273
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 271

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



259
260
261
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 259

def email
    @properties['email']
end

#end_day ⇒ String

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

Returns:

  • (String) —

    The end day for the export specified when creating the job



241
242
243
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 241

def end_day
    @properties['end_day']
end

#estimated_completion_time ⇒ String

Returns this is the time estimated until your job is complete. This is calculated each time you request the job list. The time is calculated based on the current rate of job completion (which may vary) and your job queue position.

Returns:

  • (String) —

    this is the time estimated until your job is complete. This is calculated each time you request the job list. The time is calculated based on the current rate of job completion (which may vary) and your job queue position



283
284
285
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 283

def estimated_completion_time
    @properties['estimated_completion_time']
end

#friendly_name ⇒ String

Returns The friendly name specified when creating the job.

Returns:

  • (String) —

    The friendly name specified when creating the job



223
224
225
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 223

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



295
296
297
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 295

def inspect
    "<Twilio.Bulkexports.V1.ExportCustomJobInstance>"
end

#job_queue_position ⇒ String

Returns This is the job position from the 1st in line. Your queue position will never increase. As jobs ahead of yours in the queue are processed, the queue position number will decrease.

Returns:

  • (String) —

    This is the job position from the 1st in line. Your queue position will never increase. As jobs ahead of yours in the queue are processed, the queue position number will decrease



277
278
279
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 277

def job_queue_position
    @properties['job_queue_position']
end

#job_sid ⇒ String

Returns The unique job_sid returned when the custom export was created.

Returns:

  • (String) —

    The unique job_sid returned when the custom export was created



265
266
267
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 265

def job_sid
    @properties['job_sid']
end

#resource_type ⇒ String

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

Returns:

  • (String) —

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



229
230
231
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 229

def resource_type
    @properties['resource_type']
end

#start_day ⇒ String

Returns The start day for the custom export specified when creating the job.

Returns:

  • (String) —

    The start day for the custom export specified when creating the job



235
236
237
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 235

def start_day
    @properties['start_day']
end

#to_s ⇒ Object

Provide a user friendly representation



289
290
291
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 289

def to_s
    "<Twilio.Bulkexports.V1.ExportCustomJobInstance>"
end

#webhook_method ⇒ String

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

Returns:

  • (String) —

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



253
254
255
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 253

def webhook_method
    @properties['webhook_method']
end

#webhook_url ⇒ String

Returns The optional webhook url called on completion of the job. If this is supplied, ‘WebhookMethod` must also be supplied.

Returns:

  • (String) —

    The optional webhook url called on completion of the job. If this is supplied, ‘WebhookMethod` must also be supplied.



247
248
249
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 247

def webhook_url
    @properties['webhook_url']
end