Class: Twilio::REST::Numbers::V2::RegulatoryComplianceList::SupportingDocumentInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/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.


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

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


276
277
278
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 276

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


306
307
308
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 306

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:


261
262
263
264
265
266
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 261

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


312
313
314
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 312

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


318
319
320
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 318

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the SupportingDocumentInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


349
350
351
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 349

def delete
  context.delete
end

#fetchSupportingDocumentInstance

Fetch the SupportingDocumentInstance

Returns:


331
332
333
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 331

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


282
283
284
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 282

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


362
363
364
365
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 362

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

#mime_typeString

Returns The image type of the file.

Returns:

  • (String)

    The image type of the file


288
289
290
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 288

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


270
271
272
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 270

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


294
295
296
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 294

def status
  @properties['status']
end

#to_sObject

Provide a user friendly representation


355
356
357
358
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 355

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

#typeString

Returns The type of the Supporting Document.

Returns:

  • (String)

    The type of the Supporting Document


300
301
302
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 300

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:


342
343
344
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 342

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


324
325
326
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 324

def url
  @properties['url']
end