Class: Twilio::REST::Bulkexports::V1::ExportList::JobInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Bulkexports::V1::ExportList::JobInstance

Defined in:

lib/twilio-ruby/rest/bulkexports/v1/export/job.rb

Instance Method Summary

• #context ⇒ JobContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #delete ⇒ Boolean

  Delete the JobInstance.

• #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 time for the export specified when creating the job.

• #estimated_completion_time ⇒ String

  This is the time estimated until your job is complete.

• #fetch ⇒ JobInstance

  Fetch the JobInstance.

• #friendly_name ⇒ String

  The friendly name specified when creating the job.

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

  Initialize the JobInstance.

• #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 job_sid returned when the export was created.

• #resource_type ⇒ String

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

• #start_day ⇒ String

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

• #to_s ⇒ Object

  Provide a user friendly representation.

• #url ⇒ String

  The url.

• #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, job_sid: nil) ⇒ JobInstance

Initialize the JobInstance

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

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'],
      'job_queue_position' => payload['job_queue_position'],
      'estimated_completion_time' => payload['estimated_completion_time'],
  }

  # 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

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

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

#delete ⇒ Boolean

Delete the JobInstance

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

def delete
  context.delete
end

#details ⇒ Hash

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

def details
  @properties['details']
end

#email ⇒ String

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

def email
  @properties['email']
end

#end_day ⇒ String

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

def end_day
  @properties['end_day']
end

#estimated_completion_time ⇒ String

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

def estimated_completion_time
  @properties['estimated_completion_time']
end

#fetch ⇒ JobInstance

Fetch the JobInstance

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

def fetch
  context.fetch
end

#friendly_name ⇒ String

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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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

#job_queue_position ⇒ String

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

def job_queue_position
  @properties['job_queue_position']
end

#job_sid ⇒ String

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

def job_sid
  @properties['job_sid']
end

#resource_type ⇒ String

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

def resource_type
  @properties['resource_type']
end

#start_day ⇒ String

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

def start_day
  @properties['start_day']
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

#url ⇒ String

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

def url
  @properties['url']
end

#webhook_method ⇒ String

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

def webhook_method
  @properties['webhook_method']
end

#webhook_url ⇒ String

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

def webhook_url
  @properties['webhook_url']
end