Class: Twilio::REST::Conversations::V1::AddressConfigurationList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Conversations::V1::AddressConfigurationList
- Defined in:
- lib/twilio-ruby/rest/conversations/v1/address_configuration.rb
Instance Method Summary collapse
-
#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, address_country: :unset) ⇒ AddressConfigurationInstance
Create the AddressConfigurationInstance.
-
#each ⇒ Object
When passed a block, yields AddressConfigurationInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of AddressConfigurationInstance records from the API.
-
#initialize(version) ⇒ AddressConfigurationList
constructor
Initialize the AddressConfigurationList.
-
#list(type: :unset, limit: nil, page_size: nil) ⇒ Array
Lists AddressConfigurationInstance records from the API as a list.
-
#page(type: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of AddressConfigurationInstance records from the API.
-
#stream(type: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version) ⇒ AddressConfigurationList
Initialize the AddressConfigurationList
25 26 27 28 29 30 31 |
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 25 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, address_country: :unset) ⇒ AddressConfigurationInstance
Create the AddressConfigurationInstance
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 47 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, address_country: :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, 'AddressCountry' => address_country, }) 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.
131 132 133 134 135 136 137 138 139 |
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 131 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.
167 168 169 170 171 172 173 |
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 167 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.
97 98 99 100 101 102 103 |
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 97 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.
149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 149 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 Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
117 118 119 120 121 122 123 124 125 |
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 117 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
178 179 180 |
# File 'lib/twilio-ruby/rest/conversations/v1/address_configuration.rb', line 178 def to_s '#<Twilio.Conversations.V1.AddressConfigurationList>' end |