Class: Twilio::REST::Conversations::V1::AddressConfigurationList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ AddressConfigurationList

Initialize the AddressConfigurationList

Parameters:

  • version (Version) —

    Version that contains the resource


18
19
20
21
22
23
24
 
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 18

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/Configuration/Addresses"
end

Instance Method Details

#create(type: nil, address: nil, 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

Create the AddressConfigurationInstance

Parameters:

  • type (address_configuration.Type) (defaults to: nil) —

    Type of Address. Value can be `whatsapp` or `sms`.

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

    The unique address to be configured. The address can be a whatsapp address or phone number

  • 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:


143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 143

def create(type: nil, address: nil, 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)
  data = Twilio::Values.of({
      'Type' => type,
      'Address' => address,
      'FriendlyName' => friendly_name,
      'AutoCreation.Enabled' => auto_creation_enabled,
      'AutoCreation.Type' => auto_creation_type,
      'AutoCreation.ConversationServiceSid' => auto_creation_conversation_service_sid,
      'AutoCreation.WebhookUrl' => auto_creation_webhook_url,
      'AutoCreation.WebhookMethod' => auto_creation_webhook_method,
      'AutoCreation.WebhookFilters' => Twilio.serialize_list(auto_creation_webhook_filters) { |e| e },
      'AutoCreation.StudioFlowSid' => auto_creation_studio_flow_sid,
      'AutoCreation.StudioRetryCount' => auto_creation_studio_retry_count,
  })

  payload = @version.create('POST', @uri, data: data)

  AddressConfigurationInstance.new(@version, payload, )
end

#each ⇒ Object

When passed a block, yields AddressConfigurationInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.


68
69
70
71
72
73
74
75
76
 
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 68

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of AddressConfigurationInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of AddressConfigurationInstance


105
106
107
108
109
110
111
 
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 105

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  AddressConfigurationPage.new(@version, response, @solution)
end

#list(type: :unset, limit: nil, page_size: nil) ⇒ Array

Lists AddressConfigurationInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.

Parameters:

  • type (String) (defaults to: :unset) —

    Filter the address configurations by its type. This value can be one of: `whatsapp`, `sms`.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results


39
40
41
 
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 39

def list(type: :unset, limit: nil, page_size: nil)
  self.stream(type: type, limit: limit, page_size: page_size).entries
end

#page(type: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of AddressConfigurationInstance records from the API. Request is executed immediately.

Parameters:

  • type (String) (defaults to: :unset) —

    Filter the address configurations by its type. This value can be one of: `whatsapp`, `sms`.

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of AddressConfigurationInstance


87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 87

def page(type: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Type' => type,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  AddressConfigurationPage.new(@version, response, @solution)
end

#stream(type: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams AddressConfigurationInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • type (String) (defaults to: :unset) —

    Filter the address configurations by its type. This value can be one of: `whatsapp`, `sms`.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results


56
57
58
59
60
61
62
 
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 56

def stream(type: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(type: type, page_size: limits[:page_size], )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation


165
166
167
 
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 165

def to_s
  '#<Twilio.Conversations.V1.AddressConfigurationList>'
end