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

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Bulkexports::V1::ExportContext::ExportCustomJobInstance

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

• #details ⇒ Hash

  The details of a job state which is an object that contains a status string, a day count integer, and list of days in the job.

• #email ⇒ String

  The optional email to send the completion notification to.

• #end_day ⇒ String

  The end day for the custom export specified as a string in the format of yyyy-MM-dd.

• #estimated_completion_time ⇒ String

  This is the time estimated until your job is complete.

• #friendly_name ⇒ String

  The friendly name specified when creating the job.

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

  Initialize the ExportCustomJobInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #job_queue_position ⇒ String

  This is the job position from the 1st in line.

• #job_sid ⇒ String

  The unique job_sid returned when the custom export was created.

• #resource_type ⇒ String

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

• #start_day ⇒ String

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

• #to_s ⇒ Object

  Provide a user friendly representation.

• #webhook_method ⇒ String

  This is the method used to call the webhook.

• #webhook_url ⇒ String

  The optional webhook url called on completion.

Constructor Details

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

Initialize the ExportCustomJobInstance

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

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

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

def details
  @properties['details']
end

#email ⇒ String

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

def email
  @properties['email']
end

#end_day ⇒ String

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

def end_day
  @properties['end_day']
end

#estimated_completion_time ⇒ String

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

def estimated_completion_time
  @properties['estimated_completion_time']
end

#friendly_name ⇒ String

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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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

#job_queue_position ⇒ String

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

def job_queue_position
  @properties['job_queue_position']
end

#job_sid ⇒ String

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

def job_sid
  @properties['job_sid']
end

#resource_type ⇒ String

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

def resource_type
  @properties['resource_type']
end

#start_day ⇒ String

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

def start_day
  @properties['start_day']
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

#webhook_method ⇒ String

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

def webhook_method
  @properties['webhook_method']
end

#webhook_url ⇒ String

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

def webhook_url
  @properties['webhook_url']
end