twilio-ruby 5.40.3 → 5.74.1

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

@@ -11,7 +11,7 @@ module Twilio
     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.
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class SinkList < ListResource
           ##
           # Initialize the SinkList
@@ -27,10 +27,12 @@ module Twilio
 
           ##
           # Create the SinkInstance
-          # @param [String] description A human readable description for the Sink
+          # @param [String] description A human readable description for the Sink **This
+          #   value should not contain PII.**
           # @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.
+          # @param [sink.SinkType] sink_type The Sink type. Can only be "kinesis" or
+          #   "webhook" currently.
           # @return [SinkInstance] Created SinkInstance
           def create(description: nil, sink_configuration: nil, sink_type: nil)
             data = Twilio::Values.of({
@@ -48,6 +50,10 @@ module Twilio
           # Lists SinkInstance records from the API as a list.
           # Unlike stream(), this operation is eager and will load `limit` records into
           # memory before returning.
+          # @param [Boolean] in_use A boolean query parameter filtering the results to
+          #   return sinks used/not used by a subscription.
+          # @param [String] status A String query parameter filtering the results by status
+          #   `initialized`, `validating`, `active` or `failed`.
           # @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
@@ -55,14 +61,18 @@ module Twilio
           #    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
+          def list(in_use: :unset, status: :unset, limit: nil, page_size: nil)
+            self.stream(in_use: in_use, status: status, limit: limit, page_size: page_size).entries
           end
 
           ##
           # Streams SinkInstance records from the API as an Enumerable.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
+          # @param [Boolean] in_use A boolean query parameter filtering the results to
+          #   return sinks used/not used by a subscription.
+          # @param [String] status A String query parameter filtering the results by status
+          #   `initialized`, `validating`, `active` or `failed`.
           # @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
@@ -70,10 +80,10 @@ module Twilio
           #    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)
+          def stream(in_use: :unset, status: :unset, limit: nil, page_size: nil)
             limits = @version.read_limits(limit, page_size)
 
-            page = self.page(page_size: limits[:page_size], )
+            page = self.page(in_use: in_use, status: status, page_size: limits[:page_size], )
 
             @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
           end
@@ -95,12 +105,18 @@ module Twilio
           ##
           # Retrieve a single page of SinkInstance records from the API.
           # Request is executed immediately.
+          # @param [Boolean] in_use A boolean query parameter filtering the results to
+          #   return sinks used/not used by a subscription.
+          # @param [String] status A String query parameter filtering the results by status
+          #   `initialized`, `validating`, `active` or `failed`.
           # @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 SinkInstance
-          def page(page_token: :unset, page_number: :unset, page_size: :unset)
+          def page(in_use: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
             params = Twilio::Values.of({
+                'InUse' => in_use,
+                'Status' => status,
                 'PageToken' => page_token,
                 'Page' => page_number,
                 'PageSize' => page_size,
@@ -132,7 +148,7 @@ module Twilio
         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.
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class SinkPage < Page
           ##
           # Initialize the SinkPage
@@ -163,7 +179,7 @@ module Twilio
         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.
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class SinkContext < InstanceContext
           ##
           # Initialize the SinkContext
@@ -198,6 +214,19 @@ module Twilio
              @version.delete('DELETE', @uri)
           end
 
+          ##
+          # Update the SinkInstance
+          # @param [String] description A human readable description for the Sink **This
+          #   value should not contain PII.**
+          # @return [SinkInstance] Updated SinkInstance
+          def update(description: nil)
+            data = Twilio::Values.of({'Description' => description, })
+
+            payload = @version.update('POST', @uri, data: data)
+
+            SinkInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
           ##
           # Access the sink_test
           # @return [SinkTestList]
@@ -238,7 +267,7 @@ module Twilio
         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.
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class SinkInstance < InstanceResource
           ##
           # Initialize the SinkInstance
@@ -346,6 +375,15 @@ module Twilio
             context.delete
           end
 
+          ##
+          # Update the SinkInstance
+          # @param [String] description A human readable description for the Sink **This
+          #   value should not contain PII.**
+          # @return [SinkInstance] Updated SinkInstance
+          def update(description: nil)
+            context.update(description: description, )
+          end
+
           ##
           # Access the sink_test
           # @return [sink_test] sink_test

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

@@ -12,7 +12,7 @@ module Twilio
       class V1 < Version
         class SubscriptionContext < 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.
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class SubscribedEventList < ListResource
             ##
             # Initialize the SubscribedEventList
@@ -107,6 +107,20 @@ module Twilio
               SubscribedEventPage.new(@version, response, @solution)
             end
 
+            ##
+            # Create the SubscribedEventInstance
+            # @param [String] type Type of event being subscribed to.
+            # @param [String] schema_version The schema version that the subscription should
+            #   use.
+            # @return [SubscribedEventInstance] Created SubscribedEventInstance
+            def create(type: nil, schema_version: :unset)
+              data = Twilio::Values.of({'Type' => type, 'SchemaVersion' => schema_version, })
+
+              payload = @version.create('POST', @uri, data: data)
+
+              SubscribedEventInstance.new(@version, payload, subscription_sid: @solution[:subscription_sid], )
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
@@ -115,7 +129,7 @@ module Twilio
           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.
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class SubscribedEventPage < Page
             ##
             # Initialize the SubscribedEventPage
@@ -146,25 +160,116 @@ module Twilio
           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.
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class SubscribedEventContext < InstanceContext
+            ##
+            # Initialize the SubscribedEventContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] subscription_sid The unique SID identifier of the Subscription.
+            # @param [String] type Type of event being subscribed to.
+            # @return [SubscribedEventContext] SubscribedEventContext
+            def initialize(version, subscription_sid, type)
+              super(version)
+
+              # Path Solution
+              @solution = {subscription_sid: subscription_sid, type: type, }
+              @uri = "/Subscriptions/#{@solution[:subscription_sid]}/SubscribedEvents/#{@solution[:type]}"
+            end
+
+            ##
+            # Fetch the SubscribedEventInstance
+            # @return [SubscribedEventInstance] Fetched SubscribedEventInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              SubscribedEventInstance.new(
+                  @version,
+                  payload,
+                  subscription_sid: @solution[:subscription_sid],
+                  type: @solution[:type],
+              )
+            end
+
+            ##
+            # Update the SubscribedEventInstance
+            # @param [String] schema_version The schema version that the subscription should
+            #   use.
+            # @return [SubscribedEventInstance] Updated SubscribedEventInstance
+            def update(schema_version: :unset)
+              data = Twilio::Values.of({'SchemaVersion' => schema_version, })
+
+              payload = @version.update('POST', @uri, data: data)
+
+              SubscribedEventInstance.new(
+                  @version,
+                  payload,
+                  subscription_sid: @solution[:subscription_sid],
+                  type: @solution[:type],
+              )
+            end
+
+            ##
+            # Delete the SubscribedEventInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+               @version.delete('DELETE', @uri)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Events.V1.SubscribedEventContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Events.V1.SubscribedEventContext #{context}>"
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class SubscribedEventInstance < InstanceResource
             ##
             # Initialize the SubscribedEventInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] subscription_sid The unique SID identifier of the Subscription.
+            # @param [String] type Type of event being subscribed to.
             # @return [SubscribedEventInstance] SubscribedEventInstance
-            def initialize(version, payload, subscription_sid: nil)
+            def initialize(version, payload, subscription_sid: nil, type: nil)
               super(version)
 
               # Marshaled Properties
               @properties = {
                   'account_sid' => payload['account_sid'],
                   'type' => payload['type'],
-                  'version' => payload['version'].to_i,
+                  'schema_version' => payload['schema_version'] == nil ? payload['schema_version'] : payload['schema_version'].to_i,
                   'subscription_sid' => payload['subscription_sid'],
                   'url' => payload['url'],
               }
+
+              # Context
+              @instance_context = nil
+              @params = {'subscription_sid' => subscription_sid, '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 [SubscribedEventContext] SubscribedEventContext for this SubscribedEventInstance
+            def context
+              unless @instance_context
+                @instance_context = SubscribedEventContext.new(
+                    @version,
+                    @params['subscription_sid'],
+                    @params['type'],
+                )
+              end
+              @instance_context
             end
 
             ##
@@ -181,8 +286,8 @@ module Twilio
 
             ##
             # @return [String] The schema version that the subscription should use.
-            def version
-              @properties['version']
+            def schema_version
+              @properties['schema_version']
             end
 
             ##
@@ -197,16 +302,41 @@ module Twilio
               @properties['url']
             end
 
+            ##
+            # Fetch the SubscribedEventInstance
+            # @return [SubscribedEventInstance] Fetched SubscribedEventInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Update the SubscribedEventInstance
+            # @param [String] schema_version The schema version that the subscription should
+            #   use.
+            # @return [SubscribedEventInstance] Updated SubscribedEventInstance
+            def update(schema_version: :unset)
+              context.update(schema_version: schema_version, )
+            end
+
+            ##
+            # Delete the SubscribedEventInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+              context.delete
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
-              "<Twilio.Events.V1.SubscribedEventInstance>"
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Events.V1.SubscribedEventInstance #{values}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
-              "<Twilio.Events.V1.SubscribedEventInstance>"
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Events.V1.SubscribedEventInstance #{values}>"
             end
           end
         end

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

@@ -11,7 +11,7 @@ module Twilio
     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.
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class SubscriptionList < ListResource
           ##
           # Initialize the SubscriptionList
@@ -29,6 +29,8 @@ module Twilio
           # Lists SubscriptionInstance records from the API as a list.
           # Unlike stream(), this operation is eager and will load `limit` records into
           # memory before returning.
+          # @param [String] sink_sid The SID of the sink that the list of Subscriptions
+          #   should be filtered by.
           # @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
@@ -36,14 +38,16 @@ module Twilio
           #    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
+          def list(sink_sid: :unset, limit: nil, page_size: nil)
+            self.stream(sink_sid: sink_sid, limit: limit, page_size: page_size).entries
           end
 
           ##
           # Streams SubscriptionInstance records from the API as an Enumerable.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
+          # @param [String] sink_sid The SID of the sink that the list of Subscriptions
+          #   should be filtered by.
           # @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
@@ -51,10 +55,10 @@ module Twilio
           #    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)
+          def stream(sink_sid: :unset, limit: nil, page_size: nil)
             limits = @version.read_limits(limit, page_size)
 
-            page = self.page(page_size: limits[:page_size], )
+            page = self.page(sink_sid: sink_sid, page_size: limits[:page_size], )
 
             @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
           end
@@ -76,12 +80,15 @@ module Twilio
           ##
           # Retrieve a single page of SubscriptionInstance records from the API.
           # Request is executed immediately.
+          # @param [String] sink_sid The SID of the sink that the list of Subscriptions
+          #   should be filtered by.
           # @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 SubscriptionInstance
-          def page(page_token: :unset, page_number: :unset, page_size: :unset)
+          def page(sink_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
             params = Twilio::Values.of({
+                'SinkSid' => sink_sid,
                 'PageToken' => page_token,
                 'Page' => page_number,
                 'PageSize' => page_size,
@@ -108,11 +115,12 @@ module Twilio
           ##
           # Create the SubscriptionInstance
           # @param [String] description A human readable description for the Subscription
+          #   **This value should not contain PII.**
           # @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.
+          # @param [Array[Hash]] types An array of objects containing the subscribed Event
+          #   Types
           # @return [SubscriptionInstance] Created SubscriptionInstance
           def create(description: nil, sink_sid: nil, types: nil)
             data = Twilio::Values.of({
@@ -134,7 +142,7 @@ module Twilio
         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.
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class SubscriptionPage < Page
           ##
           # Initialize the SubscriptionPage
@@ -165,7 +173,7 @@ module Twilio
         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.
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class SubscriptionContext < InstanceContext
           ##
           # Initialize the SubscriptionContext
@@ -218,8 +226,14 @@ module Twilio
           ##
           # Access the subscribed_events
           # @return [SubscribedEventList]
-          # @return [SubscribedEventContext]
-          def subscribed_events
+          # @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
+
             unless @subscribed_events
               @subscribed_events = SubscribedEventList.new(@version, subscription_sid: @solution[:sid], )
             end
@@ -243,7 +257,7 @@ module Twilio
         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.
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class SubscriptionInstance < InstanceResource
           ##
           # Initialize the SubscriptionInstance

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

@@ -27,11 +27,12 @@ module Twilio
         # @return [Twilio::REST::Events::V1::EventTypeList]
         def event_types(type=:unset)
           if type.nil?
-            raise ArgumentError, 'type cannot be nil'
-          elsif type == :unset
-            @event_types ||= EventTypeList.new self
+              raise ArgumentError, 'type cannot be nil'
+          end
+          if type == :unset
+              @event_types ||= EventTypeList.new self
           else
-            EventTypeContext.new(self, type)
+              EventTypeContext.new(self, type)
           end
         end
 
@@ -42,11 +43,12 @@ module Twilio
         # @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
+              raise ArgumentError, 'id cannot be nil'
+          end
+          if id == :unset
+              @schemas ||= SchemaList.new self
           else
-            SchemaContext.new(self, id)
+              SchemaContext.new(self, id)
           end
         end
 
@@ -56,11 +58,12 @@ module Twilio
         # @return [Twilio::REST::Events::V1::SinkList]
         def sinks(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @sinks ||= SinkList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @sinks ||= SinkList.new self
           else
-            SinkContext.new(self, sid)
+              SinkContext.new(self, sid)
           end
         end
 
@@ -71,11 +74,12 @@ module Twilio
         # @return [Twilio::REST::Events::V1::SubscriptionList]
         def subscriptions(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @subscriptions ||= SubscriptionList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @subscriptions ||= SubscriptionList.new self
           else
-            SubscriptionContext.new(self, sid)
+              SubscriptionContext.new(self, sid)
           end
         end