twilio-ruby 5.40.2 → 5.43.0

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

@@ -29,13 +29,22 @@ module Twilio
       end
 
       ##
-      # @param [String] type The type
+      # @param [String] type A string that uniquely identifies this Event Type.
       # @return [Twilio::REST::Events::V1::EventTypeInstance] if type was passed.
       # @return [Twilio::REST::Events::V1::EventTypeList]
       def event_types(type=:unset)
         self.v1.event_types(type)
       end
 
+      ##
+      # @param [String] id The unique identifier of the schema. Each schema can have
+      #   multiple versions, that share the same id.
+      # @return [Twilio::REST::Events::V1::SchemaInstance] if id was passed.
+      # @return [Twilio::REST::Events::V1::SchemaList]
+      def schemas(id=:unset)
+        self.v1.schemas(id)
+      end
+
       ##
       # @param [String] sid A 34 character string that uniquely identifies this Sink.
       # @return [Twilio::REST::Events::V1::SinkInstance] if sid was passed.

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

@@ -16,12 +16,13 @@ module Twilio
           super
           @version = 'v1'
           @event_types = nil
+          @schemas = nil
           @sinks = nil
           @subscriptions = nil
         end
 
         ##
-        # @param [String] type The type
+        # @param [String] type A string that uniquely identifies this Event Type.
         # @return [Twilio::REST::Events::V1::EventTypeContext] if type was passed.
         # @return [Twilio::REST::Events::V1::EventTypeList]
         def event_types(type=:unset)
@@ -34,6 +35,21 @@ module Twilio
           end
         end
 
+        ##
+        # @param [String] id The unique identifier of the schema. Each schema can have
+        #   multiple versions, that share the same id.
+        # @return [Twilio::REST::Events::V1::SchemaContext] if id was passed.
+        # @return [Twilio::REST::Events::V1::SchemaList]
+        def schemas(id=:unset)
+          if id.nil?
+            raise ArgumentError, 'id cannot be nil'
+          elsif id == :unset
+            @schemas ||= SchemaList.new self
+          else
+            SchemaContext.new(self, id)
+          end
+        end
+
         ##
         # @param [String] sid A 34 character string that uniquely identifies this Sink.
         # @return [Twilio::REST::Events::V1::SinkContext] if sid was passed.

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

@@ -149,7 +149,7 @@ module Twilio
           ##
           # Initialize the EventTypeContext
           # @param [Version] version Version that contains the resource
-          # @param [String] type The type
+          # @param [String] type A string that uniquely identifies this Event Type.
           # @return [EventTypeContext] EventTypeContext
           def initialize(version, type)
             super(version)
@@ -190,7 +190,7 @@ module Twilio
           # Initialize the EventTypeInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] type The type
+          # @param [String] type A string that uniquely identifies this Event Type.
           # @return [EventTypeInstance] EventTypeInstance
           def initialize(version, payload, type: nil)
             super(version)
@@ -223,37 +223,37 @@ module Twilio
           end
 
           ##
-          # @return [String] The type
+          # @return [String] The Event Type identifier.
           def type
             @properties['type']
           end
 
           ##
-          # @return [String] The schema_id
+          # @return [String] The Schema identifier for this Event Type.
           def schema_id
             @properties['schema_id']
           end
 
           ##
-          # @return [Time] The date_created
+          # @return [Time] The date this Event Type was created.
           def date_created
             @properties['date_created']
           end
 
           ##
-          # @return [Time] The date_updated
+          # @return [Time] The date this Event Type was updated.
           def date_updated
             @properties['date_updated']
           end
 
           ##
-          # @return [String] The description
+          # @return [String] Event Type description.
           def description
             @properties['description']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The URL of this resource.
           def url
             @properties['url']
           end

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

@@ -0,0 +1,226 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Events < Domain
+      class V1 < Version
+        ##
+        # 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 SchemaList < ListResource
+          ##
+          # Initialize the SchemaList
+          # @param [Version] version Version that contains the resource
+          # @return [SchemaList] SchemaList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Events.V1.SchemaList>'
+          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 SchemaPage < Page
+          ##
+          # Initialize the SchemaPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [SchemaPage] SchemaPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of SchemaInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [SchemaInstance] SchemaInstance
+          def get_instance(payload)
+            SchemaInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Events.V1.SchemaPage>'
+          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 SchemaContext < InstanceContext
+          ##
+          # Initialize the SchemaContext
+          # @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 [SchemaContext] SchemaContext
+          def initialize(version, id)
+            super(version)
+
+            # Path Solution
+            @solution = {id: id, }
+            @uri = "/Schemas/#{@solution[:id]}"
+
+            # Dependents
+            @versions = nil
+          end
+
+          ##
+          # Fetch the SchemaInstance
+          # @return [SchemaInstance] Fetched SchemaInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            SchemaInstance.new(@version, payload, id: @solution[:id], )
+          end
+
+          ##
+          # Access the versions
+          # @return [VersionList]
+          # @return [VersionContext] if schema_version was passed.
+          def versions(schema_version=:unset)
+            raise ArgumentError, 'schema_version cannot be nil' if schema_version.nil?
+
+            if schema_version != :unset
+              return VersionContext.new(@version, @solution[:id], schema_version, )
+            end
+
+            unless @versions
+              @versions = VersionList.new(@version, id: @solution[:id], )
+            end
+
+            @versions
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Events.V1.SchemaContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Events.V1.SchemaContext #{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 SchemaInstance < InstanceResource
+          ##
+          # Initialize the SchemaInstance
+          # @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.
+          # @return [SchemaInstance] SchemaInstance
+          def initialize(version, payload, id: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'id' => payload['id'],
+                'url' => payload['url'],
+                'links' => payload['links'],
+                'last_created' => Twilio.deserialize_iso8601_datetime(payload['last_created']),
+                'last_version' => payload['last_version'].to_i,
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'id' => id || @properties['id'], }
+          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 [SchemaContext] SchemaContext for this SchemaInstance
+          def context
+            unless @instance_context
+              @instance_context = SchemaContext.new(@version, @params['id'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] Schema Identifier.
+          def id
+            @properties['id']
+          end
+
+          ##
+          # @return [String] The URL of this resource.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # @return [String] Nested resource URLs.
+          def links
+            @properties['links']
+          end
+
+          ##
+          # @return [Time] The date that the last schema version was created.
+          def last_created
+            @properties['last_created']
+          end
+
+          ##
+          # @return [String] Last schema version.
+          def last_version
+            @properties['last_version']
+          end
+
+          ##
+          # Fetch the SchemaInstance
+          # @return [SchemaInstance] Fetched SchemaInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Access the versions
+          # @return [versions] versions
+          def versions
+            context.versions
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Events.V1.SchemaInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Events.V1.SchemaInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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