Class: Twilio::REST::Events::V1::SubscriptionList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ SubscriptionList

Initialize the SubscriptionList



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

def initialize(version)
    super(version)
    # Path Solution
    @solution = {  }
    @uri = "/Subscriptions"
    
end

Instance Method Details

#create(description: nil, sink_sid: nil, types: nil) ⇒ SubscriptionInstance

Create the SubscriptionInstance



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

def create(
    description: nil, 
    sink_sid: nil, 
    types: nil
)

    data = Twilio::Values.of({
        'Description' => description,
        'SinkSid' => sink_sid,
        'Types' => Twilio.serialize_list(types) { |e| Twilio.serialize_object(e) },
    })

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

#each ⇒ Object

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



111
112
113
114
115
116
117
118
119
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 111

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



150
151
152
153
154
155
156
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 150

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

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

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



77
78
79
80
81
82
83
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 77

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

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

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



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 129

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

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

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

#stream(sink_sid: :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.



97
98
99
100
101
102
103
104
105
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 97

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

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



161
162
163
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 161

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