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) —

    A 34 character string that uniquely identifies this fax.



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 333

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_sid ⇒ String

Returns Account SID.

Returns:

  • (String) —

    Account SID



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

def 
  @properties['account_sid']
end

#api_version ⇒ String

Returns The API version used.

Returns:

  • (String) —

    The API version used



442
443
444
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 442

def api_version
  @properties['api_version']
end

#context ⇒ FaxContext

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



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

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

#date_created ⇒ Time

Returns The date this fax was created.

Returns:

  • (Time) —

    The date this fax was created



460
461
462
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 460

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this fax was updated.

Returns:

  • (Time) —

    The date this fax was updated



466
467
468
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 466

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the FaxInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



502
503
504
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 502

def delete
  context.delete
end

#direction ⇒ fax.Direction

Returns The direction of this fax.

Returns:

  • (fax.Direction) —

    The direction of this fax



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

def direction
  @properties['direction']
end

#duration ⇒ String

Returns The time taken to transmit the fax.

Returns:

  • (String) —

    The time taken to transmit the fax



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

def duration
  @properties['duration']
end

#fetch ⇒ FaxInstance

Fetch a FaxInstance

Returns:



485
486
487
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 485

def fetch
  context.fetch
end

#from ⇒ String

Returns The party that sent the fax.

Returns:

  • (String) —

    The party that sent the fax



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

def from
  @properties['from']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



522
523
524
525
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 522

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

#links ⇒ String

Returns Nested resource URLs.

Returns:

  • (String) —

    Nested resource URLs



472
473
474
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 472

def links
  @properties['links']
end

#media ⇒ media

Access the media

Returns:



509
510
511
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 509

def media
  context.media
end

#media_sid ⇒ String

Returns Media SID.

Returns:

  • (String) —

    Media SID



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

def media_sid
  @properties['media_sid']
end

#media_url ⇒ String

Returns URL pointing to fax media.

Returns:

  • (String) —

    URL pointing to fax media



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

def media_url
  @properties['media_url']
end

#num_pages ⇒ String

Returns Number of pages.

Returns:

  • (String) —

    Number of pages



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

def num_pages
  @properties['num_pages']
end

#price ⇒ String

Returns Fax transmission price.

Returns:

  • (String) —

    Fax transmission price



448
449
450
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 448

def price
  @properties['price']
end

#price_unit ⇒ String

Returns Currency used for billing.

Returns:

  • (String) —

    Currency used for billing



454
455
456
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 454

def price_unit
  @properties['price_unit']
end

#quality ⇒ fax.Quality

Returns The quality of this fax.

Returns:

  • (fax.Quality) —

    The quality of this fax



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

def quality
  @properties['quality']
end

#sid ⇒ String

Returns A string that uniquely identifies this fax.

Returns:

  • (String) —

    A string that uniquely identifies this fax.



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

def sid
  @properties['sid']
end

#status ⇒ fax.Status

Returns The status of this fax.

Returns:

  • (fax.Status) —

    The status of this fax



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

def status
  @properties['status']
end

#to ⇒ String

Returns The party that received the fax.

Returns:

  • (String) —

    The party that received the fax



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

def to
  @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



515
516
517
518
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 515

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

#update(status: :unset) ⇒ FaxInstance

Update the FaxInstance

Parameters:

  • status (fax.UpdateStatus) (defaults to: :unset) —

    The updated status of this fax. The only valid option is ‘canceled`. This may fail if the status has already started transmission.

Returns:



495
496
497
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 495

def update(status: :unset)
  context.update(status: status, )
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource



478
479
480
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 478

def url
  @properties['url']
end