twilio-ruby 5.40.0 → 5.41.0

data/lib/twilio-ruby/rest/events/v1/schema/schema_version.rb

@@ -0,0 +1,290 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Events < Domain
+      class V1 < Version
+        class SchemaContext < InstanceContext
+          ##
+          # 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 help@twilio.com.
+          class VersionList < ListResource
+            ##
+            # Initialize the VersionList
+            # @param [Version] version Version that contains the resource
+            # @param [String] id The unique identifier of the schema. Each schema can have
+            #   multiple versions, that share the same id.
+            # @return [VersionList] VersionList
+            def initialize(version, id: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {id: id}
+              @uri = "/Schemas/#{@solution[:id]}/Versions"
+            end
+
+            ##
+            # Lists VersionInstance 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 VersionInstance 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], )
+
+              @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+            end
+
+            ##
+            # When passed a block, yields VersionInstance 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], )
+
+              @version.stream(page,
+                              limit: limits[:limit],
+                              page_limit: limits[:page_limit]).each {|x| yield x}
+            end
+
+            ##
+            # Retrieve a single page of VersionInstance 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 VersionInstance
+            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)
+
+              VersionPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of VersionInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of VersionInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              VersionPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Events.V1.VersionList>'
+            end
+          end
+
+          ##
+          # 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 help@twilio.com.
+          class VersionPage < Page
+            ##
+            # Initialize the VersionPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [VersionPage] VersionPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of VersionInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [VersionInstance] VersionInstance
+            def get_instance(payload)
+              VersionInstance.new(@version, payload, id: @solution[:id], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Events.V1.VersionPage>'
+            end
+          end
+
+          ##
+          # 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 help@twilio.com.
+          class VersionContext < InstanceContext
+            ##
+            # Initialize the VersionContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] id The unique identifier of the schema. Each schema can have
+            #   multiple versions, that share the same id.
+            # @param [String] schema_version The version of the schema
+            # @return [VersionContext] VersionContext
+            def initialize(version, id, schema_version)
+              super(version)
+
+              # Path Solution
+              @solution = {id: id, schema_version: schema_version, }
+              @uri = "/Schemas/#{@solution[:id]}/Versions/#{@solution[:schema_version]}"
+            end
+
+            ##
+            # Fetch the VersionInstance
+            # @return [VersionInstance] Fetched VersionInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              VersionInstance.new(
+                  @version,
+                  payload,
+                  id: @solution[:id],
+                  schema_version: @solution[:schema_version],
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Events.V1.VersionContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Events.V1.VersionContext #{context}>"
+            end
+          end
+
+          ##
+          # 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 help@twilio.com.
+          class VersionInstance < InstanceResource
+            ##
+            # Initialize the VersionInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] id The unique identifier of the schema. Each schema can have
+            #   multiple versions, that share the same id.
+            # @param [String] schema_version The version of the schema
+            # @return [VersionInstance] VersionInstance
+            def initialize(version, payload, id: nil, schema_version: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'id' => payload['id'],
+                  'schema_version' => payload['schema_version'].to_i,
+                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                  'url' => payload['url'],
+                  'raw' => payload['raw'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'id' => id, 'schema_version' => schema_version || @properties['schema_version'], }
+            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 [VersionContext] VersionContext for this VersionInstance
+            def context
+              unless @instance_context
+                @instance_context = VersionContext.new(@version, @params['id'], @params['schema_version'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The unique identifier of the schema.
+            def id
+              @properties['id']
+            end
+
+            ##
+            # @return [String] The version of this schema.
+            def schema_version
+              @properties['schema_version']
+            end
+
+            ##
+            # @return [Time] The date the schema version was created.
+            def date_created
+              @properties['date_created']
+            end
+
+            ##
+            # @return [String] The URL of this resource.
+            def url
+              @properties['url']
+            end
+
+            ##
+            # @return [String] The raw
+            def raw
+              @properties['raw']
+            end
+
+            ##
+            # Fetch the VersionInstance
+            # @return [VersionInstance] Fetched VersionInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Events.V1.VersionInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Events.V1.VersionInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/events/v1/sink.rb

@@ -27,9 +27,10 @@ module Twilio
 
           ##
           # Create the SinkInstance
-          # @param [String] description The description
-          # @param [Hash] sink_configuration The sink_configuration
-          # @param [sink.SinkType] sink_type The sink_type
+          # @param [String] description A human readable description for the Sink
+          # @param [Hash] sink_configuration The information required for Twilio to connect
+          #   to the provided Sink encoded as JSON.
+          # @param [sink.SinkType] sink_type The Sink type. Can only be "kinesis" currently.
           # @return [SinkInstance] Created SinkInstance
           def create(description: nil, sink_configuration: nil, sink_type: nil)
             data = Twilio::Values.of({
@@ -167,7 +168,7 @@ module Twilio
           ##
           # Initialize the SinkContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The sid
+          # @param [String] sid A 34 character string that uniquely identifies this Sink.
           # @return [SinkContext] SinkContext
           def initialize(version, sid)
             super(version)
@@ -243,7 +244,7 @@ module Twilio
           # Initialize the SinkInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid The sid
+          # @param [String] sid A 34 character string that uniquely identifies this Sink.
           # @return [SinkInstance] SinkInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -278,55 +279,55 @@ module Twilio
           end
 
           ##
-          # @return [Time] The date_created
+          # @return [Time] The date this Sink was created
           def date_created
             @properties['date_created']
           end
 
           ##
-          # @return [Time] The date_updated
+          # @return [Time] The date this Sink was updated
           def date_updated
             @properties['date_updated']
           end
 
           ##
-          # @return [String] The description
+          # @return [String] Sink Description
           def description
             @properties['description']
           end
 
           ##
-          # @return [String] The sid
+          # @return [String] A string that uniquely identifies this Sink.
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [Hash] The sink_configuration
+          # @return [Hash] JSON Sink configuration.
           def sink_configuration
             @properties['sink_configuration']
           end
 
           ##
-          # @return [sink.SinkType] The sink_type
+          # @return [sink.SinkType] Sink type.
           def sink_type
             @properties['sink_type']
           end
 
           ##
-          # @return [sink.Status] The status
+          # @return [sink.Status] The Status of this Sink
           def status
             @properties['status']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The URL of this resource.
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The links
+          # @return [String] Nested resource URLs.
           def links
             @properties['links']
           end

data/lib/twilio-ruby/rest/events/v1/sink/sink_test.rb

@@ -17,7 +17,7 @@ module Twilio
             ##
             # Initialize the SinkTestList
             # @param [Version] version Version that contains the resource
-            # @param [String] sid The sid
+            # @param [String] sid A 34 character string that uniquely identifies this Sink.
             # @return [SinkTestList] SinkTestList
             def initialize(version, sid: nil)
               super(version)
@@ -81,7 +81,7 @@ module Twilio
             # Initialize the SinkTestInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] sid The sid
+            # @param [String] sid A 34 character string that uniquely identifies this Sink.
             # @return [SinkTestInstance] SinkTestInstance
             def initialize(version, payload, sid: nil)
               super(version)
@@ -91,7 +91,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The result
+            # @return [String] Feedback indicating whether the test event was generated.
             def result
               @properties['result']
             end

data/lib/twilio-ruby/rest/events/v1/sink/sink_validate.rb

@@ -17,7 +17,7 @@ module Twilio
             ##
             # Initialize the SinkValidateList
             # @param [Version] version Version that contains the resource
-            # @param [String] sid The sid
+            # @param [String] sid A 34 character string that uniquely identifies this Sink.
             # @return [SinkValidateList] SinkValidateList
             def initialize(version, sid: nil)
               super(version)
@@ -29,7 +29,8 @@ module Twilio
 
             ##
             # Create the SinkValidateInstance
-            # @param [String] test_id The test_id
+            # @param [String] test_id A 34 character string that uniquely identifies the test
+            #   event for a Sink being validated.
             # @return [SinkValidateInstance] Created SinkValidateInstance
             def create(test_id: nil)
               data = Twilio::Values.of({'TestId' => test_id, })
@@ -84,7 +85,7 @@ module Twilio
             # Initialize the SinkValidateInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] sid The sid
+            # @param [String] sid A 34 character string that uniquely identifies this Sink.
             # @return [SinkValidateInstance] SinkValidateInstance
             def initialize(version, payload, sid: nil)
               super(version)
@@ -94,7 +95,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The result
+            # @return [String] Feedback indicating whether the given Sink was validated.
             def result
               @properties['result']
             end

data/lib/twilio-ruby/rest/events/v1/subscription.rb

@@ -107,9 +107,12 @@ module Twilio
 
           ##
           # Create the SubscriptionInstance
-          # @param [String] description The description
-          # @param [String] sink_sid The sink_sid
-          # @param [Hash] types The types
+          # @param [String] description A human readable description for the Subscription
+          # @param [String] sink_sid The SID of the sink that events selected by this
+          #   subscription should be sent to. Sink must be active for the subscription to be
+          #   created.
+          # @param [Hash] types Contains a dictionary of URL links to nested resources of
+          #   this Subscription.
           # @return [SubscriptionInstance] Created SubscriptionInstance
           def create(description: nil, sink_sid: nil, types: nil)
             data = Twilio::Values.of({
@@ -167,7 +170,8 @@ module Twilio
           ##
           # Initialize the SubscriptionContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The sid
+          # @param [String] sid A 34 character string that uniquely identifies this
+          #   Subscription.
           # @return [SubscriptionContext] SubscriptionContext
           def initialize(version, sid)
             super(version)
@@ -189,6 +193,21 @@ module Twilio
             SubscriptionInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
+          ##
+          # Update the SubscriptionInstance
+          # @param [String] description A human readable description for the Subscription.
+          # @param [String] sink_sid The SID of the sink that events selected by this
+          #   subscription should be sent to. Sink must be active for the subscription to be
+          #   created.
+          # @return [SubscriptionInstance] Updated SubscriptionInstance
+          def update(description: :unset, sink_sid: :unset)
+            data = Twilio::Values.of({'Description' => description, 'SinkSid' => sink_sid, })
+
+            payload = @version.update('POST', @uri, data: data)
+
+            SubscriptionInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
           ##
           # Delete the SubscriptionInstance
           # @return [Boolean] true if delete succeeds, false otherwise
@@ -199,14 +218,8 @@ module Twilio
           ##
           # Access the subscribed_events
           # @return [SubscribedEventList]
-          # @return [SubscribedEventContext] if type was passed.
-          def subscribed_events(type=:unset)
-            raise ArgumentError, 'type cannot be nil' if type.nil?
-
-            if type != :unset
-              return SubscribedEventContext.new(@version, @solution[:sid], type, )
-            end
-
+          # @return [SubscribedEventContext]
+          def subscribed_events
             unless @subscribed_events
               @subscribed_events = SubscribedEventList.new(@version, subscription_sid: @solution[:sid], )
             end
@@ -236,7 +249,8 @@ module Twilio
           # Initialize the SubscriptionInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid The sid
+          # @param [String] sid A 34 character string that uniquely identifies this
+          #   Subscription.
           # @return [SubscriptionInstance] SubscriptionInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -270,49 +284,49 @@ module Twilio
           end
 
           ##
-          # @return [String] The account_sid
+          # @return [String] Account SID.
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] The sid
+          # @return [String] A string that uniquely identifies this Subscription.
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [Time] The date_created
+          # @return [Time] The date this Subscription was created
           def date_created
             @properties['date_created']
           end
 
           ##
-          # @return [Time] The date_updated
+          # @return [Time] The date this Subscription was updated
           def date_updated
             @properties['date_updated']
           end
 
           ##
-          # @return [String] The description
+          # @return [String] Subscription description
           def description
             @properties['description']
           end
 
           ##
-          # @return [String] The sink_sid
+          # @return [String] Sink SID.
           def sink_sid
             @properties['sink_sid']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The URL of this resource.
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The links
+          # @return [String] Nested resource URLs.
           def links
             @properties['links']
           end
@@ -324,6 +338,17 @@ module Twilio
             context.fetch
           end
 
+          ##
+          # Update the SubscriptionInstance
+          # @param [String] description A human readable description for the Subscription.
+          # @param [String] sink_sid The SID of the sink that events selected by this
+          #   subscription should be sent to. Sink must be active for the subscription to be
+          #   created.
+          # @return [SubscriptionInstance] Updated SubscriptionInstance
+          def update(description: :unset, sink_sid: :unset)
+            context.update(description: description, sink_sid: sink_sid, )
+          end
+
           ##
           # Delete the SubscriptionInstance
           # @return [Boolean] true if delete succeeds, false otherwise