Class: Twilio::REST::Intelligence::V2::CustomOperatorList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ CustomOperatorList

Initialize the CustomOperatorList



26
27
28
29
30
31
32
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 26

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

Instance Method Details

#create(friendly_name: nil, operator_type: nil, config: nil) ⇒ CustomOperatorInstance

Create the CustomOperatorInstance



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/intelligence/v2/custom_operator.rb', line 39

def create(
    friendly_name: nil, 
    operator_type: nil, 
    config: nil
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'OperatorType' => operator_type,
        'Config' => Twilio.serialize_object(config),
    })

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

#each ⇒ Object

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



115
116
117
118
119
120
121
122
123
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 115

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



156
157
158
159
160
161
162
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 156

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

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

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



78
79
80
81
82
83
84
85
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 78

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

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

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



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 134

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

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

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

#stream(availability: :unset, language_code: :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.



100
101
102
103
104
105
106
107
108
109
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 100

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

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



167
168
169
 
# File 'lib/twilio-ruby/rest/intelligence/v2/custom_operator.rb', line 167

def to_s
    '#<Twilio.Intelligence.V2.CustomOperatorList>'
end