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

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The unique id of the Account that sent this message.



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.

Parameters:

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

    The destination phone number. Format with a ‘+’ and country code

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

    The URL that Twilio will POST to each time your message status changes

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

    Twilio the POST MessageSid as well as MessageStatus to the URL in the MessageStatusCallback property of this Application

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

    The max_price

  • provide_feedback (Boolean) (defaults to: :unset) —

    The provide_feedback

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

    The validity_period

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

    The max_rate

  • force_delivery (Boolean) (defaults to: :unset) —

    The force_delivery

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

    The provider_sid

  • content_retention (message.ContentRetention) (defaults to: :unset) —

    The content_retention

  • address_retention (message.AddressRetention) (defaults to: :unset) —

    The address_retention

  • smart_encoded (Boolean) (defaults to: :unset) —

    The smart_encoded

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

    A Twilio phone number or alphanumeric sender ID enabled for the type of message you wish to send.

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

    The messaging_service_sid

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

    The body

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

    The media_url

Returns:



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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of MessageInstance



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.

Parameters:

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

    Filter by messages to this number

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

    Only show messages from this phone number

  • date_sent_before (Time) (defaults to: :unset) —

    Filter by date sent

  • date_sent (Time) (defaults to: :unset) —

    Filter by date sent

  • date_sent_after (Time) (defaults to: :unset) —

    Filter by date sent

  • 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



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.

Parameters:

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

    Filter by messages to this number

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

    Only show messages from this phone number

  • date_sent_before (Time) (defaults to: :unset) —

    Filter by date sent

  • date_sent (Time) (defaults to: :unset) —

    Filter by date sent

  • date_sent_after (Time) (defaults to: :unset) —

    Filter by date sent

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



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.

Parameters:

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

    Filter by messages to this number

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

    Only show messages from this phone number

  • date_sent_before (Time) (defaults to: :unset) —

    Filter by date sent

  • date_sent (Time) (defaults to: :unset) —

    Filter by date sent

  • date_sent_after (Time) (defaults to: :unset) —

    Filter by date sent

  • 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



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