Class: Twilio::REST::Accounts::V1::CredentialList::PublicKeyContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ PublicKeyContext

Initialize the PublicKeyContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The Twilio-provided string that uniquely identifies the PublicKey resource to update.



237
238
239
240
241
242
243
244
245
246
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 237

def initialize(version, sid)
    super(version)
    

    # Path Solution
    @solution = { sid: sid,  }
    @uri = "/Credentials/PublicKeys/#{@solution[:sid]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the PublicKeyInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



250
251
252
253
254
255
256
257
258
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 250

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

    @version.delete('DELETE', @uri, headers: headers)
end

#delete_with_metadata ⇒ Boolean

Delete the PublicKeyInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 263

def delete_with_metadata

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

#fetch ⇒ PublicKeyInstance

Fetch the PublicKeyInstance

Returns:



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 282

def fetch

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

#fetch_with_metadata ⇒ PublicKeyInstance

Fetch the PublicKeyInstanceMetadata

Returns:



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 301

def fetch_with_metadata

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



391
392
393
394
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 391

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

#to_s ⇒ Object

Provide a user friendly representation



384
385
386
387
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 384

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

#update(friendly_name: :unset) ⇒ PublicKeyInstance

Update the PublicKeyInstance

Parameters:

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

    A descriptive string that you create to describe the resource. It can be up to 64 characters long.

Returns:



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 327

def update(
  friendly_name: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    PublicKeyInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#update_with_metadata(friendly_name: :unset) ⇒ PublicKeyInstance

Update the PublicKeyInstanceMetadata

Parameters:

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

    A descriptive string that you create to describe the resource. It can be up to 64 characters long.

Returns:



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 353

def update_with_metadata(
  friendly_name: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    public_key_instance = PublicKeyInstance.new(
        @version,
        response.body,
        sid: @solution[:sid],
    )
    PublicKeyInstanceMetadata.new(
        @version,
        public_key_instance,
        response.headers,
        response.status_code
    )
end