Class: Twilio::REST::Content::V2::ContentList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/content/v2/content.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ ContentList

Initialize the ContentList

Parameters:

  • version (Version) —

    Version that contains the resource



26
27
28
29
30
31
32
 
# File 'lib/twilio-ruby/rest/content/v2/content.rb', line 26

def initialize(version)
    super(version)
    # Path Solution
    @solution = {  }
    @uri = "/Content"
    
end

Instance Method Details

#each ⇒ Object

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



112
113
114
115
116
117
118
119
120
 
# File 'lib/twilio-ruby/rest/content/v2/content.rb', line 112

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of ContentInstance



170
171
172
173
174
175
176
 
# File 'lib/twilio-ruby/rest/content/v2/content.rb', line 170

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

#list(sort_by_date: :unset, sort_by_content_name: :unset, date_created_after: :unset, date_created_before: :unset, content_name: :unset, content: :unset, language: :unset, content_type: :unset, channel_eligibility: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

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

    Whether to sort by ascending or descending date updated

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

    Whether to sort by ascending or descending content name

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

    Filter by >=[date-time]

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

    Filter by <=[date-time]

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

    Filter by Regex Pattern in content name

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

    Filter by Regex Pattern in template content

  • language (Array[String]) (defaults to: :unset) —

    Filter by array of valid language(s)

  • content_type (Array[String]) (defaults to: :unset) —

    Filter by array of contentType(s)

  • channel_eligibility (Array[String]) (defaults to: :unset) —

    Filter by array of ChannelEligibility(s), where ChannelEligibility=<channel>:<status>

  • 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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/twilio-ruby/rest/content/v2/content.rb', line 54

def list(sort_by_date: :unset, sort_by_content_name: :unset, date_created_after: :unset, date_created_before: :unset, content_name: :unset, content: :unset, language: :unset, content_type: :unset, channel_eligibility: :unset, limit: nil, page_size: nil)
    self.stream(
        sort_by_date: sort_by_date,
        sort_by_content_name: sort_by_content_name,
        date_created_after: date_created_after,
        date_created_before: date_created_before,
        content_name: content_name,
        content: content,
        language: language,
        content_type: content_type,
        channel_eligibility: channel_eligibility,
        limit: limit,
        page_size: page_size
    ).entries
end

#page(sort_by_date: :unset, sort_by_content_name: :unset, date_created_after: :unset, date_created_before: :unset, content_name: :unset, content: :unset, language: :unset, content_type: :unset, channel_eligibility: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

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

    Whether to sort by ascending or descending date updated

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

    Whether to sort by ascending or descending content name

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

    Filter by >=[date-time]

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

    Filter by <=[date-time]

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

    Filter by Regex Pattern in content name

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

    Filter by Regex Pattern in template content

  • language (Array[String]) (defaults to: :unset) —

    Filter by array of valid language(s)

  • content_type (Array[String]) (defaults to: :unset) —

    Filter by array of contentType(s)

  • channel_eligibility (Array[String]) (defaults to: :unset) —

    Filter by array of ChannelEligibility(s), where ChannelEligibility=<channel>:<status>

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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/twilio-ruby/rest/content/v2/content.rb', line 138

def page(sort_by_date: :unset, sort_by_content_name: :unset, date_created_after: :unset, date_created_before: :unset, content_name: :unset, content: :unset, language: :unset, content_type: :unset, channel_eligibility: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'SortByDate' => sort_by_date,
        'SortByContentName' => sort_by_content_name,
        'DateCreatedAfter' =>  Twilio.serialize_iso8601_datetime(date_created_after),
        'DateCreatedBefore' =>  Twilio.serialize_iso8601_datetime(date_created_before),
        'ContentName' => content_name,
        'Content' => content,
        
        'Language' =>  Twilio.serialize_list(language) { |e| e },
        
        'ContentType' =>  Twilio.serialize_list(content_type) { |e| e },
        
        'ChannelEligibility' =>  Twilio.serialize_list(channel_eligibility) { |e| e },
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

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

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

#stream(sort_by_date: :unset, sort_by_content_name: :unset, date_created_after: :unset, date_created_before: :unset, content_name: :unset, content: :unset, language: :unset, content_type: :unset, channel_eligibility: :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:

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

    Whether to sort by ascending or descending date updated

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

    Whether to sort by ascending or descending content name

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

    Filter by >=[date-time]

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

    Filter by <=[date-time]

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

    Filter by Regex Pattern in content name

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

    Filter by Regex Pattern in template content

  • language (Array[String]) (defaults to: :unset) —

    Filter by array of valid language(s)

  • content_type (Array[String]) (defaults to: :unset) —

    Filter by array of contentType(s)

  • channel_eligibility (Array[String]) (defaults to: :unset) —

    Filter by array of ChannelEligibility(s), where ChannelEligibility=<channel>:<status>

  • 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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/twilio-ruby/rest/content/v2/content.rb', line 90

def stream(sort_by_date: :unset, sort_by_content_name: :unset, date_created_after: :unset, date_created_before: :unset, content_name: :unset, content: :unset, language: :unset, content_type: :unset, channel_eligibility: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        sort_by_date: sort_by_date,
        sort_by_content_name: sort_by_content_name,
        date_created_after: date_created_after,
        date_created_before: date_created_before,
        content_name: content_name,
        content: content,
        language: language,
        content_type: content_type,
        channel_eligibility: channel_eligibility,
        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



181
182
183
 
# File 'lib/twilio-ruby/rest/content/v2/content.rb', line 181

def to_s
    '#<Twilio.Content.V2.ContentList>'
end