twilio-ruby 6.8.0 → 7.10.7

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

@@ -18,12 +18,14 @@ module Twilio
         class Events < EventsBase
             class V1 < Version
                 class SubscriptionList < ListResource
+                
                     ##
                     # Initialize the SubscriptionList
                     # @param [Version] version Version that contains the resource
                     # @return [SubscriptionList] SubscriptionList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Subscriptions"
@@ -36,9 +38,9 @@ module Twilio
                     # @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
+                      description: nil, 
+                      sink_sid: nil, 
+                      types: nil
                     )
 
                         data = Twilio::Values.of({
@@ -47,13 +49,56 @@ module Twilio
                             'Types' => Twilio.serialize_list(types) { |e| Twilio.serialize_object(e) },
                         })
 
-                        payload = @version.create('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
                         SubscriptionInstance.new(
                             @version,
                             payload,
                         )
                     end
 
+                    ##
+                    # Create the SubscriptionInstanceMetadata
+                    # @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 [Array[Hash]] types An array of objects containing the subscribed Event Types
+                    # @return [SubscriptionInstance] Created SubscriptionInstance
+                    def create_with_metadata(
+                      description: nil, 
+                      sink_sid: nil, 
+                      types: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'Description' => description,
+                            'SinkSid' => sink_sid,
+                            'Types' => Twilio.serialize_list(types) { |e| Twilio.serialize_object(e) },
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        subscription_instance = SubscriptionInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        SubscriptionInstanceMetadata.new(
+                            @version,
+                            subscription_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists SubscriptionInstance records from the API as a list.
@@ -94,7 +139,35 @@ module Twilio
                             sink_sid: sink_sid,
                             page_size: limits[:page_size], )
 
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # Lists SubscriptionPageMetadata records from the API as a list.
+                      # @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
+                    #    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_with_metadata(sink_sid: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'SinkSid' => sink_sid,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        SubscriptionPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -106,9 +179,13 @@ module Twilio
 
                         page = self.page(page_size: limits[:page_size], )
 
-                        @version.stream(page,
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
                             limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
                     end
 
                     ##
@@ -119,15 +196,18 @@ module Twilio
                     # @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(sink_sid: :unset, 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,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         SubscriptionPage.new(@version, response, @solution)
                     end
@@ -154,8 +234,6 @@ module Twilio
                 end
 
 
-                ##
-                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
                 class SubscriptionContext < InstanceContext
                     ##
                     # Initialize the SubscriptionContext
@@ -164,6 +242,7 @@ module Twilio
                     # @return [SubscriptionContext] SubscriptionContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -177,7 +256,31 @@ module Twilio
                     # @return [Boolean] True if delete succeeds, false otherwise
                     def delete
 
-                        @version.delete('DELETE', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+
+                        @version.delete('DELETE', @uri, headers: headers)
+                    end
+
+                    ##
+                    # Delete the SubscriptionInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          subscription_instance = SubscriptionInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          SubscriptionInstanceMetadata.new(@version, subscription_instance, response.headers, response.status_code)
                     end
 
                     ##
@@ -185,7 +288,13 @@ module Twilio
                     # @return [SubscriptionInstance] Fetched SubscriptionInstance
                     def fetch
 
-                        payload = @version.fetch('GET', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
                         SubscriptionInstance.new(
                             @version,
                             payload,
@@ -193,22 +302,50 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the SubscriptionInstanceMetadata
+                    # @return [SubscriptionInstance] Fetched SubscriptionInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        subscription_instance = SubscriptionInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        SubscriptionInstanceMetadata.new(
+                            @version,
+                            subscription_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    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
+                      description: :unset
                     )
 
                         data = Twilio::Values.of({
                             'Description' => description,
-                            'SinkSid' => sink_sid,
                         })
 
-                        payload = @version.update('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, data: data, headers: headers)
                         SubscriptionInstance.new(
                             @version,
                             payload,
@@ -216,6 +353,38 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the SubscriptionInstanceMetadata
+                    # @param [String] description A human readable description for the Subscription.
+                    # @return [SubscriptionInstance] Updated SubscriptionInstance
+                    def update_with_metadata(
+                      description: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Description' => description,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        subscription_instance = SubscriptionInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        SubscriptionInstanceMetadata.new(
+                            @version,
+                            subscription_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the subscribed_events
                     # @return [SubscribedEventList]
@@ -251,6 +420,53 @@ module Twilio
                     end
                 end
 
+                class SubscriptionInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new SubscriptionInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}SubscriptionInstance] subscription_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [SubscriptionInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, subscription_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @subscription_instance = subscription_instance
+                    end
+
+                    def subscription
+                        @subscription_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.SubscriptionInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class SubscriptionListResponse < InstanceListResource
+                    # @param [Array<SubscriptionInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @subscription_instance = payload.body[key].map do |data|
+                        SubscriptionInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def subscription_instance
+                          @instance
+                      end
+                  end
+
                 class SubscriptionPage < Page
                     ##
                     # Initialize the SubscriptionPage
@@ -260,6 +476,7 @@ module Twilio
                     # @return [SubscriptionPage] SubscriptionPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -279,6 +496,66 @@ module Twilio
                         '<Twilio.Events.V1.SubscriptionPage>'
                     end
                 end
+
+                class SubscriptionPageMetadata < PageMetadata
+                    attr_reader :subscription_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @subscription_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @subscription_page << SubscriptionListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @subscription_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Events::V1PageMetadata>';
+                    end
+                end
+                class SubscriptionListResponse < InstanceListResource
+
+                    # @param [Array<SubscriptionInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @subscription = data_list.map do |data|
+                        SubscriptionInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def subscription
+                        @subscription
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class SubscriptionInstance < InstanceResource
                     ##
                     # Initialize the SubscriptionInstance
@@ -292,6 +569,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],
@@ -387,16 +665,13 @@ module Twilio
                     ##
                     # 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
+                      description: :unset
                     )
 
                         context.update(
                             description: description, 
-                            sink_sid: sink_sid, 
                         )
                     end
 

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

@@ -35,6 +35,7 @@ module Twilio
                     if type.nil?
                         raise ArgumentError, 'type cannot be nil'
                     end
+
                     if type == :unset
                         @event_types ||= EventTypeList.new self
                     else
@@ -49,6 +50,7 @@ module Twilio
                     if id.nil?
                         raise ArgumentError, 'id cannot be nil'
                     end
+
                     if id == :unset
                         @schemas ||= SchemaList.new self
                     else
@@ -63,6 +65,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @sinks ||= SinkList.new self
                     else
@@ -77,6 +80,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @subscriptions ||= SubscriptionList.new self
                     else