feat(client-pinpoint): This release adds support for specifying email…

… message headers for Email Templates, Campaigns, Journeys and Send Messages.
aws · May 9, 2024 · efa9f25 · efa9f25
1 parent 98edd48
commit efa9f25
Show file tree

Hide file tree

Showing 16 changed files with 265 additions and 25 deletions.
diff --git a/clients/client-pinpoint/src/commands/CreateCampaignCommand.ts b/clients/client-pinpoint/src/commands/CreateCampaignCommand.ts
@@ -108,6 +108,12 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
  *           EmailMessage: { // CampaignEmailMessage
  *             Body: "STRING_VALUE",
  *             FromAddress: "STRING_VALUE",
+ *             Headers: [ // ListOfMessageHeader
+ *               { // MessageHeader
+ *                 Name: "STRING_VALUE",
+ *                 Value: "STRING_VALUE",
+ *               },
+ *             ],
  *             HtmlBody: "STRING_VALUE",
  *             Title: "STRING_VALUE",
  *           },
@@ -293,6 +299,12 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
  *       EmailMessage: {
  *         Body: "STRING_VALUE",
  *         FromAddress: "STRING_VALUE",
+ *         Headers: [
+ *           {
+ *             Name: "STRING_VALUE",
+ *             Value: "STRING_VALUE",
+ *           },
+ *         ],
  *         HtmlBody: "STRING_VALUE",
  *         Title: "STRING_VALUE",
  *       },
@@ -479,6 +491,12 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
  * //           EmailMessage: { // CampaignEmailMessage
  * //             Body: "STRING_VALUE",
  * //             FromAddress: "STRING_VALUE",
+ * //             Headers: [ // ListOfMessageHeader
+ * //               { // MessageHeader
+ * //                 Name: "STRING_VALUE",
+ * //                 Value: "STRING_VALUE",
+ * //               },
+ * //             ],
  * //             HtmlBody: "STRING_VALUE",
  * //             Title: "STRING_VALUE",
  * //           },
@@ -675,6 +693,12 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
  * //       EmailMessage: {
  * //         Body: "STRING_VALUE",
  * //         FromAddress: "STRING_VALUE",
+ * //         Headers: [
+ * //           {
+ * //             Name: "STRING_VALUE",
+ * //             Value: "STRING_VALUE",
+ * //           },
+ * //         ],
  * //         HtmlBody: "STRING_VALUE",
  * //         Title: "STRING_VALUE",
  * //       },

diff --git a/clients/client-pinpoint/src/commands/CreateEmailTemplateCommand.ts b/clients/client-pinpoint/src/commands/CreateEmailTemplateCommand.ts
@@ -40,6 +40,12 @@ export interface CreateEmailTemplateCommandOutput extends CreateEmailTemplateRes
  *     HtmlPart: "STRING_VALUE",
  *     RecommenderId: "STRING_VALUE",
  *     Subject: "STRING_VALUE",
+ *     Headers: [ // ListOfMessageHeader
+ *       { // MessageHeader
+ *         Name: "STRING_VALUE",
+ *         Value: "STRING_VALUE",
+ *       },
+ *     ],
  *     tags: { // MapOf__string
  *       "<keys>": "STRING_VALUE",
  *     },

diff --git a/clients/client-pinpoint/src/commands/DeleteCampaignCommand.ts b/clients/client-pinpoint/src/commands/DeleteCampaignCommand.ts
@@ -114,6 +114,12 @@ export interface DeleteCampaignCommandOutput extends DeleteCampaignResponse, __M
  * //           EmailMessage: { // CampaignEmailMessage
  * //             Body: "STRING_VALUE",
  * //             FromAddress: "STRING_VALUE",
+ * //             Headers: [ // ListOfMessageHeader
+ * //               { // MessageHeader
+ * //                 Name: "STRING_VALUE",
+ * //                 Value: "STRING_VALUE",
+ * //               },
+ * //             ],
  * //             HtmlBody: "STRING_VALUE",
  * //             Title: "STRING_VALUE",
  * //           },
@@ -310,6 +316,12 @@ export interface DeleteCampaignCommandOutput extends DeleteCampaignResponse, __M
  * //       EmailMessage: {
  * //         Body: "STRING_VALUE",
  * //         FromAddress: "STRING_VALUE",
+ * //         Headers: [
+ * //           {
+ * //             Name: "STRING_VALUE",
+ * //             Value: "STRING_VALUE",
+ * //           },
+ * //         ],
  * //         HtmlBody: "STRING_VALUE",
  * //         Title: "STRING_VALUE",
  * //       },

diff --git a/clients/client-pinpoint/src/commands/GetCampaignCommand.ts b/clients/client-pinpoint/src/commands/GetCampaignCommand.ts
@@ -114,6 +114,12 @@ export interface GetCampaignCommandOutput extends GetCampaignResponse, __Metadat
  * //           EmailMessage: { // CampaignEmailMessage
  * //             Body: "STRING_VALUE",
  * //             FromAddress: "STRING_VALUE",
+ * //             Headers: [ // ListOfMessageHeader
+ * //               { // MessageHeader
+ * //                 Name: "STRING_VALUE",
+ * //                 Value: "STRING_VALUE",
+ * //               },
+ * //             ],
  * //             HtmlBody: "STRING_VALUE",
  * //             Title: "STRING_VALUE",
  * //           },
@@ -310,6 +316,12 @@ export interface GetCampaignCommandOutput extends GetCampaignResponse, __Metadat
  * //       EmailMessage: {
  * //         Body: "STRING_VALUE",
  * //         FromAddress: "STRING_VALUE",
+ * //         Headers: [
+ * //           {
+ * //             Name: "STRING_VALUE",
+ * //             Value: "STRING_VALUE",
+ * //           },
+ * //         ],
  * //         HtmlBody: "STRING_VALUE",
  * //         Title: "STRING_VALUE",
  * //       },

diff --git a/clients/client-pinpoint/src/commands/GetCampaignVersionCommand.ts b/clients/client-pinpoint/src/commands/GetCampaignVersionCommand.ts
@@ -5,8 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { commonParams } from "../endpoint/EndpointParameters";
-import { GetCampaignVersionRequest } from "../models/models_0";
-import { GetCampaignVersionResponse } from "../models/models_1";
+import { GetCampaignVersionRequest, GetCampaignVersionResponse } from "../models/models_1";
 import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
 import { de_GetCampaignVersionCommand, se_GetCampaignVersionCommand } from "../protocols/Aws_restJson1";
 
@@ -116,6 +115,12 @@ export interface GetCampaignVersionCommandOutput extends GetCampaignVersionRespo
  * //           EmailMessage: { // CampaignEmailMessage
  * //             Body: "STRING_VALUE",
  * //             FromAddress: "STRING_VALUE",
+ * //             Headers: [ // ListOfMessageHeader
+ * //               { // MessageHeader
+ * //                 Name: "STRING_VALUE",
+ * //                 Value: "STRING_VALUE",
+ * //               },
+ * //             ],
  * //             HtmlBody: "STRING_VALUE",
  * //             Title: "STRING_VALUE",
  * //           },
@@ -312,6 +317,12 @@ export interface GetCampaignVersionCommandOutput extends GetCampaignVersionRespo
  * //       EmailMessage: {
  * //         Body: "STRING_VALUE",
  * //         FromAddress: "STRING_VALUE",
+ * //         Headers: [
+ * //           {
+ * //             Name: "STRING_VALUE",
+ * //             Value: "STRING_VALUE",
+ * //           },
+ * //         ],
  * //         HtmlBody: "STRING_VALUE",
  * //         Title: "STRING_VALUE",
  * //       },

diff --git a/clients/client-pinpoint/src/commands/GetCampaignVersionsCommand.ts b/clients/client-pinpoint/src/commands/GetCampaignVersionsCommand.ts
@@ -118,6 +118,12 @@ export interface GetCampaignVersionsCommandOutput extends GetCampaignVersionsRes
  * //               EmailMessage: { // CampaignEmailMessage
  * //                 Body: "STRING_VALUE",
  * //                 FromAddress: "STRING_VALUE",
+ * //                 Headers: [ // ListOfMessageHeader
+ * //                   { // MessageHeader
+ * //                     Name: "STRING_VALUE",
+ * //                     Value: "STRING_VALUE",
+ * //                   },
+ * //                 ],
  * //                 HtmlBody: "STRING_VALUE",
  * //                 Title: "STRING_VALUE",
  * //               },
@@ -314,6 +320,12 @@ export interface GetCampaignVersionsCommandOutput extends GetCampaignVersionsRes
  * //           EmailMessage: {
  * //             Body: "STRING_VALUE",
  * //             FromAddress: "STRING_VALUE",
+ * //             Headers: [
+ * //               {
+ * //                 Name: "STRING_VALUE",
+ * //                 Value: "STRING_VALUE",
+ * //               },
+ * //             ],
  * //             HtmlBody: "STRING_VALUE",
  * //             Title: "STRING_VALUE",
  * //           },

diff --git a/clients/client-pinpoint/src/commands/GetCampaignsCommand.ts b/clients/client-pinpoint/src/commands/GetCampaignsCommand.ts
@@ -117,6 +117,12 @@ export interface GetCampaignsCommandOutput extends GetCampaignsResponse, __Metad
  * //               EmailMessage: { // CampaignEmailMessage
  * //                 Body: "STRING_VALUE",
  * //                 FromAddress: "STRING_VALUE",
+ * //                 Headers: [ // ListOfMessageHeader
+ * //                   { // MessageHeader
+ * //                     Name: "STRING_VALUE",
+ * //                     Value: "STRING_VALUE",
+ * //                   },
+ * //                 ],
  * //                 HtmlBody: "STRING_VALUE",
  * //                 Title: "STRING_VALUE",
  * //               },
@@ -313,6 +319,12 @@ export interface GetCampaignsCommandOutput extends GetCampaignsResponse, __Metad
  * //           EmailMessage: {
  * //             Body: "STRING_VALUE",
  * //             FromAddress: "STRING_VALUE",
+ * //             Headers: [
+ * //               {
+ * //                 Name: "STRING_VALUE",
+ * //                 Value: "STRING_VALUE",
+ * //               },
+ * //             ],
  * //             HtmlBody: "STRING_VALUE",
  * //             Title: "STRING_VALUE",
  * //           },

diff --git a/clients/client-pinpoint/src/commands/GetEmailTemplateCommand.ts b/clients/client-pinpoint/src/commands/GetEmailTemplateCommand.ts
@@ -49,6 +49,12 @@ export interface GetEmailTemplateCommandOutput extends GetEmailTemplateResponse,
  * //     LastModifiedDate: "STRING_VALUE", // required
  * //     RecommenderId: "STRING_VALUE",
  * //     Subject: "STRING_VALUE",
+ * //     Headers: [ // ListOfMessageHeader
+ * //       { // MessageHeader
+ * //         Name: "STRING_VALUE",
+ * //         Value: "STRING_VALUE",
+ * //       },
+ * //     ],
  * //     tags: { // MapOf__string
  * //       "<keys>": "STRING_VALUE",
  * //     },

diff --git a/clients/client-pinpoint/src/commands/SendMessagesCommand.ts b/clients/client-pinpoint/src/commands/SendMessagesCommand.ts
@@ -176,6 +176,12 @@ export interface SendMessagesCommandOutput extends SendMessagesResponse, __Metad
  *             Charset: "STRING_VALUE",
  *             Data: "STRING_VALUE",
  *           },
+ *           Headers: [ // ListOfMessageHeader
+ *             { // MessageHeader
+ *               Name: "STRING_VALUE",
+ *               Value: "STRING_VALUE",
+ *             },
+ *           ],
  *         },
  *         Substitutions: "<MapOfListOf__string>",
  *       },

diff --git a/clients/client-pinpoint/src/commands/SendUsersMessagesCommand.ts b/clients/client-pinpoint/src/commands/SendUsersMessagesCommand.ts
@@ -157,6 +157,12 @@ export interface SendUsersMessagesCommandOutput extends SendUsersMessagesRespons
  *             Charset: "STRING_VALUE",
  *             Data: "STRING_VALUE",
  *           },
+ *           Headers: [ // ListOfMessageHeader
+ *             { // MessageHeader
+ *               Name: "STRING_VALUE",
+ *               Value: "STRING_VALUE",
+ *             },
+ *           ],
  *         },
  *         Substitutions: "<MapOfListOf__string>",
  *       },

diff --git a/clients/client-pinpoint/src/commands/UpdateCampaignCommand.ts b/clients/client-pinpoint/src/commands/UpdateCampaignCommand.ts
@@ -109,6 +109,12 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
  *           EmailMessage: { // CampaignEmailMessage
  *             Body: "STRING_VALUE",
  *             FromAddress: "STRING_VALUE",
+ *             Headers: [ // ListOfMessageHeader
+ *               { // MessageHeader
+ *                 Name: "STRING_VALUE",
+ *                 Value: "STRING_VALUE",
+ *               },
+ *             ],
  *             HtmlBody: "STRING_VALUE",
  *             Title: "STRING_VALUE",
  *           },
@@ -294,6 +300,12 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
  *       EmailMessage: {
  *         Body: "STRING_VALUE",
  *         FromAddress: "STRING_VALUE",
+ *         Headers: [
+ *           {
+ *             Name: "STRING_VALUE",
+ *             Value: "STRING_VALUE",
+ *           },
+ *         ],
  *         HtmlBody: "STRING_VALUE",
  *         Title: "STRING_VALUE",
  *       },
@@ -480,6 +492,12 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
  * //           EmailMessage: { // CampaignEmailMessage
  * //             Body: "STRING_VALUE",
  * //             FromAddress: "STRING_VALUE",
+ * //             Headers: [ // ListOfMessageHeader
+ * //               { // MessageHeader
+ * //                 Name: "STRING_VALUE",
+ * //                 Value: "STRING_VALUE",
+ * //               },
+ * //             ],
  * //             HtmlBody: "STRING_VALUE",
  * //             Title: "STRING_VALUE",
  * //           },
@@ -676,6 +694,12 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
  * //       EmailMessage: {
  * //         Body: "STRING_VALUE",
  * //         FromAddress: "STRING_VALUE",
+ * //         Headers: [
+ * //           {
+ * //             Name: "STRING_VALUE",
+ * //             Value: "STRING_VALUE",
+ * //           },
+ * //         ],
  * //         HtmlBody: "STRING_VALUE",
  * //         Title: "STRING_VALUE",
  * //       },

diff --git a/clients/client-pinpoint/src/commands/UpdateEmailTemplateCommand.ts b/clients/client-pinpoint/src/commands/UpdateEmailTemplateCommand.ts
@@ -41,6 +41,12 @@ export interface UpdateEmailTemplateCommandOutput extends UpdateEmailTemplateRes
  *     HtmlPart: "STRING_VALUE",
  *     RecommenderId: "STRING_VALUE",
  *     Subject: "STRING_VALUE",
+ *     Headers: [ // ListOfMessageHeader
+ *       { // MessageHeader
+ *         Name: "STRING_VALUE",
+ *         Value: "STRING_VALUE",
+ *       },
+ *     ],
  *     tags: { // MapOf__string
  *       "<keys>": "STRING_VALUE",
  *     },