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



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
362
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 334

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 



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

def 
  @properties['account_sid']
end

#api_version ⇒ String 



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

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



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

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

#date_created ⇒ Time 



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the FaxInstance



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

def delete
  context.delete
end

#direction ⇒ fax.Direction 



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

def direction
  @properties['direction']
end

#duration ⇒ String 



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

def duration
  @properties['duration']
end

#fetch ⇒ FaxInstance

Fetch a FaxInstance



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

def fetch
  context.fetch
end

#from ⇒ String 



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

def from
  @properties['from']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String 



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

def links
  @properties['links']
end

#media ⇒ media

Access the media



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

def media
  context.media
end

#media_sid ⇒ String 



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

def media_sid
  @properties['media_sid']
end

#media_url ⇒ String 



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

def media_url
  @properties['media_url']
end

#num_pages ⇒ String 



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

def num_pages
  @properties['num_pages']
end

#price ⇒ String 



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

def price
  @properties['price']
end

#price_unit ⇒ String 



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

def price_unit
  @properties['price_unit']
end

#quality ⇒ fax.Quality 



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

def quality
  @properties['quality']
end

#sid ⇒ String 



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

def sid
  @properties['sid']
end

#status ⇒ fax.Status 



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

def status
  @properties['status']
end

#to ⇒ String 



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

def to
  @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#update(status: :unset) ⇒ FaxInstance

Update the FaxInstance



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

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

#url ⇒ String 



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

def url
  @properties['url']
end