blib/lib/Paws/Connect/StartChatContact.pm untested

filter: Statementstmt 0.0% 0 / 16 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 18 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Connect::StartChatContact;
3 use Moose;
4 has Attributes => (is => 'ro', isa => 'Paws::Connect::Attributes');
5 has ClientToken => (is => 'ro', isa => 'Str');
6 has ContactFlowId => (is => 'ro', isa => 'Str', required => 1);
7 has InitialMessage => (is => 'ro', isa => 'Paws::Connect::ChatMessage');
8 has InstanceId => (is => 'ro', isa => 'Str', required => 1);
9 has ParticipantDetails => (is => 'ro', isa => 'Paws::Connect::ParticipantDetails', required => 1);
10  
11 use MooseX::ClassAttribute;
12  
13 class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartChatContact');
14 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/contact/chat');
15 class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT');
16 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Connect::StartChatContactResponse');
17 1;
18  
19 ### main pod documentation begin ###
20  
21 =head1 NAME
22  
23 Paws::Connect::StartChatContact - Arguments for method StartChatContact on L<Paws::Connect>
24  
25 =head1 DESCRIPTION
26  
27 This class represents the parameters used for calling the method StartChatContact on the
28 L<Amazon Connect Service|Paws::Connect> service. Use the attributes of this class
29 as arguments to method StartChatContact.
30  
31 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartChatContact.
32  
33 =head1 SYNOPSIS
34  
35 my $connect = Paws->service('Connect');
36 my $StartChatContactResponse = $connect->StartChatContact(
37 ContactFlowId => 'MyContactFlowId',
38 InstanceId => 'MyInstanceId',
39 ParticipantDetails => {
40 DisplayName => 'MyDisplayName', # min: 1, max: 256
41  
42 },
43 Attributes => {
44 'MyAttributeName' =>
45 'MyAttributeValue', # key: min: 1, max: 32767, value: max: 32767
46 }, # OPTIONAL
47 ClientToken => 'MyClientToken', # OPTIONAL
48 InitialMessage => {
49 Content => 'MyChatContent', # min: 1, max: 1024
50 ContentType => 'MyChatContentType', # min: 1, max: 100
51  
52 }, # OPTIONAL
53 );
54  
55 # Results:
56 my $ContactId = $StartChatContactResponse->ContactId;
57 my $ParticipantId = $StartChatContactResponse->ParticipantId;
58 my $ParticipantToken = $StartChatContactResponse->ParticipantToken;
59  
60 # Returns a L<Paws::Connect::StartChatContactResponse> object.
61  
62 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
63 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/connect/StartChatContact>
64  
65 =head1 ATTRIBUTES
66  
67  
68 =head2 Attributes => L<Paws::Connect::Attributes>
69  
70 A custom key-value pair using an attribute map. The attributes are
71 standard Amazon Connect attributes. They can be accessed in contact
72 flows just like any other contact attributes.
73  
74 There can be up to 32,768 UTF-8 bytes across all key-value pairs per
75 contact. Attribute keys can include only alphanumeric, dash, and
76 underscore characters.
77  
78  
79  
80 =head2 ClientToken => Str
81  
82 A unique, case-sensitive identifier that you provide to ensure the
83 idempotency of the request.
84  
85  
86  
87 =head2 B<REQUIRED> ContactFlowId => Str
88  
89 The identifier of the contact flow for initiating the chat. To see the
90 ContactFlowId in the Amazon Connect console user interface, on the
91 navigation menu go to B<Routing>, B<Contact Flows>. Choose the contact
92 flow. On the contact flow page, under the name of the contact flow,
93 choose B<Show additional flow information>. The ContactFlowId is the
94 last part of the ARN, shown here in bold:
95  
96 arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/B<846ec553-a005-41c0-8341-xxxxxxxxxxxx>
97  
98  
99  
100 =head2 InitialMessage => L<Paws::Connect::ChatMessage>
101  
102 The initial message to be sent to the newly created chat.
103  
104  
105  
106 =head2 B<REQUIRED> InstanceId => Str
107  
108 The identifier of the Amazon Connect instance. You can find the
109 instanceId in the ARN of the instance.
110  
111  
112  
113 =head2 B<REQUIRED> ParticipantDetails => L<Paws::Connect::ParticipantDetails>
114  
115 Information identifying the participant.
116  
117  
118  
119  
120 =head1 SEE ALSO
121  
122 This class forms part of L<Paws>, documenting arguments for method StartChatContact in L<Paws::Connect>
123  
124 =head1 BUGS and CONTRIBUTIONS
125  
126 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
127  
128 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
129  
130 =cut
131