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

filter: Statementstmt 0.0% 0 / 18 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 19 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Pinpoint::EndpointResponse;
3 use Moose;
4 has Address => (is => 'ro', isa => 'Str');
5 has ApplicationId => (is => 'ro', isa => 'Str');
6 has Attributes => (is => 'ro', isa => 'Paws::Pinpoint::MapOfListOf__string');
7 has ChannelType => (is => 'ro', isa => 'Str');
8 has CohortId => (is => 'ro', isa => 'Str');
9 has CreationDate => (is => 'ro', isa => 'Str');
10 has Demographic => (is => 'ro', isa => 'Paws::Pinpoint::EndpointDemographic');
11 has EffectiveDate => (is => 'ro', isa => 'Str');
12 has EndpointStatus => (is => 'ro', isa => 'Str');
13 has Id => (is => 'ro', isa => 'Str');
14 has Location => (is => 'ro', isa => 'Paws::Pinpoint::EndpointLocation');
15 has Metrics => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__double');
16 has OptOut => (is => 'ro', isa => 'Str');
17 has RequestId => (is => 'ro', isa => 'Str');
18 has User => (is => 'ro', isa => 'Paws::Pinpoint::EndpointUser');
19  
20 1;
21  
22 ### main pod documentation begin ###
23  
24 =head1 NAME
25  
26 Paws::Pinpoint::EndpointResponse
27  
28 =head1 USAGE
29  
30 This class represents one of two things:
31  
32 =head3 Arguments in a call to a service
33  
34 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
35 Each attribute should be used as a named argument in the calls that expect this type of object.
36  
37 As an example, if Att1 is expected to be a Paws::Pinpoint::EndpointResponse object:
38  
39 $service_obj->Method(Att1 => { Address => $value, ..., User => $value });
40  
41 =head3 Results returned from an API call
42  
43 Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::EndpointResponse object:
44  
45 $result = $service_obj->Method(...);
46 $result->Att1->Address
47  
48 =head1 DESCRIPTION
49  
50 Provides information about the channel type and other settings for an
51 endpoint.
52  
53 =head1 ATTRIBUTES
54  
55  
56 =head2 Address => Str
57  
58 The destination address for messages or push notifications that you
59 send to the endpoint. The address varies by channel. For example, the
60 address for a push-notification channel is typically the token provided
61 by a push notification service, such as an Apple Push Notification
62 service (APNs) device token or a Firebase Cloud Messaging (FCM)
63 registration token. The address for the SMS channel is a phone number
64 in E.164 format, such as +12065550100. The address for the email
65 channel is an email address.
66  
67  
68 =head2 ApplicationId => Str
69  
70 The unique identifier for the application that's associated with the
71 endpoint.
72  
73  
74 =head2 Attributes => L<Paws::Pinpoint::MapOfListOf__string>
75  
76 One or more custom attributes that describe the endpoint by associating
77 a name with an array of values. For example, the value of a custom
78 attribute named Interests might be: ["Science", "Music", "Travel"]. You
79 can use these attributes as filter criteria when you create segments.
80  
81  
82 =head2 ChannelType => Str
83  
84 The channel that's used when sending messages or push notifications to
85 the endpoint.
86  
87  
88 =head2 CohortId => Str
89  
90 A number from 0-99 that represents the cohort that the endpoint is
91 assigned to. Endpoints are grouped into cohorts randomly, and each
92 cohort contains approximately 1 percent of the endpoints for an
93 application. Amazon Pinpoint assigns cohorts to the holdout or
94 treatment allocations for campaigns.
95  
96  
97 =head2 CreationDate => Str
98  
99 The date and time, in ISO 8601 format, when the endpoint was created.
100  
101  
102 =head2 Demographic => L<Paws::Pinpoint::EndpointDemographic>
103  
104 The demographic information for the endpoint, such as the time zone and
105 platform.
106  
107  
108 =head2 EffectiveDate => Str
109  
110 The date and time, in ISO 8601 format, when the endpoint was last
111 updated.
112  
113  
114 =head2 EndpointStatus => Str
115  
116 Specifies whether messages or push notifications are sent to the
117 endpoint. Possible values are: ACTIVE, messages are sent to the
118 endpoint; and, INACTIVE, messages arenE<rsquo>t sent to the endpoint.
119  
120 Amazon Pinpoint automatically sets this value to ACTIVE when you create
121 an endpoint or update an existing endpoint. Amazon Pinpoint
122 automatically sets this value to INACTIVE if you update another
123 endpoint that has the same address specified by the Address property.
124  
125  
126 =head2 Id => Str
127  
128 The unique identifier that you assigned to the endpoint. The identifier
129 should be a globally unique identifier (GUID) to ensure that it doesn't
130 conflict with other endpoint identifiers that are associated with the
131 application.
132  
133  
134 =head2 Location => L<Paws::Pinpoint::EndpointLocation>
135  
136 The geographic information for the endpoint.
137  
138  
139 =head2 Metrics => L<Paws::Pinpoint::MapOf__double>
140  
141 One or more custom metrics that your app reports to Amazon Pinpoint for
142 the endpoint.
143  
144  
145 =head2 OptOut => Str
146  
147 Specifies whether the user who's associated with the endpoint has opted
148 out of receiving messages and push notifications from you. Possible
149 values are: ALL, the user has opted out and doesn't want to receive any
150 messages or push notifications; and, NONE, the user hasn't opted out
151 and wants to receive all messages and push notifications.
152  
153  
154 =head2 RequestId => Str
155  
156 The unique identifier for the most recent request to update the
157 endpoint.
158  
159  
160 =head2 User => L<Paws::Pinpoint::EndpointUser>
161  
162 One or more custom user attributes that your app reports to Amazon
163 Pinpoint for the user who's associated with the endpoint.
164  
165  
166  
167 =head1 SEE ALSO
168  
169 This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint>
170  
171 =head1 BUGS and CONTRIBUTIONS
172  
173 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
174  
175 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
176  
177 =cut
178