Class: Twilio::REST::Sync::V1::ServiceContext::SyncMapInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/sync/v1/service/sync_map.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, sid: nil) ⇒ SyncMapInstance

Initialize the SyncMapInstance

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 SyncMap resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 588

def initialize(version, payload , service_sid: nil, sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'unique_name' => payload['unique_name'],
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'url' => payload['url'],
        'links' => payload['links'],
        'revision' => payload['revision'],
        'date_expires' => Twilio.deserialize_iso8601_datetime(payload['date_expires']),
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'created_by' => payload['created_by'],
    }

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

Instance Method Details

#account_sid ⇒ String

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

Returns:



637
638
639
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 637

def 
    @properties['account_sid']
end

#context ⇒ SyncMapContext

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

Returns:



616
617
618
619
620
621
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 616

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

#created_by ⇒ String

Returns The identity of the Sync Map’s creator. If the Sync Map is created from the client SDK, the value matches the Access Token’s identity field. If the Sync Map was created from the REST API, the value is system.

Returns:

  • (String) —

    The identity of the Sync Map’s creator. If the Sync Map is created from the client SDK, the value matches the Access Token’s identity field. If the Sync Map was created from the REST API, the value is system.



685
686
687
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 685

def created_by
    @properties['created_by']
end

#date_created ⇒ Time

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

Returns:



673
674
675
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 673

def date_created
    @properties['date_created']
end

#date_expires ⇒ Time

Returns The date and time in GMT when the Sync Map expires and will be deleted, specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format. If the Sync Map does not expire, this value is null. The Sync Map might not be deleted immediately after it expires.

Returns:

  • (Time) —

    The date and time in GMT when the Sync Map expires and will be deleted, specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format. If the Sync Map does not expire, this value is null. The Sync Map might not be deleted immediately after it expires.



667
668
669
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 667

def date_expires
    @properties['date_expires']
end

#date_updated ⇒ Time

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:



679
680
681
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 679

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SyncMapInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



692
693
694
695
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 692

def delete

    context.delete
end

#fetch ⇒ SyncMapInstance

Fetch the SyncMapInstance

Returns:



700
701
702
703
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 700

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



744
745
746
747
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 744

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

#links ⇒ Hash

Returns The URLs of the Sync Map’s nested resources.

Returns:

  • (Hash) —

    The URLs of the Sync Map’s nested resources.



655
656
657
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 655

def links
    @properties['links']
end

#revision ⇒ String

Returns The current revision of the Sync Map, represented as a string.

Returns:

  • (String) —

    The current revision of the Sync Map, represented as a string.



661
662
663
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 661

def revision
    @properties['revision']
end

#service_sid ⇒ String

Returns The SID of the [Sync Service](www.twilio.com/docs/sync/api/service) the resource is associated with.

Returns:



643
644
645
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 643

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

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

Returns:

  • (String) —

    The unique string that we created to identify the Sync Map resource.



625
626
627
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 625

def sid
    @properties['sid']
end

#sync_map_items ⇒ sync_map_items

Access the sync_map_items

Returns:



724
725
726
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 724

def sync_map_items
    context.sync_map_items
end

#sync_map_permissions ⇒ sync_map_permissions

Access the sync_map_permissions

Returns:



731
732
733
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 731

def sync_map_permissions
    context.sync_map_permissions
end

#to_s ⇒ Object

Provide a user friendly representation



737
738
739
740
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 737

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

#unique_name ⇒ String

Returns An application-defined string that uniquely identifies the resource. It can be used in place of the resource’s sid in the URL to address the resource.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource. It can be used in place of the resource’s sid in the URL to address the resource.



631
632
633
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 631

def unique_name
    @properties['unique_name']
end

#update(ttl: :unset, collection_ttl: :unset) ⇒ SyncMapInstance

Update the SyncMapInstance

Parameters:

  • ttl (String) (defaults to: :unset) —

    An alias for collection_ttl. If both parameters are provided, this value is ignored.

  • collection_ttl (String) (defaults to: :unset) —

    How long, [in seconds](www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Map expires (time-to-live) and is deleted.

Returns:



710
711
712
713
714
715
716
717
718
719
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 710

def update(
    ttl: :unset, 
    collection_ttl: :unset
)

    context.update(
        ttl: ttl, 
        collection_ttl: collection_ttl, 
    )
end

#url ⇒ String

Returns The absolute URL of the Sync Map resource.

Returns:

  • (String) —

    The absolute URL of the Sync Map resource.



649
650
651
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 649

def url
    @properties['url']
end