feat(client-pinpoint): Added support for sending push notifications u…

…sing the FCM v1 API with json credentials. Amazon Pinpoint customers can now deliver messages to Android devices using both FCM v1 API and the legacy FCM/GCM API
aws · Jul 28, 2023 · 8ac0a18 · 8ac0a18
1 parent 906b80e
commit 8ac0a18
Show file tree

Hide file tree

Showing 24 changed files with 392 additions and 90 deletions.
diff --git a/clients/client-pinpoint/src/commands/CreateCampaignCommand.ts b/clients/client-pinpoint/src/commands/CreateCampaignCommand.ts
@@ -261,6 +261,10 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
  * Name: "STRING_VALUE",
  * Version: "STRING_VALUE",
  * },
+ * InAppTemplate: {
+ * Name: "STRING_VALUE",
+ * Version: "STRING_VALUE",
+ * },
  * },
  * TreatmentDescription: "STRING_VALUE",
  * TreatmentName: "STRING_VALUE",
@@ -397,13 +401,11 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
  * SegmentVersion: Number("int"),
  * tags: "<MapOf__string>",
  * TemplateConfiguration: {
- * EmailTemplate: {
- * Name: "STRING_VALUE",
- * Version: "STRING_VALUE",
- * },
+ * EmailTemplate: "<Template>",
  * PushTemplate: "<Template>",
  * SMSTemplate: "<Template>",
  * VoiceTemplate: "<Template>",
+ * InAppTemplate: "<Template>",
  * },
  * TreatmentDescription: "STRING_VALUE",
  * TreatmentName: "STRING_VALUE",
@@ -633,6 +635,10 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
  * // Name: "STRING_VALUE",
  * // Version: "STRING_VALUE",
  * // },
+ * // InAppTemplate: {
+ * // Name: "STRING_VALUE",
+ * // Version: "STRING_VALUE",
+ * // },
  * // },
  * // TreatmentDescription: "STRING_VALUE",
  * // TreatmentName: "STRING_VALUE",
@@ -780,13 +786,11 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
  * // },
  * // tags: "<MapOf__string>",
  * // TemplateConfiguration: {
- * // EmailTemplate: {
- * // Name: "STRING_VALUE",
- * // Version: "STRING_VALUE",
- * // },
+ * // EmailTemplate: "<Template>",
  * // PushTemplate: "<Template>",
  * // SMSTemplate: "<Template>",
  * // VoiceTemplate: "<Template>",
+ * // InAppTemplate: "<Template>",
  * // },
  * // TreatmentDescription: "STRING_VALUE",
  * // TreatmentName: "STRING_VALUE",

diff --git a/clients/client-pinpoint/src/commands/CreateJourneyCommand.ts b/clients/client-pinpoint/src/commands/CreateJourneyCommand.ts
@@ -299,6 +299,11 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
  * EndpointReentryCap: Number("int"),
  * MessagesPerSecond: Number("int"),
  * EndpointReentryInterval: "STRING_VALUE",
+ * TimeframeCap: { // JourneyTimeframeCap
+ * Cap: Number("int"),
+ * Days: Number("int"),
+ * },
+ * TotalCap: Number("int"),
  * },
  * LocalTime: true || false,
  * Name: "STRING_VALUE", // required
@@ -681,6 +686,11 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met
  * // EndpointReentryCap: Number("int"),
  * // MessagesPerSecond: Number("int"),
  * // EndpointReentryInterval: "STRING_VALUE",
+ * // TimeframeCap: { // JourneyTimeframeCap
+ * // Cap: Number("int"),
+ * // Days: Number("int"),
+ * // },
+ * // TotalCap: Number("int"),
  * // },
  * // LocalTime: true || false,
  * // Name: "STRING_VALUE", // required

diff --git a/clients/client-pinpoint/src/commands/DeleteCampaignCommand.ts b/clients/client-pinpoint/src/commands/DeleteCampaignCommand.ts
@@ -270,6 +270,10 @@ export interface DeleteCampaignCommandOutput extends DeleteCampaignResponse, __M
  * // Name: "STRING_VALUE",
  * // Version: "STRING_VALUE",
  * // },
+ * // InAppTemplate: {
+ * // Name: "STRING_VALUE",
+ * // Version: "STRING_VALUE",
+ * // },
  * // },
  * // TreatmentDescription: "STRING_VALUE",
  * // TreatmentName: "STRING_VALUE",
@@ -417,13 +421,11 @@ export interface DeleteCampaignCommandOutput extends DeleteCampaignResponse, __M
  * // },
  * // tags: "<MapOf__string>",
  * // TemplateConfiguration: {
- * // EmailTemplate: {
- * // Name: "STRING_VALUE",
- * // Version: "STRING_VALUE",
- * // },
+ * // EmailTemplate: "<Template>",
  * // PushTemplate: "<Template>",
  * // SMSTemplate: "<Template>",
  * // VoiceTemplate: "<Template>",
+ * // InAppTemplate: "<Template>",
  * // },
  * // TreatmentDescription: "STRING_VALUE",
  * // TreatmentName: "STRING_VALUE",

diff --git a/clients/client-pinpoint/src/commands/DeleteGcmChannelCommand.ts b/clients/client-pinpoint/src/commands/DeleteGcmChannelCommand.ts
@@ -52,9 +52,11 @@ export interface DeleteGcmChannelCommandOutput extends DeleteGcmChannelResponse,
  * // GCMChannelResponse: { // GCMChannelResponse
  * // ApplicationId: "STRING_VALUE",
  * // CreationDate: "STRING_VALUE",
- * // Credential: "STRING_VALUE", // required
+ * // Credential: "STRING_VALUE",
+ * // DefaultAuthenticationMethod: "STRING_VALUE",
  * // Enabled: true || false,
  * // HasCredential: true || false,
+ * // HasFcmServiceCredentials: true || false,
  * // Id: "STRING_VALUE",
  * // IsArchived: true || false,
  * // LastModifiedBy: "STRING_VALUE",

diff --git a/clients/client-pinpoint/src/commands/DeleteJourneyCommand.ts b/clients/client-pinpoint/src/commands/DeleteJourneyCommand.ts
@@ -306,6 +306,11 @@ export interface DeleteJourneyCommandOutput extends DeleteJourneyResponse, __Met
  * // EndpointReentryCap: Number("int"),
  * // MessagesPerSecond: Number("int"),
  * // EndpointReentryInterval: "STRING_VALUE",
+ * // TimeframeCap: { // JourneyTimeframeCap
+ * // Cap: Number("int"),
+ * // Days: Number("int"),
+ * // },
+ * // TotalCap: Number("int"),
  * // },
  * // LocalTime: true || false,
  * // Name: "STRING_VALUE", // required

diff --git a/clients/client-pinpoint/src/commands/GetApplicationSettingsCommand.ts b/clients/client-pinpoint/src/commands/GetApplicationSettingsCommand.ts
@@ -68,6 +68,14 @@ export interface GetApplicationSettingsCommandOutput extends GetApplicationSetti
  * // End: "STRING_VALUE",
  * // Start: "STRING_VALUE",
  * // },
+ * // JourneyLimits: { // ApplicationSettingsJourneyLimits
+ * // DailyCap: Number("int"),
+ * // TimeframeCap: { // JourneyTimeframeCap
+ * // Cap: Number("int"),
+ * // Days: Number("int"),
+ * // },
+ * // TotalCap: Number("int"),
+ * // },
  * // },
  * // };
  *

diff --git a/clients/client-pinpoint/src/commands/GetCampaignCommand.ts b/clients/client-pinpoint/src/commands/GetCampaignCommand.ts
@@ -270,6 +270,10 @@ export interface GetCampaignCommandOutput extends GetCampaignResponse, __Metadat
  * // Name: "STRING_VALUE",
  * // Version: "STRING_VALUE",
  * // },
+ * // InAppTemplate: {
+ * // Name: "STRING_VALUE",
+ * // Version: "STRING_VALUE",
+ * // },
  * // },
  * // TreatmentDescription: "STRING_VALUE",
  * // TreatmentName: "STRING_VALUE",
@@ -417,13 +421,11 @@ export interface GetCampaignCommandOutput extends GetCampaignResponse, __Metadat
  * // },
  * // tags: "<MapOf__string>",
  * // TemplateConfiguration: {
- * // EmailTemplate: {
- * // Name: "STRING_VALUE",
- * // Version: "STRING_VALUE",
- * // },
+ * // EmailTemplate: "<Template>",
  * // PushTemplate: "<Template>",
  * // SMSTemplate: "<Template>",
  * // VoiceTemplate: "<Template>",
+ * // InAppTemplate: "<Template>",
  * // },
  * // TreatmentDescription: "STRING_VALUE",
  * // TreatmentName: "STRING_VALUE",

diff --git a/clients/client-pinpoint/src/commands/GetCampaignVersionCommand.ts b/clients/client-pinpoint/src/commands/GetCampaignVersionCommand.ts
@@ -13,7 +13,8 @@ import {
  SerdeContext as __SerdeContext,
 } from "@smithy/types";
 
-import { GetCampaignVersionRequest, GetCampaignVersionResponse } from "../models/models_0";
+import { GetCampaignVersionRequest } from "../models/models_0";
+import { GetCampaignVersionResponse } from "../models/models_1";
 import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
 import { de_GetCampaignVersionCommand, se_GetCampaignVersionCommand } from "../protocols/Aws_restJson1";
 
@@ -271,6 +272,10 @@ export interface GetCampaignVersionCommandOutput extends GetCampaignVersionRespo
  * // Name: "STRING_VALUE",
  * // Version: "STRING_VALUE",
  * // },
+ * // InAppTemplate: {
+ * // Name: "STRING_VALUE",
+ * // Version: "STRING_VALUE",
+ * // },
  * // },
  * // TreatmentDescription: "STRING_VALUE",
  * // TreatmentName: "STRING_VALUE",
@@ -418,13 +423,11 @@ export interface GetCampaignVersionCommandOutput extends GetCampaignVersionRespo
  * // },
  * // tags: "<MapOf__string>",
  * // TemplateConfiguration: {
- * // EmailTemplate: {
- * // Name: "STRING_VALUE",
- * // Version: "STRING_VALUE",
- * // },
+ * // EmailTemplate: "<Template>",
  * // PushTemplate: "<Template>",
  * // SMSTemplate: "<Template>",
  * // VoiceTemplate: "<Template>",
+ * // InAppTemplate: "<Template>",
  * // },
  * // TreatmentDescription: "STRING_VALUE",
  * // TreatmentName: "STRING_VALUE",

diff --git a/clients/client-pinpoint/src/commands/GetCampaignVersionsCommand.ts b/clients/client-pinpoint/src/commands/GetCampaignVersionsCommand.ts
@@ -13,8 +13,7 @@ import {
  SerdeContext as __SerdeContext,
 } from "@smithy/types";
 
-import { GetCampaignVersionsRequest } from "../models/models_0";
-import { GetCampaignVersionsResponse } from "../models/models_1";
+import { GetCampaignVersionsRequest, GetCampaignVersionsResponse } from "../models/models_1";
 import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
 import { de_GetCampaignVersionsCommand, se_GetCampaignVersionsCommand } from "../protocols/Aws_restJson1";
 
@@ -275,6 +274,10 @@ export interface GetCampaignVersionsCommandOutput extends GetCampaignVersionsRes
  * // Name: "STRING_VALUE",
  * // Version: "STRING_VALUE",
  * // },
+ * // InAppTemplate: {
+ * // Name: "STRING_VALUE",
+ * // Version: "STRING_VALUE",
+ * // },
  * // },
  * // TreatmentDescription: "STRING_VALUE",
  * // TreatmentName: "STRING_VALUE",
@@ -422,13 +425,11 @@ export interface GetCampaignVersionsCommandOutput extends GetCampaignVersionsRes
  * // },
  * // tags: "<MapOf__string>",
  * // TemplateConfiguration: {
- * // EmailTemplate: {
- * // Name: "STRING_VALUE",
- * // Version: "STRING_VALUE",
- * // },
+ * // EmailTemplate: "<Template>",
  * // PushTemplate: "<Template>",
  * // SMSTemplate: "<Template>",
  * // VoiceTemplate: "<Template>",
+ * // InAppTemplate: "<Template>",
  * // },
  * // TreatmentDescription: "STRING_VALUE",
  * // TreatmentName: "STRING_VALUE",

diff --git a/clients/client-pinpoint/src/commands/GetCampaignsCommand.ts b/clients/client-pinpoint/src/commands/GetCampaignsCommand.ts
@@ -273,6 +273,10 @@ export interface GetCampaignsCommandOutput extends GetCampaignsResponse, __Metad
  * // Name: "STRING_VALUE",
  * // Version: "STRING_VALUE",
  * // },
+ * // InAppTemplate: {
+ * // Name: "STRING_VALUE",
+ * // Version: "STRING_VALUE",
+ * // },
  * // },
  * // TreatmentDescription: "STRING_VALUE",
  * // TreatmentName: "STRING_VALUE",
@@ -420,13 +424,11 @@ export interface GetCampaignsCommandOutput extends GetCampaignsResponse, __Metad
  * // },
  * // tags: "<MapOf__string>",
  * // TemplateConfiguration: {
- * // EmailTemplate: {
- * // Name: "STRING_VALUE",
- * // Version: "STRING_VALUE",
- * // },
+ * // EmailTemplate: "<Template>",
  * // PushTemplate: "<Template>",
  * // SMSTemplate: "<Template>",
  * // VoiceTemplate: "<Template>",
+ * // InAppTemplate: "<Template>",
  * // },
  * // TreatmentDescription: "STRING_VALUE",
  * // TreatmentName: "STRING_VALUE",

diff --git a/clients/client-pinpoint/src/commands/GetGcmChannelCommand.ts b/clients/client-pinpoint/src/commands/GetGcmChannelCommand.ts
@@ -52,9 +52,11 @@ export interface GetGcmChannelCommandOutput extends GetGcmChannelResponse, __Met
  * // GCMChannelResponse: { // GCMChannelResponse
  * // ApplicationId: "STRING_VALUE",
  * // CreationDate: "STRING_VALUE",
- * // Credential: "STRING_VALUE", // required
+ * // Credential: "STRING_VALUE",
+ * // DefaultAuthenticationMethod: "STRING_VALUE",
  * // Enabled: true || false,
  * // HasCredential: true || false,
+ * // HasFcmServiceCredentials: true || false,
  * // Id: "STRING_VALUE",
  * // IsArchived: true || false,
  * // LastModifiedBy: "STRING_VALUE",

diff --git a/clients/client-pinpoint/src/commands/GetJourneyCommand.ts b/clients/client-pinpoint/src/commands/GetJourneyCommand.ts
@@ -306,6 +306,11 @@ export interface GetJourneyCommandOutput extends GetJourneyResponse, __MetadataB
  * // EndpointReentryCap: Number("int"),
  * // MessagesPerSecond: Number("int"),
  * // EndpointReentryInterval: "STRING_VALUE",
+ * // TimeframeCap: { // JourneyTimeframeCap
+ * // Cap: Number("int"),
+ * // Days: Number("int"),
+ * // },
+ * // TotalCap: Number("int"),
  * // },
  * // LocalTime: true || false,
  * // Name: "STRING_VALUE", // required

diff --git a/clients/client-pinpoint/src/commands/ListJourneysCommand.ts b/clients/client-pinpoint/src/commands/ListJourneysCommand.ts
@@ -309,6 +309,11 @@ export interface ListJourneysCommandOutput extends ListJourneysResponse, __Metad
  * // EndpointReentryCap: Number("int"),
  * // MessagesPerSecond: Number("int"),
  * // EndpointReentryInterval: "STRING_VALUE",
+ * // TimeframeCap: { // JourneyTimeframeCap
+ * // Cap: Number("int"),
+ * // Days: Number("int"),
+ * // },
+ * // TotalCap: Number("int"),
  * // },
  * // LocalTime: true || false,
  * // Name: "STRING_VALUE", // required

diff --git a/clients/client-pinpoint/src/commands/SendMessagesCommand.ts b/clients/client-pinpoint/src/commands/SendMessagesCommand.ts
@@ -196,6 +196,7 @@ export interface SendMessagesCommandOutput extends SendMessagesResponse, __Metad
  * IconReference: "STRING_VALUE",
  * ImageIconUrl: "STRING_VALUE",
  * ImageUrl: "STRING_VALUE",
+ * PreferredAuthenticationMethod: "STRING_VALUE",
  * Priority: "STRING_VALUE",
  * RawContent: "STRING_VALUE",
  * RestrictedPackageName: "STRING_VALUE",
@@ -243,6 +244,10 @@ export interface SendMessagesCommandOutput extends SendMessagesResponse, __Metad
  * Name: "STRING_VALUE",
  * Version: "STRING_VALUE",
  * },
+ * InAppTemplate: {
+ * Name: "STRING_VALUE",
+ * Version: "STRING_VALUE",
+ * },
  * },
  * TraceId: "STRING_VALUE",
  * },

diff --git a/clients/client-pinpoint/src/commands/SendUsersMessagesCommand.ts b/clients/client-pinpoint/src/commands/SendUsersMessagesCommand.ts
@@ -177,6 +177,7 @@ export interface SendUsersMessagesCommandOutput extends SendUsersMessagesRespons
  * IconReference: "STRING_VALUE",
  * ImageIconUrl: "STRING_VALUE",
  * ImageUrl: "STRING_VALUE",
+ * PreferredAuthenticationMethod: "STRING_VALUE",
  * Priority: "STRING_VALUE",
  * RawContent: "STRING_VALUE",
  * RestrictedPackageName: "STRING_VALUE",
@@ -224,6 +225,10 @@ export interface SendUsersMessagesCommandOutput extends SendUsersMessagesRespons
  * Name: "STRING_VALUE",
  * Version: "STRING_VALUE",
  * },
+ * InAppTemplate: {
+ * Name: "STRING_VALUE",
+ * Version: "STRING_VALUE",
+ * },
  * },
  * TraceId: "STRING_VALUE",
  * Users: { // MapOfEndpointSendConfiguration // required

diff --git a/clients/client-pinpoint/src/commands/UpdateApplicationSettingsCommand.ts b/clients/client-pinpoint/src/commands/UpdateApplicationSettingsCommand.ts
@@ -64,6 +64,14 @@ export interface UpdateApplicationSettingsCommandOutput extends UpdateApplicatio
  * End: "STRING_VALUE",
  * Start: "STRING_VALUE",
  * },
+ * JourneyLimits: { // ApplicationSettingsJourneyLimits
+ * DailyCap: Number("int"),
+ * TimeframeCap: { // JourneyTimeframeCap
+ * Cap: Number("int"),
+ * Days: Number("int"),
+ * },
+ * TotalCap: Number("int"),
+ * },
  * },
  * };
  * const command = new UpdateApplicationSettingsCommand(input);
@@ -88,6 +96,14 @@ export interface UpdateApplicationSettingsCommandOutput extends UpdateApplicatio
  * // End: "STRING_VALUE",
  * // Start: "STRING_VALUE",
  * // },
+ * // JourneyLimits: { // ApplicationSettingsJourneyLimits
+ * // DailyCap: Number("int"),
+ * // TimeframeCap: { // JourneyTimeframeCap
+ * // Cap: Number("int"),
+ * // Days: Number("int"),
+ * // },
+ * // TotalCap: Number("int"),
+ * // },
  * // },
  * // };
  *