twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/flex_api/v1/web_channel.rb

@@ -18,12 +18,14 @@ module Twilio
         class FlexApi < FlexApiBase
             class V1 < Version
                 class WebChannelList < ListResource
+                
                     ##
                     # Initialize the WebChannelList
                     # @param [Version] version Version that contains the resource
                     # @return [WebChannelList] WebChannelList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/WebChannels"
@@ -39,12 +41,12 @@ module Twilio
                     # @param [String] pre_engagement_data The pre-engagement data.
                     # @return [WebChannelInstance] Created WebChannelInstance
                     def create(
-                        flex_flow_sid: nil, 
-                        identity: nil, 
-                        customer_friendly_name: nil, 
-                        chat_friendly_name: nil, 
-                        chat_unique_name: :unset, 
-                        pre_engagement_data: :unset
+                      flex_flow_sid: nil, 
+                      identity: nil, 
+                      customer_friendly_name: nil, 
+                      chat_friendly_name: nil, 
+                      chat_unique_name: :unset, 
+                      pre_engagement_data: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -56,13 +58,65 @@ module Twilio
                             'PreEngagementData' => pre_engagement_data,
                         })
 
-                        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)
                         WebChannelInstance.new(
                             @version,
                             payload,
                         )
                     end
 
+                    ##
+                    # Create the WebChannelInstanceMetadata
+                    # @param [String] flex_flow_sid The SID of the Flex Flow.
+                    # @param [String] identity The chat identity.
+                    # @param [String] customer_friendly_name The chat participant's friendly name.
+                    # @param [String] chat_friendly_name The chat channel's friendly name.
+                    # @param [String] chat_unique_name The chat channel's unique name.
+                    # @param [String] pre_engagement_data The pre-engagement data.
+                    # @return [WebChannelInstance] Created WebChannelInstance
+                    def create_with_metadata(
+                      flex_flow_sid: nil, 
+                      identity: nil, 
+                      customer_friendly_name: nil, 
+                      chat_friendly_name: nil, 
+                      chat_unique_name: :unset, 
+                      pre_engagement_data: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FlexFlowSid' => flex_flow_sid,
+                            'Identity' => identity,
+                            'CustomerFriendlyName' => customer_friendly_name,
+                            'ChatFriendlyName' => chat_friendly_name,
+                            'ChatUniqueName' => chat_unique_name,
+                            'PreEngagementData' => pre_engagement_data,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        web_channel_instance = WebChannelInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        WebChannelInstanceMetadata.new(
+                            @version,
+                            web_channel_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists WebChannelInstance records from the API as a list.
@@ -99,7 +153,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 WebChannelPageMetadata 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)
+
+                        WebChannelPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -111,9 +191,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
 
                     ##
@@ -123,14 +207,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 WebChannelInstance
-                    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)
 
                         WebChannelPage.new(@version, response, @solution)
                     end
@@ -165,6 +252,7 @@ module Twilio
                     # @return [WebChannelContext] WebChannelContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -177,7 +265,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 WebChannelInstanceMetadata
+                    # @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)
+                          webChannel_instance = WebChannelInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          WebChannelInstanceMetadata.new(@version, webChannel_instance, response.headers, response.status_code)
                     end
 
                     ##
@@ -185,7 +297,13 @@ module Twilio
                     # @return [WebChannelInstance] Fetched WebChannelInstance
                     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)
                         WebChannelInstance.new(
                             @version,
                             payload,
@@ -193,14 +311,39 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the WebChannelInstanceMetadata
+                    # @return [WebChannelInstance] Fetched WebChannelInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        web_channel_instance = WebChannelInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        WebChannelInstanceMetadata.new(
+                            @version,
+                            web_channel_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the WebChannelInstance
                     # @param [ChatStatus] chat_status 
                     # @param [String] post_engagement_data The post-engagement data.
                     # @return [WebChannelInstance] Updated WebChannelInstance
                     def update(
-                        chat_status: :unset, 
-                        post_engagement_data: :unset
+                      chat_status: :unset, 
+                      post_engagement_data: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -208,7 +351,13 @@ module Twilio
                             'PostEngagementData' => post_engagement_data,
                         })
 
-                        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)
                         WebChannelInstance.new(
                             @version,
                             payload,
@@ -216,6 +365,41 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the WebChannelInstanceMetadata
+                    # @param [ChatStatus] chat_status 
+                    # @param [String] post_engagement_data The post-engagement data.
+                    # @return [WebChannelInstance] Updated WebChannelInstance
+                    def update_with_metadata(
+                      chat_status: :unset, 
+                      post_engagement_data: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'ChatStatus' => chat_status,
+                            'PostEngagementData' => post_engagement_data,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        web_channel_instance = WebChannelInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        WebChannelInstanceMetadata.new(
+                            @version,
+                            web_channel_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -232,6 +416,53 @@ module Twilio
                     end
                 end
 
+                class WebChannelInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new WebChannelInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}WebChannelInstance] web_channel_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 [WebChannelInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, web_channel_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @web_channel_instance = web_channel_instance
+                    end
+
+                    def web_channel
+                        @web_channel_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.WebChannelInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class WebChannelListResponse < InstanceListResource
+                    # @param [Array<WebChannelInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @web_channel_instance = payload.body[key].map do |data|
+                        WebChannelInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def web_channel_instance
+                          @instance
+                      end
+                  end
+
                 class WebChannelPage < Page
                     ##
                     # Initialize the WebChannelPage
@@ -241,6 +472,7 @@ module Twilio
                     # @return [WebChannelPage] WebChannelPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -260,6 +492,66 @@ module Twilio
                         '<Twilio.FlexApi.V1.WebChannelPage>'
                     end
                 end
+
+                class WebChannelPageMetadata < PageMetadata
+                    attr_reader :web_channel_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @web_channel_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @web_channel_page << WebChannelListResponse.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
+                        @web_channel_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::FlexApi::V1PageMetadata>';
+                    end
+                end
+                class WebChannelListResponse < InstanceListResource
+
+                    # @param [Array<WebChannelInstance>] 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
+                      @web_channel = data_list.map do |data|
+                        WebChannelInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def web_channel
+                        @web_channel
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class WebChannelInstance < InstanceResource
                     ##
                     # Initialize the WebChannelInstance
@@ -273,6 +565,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],
@@ -357,8 +650,8 @@ module Twilio
                     # @param [String] post_engagement_data The post-engagement data.
                     # @return [WebChannelInstance] Updated WebChannelInstance
                     def update(
-                        chat_status: :unset, 
-                        post_engagement_data: :unset
+                      chat_status: :unset, 
+                      post_engagement_data: :unset
                     )
 
                         context.update(

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

@@ -36,6 +36,13 @@ module Twilio
                     @insights_settings_comment = nil
                     @insights_user_roles = nil
                     @interaction = nil
+                    @plugins = nil
+                    @plugin_archive = nil
+                    @plugin_configurations = nil
+                    @plugin_configuration_archive = nil
+                    @plugin_releases = nil
+                    @plugin_version_archive = nil
+                    @provisioning_status = nil
                     @web_channel = nil
                 end
 
@@ -47,6 +54,7 @@ module Twilio
                     if assessment_sid.nil?
                         raise ArgumentError, 'assessment_sid cannot be nil'
                     end
+
                     if assessment_sid == :unset
                         @assessments ||= AssessmentsList.new self
                     else
@@ -61,6 +69,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @channel ||= ChannelList.new self
                     else
@@ -80,6 +89,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @flex_flow ||= FlexFlowList.new self
                     else
@@ -104,6 +114,7 @@ module Twilio
                     if questionnaire_sid.nil?
                         raise ArgumentError, 'questionnaire_sid cannot be nil'
                     end
+
                     if questionnaire_sid == :unset
                         @insights_questionnaires ||= InsightsQuestionnairesList.new self
                     else
@@ -118,6 +129,7 @@ module Twilio
                     if category_sid.nil?
                         raise ArgumentError, 'category_sid cannot be nil'
                     end
+
                     if category_sid == :unset
                         @insights_questionnaires_category ||= InsightsQuestionnairesCategoryList.new self
                     else
@@ -132,6 +144,7 @@ module Twilio
                     if question_sid.nil?
                         raise ArgumentError, 'question_sid cannot be nil'
                     end
+
                     if question_sid == :unset
                         @insights_questionnaires_question ||= InsightsQuestionnairesQuestionList.new self
                     else
@@ -171,6 +184,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @interaction ||= InteractionList.new self
                     else
@@ -178,6 +192,128 @@ module Twilio
                     end
                 end
                 ##
+                # @param [String] sid The SID of the Flex Plugin resource to fetch.
+                # @return [Twilio::REST::FlexApi::V1::PluginContext] if sid was passed.
+                # @return [Twilio::REST::FlexApi::V1::PluginList]
+                def plugins(sid=:unset)
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+
+                    if sid == :unset
+                        @plugins ||= PluginList.new self
+                    else
+                        PluginContext.new(self, sid)
+                    end
+                end
+                ##
+                # @param [String] sid The SID of the Flex Plugin resource to archive.
+                # @return [Twilio::REST::FlexApi::V1::PluginArchiveContext] if sid was passed.
+                # @return [Twilio::REST::FlexApi::V1::PluginArchiveList]
+                def plugin_archive(sid=:unset)
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+
+                    if sid == :unset
+                        @plugin_archive ||= PluginArchiveList.new self
+                    else
+                        PluginArchiveContext.new(self, sid)
+                    end
+                end
+                ##
+                # @param [String] sid The SID of the Flex Plugin Configuration resource to fetch.
+                # @return [Twilio::REST::FlexApi::V1::PluginConfigurationContext] if sid was passed.
+                # @return [Twilio::REST::FlexApi::V1::PluginConfigurationList]
+                def plugin_configurations(sid=:unset)
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+
+                    if sid == :unset
+                        @plugin_configurations ||= PluginConfigurationList.new self
+                    else
+                        PluginConfigurationContext.new(self, sid)
+                    end
+                end
+                ##
+                # @param [String] sid The SID of the Flex Plugin Configuration resource to archive.
+                # @return [Twilio::REST::FlexApi::V1::PluginConfigurationArchiveContext] if sid was passed.
+                # @return [Twilio::REST::FlexApi::V1::PluginConfigurationArchiveList]
+                def plugin_configuration_archive(sid=:unset)
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+
+                    if sid == :unset
+                        @plugin_configuration_archive ||= PluginConfigurationArchiveList.new self
+                    else
+                        PluginConfigurationArchiveContext.new(self, sid)
+                    end
+                end
+                ##
+                # @param [String] sid The SID of the Flex Plugin Release resource to fetch.
+                # @return [Twilio::REST::FlexApi::V1::PluginReleaseContext] if sid was passed.
+                # @return [Twilio::REST::FlexApi::V1::PluginReleaseList]
+                def plugin_releases(sid=:unset)
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+
+                    if sid == :unset
+                        @plugin_releases ||= PluginReleaseList.new self
+                    else
+                        PluginReleaseContext.new(self, sid)
+                    end
+                end
+                ##
+                # @param [String] plugin_sid The SID of the Flex Plugin the resource to belongs to.
+                # @param [String] sid The SID of the Flex Plugin Version resource to archive.
+                # @return [Twilio::REST::FlexApi::V1::PluginVersionArchiveContext] if pluginSid was passed.
+                # @return [Twilio::REST::FlexApi::V1::PluginVersionArchiveList]
+                def plugin_version_archive(plugin_sid=:unset, sid=:unset)
+                    if plugin_sid.nil?
+                        raise ArgumentError, 'plugin_sid cannot be nil'
+                    end
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+
+                    if plugin_sid == :unset && sid == :unset
+                        @plugin_version_archive ||= PluginVersionArchiveList.new self
+                    elsif plugin_sid != :unset && sid == :unset
+                        PluginVersionArchiveList.new(self, plugin_sid: plugin_sid)
+                    else
+                        PluginVersionArchiveContext.new(self, plugin_sid, sid)
+                    end
+                end
+                ##
+                # @param [String] plugin_sid The SID of the Flex Plugin the resource to belongs to.
+                # @param [String] sid The SID of the Flex Plugin Version resource to archive.
+                # @return [Twilio::REST::FlexApi::V1::PluginVersionArchiveContext] if sid was passed.
+                # @return [Twilio::REST::FlexApi::V1::PluginVersionArchiveList]
+                def plugin_version_archive(plugin_sid=:unset, sid=:unset)
+                    if plugin_sid.nil?
+                        raise ArgumentError, 'plugin_sid cannot be nil'
+                    end
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+
+                    if plugin_sid == :unset && sid == :unset
+                        @plugin_version_archive ||= PluginVersionArchiveList.new self
+                    elsif plugin_sid != :unset && sid == :unset
+                        PluginVersionArchiveList.new(self, plugin_sid: plugin_sid)
+                    else
+                        PluginVersionArchiveContext.new(self, plugin_sid, sid)
+                    end
+                end
+                ##
+                # @return [Twilio::REST::FlexApi::V1::provisioningStatusContext]
+                def provisioning_status
+                    @provisioning_status ||= ProvisioningStatusContext.new self
+                end
+                ##
                 # @param [String] sid The SID of the WebChannel resource to fetch.
                 # @return [Twilio::REST::FlexApi::V1::WebChannelContext] if sid was passed.
                 # @return [Twilio::REST::FlexApi::V1::WebChannelList]
@@ -185,6 +321,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @web_channel ||= WebChannelList.new self
                     else