@aws-sdk/client-pinpoint 3.378.0 → 3.380.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-types/commands/CreateCampaignCommand.d.ts +12 -8
- package/dist-types/commands/CreateJourneyCommand.d.ts +10 -0
- package/dist-types/commands/DeleteCampaignCommand.d.ts +6 -4
- package/dist-types/commands/DeleteGcmChannelCommand.d.ts +3 -1
- package/dist-types/commands/DeleteJourneyCommand.d.ts +5 -0
- package/dist-types/commands/GetApplicationSettingsCommand.d.ts +8 -0
- package/dist-types/commands/GetCampaignCommand.d.ts +6 -4
- package/dist-types/commands/GetCampaignVersionCommand.d.ts +8 -5
- package/dist-types/commands/GetCampaignVersionsCommand.d.ts +7 -6
- package/dist-types/commands/GetCampaignsCommand.d.ts +6 -4
- package/dist-types/commands/GetGcmChannelCommand.d.ts +3 -1
- package/dist-types/commands/GetJourneyCommand.d.ts +5 -0
- package/dist-types/commands/ListJourneysCommand.d.ts +5 -0
- package/dist-types/commands/SendMessagesCommand.d.ts +5 -0
- package/dist-types/commands/SendUsersMessagesCommand.d.ts +5 -0
- package/dist-types/commands/UpdateApplicationSettingsCommand.d.ts +16 -0
- package/dist-types/commands/UpdateCampaignCommand.d.ts +12 -8
- package/dist-types/commands/UpdateGcmChannelCommand.d.ts +6 -2
- package/dist-types/commands/UpdateJourneyCommand.d.ts +10 -0
- package/dist-types/commands/UpdateJourneyStateCommand.d.ts +5 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +3 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +71 -33
- package/dist-types/models/models_1.d.ts +37 -3
- package/dist-types/ts3.4/commands/GetCampaignVersionCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/GetCampaignVersionsCommand.d.ts +4 -2
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +20 -11
- package/dist-types/ts3.4/models/models_1.d.ts +11 -0
- package/package.json +6 -6
|
@@ -248,6 +248,10 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
248
248
|
* Name: "STRING_VALUE",
|
|
249
249
|
* Version: "STRING_VALUE",
|
|
250
250
|
* },
|
|
251
|
+
* InAppTemplate: {
|
|
252
|
+
* Name: "STRING_VALUE",
|
|
253
|
+
* Version: "STRING_VALUE",
|
|
254
|
+
* },
|
|
251
255
|
* },
|
|
252
256
|
* TreatmentDescription: "STRING_VALUE",
|
|
253
257
|
* TreatmentName: "STRING_VALUE",
|
|
@@ -384,13 +388,11 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
384
388
|
* SegmentVersion: Number("int"),
|
|
385
389
|
* tags: "<MapOf__string>",
|
|
386
390
|
* TemplateConfiguration: {
|
|
387
|
-
* EmailTemplate:
|
|
388
|
-
* Name: "STRING_VALUE",
|
|
389
|
-
* Version: "STRING_VALUE",
|
|
390
|
-
* },
|
|
391
|
+
* EmailTemplate: "<Template>",
|
|
391
392
|
* PushTemplate: "<Template>",
|
|
392
393
|
* SMSTemplate: "<Template>",
|
|
393
394
|
* VoiceTemplate: "<Template>",
|
|
395
|
+
* InAppTemplate: "<Template>",
|
|
394
396
|
* },
|
|
395
397
|
* TreatmentDescription: "STRING_VALUE",
|
|
396
398
|
* TreatmentName: "STRING_VALUE",
|
|
@@ -620,6 +622,10 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
620
622
|
* // Name: "STRING_VALUE",
|
|
621
623
|
* // Version: "STRING_VALUE",
|
|
622
624
|
* // },
|
|
625
|
+
* // InAppTemplate: {
|
|
626
|
+
* // Name: "STRING_VALUE",
|
|
627
|
+
* // Version: "STRING_VALUE",
|
|
628
|
+
* // },
|
|
623
629
|
* // },
|
|
624
630
|
* // TreatmentDescription: "STRING_VALUE",
|
|
625
631
|
* // TreatmentName: "STRING_VALUE",
|
|
@@ -767,13 +773,11 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
767
773
|
* // },
|
|
768
774
|
* // tags: "<MapOf__string>",
|
|
769
775
|
* // TemplateConfiguration: {
|
|
770
|
-
* // EmailTemplate:
|
|
771
|
-
* // Name: "STRING_VALUE",
|
|
772
|
-
* // Version: "STRING_VALUE",
|
|
773
|
-
* // },
|
|
776
|
+
* // EmailTemplate: "<Template>",
|
|
774
777
|
* // PushTemplate: "<Template>",
|
|
775
778
|
* // SMSTemplate: "<Template>",
|
|
776
779
|
* // VoiceTemplate: "<Template>",
|
|
780
|
+
* // InAppTemplate: "<Template>",
|
|
777
781
|
* // },
|
|
778
782
|
* // TreatmentDescription: "STRING_VALUE",
|
|
779
783
|
* // TreatmentName: "STRING_VALUE",
|
|
@@ -286,6 +286,11 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
286
286
|
* EndpointReentryCap: Number("int"),
|
|
287
287
|
* MessagesPerSecond: Number("int"),
|
|
288
288
|
* EndpointReentryInterval: "STRING_VALUE",
|
|
289
|
+
* TimeframeCap: { // JourneyTimeframeCap
|
|
290
|
+
* Cap: Number("int"),
|
|
291
|
+
* Days: Number("int"),
|
|
292
|
+
* },
|
|
293
|
+
* TotalCap: Number("int"),
|
|
289
294
|
* },
|
|
290
295
|
* LocalTime: true || false,
|
|
291
296
|
* Name: "STRING_VALUE", // required
|
|
@@ -668,6 +673,11 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
|
|
|
668
673
|
* // EndpointReentryCap: Number("int"),
|
|
669
674
|
* // MessagesPerSecond: Number("int"),
|
|
670
675
|
* // EndpointReentryInterval: "STRING_VALUE",
|
|
676
|
+
* // TimeframeCap: { // JourneyTimeframeCap
|
|
677
|
+
* // Cap: Number("int"),
|
|
678
|
+
* // Days: Number("int"),
|
|
679
|
+
* // },
|
|
680
|
+
* // TotalCap: Number("int"),
|
|
671
681
|
* // },
|
|
672
682
|
* // LocalTime: true || false,
|
|
673
683
|
* // Name: "STRING_VALUE", // required
|
|
@@ -257,6 +257,10 @@ export interface DeleteCampaignCommandOutput extends DeleteCampaignResponse, __M
|
|
|
257
257
|
* // Name: "STRING_VALUE",
|
|
258
258
|
* // Version: "STRING_VALUE",
|
|
259
259
|
* // },
|
|
260
|
+
* // InAppTemplate: {
|
|
261
|
+
* // Name: "STRING_VALUE",
|
|
262
|
+
* // Version: "STRING_VALUE",
|
|
263
|
+
* // },
|
|
260
264
|
* // },
|
|
261
265
|
* // TreatmentDescription: "STRING_VALUE",
|
|
262
266
|
* // TreatmentName: "STRING_VALUE",
|
|
@@ -404,13 +408,11 @@ export interface DeleteCampaignCommandOutput extends DeleteCampaignResponse, __M
|
|
|
404
408
|
* // },
|
|
405
409
|
* // tags: "<MapOf__string>",
|
|
406
410
|
* // TemplateConfiguration: {
|
|
407
|
-
* // EmailTemplate:
|
|
408
|
-
* // Name: "STRING_VALUE",
|
|
409
|
-
* // Version: "STRING_VALUE",
|
|
410
|
-
* // },
|
|
411
|
+
* // EmailTemplate: "<Template>",
|
|
411
412
|
* // PushTemplate: "<Template>",
|
|
412
413
|
* // SMSTemplate: "<Template>",
|
|
413
414
|
* // VoiceTemplate: "<Template>",
|
|
415
|
+
* // InAppTemplate: "<Template>",
|
|
414
416
|
* // },
|
|
415
417
|
* // TreatmentDescription: "STRING_VALUE",
|
|
416
418
|
* // TreatmentName: "STRING_VALUE",
|
|
@@ -39,9 +39,11 @@ export interface DeleteGcmChannelCommandOutput extends DeleteGcmChannelResponse,
|
|
|
39
39
|
* // GCMChannelResponse: { // GCMChannelResponse
|
|
40
40
|
* // ApplicationId: "STRING_VALUE",
|
|
41
41
|
* // CreationDate: "STRING_VALUE",
|
|
42
|
-
* // Credential: "STRING_VALUE",
|
|
42
|
+
* // Credential: "STRING_VALUE",
|
|
43
|
+
* // DefaultAuthenticationMethod: "STRING_VALUE",
|
|
43
44
|
* // Enabled: true || false,
|
|
44
45
|
* // HasCredential: true || false,
|
|
46
|
+
* // HasFcmServiceCredentials: true || false,
|
|
45
47
|
* // Id: "STRING_VALUE",
|
|
46
48
|
* // IsArchived: true || false,
|
|
47
49
|
* // LastModifiedBy: "STRING_VALUE",
|
|
@@ -293,6 +293,11 @@ export interface DeleteJourneyCommandOutput extends DeleteJourneyResponse, __Met
|
|
|
293
293
|
* // EndpointReentryCap: Number("int"),
|
|
294
294
|
* // MessagesPerSecond: Number("int"),
|
|
295
295
|
* // EndpointReentryInterval: "STRING_VALUE",
|
|
296
|
+
* // TimeframeCap: { // JourneyTimeframeCap
|
|
297
|
+
* // Cap: Number("int"),
|
|
298
|
+
* // Days: Number("int"),
|
|
299
|
+
* // },
|
|
300
|
+
* // TotalCap: Number("int"),
|
|
296
301
|
* // },
|
|
297
302
|
* // LocalTime: true || false,
|
|
298
303
|
* // Name: "STRING_VALUE", // required
|
|
@@ -55,6 +55,14 @@ export interface GetApplicationSettingsCommandOutput extends GetApplicationSetti
|
|
|
55
55
|
* // End: "STRING_VALUE",
|
|
56
56
|
* // Start: "STRING_VALUE",
|
|
57
57
|
* // },
|
|
58
|
+
* // JourneyLimits: { // ApplicationSettingsJourneyLimits
|
|
59
|
+
* // DailyCap: Number("int"),
|
|
60
|
+
* // TimeframeCap: { // JourneyTimeframeCap
|
|
61
|
+
* // Cap: Number("int"),
|
|
62
|
+
* // Days: Number("int"),
|
|
63
|
+
* // },
|
|
64
|
+
* // TotalCap: Number("int"),
|
|
65
|
+
* // },
|
|
58
66
|
* // },
|
|
59
67
|
* // };
|
|
60
68
|
*
|
|
@@ -257,6 +257,10 @@ export interface GetCampaignCommandOutput extends GetCampaignResponse, __Metadat
|
|
|
257
257
|
* // Name: "STRING_VALUE",
|
|
258
258
|
* // Version: "STRING_VALUE",
|
|
259
259
|
* // },
|
|
260
|
+
* // InAppTemplate: {
|
|
261
|
+
* // Name: "STRING_VALUE",
|
|
262
|
+
* // Version: "STRING_VALUE",
|
|
263
|
+
* // },
|
|
260
264
|
* // },
|
|
261
265
|
* // TreatmentDescription: "STRING_VALUE",
|
|
262
266
|
* // TreatmentName: "STRING_VALUE",
|
|
@@ -404,13 +408,11 @@ export interface GetCampaignCommandOutput extends GetCampaignResponse, __Metadat
|
|
|
404
408
|
* // },
|
|
405
409
|
* // tags: "<MapOf__string>",
|
|
406
410
|
* // TemplateConfiguration: {
|
|
407
|
-
* // EmailTemplate:
|
|
408
|
-
* // Name: "STRING_VALUE",
|
|
409
|
-
* // Version: "STRING_VALUE",
|
|
410
|
-
* // },
|
|
411
|
+
* // EmailTemplate: "<Template>",
|
|
411
412
|
* // PushTemplate: "<Template>",
|
|
412
413
|
* // SMSTemplate: "<Template>",
|
|
413
414
|
* // VoiceTemplate: "<Template>",
|
|
415
|
+
* // InAppTemplate: "<Template>",
|
|
414
416
|
* // },
|
|
415
417
|
* // TreatmentDescription: "STRING_VALUE",
|
|
416
418
|
* // TreatmentName: "STRING_VALUE",
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
2
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
-
import { GetCampaignVersionRequest
|
|
4
|
+
import { GetCampaignVersionRequest } from "../models/models_0";
|
|
5
|
+
import { GetCampaignVersionResponse } from "../models/models_1";
|
|
5
6
|
import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
|
|
6
7
|
/**
|
|
7
8
|
* @public
|
|
@@ -258,6 +259,10 @@ export interface GetCampaignVersionCommandOutput extends GetCampaignVersionRespo
|
|
|
258
259
|
* // Name: "STRING_VALUE",
|
|
259
260
|
* // Version: "STRING_VALUE",
|
|
260
261
|
* // },
|
|
262
|
+
* // InAppTemplate: {
|
|
263
|
+
* // Name: "STRING_VALUE",
|
|
264
|
+
* // Version: "STRING_VALUE",
|
|
265
|
+
* // },
|
|
261
266
|
* // },
|
|
262
267
|
* // TreatmentDescription: "STRING_VALUE",
|
|
263
268
|
* // TreatmentName: "STRING_VALUE",
|
|
@@ -405,13 +410,11 @@ export interface GetCampaignVersionCommandOutput extends GetCampaignVersionRespo
|
|
|
405
410
|
* // },
|
|
406
411
|
* // tags: "<MapOf__string>",
|
|
407
412
|
* // TemplateConfiguration: {
|
|
408
|
-
* // EmailTemplate:
|
|
409
|
-
* // Name: "STRING_VALUE",
|
|
410
|
-
* // Version: "STRING_VALUE",
|
|
411
|
-
* // },
|
|
413
|
+
* // EmailTemplate: "<Template>",
|
|
412
414
|
* // PushTemplate: "<Template>",
|
|
413
415
|
* // SMSTemplate: "<Template>",
|
|
414
416
|
* // VoiceTemplate: "<Template>",
|
|
417
|
+
* // InAppTemplate: "<Template>",
|
|
415
418
|
* // },
|
|
416
419
|
* // TreatmentDescription: "STRING_VALUE",
|
|
417
420
|
* // TreatmentName: "STRING_VALUE",
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
2
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
-
import { GetCampaignVersionsRequest } from "../models/
|
|
5
|
-
import { GetCampaignVersionsResponse } from "../models/models_1";
|
|
4
|
+
import { GetCampaignVersionsRequest, GetCampaignVersionsResponse } from "../models/models_1";
|
|
6
5
|
import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
|
|
7
6
|
/**
|
|
8
7
|
* @public
|
|
@@ -262,6 +261,10 @@ export interface GetCampaignVersionsCommandOutput extends GetCampaignVersionsRes
|
|
|
262
261
|
* // Name: "STRING_VALUE",
|
|
263
262
|
* // Version: "STRING_VALUE",
|
|
264
263
|
* // },
|
|
264
|
+
* // InAppTemplate: {
|
|
265
|
+
* // Name: "STRING_VALUE",
|
|
266
|
+
* // Version: "STRING_VALUE",
|
|
267
|
+
* // },
|
|
265
268
|
* // },
|
|
266
269
|
* // TreatmentDescription: "STRING_VALUE",
|
|
267
270
|
* // TreatmentName: "STRING_VALUE",
|
|
@@ -409,13 +412,11 @@ export interface GetCampaignVersionsCommandOutput extends GetCampaignVersionsRes
|
|
|
409
412
|
* // },
|
|
410
413
|
* // tags: "<MapOf__string>",
|
|
411
414
|
* // TemplateConfiguration: {
|
|
412
|
-
* // EmailTemplate:
|
|
413
|
-
* // Name: "STRING_VALUE",
|
|
414
|
-
* // Version: "STRING_VALUE",
|
|
415
|
-
* // },
|
|
415
|
+
* // EmailTemplate: "<Template>",
|
|
416
416
|
* // PushTemplate: "<Template>",
|
|
417
417
|
* // SMSTemplate: "<Template>",
|
|
418
418
|
* // VoiceTemplate: "<Template>",
|
|
419
|
+
* // InAppTemplate: "<Template>",
|
|
419
420
|
* // },
|
|
420
421
|
* // TreatmentDescription: "STRING_VALUE",
|
|
421
422
|
* // TreatmentName: "STRING_VALUE",
|
|
@@ -260,6 +260,10 @@ export interface GetCampaignsCommandOutput extends GetCampaignsResponse, __Metad
|
|
|
260
260
|
* // Name: "STRING_VALUE",
|
|
261
261
|
* // Version: "STRING_VALUE",
|
|
262
262
|
* // },
|
|
263
|
+
* // InAppTemplate: {
|
|
264
|
+
* // Name: "STRING_VALUE",
|
|
265
|
+
* // Version: "STRING_VALUE",
|
|
266
|
+
* // },
|
|
263
267
|
* // },
|
|
264
268
|
* // TreatmentDescription: "STRING_VALUE",
|
|
265
269
|
* // TreatmentName: "STRING_VALUE",
|
|
@@ -407,13 +411,11 @@ export interface GetCampaignsCommandOutput extends GetCampaignsResponse, __Metad
|
|
|
407
411
|
* // },
|
|
408
412
|
* // tags: "<MapOf__string>",
|
|
409
413
|
* // TemplateConfiguration: {
|
|
410
|
-
* // EmailTemplate:
|
|
411
|
-
* // Name: "STRING_VALUE",
|
|
412
|
-
* // Version: "STRING_VALUE",
|
|
413
|
-
* // },
|
|
414
|
+
* // EmailTemplate: "<Template>",
|
|
414
415
|
* // PushTemplate: "<Template>",
|
|
415
416
|
* // SMSTemplate: "<Template>",
|
|
416
417
|
* // VoiceTemplate: "<Template>",
|
|
418
|
+
* // InAppTemplate: "<Template>",
|
|
417
419
|
* // },
|
|
418
420
|
* // TreatmentDescription: "STRING_VALUE",
|
|
419
421
|
* // TreatmentName: "STRING_VALUE",
|
|
@@ -39,9 +39,11 @@ export interface GetGcmChannelCommandOutput extends GetGcmChannelResponse, __Met
|
|
|
39
39
|
* // GCMChannelResponse: { // GCMChannelResponse
|
|
40
40
|
* // ApplicationId: "STRING_VALUE",
|
|
41
41
|
* // CreationDate: "STRING_VALUE",
|
|
42
|
-
* // Credential: "STRING_VALUE",
|
|
42
|
+
* // Credential: "STRING_VALUE",
|
|
43
|
+
* // DefaultAuthenticationMethod: "STRING_VALUE",
|
|
43
44
|
* // Enabled: true || false,
|
|
44
45
|
* // HasCredential: true || false,
|
|
46
|
+
* // HasFcmServiceCredentials: true || false,
|
|
45
47
|
* // Id: "STRING_VALUE",
|
|
46
48
|
* // IsArchived: true || false,
|
|
47
49
|
* // LastModifiedBy: "STRING_VALUE",
|
|
@@ -293,6 +293,11 @@ export interface GetJourneyCommandOutput extends GetJourneyResponse, __MetadataB
|
|
|
293
293
|
* // EndpointReentryCap: Number("int"),
|
|
294
294
|
* // MessagesPerSecond: Number("int"),
|
|
295
295
|
* // EndpointReentryInterval: "STRING_VALUE",
|
|
296
|
+
* // TimeframeCap: { // JourneyTimeframeCap
|
|
297
|
+
* // Cap: Number("int"),
|
|
298
|
+
* // Days: Number("int"),
|
|
299
|
+
* // },
|
|
300
|
+
* // TotalCap: Number("int"),
|
|
296
301
|
* // },
|
|
297
302
|
* // LocalTime: true || false,
|
|
298
303
|
* // Name: "STRING_VALUE", // required
|
|
@@ -296,6 +296,11 @@ export interface ListJourneysCommandOutput extends ListJourneysResponse, __Metad
|
|
|
296
296
|
* // EndpointReentryCap: Number("int"),
|
|
297
297
|
* // MessagesPerSecond: Number("int"),
|
|
298
298
|
* // EndpointReentryInterval: "STRING_VALUE",
|
|
299
|
+
* // TimeframeCap: { // JourneyTimeframeCap
|
|
300
|
+
* // Cap: Number("int"),
|
|
301
|
+
* // Days: Number("int"),
|
|
302
|
+
* // },
|
|
303
|
+
* // TotalCap: Number("int"),
|
|
299
304
|
* // },
|
|
300
305
|
* // LocalTime: true || false,
|
|
301
306
|
* // Name: "STRING_VALUE", // required
|
|
@@ -183,6 +183,7 @@ export interface SendMessagesCommandOutput extends SendMessagesResponse, __Metad
|
|
|
183
183
|
* IconReference: "STRING_VALUE",
|
|
184
184
|
* ImageIconUrl: "STRING_VALUE",
|
|
185
185
|
* ImageUrl: "STRING_VALUE",
|
|
186
|
+
* PreferredAuthenticationMethod: "STRING_VALUE",
|
|
186
187
|
* Priority: "STRING_VALUE",
|
|
187
188
|
* RawContent: "STRING_VALUE",
|
|
188
189
|
* RestrictedPackageName: "STRING_VALUE",
|
|
@@ -230,6 +231,10 @@ export interface SendMessagesCommandOutput extends SendMessagesResponse, __Metad
|
|
|
230
231
|
* Name: "STRING_VALUE",
|
|
231
232
|
* Version: "STRING_VALUE",
|
|
232
233
|
* },
|
|
234
|
+
* InAppTemplate: {
|
|
235
|
+
* Name: "STRING_VALUE",
|
|
236
|
+
* Version: "STRING_VALUE",
|
|
237
|
+
* },
|
|
233
238
|
* },
|
|
234
239
|
* TraceId: "STRING_VALUE",
|
|
235
240
|
* },
|
|
@@ -164,6 +164,7 @@ export interface SendUsersMessagesCommandOutput extends SendUsersMessagesRespons
|
|
|
164
164
|
* IconReference: "STRING_VALUE",
|
|
165
165
|
* ImageIconUrl: "STRING_VALUE",
|
|
166
166
|
* ImageUrl: "STRING_VALUE",
|
|
167
|
+
* PreferredAuthenticationMethod: "STRING_VALUE",
|
|
167
168
|
* Priority: "STRING_VALUE",
|
|
168
169
|
* RawContent: "STRING_VALUE",
|
|
169
170
|
* RestrictedPackageName: "STRING_VALUE",
|
|
@@ -211,6 +212,10 @@ export interface SendUsersMessagesCommandOutput extends SendUsersMessagesRespons
|
|
|
211
212
|
* Name: "STRING_VALUE",
|
|
212
213
|
* Version: "STRING_VALUE",
|
|
213
214
|
* },
|
|
215
|
+
* InAppTemplate: {
|
|
216
|
+
* Name: "STRING_VALUE",
|
|
217
|
+
* Version: "STRING_VALUE",
|
|
218
|
+
* },
|
|
214
219
|
* },
|
|
215
220
|
* TraceId: "STRING_VALUE",
|
|
216
221
|
* Users: { // MapOfEndpointSendConfiguration // required
|
|
@@ -51,6 +51,14 @@ export interface UpdateApplicationSettingsCommandOutput extends UpdateApplicatio
|
|
|
51
51
|
* End: "STRING_VALUE",
|
|
52
52
|
* Start: "STRING_VALUE",
|
|
53
53
|
* },
|
|
54
|
+
* JourneyLimits: { // ApplicationSettingsJourneyLimits
|
|
55
|
+
* DailyCap: Number("int"),
|
|
56
|
+
* TimeframeCap: { // JourneyTimeframeCap
|
|
57
|
+
* Cap: Number("int"),
|
|
58
|
+
* Days: Number("int"),
|
|
59
|
+
* },
|
|
60
|
+
* TotalCap: Number("int"),
|
|
61
|
+
* },
|
|
54
62
|
* },
|
|
55
63
|
* };
|
|
56
64
|
* const command = new UpdateApplicationSettingsCommand(input);
|
|
@@ -75,6 +83,14 @@ export interface UpdateApplicationSettingsCommandOutput extends UpdateApplicatio
|
|
|
75
83
|
* // End: "STRING_VALUE",
|
|
76
84
|
* // Start: "STRING_VALUE",
|
|
77
85
|
* // },
|
|
86
|
+
* // JourneyLimits: { // ApplicationSettingsJourneyLimits
|
|
87
|
+
* // DailyCap: Number("int"),
|
|
88
|
+
* // TimeframeCap: { // JourneyTimeframeCap
|
|
89
|
+
* // Cap: Number("int"),
|
|
90
|
+
* // Days: Number("int"),
|
|
91
|
+
* // },
|
|
92
|
+
* // TotalCap: Number("int"),
|
|
93
|
+
* // },
|
|
78
94
|
* // },
|
|
79
95
|
* // };
|
|
80
96
|
*
|
|
@@ -249,6 +249,10 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
|
|
|
249
249
|
* Name: "STRING_VALUE",
|
|
250
250
|
* Version: "STRING_VALUE",
|
|
251
251
|
* },
|
|
252
|
+
* InAppTemplate: {
|
|
253
|
+
* Name: "STRING_VALUE",
|
|
254
|
+
* Version: "STRING_VALUE",
|
|
255
|
+
* },
|
|
252
256
|
* },
|
|
253
257
|
* TreatmentDescription: "STRING_VALUE",
|
|
254
258
|
* TreatmentName: "STRING_VALUE",
|
|
@@ -385,13 +389,11 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
|
|
|
385
389
|
* SegmentVersion: Number("int"),
|
|
386
390
|
* tags: "<MapOf__string>",
|
|
387
391
|
* TemplateConfiguration: {
|
|
388
|
-
* EmailTemplate:
|
|
389
|
-
* Name: "STRING_VALUE",
|
|
390
|
-
* Version: "STRING_VALUE",
|
|
391
|
-
* },
|
|
392
|
+
* EmailTemplate: "<Template>",
|
|
392
393
|
* PushTemplate: "<Template>",
|
|
393
394
|
* SMSTemplate: "<Template>",
|
|
394
395
|
* VoiceTemplate: "<Template>",
|
|
396
|
+
* InAppTemplate: "<Template>",
|
|
395
397
|
* },
|
|
396
398
|
* TreatmentDescription: "STRING_VALUE",
|
|
397
399
|
* TreatmentName: "STRING_VALUE",
|
|
@@ -621,6 +623,10 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
|
|
|
621
623
|
* // Name: "STRING_VALUE",
|
|
622
624
|
* // Version: "STRING_VALUE",
|
|
623
625
|
* // },
|
|
626
|
+
* // InAppTemplate: {
|
|
627
|
+
* // Name: "STRING_VALUE",
|
|
628
|
+
* // Version: "STRING_VALUE",
|
|
629
|
+
* // },
|
|
624
630
|
* // },
|
|
625
631
|
* // TreatmentDescription: "STRING_VALUE",
|
|
626
632
|
* // TreatmentName: "STRING_VALUE",
|
|
@@ -768,13 +774,11 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
|
|
|
768
774
|
* // },
|
|
769
775
|
* // tags: "<MapOf__string>",
|
|
770
776
|
* // TemplateConfiguration: {
|
|
771
|
-
* // EmailTemplate:
|
|
772
|
-
* // Name: "STRING_VALUE",
|
|
773
|
-
* // Version: "STRING_VALUE",
|
|
774
|
-
* // },
|
|
777
|
+
* // EmailTemplate: "<Template>",
|
|
775
778
|
* // PushTemplate: "<Template>",
|
|
776
779
|
* // SMSTemplate: "<Template>",
|
|
777
780
|
* // VoiceTemplate: "<Template>",
|
|
781
|
+
* // InAppTemplate: "<Template>",
|
|
778
782
|
* // },
|
|
779
783
|
* // TreatmentDescription: "STRING_VALUE",
|
|
780
784
|
* // TreatmentName: "STRING_VALUE",
|
|
@@ -33,8 +33,10 @@ export interface UpdateGcmChannelCommandOutput extends UpdateGcmChannelResponse,
|
|
|
33
33
|
* const input = { // UpdateGcmChannelRequest
|
|
34
34
|
* ApplicationId: "STRING_VALUE", // required
|
|
35
35
|
* GCMChannelRequest: { // GCMChannelRequest
|
|
36
|
-
* ApiKey: "STRING_VALUE",
|
|
36
|
+
* ApiKey: "STRING_VALUE",
|
|
37
|
+
* DefaultAuthenticationMethod: "STRING_VALUE",
|
|
37
38
|
* Enabled: true || false,
|
|
39
|
+
* ServiceJson: "STRING_VALUE",
|
|
38
40
|
* },
|
|
39
41
|
* };
|
|
40
42
|
* const command = new UpdateGcmChannelCommand(input);
|
|
@@ -43,9 +45,11 @@ export interface UpdateGcmChannelCommandOutput extends UpdateGcmChannelResponse,
|
|
|
43
45
|
* // GCMChannelResponse: { // GCMChannelResponse
|
|
44
46
|
* // ApplicationId: "STRING_VALUE",
|
|
45
47
|
* // CreationDate: "STRING_VALUE",
|
|
46
|
-
* // Credential: "STRING_VALUE",
|
|
48
|
+
* // Credential: "STRING_VALUE",
|
|
49
|
+
* // DefaultAuthenticationMethod: "STRING_VALUE",
|
|
47
50
|
* // Enabled: true || false,
|
|
48
51
|
* // HasCredential: true || false,
|
|
52
|
+
* // HasFcmServiceCredentials: true || false,
|
|
49
53
|
* // Id: "STRING_VALUE",
|
|
50
54
|
* // IsArchived: true || false,
|
|
51
55
|
* // LastModifiedBy: "STRING_VALUE",
|
|
@@ -287,6 +287,11 @@ export interface UpdateJourneyCommandOutput extends UpdateJourneyResponse, __Met
|
|
|
287
287
|
* EndpointReentryCap: Number("int"),
|
|
288
288
|
* MessagesPerSecond: Number("int"),
|
|
289
289
|
* EndpointReentryInterval: "STRING_VALUE",
|
|
290
|
+
* TimeframeCap: { // JourneyTimeframeCap
|
|
291
|
+
* Cap: Number("int"),
|
|
292
|
+
* Days: Number("int"),
|
|
293
|
+
* },
|
|
294
|
+
* TotalCap: Number("int"),
|
|
290
295
|
* },
|
|
291
296
|
* LocalTime: true || false,
|
|
292
297
|
* Name: "STRING_VALUE", // required
|
|
@@ -669,6 +674,11 @@ export interface UpdateJourneyCommandOutput extends UpdateJourneyResponse, __Met
|
|
|
669
674
|
* // EndpointReentryCap: Number("int"),
|
|
670
675
|
* // MessagesPerSecond: Number("int"),
|
|
671
676
|
* // EndpointReentryInterval: "STRING_VALUE",
|
|
677
|
+
* // TimeframeCap: { // JourneyTimeframeCap
|
|
678
|
+
* // Cap: Number("int"),
|
|
679
|
+
* // Days: Number("int"),
|
|
680
|
+
* // },
|
|
681
|
+
* // TotalCap: Number("int"),
|
|
672
682
|
* // },
|
|
673
683
|
* // LocalTime: true || false,
|
|
674
684
|
* // Name: "STRING_VALUE", // required
|
|
@@ -296,6 +296,11 @@ export interface UpdateJourneyStateCommandOutput extends UpdateJourneyStateRespo
|
|
|
296
296
|
* // EndpointReentryCap: Number("int"),
|
|
297
297
|
* // MessagesPerSecond: Number("int"),
|
|
298
298
|
* // EndpointReentryInterval: "STRING_VALUE",
|
|
299
|
+
* // TimeframeCap: { // JourneyTimeframeCap
|
|
300
|
+
* // Cap: Number("int"),
|
|
301
|
+
* // Days: Number("int"),
|
|
302
|
+
* // },
|
|
303
|
+
* // TotalCap: Number("int"),
|
|
299
304
|
* // },
|
|
300
305
|
* // LocalTime: true || false,
|
|
301
306
|
* // Name: "STRING_VALUE", // required
|
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
|
|
2
|
+
/**
|
|
3
|
+
* @public
|
|
4
|
+
*/
|
|
2
5
|
export interface ClientInputEndpointParameters {
|
|
3
6
|
region?: string | Provider<string>;
|
|
4
7
|
useDualstackEndpoint?: boolean | Provider<boolean>;
|
package/dist-types/index.d.ts
CHANGED
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
*/
|
|
6
6
|
export * from "./PinpointClient";
|
|
7
7
|
export * from "./Pinpoint";
|
|
8
|
+
export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
|
|
8
9
|
export * from "./commands";
|
|
9
10
|
export * from "./models";
|
|
10
11
|
export { PinpointServiceException } from "./models/PinpointServiceException";
|
|
@@ -1596,6 +1596,38 @@ export interface ApplicationResponse {
|
|
|
1596
1596
|
*/
|
|
1597
1597
|
CreationDate?: string;
|
|
1598
1598
|
}
|
|
1599
|
+
/**
|
|
1600
|
+
* @public
|
|
1601
|
+
* <p>The number of messages that can be sent to an endpoint during the specified timeframe for all journeys.</p>
|
|
1602
|
+
*/
|
|
1603
|
+
export interface JourneyTimeframeCap {
|
|
1604
|
+
/**
|
|
1605
|
+
* <p>The maximum number of messages that all journeys can send to an endpoint during the specified timeframe. The maximum value is 100. If set to 0, this limit will not apply.</p>
|
|
1606
|
+
*/
|
|
1607
|
+
Cap?: number;
|
|
1608
|
+
/**
|
|
1609
|
+
* <p>The length of the timeframe in days. The maximum value is 30. If set to 0, this limit will not apply.</p>
|
|
1610
|
+
*/
|
|
1611
|
+
Days?: number;
|
|
1612
|
+
}
|
|
1613
|
+
/**
|
|
1614
|
+
* @public
|
|
1615
|
+
* <p>The default sending limits for journeys in the application. To override these limits and define custom limits for a specific journey, use the Journey resource.</p>
|
|
1616
|
+
*/
|
|
1617
|
+
export interface ApplicationSettingsJourneyLimits {
|
|
1618
|
+
/**
|
|
1619
|
+
* <p>The daily number of messages that an endpoint can receive from all journeys. The maximum value is 100. If set to 0, this limit will not apply.</p>
|
|
1620
|
+
*/
|
|
1621
|
+
DailyCap?: number;
|
|
1622
|
+
/**
|
|
1623
|
+
* <p>The default maximum number of messages that can be sent to an endpoint during the specified timeframe for all journeys.</p>
|
|
1624
|
+
*/
|
|
1625
|
+
TimeframeCap?: JourneyTimeframeCap;
|
|
1626
|
+
/**
|
|
1627
|
+
* <p>The default maximum number of messages that a single journey can sent to a single endpoint. The maximum value is 100. If set to 0, this limit will not apply.</p>
|
|
1628
|
+
*/
|
|
1629
|
+
TotalCap?: number;
|
|
1630
|
+
}
|
|
1599
1631
|
/**
|
|
1600
1632
|
* @public
|
|
1601
1633
|
* @enum
|
|
@@ -1691,6 +1723,10 @@ export interface ApplicationSettingsResource {
|
|
|
1691
1723
|
* <p>The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:</p> <ul><li><p>The EndpointDemographic.Timezone property of the endpoint is set to a valid value.</p></li> <li><p>The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).</p></li> <li><p>The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).</p></li></ul> <p>If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.</p>
|
|
1692
1724
|
*/
|
|
1693
1725
|
QuietTime?: QuietTime;
|
|
1726
|
+
/**
|
|
1727
|
+
* <p>The default sending limits for journeys in the application. These limits apply to each journey for the application but can be overridden, on a per journey basis, with the JourneyLimits resource.</p>
|
|
1728
|
+
*/
|
|
1729
|
+
JourneyLimits?: ApplicationSettingsJourneyLimits;
|
|
1694
1730
|
}
|
|
1695
1731
|
/**
|
|
1696
1732
|
* @public
|
|
@@ -2405,6 +2441,10 @@ export interface TemplateConfiguration {
|
|
|
2405
2441
|
* <p>The voice template to use for the message. This object isn't supported for campaigns.</p>
|
|
2406
2442
|
*/
|
|
2407
2443
|
VoiceTemplate?: Template;
|
|
2444
|
+
/**
|
|
2445
|
+
* <p>The InApp template to use for the message. The InApp template object is not supported for SendMessages.</p>
|
|
2446
|
+
*/
|
|
2447
|
+
InAppTemplate?: Template;
|
|
2408
2448
|
}
|
|
2409
2449
|
/**
|
|
2410
2450
|
* @public
|
|
@@ -3452,6 +3492,14 @@ export interface JourneyLimits {
|
|
|
3452
3492
|
* <p>Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H. </p>
|
|
3453
3493
|
*/
|
|
3454
3494
|
EndpointReentryInterval?: string;
|
|
3495
|
+
/**
|
|
3496
|
+
* <p>The number of messages that an endpoint can receive during the specified timeframe.</p>
|
|
3497
|
+
*/
|
|
3498
|
+
TimeframeCap?: JourneyTimeframeCap;
|
|
3499
|
+
/**
|
|
3500
|
+
* <p>The maximum number of messages a journey can sent to a single endpoint. The maximum value is 100. If set to 0, this limit will not apply.</p>
|
|
3501
|
+
*/
|
|
3502
|
+
TotalCap?: number;
|
|
3455
3503
|
}
|
|
3456
3504
|
/**
|
|
3457
3505
|
* @public
|
|
@@ -4884,7 +4932,11 @@ export interface GCMChannelResponse {
|
|
|
4884
4932
|
/**
|
|
4885
4933
|
* <p>The Web API Key, also referred to as an <i>API_KEY</i> or <i>server key</i>, that you received from Google to communicate with Google services.</p>
|
|
4886
4934
|
*/
|
|
4887
|
-
Credential
|
|
4935
|
+
Credential?: string;
|
|
4936
|
+
/**
|
|
4937
|
+
* <p>The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".</p>
|
|
4938
|
+
*/
|
|
4939
|
+
DefaultAuthenticationMethod?: string;
|
|
4888
4940
|
/**
|
|
4889
4941
|
* <p>Specifies whether the GCM channel is enabled for the application.</p>
|
|
4890
4942
|
*/
|
|
@@ -4893,6 +4945,10 @@ export interface GCMChannelResponse {
|
|
|
4893
4945
|
* <p>(Not used) This property is retained only for backward compatibility.</p>
|
|
4894
4946
|
*/
|
|
4895
4947
|
HasCredential?: boolean;
|
|
4948
|
+
/**
|
|
4949
|
+
* <p>Returns true if the JSON file provided by Google during registration process was used in the <b>ServiceJson</b> field of the request.</p>
|
|
4950
|
+
*/
|
|
4951
|
+
HasFcmServiceCredentials?: boolean;
|
|
4896
4952
|
/**
|
|
4897
4953
|
* <p>(Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.</p>
|
|
4898
4954
|
*/
|
|
@@ -5380,7 +5436,11 @@ export interface GCMMessage {
|
|
|
5380
5436
|
*/
|
|
5381
5437
|
ImageUrl?: string;
|
|
5382
5438
|
/**
|
|
5383
|
-
* <p>
|
|
5439
|
+
* <p>The preferred authentication method, with valid values "KEY" or "TOKEN". If a value isn't provided then the <b>DefaultAuthenticationMethod</b> is used.</p>
|
|
5440
|
+
*/
|
|
5441
|
+
PreferredAuthenticationMethod?: string;
|
|
5442
|
+
/**
|
|
5443
|
+
* <p>para>normal – The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.</p>/listitem> <li><p>high – The notification is sent immediately and might wake a sleeping device.</p></li>/para> <p>Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.</p> <p>The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.</p>
|
|
5384
5444
|
*/
|
|
5385
5445
|
Priority?: string;
|
|
5386
5446
|
/**
|
|
@@ -6015,11 +6075,19 @@ export interface GCMChannelRequest {
|
|
|
6015
6075
|
/**
|
|
6016
6076
|
* <p>The Web API Key, also referred to as an <i>API_KEY</i> or <i>server key</i>, that you received from Google to communicate with Google services.</p>
|
|
6017
6077
|
*/
|
|
6018
|
-
ApiKey
|
|
6078
|
+
ApiKey?: string;
|
|
6079
|
+
/**
|
|
6080
|
+
* <p>The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".</p>
|
|
6081
|
+
*/
|
|
6082
|
+
DefaultAuthenticationMethod?: string;
|
|
6019
6083
|
/**
|
|
6020
6084
|
* <p>Specifies whether to enable the GCM channel for the application.</p>
|
|
6021
6085
|
*/
|
|
6022
6086
|
Enabled?: boolean;
|
|
6087
|
+
/**
|
|
6088
|
+
* <p>The contents of the JSON file provided by Google during registration in order to generate an access token for authentication. For more information see <a href="https://firebase.google.com/docs/cloud-messaging/migrate-v1">Migrate from legacy FCM APIs to HTTP v1</a>.</p>
|
|
6089
|
+
*/
|
|
6090
|
+
ServiceJson?: string;
|
|
6023
6091
|
}
|
|
6024
6092
|
/**
|
|
6025
6093
|
* @public
|
|
@@ -6362,33 +6430,3 @@ export interface GetCampaignVersionRequest {
|
|
|
6362
6430
|
*/
|
|
6363
6431
|
Version: string | undefined;
|
|
6364
6432
|
}
|
|
6365
|
-
/**
|
|
6366
|
-
* @public
|
|
6367
|
-
*/
|
|
6368
|
-
export interface GetCampaignVersionResponse {
|
|
6369
|
-
/**
|
|
6370
|
-
* <p>Provides information about the status, configuration, and other settings for a campaign.</p>
|
|
6371
|
-
*/
|
|
6372
|
-
CampaignResponse: CampaignResponse | undefined;
|
|
6373
|
-
}
|
|
6374
|
-
/**
|
|
6375
|
-
* @public
|
|
6376
|
-
*/
|
|
6377
|
-
export interface GetCampaignVersionsRequest {
|
|
6378
|
-
/**
|
|
6379
|
-
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
6380
|
-
*/
|
|
6381
|
-
ApplicationId: string | undefined;
|
|
6382
|
-
/**
|
|
6383
|
-
* <p>The unique identifier for the campaign.</p>
|
|
6384
|
-
*/
|
|
6385
|
-
CampaignId: string | undefined;
|
|
6386
|
-
/**
|
|
6387
|
-
* <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>
|
|
6388
|
-
*/
|
|
6389
|
-
PageSize?: string;
|
|
6390
|
-
/**
|
|
6391
|
-
* <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
|
|
6392
|
-
*/
|
|
6393
|
-
Token?: string;
|
|
6394
|
-
}
|
|
@@ -1,4 +1,34 @@
|
|
|
1
|
-
import { AddressConfiguration, ADMChannelRequest, ADMChannelResponse, AndroidPushNotificationTemplate, APNSChannelRequest, APNSChannelResponse, APNSPushNotificationTemplate, APNSSandboxChannelRequest, APNSSandboxChannelResponse, APNSVoipChannelRequest, APNSVoipChannelResponse, APNSVoipSandboxChannelRequest, APNSVoipSandboxChannelResponse, ApplicationSettingsResource, AttributesResource, BaiduChannelRequest, BaiduChannelResponse, BaseKpiResult, CampaignEventFilter, CampaignHook, CampaignLimits, CampaignResponse, CampaignsResponse, ChannelsResponse, DefaultPushNotificationTemplate, DeliveryStatus, DirectMessageConfiguration, EmailChannelRequest, EmailChannelResponse, EmailTemplateRequest, EmailTemplateResponse, EndpointBatchRequest, EndpointMessageResult, EndpointRequest, EndpointResponse, EndpointSendConfiguration, EndpointsResponse, EventsRequest, EventsResponse, EventStream, ExportJobResponse, ExportJobsResponse, GCMChannelRequest, GCMChannelResponse, ImportJobResponse, InAppMessageContent, InAppTemplateRequest, JourneyResponse, Layout, MessageBody, PushNotificationTemplateRequest, QuietTime, RecommenderConfigurationResponse, SegmentResponse, SMSChannelResponse, SMSTemplateRequest, State, TemplateConfiguration, TemplateType, VoiceChannelResponse, VoiceTemplateRequest, WriteCampaignRequest, WriteJourneyRequest, WriteSegmentRequest } from "./models_0";
|
|
1
|
+
import { AddressConfiguration, ADMChannelRequest, ADMChannelResponse, AndroidPushNotificationTemplate, APNSChannelRequest, APNSChannelResponse, APNSPushNotificationTemplate, APNSSandboxChannelRequest, APNSSandboxChannelResponse, APNSVoipChannelRequest, APNSVoipChannelResponse, APNSVoipSandboxChannelRequest, APNSVoipSandboxChannelResponse, ApplicationSettingsJourneyLimits, ApplicationSettingsResource, AttributesResource, BaiduChannelRequest, BaiduChannelResponse, BaseKpiResult, CampaignEventFilter, CampaignHook, CampaignLimits, CampaignResponse, CampaignsResponse, ChannelsResponse, DefaultPushNotificationTemplate, DeliveryStatus, DirectMessageConfiguration, EmailChannelRequest, EmailChannelResponse, EmailTemplateRequest, EmailTemplateResponse, EndpointBatchRequest, EndpointMessageResult, EndpointRequest, EndpointResponse, EndpointSendConfiguration, EndpointsResponse, EventsRequest, EventsResponse, EventStream, ExportJobResponse, ExportJobsResponse, GCMChannelRequest, GCMChannelResponse, ImportJobResponse, InAppMessageContent, InAppTemplateRequest, JourneyResponse, Layout, MessageBody, PushNotificationTemplateRequest, QuietTime, RecommenderConfigurationResponse, SegmentResponse, SMSChannelResponse, SMSTemplateRequest, State, TemplateConfiguration, TemplateType, VoiceChannelResponse, VoiceTemplateRequest, WriteCampaignRequest, WriteJourneyRequest, WriteSegmentRequest } from "./models_0";
|
|
2
|
+
/**
|
|
3
|
+
* @public
|
|
4
|
+
*/
|
|
5
|
+
export interface GetCampaignVersionResponse {
|
|
6
|
+
/**
|
|
7
|
+
* <p>Provides information about the status, configuration, and other settings for a campaign.</p>
|
|
8
|
+
*/
|
|
9
|
+
CampaignResponse: CampaignResponse | undefined;
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
export interface GetCampaignVersionsRequest {
|
|
15
|
+
/**
|
|
16
|
+
* <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
|
|
17
|
+
*/
|
|
18
|
+
ApplicationId: string | undefined;
|
|
19
|
+
/**
|
|
20
|
+
* <p>The unique identifier for the campaign.</p>
|
|
21
|
+
*/
|
|
22
|
+
CampaignId: string | undefined;
|
|
23
|
+
/**
|
|
24
|
+
* <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>
|
|
25
|
+
*/
|
|
26
|
+
PageSize?: string;
|
|
27
|
+
/**
|
|
28
|
+
* <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
|
|
29
|
+
*/
|
|
30
|
+
Token?: string;
|
|
31
|
+
}
|
|
2
32
|
/**
|
|
3
33
|
* @public
|
|
4
34
|
*/
|
|
@@ -1448,7 +1478,7 @@ export interface TemplateResponse {
|
|
|
1448
1478
|
*/
|
|
1449
1479
|
TemplateName: string | undefined;
|
|
1450
1480
|
/**
|
|
1451
|
-
* <p>The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.</p>
|
|
1481
|
+
* <p>The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.</p>
|
|
1452
1482
|
*/
|
|
1453
1483
|
TemplateType: TemplateType | string | undefined;
|
|
1454
1484
|
/**
|
|
@@ -1482,7 +1512,7 @@ export interface TemplateVersionResponse {
|
|
|
1482
1512
|
*/
|
|
1483
1513
|
TemplateName: string | undefined;
|
|
1484
1514
|
/**
|
|
1485
|
-
* <p>The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.</p>
|
|
1515
|
+
* <p>The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.</p>
|
|
1486
1516
|
*/
|
|
1487
1517
|
TemplateType: string | undefined;
|
|
1488
1518
|
/**
|
|
@@ -2201,6 +2231,10 @@ export interface WriteApplicationSettingsRequest {
|
|
|
2201
2231
|
* <p>The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:</p> <ul><li><p>The EndpointDemographic.Timezone property of the endpoint is set to a valid value.</p></li> <li><p>The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).</p></li> <li><p>The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).</p></li></ul> <p>If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.</p> <p>To override the default quiet time settings for a specific campaign or journey, use the <link linkend="apps-application-id-campaigns-campaign-id">Campaign</link> resource or the <link linkend="apps-application-id-journeys-journey-id">Journey</link> resource to define a custom quiet time for the campaign or journey.</p>
|
|
2202
2232
|
*/
|
|
2203
2233
|
QuietTime?: QuietTime;
|
|
2234
|
+
/**
|
|
2235
|
+
* <p>The default sending limits for journeys in the application. These limits apply to each journey for the application but can be overridden, on a per journey basis, with the JourneyLimits resource.</p>
|
|
2236
|
+
*/
|
|
2237
|
+
JourneyLimits?: ApplicationSettingsJourneyLimits;
|
|
2204
2238
|
}
|
|
2205
2239
|
/**
|
|
2206
2240
|
* @public
|
|
@@ -6,10 +6,8 @@ import {
|
|
|
6
6
|
MetadataBearer as __MetadataBearer,
|
|
7
7
|
MiddlewareStack,
|
|
8
8
|
} from "@smithy/types";
|
|
9
|
-
import {
|
|
10
|
-
|
|
11
|
-
GetCampaignVersionResponse,
|
|
12
|
-
} from "../models/models_0";
|
|
9
|
+
import { GetCampaignVersionRequest } from "../models/models_0";
|
|
10
|
+
import { GetCampaignVersionResponse } from "../models/models_1";
|
|
13
11
|
import {
|
|
14
12
|
PinpointClientResolvedConfig,
|
|
15
13
|
ServiceInputTypes,
|
|
@@ -6,8 +6,10 @@ import {
|
|
|
6
6
|
MetadataBearer as __MetadataBearer,
|
|
7
7
|
MiddlewareStack,
|
|
8
8
|
} from "@smithy/types";
|
|
9
|
-
import {
|
|
10
|
-
|
|
9
|
+
import {
|
|
10
|
+
GetCampaignVersionsRequest,
|
|
11
|
+
GetCampaignVersionsResponse,
|
|
12
|
+
} from "../models/models_1";
|
|
11
13
|
import {
|
|
12
14
|
PinpointClientResolvedConfig,
|
|
13
15
|
ServiceInputTypes,
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
export * from "./PinpointClient";
|
|
2
2
|
export * from "./Pinpoint";
|
|
3
|
+
export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
|
|
3
4
|
export * from "./commands";
|
|
4
5
|
export * from "./models";
|
|
5
6
|
export { PinpointServiceException } from "./models/PinpointServiceException";
|
|
@@ -474,6 +474,15 @@ export interface ApplicationResponse {
|
|
|
474
474
|
tags?: Record<string, string>;
|
|
475
475
|
CreationDate?: string;
|
|
476
476
|
}
|
|
477
|
+
export interface JourneyTimeframeCap {
|
|
478
|
+
Cap?: number;
|
|
479
|
+
Days?: number;
|
|
480
|
+
}
|
|
481
|
+
export interface ApplicationSettingsJourneyLimits {
|
|
482
|
+
DailyCap?: number;
|
|
483
|
+
TimeframeCap?: JourneyTimeframeCap;
|
|
484
|
+
TotalCap?: number;
|
|
485
|
+
}
|
|
477
486
|
export declare const Mode: {
|
|
478
487
|
readonly DELIVERY: "DELIVERY";
|
|
479
488
|
readonly FILTER: "FILTER";
|
|
@@ -501,6 +510,7 @@ export interface ApplicationSettingsResource {
|
|
|
501
510
|
LastModifiedDate?: string;
|
|
502
511
|
Limits?: CampaignLimits;
|
|
503
512
|
QuietTime?: QuietTime;
|
|
513
|
+
JourneyLimits?: ApplicationSettingsJourneyLimits;
|
|
504
514
|
}
|
|
505
515
|
export interface ApplicationsResponse {
|
|
506
516
|
Item?: ApplicationResponse[];
|
|
@@ -717,6 +727,7 @@ export interface TemplateConfiguration {
|
|
|
717
727
|
PushTemplate?: Template;
|
|
718
728
|
SMSTemplate?: Template;
|
|
719
729
|
VoiceTemplate?: Template;
|
|
730
|
+
InAppTemplate?: Template;
|
|
720
731
|
}
|
|
721
732
|
export interface TreatmentResource {
|
|
722
733
|
CustomDeliveryConfiguration?: CustomDeliveryConfiguration;
|
|
@@ -1030,6 +1041,8 @@ export interface JourneyLimits {
|
|
|
1030
1041
|
EndpointReentryCap?: number;
|
|
1031
1042
|
MessagesPerSecond?: number;
|
|
1032
1043
|
EndpointReentryInterval?: string;
|
|
1044
|
+
TimeframeCap?: JourneyTimeframeCap;
|
|
1045
|
+
TotalCap?: number;
|
|
1033
1046
|
}
|
|
1034
1047
|
export declare const DayOfWeek: {
|
|
1035
1048
|
readonly FRIDAY: "FRIDAY";
|
|
@@ -1454,9 +1467,11 @@ export interface DeleteGcmChannelRequest {
|
|
|
1454
1467
|
export interface GCMChannelResponse {
|
|
1455
1468
|
ApplicationId?: string;
|
|
1456
1469
|
CreationDate?: string;
|
|
1457
|
-
Credential
|
|
1470
|
+
Credential?: string;
|
|
1471
|
+
DefaultAuthenticationMethod?: string;
|
|
1458
1472
|
Enabled?: boolean;
|
|
1459
1473
|
HasCredential?: boolean;
|
|
1474
|
+
HasFcmServiceCredentials?: boolean;
|
|
1460
1475
|
Id?: string;
|
|
1461
1476
|
IsArchived?: boolean;
|
|
1462
1477
|
LastModifiedBy?: string;
|
|
@@ -1607,6 +1622,7 @@ export interface GCMMessage {
|
|
|
1607
1622
|
IconReference?: string;
|
|
1608
1623
|
ImageIconUrl?: string;
|
|
1609
1624
|
ImageUrl?: string;
|
|
1625
|
+
PreferredAuthenticationMethod?: string;
|
|
1610
1626
|
Priority?: string;
|
|
1611
1627
|
RawContent?: string;
|
|
1612
1628
|
RestrictedPackageName?: string;
|
|
@@ -1780,8 +1796,10 @@ export interface ExportJobsResponse {
|
|
|
1780
1796
|
NextToken?: string;
|
|
1781
1797
|
}
|
|
1782
1798
|
export interface GCMChannelRequest {
|
|
1783
|
-
ApiKey
|
|
1799
|
+
ApiKey?: string;
|
|
1800
|
+
DefaultAuthenticationMethod?: string;
|
|
1784
1801
|
Enabled?: boolean;
|
|
1802
|
+
ServiceJson?: string;
|
|
1785
1803
|
}
|
|
1786
1804
|
export interface GetAdmChannelRequest {
|
|
1787
1805
|
ApplicationId: string | undefined;
|
|
@@ -1890,12 +1908,3 @@ export interface GetCampaignVersionRequest {
|
|
|
1890
1908
|
CampaignId: string | undefined;
|
|
1891
1909
|
Version: string | undefined;
|
|
1892
1910
|
}
|
|
1893
|
-
export interface GetCampaignVersionResponse {
|
|
1894
|
-
CampaignResponse: CampaignResponse | undefined;
|
|
1895
|
-
}
|
|
1896
|
-
export interface GetCampaignVersionsRequest {
|
|
1897
|
-
ApplicationId: string | undefined;
|
|
1898
|
-
CampaignId: string | undefined;
|
|
1899
|
-
PageSize?: string;
|
|
1900
|
-
Token?: string;
|
|
1901
|
-
}
|
|
@@ -12,6 +12,7 @@ import {
|
|
|
12
12
|
APNSVoipChannelResponse,
|
|
13
13
|
APNSVoipSandboxChannelRequest,
|
|
14
14
|
APNSVoipSandboxChannelResponse,
|
|
15
|
+
ApplicationSettingsJourneyLimits,
|
|
15
16
|
ApplicationSettingsResource,
|
|
16
17
|
AttributesResource,
|
|
17
18
|
BaiduChannelRequest,
|
|
@@ -64,6 +65,15 @@ import {
|
|
|
64
65
|
WriteJourneyRequest,
|
|
65
66
|
WriteSegmentRequest,
|
|
66
67
|
} from "./models_0";
|
|
68
|
+
export interface GetCampaignVersionResponse {
|
|
69
|
+
CampaignResponse: CampaignResponse | undefined;
|
|
70
|
+
}
|
|
71
|
+
export interface GetCampaignVersionsRequest {
|
|
72
|
+
ApplicationId: string | undefined;
|
|
73
|
+
CampaignId: string | undefined;
|
|
74
|
+
PageSize?: string;
|
|
75
|
+
Token?: string;
|
|
76
|
+
}
|
|
67
77
|
export interface GetCampaignVersionsResponse {
|
|
68
78
|
CampaignsResponse: CampaignsResponse | undefined;
|
|
69
79
|
}
|
|
@@ -724,6 +734,7 @@ export interface WriteApplicationSettingsRequest {
|
|
|
724
734
|
EventTaggingEnabled?: boolean;
|
|
725
735
|
Limits?: CampaignLimits;
|
|
726
736
|
QuietTime?: QuietTime;
|
|
737
|
+
JourneyLimits?: ApplicationSettingsJourneyLimits;
|
|
727
738
|
}
|
|
728
739
|
export interface UpdateApplicationSettingsRequest {
|
|
729
740
|
ApplicationId: string | undefined;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-pinpoint",
|
|
3
3
|
"description": "AWS SDK for JavaScript Pinpoint Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.380.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,13 +21,13 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.379.1",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.379.1",
|
|
26
|
+
"@aws-sdk/middleware-host-header": "3.379.1",
|
|
27
27
|
"@aws-sdk/middleware-logger": "3.378.0",
|
|
28
28
|
"@aws-sdk/middleware-recursion-detection": "3.378.0",
|
|
29
|
-
"@aws-sdk/middleware-signing": "3.
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
29
|
+
"@aws-sdk/middleware-signing": "3.379.1",
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.379.1",
|
|
31
31
|
"@aws-sdk/types": "3.378.0",
|
|
32
32
|
"@aws-sdk/util-endpoints": "3.378.0",
|
|
33
33
|
"@aws-sdk/util-user-agent-browser": "3.378.0",
|