blib/lib/Paws/Pinpoint/SendMessages.pm untested

filter: Statementstmt 0.0% 0 / 14 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 16 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Pinpoint::SendMessages;
3 use Moose;
4 has ApplicationId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'application-id', required => 1);
5 has MessageRequest => (is => 'ro', isa => 'Paws::Pinpoint::MessageRequest', required => 1);
6  
7 use MooseX::ClassAttribute;
8 class_has _stream_param => (is => 'ro', default => 'MessageRequest');
9 class_has _api_call => (isa => 'Str', is => 'ro', default => 'SendMessages');
10 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/apps/{application-id}/messages');
11 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
12 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Pinpoint::SendMessagesResponse');
13 1;
14  
15 ### main pod documentation begin ###
16  
17 =head1 NAME
18  
19 Paws::Pinpoint::SendMessages - Arguments for method SendMessages on L<Paws::Pinpoint>
20  
21 =head1 DESCRIPTION
22  
23 This class represents the parameters used for calling the method SendMessages on the
24 L<Amazon Pinpoint|Paws::Pinpoint> service. Use the attributes of this class
25 as arguments to method SendMessages.
26  
27 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SendMessages.
28  
29 =head1 SYNOPSIS
30  
31 my $pinpoint = Paws->service('Pinpoint');
32 my $SendMessagesResponse = $pinpoint->SendMessages(
33 ApplicationId => 'My__string',
34 MessageRequest => {
35 MessageConfiguration => {
36 ADMMessage => {
37 Action => 'OPEN_APP', # values: OPEN_APP, DEEP_LINK, URL; OPTIONAL
38 Body => 'My__string',
39 ConsolidationKey => 'My__string',
40 Data => { 'My__string' => 'My__string', }, # OPTIONAL
41 ExpiresAfter => 'My__string',
42 IconReference => 'My__string',
43 ImageIconUrl => 'My__string',
44 ImageUrl => 'My__string',
45 MD5 => 'My__string',
46 RawContent => 'My__string',
47 SilentPush => 1, # OPTIONAL
48 SmallImageIconUrl => 'My__string',
49 Sound => 'My__string',
50 Substitutions => { 'My__string' => [ 'My__string', ... ], }
51 , # OPTIONAL
52 Title => 'My__string',
53 Url => 'My__string',
54 }, # OPTIONAL
55 APNSMessage => {
56 APNSPushType => 'My__string',
57 Action => 'OPEN_APP', # values: OPEN_APP, DEEP_LINK, URL; OPTIONAL
58 Badge => 1, # OPTIONAL
59 Body => 'My__string',
60 Category => 'My__string',
61 CollapseId => 'My__string',
62 Data => { 'My__string' => 'My__string', }, # OPTIONAL
63 MediaUrl => 'My__string',
64 PreferredAuthenticationMethod => 'My__string',
65 Priority => 'My__string',
66 RawContent => 'My__string',
67 SilentPush => 1, # OPTIONAL
68 Sound => 'My__string',
69 Substitutions => { 'My__string' => [ 'My__string', ... ], }
70 , # OPTIONAL
71 ThreadId => 'My__string',
72 TimeToLive => 1, # OPTIONAL
73 Title => 'My__string',
74 Url => 'My__string',
75 }, # OPTIONAL
76 BaiduMessage => {
77 Action => 'OPEN_APP', # values: OPEN_APP, DEEP_LINK, URL; OPTIONAL
78 Body => 'My__string',
79 Data => { 'My__string' => 'My__string', }, # OPTIONAL
80 IconReference => 'My__string',
81 ImageIconUrl => 'My__string',
82 ImageUrl => 'My__string',
83 RawContent => 'My__string',
84 SilentPush => 1, # OPTIONAL
85 SmallImageIconUrl => 'My__string',
86 Sound => 'My__string',
87 Substitutions => { 'My__string' => [ 'My__string', ... ], }
88 , # OPTIONAL
89 TimeToLive => 1, # OPTIONAL
90 Title => 'My__string',
91 Url => 'My__string',
92 }, # OPTIONAL
93 DefaultMessage => {
94 Body => 'My__string',
95 Substitutions => { 'My__string' => [ 'My__string', ... ], }
96 , # OPTIONAL
97 }, # OPTIONAL
98 DefaultPushNotificationMessage => {
99 Action => 'OPEN_APP', # values: OPEN_APP, DEEP_LINK, URL; OPTIONAL
100 Body => 'My__string',
101 Data => { 'My__string' => 'My__string', }, # OPTIONAL
102 SilentPush => 1, # OPTIONAL
103 Substitutions => { 'My__string' => [ 'My__string', ... ], }
104 , # OPTIONAL
105 Title => 'My__string',
106 Url => 'My__string',
107 }, # OPTIONAL
108 EmailMessage => {
109 Body => 'My__string',
110 FeedbackForwardingAddress => 'My__string',
111 FromAddress => 'My__string',
112 RawEmail => {
113 Data => 'Blob__blob', # OPTIONAL
114 }, # OPTIONAL
115 ReplyToAddresses => [ 'My__string', ... ],
116 SimpleEmail => {
117 HtmlPart => {
118 Charset => 'My__string',
119 Data => 'My__string',
120 }, # OPTIONAL
121 Subject => {
122 Charset => 'My__string',
123 Data => 'My__string',
124 }, # OPTIONAL
125 TextPart => {
126 Charset => 'My__string',
127 Data => 'My__string',
128 }, # OPTIONAL
129 }, # OPTIONAL
130 Substitutions => { 'My__string' => [ 'My__string', ... ], }
131 , # OPTIONAL
132 }, # OPTIONAL
133 GCMMessage => {
134 Action => 'OPEN_APP', # values: OPEN_APP, DEEP_LINK, URL; OPTIONAL
135 Body => 'My__string',
136 CollapseKey => 'My__string',
137 Data => { 'My__string' => 'My__string', }, # OPTIONAL
138 IconReference => 'My__string',
139 ImageIconUrl => 'My__string',
140 ImageUrl => 'My__string',
141 Priority => 'My__string',
142 RawContent => 'My__string',
143 RestrictedPackageName => 'My__string',
144 SilentPush => 1, # OPTIONAL
145 SmallImageIconUrl => 'My__string',
146 Sound => 'My__string',
147 Substitutions => { 'My__string' => [ 'My__string', ... ], }
148 , # OPTIONAL
149 TimeToLive => 1, # OPTIONAL
150 Title => 'My__string',
151 Url => 'My__string',
152 }, # OPTIONAL
153 SMSMessage => {
154 Body => 'My__string',
155 EntityId => 'My__string',
156 Keyword => 'My__string',
157 MediaUrl => 'My__string',
158 MessageType =>
159 'TRANSACTIONAL', # values: TRANSACTIONAL, PROMOTIONAL; OPTIONAL
160 OriginationNumber => 'My__string',
161 SenderId => 'My__string',
162 Substitutions => { 'My__string' => [ 'My__string', ... ], }
163 , # OPTIONAL
164 TemplateId => 'My__string',
165 }, # OPTIONAL
166 VoiceMessage => {
167 Body => 'My__string',
168 LanguageCode => 'My__string',
169 OriginationNumber => 'My__string',
170 Substitutions => { 'My__string' => [ 'My__string', ... ], }
171 , # OPTIONAL
172 VoiceId => 'My__string',
173 }, # OPTIONAL
174 },
175 Addresses => {
176 'My__string' => {
177 BodyOverride => 'My__string',
178 ChannelType => 'PUSH'
179 , # values: PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM; OPTIONAL
180 Context => { 'My__string' => 'My__string', }, # OPTIONAL
181 RawContent => 'My__string',
182 Substitutions => { 'My__string' => [ 'My__string', ... ], }
183 , # OPTIONAL
184 TitleOverride => 'My__string',
185 },
186 }, # OPTIONAL
187 Context => { 'My__string' => 'My__string', }, # OPTIONAL
188 Endpoints => {
189 'My__string' => {
190 BodyOverride => 'My__string',
191 Context => { 'My__string' => 'My__string', }, # OPTIONAL
192 RawContent => 'My__string',
193 Substitutions => { 'My__string' => [ 'My__string', ... ], }
194 , # OPTIONAL
195 TitleOverride => 'My__string',
196 },
197 }, # OPTIONAL
198 TemplateConfiguration => {
199 EmailTemplate => {
200 Name => 'My__string',
201 Version => 'My__string',
202 }, # OPTIONAL
203 PushTemplate => {
204 Name => 'My__string',
205 Version => 'My__string',
206 }, # OPTIONAL
207 SMSTemplate => {
208 Name => 'My__string',
209 Version => 'My__string',
210 }, # OPTIONAL
211 VoiceTemplate => {
212 Name => 'My__string',
213 Version => 'My__string',
214 }, # OPTIONAL
215 }, # OPTIONAL
216 TraceId => 'My__string',
217 },
218  
219 );
220  
221 # Results:
222 my $MessageResponse = $SendMessagesResponse->MessageResponse;
223  
224 # Returns a L<Paws::Pinpoint::SendMessagesResponse> object.
225  
226 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.
227 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/pinpoint/SendMessages>
228  
229 =head1 ATTRIBUTES
230  
231  
232 =head2 B<REQUIRED> ApplicationId => Str
233  
234 The unique identifier for the application. This identifier is displayed
235 as the B<Project ID> on the Amazon Pinpoint console.
236  
237  
238  
239 =head2 B<REQUIRED> MessageRequest => L<Paws::Pinpoint::MessageRequest>
240  
241  
242  
243  
244  
245  
246 =head1 SEE ALSO
247  
248 This class forms part of L<Paws>, documenting arguments for method SendMessages in L<Paws::Pinpoint>
249  
250 =head1 BUGS and CONTRIBUTIONS
251  
252 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
253  
254 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
255  
256 =cut
257