Class: Twilio::REST::Fax::V1::FaxInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/fax/v1/fax.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, sid: nil) ⇒ FaxInstance

Initialize the FaxInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • sid (String) (defaults to: nil)

    The Twilio-provided string that uniquely identifies the Fax resource to fetch.


272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 272

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'from' => payload['from'],
      'to' => payload['to'],
      'quality' => payload['quality'],
      'media_sid' => payload['media_sid'],
      'media_url' => payload['media_url'],
      'num_pages' => payload['num_pages'] == nil ? payload['num_pages'] : payload['num_pages'].to_i,
      'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
      'status' => payload['status'],
      'direction' => payload['direction'],
      'api_version' => payload['api_version'],
      'price' => payload['price'].to_f,
      'price_unit' => payload['price_unit'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'links' => payload['links'],
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


321
322
323
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 321

def 
  @properties['account_sid']
end

#api_versionString

Returns The API version used to transmit the fax.

Returns:

  • (String)

    The API version used to transmit the fax


381
382
383
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 381

def api_version
  @properties['api_version']
end

#contextFaxContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:

  • (FaxContext)

    FaxContext for this FaxInstance


306
307
308
309
310
311
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 306

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

#date_createdTime

Returns The ISO 8601 formatted date and time in GMT when the resource was created.

Returns:

  • (Time)

    The ISO 8601 formatted date and time in GMT when the resource was created


399
400
401
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 399

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The ISO 8601 formatted date and time in GMT when the resource was last updated.

Returns:

  • (Time)

    The ISO 8601 formatted date and time in GMT when the resource was last updated


405
406
407
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 405

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the FaxInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


431
432
433
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 431

def delete
  context.delete
end

#directionfax.Direction

Returns The direction of the fax.

Returns:

  • (fax.Direction)

    The direction of the fax


375
376
377
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 375

def direction
  @properties['direction']
end

#durationString

Returns The time it took to transmit the fax.

Returns:

  • (String)

    The time it took to transmit the fax


363
364
365
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 363

def duration
  @properties['duration']
end

#fetchFaxInstance

Fetch the FaxInstance

Returns:


424
425
426
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 424

def fetch
  context.fetch
end

#fromString

Returns The number the fax was sent from.

Returns:

  • (String)

    The number the fax was sent from


327
328
329
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 327

def from
  @properties['from']
end

#inspectObject

Provide a detailed, user friendly representation


451
452
453
454
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 451

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

Returns The URLs of the fax's related resources.

Returns:

  • (String)

    The URLs of the fax's related resources


411
412
413
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 411

def links
  @properties['links']
end

#mediamedia

Access the media

Returns:


438
439
440
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 438

def media
  context.media
end

#media_sidString

Returns The SID of the FaxMedia resource that is associated with the Fax.

Returns:

  • (String)

    The SID of the FaxMedia resource that is associated with the Fax


345
346
347
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 345

def media_sid
  @properties['media_sid']
end

#media_urlString

Returns The Twilio-hosted URL that can be used to download fax media.

Returns:

  • (String)

    The Twilio-hosted URL that can be used to download fax media


351
352
353
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 351

def media_url
  @properties['media_url']
end

#num_pagesString

Returns The number of pages contained in the fax document.

Returns:

  • (String)

    The number of pages contained in the fax document


357
358
359
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 357

def num_pages
  @properties['num_pages']
end

#priceString

Returns The fax transmission price.

Returns:

  • (String)

    The fax transmission price


387
388
389
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 387

def price
  @properties['price']
end

#price_unitString

Returns The ISO 4217 currency used for billing.

Returns:

  • (String)

    The ISO 4217 currency used for billing


393
394
395
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 393

def price_unit
  @properties['price_unit']
end

#qualityfax.Quality

Returns The quality of the fax.

Returns:

  • (fax.Quality)

    The quality of the fax


339
340
341
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 339

def quality
  @properties['quality']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


315
316
317
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 315

def sid
  @properties['sid']
end

#statusfax.Status

Returns The status of the fax.

Returns:

  • (fax.Status)

    The status of the fax


369
370
371
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 369

def status
  @properties['status']
end

#toString

Returns The phone number that received the fax.

Returns:

  • (String)

    The phone number that received the fax


333
334
335
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 333

def to
  @properties['to']
end

#to_sObject

Provide a user friendly representation


444
445
446
447
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 444

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

#urlString

Returns The absolute URL of the fax resource.

Returns:

  • (String)

    The absolute URL of the fax resource


417
418
419
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 417

def url
  @properties['url']
end