Class: Twilio::REST::Sync::V1::ServiceContext::SyncMapContext

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Defined Under Namespace

Classes: SyncMapItemContext, SyncMapItemInstance, SyncMapItemList, SyncMapItemPage, SyncMapPermissionContext, SyncMapPermissionInstance, SyncMapPermissionList, SyncMapPermissionPage

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ SyncMapContext

Initialize the SyncMapContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The service_sid

  • sid (String) —

    The sid



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

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

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

  # Dependents
  @sync_map_items = nil
  @sync_map_permissions = nil
end

Instance Method Details

#delete ⇒ Boolean

Deletes the SyncMapInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



231
232
233
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 231

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

#fetch ⇒ SyncMapInstance

Fetch a SyncMapInstance

Returns:



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

def fetch
  params = Twilio::Values.of({})

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

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

#sync_map_items(key = :unset) ⇒ SyncMapItemList, SyncMapItemContext

Access the sync_map_items

Returns:

Raises:

  • (ArgumentError) 


239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 239

def sync_map_items(key=:unset)
  raise ArgumentError, 'key cannot be nil' if key.nil?

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

  unless @sync_map_items
    @sync_map_items = SyncMapItemList.new(
        @version,
        service_sid: @solution[:service_sid],
        map_sid: @solution[:sid],
    )
  end

  @sync_map_items
end

#sync_map_permissions(identity = :unset) ⇒ SyncMapPermissionList, SyncMapPermissionContext

Access the sync_map_permissions

Returns:

Raises:

  • (ArgumentError) 


266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 266

def sync_map_permissions(identity=:unset)
  raise ArgumentError, 'identity cannot be nil' if identity.nil?

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

  unless @sync_map_permissions
    @sync_map_permissions = SyncMapPermissionList.new(
        @version,
        service_sid: @solution[:service_sid],
        map_sid: @solution[:sid],
    )
  end

  @sync_map_permissions
end

#to_s ⇒ Object

Provide a user friendly representation



291
292
293
294
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 291

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