aws-sdk-connectparticipant 1.19.0 → 1.36.0

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

@@ -33,7 +33,7 @@ module Aws::ConnectParticipant
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits
+    #   [1]: https://docs.aws.amazon.com/connect/latest/adminguide/feature-limits.html
     #   @return [String]
     #
     # @!attribute [rw] attachment_id
@@ -59,25 +59,22 @@ module Aws::ConnectParticipant
       include Aws::Structure
     end
 
-    # @note When making an API call, you may pass CompleteAttachmentUploadRequest
-    #   data as a hash:
-    #
-    #       {
-    #         attachment_ids: ["ArtifactId"], # required
-    #         client_token: "NonEmptyClientToken", # required
-    #         connection_token: "ParticipantToken", # required
-    #       }
-    #
     # @!attribute [rw] attachment_ids
     #   A list of unique identifiers for the attachments.
     #   @return [Array<String>]
     #
     # @!attribute [rw] client_token
     #   A unique, case-sensitive identifier that you provide to ensure the
-    #   idempotency of the request.
+    #   idempotency of the request. If not provided, the Amazon Web Services
+    #   SDK populates this field. For more information about idempotency,
+    #   see [Making retries safe with idempotent APIs][1].
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.
+    #
+    #
+    #
+    #   [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
     #   @return [String]
     #
     # @!attribute [rw] connection_token
@@ -134,17 +131,10 @@ module Aws::ConnectParticipant
       include Aws::Structure
     end
 
-    # @note When making an API call, you may pass CreateParticipantConnectionRequest
-    #   data as a hash:
-    #
-    #       {
-    #         type: ["WEBSOCKET"], # required, accepts WEBSOCKET, CONNECTION_CREDENTIALS
-    #         participant_token: "ParticipantToken", # required
-    #         connect_participant: false,
-    #       }
-    #
     # @!attribute [rw] type
-    #   Type of connection information required.
+    #   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
@@ -160,7 +150,8 @@ module Aws::ConnectParticipant
     #
     # @!attribute [rw] connect_participant
     #   Amazon Connect Participant is used to mark the participant as
-    #   connected for message streaming.
+    #   connected for customer participant in message streaming, as well as
+    #   for agent or manager participant in non-streaming chats.
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/CreateParticipantConnectionRequest AWS API Documentation
@@ -191,20 +182,49 @@ module Aws::ConnectParticipant
       include Aws::Structure
     end
 
-    # @note When making an API call, you may pass DisconnectParticipantRequest
-    #   data as a hash:
+    # @!attribute [rw] view_token
+    #   An encrypted token originating from the interactive message of a
+    #   ShowView block operation. Represents the desired view.
+    #   @return [String]
     #
-    #       {
-    #         client_token: "ClientToken",
-    #         connection_token: "ParticipantToken", # required
-    #       }
+    # @!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.
+    #   idempotency of the request. If not provided, the Amazon Web Services
+    #   SDK populates this field. For more information about idempotency,
+    #   see [Making retries safe with idempotent APIs][1].
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.
+    #
+    #
+    #
+    #   [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
     #   @return [String]
     #
     # @!attribute [rw] connection_token
@@ -225,14 +245,6 @@ module Aws::ConnectParticipant
     #
     class DisconnectParticipantResponse < Aws::EmptyStructure; end
 
-    # @note When making an API call, you may pass GetAttachmentRequest
-    #   data as a hash:
-    #
-    #       {
-    #         attachment_id: "ArtifactId", # required
-    #         connection_token: "ParticipantToken", # required
-    #       }
-    #
     # @!attribute [rw] attachment_id
     #   A unique identifier for the attachment.
     #   @return [String]
@@ -275,23 +287,6 @@ module Aws::ConnectParticipant
       include Aws::Structure
     end
 
-    # @note When making an API call, you may pass GetTranscriptRequest
-    #   data as a hash:
-    #
-    #       {
-    #         contact_id: "ContactId",
-    #         max_results: 1,
-    #         next_token: "NextToken",
-    #         scan_direction: "FORWARD", # accepts FORWARD, BACKWARD
-    #         sort_order: "DESCENDING", # accepts DESCENDING, ASCENDING
-    #         start_position: {
-    #           id: "ChatItemId",
-    #           absolute_time: "Instant",
-    #           most_recent: 1,
-    #         },
-    #         connection_token: "ParticipantToken", # required
-    #       }
-    #
     # @!attribute [rw] contact_id
     #   The contactId from the current contact chain for which transcript is
     #   needed.
@@ -418,6 +413,28 @@ module Aws::ConnectParticipant
     #   Provides information about the attachments.
     #   @return [Array<Types::AttachmentItem>]
     #
+    # @!attribute [rw] message_metadata
+    #   The metadata related to the message. Currently this supports only
+    #   information related to message receipts.
+    #   @return [Types::MessageMetadata]
+    #
+    # @!attribute [rw] related_contact_id
+    #   The contactId on which the transcript item was originally sent. This
+    #   field is only populated for persistent chats when the transcript
+    #   item is from the past chat session. For more information, see
+    #   [Enable persistent chat][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html
+    #   @return [String]
+    #
+    # @!attribute [rw] contact_id
+    #   The contactId on which the transcript item was originally sent. This
+    #   field is populated only when the transcript item is from the current
+    #   chat session.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/Item AWS API Documentation
     #
     class Item < Struct.new(
@@ -429,40 +446,115 @@ module Aws::ConnectParticipant
       :participant_id,
       :display_name,
       :participant_role,
-      :attachments)
+      :attachments,
+      :message_metadata,
+      :related_contact_id,
+      :contact_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Contains metadata related to a message.
+    #
+    # @!attribute [rw] message_id
+    #   The identifier of the message that contains the metadata
+    #   information.
+    #   @return [String]
+    #
+    # @!attribute [rw] receipts
+    #   The list of receipt information for a message for different
+    #   recipients.
+    #   @return [Array<Types::Receipt>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/MessageMetadata AWS API Documentation
+    #
+    class MessageMetadata < Struct.new(
+      :message_id,
+      :receipts)
       SENSITIVE = []
       include Aws::Structure
     end
 
-    # @note When making an API call, you may pass SendEventRequest
-    #   data as a hash:
+    # The receipt for the message delivered to the recipient.
+    #
+    # @!attribute [rw] delivered_timestamp
+    #   The time when the message was delivered to the recipient.
+    #   @return [String]
+    #
+    # @!attribute [rw] read_timestamp
+    #   The time when the message was read by the recipient.
+    #   @return [String]
+    #
+    # @!attribute [rw] recipient_participant_id
+    #   The identifier of the recipient of the message.
+    #   @return [String]
     #
-    #       {
-    #         content_type: "ChatContentType", # required
-    #         content: "ChatContent",
-    #         client_token: "ClientToken",
-    #         connection_token: "ParticipantToken", # required
-    #       }
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/Receipt AWS API Documentation
     #
+    class Receipt < Struct.new(
+      :delivered_timestamp,
+      :read_timestamp,
+      :recipient_participant_id)
+      SENSITIVE = []
+      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:
     #
     #   * application/vnd.amazonaws.connect.event.typing
     #
     #   * application/vnd.amazonaws.connect.event.connection.acknowledged
+    #
+    #   * application/vnd.amazonaws.connect.event.message.delivered
+    #
+    #   * application/vnd.amazonaws.connect.event.message.read
     #   @return [String]
     #
     # @!attribute [rw] content
-    #   The content of the event to be sent (for example, message text).
-    #   This is not yet supported.
+    #   The content of the event to be sent (for example, message text). For
+    #   content related to message receipts, this is supported in the form
+    #   of a JSON string.
+    #
+    #   Sample Content:
+    #   "\\\{\\"messageId\\":\\"11111111-aaaa-bbbb-cccc-EXAMPLE01234\\"\\}"
     #   @return [String]
     #
     # @!attribute [rw] client_token
     #   A unique, case-sensitive identifier that you provide to ensure the
-    #   idempotency of the request.
+    #   idempotency of the request. If not provided, the Amazon Web Services
+    #   SDK populates this field. For more information about idempotency,
+    #   see [Making retries safe with idempotent APIs][1].
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.
+    #
+    #
+    #
+    #   [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
     #   @return [String]
     #
     # @!attribute [rw] connection_token
@@ -501,30 +593,38 @@ module Aws::ConnectParticipant
       include Aws::Structure
     end
 
-    # @note When making an API call, you may pass SendMessageRequest
-    #   data as a hash:
-    #
-    #       {
-    #         content_type: "ChatContentType", # required
-    #         content: "ChatContent", # required
-    #         client_token: "ClientToken",
-    #         connection_token: "ParticipantToken", # required
-    #       }
-    #
     # @!attribute [rw] content_type
-    #   The type of the content. Supported types are text/plain.
+    #   The type of the content. Supported types are `text/plain`,
+    #   `text/markdown`, `application/json`, and
+    #   `application/vnd.amazonaws.connect.message.interactive.response`.
     #   @return [String]
     #
     # @!attribute [rw] content
     #   The content of the message.
+    #
+    #   * For `text/plain` and `text/markdown`, the Length Constraints are
+    #     Minimum of 1, Maximum of 1024.
+    #
+    #   * For `application/json`, the Length Constraints are Minimum of 1,
+    #     Maximum of 12000.
+    #
+    #   * For
+    #     `application/vnd.amazonaws.connect.message.interactive.response`,
+    #     the Length Constraints are Minimum of 1, Maximum of 12288.
     #   @return [String]
     #
     # @!attribute [rw] client_token
     #   A unique, case-sensitive identifier that you provide to ensure the
-    #   idempotency of the request.
+    #   idempotency of the request. If not provided, the Amazon Web Services
+    #   SDK populates this field. For more information about idempotency,
+    #   see [Making retries safe with idempotent APIs][1].
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.
+    #
+    #
+    #
+    #   [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
     #   @return [String]
     #
     # @!attribute [rw] connection_token
@@ -575,17 +675,6 @@ module Aws::ConnectParticipant
       include Aws::Structure
     end
 
-    # @note When making an API call, you may pass StartAttachmentUploadRequest
-    #   data as a hash:
-    #
-    #       {
-    #         content_type: "ContentType", # required
-    #         attachment_size_in_bytes: 1, # required
-    #         attachment_name: "AttachmentName", # required
-    #         client_token: "NonEmptyClientToken", # required
-    #         connection_token: "ParticipantToken", # required
-    #       }
-    #
     # @!attribute [rw] content_type
     #   Describes the MIME file type of the attachment. For a list of
     #   supported file types, see [Feature specifications][1] in the *Amazon
@@ -593,7 +682,7 @@ module Aws::ConnectParticipant
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits
+    #   [1]: https://docs.aws.amazon.com/connect/latest/adminguide/feature-limits.html
     #   @return [String]
     #
     # @!attribute [rw] attachment_size_in_bytes
@@ -605,11 +694,17 @@ module Aws::ConnectParticipant
     #   @return [String]
     #
     # @!attribute [rw] client_token
-    #   A unique case sensitive identifier to support idempotency of
-    #   request.
+    #   A unique, case-sensitive identifier that you provide to ensure the
+    #   idempotency of the request. If not provided, the Amazon Web Services
+    #   SDK populates this field. For more information about idempotency,
+    #   see [Making retries safe with idempotent APIs][1].
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.
+    #
+    #
+    #
+    #   [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
     #   @return [String]
     #
     # @!attribute [rw] connection_token
@@ -649,15 +744,6 @@ module Aws::ConnectParticipant
     # A filtering option for where to start. For example, if you sent 100
     # messages, start with message 50.
     #
-    # @note When making an API call, you may pass StartPosition
-    #   data as a hash:
-    #
-    #       {
-    #         id: "ChatItemId",
-    #         absolute_time: "Instant",
-    #         most_recent: 1,
-    #       }
-    #
     # @!attribute [rw] id
     #   The ID of the message or event where to start.
     #   @return [String]
@@ -742,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

@@ -13,9 +13,13 @@ require 'aws-sigv4'
 
 require_relative 'aws-sdk-connectparticipant/types'
 require_relative 'aws-sdk-connectparticipant/client_api'
+require_relative 'aws-sdk-connectparticipant/plugins/endpoints.rb'
 require_relative 'aws-sdk-connectparticipant/client'
 require_relative 'aws-sdk-connectparticipant/errors'
 require_relative 'aws-sdk-connectparticipant/resource'
+require_relative 'aws-sdk-connectparticipant/endpoint_parameters'
+require_relative 'aws-sdk-connectparticipant/endpoint_provider'
+require_relative 'aws-sdk-connectparticipant/endpoints'
 require_relative 'aws-sdk-connectparticipant/customizations'
 
 # This module provides support for Amazon Connect Participant Service. This module is available in the
@@ -48,6 +52,6 @@ require_relative 'aws-sdk-connectparticipant/customizations'
 # @!group service
 module Aws::ConnectParticipant
 
-  GEM_VERSION = '1.19.0'
+  GEM_VERSION = '1.36.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-connectparticipant
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.36.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-30 00:00:00.000000000 Z
+date: 2023-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.122.0
+        version: 3.184.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.122.0
+        version: 3.184.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement
@@ -59,7 +59,11 @@ files:
 - lib/aws-sdk-connectparticipant/client.rb
 - lib/aws-sdk-connectparticipant/client_api.rb
 - lib/aws-sdk-connectparticipant/customizations.rb
+- lib/aws-sdk-connectparticipant/endpoint_parameters.rb
+- lib/aws-sdk-connectparticipant/endpoint_provider.rb
+- lib/aws-sdk-connectparticipant/endpoints.rb
 - lib/aws-sdk-connectparticipant/errors.rb
+- lib/aws-sdk-connectparticipant/plugins/endpoints.rb
 - lib/aws-sdk-connectparticipant/resource.rb
 - lib/aws-sdk-connectparticipant/types.rb
 homepage: https://github.com/aws/aws-sdk-ruby