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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

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

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

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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# 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'],
  }
end

Instance Method Details

#details ⇒ Hash

Returns 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.

Returns:

  • (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



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

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



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

def email
  @properties['email']
end

#end_day ⇒ String

Returns The end day for the custom export specified as a string in the format of yyyy-MM-dd. This will be the last day exported. For instance, to export a single day, choose the same day for start and end day. To export the first 4 days of July, you would set the start date to 2020-07-01 and the end date to 2020-07-04. The end date must be the UTC day before yesterday.

Returns:

  • (String) —

    The end day for the custom export specified as a string in the format of yyyy-MM-dd. This will be the last day exported. For instance, to export a single day, choose the same day for start and end day. To export the first 4 days of July, you would set the start date to 2020-07-01 and the end date to 2020-07-04. The end date must be the UTC day before yesterday.



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

def end_day
  @properties['end_day']
end

#friendly_name ⇒ String

Returns The friendly name specified when creating the job.

Returns:

  • (String) —

    The friendly name specified when creating the job



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#job_sid ⇒ String

Returns The unique job_sid returned when the custom export was created. This can be used to look up the status of the job.

Returns:

  • (String) —

    The unique job_sid returned when the custom export was created. This can be used to look up the status of the job.



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

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



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

def resource_type
  @properties['resource_type']
end

#start_day ⇒ String

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

Returns:

  • (String) —

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



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

def start_day
  @properties['start_day']
end

#to_s ⇒ Object

Provide a user friendly representation



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

def to_s
  "<Twilio.Bulkexports.V1.ExportCustomJobInstance>"
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



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

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



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

def webhook_url
  @properties['webhook_url']
end