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 unique string that that we created to identify the Bulk Export job


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

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


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

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


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

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


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

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


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

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


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

def end_day
  @properties['end_day']
end

#fetch ⇒ JobInstance

Fetch the JobInstance

Returns:


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

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


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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


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

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


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

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


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

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


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

def start_day
  @properties['start_day']
end

#to_s ⇒ Object

Provide a user friendly representation


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

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


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

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


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

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


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

def webhook_url
  @properties['webhook_url']
end