Class: Twilio::REST::Serverless::V1::ServiceContext::AssetList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/serverless/v1/service/asset.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ AssetList

Initialize the AssetList



28
29
30
31
32
33
34
35
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/asset.rb', line 28

def initialize(version, service_sid: nil)
    super(version)
    
    # Path Solution
    @solution = { service_sid: service_sid }
    @uri = "/Services/#{@solution[:service_sid]}/Assets"
    
end

Instance Method Details

#create(friendly_name: nil) ⇒ AssetInstance

Create the AssetInstance



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

def create(
    friendly_name: nil
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
    })

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

#create_with_metadata(friendly_name: nil) ⇒ AssetInstance

Create the AssetInstanceMetadata



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/asset.rb', line 66

def create_with_metadata(
  friendly_name: nil
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    asset_instance = AssetInstance.new(
        @version,
        response.body,
        service_sid: @solution[:service_sid],
    )
    AssetInstanceMetadata.new(
        @version,
        asset_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

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



159
160
161
162
163
164
165
166
167
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/asset.rb', line 159

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



196
197
198
199
200
201
202
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/asset.rb', line 196

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

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

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



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

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

#list_with_metadata(limit: nil, page_size: nil) ⇒ Array

Lists AssetPageMetadata records from the API as a list.



142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/asset.rb', line 142

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

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

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

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

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



176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/asset.rb', line 176

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

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

    AssetPage.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.



124
125
126
127
128
129
130
131
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/asset.rb', line 124

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



207
208
209
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/asset.rb', line 207

def to_s
    '#<Twilio.Serverless.V1.AssetList>'
end