Class: Twilio::REST::Api::V2010::AccountContext::MessageList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/message.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil) ⇒ MessageList

Initialize the MessageList



18
19
20
21
22
23
24
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 18

def initialize(version, account_sid: nil)
  super(version)

  # Path Solution
  @solution = {account_sid: }
  @uri = "/Accounts/#{@solution[:account_sid]}/Messages.json"
end

Instance Method Details

#create(to: nil, status_callback: :unset, application_sid: :unset, max_price: :unset, provide_feedback: :unset, validity_period: :unset, max_rate: :unset, force_delivery: :unset, provider_sid: :unset, content_retention: :unset, address_retention: :unset, smart_encoded: :unset, from: :unset, messaging_service_sid: :unset, body: :unset, media_url: :unset) ⇒ MessageInstance

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



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
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 51

def create(to: nil, status_callback: :unset, application_sid: :unset, max_price: :unset, provide_feedback: :unset, validity_period: :unset, max_rate: :unset, force_delivery: :unset, provider_sid: :unset, content_retention: :unset, address_retention: :unset, smart_encoded: :unset, from: :unset, messaging_service_sid: :unset, body: :unset, media_url: :unset)
  data = Twilio::Values.of({
      'To' => to,
      'From' => from,
      'MessagingServiceSid' => messaging_service_sid,
      'Body' => body,
      'MediaUrl' => Twilio.serialize_list(media_url) { |e| e },
      'StatusCallback' => status_callback,
      'ApplicationSid' => application_sid,
      'MaxPrice' => max_price,
      'ProvideFeedback' => provide_feedback,
      'ValidityPeriod' => validity_period,
      'MaxRate' => max_rate,
      'ForceDelivery' => force_delivery,
      'ProviderSid' => provider_sid,
      'ContentRetention' => content_retention,
      'AddressRetention' => address_retention,
      'SmartEncoded' => smart_encoded,
  })

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

  MessageInstance.new(@version, payload, account_sid: @solution[:account_sid], )
end

#each ⇒ Object

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



143
144
145
146
147
148
149
150
151
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 143

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 MessageInstance records from the API. Request is executed immediately.



189
190
191
192
193
194
195
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 189

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

#list(to: :unset, from: :unset, date_sent_before: :unset, date_sent: :unset, date_sent_after: :unset, limit: nil, page_size: nil) ⇒ Array

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



96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 96

def list(to: :unset, from: :unset, date_sent_before: :unset, date_sent: :unset, date_sent_after: :unset, limit: nil, page_size: nil)
  self.stream(
      to: to,
      from: from,
      date_sent_before: date_sent_before,
      date_sent: date_sent,
      date_sent_after: date_sent_after,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(to: :unset, from: :unset, date_sent_before: :unset, date_sent: :unset, date_sent_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 165

def page(to: :unset, from: :unset, date_sent_before: :unset, date_sent: :unset, date_sent_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'To' => to,
      'From' => from,
      'DateSent<' => Twilio.serialize_iso8601_datetime(date_sent_before),
      'DateSent' => Twilio.serialize_iso8601_datetime(date_sent),
      'DateSent>' => Twilio.serialize_iso8601_datetime(date_sent_after),
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  MessagePage.new(@version, response, @solution)
end

#stream(to: :unset, from: :unset, date_sent_before: :unset, date_sent: :unset, date_sent_after: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 124

def stream(to: :unset, from: :unset, date_sent_before: :unset, date_sent: :unset, date_sent_after: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      to: to,
      from: from,
      date_sent_before: date_sent_before,
      date_sent: date_sent,
      date_sent_after: date_sent_after,
      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



199
200
201
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 199

def to_s
  '#<Twilio.Api.V2010.MessageList>'
end