Class: Twilio::REST::Memory::V1::StoreContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/memory/v1/store.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, store_id) ⇒ StoreContext

Initialize the StoreContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • store_id (String) —

    A unique Memory Store ID using Twilio Type ID (TTID) format



292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/twilio-ruby/rest/memory/v1/store.rb', line 292

def initialize(version, store_id)
    
    apiV1Version = ApiV1Version.new version.domain, version
    super(apiV1Version)

    # Path Solution
    @solution = { store_id: store_id,  }
    @uri = "/ControlPlane/Stores/#{@solution[:store_id]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the StoreInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/twilio-ruby/rest/memory/v1/store.rb', line 306

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
    StoreInstance.new(
      @version,
      response.body,
        store_id: @solution[:store_id],
    )
    
end

#delete_with_metadata ⇒ Boolean

Delete the StoreInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/twilio-ruby/rest/memory/v1/store.rb', line 324

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      store_instance = StoreInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      StoreInstanceMetadata.new(@version, store_instance, response.headers, response.status_code)
end

#fetch ⇒ StoreInstance

Fetch the StoreInstance

Returns:



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/twilio-ruby/rest/memory/v1/store.rb', line 343

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    StoreInstance.new(
        @version,
        payload,
        store_id: @solution[:store_id],
    )
end

#fetch_with_metadata ⇒ StoreInstance

Fetch the StoreInstanceMetadata

Returns:



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/twilio-ruby/rest/memory/v1/store.rb', line 362

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    store_instance = StoreInstance.new(
        @version,
        response.body,
        store_id: @solution[:store_id],
    )
    StoreInstanceMetadata.new(
        @version,
        store_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



448
449
450
451
 
# File 'lib/twilio-ruby/rest/memory/v1/store.rb', line 448

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

#patch(if_match: :unset, patch_store_request: :unset) ⇒ StoreInstance

Patch the StoreInstance

Parameters:

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

    Allows for optimistic concurrency control by making the request conditional. Server will only act if the resource’s current Entity Tag (ETag) matches the one provided, preventing accidental overwrites.

  • patch_store_request (PatchStoreRequest) (defaults to: :unset)

Returns:



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/twilio-ruby/rest/memory/v1/store.rb', line 389

def patch(
  if_match: :unset,
  patch_store_request: :unset
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'If-Match' => if_match, })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    payload = @version.patch('PATCH', @uri, headers: headers, data: patch_store_request.to_json)
    StoreInstance.new(
        @version,
        payload,
        store_id: @solution[:store_id],
    )
end

#patch_with_metadata(if_match: :unset, patch_store_request: :unset) ⇒ StoreInstance

Patch the StoreInstanceMetadata

Parameters:

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

    Allows for optimistic concurrency control by making the request conditional. Server will only act if the resource’s current Entity Tag (ETag) matches the one provided, preventing accidental overwrites.

  • patch_store_request (PatchStoreRequest) (defaults to: :unset)

Returns:



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/twilio-ruby/rest/memory/v1/store.rb', line 413

def patch_with_metadata(
  if_match: :unset,
patch_store_request: :unset
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'If-Match' => if_match, })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    response = @version.patch_with_metadata('PATCH', @uri, headers: headers, data: patch_store_request.to_json)
    store_instance = StoreInstance.new(
        @version,
        response.body,
        store_id: @solution[:store_id],
    )
    StoreInstanceMetadata.new(
        @version,
        store_instance,
        response.headers,
        response.status_code
    )
end

#to_s ⇒ Object

Provide a user friendly representation



441
442
443
444
 
# File 'lib/twilio-ruby/rest/memory/v1/store.rb', line 441

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