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)

    The service_sid

  • sid (String)

    The sid


169
170
171
172
173
174
175
176
177
178
179
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 169

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_items = nil
  @sync_list_permissions = nil
end

Instance Method Details

#deleteBoolean

Delete the SyncListInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


193
194
195
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 193

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

#fetchSyncListInstance

Fetch the SyncListInstance

Returns:


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

def fetch
  payload = @version.fetch('GET', @uri)

  SyncListInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
end

#inspectObject

Provide a detailed, user friendly representation


250
251
252
253
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 250

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)

201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 201

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)

223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 223

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_sObject

Provide a user friendly representation


243
244
245
246
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list.rb', line 243

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