Class: Twilio::REST::Numbers::V2::RegulatoryComplianceList::BundleInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the BundleInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • account_sid (String)

    The SID of the Account that created this Bundle resource.

  • sid (String) (defaults to: nil)

    The SID of the Call resource to fetch.



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 414

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'regulation_sid' => payload['regulation_sid'],
        'friendly_name' => payload['friendly_name'],
        'status' => payload['status'],
        'valid_until' => Twilio.deserialize_iso8601_datetime(payload['valid_until']),
        'email' => payload['email'],
        'status_callback' => payload['status_callback'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
        'links' => payload['links'],
    }

    # Context
    @instance_context = nil
    @params = { 'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sidString

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Bundle resource.

Returns:



457
458
459
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 457

def 
    @properties['account_sid']
end

#bundle_copiesbundle_copies

Access the bundle_copies

Returns:



569
570
571
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 569

def bundle_copies
    context.bundle_copies
end

#contextBundleContext

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

Returns:



442
443
444
445
446
447
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 442

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

#date_createdTime

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



499
500
501
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 499

def date_created
    @properties['date_created']
end

#date_updatedTime

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



505
506
507
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 505

def date_updated
    @properties['date_updated']
end

#deleteBoolean

Delete the BundleInstance

Returns:

  • (Boolean)

    True if delete succeeds, false otherwise



524
525
526
527
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 524

def delete

    context.delete
end

#emailString

Returns The email address that will receive updates when the Bundle resource changes status.

Returns:

  • (String)

    The email address that will receive updates when the Bundle resource changes status.



487
488
489
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 487

def email
    @properties['email']
end

#evaluationsevaluations

Access the evaluations

Returns:



583
584
585
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 583

def evaluations
    context.evaluations
end

#fetchBundleInstance

Fetch the BundleInstance

Returns:



532
533
534
535
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 532

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.



469
470
471
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 469

def friendly_name
    @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation



596
597
598
599
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 596

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

#item_assignmentsitem_assignments

Access the item_assignments

Returns:



576
577
578
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 576

def item_assignments
    context.item_assignments
end

Returns The URLs of the Assigned Items of the Bundle resource.

Returns:

  • (Hash)

    The URLs of the Assigned Items of the Bundle resource.



517
518
519
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 517

def links
    @properties['links']
end

#regulation_sidString

Returns The unique string of a regulation that is associated to the Bundle resource.

Returns:

  • (String)

    The unique string of a regulation that is associated to the Bundle resource.



463
464
465
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 463

def regulation_sid
    @properties['regulation_sid']
end

#replace_itemsreplace_items

Access the replace_items

Returns:



562
563
564
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 562

def replace_items
    context.replace_items
end

#sidString

Returns The unique string that we created to identify the Bundle resource.

Returns:

  • (String)

    The unique string that we created to identify the Bundle resource.



451
452
453
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 451

def sid
    @properties['sid']
end

#statusStatus

Returns:

  • (Status)


475
476
477
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 475

def status
    @properties['status']
end

#status_callbackString

Returns The URL we call to inform your application of status changes.

Returns:

  • (String)

    The URL we call to inform your application of status changes.



493
494
495
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 493

def status_callback
    @properties['status_callback']
end

#to_sObject

Provide a user friendly representation



589
590
591
592
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 589

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

#update(status: :unset, status_callback: :unset, friendly_name: :unset, email: :unset) ⇒ BundleInstance

Update the BundleInstance

Parameters:

  • status (Status) (defaults to: :unset)
  • status_callback (String) (defaults to: :unset)

    The URL we call to inform your application of status changes.

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

    The string that you assigned to describe the resource.

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

    The email address that will receive updates when the Bundle resource changes status.

Returns:



544
545
546
547
548
549
550
551
552
553
554
555
556
557
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 544

def update(
    status: :unset, 
    status_callback: :unset, 
    friendly_name: :unset, 
    email: :unset
)

    context.update(
        status: status, 
        status_callback: status_callback, 
        friendly_name: friendly_name, 
        email: email, 
    )
end

#urlString

Returns The absolute URL of the Bundle resource.

Returns:

  • (String)

    The absolute URL of the Bundle resource.



511
512
513
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 511

def url
    @properties['url']
end

#valid_untilTime

Returns The date and time in GMT in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format when the resource will be valid until.

Returns:



481
482
483
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 481

def valid_until
    @properties['valid_until']
end