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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 338

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 



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

def 
  @properties['account_sid']
end

#api_version ⇒ String 



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

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



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

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

#date_created ⇒ Time 



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the FaxInstance



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

def delete
  context.delete
end

#direction ⇒ fax.Direction 



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

def direction
  @properties['direction']
end

#duration ⇒ String 



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

def duration
  @properties['duration']
end

#fetch ⇒ FaxInstance

Fetch the FaxInstance



490
491
492
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 490

def fetch
  context.fetch
end

#from ⇒ String 



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

def from
  @properties['from']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



528
529
530
531
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 528

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

#links ⇒ String 



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

def links
  @properties['links']
end

#media ⇒ media

Access the media



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

def media
  context.media
end

#media_sid ⇒ String 



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

def media_sid
  @properties['media_sid']
end

#media_url ⇒ String 



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

def media_url
  @properties['media_url']
end

#num_pages ⇒ String 



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

def num_pages
  @properties['num_pages']
end

#price ⇒ String 



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

def price
  @properties['price']
end

#price_unit ⇒ String 



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

def price_unit
  @properties['price_unit']
end

#quality ⇒ fax.Quality 



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

def quality
  @properties['quality']
end

#sid ⇒ String 



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

def sid
  @properties['sid']
end

#status ⇒ fax.Status 



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

def status
  @properties['status']
end

#to ⇒ String 



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

def to
  @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#update(status: :unset) ⇒ FaxInstance

Update the FaxInstance



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

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

#url ⇒ String 



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

def url
  @properties['url']
end