twilio-ruby 7.9.1 → 7.10.0

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

@@ -25,6 +25,7 @@ module Twilio
                     # @return [SinkList] SinkList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Sinks"
@@ -61,6 +62,43 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the SinkInstanceMetadata
+                    # @param [String] description A human readable description for the Sink **This value should not contain PII.**
+                    # @param [Object] sink_configuration The information required for Twilio to connect to the provided Sink encoded as JSON.
+                    # @param [SinkType] sink_type 
+                    # @return [SinkInstance] Created SinkInstance
+                    def create_with_metadata(
+                      description: nil, 
+                      sink_configuration: nil, 
+                      sink_type: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'Description' => description,
+                            'SinkConfiguration' => Twilio.serialize_object(sink_configuration),
+                            'SinkType' => sink_type,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        sink_instance = SinkInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        SinkInstanceMetadata.new(
+                            @version,
+                            sink_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists SinkInstance records from the API as a list.
@@ -108,6 +146,32 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists SinkPageMetadata records from the API as a list.
+                      # @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
+                    #    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(in_use: :unset, status: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'InUse' => in_use,
+                            'Status' => status,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        SinkPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields SinkInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -131,7 +195,7 @@ 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 SinkInstance
-                    def page(in_use: :unset, status: :unset, 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,
@@ -178,6 +242,7 @@ module Twilio
                     # @return [SinkContext] SinkContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -196,9 +261,29 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the SinkInstanceMetadata
+                    # @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)
+                          sink_instance = SinkInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          SinkInstanceMetadata.new(@version, sink_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the SinkInstance
                     # @return [SinkInstance] Fetched SinkInstance
@@ -218,6 +303,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the SinkInstanceMetadata
+                    # @return [SinkInstance] Fetched SinkInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        sink_instance = SinkInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        SinkInstanceMetadata.new(
+                            @version,
+                            sink_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the SinkInstance
                     # @param [String] description A human readable description for the Sink **This value should not contain PII.**
@@ -244,6 +354,38 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the SinkInstanceMetadata
+                    # @param [String] description A human readable description for the Sink **This value should not contain PII.**
+                    # @return [SinkInstance] Updated SinkInstance
+                    def update_with_metadata(
+                      description: nil
+                    )
+
+                        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)
+                        sink_instance = SinkInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        SinkInstanceMetadata.new(
+                            @version,
+                            sink_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the sink_test
                     # @return [SinkTestList]
@@ -282,6 +424,53 @@ module Twilio
                     end
                 end
 
+                class SinkInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new SinkInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}SinkInstance] sink_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 [SinkInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, sink_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @sink_instance = sink_instance
+                    end
+
+                    def sink
+                        @sink_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.SinkInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class SinkListResponse < InstanceListResource
+                    # @param [Array<SinkInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @sink_instance = payload.body[key].map do |data|
+                        SinkInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def sink_instance
+                          @instance
+                      end
+                  end
+
                 class SinkPage < Page
                     ##
                     # Initialize the SinkPage
@@ -291,6 +480,7 @@ module Twilio
                     # @return [SinkPage] SinkPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -310,6 +500,66 @@ module Twilio
                         '<Twilio.Events.V1.SinkPage>'
                     end
                 end
+
+                class SinkPageMetadata < PageMetadata
+                    attr_reader :sink_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @sink_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @sink_page << SinkListResponse.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
+                        @sink_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Events::V1PageMetadata>';
+                    end
+                end
+                class SinkListResponse < InstanceListResource
+
+                    # @param [Array<SinkInstance>] 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
+                      @sink = data_list.map do |data|
+                        SinkInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def sink
+                        @sink
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class SinkInstance < InstanceResource
                     ##
                     # Initialize the SinkInstance
@@ -323,6 +573,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),

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

@@ -27,6 +27,7 @@ module Twilio
                     # @return [SubscribedEventList] SubscribedEventList
                     def initialize(version, subscription_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { subscription_sid: subscription_sid }
                         @uri = "/Subscriptions/#{@solution[:subscription_sid]}/SubscribedEvents"
@@ -61,6 +62,41 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the SubscribedEventInstanceMetadata
+                    # @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_with_metadata(
+                      type: nil, 
+                      schema_version: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Type' => type,
+                            'SchemaVersion' => schema_version,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        subscribed_event_instance = SubscribedEventInstance.new(
+                            @version,
+                            response.body,
+                            subscription_sid: @solution[:subscription_sid],
+                        )
+                        SubscribedEventInstanceMetadata.new(
+                            @version,
+                            subscribed_event_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists SubscribedEventInstance records from the API as a list.
@@ -100,6 +136,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists SubscribedEventPageMetadata records from the API as a list.
+                    # @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(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        SubscribedEventPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields SubscribedEventInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -121,7 +179,7 @@ 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 SubscribedEventInstance
-                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'PageToken' => page_token,
                             'Page' => page_number,
@@ -167,6 +225,7 @@ module Twilio
                     # @return [SubscribedEventContext] SubscribedEventContext
                     def initialize(version, subscription_sid, type)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { subscription_sid: subscription_sid, type: type,  }
@@ -183,9 +242,29 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the SubscribedEventInstanceMetadata
+                    # @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)
+                          subscribedEvent_instance = SubscribedEventInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          SubscribedEventInstanceMetadata.new(@version, subscribedEvent_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the SubscribedEventInstance
                     # @return [SubscribedEventInstance] Fetched SubscribedEventInstance
@@ -206,6 +285,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the SubscribedEventInstanceMetadata
+                    # @return [SubscribedEventInstance] Fetched SubscribedEventInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        subscribed_event_instance = SubscribedEventInstance.new(
+                            @version,
+                            response.body,
+                            subscription_sid: @solution[:subscription_sid],
+                            type: @solution[:type],
+                        )
+                        SubscribedEventInstanceMetadata.new(
+                            @version,
+                            subscribed_event_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the SubscribedEventInstance
                     # @param [String] schema_version The schema version that the Subscription should use.
@@ -233,6 +338,39 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the SubscribedEventInstanceMetadata
+                    # @param [String] schema_version The schema version that the Subscription should use.
+                    # @return [SubscribedEventInstance] Updated SubscribedEventInstance
+                    def update_with_metadata(
+                      schema_version: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'SchemaVersion' => schema_version,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        subscribed_event_instance = SubscribedEventInstance.new(
+                            @version,
+                            response.body,
+                            subscription_sid: @solution[:subscription_sid],
+                            type: @solution[:type],
+                        )
+                        SubscribedEventInstanceMetadata.new(
+                            @version,
+                            subscribed_event_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -249,6 +387,53 @@ module Twilio
                     end
                 end
 
+                class SubscribedEventInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new SubscribedEventInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}SubscribedEventInstance] subscribed_event_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 [SubscribedEventInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, subscribed_event_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @subscribed_event_instance = subscribed_event_instance
+                    end
+
+                    def subscribed_event
+                        @subscribed_event_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.SubscribedEventInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class SubscribedEventListResponse < InstanceListResource
+                    # @param [Array<SubscribedEventInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @subscribed_event_instance = payload.body[key].map do |data|
+                        SubscribedEventInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def subscribed_event_instance
+                          @instance
+                      end
+                  end
+
                 class SubscribedEventPage < Page
                     ##
                     # Initialize the SubscribedEventPage
@@ -258,6 +443,7 @@ module Twilio
                     # @return [SubscribedEventPage] SubscribedEventPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -277,6 +463,66 @@ module Twilio
                         '<Twilio.Events.V1.SubscribedEventPage>'
                     end
                 end
+
+                class SubscribedEventPageMetadata < PageMetadata
+                    attr_reader :subscribed_event_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @subscribed_event_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @subscribed_event_page << SubscribedEventListResponse.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
+                        @subscribed_event_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Events::V1PageMetadata>';
+                    end
+                end
+                class SubscribedEventListResponse < InstanceListResource
+
+                    # @param [Array<SubscribedEventInstance>] 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
+                      @subscribed_event = data_list.map do |data|
+                        SubscribedEventInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def subscribed_event
+                        @subscribed_event
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class SubscribedEventInstance < InstanceResource
                     ##
                     # Initialize the SubscribedEventInstance
@@ -290,6 +536,7 @@ module Twilio
                     def initialize(version, payload , subscription_sid: nil, type: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],