Class: Twilio::REST::Serverless::V1::ServiceContext::FunctionContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/serverless/v1/service/function.rb,
lib/twilio-ruby/rest/serverless/v1/service/function/function_version.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Defined Under Namespace

Classes: FunctionVersionContext, FunctionVersionInstance, FunctionVersionList, FunctionVersionPage

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ FunctionContext

Initialize the FunctionContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The service_sid

  • sid (String) —

    The sid



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

def initialize(version, service_sid, sid)
  super(version)

  # Path Solution
  @solution = {service_sid: service_sid, sid: sid, }
  @uri = "/Services/#{@solution[:service_sid]}/Functions/#{@solution[:sid]}"

  # Dependents
  @function_versions = nil
end

Instance Method Details

#fetch ⇒ FunctionInstance

Fetch a FunctionInstance

Returns:



190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 190

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  FunctionInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
end

#function_versions(sid = :unset) ⇒ FunctionVersionList, FunctionVersionContext

Access the function_versions

Returns:

Raises:

  • (ArgumentError) 


222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 222

def function_versions(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return FunctionVersionContext.new(@version, @solution[:service_sid], @solution[:sid], sid, )
  end

  unless @function_versions
    @function_versions = FunctionVersionList.new(
        @version,
        service_sid: @solution[:service_sid],
        function_sid: @solution[:sid],
    )
  end

  @function_versions
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



249
250
251
252
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 249

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Serverless.V1.FunctionContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



242
243
244
245
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 242

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Serverless.V1.FunctionContext #{context}>"
end

#update(friendly_name: nil) ⇒ FunctionInstance

Update the FunctionInstance

Parameters:

  • friendly_name (String) (defaults to: nil) —

    The friendly_name

Returns:



206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/function.rb', line 206

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

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  FunctionInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
end