Class: Twilio::REST::Fax::V1::FaxContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/fax/v1/fax.rb,
lib/twilio-ruby/rest/fax/v1/fax/fax_media.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Defined Under Namespace

Classes: FaxMediaContext, FaxMediaInstance, FaxMediaList, FaxMediaPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ FaxContext

Initialize the FaxContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    A 34 character string that uniquely identifies this fax.



247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 247

def initialize(version, sid)
  super(version)

  # Path Solution
  @solution = {
      sid: sid,
  }
  @uri = "/Faxes/#{@solution[:sid]}"

  # Dependents
  @media = nil
end

Instance Method Details

#delete ⇒ Boolean

Deletes the FaxInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  @version.delete('delete', @uri)
end

#fetch ⇒ FaxInstance

Fetch a FaxInstance

Returns:



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 263

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  FaxInstance.new(
      @version,
      payload,
      sid: @solution[:sid],
  )
end

#media(sid = :unset) ⇒ FaxMediaList, FaxMediaContext

Access the media

Returns:

Raises:

  • (ArgumentError) 


314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 314

def media(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return FaxMediaContext.new(
        @version,
        @solution[:sid],
        sid,
    )
  end

  unless @media
    @media = FaxMediaList.new(
        @version,
        fax_sid: @solution[:sid],
    )
  end

  @media
end

#to_s ⇒ Object

Provide a user friendly representation



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

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Fax.V1.FaxContext #{context}>"
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:



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/twilio-ruby/rest/fax/v1/fax.rb', line 285

def update(status: :unset)
  data = Twilio::Values.of({
      'Status' => status,
  })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  FaxInstance.new(
      @version,
      payload,
      sid: @solution[:sid],
  )
end