@aws-sdk/client-pinpoint 3.332.0 → 3.335.1

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.
Files changed (149) hide show
  1. package/CHANGELOG.md +4785 -0
  2. package/dist-cjs/protocols/Aws_restJson1.js +1 -1
  3. package/dist-es/protocols/Aws_restJson1.js +1 -1
  4. package/dist-types/PinpointClient.d.ts +3 -2
  5. package/dist-types/endpoint/EndpointParameters.d.ts +2 -1
  6. package/dist-types/protocols/Aws_restJson1.d.ts +2 -2
  7. package/dist-types/runtimeConfig.browser.d.ts +12 -12
  8. package/dist-types/runtimeConfig.d.ts +9 -9
  9. package/dist-types/runtimeConfig.native.d.ts +13 -13
  10. package/dist-types/runtimeConfig.shared.d.ts +4 -4
  11. package/dist-types/ts3.4/Pinpoint.d.ts +864 -2091
  12. package/dist-types/ts3.4/PinpointClient.d.ts +284 -844
  13. package/dist-types/ts3.4/commands/CreateAppCommand.d.ts +103 -34
  14. package/dist-types/ts3.4/commands/CreateCampaignCommand.d.ts +833 -37
  15. package/dist-types/ts3.4/commands/CreateEmailTemplateCommand.d.ts +99 -38
  16. package/dist-types/ts3.4/commands/CreateExportJobCommand.d.ts +117 -37
  17. package/dist-types/ts3.4/commands/CreateImportJobCommand.d.ts +125 -37
  18. package/dist-types/ts3.4/commands/CreateInAppTemplateCommand.d.ts +155 -38
  19. package/dist-types/ts3.4/commands/CreateJourneyCommand.d.ts +840 -37
  20. package/dist-types/ts3.4/commands/CreatePushTemplateCommand.d.ts +145 -38
  21. package/dist-types/ts3.4/commands/CreateRecommenderConfigurationCommand.d.ts +117 -41
  22. package/dist-types/ts3.4/commands/CreateSegmentCommand.d.ts +378 -37
  23. package/dist-types/ts3.4/commands/CreateSmsTemplateCommand.d.ts +97 -38
  24. package/dist-types/ts3.4/commands/CreateVoiceTemplateCommand.d.ts +98 -38
  25. package/dist-types/ts3.4/commands/DeleteAdmChannelCommand.d.ts +101 -37
  26. package/dist-types/ts3.4/commands/DeleteApnsChannelCommand.d.ts +103 -38
  27. package/dist-types/ts3.4/commands/DeleteApnsSandboxChannelCommand.d.ts +103 -41
  28. package/dist-types/ts3.4/commands/DeleteApnsVoipChannelCommand.d.ts +103 -41
  29. package/dist-types/ts3.4/commands/DeleteApnsVoipSandboxChannelCommand.d.ts +103 -41
  30. package/dist-types/ts3.4/commands/DeleteAppCommand.d.ts +98 -34
  31. package/dist-types/ts3.4/commands/DeleteBaiduChannelCommand.d.ts +102 -38
  32. package/dist-types/ts3.4/commands/DeleteCampaignCommand.d.ts +470 -37
  33. package/dist-types/ts3.4/commands/DeleteEmailChannelCommand.d.ts +106 -38
  34. package/dist-types/ts3.4/commands/DeleteEmailTemplateCommand.d.ts +94 -38
  35. package/dist-types/ts3.4/commands/DeleteEndpointCommand.d.ts +136 -37
  36. package/dist-types/ts3.4/commands/DeleteEventStreamCommand.d.ts +97 -38
  37. package/dist-types/ts3.4/commands/DeleteGcmChannelCommand.d.ts +102 -37
  38. package/dist-types/ts3.4/commands/DeleteInAppTemplateCommand.d.ts +94 -38
  39. package/dist-types/ts3.4/commands/DeleteJourneyCommand.d.ts +468 -37
  40. package/dist-types/ts3.4/commands/DeletePushTemplateCommand.d.ts +94 -38
  41. package/dist-types/ts3.4/commands/DeleteRecommenderConfigurationCommand.d.ts +105 -41
  42. package/dist-types/ts3.4/commands/DeleteSegmentCommand.d.ts +243 -37
  43. package/dist-types/ts3.4/commands/DeleteSmsChannelCommand.d.ts +105 -37
  44. package/dist-types/ts3.4/commands/DeleteSmsTemplateCommand.d.ts +94 -38
  45. package/dist-types/ts3.4/commands/DeleteUserEndpointsCommand.d.ts +140 -38
  46. package/dist-types/ts3.4/commands/DeleteVoiceChannelCommand.d.ts +101 -38
  47. package/dist-types/ts3.4/commands/DeleteVoiceTemplateCommand.d.ts +94 -38
  48. package/dist-types/ts3.4/commands/GetAdmChannelCommand.d.ts +101 -37
  49. package/dist-types/ts3.4/commands/GetApnsChannelCommand.d.ts +103 -37
  50. package/dist-types/ts3.4/commands/GetApnsSandboxChannelCommand.d.ts +103 -41
  51. package/dist-types/ts3.4/commands/GetApnsVoipChannelCommand.d.ts +103 -38
  52. package/dist-types/ts3.4/commands/GetApnsVoipSandboxChannelCommand.d.ts +103 -41
  53. package/dist-types/ts3.4/commands/GetAppCommand.d.ts +98 -32
  54. package/dist-types/ts3.4/commands/GetApplicationDateRangeKpiCommand.d.ts +121 -41
  55. package/dist-types/ts3.4/commands/GetApplicationSettingsCommand.d.ts +109 -41
  56. package/dist-types/ts3.4/commands/GetAppsCommand.d.ts +104 -34
  57. package/dist-types/ts3.4/commands/GetBaiduChannelCommand.d.ts +102 -37
  58. package/dist-types/ts3.4/commands/GetCampaignActivitiesCommand.d.ts +115 -41
  59. package/dist-types/ts3.4/commands/GetCampaignCommand.d.ts +470 -34
  60. package/dist-types/ts3.4/commands/GetCampaignDateRangeKpiCommand.d.ts +123 -41
  61. package/dist-types/ts3.4/commands/GetCampaignVersionCommand.d.ts +471 -38
  62. package/dist-types/ts3.4/commands/GetCampaignVersionsCommand.d.ts +477 -38
  63. package/dist-types/ts3.4/commands/GetCampaignsCommand.d.ts +476 -34
  64. package/dist-types/ts3.4/commands/GetChannelsCommand.d.ts +104 -34
  65. package/dist-types/ts3.4/commands/GetEmailChannelCommand.d.ts +106 -37
  66. package/dist-types/ts3.4/commands/GetEmailTemplateCommand.d.ts +107 -37
  67. package/dist-types/ts3.4/commands/GetEndpointCommand.d.ts +136 -34
  68. package/dist-types/ts3.4/commands/GetEventStreamCommand.d.ts +97 -37
  69. package/dist-types/ts3.4/commands/GetExportJobCommand.d.ts +112 -34
  70. package/dist-types/ts3.4/commands/GetExportJobsCommand.d.ts +118 -37
  71. package/dist-types/ts3.4/commands/GetGcmChannelCommand.d.ts +102 -37
  72. package/dist-types/ts3.4/commands/GetImportJobCommand.d.ts +116 -34
  73. package/dist-types/ts3.4/commands/GetImportJobsCommand.d.ts +122 -37
  74. package/dist-types/ts3.4/commands/GetInAppMessagesCommand.d.ts +197 -37
  75. package/dist-types/ts3.4/commands/GetInAppTemplateCommand.d.ts +163 -37
  76. package/dist-types/ts3.4/commands/GetJourneyCommand.d.ts +468 -34
  77. package/dist-types/ts3.4/commands/GetJourneyDateRangeKpiCommand.d.ts +123 -41
  78. package/dist-types/ts3.4/commands/GetJourneyExecutionActivityMetricsCommand.d.ts +103 -41
  79. package/dist-types/ts3.4/commands/GetJourneyExecutionMetricsCommand.d.ts +100 -41
  80. package/dist-types/ts3.4/commands/GetJourneyRunExecutionActivityMetricsCommand.d.ts +134 -41
  81. package/dist-types/ts3.4/commands/GetJourneyRunExecutionMetricsCommand.d.ts +130 -41
  82. package/dist-types/ts3.4/commands/GetJourneyRunsCommand.d.ts +135 -37
  83. package/dist-types/ts3.4/commands/GetPushTemplateCommand.d.ts +153 -37
  84. package/dist-types/ts3.4/commands/GetRecommenderConfigurationCommand.d.ts +105 -41
  85. package/dist-types/ts3.4/commands/GetRecommenderConfigurationsCommand.d.ts +111 -41
  86. package/dist-types/ts3.4/commands/GetSegmentCommand.d.ts +243 -34
  87. package/dist-types/ts3.4/commands/GetSegmentExportJobsCommand.d.ts +119 -41
  88. package/dist-types/ts3.4/commands/GetSegmentImportJobsCommand.d.ts +123 -41
  89. package/dist-types/ts3.4/commands/GetSegmentVersionCommand.d.ts +244 -38
  90. package/dist-types/ts3.4/commands/GetSegmentVersionsCommand.d.ts +250 -38
  91. package/dist-types/ts3.4/commands/GetSegmentsCommand.d.ts +249 -34
  92. package/dist-types/ts3.4/commands/GetSmsChannelCommand.d.ts +105 -37
  93. package/dist-types/ts3.4/commands/GetSmsTemplateCommand.d.ts +105 -37
  94. package/dist-types/ts3.4/commands/GetUserEndpointsCommand.d.ts +140 -37
  95. package/dist-types/ts3.4/commands/GetVoiceChannelCommand.d.ts +101 -37
  96. package/dist-types/ts3.4/commands/GetVoiceTemplateCommand.d.ts +106 -37
  97. package/dist-types/ts3.4/commands/ListJourneysCommand.d.ts +474 -34
  98. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +73 -38
  99. package/dist-types/ts3.4/commands/ListTemplateVersionsCommand.d.ts +108 -41
  100. package/dist-types/ts3.4/commands/ListTemplatesCommand.d.ts +104 -37
  101. package/dist-types/ts3.4/commands/PhoneNumberValidateCommand.d.ts +108 -38
  102. package/dist-types/ts3.4/commands/PutEventStreamCommand.d.ts +101 -37
  103. package/dist-types/ts3.4/commands/PutEventsCommand.d.ts +176 -34
  104. package/dist-types/ts3.4/commands/RemoveAttributesCommand.d.ts +102 -37
  105. package/dist-types/ts3.4/commands/SendMessagesCommand.d.ts +313 -34
  106. package/dist-types/ts3.4/commands/SendOTPMessageCommand.d.ts +125 -37
  107. package/dist-types/ts3.4/commands/SendUsersMessagesCommand.d.ts +296 -38
  108. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +72 -32
  109. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +70 -32
  110. package/dist-types/ts3.4/commands/UpdateAdmChannelCommand.d.ts +106 -37
  111. package/dist-types/ts3.4/commands/UpdateApnsChannelCommand.d.ts +113 -38
  112. package/dist-types/ts3.4/commands/UpdateApnsSandboxChannelCommand.d.ts +113 -41
  113. package/dist-types/ts3.4/commands/UpdateApnsVoipChannelCommand.d.ts +113 -41
  114. package/dist-types/ts3.4/commands/UpdateApnsVoipSandboxChannelCommand.d.ts +113 -41
  115. package/dist-types/ts3.4/commands/UpdateApplicationSettingsCommand.d.ts +129 -41
  116. package/dist-types/ts3.4/commands/UpdateBaiduChannelCommand.d.ts +107 -38
  117. package/dist-types/ts3.4/commands/UpdateCampaignCommand.d.ts +834 -37
  118. package/dist-types/ts3.4/commands/UpdateEmailChannelCommand.d.ts +113 -38
  119. package/dist-types/ts3.4/commands/UpdateEmailTemplateCommand.d.ts +106 -38
  120. package/dist-types/ts3.4/commands/UpdateEndpointCommand.d.ts +136 -37
  121. package/dist-types/ts3.4/commands/UpdateEndpointsBatchCommand.d.ts +140 -41
  122. package/dist-types/ts3.4/commands/UpdateGcmChannelCommand.d.ts +106 -37
  123. package/dist-types/ts3.4/commands/UpdateInAppTemplateCommand.d.ts +162 -38
  124. package/dist-types/ts3.4/commands/UpdateJourneyCommand.d.ts +844 -37
  125. package/dist-types/ts3.4/commands/UpdateJourneyStateCommand.d.ts +471 -38
  126. package/dist-types/ts3.4/commands/UpdatePushTemplateCommand.d.ts +152 -38
  127. package/dist-types/ts3.4/commands/UpdateRecommenderConfigurationCommand.d.ts +118 -41
  128. package/dist-types/ts3.4/commands/UpdateSegmentCommand.d.ts +379 -37
  129. package/dist-types/ts3.4/commands/UpdateSmsChannelCommand.d.ts +110 -37
  130. package/dist-types/ts3.4/commands/UpdateSmsTemplateCommand.d.ts +104 -38
  131. package/dist-types/ts3.4/commands/UpdateTemplateActiveVersionCommand.d.ts +97 -41
  132. package/dist-types/ts3.4/commands/UpdateVoiceChannelCommand.d.ts +104 -38
  133. package/dist-types/ts3.4/commands/UpdateVoiceTemplateCommand.d.ts +105 -38
  134. package/dist-types/ts3.4/commands/VerifyOTPMessageCommand.d.ts +97 -37
  135. package/dist-types/ts3.4/commands/index.d.ts +122 -122
  136. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +20 -33
  137. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +5 -8
  138. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -2
  139. package/dist-types/ts3.4/index.d.ts +5 -5
  140. package/dist-types/ts3.4/models/PinpointServiceException.d.ts +12 -7
  141. package/dist-types/ts3.4/models/index.d.ts +2 -2
  142. package/dist-types/ts3.4/models/models_0.d.ts +6383 -1896
  143. package/dist-types/ts3.4/models/models_1.d.ts +2807 -915
  144. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +1100 -1469
  145. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +42 -91
  146. package/dist-types/ts3.4/runtimeConfig.d.ts +42 -91
  147. package/dist-types/ts3.4/runtimeConfig.native.d.ts +41 -80
  148. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +18 -18
  149. package/package.json +5 -4
@@ -1,38 +1,113 @@
1
- import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
- import { Command as $Command } from "@aws-sdk/smithy-client";
3
- import {
4
- Handler,
5
- HttpHandlerOptions as __HttpHandlerOptions,
6
- MetadataBearer as __MetadataBearer,
7
- MiddlewareStack,
8
- } from "@aws-sdk/types";
9
- import {
10
- UpdateEmailChannelRequest,
11
- UpdateEmailChannelResponse,
12
- } from "../models/models_1";
13
- import {
14
- PinpointClientResolvedConfig,
15
- ServiceInputTypes,
16
- ServiceOutputTypes,
17
- } from "../PinpointClient";
18
- export interface UpdateEmailChannelCommandInput
19
- extends UpdateEmailChannelRequest {}
20
- export interface UpdateEmailChannelCommandOutput
21
- extends UpdateEmailChannelResponse,
22
- __MetadataBearer {}
23
- export declare class UpdateEmailChannelCommand extends $Command<
24
- UpdateEmailChannelCommandInput,
25
- UpdateEmailChannelCommandOutput,
26
- PinpointClientResolvedConfig
27
- > {
28
- readonly input: UpdateEmailChannelCommandInput;
29
- static getEndpointParameterInstructions(): EndpointParameterInstructions;
30
- constructor(input: UpdateEmailChannelCommandInput);
31
- resolveMiddleware(
32
- clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
33
- configuration: PinpointClientResolvedConfig,
34
- options?: __HttpHandlerOptions
35
- ): Handler<UpdateEmailChannelCommandInput, UpdateEmailChannelCommandOutput>;
36
- private serialize;
37
- private deserialize;
38
- }
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { UpdateEmailChannelRequest, UpdateEmailChannelResponse } from "../models/models_1";
5
+ import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link UpdateEmailChannelCommand}.
10
+ */
11
+ export interface UpdateEmailChannelCommandInput extends UpdateEmailChannelRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link UpdateEmailChannelCommand}.
17
+ */
18
+ export interface UpdateEmailChannelCommandOutput extends UpdateEmailChannelResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Enables the email channel for an application or updates the status and settings of the email channel for an application.</p>
23
+ * @example
24
+ * Use a bare-bones client and the command you need to make an API call.
25
+ * ```javascript
26
+ * import { PinpointClient, UpdateEmailChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
+ * // const { PinpointClient, UpdateEmailChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
+ * const client = new PinpointClient(config);
29
+ * const input = { // UpdateEmailChannelRequest
30
+ * ApplicationId: "STRING_VALUE", // required
31
+ * EmailChannelRequest: { // EmailChannelRequest
32
+ * ConfigurationSet: "STRING_VALUE",
33
+ * Enabled: true || false,
34
+ * FromAddress: "STRING_VALUE", // required
35
+ * Identity: "STRING_VALUE", // required
36
+ * RoleArn: "STRING_VALUE",
37
+ * },
38
+ * };
39
+ * const command = new UpdateEmailChannelCommand(input);
40
+ * const response = await client.send(command);
41
+ * // { // UpdateEmailChannelResponse
42
+ * // EmailChannelResponse: { // EmailChannelResponse
43
+ * // ApplicationId: "STRING_VALUE",
44
+ * // ConfigurationSet: "STRING_VALUE",
45
+ * // CreationDate: "STRING_VALUE",
46
+ * // Enabled: true || false,
47
+ * // FromAddress: "STRING_VALUE",
48
+ * // HasCredential: true || false,
49
+ * // Id: "STRING_VALUE",
50
+ * // Identity: "STRING_VALUE",
51
+ * // IsArchived: true || false,
52
+ * // LastModifiedBy: "STRING_VALUE",
53
+ * // LastModifiedDate: "STRING_VALUE",
54
+ * // MessagesPerSecond: Number("int"),
55
+ * // Platform: "STRING_VALUE", // required
56
+ * // RoleArn: "STRING_VALUE",
57
+ * // Version: Number("int"),
58
+ * // },
59
+ * // };
60
+ *
61
+ * ```
62
+ *
63
+ * @param UpdateEmailChannelCommandInput - {@link UpdateEmailChannelCommandInput}
64
+ * @returns {@link UpdateEmailChannelCommandOutput}
65
+ * @see {@link UpdateEmailChannelCommandInput} for command's `input` shape.
66
+ * @see {@link UpdateEmailChannelCommandOutput} for command's `response` shape.
67
+ * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
68
+ *
69
+ * @throws {@link BadRequestException} (client fault)
70
+ * <p>Provides information about an API request or response.</p>
71
+ *
72
+ * @throws {@link ForbiddenException} (client fault)
73
+ * <p>Provides information about an API request or response.</p>
74
+ *
75
+ * @throws {@link InternalServerErrorException} (server fault)
76
+ * <p>Provides information about an API request or response.</p>
77
+ *
78
+ * @throws {@link MethodNotAllowedException} (client fault)
79
+ * <p>Provides information about an API request or response.</p>
80
+ *
81
+ * @throws {@link NotFoundException} (client fault)
82
+ * <p>Provides information about an API request or response.</p>
83
+ *
84
+ * @throws {@link PayloadTooLargeException} (client fault)
85
+ * <p>Provides information about an API request or response.</p>
86
+ *
87
+ * @throws {@link TooManyRequestsException} (client fault)
88
+ * <p>Provides information about an API request or response.</p>
89
+ *
90
+ * @throws {@link PinpointServiceException}
91
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
92
+ *
93
+ */
94
+ export declare class UpdateEmailChannelCommand extends $Command<UpdateEmailChannelCommandInput, UpdateEmailChannelCommandOutput, PinpointClientResolvedConfig> {
95
+ readonly input: UpdateEmailChannelCommandInput;
96
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
97
+ /**
98
+ * @public
99
+ */
100
+ constructor(input: UpdateEmailChannelCommandInput);
101
+ /**
102
+ * @internal
103
+ */
104
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateEmailChannelCommandInput, UpdateEmailChannelCommandOutput>;
105
+ /**
106
+ * @internal
107
+ */
108
+ private serialize;
109
+ /**
110
+ * @internal
111
+ */
112
+ private deserialize;
113
+ }
@@ -1,38 +1,106 @@
1
- import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
- import { Command as $Command } from "@aws-sdk/smithy-client";
3
- import {
4
- Handler,
5
- HttpHandlerOptions as __HttpHandlerOptions,
6
- MetadataBearer as __MetadataBearer,
7
- MiddlewareStack,
8
- } from "@aws-sdk/types";
9
- import {
10
- UpdateEmailTemplateRequest,
11
- UpdateEmailTemplateResponse,
12
- } from "../models/models_1";
13
- import {
14
- PinpointClientResolvedConfig,
15
- ServiceInputTypes,
16
- ServiceOutputTypes,
17
- } from "../PinpointClient";
18
- export interface UpdateEmailTemplateCommandInput
19
- extends UpdateEmailTemplateRequest {}
20
- export interface UpdateEmailTemplateCommandOutput
21
- extends UpdateEmailTemplateResponse,
22
- __MetadataBearer {}
23
- export declare class UpdateEmailTemplateCommand extends $Command<
24
- UpdateEmailTemplateCommandInput,
25
- UpdateEmailTemplateCommandOutput,
26
- PinpointClientResolvedConfig
27
- > {
28
- readonly input: UpdateEmailTemplateCommandInput;
29
- static getEndpointParameterInstructions(): EndpointParameterInstructions;
30
- constructor(input: UpdateEmailTemplateCommandInput);
31
- resolveMiddleware(
32
- clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
33
- configuration: PinpointClientResolvedConfig,
34
- options?: __HttpHandlerOptions
35
- ): Handler<UpdateEmailTemplateCommandInput, UpdateEmailTemplateCommandOutput>;
36
- private serialize;
37
- private deserialize;
38
- }
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { UpdateEmailTemplateRequest, UpdateEmailTemplateResponse } from "../models/models_1";
5
+ import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link UpdateEmailTemplateCommand}.
10
+ */
11
+ export interface UpdateEmailTemplateCommandInput extends UpdateEmailTemplateRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link UpdateEmailTemplateCommand}.
17
+ */
18
+ export interface UpdateEmailTemplateCommandOutput extends UpdateEmailTemplateResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Updates an existing message template for messages that are sent through the email channel.</p>
23
+ * @example
24
+ * Use a bare-bones client and the command you need to make an API call.
25
+ * ```javascript
26
+ * import { PinpointClient, UpdateEmailTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
+ * // const { PinpointClient, UpdateEmailTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
+ * const client = new PinpointClient(config);
29
+ * const input = { // UpdateEmailTemplateRequest
30
+ * CreateNewVersion: true || false,
31
+ * EmailTemplateRequest: { // EmailTemplateRequest
32
+ * DefaultSubstitutions: "STRING_VALUE",
33
+ * HtmlPart: "STRING_VALUE",
34
+ * RecommenderId: "STRING_VALUE",
35
+ * Subject: "STRING_VALUE",
36
+ * tags: { // MapOf__string
37
+ * "<keys>": "STRING_VALUE",
38
+ * },
39
+ * TemplateDescription: "STRING_VALUE",
40
+ * TextPart: "STRING_VALUE",
41
+ * },
42
+ * TemplateName: "STRING_VALUE", // required
43
+ * Version: "STRING_VALUE",
44
+ * };
45
+ * const command = new UpdateEmailTemplateCommand(input);
46
+ * const response = await client.send(command);
47
+ * // { // UpdateEmailTemplateResponse
48
+ * // MessageBody: { // MessageBody
49
+ * // Message: "STRING_VALUE",
50
+ * // RequestID: "STRING_VALUE",
51
+ * // },
52
+ * // };
53
+ *
54
+ * ```
55
+ *
56
+ * @param UpdateEmailTemplateCommandInput - {@link UpdateEmailTemplateCommandInput}
57
+ * @returns {@link UpdateEmailTemplateCommandOutput}
58
+ * @see {@link UpdateEmailTemplateCommandInput} for command's `input` shape.
59
+ * @see {@link UpdateEmailTemplateCommandOutput} for command's `response` shape.
60
+ * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
61
+ *
62
+ * @throws {@link BadRequestException} (client fault)
63
+ * <p>Provides information about an API request or response.</p>
64
+ *
65
+ * @throws {@link ForbiddenException} (client fault)
66
+ * <p>Provides information about an API request or response.</p>
67
+ *
68
+ * @throws {@link InternalServerErrorException} (server fault)
69
+ * <p>Provides information about an API request or response.</p>
70
+ *
71
+ * @throws {@link MethodNotAllowedException} (client fault)
72
+ * <p>Provides information about an API request or response.</p>
73
+ *
74
+ * @throws {@link NotFoundException} (client fault)
75
+ * <p>Provides information about an API request or response.</p>
76
+ *
77
+ * @throws {@link PayloadTooLargeException} (client fault)
78
+ * <p>Provides information about an API request or response.</p>
79
+ *
80
+ * @throws {@link TooManyRequestsException} (client fault)
81
+ * <p>Provides information about an API request or response.</p>
82
+ *
83
+ * @throws {@link PinpointServiceException}
84
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
85
+ *
86
+ */
87
+ export declare class UpdateEmailTemplateCommand extends $Command<UpdateEmailTemplateCommandInput, UpdateEmailTemplateCommandOutput, PinpointClientResolvedConfig> {
88
+ readonly input: UpdateEmailTemplateCommandInput;
89
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
90
+ /**
91
+ * @public
92
+ */
93
+ constructor(input: UpdateEmailTemplateCommandInput);
94
+ /**
95
+ * @internal
96
+ */
97
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateEmailTemplateCommandInput, UpdateEmailTemplateCommandOutput>;
98
+ /**
99
+ * @internal
100
+ */
101
+ private serialize;
102
+ /**
103
+ * @internal
104
+ */
105
+ private deserialize;
106
+ }
@@ -1,37 +1,136 @@
1
- import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
- import { Command as $Command } from "@aws-sdk/smithy-client";
3
- import {
4
- Handler,
5
- HttpHandlerOptions as __HttpHandlerOptions,
6
- MetadataBearer as __MetadataBearer,
7
- MiddlewareStack,
8
- } from "@aws-sdk/types";
9
- import {
10
- UpdateEndpointRequest,
11
- UpdateEndpointResponse,
12
- } from "../models/models_1";
13
- import {
14
- PinpointClientResolvedConfig,
15
- ServiceInputTypes,
16
- ServiceOutputTypes,
17
- } from "../PinpointClient";
18
- export interface UpdateEndpointCommandInput extends UpdateEndpointRequest {}
19
- export interface UpdateEndpointCommandOutput
20
- extends UpdateEndpointResponse,
21
- __MetadataBearer {}
22
- export declare class UpdateEndpointCommand extends $Command<
23
- UpdateEndpointCommandInput,
24
- UpdateEndpointCommandOutput,
25
- PinpointClientResolvedConfig
26
- > {
27
- readonly input: UpdateEndpointCommandInput;
28
- static getEndpointParameterInstructions(): EndpointParameterInstructions;
29
- constructor(input: UpdateEndpointCommandInput);
30
- resolveMiddleware(
31
- clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
32
- configuration: PinpointClientResolvedConfig,
33
- options?: __HttpHandlerOptions
34
- ): Handler<UpdateEndpointCommandInput, UpdateEndpointCommandOutput>;
35
- private serialize;
36
- private deserialize;
37
- }
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { UpdateEndpointRequest, UpdateEndpointResponse } from "../models/models_1";
5
+ import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link UpdateEndpointCommand}.
10
+ */
11
+ export interface UpdateEndpointCommandInput extends UpdateEndpointRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link UpdateEndpointCommand}.
17
+ */
18
+ export interface UpdateEndpointCommandOutput extends UpdateEndpointResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.</p>
23
+ * @example
24
+ * Use a bare-bones client and the command you need to make an API call.
25
+ * ```javascript
26
+ * import { PinpointClient, UpdateEndpointCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
+ * // const { PinpointClient, UpdateEndpointCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
+ * const client = new PinpointClient(config);
29
+ * const input = { // UpdateEndpointRequest
30
+ * ApplicationId: "STRING_VALUE", // required
31
+ * EndpointId: "STRING_VALUE", // required
32
+ * EndpointRequest: { // EndpointRequest
33
+ * Address: "STRING_VALUE",
34
+ * Attributes: { // MapOfListOf__string
35
+ * "<keys>": [ // ListOf__string
36
+ * "STRING_VALUE",
37
+ * ],
38
+ * },
39
+ * ChannelType: "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP",
40
+ * Demographic: { // EndpointDemographic
41
+ * AppVersion: "STRING_VALUE",
42
+ * Locale: "STRING_VALUE",
43
+ * Make: "STRING_VALUE",
44
+ * Model: "STRING_VALUE",
45
+ * ModelVersion: "STRING_VALUE",
46
+ * Platform: "STRING_VALUE",
47
+ * PlatformVersion: "STRING_VALUE",
48
+ * Timezone: "STRING_VALUE",
49
+ * },
50
+ * EffectiveDate: "STRING_VALUE",
51
+ * EndpointStatus: "STRING_VALUE",
52
+ * Location: { // EndpointLocation
53
+ * City: "STRING_VALUE",
54
+ * Country: "STRING_VALUE",
55
+ * Latitude: Number("double"),
56
+ * Longitude: Number("double"),
57
+ * PostalCode: "STRING_VALUE",
58
+ * Region: "STRING_VALUE",
59
+ * },
60
+ * Metrics: { // MapOf__double
61
+ * "<keys>": Number("double"),
62
+ * },
63
+ * OptOut: "STRING_VALUE",
64
+ * RequestId: "STRING_VALUE",
65
+ * User: { // EndpointUser
66
+ * UserAttributes: {
67
+ * "<keys>": [
68
+ * "STRING_VALUE",
69
+ * ],
70
+ * },
71
+ * UserId: "STRING_VALUE",
72
+ * },
73
+ * },
74
+ * };
75
+ * const command = new UpdateEndpointCommand(input);
76
+ * const response = await client.send(command);
77
+ * // { // UpdateEndpointResponse
78
+ * // MessageBody: { // MessageBody
79
+ * // Message: "STRING_VALUE",
80
+ * // RequestID: "STRING_VALUE",
81
+ * // },
82
+ * // };
83
+ *
84
+ * ```
85
+ *
86
+ * @param UpdateEndpointCommandInput - {@link UpdateEndpointCommandInput}
87
+ * @returns {@link UpdateEndpointCommandOutput}
88
+ * @see {@link UpdateEndpointCommandInput} for command's `input` shape.
89
+ * @see {@link UpdateEndpointCommandOutput} for command's `response` shape.
90
+ * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
91
+ *
92
+ * @throws {@link BadRequestException} (client fault)
93
+ * <p>Provides information about an API request or response.</p>
94
+ *
95
+ * @throws {@link ForbiddenException} (client fault)
96
+ * <p>Provides information about an API request or response.</p>
97
+ *
98
+ * @throws {@link InternalServerErrorException} (server fault)
99
+ * <p>Provides information about an API request or response.</p>
100
+ *
101
+ * @throws {@link MethodNotAllowedException} (client fault)
102
+ * <p>Provides information about an API request or response.</p>
103
+ *
104
+ * @throws {@link NotFoundException} (client fault)
105
+ * <p>Provides information about an API request or response.</p>
106
+ *
107
+ * @throws {@link PayloadTooLargeException} (client fault)
108
+ * <p>Provides information about an API request or response.</p>
109
+ *
110
+ * @throws {@link TooManyRequestsException} (client fault)
111
+ * <p>Provides information about an API request or response.</p>
112
+ *
113
+ * @throws {@link PinpointServiceException}
114
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
115
+ *
116
+ */
117
+ export declare class UpdateEndpointCommand extends $Command<UpdateEndpointCommandInput, UpdateEndpointCommandOutput, PinpointClientResolvedConfig> {
118
+ readonly input: UpdateEndpointCommandInput;
119
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
120
+ /**
121
+ * @public
122
+ */
123
+ constructor(input: UpdateEndpointCommandInput);
124
+ /**
125
+ * @internal
126
+ */
127
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateEndpointCommandInput, UpdateEndpointCommandOutput>;
128
+ /**
129
+ * @internal
130
+ */
131
+ private serialize;
132
+ /**
133
+ * @internal
134
+ */
135
+ private deserialize;
136
+ }
@@ -1,41 +1,140 @@
1
- import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
- import { Command as $Command } from "@aws-sdk/smithy-client";
3
- import {
4
- Handler,
5
- HttpHandlerOptions as __HttpHandlerOptions,
6
- MetadataBearer as __MetadataBearer,
7
- MiddlewareStack,
8
- } from "@aws-sdk/types";
9
- import {
10
- UpdateEndpointsBatchRequest,
11
- UpdateEndpointsBatchResponse,
12
- } from "../models/models_1";
13
- import {
14
- PinpointClientResolvedConfig,
15
- ServiceInputTypes,
16
- ServiceOutputTypes,
17
- } from "../PinpointClient";
18
- export interface UpdateEndpointsBatchCommandInput
19
- extends UpdateEndpointsBatchRequest {}
20
- export interface UpdateEndpointsBatchCommandOutput
21
- extends UpdateEndpointsBatchResponse,
22
- __MetadataBearer {}
23
- export declare class UpdateEndpointsBatchCommand extends $Command<
24
- UpdateEndpointsBatchCommandInput,
25
- UpdateEndpointsBatchCommandOutput,
26
- PinpointClientResolvedConfig
27
- > {
28
- readonly input: UpdateEndpointsBatchCommandInput;
29
- static getEndpointParameterInstructions(): EndpointParameterInstructions;
30
- constructor(input: UpdateEndpointsBatchCommandInput);
31
- resolveMiddleware(
32
- clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
33
- configuration: PinpointClientResolvedConfig,
34
- options?: __HttpHandlerOptions
35
- ): Handler<
36
- UpdateEndpointsBatchCommandInput,
37
- UpdateEndpointsBatchCommandOutput
38
- >;
39
- private serialize;
40
- private deserialize;
41
- }
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { UpdateEndpointsBatchRequest, UpdateEndpointsBatchResponse } from "../models/models_1";
5
+ import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link UpdateEndpointsBatchCommand}.
10
+ */
11
+ export interface UpdateEndpointsBatchCommandInput extends UpdateEndpointsBatchRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link UpdateEndpointsBatchCommand}.
17
+ */
18
+ export interface UpdateEndpointsBatchCommandOutput extends UpdateEndpointsBatchResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.</p>
23
+ * @example
24
+ * Use a bare-bones client and the command you need to make an API call.
25
+ * ```javascript
26
+ * import { PinpointClient, UpdateEndpointsBatchCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
27
+ * // const { PinpointClient, UpdateEndpointsBatchCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
28
+ * const client = new PinpointClient(config);
29
+ * const input = { // UpdateEndpointsBatchRequest
30
+ * ApplicationId: "STRING_VALUE", // required
31
+ * EndpointBatchRequest: { // EndpointBatchRequest
32
+ * Item: [ // ListOfEndpointBatchItem // required
33
+ * { // EndpointBatchItem
34
+ * Address: "STRING_VALUE",
35
+ * Attributes: { // MapOfListOf__string
36
+ * "<keys>": [ // ListOf__string
37
+ * "STRING_VALUE",
38
+ * ],
39
+ * },
40
+ * ChannelType: "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP",
41
+ * Demographic: { // EndpointDemographic
42
+ * AppVersion: "STRING_VALUE",
43
+ * Locale: "STRING_VALUE",
44
+ * Make: "STRING_VALUE",
45
+ * Model: "STRING_VALUE",
46
+ * ModelVersion: "STRING_VALUE",
47
+ * Platform: "STRING_VALUE",
48
+ * PlatformVersion: "STRING_VALUE",
49
+ * Timezone: "STRING_VALUE",
50
+ * },
51
+ * EffectiveDate: "STRING_VALUE",
52
+ * EndpointStatus: "STRING_VALUE",
53
+ * Id: "STRING_VALUE",
54
+ * Location: { // EndpointLocation
55
+ * City: "STRING_VALUE",
56
+ * Country: "STRING_VALUE",
57
+ * Latitude: Number("double"),
58
+ * Longitude: Number("double"),
59
+ * PostalCode: "STRING_VALUE",
60
+ * Region: "STRING_VALUE",
61
+ * },
62
+ * Metrics: { // MapOf__double
63
+ * "<keys>": Number("double"),
64
+ * },
65
+ * OptOut: "STRING_VALUE",
66
+ * RequestId: "STRING_VALUE",
67
+ * User: { // EndpointUser
68
+ * UserAttributes: {
69
+ * "<keys>": [
70
+ * "STRING_VALUE",
71
+ * ],
72
+ * },
73
+ * UserId: "STRING_VALUE",
74
+ * },
75
+ * },
76
+ * ],
77
+ * },
78
+ * };
79
+ * const command = new UpdateEndpointsBatchCommand(input);
80
+ * const response = await client.send(command);
81
+ * // { // UpdateEndpointsBatchResponse
82
+ * // MessageBody: { // MessageBody
83
+ * // Message: "STRING_VALUE",
84
+ * // RequestID: "STRING_VALUE",
85
+ * // },
86
+ * // };
87
+ *
88
+ * ```
89
+ *
90
+ * @param UpdateEndpointsBatchCommandInput - {@link UpdateEndpointsBatchCommandInput}
91
+ * @returns {@link UpdateEndpointsBatchCommandOutput}
92
+ * @see {@link UpdateEndpointsBatchCommandInput} for command's `input` shape.
93
+ * @see {@link UpdateEndpointsBatchCommandOutput} for command's `response` shape.
94
+ * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
95
+ *
96
+ * @throws {@link BadRequestException} (client fault)
97
+ * <p>Provides information about an API request or response.</p>
98
+ *
99
+ * @throws {@link ForbiddenException} (client fault)
100
+ * <p>Provides information about an API request or response.</p>
101
+ *
102
+ * @throws {@link InternalServerErrorException} (server fault)
103
+ * <p>Provides information about an API request or response.</p>
104
+ *
105
+ * @throws {@link MethodNotAllowedException} (client fault)
106
+ * <p>Provides information about an API request or response.</p>
107
+ *
108
+ * @throws {@link NotFoundException} (client fault)
109
+ * <p>Provides information about an API request or response.</p>
110
+ *
111
+ * @throws {@link PayloadTooLargeException} (client fault)
112
+ * <p>Provides information about an API request or response.</p>
113
+ *
114
+ * @throws {@link TooManyRequestsException} (client fault)
115
+ * <p>Provides information about an API request or response.</p>
116
+ *
117
+ * @throws {@link PinpointServiceException}
118
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
119
+ *
120
+ */
121
+ export declare class UpdateEndpointsBatchCommand extends $Command<UpdateEndpointsBatchCommandInput, UpdateEndpointsBatchCommandOutput, PinpointClientResolvedConfig> {
122
+ readonly input: UpdateEndpointsBatchCommandInput;
123
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
124
+ /**
125
+ * @public
126
+ */
127
+ constructor(input: UpdateEndpointsBatchCommandInput);
128
+ /**
129
+ * @internal
130
+ */
131
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateEndpointsBatchCommandInput, UpdateEndpointsBatchCommandOutput>;
132
+ /**
133
+ * @internal
134
+ */
135
+ private serialize;
136
+ /**
137
+ * @internal
138
+ */
139
+ private deserialize;
140
+ }