Class: Twilio::REST::Messaging::V1::ServiceContext::ShortCodeList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/messaging/v1/service/short_code.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ ShortCodeList

Initialize the ShortCodeList

Parameters:

  • version (Version)

    Version that contains the resource

  • service_sid (String) (defaults to: nil)

    The SID of the Service the resource is associated with.


24
25
26
27
28
29
30
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 24

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

  # Path Solution
  @solution = {service_sid: service_sid}
  @uri = "/Services/#{@solution[:service_sid]}/ShortCodes"
end

Instance Method Details

#create(short_code_sid: nil) ⇒ ShortCodeInstance

Create the ShortCodeInstance

Parameters:

  • short_code_sid (String) (defaults to: nil)

    The SID of the ShortCode resource being added to the Service.

Returns:


37
38
39
40
41
42
43
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 37

def create(short_code_sid: nil)
  data = Twilio::Values.of({'ShortCodeSid' => short_code_sid, })

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

  ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid], )
end

#eachObject

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


83
84
85
86
87
88
89
90
91
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 83

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


117
118
119
120
121
122
123
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 117

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

#list(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:

  • 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


56
57
58
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 56

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

#page(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:

  • 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


100
101
102
103
104
105
106
107
108
109
110
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 100

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

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

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

#stream(limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

  • 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


71
72
73
74
75
76
77
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 71

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

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_sObject

Provide a user friendly representation


127
128
129
# File 'lib/twilio-ruby/rest/messaging/v1/service/short_code.rb', line 127

def to_s
  '#<Twilio.Messaging.V1.ShortCodeList>'
end