Class: Twilio::REST::Trusthub::V1::SupportingDocumentInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ SupportingDocumentInstance

Initialize the SupportingDocumentInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • sid (String) (defaults to: nil)

    The unique string created by Twilio to identify the Supporting Document resource.


234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 234

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

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'friendly_name' => payload['friendly_name'],
      'mime_type' => payload['mime_type'],
      'status' => payload['status'],
      'type' => payload['type'],
      'attributes' => payload['attributes'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      '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


275
276
277
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 275

def 
  @properties['account_sid']
end

#attributesHash

Returns The set of parameters that compose the Supporting Documents resource.

Returns:

  • (Hash)

    The set of parameters that compose the Supporting Documents resource


305
306
307
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 305

def attributes
  @properties['attributes']
end

#contextSupportingDocumentContext

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

Returns:


260
261
262
263
264
265
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 260

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

#date_createdTime

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

Returns:

  • (Time)

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


311
312
313
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 311

def date_created
  @properties['date_created']
end

#date_updatedTime

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

Returns:

  • (Time)

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


317
318
319
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 317

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the SupportingDocumentInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


348
349
350
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 348

def delete
  context.delete
end

#fetchSupportingDocumentInstance

Fetch the SupportingDocumentInstance

Returns:


330
331
332
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 330

def fetch
  context.fetch
end

#friendly_nameString

Returns The string that you assigned to describe the resource.

Returns:

  • (String)

    The string that you assigned to describe the resource


281
282
283
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 281

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


361
362
363
364
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 361

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

#mime_typeString

Returns The image type of the file.

Returns:

  • (String)

    The image type of the file


287
288
289
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 287

def mime_type
  @properties['mime_type']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


269
270
271
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 269

def sid
  @properties['sid']
end

#statussupporting_document.Status

Returns The verification status of the Supporting Document resource.

Returns:

  • (supporting_document.Status)

    The verification status of the Supporting Document resource


293
294
295
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 293

def status
  @properties['status']
end

#to_sObject

Provide a user friendly representation


354
355
356
357
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 354

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

#typeString

Returns The type of the Supporting Document.

Returns:

  • (String)

    The type of the Supporting Document


299
300
301
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 299

def type
  @properties['type']
end

#update(friendly_name: :unset, attributes: :unset) ⇒ SupportingDocumentInstance

Update the SupportingDocumentInstance

Parameters:

  • friendly_name (String) (defaults to: :unset)

    The string that you assigned to describe the resource.

  • attributes (Hash) (defaults to: :unset)

    The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types.

Returns:


341
342
343
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 341

def update(friendly_name: :unset, attributes: :unset)
  context.update(friendly_name: friendly_name, attributes: attributes, )
end

#urlString

Returns The absolute URL of the Supporting Document resource.

Returns:

  • (String)

    The absolute URL of the Supporting Document resource


323
324
325
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 323

def url
  @properties['url']
end