@aws-sdk/client-pinpoint 3.934.0 → 3.935.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.js +188 -188
- package/dist-es/index.js +2 -1
- package/dist-es/models/enums.js +187 -0
- package/dist-es/models/errors.js +129 -0
- package/dist-es/models/models_0.js +1 -310
- package/dist-es/models/models_1.js +1 -6
- package/dist-es/schemas/schemas_0.js +1 -1
- package/dist-types/commands/GetCampaignVersionCommand.d.ts +1 -1
- package/dist-types/commands/GetCampaignVersionsCommand.d.ts +1 -1
- package/dist-types/commands/GetChannelsCommand.d.ts +1 -1
- package/dist-types/commands/GetEmailChannelCommand.d.ts +1 -1
- package/dist-types/commands/GetEmailTemplateCommand.d.ts +1 -1
- package/dist-types/commands/GetEndpointCommand.d.ts +1 -1
- package/dist-types/commands/GetEventStreamCommand.d.ts +1 -1
- package/dist-types/commands/GetExportJobCommand.d.ts +1 -1
- package/dist-types/commands/GetExportJobsCommand.d.ts +1 -1
- package/dist-types/commands/GetGcmChannelCommand.d.ts +1 -1
- package/dist-types/commands/GetImportJobCommand.d.ts +1 -1
- package/dist-types/commands/GetImportJobsCommand.d.ts +1 -1
- package/dist-types/commands/GetInAppMessagesCommand.d.ts +1 -1
- package/dist-types/commands/GetInAppTemplateCommand.d.ts +1 -1
- package/dist-types/commands/GetJourneyCommand.d.ts +2 -1
- package/dist-types/index.d.ts +4 -1
- package/dist-types/models/enums.d.ts +411 -0
- package/dist-types/models/errors.d.ts +178 -0
- package/dist-types/models/models_0.d.ts +547 -575
- package/dist-types/models/models_1.d.ts +2 -561
- package/dist-types/ts3.4/commands/GetCampaignVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetCampaignVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetChannelsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetEmailChannelCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetEmailTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetEndpointCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetEventStreamCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetExportJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetExportJobsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetGcmChannelCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetImportJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetImportJobsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetInAppMessagesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetInAppTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetJourneyCommand.d.ts +2 -1
- package/dist-types/ts3.4/index.d.ts +4 -1
- package/dist-types/ts3.4/models/enums.d.ts +220 -0
- package/dist-types/ts3.4/models/errors.d.ts +68 -0
- package/dist-types/ts3.4/models/models_0.d.ts +172 -280
- package/dist-types/ts3.4/models/models_1.d.ts +2 -163
- package/package.json +12 -12
- package/dist-es/models/index.js +0 -2
- package/dist-types/models/index.d.ts +0 -2
- package/dist-types/ts3.4/models/index.d.ts +0 -2
|
@@ -1,550 +1,5 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
* @public
|
|
4
|
-
*/
|
|
5
|
-
export interface GetCampaignVersionRequest {
|
|
6
|
-
/**
|
|
7
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
8
|
-
* @public
|
|
9
|
-
*/
|
|
10
|
-
ApplicationId: string | undefined;
|
|
11
|
-
/**
|
|
12
|
-
* <p>The unique identifier for the campaign.</p>
|
|
13
|
-
* @public
|
|
14
|
-
*/
|
|
15
|
-
CampaignId: string | undefined;
|
|
16
|
-
/**
|
|
17
|
-
* <p>The unique version number (Version property) for the campaign version.</p>
|
|
18
|
-
* @public
|
|
19
|
-
*/
|
|
20
|
-
Version: string | undefined;
|
|
21
|
-
}
|
|
22
|
-
/**
|
|
23
|
-
* @public
|
|
24
|
-
*/
|
|
25
|
-
export interface GetCampaignVersionResponse {
|
|
26
|
-
/**
|
|
27
|
-
* <p>Provides information about the status, configuration, and other settings for a campaign.</p>
|
|
28
|
-
* @public
|
|
29
|
-
*/
|
|
30
|
-
CampaignResponse: CampaignResponse | undefined;
|
|
31
|
-
}
|
|
32
|
-
/**
|
|
33
|
-
* @public
|
|
34
|
-
*/
|
|
35
|
-
export interface GetCampaignVersionsRequest {
|
|
36
|
-
/**
|
|
37
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
38
|
-
* @public
|
|
39
|
-
*/
|
|
40
|
-
ApplicationId: string | undefined;
|
|
41
|
-
/**
|
|
42
|
-
* <p>The unique identifier for the campaign.</p>
|
|
43
|
-
* @public
|
|
44
|
-
*/
|
|
45
|
-
CampaignId: string | undefined;
|
|
46
|
-
/**
|
|
47
|
-
* <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
|
|
48
|
-
* @public
|
|
49
|
-
*/
|
|
50
|
-
PageSize?: string | undefined;
|
|
51
|
-
/**
|
|
52
|
-
* <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
|
|
53
|
-
* @public
|
|
54
|
-
*/
|
|
55
|
-
Token?: string | undefined;
|
|
56
|
-
}
|
|
57
|
-
/**
|
|
58
|
-
* @public
|
|
59
|
-
*/
|
|
60
|
-
export interface GetCampaignVersionsResponse {
|
|
61
|
-
/**
|
|
62
|
-
* <p>Provides information about the configuration and other settings for all the campaigns that are associated with an application.</p>
|
|
63
|
-
* @public
|
|
64
|
-
*/
|
|
65
|
-
CampaignsResponse: CampaignsResponse | undefined;
|
|
66
|
-
}
|
|
67
|
-
/**
|
|
68
|
-
* @public
|
|
69
|
-
*/
|
|
70
|
-
export interface GetChannelsRequest {
|
|
71
|
-
/**
|
|
72
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
73
|
-
* @public
|
|
74
|
-
*/
|
|
75
|
-
ApplicationId: string | undefined;
|
|
76
|
-
}
|
|
77
|
-
/**
|
|
78
|
-
* @public
|
|
79
|
-
*/
|
|
80
|
-
export interface GetChannelsResponse {
|
|
81
|
-
/**
|
|
82
|
-
* <p>Provides information about the general settings and status of all channels for an application, including channels that aren't enabled for the application.</p>
|
|
83
|
-
* @public
|
|
84
|
-
*/
|
|
85
|
-
ChannelsResponse: ChannelsResponse | undefined;
|
|
86
|
-
}
|
|
87
|
-
/**
|
|
88
|
-
* @public
|
|
89
|
-
*/
|
|
90
|
-
export interface GetEmailChannelRequest {
|
|
91
|
-
/**
|
|
92
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
93
|
-
* @public
|
|
94
|
-
*/
|
|
95
|
-
ApplicationId: string | undefined;
|
|
96
|
-
}
|
|
97
|
-
/**
|
|
98
|
-
* @public
|
|
99
|
-
*/
|
|
100
|
-
export interface GetEmailChannelResponse {
|
|
101
|
-
/**
|
|
102
|
-
* <p>Provides information about the status and settings of the email channel for an application.</p>
|
|
103
|
-
* @public
|
|
104
|
-
*/
|
|
105
|
-
EmailChannelResponse: EmailChannelResponse | undefined;
|
|
106
|
-
}
|
|
107
|
-
/**
|
|
108
|
-
* @public
|
|
109
|
-
*/
|
|
110
|
-
export interface GetEmailTemplateRequest {
|
|
111
|
-
/**
|
|
112
|
-
* <p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>
|
|
113
|
-
* @public
|
|
114
|
-
*/
|
|
115
|
-
TemplateName: string | undefined;
|
|
116
|
-
/**
|
|
117
|
-
* <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
|
|
118
|
-
* @public
|
|
119
|
-
*/
|
|
120
|
-
Version?: string | undefined;
|
|
121
|
-
}
|
|
122
|
-
/**
|
|
123
|
-
* @public
|
|
124
|
-
*/
|
|
125
|
-
export interface GetEmailTemplateResponse {
|
|
126
|
-
/**
|
|
127
|
-
* <p>Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.</p>
|
|
128
|
-
* @public
|
|
129
|
-
*/
|
|
130
|
-
EmailTemplateResponse: EmailTemplateResponse | undefined;
|
|
131
|
-
}
|
|
132
|
-
/**
|
|
133
|
-
* @public
|
|
134
|
-
*/
|
|
135
|
-
export interface GetEndpointRequest {
|
|
136
|
-
/**
|
|
137
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
138
|
-
* @public
|
|
139
|
-
*/
|
|
140
|
-
ApplicationId: string | undefined;
|
|
141
|
-
/**
|
|
142
|
-
* <p>The case insensitive unique identifier for the endpoint. The identifier can't contain <code>$</code>, <code>\{</code> or <code>\}</code>.</p>
|
|
143
|
-
* @public
|
|
144
|
-
*/
|
|
145
|
-
EndpointId: string | undefined;
|
|
146
|
-
}
|
|
147
|
-
/**
|
|
148
|
-
* @public
|
|
149
|
-
*/
|
|
150
|
-
export interface GetEndpointResponse {
|
|
151
|
-
/**
|
|
152
|
-
* <p>Provides information about the channel type and other settings for an endpoint.</p>
|
|
153
|
-
* @public
|
|
154
|
-
*/
|
|
155
|
-
EndpointResponse: EndpointResponse | undefined;
|
|
156
|
-
}
|
|
157
|
-
/**
|
|
158
|
-
* @public
|
|
159
|
-
*/
|
|
160
|
-
export interface GetEventStreamRequest {
|
|
161
|
-
/**
|
|
162
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
163
|
-
* @public
|
|
164
|
-
*/
|
|
165
|
-
ApplicationId: string | undefined;
|
|
166
|
-
}
|
|
167
|
-
/**
|
|
168
|
-
* @public
|
|
169
|
-
*/
|
|
170
|
-
export interface GetEventStreamResponse {
|
|
171
|
-
/**
|
|
172
|
-
* <p>Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.</p>
|
|
173
|
-
* @public
|
|
174
|
-
*/
|
|
175
|
-
EventStream: EventStream | undefined;
|
|
176
|
-
}
|
|
177
|
-
/**
|
|
178
|
-
* @public
|
|
179
|
-
*/
|
|
180
|
-
export interface GetExportJobRequest {
|
|
181
|
-
/**
|
|
182
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
183
|
-
* @public
|
|
184
|
-
*/
|
|
185
|
-
ApplicationId: string | undefined;
|
|
186
|
-
/**
|
|
187
|
-
* <p>The unique identifier for the job.</p>
|
|
188
|
-
* @public
|
|
189
|
-
*/
|
|
190
|
-
JobId: string | undefined;
|
|
191
|
-
}
|
|
192
|
-
/**
|
|
193
|
-
* @public
|
|
194
|
-
*/
|
|
195
|
-
export interface GetExportJobResponse {
|
|
196
|
-
/**
|
|
197
|
-
* <p>Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.</p>
|
|
198
|
-
* @public
|
|
199
|
-
*/
|
|
200
|
-
ExportJobResponse: ExportJobResponse | undefined;
|
|
201
|
-
}
|
|
202
|
-
/**
|
|
203
|
-
* @public
|
|
204
|
-
*/
|
|
205
|
-
export interface GetExportJobsRequest {
|
|
206
|
-
/**
|
|
207
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
208
|
-
* @public
|
|
209
|
-
*/
|
|
210
|
-
ApplicationId: string | undefined;
|
|
211
|
-
/**
|
|
212
|
-
* <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
|
|
213
|
-
* @public
|
|
214
|
-
*/
|
|
215
|
-
PageSize?: string | undefined;
|
|
216
|
-
/**
|
|
217
|
-
* <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
|
|
218
|
-
* @public
|
|
219
|
-
*/
|
|
220
|
-
Token?: string | undefined;
|
|
221
|
-
}
|
|
222
|
-
/**
|
|
223
|
-
* @public
|
|
224
|
-
*/
|
|
225
|
-
export interface GetExportJobsResponse {
|
|
226
|
-
/**
|
|
227
|
-
* <p>Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file.</p>
|
|
228
|
-
* @public
|
|
229
|
-
*/
|
|
230
|
-
ExportJobsResponse: ExportJobsResponse | undefined;
|
|
231
|
-
}
|
|
232
|
-
/**
|
|
233
|
-
* @public
|
|
234
|
-
*/
|
|
235
|
-
export interface GetGcmChannelRequest {
|
|
236
|
-
/**
|
|
237
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
238
|
-
* @public
|
|
239
|
-
*/
|
|
240
|
-
ApplicationId: string | undefined;
|
|
241
|
-
}
|
|
242
|
-
/**
|
|
243
|
-
* @public
|
|
244
|
-
*/
|
|
245
|
-
export interface GetGcmChannelResponse {
|
|
246
|
-
/**
|
|
247
|
-
* <p>Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.</p>
|
|
248
|
-
* @public
|
|
249
|
-
*/
|
|
250
|
-
GCMChannelResponse: GCMChannelResponse | undefined;
|
|
251
|
-
}
|
|
252
|
-
/**
|
|
253
|
-
* @public
|
|
254
|
-
*/
|
|
255
|
-
export interface GetImportJobRequest {
|
|
256
|
-
/**
|
|
257
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
258
|
-
* @public
|
|
259
|
-
*/
|
|
260
|
-
ApplicationId: string | undefined;
|
|
261
|
-
/**
|
|
262
|
-
* <p>The unique identifier for the job.</p>
|
|
263
|
-
* @public
|
|
264
|
-
*/
|
|
265
|
-
JobId: string | undefined;
|
|
266
|
-
}
|
|
267
|
-
/**
|
|
268
|
-
* @public
|
|
269
|
-
*/
|
|
270
|
-
export interface GetImportJobResponse {
|
|
271
|
-
/**
|
|
272
|
-
* <p>Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.</p>
|
|
273
|
-
* @public
|
|
274
|
-
*/
|
|
275
|
-
ImportJobResponse: ImportJobResponse | undefined;
|
|
276
|
-
}
|
|
277
|
-
/**
|
|
278
|
-
* @public
|
|
279
|
-
*/
|
|
280
|
-
export interface GetImportJobsRequest {
|
|
281
|
-
/**
|
|
282
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
283
|
-
* @public
|
|
284
|
-
*/
|
|
285
|
-
ApplicationId: string | undefined;
|
|
286
|
-
/**
|
|
287
|
-
* <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
|
|
288
|
-
* @public
|
|
289
|
-
*/
|
|
290
|
-
PageSize?: string | undefined;
|
|
291
|
-
/**
|
|
292
|
-
* <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
|
|
293
|
-
* @public
|
|
294
|
-
*/
|
|
295
|
-
Token?: string | undefined;
|
|
296
|
-
}
|
|
297
|
-
/**
|
|
298
|
-
* <p>Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.</p>
|
|
299
|
-
* @public
|
|
300
|
-
*/
|
|
301
|
-
export interface ImportJobsResponse {
|
|
302
|
-
/**
|
|
303
|
-
* <p>An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).</p>
|
|
304
|
-
* @public
|
|
305
|
-
*/
|
|
306
|
-
Item: ImportJobResponse[] | undefined;
|
|
307
|
-
/**
|
|
308
|
-
* <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
|
|
309
|
-
* @public
|
|
310
|
-
*/
|
|
311
|
-
NextToken?: string | undefined;
|
|
312
|
-
}
|
|
313
|
-
/**
|
|
314
|
-
* @public
|
|
315
|
-
*/
|
|
316
|
-
export interface GetImportJobsResponse {
|
|
317
|
-
/**
|
|
318
|
-
* <p>Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.</p>
|
|
319
|
-
* @public
|
|
320
|
-
*/
|
|
321
|
-
ImportJobsResponse: ImportJobsResponse | undefined;
|
|
322
|
-
}
|
|
323
|
-
/**
|
|
324
|
-
* @public
|
|
325
|
-
*/
|
|
326
|
-
export interface GetInAppMessagesRequest {
|
|
327
|
-
/**
|
|
328
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
329
|
-
* @public
|
|
330
|
-
*/
|
|
331
|
-
ApplicationId: string | undefined;
|
|
332
|
-
/**
|
|
333
|
-
* <p>The unique identifier for the endpoint.</p>
|
|
334
|
-
* @public
|
|
335
|
-
*/
|
|
336
|
-
EndpointId: string | undefined;
|
|
337
|
-
}
|
|
338
|
-
/**
|
|
339
|
-
* <p>Provides all fields required for building an in-app message.</p>
|
|
340
|
-
* @public
|
|
341
|
-
*/
|
|
342
|
-
export interface InAppMessage {
|
|
343
|
-
/**
|
|
344
|
-
* <p>In-app message content.</p>
|
|
345
|
-
* @public
|
|
346
|
-
*/
|
|
347
|
-
Content?: InAppMessageContent[] | undefined;
|
|
348
|
-
/**
|
|
349
|
-
* <p>Custom config to be sent to SDK.</p>
|
|
350
|
-
* @public
|
|
351
|
-
*/
|
|
352
|
-
CustomConfig?: Record<string, string> | undefined;
|
|
353
|
-
/**
|
|
354
|
-
* <p>The layout of the message.</p>
|
|
355
|
-
* @public
|
|
356
|
-
*/
|
|
357
|
-
Layout?: Layout | undefined;
|
|
358
|
-
}
|
|
359
|
-
/**
|
|
360
|
-
* <p>Schedule of the campaign.</p>
|
|
361
|
-
* @public
|
|
362
|
-
*/
|
|
363
|
-
export interface InAppCampaignSchedule {
|
|
364
|
-
/**
|
|
365
|
-
* <p>The scheduled time after which the in-app message should not be shown. Timestamp is in ISO 8601 format.</p>
|
|
366
|
-
* @public
|
|
367
|
-
*/
|
|
368
|
-
EndDate?: string | undefined;
|
|
369
|
-
/**
|
|
370
|
-
* <p>The event filter the SDK has to use to show the in-app message in the application.</p>
|
|
371
|
-
* @public
|
|
372
|
-
*/
|
|
373
|
-
EventFilter?: CampaignEventFilter | undefined;
|
|
374
|
-
/**
|
|
375
|
-
* <p>Time during which the in-app message should not be shown to the user.</p>
|
|
376
|
-
* @public
|
|
377
|
-
*/
|
|
378
|
-
QuietTime?: QuietTime | undefined;
|
|
379
|
-
}
|
|
380
|
-
/**
|
|
381
|
-
* <p>Targeted in-app message campaign.</p>
|
|
382
|
-
* @public
|
|
383
|
-
*/
|
|
384
|
-
export interface InAppMessageCampaign {
|
|
385
|
-
/**
|
|
386
|
-
* <p>Campaign id of the corresponding campaign.</p>
|
|
387
|
-
* @public
|
|
388
|
-
*/
|
|
389
|
-
CampaignId?: string | undefined;
|
|
390
|
-
/**
|
|
391
|
-
* <p>Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.</p>
|
|
392
|
-
* @public
|
|
393
|
-
*/
|
|
394
|
-
DailyCap?: number | undefined;
|
|
395
|
-
/**
|
|
396
|
-
* <p>In-app message content with all fields required for rendering an in-app message.</p>
|
|
397
|
-
* @public
|
|
398
|
-
*/
|
|
399
|
-
InAppMessage?: InAppMessage | undefined;
|
|
400
|
-
/**
|
|
401
|
-
* <p>Priority of the in-app message.</p>
|
|
402
|
-
* @public
|
|
403
|
-
*/
|
|
404
|
-
Priority?: number | undefined;
|
|
405
|
-
/**
|
|
406
|
-
* <p>Schedule of the campaign.</p>
|
|
407
|
-
* @public
|
|
408
|
-
*/
|
|
409
|
-
Schedule?: InAppCampaignSchedule | undefined;
|
|
410
|
-
/**
|
|
411
|
-
* <p>Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.</p>
|
|
412
|
-
* @public
|
|
413
|
-
*/
|
|
414
|
-
SessionCap?: number | undefined;
|
|
415
|
-
/**
|
|
416
|
-
* <p>Total cap which controls the number of times an in-app message can be shown to the endpoint.</p>
|
|
417
|
-
* @public
|
|
418
|
-
*/
|
|
419
|
-
TotalCap?: number | undefined;
|
|
420
|
-
/**
|
|
421
|
-
* <p>Treatment id of the campaign.</p>
|
|
422
|
-
* @public
|
|
423
|
-
*/
|
|
424
|
-
TreatmentId?: string | undefined;
|
|
425
|
-
}
|
|
426
|
-
/**
|
|
427
|
-
* <p>Get in-app messages response object.</p>
|
|
428
|
-
* @public
|
|
429
|
-
*/
|
|
430
|
-
export interface InAppMessagesResponse {
|
|
431
|
-
/**
|
|
432
|
-
* <p>List of targeted in-app message campaigns.</p>
|
|
433
|
-
* @public
|
|
434
|
-
*/
|
|
435
|
-
InAppMessageCampaigns?: InAppMessageCampaign[] | undefined;
|
|
436
|
-
}
|
|
437
|
-
/**
|
|
438
|
-
* @public
|
|
439
|
-
*/
|
|
440
|
-
export interface GetInAppMessagesResponse {
|
|
441
|
-
/**
|
|
442
|
-
* <p>Get in-app messages response object.</p>
|
|
443
|
-
* @public
|
|
444
|
-
*/
|
|
445
|
-
InAppMessagesResponse: InAppMessagesResponse | undefined;
|
|
446
|
-
}
|
|
447
|
-
/**
|
|
448
|
-
* @public
|
|
449
|
-
*/
|
|
450
|
-
export interface GetInAppTemplateRequest {
|
|
451
|
-
/**
|
|
452
|
-
* <p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>
|
|
453
|
-
* @public
|
|
454
|
-
*/
|
|
455
|
-
TemplateName: string | undefined;
|
|
456
|
-
/**
|
|
457
|
-
* <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
|
|
458
|
-
* @public
|
|
459
|
-
*/
|
|
460
|
-
Version?: string | undefined;
|
|
461
|
-
}
|
|
462
|
-
/**
|
|
463
|
-
* <p>In-App Template Response.</p>
|
|
464
|
-
* @public
|
|
465
|
-
*/
|
|
466
|
-
export interface InAppTemplateResponse {
|
|
467
|
-
/**
|
|
468
|
-
* <p>The resource arn of the template.</p>
|
|
469
|
-
* @public
|
|
470
|
-
*/
|
|
471
|
-
Arn?: string | undefined;
|
|
472
|
-
/**
|
|
473
|
-
* <p>The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.</p>
|
|
474
|
-
* @public
|
|
475
|
-
*/
|
|
476
|
-
Content?: InAppMessageContent[] | undefined;
|
|
477
|
-
/**
|
|
478
|
-
* <p>The creation date of the template.</p>
|
|
479
|
-
* @public
|
|
480
|
-
*/
|
|
481
|
-
CreationDate: string | undefined;
|
|
482
|
-
/**
|
|
483
|
-
* <p>Custom config to be sent to client.</p>
|
|
484
|
-
* @public
|
|
485
|
-
*/
|
|
486
|
-
CustomConfig?: Record<string, string> | undefined;
|
|
487
|
-
/**
|
|
488
|
-
* <p>The last modified date of the template.</p>
|
|
489
|
-
* @public
|
|
490
|
-
*/
|
|
491
|
-
LastModifiedDate: string | undefined;
|
|
492
|
-
/**
|
|
493
|
-
* <p>The layout of the message.</p>
|
|
494
|
-
* @public
|
|
495
|
-
*/
|
|
496
|
-
Layout?: Layout | undefined;
|
|
497
|
-
/**
|
|
498
|
-
* <p>A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.</p>
|
|
499
|
-
* @public
|
|
500
|
-
*/
|
|
501
|
-
tags?: Record<string, string> | undefined;
|
|
502
|
-
/**
|
|
503
|
-
* <p>The description of the template.</p>
|
|
504
|
-
* @public
|
|
505
|
-
*/
|
|
506
|
-
TemplateDescription?: string | undefined;
|
|
507
|
-
/**
|
|
508
|
-
* <p>The name of the template.</p>
|
|
509
|
-
* @public
|
|
510
|
-
*/
|
|
511
|
-
TemplateName: string | undefined;
|
|
512
|
-
/**
|
|
513
|
-
* <p>The type of the template.</p>
|
|
514
|
-
* @public
|
|
515
|
-
*/
|
|
516
|
-
TemplateType: TemplateType | undefined;
|
|
517
|
-
/**
|
|
518
|
-
* <p>The version id of the template.</p>
|
|
519
|
-
* @public
|
|
520
|
-
*/
|
|
521
|
-
Version?: string | undefined;
|
|
522
|
-
}
|
|
523
|
-
/**
|
|
524
|
-
* @public
|
|
525
|
-
*/
|
|
526
|
-
export interface GetInAppTemplateResponse {
|
|
527
|
-
/**
|
|
528
|
-
* <p>In-App Template Response.</p>
|
|
529
|
-
* @public
|
|
530
|
-
*/
|
|
531
|
-
InAppTemplateResponse: InAppTemplateResponse | undefined;
|
|
532
|
-
}
|
|
533
|
-
/**
|
|
534
|
-
* @public
|
|
535
|
-
*/
|
|
536
|
-
export interface GetJourneyRequest {
|
|
537
|
-
/**
|
|
538
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
539
|
-
* @public
|
|
540
|
-
*/
|
|
541
|
-
ApplicationId: string | undefined;
|
|
542
|
-
/**
|
|
543
|
-
* <p>The unique identifier for the journey.</p>
|
|
544
|
-
* @public
|
|
545
|
-
*/
|
|
546
|
-
JourneyId: string | undefined;
|
|
547
|
-
}
|
|
1
|
+
import { DeliveryStatus, JourneyRunStatus, State, TemplateType } from "./enums";
|
|
2
|
+
import { AddressConfiguration, ADMChannelRequest, ADMChannelResponse, AndroidPushNotificationTemplate, APNSChannelRequest, APNSChannelResponse, APNSPushNotificationTemplate, APNSSandboxChannelRequest, APNSSandboxChannelResponse, APNSVoipChannelRequest, APNSVoipChannelResponse, APNSVoipSandboxChannelRequest, APNSVoipSandboxChannelResponse, ApplicationSettingsJourneyLimits, ApplicationSettingsResource, AttributesResource, BaiduChannelRequest, BaiduChannelResponse, BaseKpiResult, CampaignHook, CampaignLimits, CampaignResponse, DefaultPushNotificationTemplate, DirectMessageConfiguration, EmailChannelRequest, EmailChannelResponse, EmailTemplateRequest, EndpointBatchRequest, EndpointMessageResult, EndpointRequest, EndpointSendConfiguration, EndpointsResponse, EventsRequest, EventsResponse, EventStream, ExportJobsResponse, GCMChannelRequest, GCMChannelResponse, ImportJobsResponse, InAppTemplateRequest, JourneyResponse, MessageBody, PushNotificationTemplateRequest, QuietTime, RecommenderConfigurationResponse, SegmentResponse, SMSChannelResponse, SMSTemplateRequest, TemplateConfiguration, VoiceChannelResponse, VoiceTemplateRequest, WriteCampaignRequest, WriteJourneyRequest, WriteSegmentRequest } from "./models_0";
|
|
548
3
|
/**
|
|
549
4
|
* @public
|
|
550
5
|
*/
|
|
@@ -965,20 +420,6 @@ export interface GetJourneyRunsRequest {
|
|
|
965
420
|
*/
|
|
966
421
|
Token?: string | undefined;
|
|
967
422
|
}
|
|
968
|
-
/**
|
|
969
|
-
* @public
|
|
970
|
-
* @enum
|
|
971
|
-
*/
|
|
972
|
-
export declare const JourneyRunStatus: {
|
|
973
|
-
readonly CANCELLED: "CANCELLED";
|
|
974
|
-
readonly COMPLETED: "COMPLETED";
|
|
975
|
-
readonly RUNNING: "RUNNING";
|
|
976
|
-
readonly SCHEDULED: "SCHEDULED";
|
|
977
|
-
};
|
|
978
|
-
/**
|
|
979
|
-
* @public
|
|
980
|
-
*/
|
|
981
|
-
export type JourneyRunStatus = (typeof JourneyRunStatus)[keyof typeof JourneyRunStatus];
|
|
982
423
|
/**
|
|
983
424
|
* <p>Provides information from a specified run of a journey.</p>
|
|
984
425
|
* @public
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { GetChannelsRequest, GetChannelsResponse } from "../models/
|
|
3
|
+
import { GetChannelsRequest, GetChannelsResponse } from "../models/models_0";
|
|
4
4
|
import {
|
|
5
5
|
PinpointClientResolvedConfig,
|
|
6
6
|
ServiceInputTypes,
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { GetEndpointRequest, GetEndpointResponse } from "../models/
|
|
3
|
+
import { GetEndpointRequest, GetEndpointResponse } from "../models/models_0";
|
|
4
4
|
import {
|
|
5
5
|
PinpointClientResolvedConfig,
|
|
6
6
|
ServiceInputTypes,
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { GetExportJobRequest, GetExportJobResponse } from "../models/
|
|
3
|
+
import { GetExportJobRequest, GetExportJobResponse } from "../models/models_0";
|
|
4
4
|
import {
|
|
5
5
|
PinpointClientResolvedConfig,
|
|
6
6
|
ServiceInputTypes,
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { GetImportJobRequest, GetImportJobResponse } from "../models/
|
|
3
|
+
import { GetImportJobRequest, GetImportJobResponse } from "../models/models_0";
|
|
4
4
|
import {
|
|
5
5
|
PinpointClientResolvedConfig,
|
|
6
6
|
ServiceInputTypes,
|