Class: Twilio::REST::Notify::V1::ServiceContext::BindingInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the BindingInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Binding resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



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

def initialize(version, payload , service_sid: 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  || @properties['service_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Binding resource.

Returns:



336
337
338
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 336

def 
    @properties['account_sid']
end

#address ⇒ String

Returns The channel-specific address. For APNS, the device token. For FCM and GCM, the registration token. For SMS, a phone number in E.164 format. For Facebook Messenger, the Messenger ID of the user or a phone number in E.164 format.

Returns:

  • (String) —

    The channel-specific address. For APNS, the device token. For FCM and GCM, the registration token. For SMS, a phone number in E.164 format. For Facebook Messenger, the Messenger ID of the user or a phone number in E.164 format.



390
391
392
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 390

def address
    @properties['address']
end

#binding_type ⇒ String

Returns The transport technology to use for the Binding. Can be: ‘apn`, `fcm`, `gcm`, `sms`, or `facebook-messenger`.

Returns:

  • (String) —

    The transport technology to use for the Binding. Can be: ‘apn`, `fcm`, `gcm`, `sms`, or `facebook-messenger`.



384
385
386
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 384

def binding_type
    @properties['binding_type']
end

#context ⇒ BindingContext

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

Returns:



321
322
323
324
325
326
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 321

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

#credential_sid ⇒ String

Returns The SID of the [Credential](www.twilio.com/docs/notify/api/credential-resource) resource to be used to send notifications to this Binding. If present, this overrides the Credential specified in the Service resource. Applicable only to ‘apn`, `fcm`, and `gcm` type Bindings.

Returns:

  • (String) —

    The SID of the [Credential](www.twilio.com/docs/notify/api/credential-resource) resource to be used to send notifications to this Binding. If present, this overrides the Credential specified in the Service resource. Applicable only to ‘apn`, `fcm`, and `gcm` type Bindings.



348
349
350
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 348

def credential_sid
    @properties['credential_sid']
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



354
355
356
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 354

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



360
361
362
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 360

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the BindingInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



415
416
417
418
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 415

def delete

    context.delete
end

#endpoint ⇒ String

Returns Deprecated.

Returns:

  • (String) —

    Deprecated.



372
373
374
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 372

def endpoint
    @properties['endpoint']
end

#fetch ⇒ BindingInstance

Fetch the BindingInstance

Returns:



423
424
425
426
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 423

def fetch

    context.fetch
end

#identity ⇒ String

Returns The ‘identity` value that uniquely identifies the resource’s [User](www.twilio.com/docs/chat/rest/user-resource) within the [Service](www.twilio.com/docs/notify/api/service-resource). Up to 20 Bindings can be created for the same Identity in a given Service.

Returns:



378
379
380
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 378

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



437
438
439
440
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 437

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

#links ⇒ Hash

Returns The URLs of related resources.

Returns:

  • (Hash) —

    The URLs of related resources.



408
409
410
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 408

def links
    @properties['links']
end

#notification_protocol_version ⇒ String

Returns The protocol version to use to send the notification. This defaults to the value of ‘default_xxxx_notification_protocol_version` in the [Service](www.twilio.com/docs/notify/api/service-resource) for the protocol. The current version is `"3"` for `apn`, `fcm`, and `gcm` type Bindings. The parameter is not applicable to `sms` and `facebook-messenger` type Bindings as the data format is fixed.

Returns:

  • (String) —

    The protocol version to use to send the notification. This defaults to the value of ‘default_xxxx_notification_protocol_version` in the [Service](www.twilio.com/docs/notify/api/service-resource) for the protocol. The current version is `"3"` for `apn`, `fcm`, and `gcm` type Bindings. The parameter is not applicable to `sms` and `facebook-messenger` type Bindings as the data format is fixed.



366
367
368
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 366

def notification_protocol_version
    @properties['notification_protocol_version']
end

#service_sid ⇒ String

Returns The SID of the [Service](www.twilio.com/docs/notify/api/service-resource) the resource is associated with.

Returns:



342
343
344
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 342

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the Binding resource.

Returns:

  • (String) —

    The unique string that we created to identify the Binding resource.



330
331
332
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 330

def sid
    @properties['sid']
end

#tags ⇒ Array<String>

Returns The list of tags associated with this Binding. Tags can be used to select the Bindings to use when sending a notification. Maximum 20 tags are allowed.

Returns:

  • (Array<String>) —

    The list of tags associated with this Binding. Tags can be used to select the Bindings to use when sending a notification. Maximum 20 tags are allowed.



396
397
398
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 396

def tags
    @properties['tags']
end

#to_s ⇒ Object

Provide a user friendly representation



430
431
432
433
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 430

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

#url ⇒ String

Returns The absolute URL of the Binding resource.

Returns:

  • (String) —

    The absolute URL of the Binding resource.



402
403
404
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 402

def url
    @properties['url']
end