blib/lib/Paws/WorkDocs/CreateComment.pm untested

filter: Statementstmt 0.0% 0 / 21 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 23 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::WorkDocs::CreateComment;
3 use Moose;
4 has AuthenticationToken => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'Authentication');
5 has DocumentId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'DocumentId', required => 1);
6 has NotifyCollaborators => (is => 'ro', isa => 'Bool');
7 has ParentId => (is => 'ro', isa => 'Str');
8 has Text => (is => 'ro', isa => 'Str', required => 1);
9 has ThreadId => (is => 'ro', isa => 'Str');
10 has VersionId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'VersionId', required => 1);
11 has Visibility => (is => 'ro', isa => 'Str');
12  
13 use MooseX::ClassAttribute;
14  
15 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateComment');
16 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/api/v1/documents/{DocumentId}/versions/{VersionId}/comment');
17 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
18 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WorkDocs::CreateCommentResponse');
19 1;
20  
21 ### main pod documentation begin ###
22  
23 =head1 NAME
24  
25 Paws::WorkDocs::CreateComment - Arguments for method CreateComment on L<Paws::WorkDocs>
26  
27 =head1 DESCRIPTION
28  
29 This class represents the parameters used for calling the method CreateComment on the
30 L<Amazon WorkDocs|Paws::WorkDocs> service. Use the attributes of this class
31 as arguments to method CreateComment.
32  
33 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateComment.
34  
35 =head1 SYNOPSIS
36  
37 my $workdocs = Paws->service('WorkDocs');
38 my $CreateCommentResponse = $workdocs->CreateComment(
39 DocumentId => 'MyResourceIdType',
40 Text => 'MyCommentTextType',
41 VersionId => 'MyDocumentVersionIdType',
42 AuthenticationToken => 'MyAuthenticationHeaderType', # OPTIONAL
43 NotifyCollaborators => 1, # OPTIONAL
44 ParentId => 'MyCommentIdType', # OPTIONAL
45 ThreadId => 'MyCommentIdType', # OPTIONAL
46 Visibility => 'PUBLIC', # OPTIONAL
47 );
48  
49 # Results:
50 my $Comment = $CreateCommentResponse->Comment;
51  
52 # Returns a L<Paws::WorkDocs::CreateCommentResponse> object.
53  
54 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.
55 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/workdocs/CreateComment>
56  
57 =head1 ATTRIBUTES
58  
59  
60 =head2 AuthenticationToken => Str
61  
62 Amazon WorkDocs authentication token. Not required when using AWS
63 administrator credentials to access the API.
64  
65  
66  
67 =head2 B<REQUIRED> DocumentId => Str
68  
69 The ID of the document.
70  
71  
72  
73 =head2 NotifyCollaborators => Bool
74  
75 Set this parameter to TRUE to send an email out to the document
76 collaborators after the comment is created.
77  
78  
79  
80 =head2 ParentId => Str
81  
82 The ID of the parent comment.
83  
84  
85  
86 =head2 B<REQUIRED> Text => Str
87  
88 The text of the comment.
89  
90  
91  
92 =head2 ThreadId => Str
93  
94 The ID of the root comment in the thread.
95  
96  
97  
98 =head2 B<REQUIRED> VersionId => Str
99  
100 The ID of the document version.
101  
102  
103  
104 =head2 Visibility => Str
105  
106 The visibility of the comment. Options are either PRIVATE, where the
107 comment is visible only to the comment author and document owner and
108 co-owners, or PUBLIC, where the comment is visible to document owners,
109 co-owners, and contributors.
110  
111 Valid values are: C<"PUBLIC">, C<"PRIVATE">
112  
113  
114 =head1 SEE ALSO
115  
116 This class forms part of L<Paws>, documenting arguments for method CreateComment in L<Paws::WorkDocs>
117  
118 =head1 BUGS and CONTRIBUTIONS
119  
120 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
121  
122 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
123  
124 =cut
125