Class: Twilio::REST::Conversations::V1::ConversationList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Conversations::V1::ConversationList
- Defined in:
- lib/twilio-ruby/rest/conversations/v1/conversation.rb
Instance Method Summary collapse
-
#create(friendly_name: :unset, unique_name: :unset, date_created: :unset, date_updated: :unset, messaging_service_sid: :unset, attributes: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, bindings_email_address: :unset, bindings_email_name: :unset, x_twilio_webhook_enabled: :unset) ⇒ ConversationInstance
Create the ConversationInstance.
-
#each ⇒ Object
When passed a block, yields ConversationInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of ConversationInstance records from the API.
-
#initialize(version) ⇒ ConversationList
constructor
Initialize the ConversationList.
-
#list(start_date: :unset, end_date: :unset, state: :unset, limit: nil, page_size: nil) ⇒ Array
Lists ConversationInstance records from the API as a list.
-
#page(start_date: :unset, end_date: :unset, state: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of ConversationInstance records from the API.
-
#stream(start_date: :unset, end_date: :unset, state: :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) ⇒ ConversationList
Initialize the ConversationList
25 26 27 28 29 30 31 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 25 def initialize(version) super(version) # Path Solution @solution = { } @uri = "/Conversations" end |
Instance Method Details
#create(friendly_name: :unset, unique_name: :unset, date_created: :unset, date_updated: :unset, messaging_service_sid: :unset, attributes: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, bindings_email_address: :unset, bindings_email_name: :unset, x_twilio_webhook_enabled: :unset) ⇒ ConversationInstance
Create the ConversationInstance
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/conversation.rb', line 47 def create( friendly_name: :unset, unique_name: :unset, date_created: :unset, date_updated: :unset, messaging_service_sid: :unset, attributes: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, bindings_email_address: :unset, bindings_email_name: :unset, x_twilio_webhook_enabled: :unset ) data = Twilio::Values.of({ 'FriendlyName' => friendly_name, 'UniqueName' => unique_name, 'DateCreated' => Twilio.serialize_iso8601_datetime(date_created), 'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated), 'MessagingServiceSid' => messaging_service_sid, 'Attributes' => attributes, 'State' => state, 'Timers.Inactive' => timers_inactive, 'Timers.Closed' => timers_closed, 'Bindings.Email.Address' => bindings_email_address, 'Bindings.Email.Name' => bindings_email_name, }) headers = Twilio::Values.of({ 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, }) payload = @version.create('POST', @uri, data: data, headers: headers) ConversationInstance.new( @version, payload, ) end |
#each ⇒ Object
When passed a block, yields ConversationInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
139 140 141 142 143 144 145 146 147 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 139 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 ConversationInstance records from the API. Request is executed immediately.
179 180 181 182 183 184 185 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 179 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) ConversationPage.new(@version, response, @solution) end |
#list(start_date: :unset, end_date: :unset, state: :unset, limit: nil, page_size: nil) ⇒ Array
Lists ConversationInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
99 100 101 102 103 104 105 106 107 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 99 def list(start_date: :unset, end_date: :unset, state: :unset, limit: nil, page_size: nil) self.stream( start_date: start_date, end_date: end_date, state: state, limit: limit, page_size: page_size ).entries end |
#page(start_date: :unset, end_date: :unset, state: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of ConversationInstance records from the API. Request is executed immediately.
159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 159 def page(start_date: :unset, end_date: :unset, state: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'StartDate' => start_date, 'EndDate' => end_date, 'State' => state, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) ConversationPage.new(@version, response, @solution) end |
#stream(start_date: :unset, end_date: :unset, state: :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.
123 124 125 126 127 128 129 130 131 132 133 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 123 def stream(start_date: :unset, end_date: :unset, state: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( start_date: start_date, end_date: end_date, state: state, 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
190 191 192 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation.rb', line 190 def to_s '#<Twilio.Conversations.V1.ConversationList>' end |