lib/twilio-ruby/rest/serverless/v1/service/function/function_version.rb in twilio-ruby-5.77.0 vs lib/twilio-ruby/rest/serverless/v1/service/function/function_version.rb in twilio-ruby-6.0.0.pre.rc.1
- old
+ new
@@ -1,364 +1,354 @@
##
-# This code was generated by
-# \ / _ _ _| _ _
-# | (_)\/(_)(_|\/| |(/_ v1.0.0
-# / /
+# This code was generated by
+# ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
+# | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
+# | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
#
-# frozen_string_literal: true
+# Twilio - Serverless
+# This is the public Twilio REST API.
+#
+# NOTE: This class is auto generated by OpenAPI Generator.
+# https://openapi-generator.tech
+# Do not edit the class manually.
+#
+
module Twilio
- module REST
- class Serverless < Domain
- class V1 < Version
- class ServiceContext < InstanceContext
- class FunctionContext < InstanceContext
- ##
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
- class FunctionVersionList < ListResource
- ##
- # Initialize the FunctionVersionList
- # @param [Version] version Version that contains the resource
- # @param [String] service_sid The SID of the Service that the Function Version
- # resource is associated with.
- # @param [String] function_sid The SID of the Function resource that is the parent
- # of the Function Version resource.
- # @return [FunctionVersionList] FunctionVersionList
- def initialize(version, service_sid: nil, function_sid: nil)
- super(version)
+ module REST
+ class Serverless < ServerlessBase
+ class V1 < Version
+ class ServiceContext < InstanceContext
+ class FunctionContext < InstanceContext
- # Path Solution
- @solution = {service_sid: service_sid, function_sid: function_sid}
- @uri = "/Services/#{@solution[:service_sid]}/Functions/#{@solution[:function_sid]}/Versions"
- end
+ class FunctionVersionList < ListResource
+ ##
+ # Initialize the FunctionVersionList
+ # @param [Version] version Version that contains the resource
+ # @return [FunctionVersionList] FunctionVersionList
+ def initialize(version, service_sid: nil, function_sid: nil)
+ super(version)
+ # Path Solution
+ @solution = { service_sid: service_sid, function_sid: function_sid }
+ @uri = "/Services/#{@solution[:service_sid]}/Functions/#{@solution[:function_sid]}/Versions"
+
+ end
+
+ ##
+ # Lists FunctionVersionInstance records from the API as a list.
+ # Unlike stream(), this operation is eager and will load `limit` records into
+ # memory before returning.
+ # @param [Integer] limit Upper limit for the number of records to return. stream()
+ # guarantees to never return more than limit. Default is no limit
+ # @param [Integer] page_size Number of records to fetch per request, when
+ # not set will use the default value of 50 records. If no page_size is defined
+ # but a limit is defined, stream() will attempt to read the limit with the most
+ # efficient page size, i.e. min(limit, 1000)
+ # @return [Array] Array of up to limit results
+ def list(limit: nil, page_size: nil)
+ self.stream(
+ limit: limit,
+ page_size: page_size
+ ).entries
+ end
- ##
- # Lists FunctionVersionInstance records from the API as a list.
- # Unlike stream(), this operation is eager and will load `limit` records into
- # memory before returning.
- # @param [Integer] limit Upper limit for the number of records to return. stream()
- # guarantees to never return more than limit. Default is no limit
- # @param [Integer] page_size Number of records to fetch per request, when
- # not set will use the default value of 50 records. If no page_size is defined
- # but a limit is defined, stream() will attempt to read the limit with the most
- # efficient page size, i.e. min(limit, 1000)
- # @return [Array] Array of up to limit results
- def list(limit: nil, page_size: nil)
- self.stream(limit: limit, page_size: page_size).entries
- end
+ ##
+ # Streams Instance records from the API as an Enumerable.
+ # This operation lazily loads records as efficiently as possible until the limit
+ # is reached.
+ # @param [Integer] limit Upper limit for the number of records to return. stream()
+ # guarantees to never return more than limit. Default is no limit
+ # @param [Integer] page_size Number of records to fetch per request, when
+ # not set will use the default value of 50 records. If no page_size is defined
+ # but a limit is defined, stream() will attempt to read the limit with the most
+ # efficient page size, i.e. min(limit, 1000)
+ # @return [Enumerable] Enumerable that will yield up to limit results
+ def stream(limit: nil, page_size: nil)
+ limits = @version.read_limits(limit, page_size)
- ##
- # Streams FunctionVersionInstance records from the API as an Enumerable.
- # This operation lazily loads records as efficiently as possible until the limit
- # is reached.
- # @param [Integer] limit Upper limit for the number of records to return. stream()
- # guarantees to never return more than limit. Default is no limit.
- # @param [Integer] page_size Number of records to fetch per request, when
- # not set will use the default value of 50 records. If no page_size is defined
- # but a limit is defined, stream() will attempt to read the limit with the most
- # efficient page size, i.e. min(limit, 1000)
- # @return [Enumerable] Enumerable that will yield up to limit results
- def stream(limit: nil, page_size: nil)
- limits = @version.read_limits(limit, page_size)
+ page = self.page(
+ page_size: limits[:page_size], )
- page = self.page(page_size: limits[:page_size], )
+ @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+ end
- @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
- end
+ ##
+ # When passed a block, yields FunctionVersionInstance records from the API.
+ # This operation lazily loads records as efficiently as possible until the limit
+ # is reached.
+ def each
+ limits = @version.read_limits
- ##
- # When passed a block, yields FunctionVersionInstance records from the API.
- # This operation lazily loads records as efficiently as possible until the limit
- # is reached.
- def each
- limits = @version.read_limits
+ page = self.page(page_size: limits[:page_size], )
- page = self.page(page_size: limits[:page_size], )
+ @version.stream(page,
+ limit: limits[:limit],
+ page_limit: limits[:page_limit]).each {|x| yield x}
+ end
- @version.stream(page,
- limit: limits[:limit],
- page_limit: limits[:page_limit]).each {|x| yield x}
- end
+ ##
+ # Retrieve a single page of FunctionVersionInstance records from the API.
+ # Request is executed immediately.
+ # @param [String] page_token PageToken provided by the API
+ # @param [Integer] page_number Page Number, this value is simply for client state
+ # @param [Integer] page_size Number of records to return, defaults to 50
+ # @return [Page] Page of FunctionVersionInstance
+ def page(page_token: :unset, page_number: :unset, page_size: :unset)
+ params = Twilio::Values.of({
+
+ 'PageToken' => page_token,
+ 'Page' => page_number,
+ 'PageSize' => page_size,
+ })
- ##
- # Retrieve a single page of FunctionVersionInstance records from the API.
- # Request is executed immediately.
- # @param [String] page_token PageToken provided by the API
- # @param [Integer] page_number Page Number, this value is simply for client state
- # @param [Integer] page_size Number of records to return, defaults to 50
- # @return [Page] Page of FunctionVersionInstance
- 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)
- response = @version.page('GET', @uri, params: params)
+ FunctionVersionPage.new(@version, response, @solution)
+ end
- FunctionVersionPage.new(@version, response, @solution)
- end
+ ##
+ # Retrieve a single page of FunctionVersionInstance records from the API.
+ # Request is executed immediately.
+ # @param [String] target_url API-generated URL for the requested results page
+ # @return [Page] Page of FunctionVersionInstance
+ def get_page(target_url)
+ response = @version.domain.request(
+ 'GET',
+ target_url
+ )
+ FunctionVersionPage.new(@version, response, @solution)
+ end
+
- ##
- # Retrieve a single page of FunctionVersionInstance records from the API.
- # Request is executed immediately.
- # @param [String] target_url API-generated URL for the requested results page
- # @return [Page] Page of FunctionVersionInstance
- def get_page(target_url)
- response = @version.domain.request(
- 'GET',
- target_url
- )
- FunctionVersionPage.new(@version, response, @solution)
- end
- ##
- # Provide a user friendly representation
- def to_s
- '#<Twilio.Serverless.V1.FunctionVersionList>'
- end
- end
+ # Provide a user friendly representation
+ def to_s
+ '#<Twilio.Serverless.V1.FunctionVersionList>'
+ end
+ end
- ##
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
- class FunctionVersionPage < Page
- ##
- # Initialize the FunctionVersionPage
- # @param [Version] version Version that contains the resource
- # @param [Response] response Response from the API
- # @param [Hash] solution Path solution for the resource
- # @return [FunctionVersionPage] FunctionVersionPage
- def initialize(version, response, solution)
- super(version, response)
- # Path Solution
- @solution = solution
- end
+ ##
+ #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+ class FunctionVersionContext < InstanceContext
+ ##
+ # Initialize the FunctionVersionContext
+ # @param [Version] version Version that contains the resource
+ # @param [String] service_sid The SID of the Service to fetch the Function Version resource from.
+ # @param [String] function_sid The SID of the function that is the parent of the Function Version resource to fetch.
+ # @param [String] sid The SID of the Function Version resource to fetch.
+ # @return [FunctionVersionContext] FunctionVersionContext
+ def initialize(version, service_sid, function_sid, sid)
+ super(version)
- ##
- # Build an instance of FunctionVersionInstance
- # @param [Hash] payload Payload response from the API
- # @return [FunctionVersionInstance] FunctionVersionInstance
- def get_instance(payload)
- FunctionVersionInstance.new(
- @version,
- payload,
- service_sid: @solution[:service_sid],
- function_sid: @solution[:function_sid],
- )
- end
+ # Path Solution
+ @solution = { service_sid: service_sid, function_sid: function_sid, sid: sid, }
+ @uri = "/Services/#{@solution[:service_sid]}/Functions/#{@solution[:function_sid]}/Versions/#{@solution[:sid]}"
- ##
- # Provide a user friendly representation
- def to_s
- '<Twilio.Serverless.V1.FunctionVersionPage>'
- end
- end
+ # Dependents
+ @function_version_content = nil
+ end
+ ##
+ # Fetch the FunctionVersionInstance
+ # @return [FunctionVersionInstance] Fetched FunctionVersionInstance
+ def fetch
- ##
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
- class FunctionVersionContext < InstanceContext
- ##
- # Initialize the FunctionVersionContext
- # @param [Version] version Version that contains the resource
- # @param [String] service_sid The SID of the Service to fetch the Function Version
- # resource from.
- # @param [String] function_sid The SID of the function that is the parent of the
- # Function Version resource to fetch.
- # @param [String] sid The SID of the Function Version resource to fetch.
- # @return [FunctionVersionContext] FunctionVersionContext
- def initialize(version, service_sid, function_sid, sid)
- super(version)
+ payload = @version.fetch('GET', @uri)
+ FunctionVersionInstance.new(
+ @version,
+ payload,
+ service_sid: @solution[:service_sid],
+ function_sid: @solution[:function_sid],
+ sid: @solution[:sid],
+ )
+ end
- # Path Solution
- @solution = {service_sid: service_sid, function_sid: function_sid, sid: sid, }
- @uri = "/Services/#{@solution[:service_sid]}/Functions/#{@solution[:function_sid]}/Versions/#{@solution[:sid]}"
+ ##
+ # Access the function_version_content
+ # @return [FunctionVersionContentList]
+ # @return [FunctionVersionContentContext]
+ def function_version_content
+ FunctionVersionContentContext.new(
+ @version,
+ @solution[:service_sid],
+ @solution[:function_sid],
+ @solution[:sid]
+ )
+ end
- # Dependents
- @function_version_content = nil
- end
+ ##
+ # Provide a user friendly representation
+ def to_s
+ context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+ "#<Twilio.Serverless.V1.FunctionVersionContext #{context}>"
+ end
- ##
- # Fetch the FunctionVersionInstance
- # @return [FunctionVersionInstance] Fetched FunctionVersionInstance
- def fetch
- payload = @version.fetch('GET', @uri)
+ ##
+ # Provide a detailed, user friendly representation
+ def inspect
+ context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+ "#<Twilio.Serverless.V1.FunctionVersionContext #{context}>"
+ end
+ end
- FunctionVersionInstance.new(
- @version,
- payload,
- service_sid: @solution[:service_sid],
- function_sid: @solution[:function_sid],
- sid: @solution[:sid],
- )
- end
+ class FunctionVersionPage < Page
+ ##
+ # Initialize the FunctionVersionPage
+ # @param [Version] version Version that contains the resource
+ # @param [Response] response Response from the API
+ # @param [Hash] solution Path solution for the resource
+ # @return [FunctionVersionPage] FunctionVersionPage
+ def initialize(version, response, solution)
+ super(version, response)
- ##
- # Access the function_version_content
- # @return [FunctionVersionContentList]
- # @return [FunctionVersionContentContext]
- def function_version_content
- FunctionVersionContentContext.new(
- @version,
- @solution[:service_sid],
- @solution[:function_sid],
- @solution[:sid],
- )
- end
+ # Path Solution
+ @solution = solution
+ end
- ##
- # Provide a user friendly representation
- def to_s
- context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
- "#<Twilio.Serverless.V1.FunctionVersionContext #{context}>"
- end
+ ##
+ # Build an instance of FunctionVersionInstance
+ # @param [Hash] payload Payload response from the API
+ # @return [FunctionVersionInstance] FunctionVersionInstance
+ def get_instance(payload)
+ FunctionVersionInstance.new(@version, payload, service_sid: @solution[:service_sid], function_sid: @solution[:function_sid])
+ end
- ##
- # Provide a detailed, user friendly representation
- def inspect
- context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
- "#<Twilio.Serverless.V1.FunctionVersionContext #{context}>"
- end
- end
-
- ##
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
- class FunctionVersionInstance < InstanceResource
- ##
- # Initialize the FunctionVersionInstance
- # @param [Version] version Version that contains the resource
- # @param [Hash] payload payload that contains response from Twilio
- # @param [String] service_sid The SID of the Service that the Function Version
- # resource is associated with.
- # @param [String] function_sid The SID of the Function resource that is the parent
- # of the Function Version resource.
- # @param [String] sid The SID of the Function Version resource to fetch.
- # @return [FunctionVersionInstance] FunctionVersionInstance
- def initialize(version, payload, service_sid: nil, function_sid: nil, sid: nil)
- super(version)
-
- # Marshaled Properties
- @properties = {
- 'sid' => payload['sid'],
- 'account_sid' => payload['account_sid'],
- 'service_sid' => payload['service_sid'],
- 'function_sid' => payload['function_sid'],
- 'path' => payload['path'],
- 'visibility' => payload['visibility'],
- 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
- 'url' => payload['url'],
- 'links' => payload['links'],
- }
-
- # Context
- @instance_context = nil
- @params = {
- 'service_sid' => service_sid,
- 'function_sid' => function_sid,
- 'sid' => sid || @properties['sid'],
- }
- end
-
- ##
- # Generate an instance context for the instance, the context is capable of
- # performing various actions. All instance actions are proxied to the context
- # @return [FunctionVersionContext] FunctionVersionContext for this FunctionVersionInstance
- def context
- unless @instance_context
- @instance_context = FunctionVersionContext.new(
- @version,
- @params['service_sid'],
- @params['function_sid'],
- @params['sid'],
- )
+ ##
+ # Provide a user friendly representation
+ def to_s
+ '<Twilio.Serverless.V1.FunctionVersionPage>'
+ end
end
- @instance_context
- end
+ class FunctionVersionInstance < InstanceResource
+ ##
+ # Initialize the FunctionVersionInstance
+ # @param [Version] version Version that contains the resource
+ # @param [Hash] payload payload that contains response from Twilio
+ # @param [String] account_sid The SID of the
+ # {Account}[https://www.twilio.com/docs/iam/api/account] that created this FunctionVersion
+ # resource.
+ # @param [String] sid The SID of the Call resource to fetch.
+ # @return [FunctionVersionInstance] FunctionVersionInstance
+ def initialize(version, payload , service_sid: nil, function_sid: nil, sid: nil)
+ super(version)
+
+ # Marshaled Properties
+ @properties = {
+ 'sid' => payload['sid'],
+ 'account_sid' => payload['account_sid'],
+ 'service_sid' => payload['service_sid'],
+ 'function_sid' => payload['function_sid'],
+ 'path' => payload['path'],
+ 'visibility' => payload['visibility'],
+ 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+ 'url' => payload['url'],
+ 'links' => payload['links'],
+ }
- ##
- # @return [String] The unique string that identifies the Function Version resource
- def sid
- @properties['sid']
- end
+ # Context
+ @instance_context = nil
+ @params = { 'service_sid' => service_sid || @properties['service_sid'] ,'function_sid' => function_sid || @properties['function_sid'] ,'sid' => sid || @properties['sid'] , }
+ end
- ##
- # @return [String] The SID of the Account that created the Function Version resource
- def account_sid
- @properties['account_sid']
- end
+ ##
+ # Generate an instance context for the instance, the context is capable of
+ # performing various actions. All instance actions are proxied to the context
+ # @return [FunctionVersionContext] CallContext for this CallInstance
+ def context
+ unless @instance_context
+ @instance_context = FunctionVersionContext.new(@version , @params['service_sid'], @params['function_sid'], @params['sid'])
+ end
+ @instance_context
+ end
+
+ ##
+ # @return [String] The unique string that we created to identify the Function Version resource.
+ def sid
+ @properties['sid']
+ end
+
+ ##
+ # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Function Version resource.
+ def account_sid
+ @properties['account_sid']
+ end
+
+ ##
+ # @return [String] The SID of the Service that the Function Version resource is associated with.
+ def service_sid
+ @properties['service_sid']
+ end
+
+ ##
+ # @return [String] The SID of the Function resource that is the parent of the Function Version resource.
+ def function_sid
+ @properties['function_sid']
+ end
+
+ ##
+ # @return [String] The URL-friendly string by which the Function Version resource can be referenced. It can be a maximum of 255 characters. All paths begin with a forward slash ('/'). If a Function Version creation request is submitted with a path not containing a leading slash, the path will automatically be prepended with one.
+ def path
+ @properties['path']
+ end
+
+ ##
+ # @return [Visibility]
+ def visibility
+ @properties['visibility']
+ end
+
+ ##
+ # @return [Time] The date and time in GMT when the Function Version resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+ def date_created
+ @properties['date_created']
+ end
+
+ ##
+ # @return [String] The absolute URL of the Function Version resource.
+ def url
+ @properties['url']
+ end
+
+ ##
+ # @return [Hash]
+ def links
+ @properties['links']
+ end
+
+ ##
+ # Fetch the FunctionVersionInstance
+ # @return [FunctionVersionInstance] Fetched FunctionVersionInstance
+ def fetch
- ##
- # @return [String] The SID of the Service that the Function Version resource is associated with
- def service_sid
- @properties['service_sid']
- end
+ context.fetch
+ end
- ##
- # @return [String] The SID of the Function resource that is the parent of the Function Version resource
- def function_sid
- @properties['function_sid']
- end
+ ##
+ # Access the function_version_content
+ # @return [function_version_content] function_version_content
+ def function_version_content
+ context.function_version_content
+ end
- ##
- # @return [String] The URL-friendly string by which the Function Version resource can be referenced
- def path
- @properties['path']
- end
+ ##
+ # Provide a user friendly representation
+ def to_s
+ values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+ "<Twilio.Serverless.V1.FunctionVersionInstance #{values}>"
+ end
- ##
- # @return [function_version.Visibility] The access control that determines how the Function Version resource can be accessed
- def visibility
- @properties['visibility']
- end
+ ##
+ # Provide a detailed, user friendly representation
+ def inspect
+ values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+ "<Twilio.Serverless.V1.FunctionVersionInstance #{values}>"
+ end
+ end
- ##
- # @return [Time] The ISO 8601 date and time in GMT when the Function Version resource was created
- def date_created
- @properties['date_created']
- end
-
- ##
- # @return [String] The absolute URL of the Function Version resource
- def url
- @properties['url']
- end
-
- ##
- # @return [String] The links
- def links
- @properties['links']
- end
-
- ##
- # Fetch the FunctionVersionInstance
- # @return [FunctionVersionInstance] Fetched FunctionVersionInstance
- def fetch
- context.fetch
- end
-
- ##
- # Access the function_version_content
- # @return [function_version_content] function_version_content
- def function_version_content
- context.function_version_content
- end
-
- ##
- # Provide a user friendly representation
- def to_s
- values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
- "<Twilio.Serverless.V1.FunctionVersionInstance #{values}>"
- end
-
- ##
- # Provide a detailed, user friendly representation
- def inspect
- values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
- "<Twilio.Serverless.V1.FunctionVersionInstance #{values}>"
- end
+ end
+ end
end
- end
end
- end
end
- end
-end
\ No newline at end of file
+end
+
+