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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, map_sid, key) ⇒ SyncMapItemContext

Initialize the SyncMapItemContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String)
  • map_sid (String)
  • key (String) 


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

def initialize(version, service_sid, map_sid, key)
    super(version)

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

    
end

Instance Method Details

#delete(if_match: :unset) ⇒ Boolean

Delete the SyncMapItemInstance

Parameters:

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

    The If-Match HTTP request header

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete(
    if_match: :unset
)

    headers = Twilio::Values.of({ 'If-Match' => if_match, })
    @version.delete('DELETE', @uri, headers: headers)
end

#fetch ⇒ SyncMapItemInstance

Fetch the SyncMapItemInstance

Returns:



205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb', line 205

def fetch

    payload = @version.fetch('GET', @uri)
    SyncMapItemInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        map_sid: @solution[:map_sid],
        key: @solution[:key],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



252
253
254
255
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb', line 252

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

#to_s ⇒ Object

Provide a user friendly representation



245
246
247
248
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb', line 245

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

#update(data: nil, if_match: :unset) ⇒ SyncMapItemInstance

Update the SyncMapItemInstance

Parameters:

  • data (Object) (defaults to: nil)
  • if_match (String) (defaults to: :unset) —

    The If-Match HTTP request header

Returns:



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

def update(
    data: nil, 
    if_match: :unset
)

    data = Twilio::Values.of({
        'Data' => Twilio.serialize_object(data),
    })

    headers = Twilio::Values.of({ 'If-Match' => if_match, })
    payload = @version.update('POST', @uri, data: data, headers: headers)
    SyncMapItemInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        map_sid: @solution[:map_sid],
        key: @solution[:key],
    )
end