@aws-sdk/client-pinpoint 3.319.0 → 3.321.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/README.md +24 -0
- package/dist-cjs/Pinpoint.js +6 -0
- package/dist-cjs/commands/GetJourneyRunExecutionActivityMetricsCommand.js +45 -0
- package/dist-cjs/commands/GetJourneyRunExecutionMetricsCommand.js +45 -0
- package/dist-cjs/commands/GetJourneyRunsCommand.js +45 -0
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_1.js +7 -0
- package/dist-cjs/protocols/Aws_restJson1.js +226 -4
- package/dist-es/Pinpoint.js +6 -0
- package/dist-es/commands/GetJourneyRunExecutionActivityMetricsCommand.js +41 -0
- package/dist-es/commands/GetJourneyRunExecutionMetricsCommand.js +41 -0
- package/dist-es/commands/GetJourneyRunsCommand.js +41 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_1.js +6 -1
- package/dist-es/protocols/Aws_restJson1.js +216 -0
- package/dist-types/Pinpoint.d.ts +21 -0
- package/dist-types/PinpointClient.d.ts +5 -2
- package/dist-types/commands/CreateCampaignCommand.d.ts +33 -33
- package/dist-types/commands/CreateImportJobCommand.d.ts +1 -1
- package/dist-types/commands/CreateInAppTemplateCommand.d.ts +10 -10
- package/dist-types/commands/CreateJourneyCommand.d.ts +19 -19
- package/dist-types/commands/CreatePushTemplateCommand.d.ts +5 -5
- package/dist-types/commands/CreateSegmentCommand.d.ts +16 -16
- package/dist-types/commands/GetJourneyRunExecutionActivityMetricsCommand.d.ts +118 -0
- package/dist-types/commands/GetJourneyRunExecutionMetricsCommand.d.ts +116 -0
- package/dist-types/commands/GetJourneyRunsCommand.d.ts +119 -0
- package/dist-types/commands/PutEventsCommand.d.ts +1 -1
- package/dist-types/commands/SendMessagesCommand.d.ts +7 -7
- package/dist-types/commands/SendUsersMessagesCommand.d.ts +6 -6
- package/dist-types/commands/UpdateApplicationSettingsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCampaignCommand.d.ts +33 -33
- package/dist-types/commands/UpdateEndpointCommand.d.ts +1 -1
- package/dist-types/commands/UpdateEndpointsBatchCommand.d.ts +1 -1
- package/dist-types/commands/UpdateInAppTemplateCommand.d.ts +10 -10
- package/dist-types/commands/UpdateJourneyCommand.d.ts +19 -19
- package/dist-types/commands/UpdateJourneyStateCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePushTemplateCommand.d.ts +5 -5
- package/dist-types/commands/UpdateSegmentCommand.d.ts +16 -16
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +30 -26
- package/dist-types/models/models_1.d.ts +215 -3
- package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
- package/dist-types/ts3.4/Pinpoint.d.ts +57 -0
- package/dist-types/ts3.4/PinpointClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/GetJourneyRunExecutionActivityMetricsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/GetJourneyRunExecutionMetricsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/GetJourneyRunsCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +1 -0
- package/dist-types/ts3.4/models/models_1.d.ts +68 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
- package/package.json +1 -1
|
@@ -34,12 +34,12 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
34
34
|
* CustomDeliveryConfiguration: { // CustomDeliveryConfiguration
|
|
35
35
|
* DeliveryUri: "STRING_VALUE", // required
|
|
36
36
|
* EndpointTypes: [ // ListOf__EndpointTypesElement
|
|
37
|
-
* "
|
|
37
|
+
* "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP",
|
|
38
38
|
* ],
|
|
39
39
|
* },
|
|
40
40
|
* MessageConfiguration: { // MessageConfiguration
|
|
41
41
|
* ADMMessage: { // Message
|
|
42
|
-
* Action: "
|
|
42
|
+
* Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
43
43
|
* Body: "STRING_VALUE",
|
|
44
44
|
* ImageIconUrl: "STRING_VALUE",
|
|
45
45
|
* ImageSmallIconUrl: "STRING_VALUE",
|
|
@@ -53,7 +53,7 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
53
53
|
* Url: "STRING_VALUE",
|
|
54
54
|
* },
|
|
55
55
|
* APNSMessage: {
|
|
56
|
-
* Action: "
|
|
56
|
+
* Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
57
57
|
* Body: "STRING_VALUE",
|
|
58
58
|
* ImageIconUrl: "STRING_VALUE",
|
|
59
59
|
* ImageSmallIconUrl: "STRING_VALUE",
|
|
@@ -67,7 +67,7 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
67
67
|
* Url: "STRING_VALUE",
|
|
68
68
|
* },
|
|
69
69
|
* BaiduMessage: {
|
|
70
|
-
* Action: "
|
|
70
|
+
* Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
71
71
|
* Body: "STRING_VALUE",
|
|
72
72
|
* ImageIconUrl: "STRING_VALUE",
|
|
73
73
|
* ImageSmallIconUrl: "STRING_VALUE",
|
|
@@ -84,7 +84,7 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
84
84
|
* Data: "STRING_VALUE",
|
|
85
85
|
* },
|
|
86
86
|
* DefaultMessage: {
|
|
87
|
-
* Action: "
|
|
87
|
+
* Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
88
88
|
* Body: "STRING_VALUE",
|
|
89
89
|
* ImageIconUrl: "STRING_VALUE",
|
|
90
90
|
* ImageSmallIconUrl: "STRING_VALUE",
|
|
@@ -104,7 +104,7 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
104
104
|
* Title: "STRING_VALUE",
|
|
105
105
|
* },
|
|
106
106
|
* GCMMessage: {
|
|
107
|
-
* Action: "
|
|
107
|
+
* Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
108
108
|
* Body: "STRING_VALUE",
|
|
109
109
|
* ImageIconUrl: "STRING_VALUE",
|
|
110
110
|
* ImageSmallIconUrl: "STRING_VALUE",
|
|
@@ -119,7 +119,7 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
119
119
|
* },
|
|
120
120
|
* SMSMessage: { // CampaignSmsMessage
|
|
121
121
|
* Body: "STRING_VALUE",
|
|
122
|
-
* MessageType: "
|
|
122
|
+
* MessageType: "TRANSACTIONAL" || "PROMOTIONAL",
|
|
123
123
|
* OriginationNumber: "STRING_VALUE",
|
|
124
124
|
* SenderId: "STRING_VALUE",
|
|
125
125
|
* EntityId: "STRING_VALUE",
|
|
@@ -131,53 +131,53 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
131
131
|
* { // InAppMessageContent
|
|
132
132
|
* BackgroundColor: "STRING_VALUE",
|
|
133
133
|
* BodyConfig: { // InAppMessageBodyConfig
|
|
134
|
-
* Alignment: "
|
|
134
|
+
* Alignment: "LEFT" || "CENTER" || "RIGHT", // required
|
|
135
135
|
* Body: "STRING_VALUE", // required
|
|
136
136
|
* TextColor: "STRING_VALUE", // required
|
|
137
137
|
* },
|
|
138
138
|
* HeaderConfig: { // InAppMessageHeaderConfig
|
|
139
|
-
* Alignment: "
|
|
139
|
+
* Alignment: "LEFT" || "CENTER" || "RIGHT", // required
|
|
140
140
|
* Header: "STRING_VALUE", // required
|
|
141
141
|
* TextColor: "STRING_VALUE", // required
|
|
142
142
|
* },
|
|
143
143
|
* ImageUrl: "STRING_VALUE",
|
|
144
144
|
* PrimaryBtn: { // InAppMessageButton
|
|
145
145
|
* Android: { // OverrideButtonConfiguration
|
|
146
|
-
* ButtonAction: "
|
|
146
|
+
* ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
147
147
|
* Link: "STRING_VALUE",
|
|
148
148
|
* },
|
|
149
149
|
* DefaultConfig: { // DefaultButtonConfiguration
|
|
150
150
|
* BackgroundColor: "STRING_VALUE",
|
|
151
151
|
* BorderRadius: Number("int"),
|
|
152
|
-
* ButtonAction: "
|
|
152
|
+
* ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
153
153
|
* Link: "STRING_VALUE",
|
|
154
154
|
* Text: "STRING_VALUE", // required
|
|
155
155
|
* TextColor: "STRING_VALUE",
|
|
156
156
|
* },
|
|
157
157
|
* IOS: {
|
|
158
|
-
* ButtonAction: "
|
|
158
|
+
* ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
159
159
|
* Link: "STRING_VALUE",
|
|
160
160
|
* },
|
|
161
161
|
* Web: {
|
|
162
|
-
* ButtonAction: "
|
|
162
|
+
* ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
163
163
|
* Link: "STRING_VALUE",
|
|
164
164
|
* },
|
|
165
165
|
* },
|
|
166
166
|
* SecondaryBtn: {
|
|
167
167
|
* Android: {
|
|
168
|
-
* ButtonAction: "
|
|
168
|
+
* ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
169
169
|
* Link: "STRING_VALUE",
|
|
170
170
|
* },
|
|
171
171
|
* DefaultConfig: {
|
|
172
172
|
* BackgroundColor: "STRING_VALUE",
|
|
173
173
|
* BorderRadius: Number("int"),
|
|
174
|
-
* ButtonAction: "
|
|
174
|
+
* ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
175
175
|
* Link: "STRING_VALUE",
|
|
176
176
|
* Text: "STRING_VALUE", // required
|
|
177
177
|
* TextColor: "STRING_VALUE",
|
|
178
178
|
* },
|
|
179
179
|
* IOS: {
|
|
180
|
-
* ButtonAction: "
|
|
180
|
+
* ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
181
181
|
* Link: "STRING_VALUE",
|
|
182
182
|
* },
|
|
183
183
|
* Web: "<OverrideButtonConfiguration>",
|
|
@@ -187,7 +187,7 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
187
187
|
* CustomConfig: { // MapOf__string
|
|
188
188
|
* "<keys>": "STRING_VALUE",
|
|
189
189
|
* },
|
|
190
|
-
* Layout: "
|
|
190
|
+
* Layout: "BOTTOM_BANNER" || "TOP_BANNER" || "OVERLAYS" || "MOBILE_FEED" || "MIDDLE_BANNER" || "CAROUSEL",
|
|
191
191
|
* },
|
|
192
192
|
* },
|
|
193
193
|
* Schedule: { // Schedule
|
|
@@ -196,14 +196,14 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
196
196
|
* Dimensions: { // EventDimensions
|
|
197
197
|
* Attributes: { // MapOfAttributeDimension
|
|
198
198
|
* "<keys>": { // AttributeDimension
|
|
199
|
-
* AttributeType: "
|
|
199
|
+
* AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
200
200
|
* Values: [ // ListOf__string // required
|
|
201
201
|
* "STRING_VALUE",
|
|
202
202
|
* ],
|
|
203
203
|
* },
|
|
204
204
|
* },
|
|
205
205
|
* EventType: { // SetDimension
|
|
206
|
-
* DimensionType: "
|
|
206
|
+
* DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
207
207
|
* Values: [ // required
|
|
208
208
|
* "STRING_VALUE",
|
|
209
209
|
* ],
|
|
@@ -215,9 +215,9 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
215
215
|
* },
|
|
216
216
|
* },
|
|
217
217
|
* },
|
|
218
|
-
* FilterType: "
|
|
218
|
+
* FilterType: "SYSTEM" || "ENDPOINT", // required
|
|
219
219
|
* },
|
|
220
|
-
* Frequency: "
|
|
220
|
+
* Frequency: "ONCE" || "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "EVENT" || "IN_APP_EVENT",
|
|
221
221
|
* IsLocalTime: true || false,
|
|
222
222
|
* QuietTime: { // QuietTime
|
|
223
223
|
* End: "STRING_VALUE",
|
|
@@ -252,14 +252,14 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
252
252
|
* CustomDeliveryConfiguration: {
|
|
253
253
|
* DeliveryUri: "STRING_VALUE", // required
|
|
254
254
|
* EndpointTypes: [
|
|
255
|
-
* "
|
|
255
|
+
* "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP",
|
|
256
256
|
* ],
|
|
257
257
|
* },
|
|
258
258
|
* Description: "STRING_VALUE",
|
|
259
259
|
* HoldoutPercent: Number("int"),
|
|
260
260
|
* Hook: { // CampaignHook
|
|
261
261
|
* LambdaFunctionName: "STRING_VALUE",
|
|
262
|
-
* Mode: "
|
|
262
|
+
* Mode: "DELIVERY" || "FILTER",
|
|
263
263
|
* WebUrl: "STRING_VALUE",
|
|
264
264
|
* },
|
|
265
265
|
* IsPaused: true || false,
|
|
@@ -287,7 +287,7 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
287
287
|
* GCMMessage: "<Message>",
|
|
288
288
|
* SMSMessage: {
|
|
289
289
|
* Body: "STRING_VALUE",
|
|
290
|
-
* MessageType: "
|
|
290
|
+
* MessageType: "TRANSACTIONAL" || "PROMOTIONAL",
|
|
291
291
|
* OriginationNumber: "STRING_VALUE",
|
|
292
292
|
* SenderId: "STRING_VALUE",
|
|
293
293
|
* EntityId: "STRING_VALUE",
|
|
@@ -299,12 +299,12 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
299
299
|
* {
|
|
300
300
|
* BackgroundColor: "STRING_VALUE",
|
|
301
301
|
* BodyConfig: {
|
|
302
|
-
* Alignment: "
|
|
302
|
+
* Alignment: "LEFT" || "CENTER" || "RIGHT", // required
|
|
303
303
|
* Body: "STRING_VALUE", // required
|
|
304
304
|
* TextColor: "STRING_VALUE", // required
|
|
305
305
|
* },
|
|
306
306
|
* HeaderConfig: {
|
|
307
|
-
* Alignment: "
|
|
307
|
+
* Alignment: "LEFT" || "CENTER" || "RIGHT", // required
|
|
308
308
|
* Header: "STRING_VALUE", // required
|
|
309
309
|
* TextColor: "STRING_VALUE", // required
|
|
310
310
|
* },
|
|
@@ -314,7 +314,7 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
314
314
|
* DefaultConfig: {
|
|
315
315
|
* BackgroundColor: "STRING_VALUE",
|
|
316
316
|
* BorderRadius: Number("int"),
|
|
317
|
-
* ButtonAction: "
|
|
317
|
+
* ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
318
318
|
* Link: "STRING_VALUE",
|
|
319
319
|
* Text: "STRING_VALUE", // required
|
|
320
320
|
* TextColor: "STRING_VALUE",
|
|
@@ -327,7 +327,7 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
327
327
|
* DefaultConfig: {
|
|
328
328
|
* BackgroundColor: "STRING_VALUE",
|
|
329
329
|
* BorderRadius: Number("int"),
|
|
330
|
-
* ButtonAction: "
|
|
330
|
+
* ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
331
331
|
* Link: "STRING_VALUE",
|
|
332
332
|
* Text: "STRING_VALUE", // required
|
|
333
333
|
* TextColor: "STRING_VALUE",
|
|
@@ -340,7 +340,7 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
340
340
|
* CustomConfig: {
|
|
341
341
|
* "<keys>": "STRING_VALUE",
|
|
342
342
|
* },
|
|
343
|
-
* Layout: "
|
|
343
|
+
* Layout: "BOTTOM_BANNER" || "TOP_BANNER" || "OVERLAYS" || "MOBILE_FEED" || "MIDDLE_BANNER" || "CAROUSEL",
|
|
344
344
|
* },
|
|
345
345
|
* },
|
|
346
346
|
* Name: "STRING_VALUE",
|
|
@@ -350,12 +350,12 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
350
350
|
* Dimensions: {
|
|
351
351
|
* Attributes: {
|
|
352
352
|
* "<keys>": {
|
|
353
|
-
* AttributeType: "
|
|
353
|
+
* AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
354
354
|
* Values: "<ListOf__string>", // required
|
|
355
355
|
* },
|
|
356
356
|
* },
|
|
357
357
|
* EventType: {
|
|
358
|
-
* DimensionType: "
|
|
358
|
+
* DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
359
359
|
* Values: "<ListOf__string>", // required
|
|
360
360
|
* },
|
|
361
361
|
* Metrics: {
|
|
@@ -365,9 +365,9 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
365
365
|
* },
|
|
366
366
|
* },
|
|
367
367
|
* },
|
|
368
|
-
* FilterType: "
|
|
368
|
+
* FilterType: "SYSTEM" || "ENDPOINT", // required
|
|
369
369
|
* },
|
|
370
|
-
* Frequency: "
|
|
370
|
+
* Frequency: "ONCE" || "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "EVENT" || "IN_APP_EVENT",
|
|
371
371
|
* IsLocalTime: true || false,
|
|
372
372
|
* QuietTime: {
|
|
373
373
|
* End: "STRING_VALUE",
|
|
@@ -31,7 +31,7 @@ export interface CreateImportJobCommandOutput extends CreateImportJobResponse, _
|
|
|
31
31
|
* ImportJobRequest: { // ImportJobRequest
|
|
32
32
|
* DefineSegment: true || false,
|
|
33
33
|
* ExternalId: "STRING_VALUE",
|
|
34
|
-
* Format: "
|
|
34
|
+
* Format: "CSV" || "JSON", // required
|
|
35
35
|
* RegisterEndpoints: true || false,
|
|
36
36
|
* RoleArn: "STRING_VALUE", // required
|
|
37
37
|
* S3Url: "STRING_VALUE", // required
|
|
@@ -32,53 +32,53 @@ export interface CreateInAppTemplateCommandOutput extends CreateInAppTemplateRes
|
|
|
32
32
|
* { // InAppMessageContent
|
|
33
33
|
* BackgroundColor: "STRING_VALUE",
|
|
34
34
|
* BodyConfig: { // InAppMessageBodyConfig
|
|
35
|
-
* Alignment: "
|
|
35
|
+
* Alignment: "LEFT" || "CENTER" || "RIGHT", // required
|
|
36
36
|
* Body: "STRING_VALUE", // required
|
|
37
37
|
* TextColor: "STRING_VALUE", // required
|
|
38
38
|
* },
|
|
39
39
|
* HeaderConfig: { // InAppMessageHeaderConfig
|
|
40
|
-
* Alignment: "
|
|
40
|
+
* Alignment: "LEFT" || "CENTER" || "RIGHT", // required
|
|
41
41
|
* Header: "STRING_VALUE", // required
|
|
42
42
|
* TextColor: "STRING_VALUE", // required
|
|
43
43
|
* },
|
|
44
44
|
* ImageUrl: "STRING_VALUE",
|
|
45
45
|
* PrimaryBtn: { // InAppMessageButton
|
|
46
46
|
* Android: { // OverrideButtonConfiguration
|
|
47
|
-
* ButtonAction: "
|
|
47
|
+
* ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
48
48
|
* Link: "STRING_VALUE",
|
|
49
49
|
* },
|
|
50
50
|
* DefaultConfig: { // DefaultButtonConfiguration
|
|
51
51
|
* BackgroundColor: "STRING_VALUE",
|
|
52
52
|
* BorderRadius: Number("int"),
|
|
53
|
-
* ButtonAction: "
|
|
53
|
+
* ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
54
54
|
* Link: "STRING_VALUE",
|
|
55
55
|
* Text: "STRING_VALUE", // required
|
|
56
56
|
* TextColor: "STRING_VALUE",
|
|
57
57
|
* },
|
|
58
58
|
* IOS: {
|
|
59
|
-
* ButtonAction: "
|
|
59
|
+
* ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
60
60
|
* Link: "STRING_VALUE",
|
|
61
61
|
* },
|
|
62
62
|
* Web: {
|
|
63
|
-
* ButtonAction: "
|
|
63
|
+
* ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
64
64
|
* Link: "STRING_VALUE",
|
|
65
65
|
* },
|
|
66
66
|
* },
|
|
67
67
|
* SecondaryBtn: {
|
|
68
68
|
* Android: {
|
|
69
|
-
* ButtonAction: "
|
|
69
|
+
* ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
70
70
|
* Link: "STRING_VALUE",
|
|
71
71
|
* },
|
|
72
72
|
* DefaultConfig: {
|
|
73
73
|
* BackgroundColor: "STRING_VALUE",
|
|
74
74
|
* BorderRadius: Number("int"),
|
|
75
|
-
* ButtonAction: "
|
|
75
|
+
* ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
76
76
|
* Link: "STRING_VALUE",
|
|
77
77
|
* Text: "STRING_VALUE", // required
|
|
78
78
|
* TextColor: "STRING_VALUE",
|
|
79
79
|
* },
|
|
80
80
|
* IOS: {
|
|
81
|
-
* ButtonAction: "
|
|
81
|
+
* ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
82
82
|
* Link: "STRING_VALUE",
|
|
83
83
|
* },
|
|
84
84
|
* Web: "<OverrideButtonConfiguration>",
|
|
@@ -88,7 +88,7 @@ export interface CreateInAppTemplateCommandOutput extends CreateInAppTemplateRes
|
|
|
88
88
|
* CustomConfig: { // MapOf__string
|
|
89
89
|
* "<keys>": "STRING_VALUE",
|
|
90
90
|
* },
|
|
91
|
-
* Layout: "
|
|
91
|
+
* Layout: "BOTTOM_BANNER" || "TOP_BANNER" || "OVERLAYS" || "MOBILE_FEED" || "MIDDLE_BANNER" || "CAROUSEL",
|
|
92
92
|
* tags: {
|
|
93
93
|
* "<keys>": "STRING_VALUE",
|
|
94
94
|
* },
|
|
@@ -34,7 +34,7 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
34
34
|
* CUSTOM: { // CustomMessageActivity
|
|
35
35
|
* DeliveryUri: "STRING_VALUE",
|
|
36
36
|
* EndpointTypes: [ // ListOf__EndpointTypesElement
|
|
37
|
-
* "
|
|
37
|
+
* "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP",
|
|
38
38
|
* ],
|
|
39
39
|
* MessageConfig: { // JourneyCustomMessage
|
|
40
40
|
* Data: "STRING_VALUE",
|
|
@@ -51,14 +51,14 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
51
51
|
* Dimensions: { // EventDimensions
|
|
52
52
|
* Attributes: { // MapOfAttributeDimension
|
|
53
53
|
* "<keys>": { // AttributeDimension
|
|
54
|
-
* AttributeType: "
|
|
54
|
+
* AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
55
55
|
* Values: [ // ListOf__string // required
|
|
56
56
|
* "STRING_VALUE",
|
|
57
57
|
* ],
|
|
58
58
|
* },
|
|
59
59
|
* },
|
|
60
60
|
* EventType: { // SetDimension
|
|
61
|
-
* DimensionType: "
|
|
61
|
+
* DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
62
62
|
* Values: [ // required
|
|
63
63
|
* "STRING_VALUE",
|
|
64
64
|
* ],
|
|
@@ -78,7 +78,7 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
78
78
|
* SegmentDimensions: { // SegmentDimensions
|
|
79
79
|
* Attributes: {
|
|
80
80
|
* "<keys>": {
|
|
81
|
-
* AttributeType: "
|
|
81
|
+
* AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
82
82
|
* Values: [ // required
|
|
83
83
|
* "STRING_VALUE",
|
|
84
84
|
* ],
|
|
@@ -86,29 +86,29 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
86
86
|
* },
|
|
87
87
|
* Behavior: { // SegmentBehaviors
|
|
88
88
|
* Recency: { // RecencyDimension
|
|
89
|
-
* Duration: "
|
|
90
|
-
* RecencyType: "
|
|
89
|
+
* Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required
|
|
90
|
+
* RecencyType: "ACTIVE" || "INACTIVE", // required
|
|
91
91
|
* },
|
|
92
92
|
* },
|
|
93
93
|
* Demographic: { // SegmentDemographics
|
|
94
94
|
* AppVersion: {
|
|
95
|
-
* DimensionType: "
|
|
95
|
+
* DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
96
96
|
* Values: [ // required
|
|
97
97
|
* "STRING_VALUE",
|
|
98
98
|
* ],
|
|
99
99
|
* },
|
|
100
100
|
* Channel: {
|
|
101
|
-
* DimensionType: "
|
|
101
|
+
* DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
102
102
|
* Values: [ // required
|
|
103
103
|
* "STRING_VALUE",
|
|
104
104
|
* ],
|
|
105
105
|
* },
|
|
106
106
|
* DeviceType: {
|
|
107
|
-
* DimensionType: "
|
|
107
|
+
* DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
108
108
|
* Values: "<ListOf__string>", // required
|
|
109
109
|
* },
|
|
110
110
|
* Make: {
|
|
111
|
-
* DimensionType: "
|
|
111
|
+
* DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
112
112
|
* Values: "<ListOf__string>", // required
|
|
113
113
|
* },
|
|
114
114
|
* Model: "<SetDimension>",
|
|
@@ -132,14 +132,14 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
132
132
|
* },
|
|
133
133
|
* UserAttributes: {
|
|
134
134
|
* "<keys>": {
|
|
135
|
-
* AttributeType: "
|
|
135
|
+
* AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
136
136
|
* Values: "<ListOf__string>", // required
|
|
137
137
|
* },
|
|
138
138
|
* },
|
|
139
139
|
* },
|
|
140
140
|
* },
|
|
141
141
|
* ],
|
|
142
|
-
* Operator: "
|
|
142
|
+
* Operator: "ALL" || "ANY",
|
|
143
143
|
* },
|
|
144
144
|
* EvaluationWaitTime: { // WaitTime
|
|
145
145
|
* WaitFor: "STRING_VALUE",
|
|
@@ -169,7 +169,7 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
169
169
|
* Dimensions: {
|
|
170
170
|
* Attributes: {
|
|
171
171
|
* "<keys>": {
|
|
172
|
-
* AttributeType: "
|
|
172
|
+
* AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
173
173
|
* Values: "<ListOf__string>", // required
|
|
174
174
|
* },
|
|
175
175
|
* },
|
|
@@ -189,14 +189,14 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
189
189
|
* SegmentDimensions: {
|
|
190
190
|
* Attributes: {
|
|
191
191
|
* "<keys>": {
|
|
192
|
-
* AttributeType: "
|
|
192
|
+
* AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
193
193
|
* Values: "<ListOf__string>", // required
|
|
194
194
|
* },
|
|
195
195
|
* },
|
|
196
196
|
* Behavior: {
|
|
197
197
|
* Recency: {
|
|
198
|
-
* Duration: "
|
|
199
|
-
* RecencyType: "
|
|
198
|
+
* Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required
|
|
199
|
+
* RecencyType: "ACTIVE" || "INACTIVE", // required
|
|
200
200
|
* },
|
|
201
201
|
* },
|
|
202
202
|
* Demographic: {
|
|
@@ -253,7 +253,7 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
253
253
|
* },
|
|
254
254
|
* SMS: { // SMSMessageActivity
|
|
255
255
|
* MessageConfig: { // JourneySMSMessage
|
|
256
|
-
* MessageType: "
|
|
256
|
+
* MessageType: "TRANSACTIONAL" || "PROMOTIONAL",
|
|
257
257
|
* OriginationNumber: "STRING_VALUE",
|
|
258
258
|
* SenderId: "STRING_VALUE",
|
|
259
259
|
* EntityId: "STRING_VALUE",
|
|
@@ -305,7 +305,7 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
305
305
|
* EventType: "<SetDimension>",
|
|
306
306
|
* Metrics: "<MapOfMetricDimension>",
|
|
307
307
|
* },
|
|
308
|
-
* FilterType: "
|
|
308
|
+
* FilterType: "SYSTEM" || "ENDPOINT", // required
|
|
309
309
|
* },
|
|
310
310
|
* SegmentId: "STRING_VALUE",
|
|
311
311
|
* },
|
|
@@ -313,7 +313,7 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
313
313
|
* SegmentId: "STRING_VALUE", // required
|
|
314
314
|
* },
|
|
315
315
|
* },
|
|
316
|
-
* State: "
|
|
316
|
+
* State: "DRAFT" || "ACTIVE" || "COMPLETED" || "CANCELLED" || "CLOSED" || "PAUSED",
|
|
317
317
|
* WaitForQuietTime: true || false,
|
|
318
318
|
* RefreshOnSegmentUpdate: true || false,
|
|
319
319
|
* JourneyChannelSettings: { // JourneyChannelSettings
|
|
@@ -29,7 +29,7 @@ export interface CreatePushTemplateCommandOutput extends CreatePushTemplateRespo
|
|
|
29
29
|
* const input = { // CreatePushTemplateRequest
|
|
30
30
|
* PushNotificationTemplateRequest: { // PushNotificationTemplateRequest
|
|
31
31
|
* ADM: { // AndroidPushNotificationTemplate
|
|
32
|
-
* Action: "
|
|
32
|
+
* Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
33
33
|
* Body: "STRING_VALUE",
|
|
34
34
|
* ImageIconUrl: "STRING_VALUE",
|
|
35
35
|
* ImageUrl: "STRING_VALUE",
|
|
@@ -40,7 +40,7 @@ export interface CreatePushTemplateCommandOutput extends CreatePushTemplateRespo
|
|
|
40
40
|
* Url: "STRING_VALUE",
|
|
41
41
|
* },
|
|
42
42
|
* APNS: { // APNSPushNotificationTemplate
|
|
43
|
-
* Action: "
|
|
43
|
+
* Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
44
44
|
* Body: "STRING_VALUE",
|
|
45
45
|
* MediaUrl: "STRING_VALUE",
|
|
46
46
|
* RawContent: "STRING_VALUE",
|
|
@@ -49,7 +49,7 @@ export interface CreatePushTemplateCommandOutput extends CreatePushTemplateRespo
|
|
|
49
49
|
* Url: "STRING_VALUE",
|
|
50
50
|
* },
|
|
51
51
|
* Baidu: {
|
|
52
|
-
* Action: "
|
|
52
|
+
* Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
53
53
|
* Body: "STRING_VALUE",
|
|
54
54
|
* ImageIconUrl: "STRING_VALUE",
|
|
55
55
|
* ImageUrl: "STRING_VALUE",
|
|
@@ -60,7 +60,7 @@ export interface CreatePushTemplateCommandOutput extends CreatePushTemplateRespo
|
|
|
60
60
|
* Url: "STRING_VALUE",
|
|
61
61
|
* },
|
|
62
62
|
* Default: { // DefaultPushNotificationTemplate
|
|
63
|
-
* Action: "
|
|
63
|
+
* Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
64
64
|
* Body: "STRING_VALUE",
|
|
65
65
|
* Sound: "STRING_VALUE",
|
|
66
66
|
* Title: "STRING_VALUE",
|
|
@@ -68,7 +68,7 @@ export interface CreatePushTemplateCommandOutput extends CreatePushTemplateRespo
|
|
|
68
68
|
* },
|
|
69
69
|
* DefaultSubstitutions: "STRING_VALUE",
|
|
70
70
|
* GCM: {
|
|
71
|
-
* Action: "
|
|
71
|
+
* Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
72
72
|
* Body: "STRING_VALUE",
|
|
73
73
|
* ImageIconUrl: "STRING_VALUE",
|
|
74
74
|
* ImageUrl: "STRING_VALUE",
|
|
@@ -32,7 +32,7 @@ export interface CreateSegmentCommandOutput extends CreateSegmentResponse, __Met
|
|
|
32
32
|
* Dimensions: { // SegmentDimensions
|
|
33
33
|
* Attributes: { // MapOfAttributeDimension
|
|
34
34
|
* "<keys>": { // AttributeDimension
|
|
35
|
-
* AttributeType: "
|
|
35
|
+
* AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
36
36
|
* Values: [ // ListOf__string // required
|
|
37
37
|
* "STRING_VALUE",
|
|
38
38
|
* ],
|
|
@@ -40,37 +40,37 @@ export interface CreateSegmentCommandOutput extends CreateSegmentResponse, __Met
|
|
|
40
40
|
* },
|
|
41
41
|
* Behavior: { // SegmentBehaviors
|
|
42
42
|
* Recency: { // RecencyDimension
|
|
43
|
-
* Duration: "
|
|
44
|
-
* RecencyType: "
|
|
43
|
+
* Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required
|
|
44
|
+
* RecencyType: "ACTIVE" || "INACTIVE", // required
|
|
45
45
|
* },
|
|
46
46
|
* },
|
|
47
47
|
* Demographic: { // SegmentDemographics
|
|
48
48
|
* AppVersion: { // SetDimension
|
|
49
|
-
* DimensionType: "
|
|
49
|
+
* DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
50
50
|
* Values: [ // required
|
|
51
51
|
* "STRING_VALUE",
|
|
52
52
|
* ],
|
|
53
53
|
* },
|
|
54
54
|
* Channel: {
|
|
55
|
-
* DimensionType: "
|
|
55
|
+
* DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
56
56
|
* Values: [ // required
|
|
57
57
|
* "STRING_VALUE",
|
|
58
58
|
* ],
|
|
59
59
|
* },
|
|
60
60
|
* DeviceType: {
|
|
61
|
-
* DimensionType: "
|
|
61
|
+
* DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
62
62
|
* Values: [ // required
|
|
63
63
|
* "STRING_VALUE",
|
|
64
64
|
* ],
|
|
65
65
|
* },
|
|
66
66
|
* Make: {
|
|
67
|
-
* DimensionType: "
|
|
67
|
+
* DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
68
68
|
* Values: [ // required
|
|
69
69
|
* "STRING_VALUE",
|
|
70
70
|
* ],
|
|
71
71
|
* },
|
|
72
72
|
* Model: {
|
|
73
|
-
* DimensionType: "
|
|
73
|
+
* DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
74
74
|
* Values: "<ListOf__string>", // required
|
|
75
75
|
* },
|
|
76
76
|
* Platform: "<SetDimension>",
|
|
@@ -93,7 +93,7 @@ export interface CreateSegmentCommandOutput extends CreateSegmentResponse, __Met
|
|
|
93
93
|
* },
|
|
94
94
|
* UserAttributes: {
|
|
95
95
|
* "<keys>": {
|
|
96
|
-
* AttributeType: "
|
|
96
|
+
* AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
97
97
|
* Values: "<ListOf__string>", // required
|
|
98
98
|
* },
|
|
99
99
|
* },
|
|
@@ -106,14 +106,14 @@ export interface CreateSegmentCommandOutput extends CreateSegmentResponse, __Met
|
|
|
106
106
|
* {
|
|
107
107
|
* Attributes: {
|
|
108
108
|
* "<keys>": {
|
|
109
|
-
* AttributeType: "
|
|
109
|
+
* AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
110
110
|
* Values: "<ListOf__string>", // required
|
|
111
111
|
* },
|
|
112
112
|
* },
|
|
113
113
|
* Behavior: {
|
|
114
114
|
* Recency: {
|
|
115
|
-
* Duration: "
|
|
116
|
-
* RecencyType: "
|
|
115
|
+
* Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required
|
|
116
|
+
* RecencyType: "ACTIVE" || "INACTIVE", // required
|
|
117
117
|
* },
|
|
118
118
|
* },
|
|
119
119
|
* Demographic: {
|
|
@@ -142,7 +142,7 @@ export interface CreateSegmentCommandOutput extends CreateSegmentResponse, __Met
|
|
|
142
142
|
* },
|
|
143
143
|
* UserAttributes: {
|
|
144
144
|
* "<keys>": {
|
|
145
|
-
* AttributeType: "
|
|
145
|
+
* AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
146
146
|
* Values: "<ListOf__string>", // required
|
|
147
147
|
* },
|
|
148
148
|
* },
|
|
@@ -154,11 +154,11 @@ export interface CreateSegmentCommandOutput extends CreateSegmentResponse, __Met
|
|
|
154
154
|
* Version: Number("int"),
|
|
155
155
|
* },
|
|
156
156
|
* ],
|
|
157
|
-
* SourceType: "
|
|
158
|
-
* Type: "
|
|
157
|
+
* SourceType: "ALL" || "ANY" || "NONE",
|
|
158
|
+
* Type: "ALL" || "ANY" || "NONE",
|
|
159
159
|
* },
|
|
160
160
|
* ],
|
|
161
|
-
* Include: "
|
|
161
|
+
* Include: "ALL" || "ANY" || "NONE",
|
|
162
162
|
* },
|
|
163
163
|
* tags: { // MapOf__string
|
|
164
164
|
* "<keys>": "STRING_VALUE",
|