Class: Twilio::REST::Messaging::V1::ServiceContext::AlphaSenderList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/messaging/v1/service/alpha_sender.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) ⇒ AlphaSenderList

Initialize the AlphaSenderList



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

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

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

Instance Method Details

#create(alpha_sender: nil) ⇒ AlphaSenderInstance

Create the AlphaSenderInstance



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

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

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

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

#each ⇒ Object

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



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

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



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

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

#list(limit: nil, page_size: nil) ⇒ Array

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



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

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



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

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)

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

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

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



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

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_s ⇒ Object

Provide a user friendly representation



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

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