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



27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 27

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, attempt: :unset, validity_period: :unset, force_delivery: :unset, content_retention: :unset, address_retention: :unset, smart_encoded: :unset, persistent_action: :unset, shorten_urls: :unset, schedule_type: :unset, send_at: :unset, send_as_mms: :unset, content_variables: :unset, tags: :unset, risk_check: :unset, from: :unset, messaging_service_sid: :unset, body: :unset, media_url: :unset, content_sid: :unset) ⇒ MessageInstance

Create the MessageInstance

Parameters:

Returns:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 61

def create(
    to: nil, 
    status_callback: :unset, 
    application_sid: :unset, 
    max_price: :unset, 
    provide_feedback: :unset, 
    attempt: :unset, 
    validity_period: :unset, 
    force_delivery: :unset, 
    content_retention: :unset, 
    address_retention: :unset, 
    smart_encoded: :unset, 
    persistent_action: :unset, 
    shorten_urls: :unset, 
    schedule_type: :unset, 
    send_at: :unset, 
    send_as_mms: :unset, 
    content_variables: :unset, 
    tags: :unset, 
    risk_check: :unset, 
    from: :unset, 
    messaging_service_sid: :unset, 
    body: :unset, 
    media_url: :unset, 
    content_sid: :unset
)

    data = Twilio::Values.of({
        'To' => to,
        'StatusCallback' => status_callback,
        'ApplicationSid' => application_sid,
        'MaxPrice' => max_price,
        'ProvideFeedback' => provide_feedback,
        'Attempt' => attempt,
        'ValidityPeriod' => validity_period,
        'ForceDelivery' => force_delivery,
        'ContentRetention' => content_retention,
        'AddressRetention' => address_retention,
        'SmartEncoded' => smart_encoded,
        'PersistentAction' => Twilio.serialize_list(persistent_action) { |e| e },
        'ShortenUrls' => shorten_urls,
        'ScheduleType' => schedule_type,
        'SendAt' => Twilio.serialize_iso8601_datetime(send_at),
        'SendAsMms' => send_as_mms,
        'ContentVariables' => content_variables,
        'Tags' => tags,
        'RiskCheck' => risk_check,
        'From' => from,
        'MessagingServiceSid' => messaging_service_sid,
        'Body' => body,
        'MediaUrl' => Twilio.serialize_list(media_url) { |e| e },
        'ContentSid' => content_sid,
    })

    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.



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

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



230
231
232
233
234
235
236
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 230

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: :unset, date_sent_before: :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 recipient. For example: Set this ‘to` parameter to `+15558881111` to retrieve a list of Message resources with `to` properties of `+15558881111`

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

    Filter by sender. For example: Set this ‘from` parameter to `+15552229999` to retrieve a list of Message resources with `from` properties of `+15552229999`

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

    Filter by Message ‘sent_date`. Accepts GMT dates in the following formats: `YYYY-MM-DD` (to find Messages with a specific `sent_date`), `<=YYYY-MM-DD` (to find Messages with `sent_date`s on and before a specific date), and `>=YYYY-MM-DD` (to find Messages with `sent_dates` on and after a specific date).

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

    Filter by Message ‘sent_date`. Accepts GMT dates in the following formats: `YYYY-MM-DD` (to find Messages with a specific `sent_date`), `<=YYYY-MM-DD` (to find Messages with `sent_date`s on and before a specific date), and `>=YYYY-MM-DD` (to find Messages with `sent_dates` on and after a specific date).

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

    Filter by Message ‘sent_date`. Accepts GMT dates in the following formats: `YYYY-MM-DD` (to find Messages with a specific `sent_date`), `<=YYYY-MM-DD` (to find Messages with `sent_date`s on and before a specific date), and `>=YYYY-MM-DD` (to find Messages with `sent_dates` on and after a specific date).

  • 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



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

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

#page(to: :unset, from: :unset, date_sent: :unset, date_sent_before: :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 recipient. For example: Set this ‘to` parameter to `+15558881111` to retrieve a list of Message resources with `to` properties of `+15558881111`

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

    Filter by sender. For example: Set this ‘from` parameter to `+15552229999` to retrieve a list of Message resources with `from` properties of `+15552229999`

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

    Filter by Message ‘sent_date`. Accepts GMT dates in the following formats: `YYYY-MM-DD` (to find Messages with a specific `sent_date`), `<=YYYY-MM-DD` (to find Messages with `sent_date`s on and before a specific date), and `>=YYYY-MM-DD` (to find Messages with `sent_dates` on and after a specific date).

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

    Filter by Message ‘sent_date`. Accepts GMT dates in the following formats: `YYYY-MM-DD` (to find Messages with a specific `sent_date`), `<=YYYY-MM-DD` (to find Messages with `sent_date`s on and before a specific date), and `>=YYYY-MM-DD` (to find Messages with `sent_dates` on and after a specific date).

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

    Filter by Message ‘sent_date`. Accepts GMT dates in the following formats: `YYYY-MM-DD` (to find Messages with a specific `sent_date`), `<=YYYY-MM-DD` (to find Messages with `sent_date`s on and before a specific date), and `>=YYYY-MM-DD` (to find Messages with `sent_dates` on and after a specific date).

  • 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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 208

def page(to: :unset, from: :unset, date_sent: :unset, date_sent_before: :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),
        'DateSent<' =>  Twilio.serialize_iso8601_datetime(date_sent_before),
        'DateSent>' =>  Twilio.serialize_iso8601_datetime(date_sent_after),
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })

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

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

#stream(to: :unset, from: :unset, date_sent: :unset, date_sent_before: :unset, date_sent_after: :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.

Parameters:

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

    Filter by recipient. For example: Set this ‘to` parameter to `+15558881111` to retrieve a list of Message resources with `to` properties of `+15558881111`

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

    Filter by sender. For example: Set this ‘from` parameter to `+15552229999` to retrieve a list of Message resources with `from` properties of `+15552229999`

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

    Filter by Message ‘sent_date`. Accepts GMT dates in the following formats: `YYYY-MM-DD` (to find Messages with a specific `sent_date`), `<=YYYY-MM-DD` (to find Messages with `sent_date`s on and before a specific date), and `>=YYYY-MM-DD` (to find Messages with `sent_dates` on and after a specific date).

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

    Filter by Message ‘sent_date`. Accepts GMT dates in the following formats: `YYYY-MM-DD` (to find Messages with a specific `sent_date`), `<=YYYY-MM-DD` (to find Messages with `sent_date`s on and before a specific date), and `>=YYYY-MM-DD` (to find Messages with `sent_dates` on and after a specific date).

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

    Filter by Message ‘sent_date`. Accepts GMT dates in the following formats: `YYYY-MM-DD` (to find Messages with a specific `sent_date`), `<=YYYY-MM-DD` (to find Messages with `sent_date`s on and before a specific date), and `>=YYYY-MM-DD` (to find Messages with `sent_dates` on and after a specific date).

  • 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



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

def stream(to: :unset, from: :unset, date_sent: :unset, date_sent_before: :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: date_sent,
        date_sent_before: date_sent_before,
        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



241
242
243
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 241

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