twilio-ruby 5.19.0 → 5.77.0

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

@@ -0,0 +1,298 @@
+##
+# 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 beta products that are subject to change. Use them with caution.
+        class EventTypeList < ListResource
+          ##
+          # Initialize the EventTypeList
+          # @param [Version] version Version that contains the resource
+          # @return [EventTypeList] EventTypeList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Types"
+          end
+
+          ##
+          # Lists EventTypeInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @param [String] schema_id A string parameter filtering the results to return
+          #   only the Event Types using a given schema.
+          # @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(schema_id: :unset, limit: nil, page_size: nil)
+            self.stream(schema_id: schema_id, limit: limit, page_size: page_size).entries
+          end
+
+          ##
+          # Streams EventTypeInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @param [String] schema_id A string parameter filtering the results to return
+          #   only the Event Types using a given schema.
+          # @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(schema_id: :unset, limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(schema_id: schema_id, page_size: limits[:page_size], )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields EventTypeInstance 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 EventTypeInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] schema_id A string parameter filtering the results to return
+          #   only the Event Types using a given schema.
+          # @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 EventTypeInstance
+          def page(schema_id: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'SchemaId' => schema_id,
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+
+            response = @version.page('GET', @uri, params: params)
+
+            EventTypePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of EventTypeInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of EventTypeInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            EventTypePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Events.V1.EventTypeList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class EventTypePage < Page
+          ##
+          # Initialize the EventTypePage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [EventTypePage] EventTypePage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of EventTypeInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [EventTypeInstance] EventTypeInstance
+          def get_instance(payload)
+            EventTypeInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Events.V1.EventTypePage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class EventTypeContext < InstanceContext
+          ##
+          # Initialize the EventTypeContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] type A string that uniquely identifies this Event Type.
+          # @return [EventTypeContext] EventTypeContext
+          def initialize(version, type)
+            super(version)
+
+            # Path Solution
+            @solution = {type: type, }
+            @uri = "/Types/#{@solution[:type]}"
+          end
+
+          ##
+          # Fetch the EventTypeInstance
+          # @return [EventTypeInstance] Fetched EventTypeInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            EventTypeInstance.new(@version, payload, type: @solution[:type], )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Events.V1.EventTypeContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Events.V1.EventTypeContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class EventTypeInstance < InstanceResource
+          ##
+          # Initialize the EventTypeInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] type A string that uniquely identifies this Event Type.
+          # @return [EventTypeInstance] EventTypeInstance
+          def initialize(version, payload, type: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'type' => payload['type'],
+                'schema_id' => payload['schema_id'],
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                'description' => payload['description'],
+                'url' => payload['url'],
+                'links' => payload['links'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'type' => type || @properties['type'], }
+          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 [EventTypeContext] EventTypeContext for this EventTypeInstance
+          def context
+            unless @instance_context
+              @instance_context = EventTypeContext.new(@version, @params['type'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The Event Type identifier.
+          def type
+            @properties['type']
+          end
+
+          ##
+          # @return [String] The Schema identifier for this Event Type.
+          def schema_id
+            @properties['schema_id']
+          end
+
+          ##
+          # @return [Time] The date this Event Type was created.
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # @return [Time] The date this Event Type was updated.
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # @return [String] Event Type description.
+          def description
+            @properties['description']
+          end
+
+          ##
+          # @return [String] The URL of this resource.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # @return [String] The links
+          def links
+            @properties['links']
+          end
+
+          ##
+          # Fetch the EventTypeInstance
+          # @return [EventTypeInstance] Fetched EventTypeInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Events.V1.EventTypeInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Events.V1.EventTypeInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/{fax/v1/fax/fax_media.rb → events/v1/schema/version.rb}

@@ -3,33 +3,33 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
   module REST
-    class Fax < Domain
+    class Events < Domain
       class V1 < Version
-        class FaxContext < InstanceContext
+        class SchemaContext < InstanceContext
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class FaxMediaList < ListResource
+          class SchemaVersionList < ListResource
             ##
-            # Initialize the FaxMediaList
+            # Initialize the SchemaVersionList
             # @param [Version] version Version that contains the resource
-            # @param [String] fax_sid The unique SID identifier of the fax for which this
-            #   media is associated.
-            # @return [FaxMediaList] FaxMediaList
-            def initialize(version, fax_sid: nil)
+            # @param [String] id The unique identifier of the schema. Each schema can have
+            #   multiple versions, that share the same id.
+            # @return [SchemaVersionList] SchemaVersionList
+            def initialize(version, id: nil)
               super(version)
 
               # Path Solution
-              @solution = {fax_sid: fax_sid}
-              @uri = "/Faxes/#{@solution[:fax_sid]}/Media"
+              @solution = {id: id}
+              @uri = "/Schemas/#{@solution[:id]}/Versions"
             end
 
             ##
-            # Lists FaxMediaInstance records from the API as a list.
+            # Lists SchemaVersionInstance 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()
@@ -44,7 +44,7 @@ module Twilio
             end
 
             ##
-            # Streams FaxMediaInstance records from the API as an Enumerable.
+            # Streams SchemaVersionInstance 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()
@@ -63,7 +63,7 @@ module Twilio
             end
 
             ##
-            # When passed a block, yields FaxMediaInstance records from the API.
+            # When passed a block, yields SchemaVersionInstance records from the API.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
             def each
@@ -77,55 +77,53 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of FaxMediaInstance records from the API.
+            # Retrieve a single page of SchemaVersionInstance 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 FaxMediaInstance
+            # @return [Page] Page of SchemaVersionInstance
             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
-              )
-              FaxMediaPage.new(@version, response, @solution)
+
+              response = @version.page('GET', @uri, params: params)
+
+              SchemaVersionPage.new(@version, response, @solution)
             end
 
             ##
-            # Retrieve a single page of FaxMediaInstance records from the API.
+            # Retrieve a single page of SchemaVersionInstance records from the API.
             # Request is executed immediately.
             # @param [String] target_url API-generated URL for the requested results page
-            # @return [Page] Page of FaxMediaInstance
+            # @return [Page] Page of SchemaVersionInstance
             def get_page(target_url)
               response = @version.domain.request(
                   'GET',
                   target_url
               )
-              FaxMediaPage.new(@version, response, @solution)
+              SchemaVersionPage.new(@version, response, @solution)
             end
 
             ##
             # Provide a user friendly representation
             def to_s
-              '#<Twilio.Fax.V1.FaxMediaList>'
+              '#<Twilio.Events.V1.SchemaVersionList>'
             end
           end
 
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class FaxMediaPage < Page
+          class SchemaVersionPage < Page
             ##
-            # Initialize the FaxMediaPage
+            # Initialize the SchemaVersionPage
             # @param [Version] version Version that contains the resource
             # @param [Response] response Response from the API
             # @param [Hash] solution Path solution for the resource
-            # @return [FaxMediaPage] FaxMediaPage
+            # @return [SchemaVersionPage] SchemaVersionPage
             def initialize(version, response, solution)
               super(version, response)
 
@@ -134,178 +132,155 @@ module Twilio
             end
 
             ##
-            # Build an instance of FaxMediaInstance
+            # Build an instance of SchemaVersionInstance
             # @param [Hash] payload Payload response from the API
-            # @return [FaxMediaInstance] FaxMediaInstance
+            # @return [SchemaVersionInstance] SchemaVersionInstance
             def get_instance(payload)
-              FaxMediaInstance.new(@version, payload, fax_sid: @solution[:fax_sid], )
+              SchemaVersionInstance.new(@version, payload, id: @solution[:id], )
             end
 
             ##
             # Provide a user friendly representation
             def to_s
-              '<Twilio.Fax.V1.FaxMediaPage>'
+              '<Twilio.Events.V1.SchemaVersionPage>'
             end
           end
 
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class FaxMediaContext < InstanceContext
+          class SchemaVersionContext < InstanceContext
             ##
-            # Initialize the FaxMediaContext
+            # Initialize the SchemaVersionContext
             # @param [Version] version Version that contains the resource
-            # @param [String] fax_sid The unique SID identifier of the fax.
-            # @param [String] sid A 34 character string that uniquely identifies this fax
-            #   media.
-            # @return [FaxMediaContext] FaxMediaContext
-            def initialize(version, fax_sid, sid)
+            # @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 [SchemaVersionContext] SchemaVersionContext
+            def initialize(version, id, schema_version)
               super(version)
 
               # Path Solution
-              @solution = {fax_sid: fax_sid, sid: sid, }
-              @uri = "/Faxes/#{@solution[:fax_sid]}/Media/#{@solution[:sid]}"
+              @solution = {id: id, schema_version: schema_version, }
+              @uri = "/Schemas/#{@solution[:id]}/Versions/#{@solution[:schema_version]}"
             end
 
             ##
-            # Fetch a FaxMediaInstance
-            # @return [FaxMediaInstance] Fetched FaxMediaInstance
+            # Fetch the SchemaVersionInstance
+            # @return [SchemaVersionInstance] Fetched SchemaVersionInstance
             def fetch
-              params = Twilio::Values.of({})
+              payload = @version.fetch('GET', @uri)
 
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
+              SchemaVersionInstance.new(
+                  @version,
+                  payload,
+                  id: @solution[:id],
+                  schema_version: @solution[:schema_version],
               )
-
-              FaxMediaInstance.new(@version, payload, fax_sid: @solution[:fax_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the FaxMediaInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
-            def delete
-              @version.delete('delete', @uri)
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Events.V1.SchemaVersionContext #{context}>"
             end
 
             ##
-            # Provide a user friendly representation
-            def to_s
+            # Provide a detailed, user friendly representation
+            def inspect
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-              "#<Twilio.Fax.V1.FaxMediaContext #{context}>"
+              "#<Twilio.Events.V1.SchemaVersionContext #{context}>"
             end
           end
 
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class FaxMediaInstance < InstanceResource
+          class SchemaVersionInstance < InstanceResource
             ##
-            # Initialize the FaxMediaInstance
+            # Initialize the SchemaVersionInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] fax_sid The unique SID identifier of the fax for which this
-            #   media is associated.
-            # @param [String] sid A 34 character string that uniquely identifies this fax
-            #   media.
-            # @return [FaxMediaInstance] FaxMediaInstance
-            def initialize(version, payload, fax_sid: nil, sid: nil)
+            # @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 [SchemaVersionInstance] SchemaVersionInstance
+            def initialize(version, payload, id: nil, schema_version: nil)
               super(version)
 
               # Marshaled Properties
               @properties = {
-                  'sid' => payload['sid'],
-                  'account_sid' => payload['account_sid'],
-                  'fax_sid' => payload['fax_sid'],
-                  'content_type' => payload['content_type'],
+                  'id' => payload['id'],
+                  'schema_version' => payload['schema_version'] == nil ? payload['schema_version'] : payload['schema_version'].to_i,
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
-                  'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                   'url' => payload['url'],
+                  'raw' => payload['raw'],
               }
 
               # Context
               @instance_context = nil
-              @params = {'fax_sid' => fax_sid, 'sid' => sid || @properties['sid'], }
+              @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 [FaxMediaContext] FaxMediaContext for this FaxMediaInstance
+            # @return [SchemaVersionContext] SchemaVersionContext for this SchemaVersionInstance
             def context
               unless @instance_context
-                @instance_context = FaxMediaContext.new(@version, @params['fax_sid'], @params['sid'], )
+                @instance_context = SchemaVersionContext.new(@version, @params['id'], @params['schema_version'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] A string that uniquely identifies this fax media
-            def sid
-              @properties['sid']
+            # @return [String] The unique identifier of the schema.
+            def id
+              @properties['id']
             end
 
             ##
-            # @return [String] Account SID
-            def account_sid
-              @properties['account_sid']
+            # @return [String] The version of this schema.
+            def schema_version
+              @properties['schema_version']
             end
 
             ##
-            # @return [String] Fax SID
-            def fax_sid
-              @properties['fax_sid']
-            end
-
-            ##
-            # @return [String] Media content type
-            def content_type
-              @properties['content_type']
-            end
-
-            ##
-            # @return [Time] The date this fax media was created
+            # @return [Time] The date the schema version was created.
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date this fax media was updated
-            def date_updated
-              @properties['date_updated']
-            end
-
-            ##
-            # @return [String] The URL of this resource
+            # @return [String] The URL of this resource.
             def url
               @properties['url']
             end
 
             ##
-            # Fetch a FaxMediaInstance
-            # @return [FaxMediaInstance] Fetched FaxMediaInstance
-            def fetch
-              context.fetch
+            # @return [String] The raw
+            def raw
+              @properties['raw']
             end
 
             ##
-            # Deletes the FaxMediaInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
-            def delete
-              context.delete
+            # Fetch the SchemaVersionInstance
+            # @return [SchemaVersionInstance] Fetched SchemaVersionInstance
+            def fetch
+              context.fetch
             end
 
             ##
             # Provide a user friendly representation
             def to_s
               values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Fax.V1.FaxMediaInstance #{values}>"
+              "<Twilio.Events.V1.SchemaVersionInstance #{values}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
               values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Fax.V1.FaxMediaInstance #{values}>"
+              "<Twilio.Events.V1.SchemaVersionInstance #{values}>"
             end
           end
         end