class Twilio::REST::Preview::BulkExports::ExportContext::ExportCustomJobInstance
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 help@twilio.com.
Public Class Methods
Initialize the ExportCustomJobInstance
@param [Version] version Version
that contains the resource @param [Hash] payload payload that contains response from Twilio
@param [String] resource_type
The type of communication – Messages, Calls,
Conferences, and Participants
@return [ExportCustomJobInstance] ExportCustomJobInstance
Twilio::REST::InstanceResource::new
# File lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb 188 def initialize(version, payload, resource_type: nil) 189 super(version) 190 191 # Marshaled Properties 192 @properties = { 193 'friendly_name' => payload['friendly_name'], 194 'resource_type' => payload['resource_type'], 195 'start_day' => payload['start_day'], 196 'end_day' => payload['end_day'], 197 'webhook_url' => payload['webhook_url'], 198 'webhook_method' => payload['webhook_method'], 199 'email' => payload['email'], 200 'job_sid' => payload['job_sid'], 201 'details' => payload['details'], 202 } 203 end
Public Instance Methods
@return [Hash] The details
# File lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb 255 def details 256 @properties['details'] 257 end
@return [String] The optional email to send the completion notification to
# File lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb 243 def email 244 @properties['email'] 245 end
@return [String] The end day for the custom export specified as a string in the format of yyyy-MM-dd
# File lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb 225 def end_day 226 @properties['end_day'] 227 end
@return [String] The friendly name specified when creating the job
# File lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb 207 def friendly_name 208 @properties['friendly_name'] 209 end
Provide a detailed, user friendly representation
# File lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb 267 def inspect 268 "<Twilio.Preview.BulkExports.ExportCustomJobInstance>" 269 end
@return [String] The unique job_sid
returned when the custom export was created. This can be used to look up the status of the job.
# File lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb 249 def job_sid 250 @properties['job_sid'] 251 end
@return [String] The type of communication – Messages, Calls, Conferences, and Participants
# File lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb 213 def resource_type 214 @properties['resource_type'] 215 end
@return [String] The start day for the custom export specified as a string in the format of yyyy-MM-dd
# File lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb 219 def start_day 220 @properties['start_day'] 221 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb 261 def to_s 262 "<Twilio.Preview.BulkExports.ExportCustomJobInstance>" 263 end
@return [String] This is the method used to call the webhook
# File lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb 237 def webhook_method 238 @properties['webhook_method'] 239 end
@return [String] The optional webhook url called on completion
# File lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb 231 def webhook_url 232 @properties['webhook_url'] 233 end