Class: Twilio::REST::Events::V1::SinkList

Inherits:
ListResource show all
Defined in:
lib/twilio-ruby/rest/events/v1/sink.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ SinkList

Initialize the SinkList



20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 20

def initialize(version)
  super(version)

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

Instance Method Details

#create(description: nil, sink_configuration: nil, sink_type: nil) ⇒ SinkInstance

Create the SinkInstance



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 35

def create(description: nil, sink_configuration: nil, sink_type: nil)
  data = Twilio::Values.of({
      'Description' => description,
      'SinkConfiguration' => Twilio.serialize_object(sink_configuration),
      'SinkType' => sink_type,
  })

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

  SinkInstance.new(@version, payload, )
end

#each ⇒ Object

When passed a block, yields SinkInstance 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/events/v1/sink.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 SinkInstance records from the API. Request is executed immediately.



119
120
121
122
123
124
125
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 119

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

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

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



58
59
60
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 58

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



102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 102

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)

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

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

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



73
74
75
76
77
78
79
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 73

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



129
130
131
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 129

def to_s
  '#<Twilio.Events.V1.SinkList>'
end