Class: Twilio::REST::Preview::Sync::ServiceContext::SyncMapContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/sync/service/sync_map.rb,
lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb,
lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_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: 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



176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map.rb', line 176

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



206
207
208
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map.rb', line 206

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

#fetch ⇒ SyncMapInstance

Fetch a SyncMapInstance

Returns:



191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map.rb', line 191

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



263
264
265
266
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map.rb', line 263

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

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

Access the sync_map_items

Returns:

Raises:

  • (ArgumentError) 


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

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) 


236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map.rb', line 236

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



256
257
258
259
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map.rb', line 256

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