Class: Twilio::REST::Proxy::V1::ServiceList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ ServiceList

Initialize the ServiceList



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

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

Instance Method Details

#create(unique_name: nil, default_ttl: :unset, callback_url: :unset, geo_match_level: :unset, number_selection_behavior: :unset, intercept_callback_url: :unset, out_of_session_callback_url: :unset, chat_instance_sid: :unset) ⇒ ServiceInstance

Create the ServiceInstance



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 44

def create(
    unique_name: nil, 
    default_ttl: :unset, 
    callback_url: :unset, 
    geo_match_level: :unset, 
    number_selection_behavior: :unset, 
    intercept_callback_url: :unset, 
    out_of_session_callback_url: :unset, 
    chat_instance_sid: :unset
)

    data = Twilio::Values.of({
        'UniqueName' => unique_name,
        'DefaultTtl' => default_ttl,
        'CallbackUrl' => callback_url,
        'GeoMatchLevel' => geo_match_level,
        'NumberSelectionBehavior' => number_selection_behavior,
        'InterceptCallbackUrl' => intercept_callback_url,
        'OutOfSessionCallbackUrl' => out_of_session_callback_url,
        'ChatInstanceSid' => chat_instance_sid,
    })

    
    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.



117
118
119
120
121
122
123
124
125
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 117

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.



151
152
153
154
155
156
157
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 151

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.



86
87
88
89
90
91
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 86

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.



134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 134

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 Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



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

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



162
163
164
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 162

def to_s
    '#<Twilio.Proxy.V1.ServiceList>'
end