Class: Twilio::REST::Preview::Sync::ServiceContext::SyncListContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/sync/service/sync_list.rb,
lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb,
lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_permission.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Defined Under Namespace

Classes: SyncListItemContext, SyncListItemInstance, SyncListItemList, SyncListItemPage, SyncListPermissionContext, SyncListPermissionInstance, SyncListPermissionList, SyncListPermissionPage

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ SyncListContext

Initialize the SyncListContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String)
  • sid (String) 


157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 157

def initialize(version, service_sid, sid)
    super(version)

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

    # Dependents
    @sync_list_permissions = nil
    @sync_list_items = nil
end

Instance Method Details

#delete ⇒ Boolean

Delete the SyncListInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



171
172
173
174
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 171

def delete

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

#fetch ⇒ SyncListInstance

Fetch the SyncListInstance

Returns:



179
180
181
182
183
184
185
186
187
188
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 179

def fetch

    payload = @version.fetch('GET', @uri)
    SyncListInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



238
239
240
241
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 238

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Preview.Sync.SyncListContext #{context}>"
end

#sync_list_items(index = :unset) ⇒ SyncListItemList, SyncListItemContext

Access the sync_list_items

Returns:

Raises:

  • (ArgumentError) 


213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 213

def sync_list_items(index=:unset)

    raise ArgumentError, 'index cannot be nil' if index.nil?

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

    unless @sync_list_items
        @sync_list_items = SyncListItemList.new(
            @version, service_sid: @solution[:service_sid], list_sid: @solution[:sid], )
    end

 @sync_list_items
end

#sync_list_permissions(identity = :unset) ⇒ SyncListPermissionList, SyncListPermissionContext

Access the sync_list_permissions

Returns:

Raises:

  • (ArgumentError) 


194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 194

def sync_list_permissions(identity=:unset)

    raise ArgumentError, 'identity cannot be nil' if identity.nil?

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

    unless @sync_list_permissions
        @sync_list_permissions = SyncListPermissionList.new(
            @version, service_sid: @solution[:service_sid], list_sid: @solution[:sid], )
    end

 @sync_list_permissions
end

#to_s ⇒ Object

Provide a user friendly representation



231
232
233
234
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 231

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Preview.Sync.SyncListContext #{context}>"
end