twilio-ruby 7.3.3 → 7.10.1

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

@@ -25,6 +25,7 @@ module Twilio
                     # @return [FlexFlowList] FlexFlowList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/FlexFlows"
@@ -92,6 +93,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.create('POST', @uri, data: data, headers: headers)
                         FlexFlowInstance.new(
                             @version,
@@ -99,6 +104,85 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the FlexFlowInstanceMetadata
+                    # @param [String] friendly_name A descriptive string that you create to describe the Flex Flow resource.
+                    # @param [String] chat_service_sid The SID of the chat service.
+                    # @param [ChannelType] channel_type 
+                    # @param [String] contact_identity The channel contact's Identity.
+                    # @param [Boolean] enabled Whether the new Flex Flow is enabled.
+                    # @param [IntegrationType] integration_type 
+                    # @param [String] integration_flow_sid The SID of the Studio Flow. Required when `integrationType` is `studio`.
+                    # @param [String] integration_url The URL of the external webhook. Required when `integrationType` is `external`.
+                    # @param [String] integration_workspace_sid The Workspace SID for a new Task. Required when `integrationType` is `task`.
+                    # @param [String] integration_workflow_sid The Workflow SID for a new Task. Required when `integrationType` is `task`.
+                    # @param [String] integration_channel The Task Channel SID (TCXXXX) or unique name (e.g., `sms`) to use for the Task that will be created. Applicable and required when `integrationType` is `task`. The default value is `default`.
+                    # @param [String] integration_timeout The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`, not applicable otherwise.
+                    # @param [String] integration_priority The Task priority of a new Task. The default priority is 0. Optional when `integrationType` is `task`, not applicable otherwise.
+                    # @param [Boolean] integration_creation_on_message In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only applicable for outbound messaging.
+                    # @param [Boolean] long_lived When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to `false`.
+                    # @param [Boolean] janitor_enabled When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to `false`.
+                    # @param [String] integration_retry_count The number of times to retry the Studio Flow or webhook in case of failure. Takes integer values from 0 to 3 with the default being 3. Optional when `integrationType` is `studio` or `external`, not applicable otherwise.
+                    # @return [FlexFlowInstance] Created FlexFlowInstance
+                    def create_with_metadata(
+                      friendly_name: nil, 
+                      chat_service_sid: nil, 
+                      channel_type: nil, 
+                      contact_identity: :unset, 
+                      enabled: :unset, 
+                      integration_type: :unset, 
+                      integration_flow_sid: :unset, 
+                      integration_url: :unset, 
+                      integration_workspace_sid: :unset, 
+                      integration_workflow_sid: :unset, 
+                      integration_channel: :unset, 
+                      integration_timeout: :unset, 
+                      integration_priority: :unset, 
+                      integration_creation_on_message: :unset, 
+                      long_lived: :unset, 
+                      janitor_enabled: :unset, 
+                      integration_retry_count: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'ChatServiceSid' => chat_service_sid,
+                            'ChannelType' => channel_type,
+                            'ContactIdentity' => contact_identity,
+                            'Enabled' => enabled,
+                            'IntegrationType' => integration_type,
+                            'Integration.FlowSid' => integration_flow_sid,
+                            'Integration.Url' => integration_url,
+                            'Integration.WorkspaceSid' => integration_workspace_sid,
+                            'Integration.WorkflowSid' => integration_workflow_sid,
+                            'Integration.Channel' => integration_channel,
+                            'Integration.Timeout' => integration_timeout,
+                            'Integration.Priority' => integration_priority,
+                            'Integration.CreationOnMessage' => integration_creation_on_message,
+                            'LongLived' => long_lived,
+                            'JanitorEnabled' => janitor_enabled,
+                            'Integration.RetryCount' => integration_retry_count,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        flex_flow_instance = FlexFlowInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        FlexFlowInstanceMetadata.new(
+                            @version,
+                            flex_flow_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists FlexFlowInstance records from the API as a list.
@@ -142,6 +226,30 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists FlexFlowPageMetadata records from the API as a list.
+                      # @param [String] friendly_name The `friendly_name` of the Flex Flow resources to read.
+                    # @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(friendly_name: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        FlexFlowPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields FlexFlowInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -164,15 +272,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 FlexFlowInstance
-                    def page(friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(friendly_name: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'FriendlyName' => friendly_name,
                             '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)
 
                         FlexFlowPage.new(@version, response, @solution)
                     end
@@ -207,6 +318,7 @@ module Twilio
                     # @return [FlexFlowContext] FlexFlowContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -221,9 +333,31 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the FlexFlowInstanceMetadata
+                    # @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)
+                          flexFlow_instance = FlexFlowInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          FlexFlowInstanceMetadata.new(@version, flexFlow_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the FlexFlowInstance
                     # @return [FlexFlowInstance] Fetched FlexFlowInstance
@@ -231,6 +365,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.fetch('GET', @uri, headers: headers)
                         FlexFlowInstance.new(
                             @version,
@@ -239,6 +377,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the FlexFlowInstanceMetadata
+                    # @return [FlexFlowInstance] Fetched FlexFlowInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        flex_flow_instance = FlexFlowInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        FlexFlowInstanceMetadata.new(
+                            @version,
+                            flex_flow_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the FlexFlowInstance
                     # @param [String] friendly_name A descriptive string that you create to describe the Flex Flow resource.
@@ -301,6 +464,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.update('POST', @uri, data: data, headers: headers)
                         FlexFlowInstance.new(
                             @version,
@@ -309,6 +476,86 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the FlexFlowInstanceMetadata
+                    # @param [String] friendly_name A descriptive string that you create to describe the Flex Flow resource.
+                    # @param [String] chat_service_sid The SID of the chat service.
+                    # @param [ChannelType] channel_type 
+                    # @param [String] contact_identity The channel contact's Identity.
+                    # @param [Boolean] enabled Whether the new Flex Flow is enabled.
+                    # @param [IntegrationType] integration_type 
+                    # @param [String] integration_flow_sid The SID of the Studio Flow. Required when `integrationType` is `studio`.
+                    # @param [String] integration_url The URL of the external webhook. Required when `integrationType` is `external`.
+                    # @param [String] integration_workspace_sid The Workspace SID for a new Task. Required when `integrationType` is `task`.
+                    # @param [String] integration_workflow_sid The Workflow SID for a new Task. Required when `integrationType` is `task`.
+                    # @param [String] integration_channel The Task Channel SID (TCXXXX) or unique name (e.g., `sms`) to use for the Task that will be created. Applicable and required when `integrationType` is `task`. The default value is `default`.
+                    # @param [String] integration_timeout The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`, not applicable otherwise.
+                    # @param [String] integration_priority The Task priority of a new Task. The default priority is 0. Optional when `integrationType` is `task`, not applicable otherwise.
+                    # @param [Boolean] integration_creation_on_message In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only applicable for outbound messaging.
+                    # @param [Boolean] long_lived When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to `false`.
+                    # @param [Boolean] janitor_enabled When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to `false`.
+                    # @param [String] integration_retry_count The number of times to retry the Studio Flow or webhook in case of failure. Takes integer values from 0 to 3 with the default being 3. Optional when `integrationType` is `studio` or `external`, not applicable otherwise.
+                    # @return [FlexFlowInstance] Updated FlexFlowInstance
+                    def update_with_metadata(
+                      friendly_name: :unset, 
+                      chat_service_sid: :unset, 
+                      channel_type: :unset, 
+                      contact_identity: :unset, 
+                      enabled: :unset, 
+                      integration_type: :unset, 
+                      integration_flow_sid: :unset, 
+                      integration_url: :unset, 
+                      integration_workspace_sid: :unset, 
+                      integration_workflow_sid: :unset, 
+                      integration_channel: :unset, 
+                      integration_timeout: :unset, 
+                      integration_priority: :unset, 
+                      integration_creation_on_message: :unset, 
+                      long_lived: :unset, 
+                      janitor_enabled: :unset, 
+                      integration_retry_count: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'ChatServiceSid' => chat_service_sid,
+                            'ChannelType' => channel_type,
+                            'ContactIdentity' => contact_identity,
+                            'Enabled' => enabled,
+                            'IntegrationType' => integration_type,
+                            'Integration.FlowSid' => integration_flow_sid,
+                            'Integration.Url' => integration_url,
+                            'Integration.WorkspaceSid' => integration_workspace_sid,
+                            'Integration.WorkflowSid' => integration_workflow_sid,
+                            'Integration.Channel' => integration_channel,
+                            'Integration.Timeout' => integration_timeout,
+                            'Integration.Priority' => integration_priority,
+                            'Integration.CreationOnMessage' => integration_creation_on_message,
+                            'LongLived' => long_lived,
+                            'JanitorEnabled' => janitor_enabled,
+                            'Integration.RetryCount' => integration_retry_count,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        flex_flow_instance = FlexFlowInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        FlexFlowInstanceMetadata.new(
+                            @version,
+                            flex_flow_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -325,6 +572,53 @@ module Twilio
                     end
                 end
 
+                class FlexFlowInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new FlexFlowInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}FlexFlowInstance] flex_flow_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 [FlexFlowInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, flex_flow_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @flex_flow_instance = flex_flow_instance
+                    end
+
+                    def flex_flow
+                        @flex_flow_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.FlexFlowInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class FlexFlowListResponse < InstanceListResource
+                    # @param [Array<FlexFlowInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @flex_flow_instance = payload.body[key].map do |data|
+                        FlexFlowInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def flex_flow_instance
+                          @instance
+                      end
+                  end
+
                 class FlexFlowPage < Page
                     ##
                     # Initialize the FlexFlowPage
@@ -334,6 +628,7 @@ module Twilio
                     # @return [FlexFlowPage] FlexFlowPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -353,6 +648,66 @@ module Twilio
                         '<Twilio.FlexApi.V1.FlexFlowPage>'
                     end
                 end
+
+                class FlexFlowPageMetadata < PageMetadata
+                    attr_reader :flex_flow_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @flex_flow_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @flex_flow_page << FlexFlowListResponse.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
+                        @flex_flow_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::FlexApi::V1PageMetadata>';
+                    end
+                end
+                class FlexFlowListResponse < InstanceListResource
+
+                    # @param [Array<FlexFlowInstance>] 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
+                      @flex_flow = data_list.map do |data|
+                        FlexFlowInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def flex_flow
+                        @flex_flow
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class FlexFlowInstance < InstanceResource
                     ##
                     # Initialize the FlexFlowInstance
@@ -366,6 +721,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],