Class: Twilio::REST::IpMessaging::V2::ServiceList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ ServiceList

Initialize the ServiceList



18
19
20
21
22
23
24
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 18

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/Services"
end

Instance Method Details

#create(friendly_name: nil) ⇒ ServiceInstance

Create the ServiceInstance



30
31
32
33
34
35
36
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 30

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

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

  ServiceInstance.new(@version, payload, )
end

#each ⇒ Object

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



76
77
78
79
80
81
82
83
84
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 76

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



110
111
112
113
114
115
116
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 110

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

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

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



49
50
51
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 49

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



93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 93

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)

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

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

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



64
65
66
67
68
69
70
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 64

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



120
121
122
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 120

def to_s
  '#<Twilio.IpMessaging.V2.ServiceList>'
end