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



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

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



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

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

    payload = @version.create('POST', @uri, data: data)
    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.



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

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.



142
143
144
145
146
147
148
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 142

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.



70
71
72
73
74
75
76
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 70

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.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 122

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

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

    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.



90
91
92
93
94
95
96
97
98
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 90

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



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

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