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

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ SinkList

Initialize the SinkList

Parameters:

  • version (Version) —

    Version that contains the resource



26
27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 26

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

Parameters:

  • description (String) (defaults to: nil) —

    A human readable description for the Sink **This value should not contain PII.**

  • sink_configuration (Object) (defaults to: nil) —

    The information required for Twilio to connect to the provided Sink encoded as JSON.

  • sink_type (SinkType) (defaults to: nil)

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 40

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,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    SinkInstance.new(
        @version,
        payload,
    )
end

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

Create the SinkInstanceMetadata

Parameters:

  • description (String) (defaults to: nil) —

    A human readable description for the Sink **This value should not contain PII.**

  • sink_configuration (Object) (defaults to: nil) —

    The information required for Twilio to connect to the provided Sink encoded as JSON.

  • sink_type (SinkType) (defaults to: nil)

Returns:



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 71

def create_with_metadata(
  description: nil, 
  sink_configuration: nil, 
  sink_type: nil
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    sink_instance = SinkInstance.new(
        @version,
        response.body,
    )
    SinkInstanceMetadata.new(
        @version,
        sink_instance,
        response.headers,
        response.status_code
    )
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.



179
180
181
182
183
184
185
186
187
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 179

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of SinkInstance



220
221
222
223
224
225
226
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 220

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

#list(in_use: :unset, status: :unset, 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.

Parameters:

  • in_use (Boolean) (defaults to: :unset) —

    A boolean query parameter filtering the results to return sinks used/not used by a subscription.

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

    A String query parameter filtering the results by status initialized, validating, active or failed.

  • 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



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

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

#list_with_metadata(in_use: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Array

Returns Array of up to limit results.

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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 160

def list_with_metadata(in_use: :unset, status: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'InUse' => in_use,
        'Status' => status,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    SinkPageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(in_use: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

  • in_use (Boolean) (defaults to: :unset) —

    A boolean query parameter filtering the results to return sinks used/not used by a subscription.

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

    A String query parameter filtering the results by status initialized, validating, active or failed.

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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 198

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

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

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

#stream(in_use: :unset, status: :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:

  • in_use (Boolean) (defaults to: :unset) —

    A boolean query parameter filtering the results to return sinks used/not used by a subscription.

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

    A String query parameter filtering the results by status initialized, validating, active or failed.

  • 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



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 138

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

    page = self.page(
        in_use: in_use,
        status: status,
        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



231
232
233
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 231

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