Class: Twilio::REST::Notify::V1::ServiceContext::UserContext::UserBindingInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb

Overview

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, identity: nil, sid: nil) ⇒ UserBindingInstance

Initialize the UserBindingInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • service_sid (String) (defaults to: nil)

    The service_sid

  • identity (String) (defaults to: nil)

    The identity

  • sid (String) (defaults to: nil)

    The sid



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 286

def initialize(version, payload, service_sid: nil, identity: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'service_sid' => payload['service_sid'],
      'credential_sid' => payload['credential_sid'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'notification_protocol_version' => payload['notification_protocol_version'],
      'endpoint' => payload['endpoint'],
      'identity' => payload['identity'],
      'binding_type' => payload['binding_type'],
      'address' => payload['address'],
      'tags' => payload['tags'],
      'url' => payload['url'],
      'links' => payload['links'],
  }

  # Context
  @instance_context = nil
  @params = {
      'service_sid' => service_sid,
      'identity' => identity,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sidString

Returns The account_sid.

Returns:

  • (String)

    The account_sid



340
341
342
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 340

def 
  @properties['account_sid']
end

#addressString

Returns The address.

Returns:

  • (String)

    The address



394
395
396
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 394

def address
  @properties['address']
end

#binding_typeString

Returns The binding_type.

Returns:

  • (String)

    The binding_type



388
389
390
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 388

def binding_type
  @properties['binding_type']
end

#contextUserBindingContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



320
321
322
323
324
325
326
327
328
329
330
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 320

def context
  unless @instance_context
    @instance_context = UserBindingContext.new(
        @version,
        @params['service_sid'],
        @params['identity'],
        @params['sid'],
    )
  end
  @instance_context
end

#credential_sidString

Returns The credential_sid.

Returns:

  • (String)

    The credential_sid



352
353
354
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 352

def credential_sid
  @properties['credential_sid']
end

#date_createdTime

Returns The date_created.

Returns:

  • (Time)

    The date_created



358
359
360
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 358

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The date_updated.

Returns:

  • (Time)

    The date_updated



364
365
366
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 364

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Deletes the UserBindingInstance

Returns:

  • (Boolean)

    true if delete succeeds, true otherwise



426
427
428
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 426

def delete
  context.delete
end

#endpointString

Returns The endpoint.

Returns:

  • (String)

    The endpoint



376
377
378
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 376

def endpoint
  @properties['endpoint']
end

#fetchUserBindingInstance

Fetch a UserBindingInstance

Returns:



419
420
421
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 419

def fetch
  context.fetch
end

#identityString

Returns The identity.

Returns:

  • (String)

    The identity



382
383
384
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 382

def identity
  @properties['identity']
end

#inspectObject

Provide a detailed, user friendly representation



439
440
441
442
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 439

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Notify.V1.UserBindingInstance #{values}>"
end

Returns The links.

Returns:

  • (String)

    The links



412
413
414
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 412

def links
  @properties['links']
end

#notification_protocol_versionString

Returns The notification_protocol_version.

Returns:

  • (String)

    The notification_protocol_version



370
371
372
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 370

def notification_protocol_version
  @properties['notification_protocol_version']
end

#service_sidString

Returns The service_sid.

Returns:

  • (String)

    The service_sid



346
347
348
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 346

def service_sid
  @properties['service_sid']
end

#sidString

Returns The sid.

Returns:

  • (String)

    The sid



334
335
336
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 334

def sid
  @properties['sid']
end

#tagsString

Returns The tags.

Returns:

  • (String)

    The tags



400
401
402
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 400

def tags
  @properties['tags']
end

#to_sObject

Provide a user friendly representation



432
433
434
435
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 432

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Notify.V1.UserBindingInstance #{values}>"
end

#urlString

Returns The url.

Returns:

  • (String)

    The url



406
407
408
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 406

def url
  @properties['url']
end