aws-sdk-connectparticipant 1.34.0 → 1.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdabe79c68b6c7d498082d809dc5b21ce7fb9c9ea609138a1c5d51d977154e2d
-  data.tar.gz: 12dac31bf921a85d405b70fb3d542e5b8980aee36e94bfd26879ecfa039ebd11
+  metadata.gz: b1a81f4fb2bd5ffff2551e14f1328df324d33ec14e8d8632e1a97496409f43e8
+  data.tar.gz: '068c6f77e540dab015988883d89d5c1444b839f1a3453a9b03afc6ec001063e5'
 SHA512:
-  metadata.gz: dfc17951ba9c9907adeb1cc413c33275716228f7a96e447a3fb7cbf8b840d40f8d9ce2ec0f98b75fc39a63edc341057747fd7e321c6c85a1bb85da9e7c1eb207
-  data.tar.gz: 56e233e383b8e84d7167ad55f4b9e7d9c102629fcc2c8953ec98dd86b59710bbe55d7b89aa5522f9ebad054049880100cdb282f665c748023a31f0538544d389
+  metadata.gz: ebd0ca28a8ef9132142c3b11bcc7fb1330334d59c9cdec294ba3cf7c201b05f01e73dc6679e36caffa9fce12bd2202fbb15e932d9ad7b66ee290cee182361d9f
+  data.tar.gz: 963eb83bcb48b7b05792167b13fc5c15cfa5f63de93f7b947bb3add58bde806104d4af2b796619188a72a352dd547db7cc23d6040b487019e2a1fa2f5c051916

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.35.0 (2023-08-31)
+------------------
+
+* Feature - Amazon Connect Participant Service adds the ability to get a view resource using a view token, which is provided in a participant message, with the release of the DescribeView API.
+
 1.34.0 (2023-07-11)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.34.0
+1.35.0

data/lib/aws-sdk-connectparticipant/client.rb

@@ -489,8 +489,9 @@ module Aws::ConnectParticipant
     # [4]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
     #
     # @option params [Array<String>] :type
-    #   Type of connection information required. This can be omitted if
-    #   `ConnectParticipant` is `true`.
+    #   Type of connection information required. If you need
+    #   `CONNECTION_CREDENTIALS` along with marking participant as connected,
+    #   pass `CONNECTION_CREDENTIALS` in `Type`.
     #
     # @option params [required, String] :participant_token
     #   This is a header parameter.
@@ -536,6 +537,46 @@ module Aws::ConnectParticipant
       req.send_request(options)
     end
 
+    # Retrieves the view for the specified view token.
+    #
+    # @option params [required, String] :view_token
+    #   An encrypted token originating from the interactive message of a
+    #   ShowView block operation. Represents the desired view.
+    #
+    # @option params [required, String] :connection_token
+    #   The connection token.
+    #
+    # @return [Types::DescribeViewResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribeViewResponse#view #view} => Types::View
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.describe_view({
+    #     view_token: "ViewToken", # required
+    #     connection_token: "ParticipantToken", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.view.id #=> String
+    #   resp.view.arn #=> String
+    #   resp.view.name #=> String
+    #   resp.view.version #=> Integer
+    #   resp.view.content.input_schema #=> String
+    #   resp.view.content.template #=> String
+    #   resp.view.content.actions #=> Array
+    #   resp.view.content.actions[0] #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/DescribeView AWS API Documentation
+    #
+    # @overload describe_view(params = {})
+    # @param [Hash] params ({})
+    def describe_view(params = {}, options = {})
+      req = build_request(:describe_view, params)
+      req.send_request(options)
+    end
+
     # Disconnects a participant.
     #
     # <note markdown="1"> `ConnectionToken` is used for invoking this API instead of
@@ -711,7 +752,7 @@ module Aws::ConnectParticipant
     #   resp.transcript[0].type #=> String, one of "TYPING", "PARTICIPANT_JOINED", "PARTICIPANT_LEFT", "CHAT_ENDED", "TRANSFER_SUCCEEDED", "TRANSFER_FAILED", "MESSAGE", "EVENT", "ATTACHMENT", "CONNECTION_ACK", "MESSAGE_DELIVERED", "MESSAGE_READ"
     #   resp.transcript[0].participant_id #=> String
     #   resp.transcript[0].display_name #=> String
-    #   resp.transcript[0].participant_role #=> String, one of "AGENT", "CUSTOMER", "SYSTEM"
+    #   resp.transcript[0].participant_role #=> String, one of "AGENT", "CUSTOMER", "SYSTEM", "CUSTOM_BOT"
     #   resp.transcript[0].attachments #=> Array
     #   resp.transcript[0].attachments[0].content_type #=> String
     #   resp.transcript[0].attachments[0].attachment_id #=> String
@@ -981,7 +1022,7 @@ module Aws::ConnectParticipant
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-connectparticipant'
-      context[:gem_version] = '1.34.0'
+      context[:gem_version] = '1.35.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-connectparticipant/client_api.rb

@@ -13,6 +13,7 @@ module Aws::ConnectParticipant
 
     include Seahorse::Model
 
+    ARN = Shapes::StringShape.new(name: 'ARN')
     AccessDeniedException = Shapes::StructureShape.new(name: 'AccessDeniedException')
     ArtifactId = Shapes::StringShape.new(name: 'ArtifactId')
     ArtifactStatus = Shapes::StringShape.new(name: 'ArtifactStatus')
@@ -37,6 +38,8 @@ module Aws::ConnectParticipant
     ContentType = Shapes::StringShape.new(name: 'ContentType')
     CreateParticipantConnectionRequest = Shapes::StructureShape.new(name: 'CreateParticipantConnectionRequest')
     CreateParticipantConnectionResponse = Shapes::StructureShape.new(name: 'CreateParticipantConnectionResponse')
+    DescribeViewRequest = Shapes::StructureShape.new(name: 'DescribeViewRequest')
+    DescribeViewResponse = Shapes::StructureShape.new(name: 'DescribeViewResponse')
     DisconnectParticipantRequest = Shapes::StructureShape.new(name: 'DisconnectParticipantRequest')
     DisconnectParticipantResponse = Shapes::StructureShape.new(name: 'DisconnectParticipantResponse')
     DisplayName = Shapes::StringShape.new(name: 'DisplayName')
@@ -62,6 +65,9 @@ module Aws::ConnectParticipant
     Reason = Shapes::StringShape.new(name: 'Reason')
     Receipt = Shapes::StructureShape.new(name: 'Receipt')
     Receipts = Shapes::ListShape.new(name: 'Receipts')
+    ResourceId = Shapes::StringShape.new(name: 'ResourceId')
+    ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
+    ResourceType = Shapes::StringShape.new(name: 'ResourceType')
     ScanDirection = Shapes::StringShape.new(name: 'ScanDirection')
     SendEventRequest = Shapes::StructureShape.new(name: 'SendEventRequest')
     SendEventResponse = Shapes::StructureShape.new(name: 'SendEventResponse')
@@ -80,6 +86,16 @@ module Aws::ConnectParticipant
     UploadMetadataSignedHeadersValue = Shapes::StringShape.new(name: 'UploadMetadataSignedHeadersValue')
     UploadMetadataUrl = Shapes::StringShape.new(name: 'UploadMetadataUrl')
     ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
+    View = Shapes::StructureShape.new(name: 'View')
+    ViewAction = Shapes::StringShape.new(name: 'ViewAction')
+    ViewActions = Shapes::ListShape.new(name: 'ViewActions')
+    ViewContent = Shapes::StructureShape.new(name: 'ViewContent')
+    ViewId = Shapes::StringShape.new(name: 'ViewId')
+    ViewInputSchema = Shapes::StringShape.new(name: 'ViewInputSchema')
+    ViewName = Shapes::StringShape.new(name: 'ViewName')
+    ViewTemplate = Shapes::StringShape.new(name: 'ViewTemplate')
+    ViewToken = Shapes::StringShape.new(name: 'ViewToken')
+    ViewVersion = Shapes::IntegerShape.new(name: 'ViewVersion')
     Websocket = Shapes::StructureShape.new(name: 'Websocket')
 
     AccessDeniedException.add_member(:message, Shapes::ShapeRef.new(shape: Message, required: true, location_name: "Message"))
@@ -120,6 +136,13 @@ module Aws::ConnectParticipant
     CreateParticipantConnectionResponse.add_member(:connection_credentials, Shapes::ShapeRef.new(shape: ConnectionCredentials, location_name: "ConnectionCredentials"))
     CreateParticipantConnectionResponse.struct_class = Types::CreateParticipantConnectionResponse
 
+    DescribeViewRequest.add_member(:view_token, Shapes::ShapeRef.new(shape: ViewToken, required: true, location: "uri", location_name: "ViewToken"))
+    DescribeViewRequest.add_member(:connection_token, Shapes::ShapeRef.new(shape: ParticipantToken, required: true, location: "header", location_name: "X-Amz-Bearer"))
+    DescribeViewRequest.struct_class = Types::DescribeViewRequest
+
+    DescribeViewResponse.add_member(:view, Shapes::ShapeRef.new(shape: View, location_name: "View"))
+    DescribeViewResponse.struct_class = Types::DescribeViewResponse
+
     DisconnectParticipantRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
     DisconnectParticipantRequest.add_member(:connection_token, Shapes::ShapeRef.new(shape: ParticipantToken, required: true, location: "header", location_name: "X-Amz-Bearer"))
     DisconnectParticipantRequest.struct_class = Types::DisconnectParticipantRequest
@@ -176,6 +199,11 @@ module Aws::ConnectParticipant
 
     Receipts.member = Shapes::ShapeRef.new(shape: Receipt)
 
+    ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
+    ResourceNotFoundException.add_member(:resource_id, Shapes::ShapeRef.new(shape: ResourceId, location_name: "ResourceId"))
+    ResourceNotFoundException.add_member(:resource_type, Shapes::ShapeRef.new(shape: ResourceType, location_name: "ResourceType"))
+    ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
+
     SendEventRequest.add_member(:content_type, Shapes::ShapeRef.new(shape: ChatContentType, required: true, location_name: "ContentType"))
     SendEventRequest.add_member(:content, Shapes::ShapeRef.new(shape: ChatContent, location_name: "Content"))
     SendEventRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
@@ -231,6 +259,20 @@ module Aws::ConnectParticipant
     ValidationException.add_member(:message, Shapes::ShapeRef.new(shape: Reason, required: true, location_name: "Message"))
     ValidationException.struct_class = Types::ValidationException
 
+    View.add_member(:id, Shapes::ShapeRef.new(shape: ViewId, location_name: "Id"))
+    View.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, location_name: "Arn"))
+    View.add_member(:name, Shapes::ShapeRef.new(shape: ViewName, location_name: "Name"))
+    View.add_member(:version, Shapes::ShapeRef.new(shape: ViewVersion, location_name: "Version"))
+    View.add_member(:content, Shapes::ShapeRef.new(shape: ViewContent, location_name: "Content"))
+    View.struct_class = Types::View
+
+    ViewActions.member = Shapes::ShapeRef.new(shape: ViewAction)
+
+    ViewContent.add_member(:input_schema, Shapes::ShapeRef.new(shape: ViewInputSchema, location_name: "InputSchema"))
+    ViewContent.add_member(:template, Shapes::ShapeRef.new(shape: ViewTemplate, location_name: "Template"))
+    ViewContent.add_member(:actions, Shapes::ShapeRef.new(shape: ViewActions, location_name: "Actions"))
+    ViewContent.struct_class = Types::ViewContent
+
     Websocket.add_member(:url, Shapes::ShapeRef.new(shape: PreSignedConnectionUrl, location_name: "Url"))
     Websocket.add_member(:connection_expiry, Shapes::ShapeRef.new(shape: ISO8601Datetime, location_name: "ConnectionExpiry"))
     Websocket.struct_class = Types::Websocket
@@ -280,6 +322,19 @@ module Aws::ConnectParticipant
         o.errors << Shapes::ShapeRef.new(shape: ValidationException)
       end)
 
+      api.add_operation(:describe_view, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DescribeView"
+        o.http_method = "GET"
+        o.http_request_uri = "/participant/views/{ViewToken}"
+        o.input = Shapes::ShapeRef.new(shape: DescribeViewRequest)
+        o.output = Shapes::ShapeRef.new(shape: DescribeViewResponse)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+      end)
+
       api.add_operation(:disconnect_participant, Seahorse::Model::Operation.new.tap do |o|
         o.name = "DisconnectParticipant"
         o.http_method = "POST"

data/lib/aws-sdk-connectparticipant/endpoints.rb

@@ -40,6 +40,20 @@ module Aws::ConnectParticipant
       end
     end
 
+    class DescribeView
+      def self.build(context)
+        unless context.config.regional_endpoint
+          endpoint = context.config.endpoint.to_s
+        end
+        Aws::ConnectParticipant::EndpointParameters.new(
+          region: context.config.region,
+          use_dual_stack: context.config.use_dualstack_endpoint,
+          use_fips: context.config.use_fips_endpoint,
+          endpoint: endpoint,
+        )
+      end
+    end
+
     class DisconnectParticipant
       def self.build(context)
         unless context.config.regional_endpoint

data/lib/aws-sdk-connectparticipant/errors.rb

@@ -30,6 +30,7 @@ module Aws::ConnectParticipant
   # * {AccessDeniedException}
   # * {ConflictException}
   # * {InternalServerException}
+  # * {ResourceNotFoundException}
   # * {ServiceQuotaExceededException}
   # * {ThrottlingException}
   # * {ValidationException}
@@ -85,6 +86,31 @@ module Aws::ConnectParticipant
       end
     end
 
+    class ResourceNotFoundException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::ConnectParticipant::Types::ResourceNotFoundException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+
+      # @return [String]
+      def resource_id
+        @data[:resource_id]
+      end
+
+      # @return [String]
+      def resource_type
+        @data[:resource_type]
+      end
+    end
+
     class ServiceQuotaExceededException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context

data/lib/aws-sdk-connectparticipant/plugins/endpoints.rb

@@ -60,6 +60,8 @@ module Aws::ConnectParticipant
             Aws::ConnectParticipant::Endpoints::CompleteAttachmentUpload.build(context)
           when :create_participant_connection
             Aws::ConnectParticipant::Endpoints::CreateParticipantConnection.build(context)
+          when :describe_view
+            Aws::ConnectParticipant::Endpoints::DescribeView.build(context)
           when :disconnect_participant
             Aws::ConnectParticipant::Endpoints::DisconnectParticipant.build(context)
           when :get_attachment

data/lib/aws-sdk-connectparticipant/types.rb

@@ -132,8 +132,9 @@ module Aws::ConnectParticipant
     end
 
     # @!attribute [rw] type
-    #   Type of connection information required. This can be omitted if
-    #   `ConnectParticipant` is `true`.
+    #   Type of connection information required. If you need
+    #   `CONNECTION_CREDENTIALS` along with marking participant as
+    #   connected, pass `CONNECTION_CREDENTIALS` in `Type`.
     #   @return [Array<String>]
     #
     # @!attribute [rw] participant_token
@@ -181,6 +182,37 @@ module Aws::ConnectParticipant
       include Aws::Structure
     end
 
+    # @!attribute [rw] view_token
+    #   An encrypted token originating from the interactive message of a
+    #   ShowView block operation. Represents the desired view.
+    #   @return [String]
+    #
+    # @!attribute [rw] connection_token
+    #   The connection token.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/DescribeViewRequest AWS API Documentation
+    #
+    class DescribeViewRequest < Struct.new(
+      :view_token,
+      :connection_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] view
+    #   A view resource object. Contains metadata and content necessary to
+    #   render the view.
+    #   @return [Types::View]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/DescribeViewResponse AWS API Documentation
+    #
+    class DescribeViewResponse < Struct.new(
+      :view)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] client_token
     #   A unique, case-sensitive identifier that you provide to ensure the
     #   idempotency of the request. If not provided, the Amazon Web Services
@@ -467,6 +499,29 @@ module Aws::ConnectParticipant
       include Aws::Structure
     end
 
+    # The resource was not found.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @!attribute [rw] resource_id
+    #   The identifier of the resource.
+    #   @return [String]
+    #
+    # @!attribute [rw] resource_type
+    #   The type of Amazon Connect resource.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/ResourceNotFoundException AWS API Documentation
+    #
+    class ResourceNotFoundException < Struct.new(
+      :message,
+      :resource_id,
+      :resource_type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] content_type
     #   The content type of the request. Supported types are:
     #
@@ -773,6 +828,68 @@ module Aws::ConnectParticipant
       include Aws::Structure
     end
 
+    # A view resource object. Contains metadata and content necessary to
+    # render the view.
+    #
+    # @!attribute [rw] id
+    #   The identifier of the view.
+    #   @return [String]
+    #
+    # @!attribute [rw] arn
+    #   The Amazon Resource Name (ARN) of the view.
+    #   @return [String]
+    #
+    # @!attribute [rw] name
+    #   The name of the view.
+    #   @return [String]
+    #
+    # @!attribute [rw] version
+    #   The current version of the view.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] content
+    #   View content containing all content necessary to render a view
+    #   except for runtime input data.
+    #   @return [Types::ViewContent]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/View AWS API Documentation
+    #
+    class View < Struct.new(
+      :id,
+      :arn,
+      :name,
+      :version,
+      :content)
+      SENSITIVE = [:name]
+      include Aws::Structure
+    end
+
+    # View content containing all content necessary to render a view except
+    # for runtime input data.
+    #
+    # @!attribute [rw] input_schema
+    #   The schema representing the input data that the view template must
+    #   be supplied to render.
+    #   @return [String]
+    #
+    # @!attribute [rw] template
+    #   The view template representing the structure of the view.
+    #   @return [String]
+    #
+    # @!attribute [rw] actions
+    #   A list of actions possible from the view
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/ViewContent AWS API Documentation
+    #
+    class ViewContent < Struct.new(
+      :input_schema,
+      :template,
+      :actions)
+      SENSITIVE = [:input_schema, :template]
+      include Aws::Structure
+    end
+
     # The websocket for the participant's connection.
     #
     # @!attribute [rw] url

data/lib/aws-sdk-connectparticipant.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-connectparticipant/customizations'
 # @!group service
 module Aws::ConnectParticipant
 
-  GEM_VERSION = '1.34.0'
+  GEM_VERSION = '1.35.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-connectparticipant
 version: !ruby/object:Gem::Version
-  version: 1.34.0
+  version: 1.35.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-11 00:00:00.000000000 Z
+date: 2023-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core