Class: Twilio::REST::Conversations::V1::AddressConfigurationInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ AddressConfigurationInstance

Initialize the AddressConfigurationInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • sid (String) (defaults to: nil)

    The SID of the Address Configuration resource. This value can be either the `sid` or the `address` of the configuration


297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 297

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

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'type' => payload['type'],
      'address' => payload['address'],
      'friendly_name' => payload['friendly_name'],
      'auto_creation' => payload['auto_creation'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
  }

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

Instance Method Details

#account_sidString

Returns The unique ID of the Account the address belongs to.

Returns:

  • (String)

    The unique ID of the Account the address belongs to.


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

def 
  @properties['account_sid']
end

#addressString

Returns The unique address to be configured.

Returns:

  • (String)

    The unique address to be configured.


349
350
351
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 349

def address
  @properties['address']
end

#auto_creationHash

Returns Auto Creation configuration for the address.

Returns:

  • (Hash)

    Auto Creation configuration for the address.


361
362
363
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 361

def auto_creation
  @properties['auto_creation']
end

#contextAddressConfigurationContext

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

Returns:


322
323
324
325
326
327
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 322

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

#date_createdTime

Returns The date that this resource was created.

Returns:

  • (Time)

    The date that this resource was created.


367
368
369
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 367

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The date that this resource was last updated.

Returns:

  • (Time)

    The date that this resource was last updated.


373
374
375
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 373

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the AddressConfigurationInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


433
434
435
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 433

def delete
  context.delete
end

#fetchAddressConfigurationInstance

Fetch the AddressConfigurationInstance

Returns:


386
387
388
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 386

def fetch
  context.fetch
end

#friendly_nameString

Returns The human-readable name of this configuration.

Returns:

  • (String)

    The human-readable name of this configuration.


355
356
357
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 355

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


446
447
448
449
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 446

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

#sidString

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String)

    A 34 character string that uniquely identifies this resource.


331
332
333
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 331

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


439
440
441
442
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 439

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

#typeString

Returns Type of Address.

Returns:

  • (String)

    Type of Address.


343
344
345
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 343

def type
  @properties['type']
end

#update(friendly_name: :unset, auto_creation_enabled: :unset, auto_creation_type: :unset, auto_creation_conversation_service_sid: :unset, auto_creation_webhook_url: :unset, auto_creation_webhook_method: :unset, auto_creation_webhook_filters: :unset, auto_creation_studio_flow_sid: :unset, auto_creation_studio_retry_count: :unset) ⇒ AddressConfigurationInstance

Update the AddressConfigurationInstance

Parameters:

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

    The human-readable name of this configuration, limited to 256 characters. Optional.

  • auto_creation_enabled (Boolean) (defaults to: :unset)

    Enable/Disable auto-creating conversations for messages to this address

  • auto_creation_type (address_configuration.AutoCreationType) (defaults to: :unset)

    Type of Auto Creation. Value can be one of `webhook`, `studio` or `default`.

  • auto_creation_conversation_service_sid (String) (defaults to: :unset)

    Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.

  • auto_creation_webhook_url (String) (defaults to: :unset)

    For type `webhook`, the url for the webhook request.

  • auto_creation_webhook_method (address_configuration.Method) (defaults to: :unset)

    For type `webhook`, the HTTP method to be used when sending a webhook request.

  • auto_creation_webhook_filters (Array[String]) (defaults to: :unset)

    The list of events, firing webhook event for this Conversation. Values can be any of the following: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationStateUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onDeliveryUpdated`

  • auto_creation_studio_flow_sid (String) (defaults to: :unset)

    For type `studio`, the studio flow SID where the webhook should be sent to.

  • auto_creation_studio_retry_count (String) (defaults to: :unset)

    For type `studio`, number of times to retry the webhook request

Returns:


416
417
418
419
420
421
422
423
424
425
426
427
428
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 416

def update(friendly_name: :unset, auto_creation_enabled: :unset, auto_creation_type: :unset, auto_creation_conversation_service_sid: :unset, auto_creation_webhook_url: :unset, auto_creation_webhook_method: :unset, auto_creation_webhook_filters: :unset, auto_creation_studio_flow_sid: :unset, auto_creation_studio_retry_count: :unset)
  context.update(
      friendly_name: friendly_name,
      auto_creation_enabled: auto_creation_enabled,
      auto_creation_type: auto_creation_type,
      auto_creation_conversation_service_sid: auto_creation_conversation_service_sid,
      auto_creation_webhook_url: auto_creation_webhook_url,
      auto_creation_webhook_method: auto_creation_webhook_method,
      auto_creation_webhook_filters: auto_creation_webhook_filters,
      auto_creation_studio_flow_sid: auto_creation_studio_flow_sid,
      auto_creation_studio_retry_count: auto_creation_studio_retry_count,
  )
end

#urlString

Returns An absolute URL for this address configuration.

Returns:

  • (String)

    An absolute URL for this address configuration.


379
380
381
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 379

def url
  @properties['url']
end