twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb

@@ -21,12 +21,14 @@ module Twilio
                 class ChannelContext < InstanceContext
 
                      class WebhookList < ListResource
+                
                     ##
                     # Initialize the WebhookList
                     # @param [Version] version Version that contains the resource
                     # @return [WebhookList] WebhookList
                     def initialize(version, service_sid: nil, channel_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { service_sid: service_sid, channel_sid: channel_sid }
                         @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Webhooks"
@@ -43,13 +45,13 @@ module Twilio
                     # @param [String] configuration_retry_count The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0.
                     # @return [WebhookInstance] Created WebhookInstance
                     def create(
-                        type: nil, 
-                        configuration_url: :unset, 
-                        configuration_method: :unset, 
-                        configuration_filters: :unset, 
-                        configuration_triggers: :unset, 
-                        configuration_flow_sid: :unset, 
-                        configuration_retry_count: :unset
+                      type: nil, 
+                      configuration_url: :unset, 
+                      configuration_method: :unset, 
+                      configuration_filters: :unset, 
+                      configuration_triggers: :unset, 
+                      configuration_flow_sid: :unset, 
+                      configuration_retry_count: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -62,7 +64,13 @@ module Twilio
                             'Configuration.RetryCount' => configuration_retry_count,
                         })
 
-                        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)
                         WebhookInstance.new(
                             @version,
                             payload,
@@ -71,6 +79,57 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the WebhookInstanceMetadata
+                    # @param [Type] type 
+                    # @param [String] configuration_url The URL of the webhook to call using the `configuration.method`.
+                    # @param [Method] configuration_method 
+                    # @param [Array[String]] configuration_filters The events that cause us to call the Channel Webhook. Used when `type` is `webhook`. This parameter takes only one event. To specify more than one event, repeat this parameter for each event. For the list of possible events, see [Webhook Event Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger).
+                    # @param [Array[String]] configuration_triggers A string that will cause us to call the webhook when it is present in a message body. This parameter takes only one trigger string. To specify more than one, repeat this parameter for each trigger string up to a total of 5 trigger strings. Used only when `type` = `trigger`.
+                    # @param [String] configuration_flow_sid The SID of the Studio [Flow](https://www.twilio.com/docs/studio/rest-api/flow) to call when an event in `configuration.filters` occurs. Used only when `type` is `studio`.
+                    # @param [String] configuration_retry_count The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0.
+                    # @return [WebhookInstance] Created WebhookInstance
+                    def create_with_metadata(
+                      type: nil, 
+                      configuration_url: :unset, 
+                      configuration_method: :unset, 
+                      configuration_filters: :unset, 
+                      configuration_triggers: :unset, 
+                      configuration_flow_sid: :unset, 
+                      configuration_retry_count: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Type' => type,
+                            'Configuration.Url' => configuration_url,
+                            'Configuration.Method' => configuration_method,
+                            'Configuration.Filters' => Twilio.serialize_list(configuration_filters) { |e| e },
+                            'Configuration.Triggers' => Twilio.serialize_list(configuration_triggers) { |e| e },
+                            'Configuration.FlowSid' => configuration_flow_sid,
+                            'Configuration.RetryCount' => configuration_retry_count,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        webhook_instance = WebhookInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            channel_sid: @solution[:channel_sid],
+                        )
+                        WebhookInstanceMetadata.new(
+                            @version,
+                            webhook_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists WebhookInstance records from the API as a list.
@@ -107,7 +166,33 @@ module Twilio
                         page = self.page(
                             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 WebhookPageMetadata 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)
+
+                        WebhookPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -119,9 +204,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
 
                     ##
@@ -131,14 +220,17 @@ 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 WebhookInstance
-                    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,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         WebhookPage.new(@version, response, @solution)
                     end
@@ -175,6 +267,7 @@ module Twilio
                     # @return [WebhookContext] WebhookContext
                     def initialize(version, service_sid, channel_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { service_sid: service_sid, channel_sid: channel_sid, sid: sid,  }
@@ -187,7 +280,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 WebhookInstanceMetadata
+                    # @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)
+                          webhook_instance = WebhookInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          WebhookInstanceMetadata.new(@version, webhook_instance, response.headers, response.status_code)
                     end
 
                     ##
@@ -195,7 +312,13 @@ module Twilio
                     # @return [WebhookInstance] Fetched WebhookInstance
                     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)
                         WebhookInstance.new(
                             @version,
                             payload,
@@ -205,6 +328,33 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the WebhookInstanceMetadata
+                    # @return [WebhookInstance] Fetched WebhookInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        webhook_instance = WebhookInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            channel_sid: @solution[:channel_sid],
+                            sid: @solution[:sid],
+                        )
+                        WebhookInstanceMetadata.new(
+                            @version,
+                            webhook_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the WebhookInstance
                     # @param [String] configuration_url The URL of the webhook to call using the `configuration.method`.
@@ -215,12 +365,12 @@ module Twilio
                     # @param [String] configuration_retry_count The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0.
                     # @return [WebhookInstance] Updated WebhookInstance
                     def update(
-                        configuration_url: :unset, 
-                        configuration_method: :unset, 
-                        configuration_filters: :unset, 
-                        configuration_triggers: :unset, 
-                        configuration_flow_sid: :unset, 
-                        configuration_retry_count: :unset
+                      configuration_url: :unset, 
+                      configuration_method: :unset, 
+                      configuration_filters: :unset, 
+                      configuration_triggers: :unset, 
+                      configuration_flow_sid: :unset, 
+                      configuration_retry_count: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -232,7 +382,13 @@ module Twilio
                             'Configuration.RetryCount' => configuration_retry_count,
                         })
 
-                        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)
                         WebhookInstance.new(
                             @version,
                             payload,
@@ -242,6 +398,55 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the WebhookInstanceMetadata
+                    # @param [String] configuration_url The URL of the webhook to call using the `configuration.method`.
+                    # @param [Method] configuration_method 
+                    # @param [Array[String]] configuration_filters The events that cause us to call the Channel Webhook. Used when `type` is `webhook`. This parameter takes only one event. To specify more than one event, repeat this parameter for each event. For the list of possible events, see [Webhook Event Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger).
+                    # @param [Array[String]] configuration_triggers A string that will cause us to call the webhook when it is present in a message body. This parameter takes only one trigger string. To specify more than one, repeat this parameter for each trigger string up to a total of 5 trigger strings. Used only when `type` = `trigger`.
+                    # @param [String] configuration_flow_sid The SID of the Studio [Flow](https://www.twilio.com/docs/studio/rest-api/flow) to call when an event in `configuration.filters` occurs. Used only when `type` = `studio`.
+                    # @param [String] configuration_retry_count The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0.
+                    # @return [WebhookInstance] Updated WebhookInstance
+                    def update_with_metadata(
+                      configuration_url: :unset, 
+                      configuration_method: :unset, 
+                      configuration_filters: :unset, 
+                      configuration_triggers: :unset, 
+                      configuration_flow_sid: :unset, 
+                      configuration_retry_count: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Configuration.Url' => configuration_url,
+                            'Configuration.Method' => configuration_method,
+                            'Configuration.Filters' => Twilio.serialize_list(configuration_filters) { |e| e },
+                            'Configuration.Triggers' => Twilio.serialize_list(configuration_triggers) { |e| e },
+                            'Configuration.FlowSid' => configuration_flow_sid,
+                            'Configuration.RetryCount' => configuration_retry_count,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        webhook_instance = WebhookInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            channel_sid: @solution[:channel_sid],
+                            sid: @solution[:sid],
+                        )
+                        WebhookInstanceMetadata.new(
+                            @version,
+                            webhook_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -258,6 +463,53 @@ module Twilio
                     end
                 end
 
+                class WebhookInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new WebhookInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}WebhookInstance] webhook_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 [WebhookInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, webhook_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @webhook_instance = webhook_instance
+                    end
+
+                    def webhook
+                        @webhook_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.WebhookInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class WebhookListResponse < InstanceListResource
+                    # @param [Array<WebhookInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @webhook_instance = payload.body[key].map do |data|
+                        WebhookInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def webhook_instance
+                          @instance
+                      end
+                  end
+
                 class WebhookPage < Page
                     ##
                     # Initialize the WebhookPage
@@ -267,6 +519,7 @@ module Twilio
                     # @return [WebhookPage] WebhookPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -286,6 +539,66 @@ module Twilio
                         '<Twilio.Chat.V2.WebhookPage>'
                     end
                 end
+
+                class WebhookPageMetadata < PageMetadata
+                    attr_reader :webhook_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @webhook_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @webhook_page << WebhookListResponse.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
+                        @webhook_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Chat::V2PageMetadata>';
+                    end
+                end
+                class WebhookListResponse < InstanceListResource
+
+                    # @param [Array<WebhookInstance>] 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
+                      @webhook = data_list.map do |data|
+                        WebhookInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def webhook
+                        @webhook
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class WebhookInstance < InstanceResource
                     ##
                     # Initialize the WebhookInstance
@@ -299,6 +612,7 @@ module Twilio
                     def initialize(version, payload , service_sid: nil, channel_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -408,12 +722,12 @@ module Twilio
                     # @param [String] configuration_retry_count The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0.
                     # @return [WebhookInstance] Updated WebhookInstance
                     def update(
-                        configuration_url: :unset, 
-                        configuration_method: :unset, 
-                        configuration_filters: :unset, 
-                        configuration_triggers: :unset, 
-                        configuration_flow_sid: :unset, 
-                        configuration_retry_count: :unset
+                      configuration_url: :unset, 
+                      configuration_method: :unset, 
+                      configuration_filters: :unset, 
+                      configuration_triggers: :unset, 
+                      configuration_flow_sid: :unset, 
+                      configuration_retry_count: :unset
                     )
 
                         context.update(