Class: Twilio::REST::IpMessaging::V2::ServiceContext::UserContext::UserBindingInstance

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the UserBindingInstance

Parameters:



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb', line 255

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

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

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



303
304
305
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb', line 303

def 
  @properties['account_sid']
end

#binding_type ⇒ user_binding.BindingType

Returns The push technology to use for the binding.

Returns:

  • (user_binding.BindingType) —

    The push technology to use for the binding



351
352
353
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb', line 351

def binding_type
  @properties['binding_type']
end

#context ⇒ UserBindingContext

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

Returns:



283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb', line 283

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

#credential_sid ⇒ String

Returns The SID of the Credential for the binding.

Returns:

  • (String) —

    The SID of the Credential for the binding



345
346
347
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb', line 345

def credential_sid
  @properties['credential_sid']
end

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



315
316
317
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb', line 315

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated



321
322
323
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb', line 321

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the UserBindingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



377
378
379
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb', line 377

def delete
  context.delete
end

#endpoint ⇒ String

Returns The unique endpoint identifier for the User Binding.

Returns:

  • (String) —

    The unique endpoint identifier for the User Binding



327
328
329
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb', line 327

def endpoint
  @properties['endpoint']
end

#fetch ⇒ UserBindingInstance

Fetch a UserBindingInstance

Returns:



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

def fetch
  context.fetch
end

#identity ⇒ String

Returns The string that identifies the resource’s User.

Returns:

  • (String) —

    The string that identifies the resource’s User



333
334
335
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb', line 333

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



390
391
392
393
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb', line 390

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

#message_types ⇒ String

Returns The Programmable Chat message types the binding is subscribed to.

Returns:

  • (String) —

    The Programmable Chat message types the binding is subscribed to



357
358
359
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb', line 357

def message_types
  @properties['message_types']
end

#service_sid ⇒ String

Returns The SID of the Service that the resource is associated with.

Returns:

  • (String) —

    The SID of the Service that the resource is associated with



309
310
311
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb', line 309

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



297
298
299
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb', line 297

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



383
384
385
386
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb', line 383

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

#url ⇒ String

Returns The absolute URL of the User Binding resource.

Returns:

  • (String) —

    The absolute URL of the User Binding resource



363
364
365
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb', line 363

def url
  @properties['url']
end

#user_sid ⇒ String

Returns The SID of the User with the binding.

Returns:

  • (String) —

    The SID of the User with the binding



339
340
341
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_binding.rb', line 339

def user_sid
  @properties['user_sid']
end