Class: Twilio::REST::Api::V2010::AccountContext::ShortCodeList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil) ⇒ ShortCodeList

Initialize the ShortCodeList

Parameters:

  • version (Version) —

    Version that contains the resource



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

def initialize(version, account_sid: nil)
    super(version)
    # Path Solution
    @solution = { account_sid:  }
    @uri = "/Accounts/#{@solution[:account_sid]}/SMS/ShortCodes.json"
    
end

Instance Method Details

#each ⇒ Object

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



85
86
87
88
89
90
91
92
93
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 85

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of ShortCodeInstance



123
124
125
126
127
128
129
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 123

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

#list(friendly_name: :unset, short_code: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

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

    The string that identifies the ShortCode resources to read.

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

    Only show the ShortCode resources that match this pattern. You can specify partial numbers and use ‘*’ as a wildcard for any digit.

  • 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



48
49
50
51
52
53
54
55
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 48

def list(friendly_name: :unset, short_code: :unset, limit: nil, page_size: nil)
    self.stream(
        friendly_name: friendly_name,
        short_code: short_code,
        limit: limit,
        page_size: page_size
    ).entries
end

#page(friendly_name: :unset, short_code: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

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

    The string that identifies the ShortCode resources to read.

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

    Only show the ShortCode resources that match this pattern. You can specify partial numbers and use ‘*’ as a wildcard for any digit.

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



104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 104

def page(friendly_name: :unset, short_code: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'ShortCode' => short_code,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })

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

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

#stream(friendly_name: :unset, short_code: :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:

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

    The string that identifies the ShortCode resources to read.

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

    Only show the ShortCode resources that match this pattern. You can specify partial numbers and use ‘*’ as a wildcard for any digit.

  • 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



70
71
72
73
74
75
76
77
78
79
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 70

def stream(friendly_name: :unset, short_code: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        friendly_name: friendly_name,
        short_code: short_code,
        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



134
135
136
 
# File 'lib/twilio-ruby/rest/api/v2010/account/short_code.rb', line 134

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