Class: Twilio::REST::Conversations::V1::ServiceContext::BindingInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, chat_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.



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 234

def initialize(version, payload , chat_service_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'chat_service_sid' => payload['chat_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']),
        'endpoint' => payload['endpoint'],
        'identity' => payload['identity'],
        'binding_type' => payload['binding_type'],
        'message_types' => payload['message_types'],
        'url' => payload['url'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The unique ID of the [Account](www.twilio.com/docs/iam/api/account) responsible for this binding.

Returns:



276
277
278
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 276

def 
    @properties['account_sid']
end

#binding_type ⇒ BindingType

Returns:

  • (BindingType) 


318
319
320
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 318

def binding_type
    @properties['binding_type']
end

#chat_service_sid ⇒ String

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

Returns:



282
283
284
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 282

def chat_service_sid
    @properties['chat_service_sid']
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:



261
262
263
264
265
266
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 261

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

#credential_sid ⇒ String

Returns The SID of the [Credential](www.twilio.com/docs/conversations/api/credential-resource) for the binding. See [push notification configuration](www.twilio.com/docs/chat/push-notification-configuration) for more info.

Returns:



288
289
290
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 288

def credential_sid
    @properties['credential_sid']
end

#date_created ⇒ Time

Returns The date that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created.



294
295
296
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 294

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated.



300
301
302
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 300

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the BindingInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



337
338
339
340
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 337

def delete

    context.delete
end

#endpoint ⇒ String

Returns The unique endpoint identifier for the Binding. The format of this value depends on the ‘binding_type`.

Returns:

  • (String) —

    The unique endpoint identifier for the Binding. The format of this value depends on the ‘binding_type`.



306
307
308
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 306

def endpoint
    @properties['endpoint']
end

#fetch ⇒ BindingInstance

Fetch the BindingInstance

Returns:



345
346
347
348
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 345

def fetch

    context.fetch
end

#identity ⇒ String

Returns The application-defined string that uniquely identifies the [Conversation User](www.twilio.com/docs/conversations/api/user-resource) within the [Conversation Service](www.twilio.com/docs/conversations/api/service-resource). See [access tokens](www.twilio.com/docs/conversations/create-tokens) for more info.

Returns:



312
313
314
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 312

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#message_types ⇒ Array<String>

Returns The [Conversation message types](www.twilio.com/docs/chat/push-notification-configuration#push-types) the binding is subscribed to.

Returns:



324
325
326
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 324

def message_types
    @properties['message_types']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



270
271
272
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 270

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



352
353
354
355
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/binding.rb', line 352

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

#url ⇒ String

Returns An absolute API resource URL for this binding.

Returns:

  • (String) —

    An absolute API resource URL for this binding.



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

def url
    @properties['url']
end