@aws-sdk/client-pinpoint 3.335.0 → 3.335.1

package/dist-types/ts3.4/commands/SendMessagesCommand.d.ts

@@ -1,34 +1,313 @@
-import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
-import { Command as $Command } from "@aws-sdk/smithy-client";
-import {
-  Handler,
-  HttpHandlerOptions as __HttpHandlerOptions,
-  MetadataBearer as __MetadataBearer,
-  MiddlewareStack,
-} from "@aws-sdk/types";
-import { SendMessagesRequest, SendMessagesResponse } from "../models/models_1";
-import {
-  PinpointClientResolvedConfig,
-  ServiceInputTypes,
-  ServiceOutputTypes,
-} from "../PinpointClient";
-export interface SendMessagesCommandInput extends SendMessagesRequest {}
-export interface SendMessagesCommandOutput
-  extends SendMessagesResponse,
-    __MetadataBearer {}
-export declare class SendMessagesCommand extends $Command<
-  SendMessagesCommandInput,
-  SendMessagesCommandOutput,
-  PinpointClientResolvedConfig
-> {
-  readonly input: SendMessagesCommandInput;
-  static getEndpointParameterInstructions(): EndpointParameterInstructions;
-  constructor(input: SendMessagesCommandInput);
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: PinpointClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<SendMessagesCommandInput, SendMessagesCommandOutput>;
-  private serialize;
-  private deserialize;
-}
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { SendMessagesRequest, SendMessagesResponse } from "../models/models_1";
+import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
+/**
+ * @public
+ *
+ * The input for {@link SendMessagesCommand}.
+ */
+export interface SendMessagesCommandInput extends SendMessagesRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link SendMessagesCommand}.
+ */
+export interface SendMessagesCommandOutput extends SendMessagesResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Creates and sends a direct message.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PinpointClient, SendMessagesCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
+ * // const { PinpointClient, SendMessagesCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
+ * const client = new PinpointClient(config);
+ * const input = { // SendMessagesRequest
+ *   ApplicationId: "STRING_VALUE", // required
+ *   MessageRequest: { // MessageRequest
+ *     Addresses: { // MapOfAddressConfiguration
+ *       "<keys>": { // AddressConfiguration
+ *         BodyOverride: "STRING_VALUE",
+ *         ChannelType: "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP",
+ *         Context: { // MapOf__string
+ *           "<keys>": "STRING_VALUE",
+ *         },
+ *         RawContent: "STRING_VALUE",
+ *         Substitutions: { // MapOfListOf__string
+ *           "<keys>": [ // ListOf__string
+ *             "STRING_VALUE",
+ *           ],
+ *         },
+ *         TitleOverride: "STRING_VALUE",
+ *       },
+ *     },
+ *     Context: {
+ *       "<keys>": "STRING_VALUE",
+ *     },
+ *     Endpoints: { // MapOfEndpointSendConfiguration
+ *       "<keys>": { // EndpointSendConfiguration
+ *         BodyOverride: "STRING_VALUE",
+ *         Context: {
+ *           "<keys>": "STRING_VALUE",
+ *         },
+ *         RawContent: "STRING_VALUE",
+ *         Substitutions: {
+ *           "<keys>": [
+ *             "STRING_VALUE",
+ *           ],
+ *         },
+ *         TitleOverride: "STRING_VALUE",
+ *       },
+ *     },
+ *     MessageConfiguration: { // DirectMessageConfiguration
+ *       ADMMessage: { // ADMMessage
+ *         Action: "OPEN_APP" || "DEEP_LINK" || "URL",
+ *         Body: "STRING_VALUE",
+ *         ConsolidationKey: "STRING_VALUE",
+ *         Data: {
+ *           "<keys>": "STRING_VALUE",
+ *         },
+ *         ExpiresAfter: "STRING_VALUE",
+ *         IconReference: "STRING_VALUE",
+ *         ImageIconUrl: "STRING_VALUE",
+ *         ImageUrl: "STRING_VALUE",
+ *         MD5: "STRING_VALUE",
+ *         RawContent: "STRING_VALUE",
+ *         SilentPush: true || false,
+ *         SmallImageIconUrl: "STRING_VALUE",
+ *         Sound: "STRING_VALUE",
+ *         Substitutions: {
+ *           "<keys>": [
+ *             "STRING_VALUE",
+ *           ],
+ *         },
+ *         Title: "STRING_VALUE",
+ *         Url: "STRING_VALUE",
+ *       },
+ *       APNSMessage: { // APNSMessage
+ *         APNSPushType: "STRING_VALUE",
+ *         Action: "OPEN_APP" || "DEEP_LINK" || "URL",
+ *         Badge: Number("int"),
+ *         Body: "STRING_VALUE",
+ *         Category: "STRING_VALUE",
+ *         CollapseId: "STRING_VALUE",
+ *         Data: {
+ *           "<keys>": "STRING_VALUE",
+ *         },
+ *         MediaUrl: "STRING_VALUE",
+ *         PreferredAuthenticationMethod: "STRING_VALUE",
+ *         Priority: "STRING_VALUE",
+ *         RawContent: "STRING_VALUE",
+ *         SilentPush: true || false,
+ *         Sound: "STRING_VALUE",
+ *         Substitutions: {
+ *           "<keys>": [
+ *             "STRING_VALUE",
+ *           ],
+ *         },
+ *         ThreadId: "STRING_VALUE",
+ *         TimeToLive: Number("int"),
+ *         Title: "STRING_VALUE",
+ *         Url: "STRING_VALUE",
+ *       },
+ *       BaiduMessage: { // BaiduMessage
+ *         Action: "OPEN_APP" || "DEEP_LINK" || "URL",
+ *         Body: "STRING_VALUE",
+ *         Data: "<MapOf__string>",
+ *         IconReference: "STRING_VALUE",
+ *         ImageIconUrl: "STRING_VALUE",
+ *         ImageUrl: "STRING_VALUE",
+ *         RawContent: "STRING_VALUE",
+ *         SilentPush: true || false,
+ *         SmallImageIconUrl: "STRING_VALUE",
+ *         Sound: "STRING_VALUE",
+ *         Substitutions: {
+ *           "<keys>": [
+ *             "STRING_VALUE",
+ *           ],
+ *         },
+ *         TimeToLive: Number("int"),
+ *         Title: "STRING_VALUE",
+ *         Url: "STRING_VALUE",
+ *       },
+ *       DefaultMessage: { // DefaultMessage
+ *         Body: "STRING_VALUE",
+ *         Substitutions: "<MapOfListOf__string>",
+ *       },
+ *       DefaultPushNotificationMessage: { // DefaultPushNotificationMessage
+ *         Action: "OPEN_APP" || "DEEP_LINK" || "URL",
+ *         Body: "STRING_VALUE",
+ *         Data: "<MapOf__string>",
+ *         SilentPush: true || false,
+ *         Substitutions: "<MapOfListOf__string>",
+ *         Title: "STRING_VALUE",
+ *         Url: "STRING_VALUE",
+ *       },
+ *       EmailMessage: { // EmailMessage
+ *         Body: "STRING_VALUE",
+ *         FeedbackForwardingAddress: "STRING_VALUE",
+ *         FromAddress: "STRING_VALUE",
+ *         RawEmail: { // RawEmail
+ *           Data: "BLOB_VALUE",
+ *         },
+ *         ReplyToAddresses: "<ListOf__string>",
+ *         SimpleEmail: { // SimpleEmail
+ *           HtmlPart: { // SimpleEmailPart
+ *             Charset: "STRING_VALUE",
+ *             Data: "STRING_VALUE",
+ *           },
+ *           Subject: {
+ *             Charset: "STRING_VALUE",
+ *             Data: "STRING_VALUE",
+ *           },
+ *           TextPart: {
+ *             Charset: "STRING_VALUE",
+ *             Data: "STRING_VALUE",
+ *           },
+ *         },
+ *         Substitutions: "<MapOfListOf__string>",
+ *       },
+ *       GCMMessage: { // GCMMessage
+ *         Action: "OPEN_APP" || "DEEP_LINK" || "URL",
+ *         Body: "STRING_VALUE",
+ *         CollapseKey: "STRING_VALUE",
+ *         Data: "<MapOf__string>",
+ *         IconReference: "STRING_VALUE",
+ *         ImageIconUrl: "STRING_VALUE",
+ *         ImageUrl: "STRING_VALUE",
+ *         Priority: "STRING_VALUE",
+ *         RawContent: "STRING_VALUE",
+ *         RestrictedPackageName: "STRING_VALUE",
+ *         SilentPush: true || false,
+ *         SmallImageIconUrl: "STRING_VALUE",
+ *         Sound: "STRING_VALUE",
+ *         Substitutions: "<MapOfListOf__string>",
+ *         TimeToLive: Number("int"),
+ *         Title: "STRING_VALUE",
+ *         Url: "STRING_VALUE",
+ *       },
+ *       SMSMessage: { // SMSMessage
+ *         Body: "STRING_VALUE",
+ *         Keyword: "STRING_VALUE",
+ *         MediaUrl: "STRING_VALUE",
+ *         MessageType: "TRANSACTIONAL" || "PROMOTIONAL",
+ *         OriginationNumber: "STRING_VALUE",
+ *         SenderId: "STRING_VALUE",
+ *         Substitutions: "<MapOfListOf__string>",
+ *         EntityId: "STRING_VALUE",
+ *         TemplateId: "STRING_VALUE",
+ *       },
+ *       VoiceMessage: { // VoiceMessage
+ *         Body: "STRING_VALUE",
+ *         LanguageCode: "STRING_VALUE",
+ *         OriginationNumber: "STRING_VALUE",
+ *         Substitutions: "<MapOfListOf__string>",
+ *         VoiceId: "STRING_VALUE",
+ *       },
+ *     },
+ *     TemplateConfiguration: { // TemplateConfiguration
+ *       EmailTemplate: { // Template
+ *         Name: "STRING_VALUE",
+ *         Version: "STRING_VALUE",
+ *       },
+ *       PushTemplate: {
+ *         Name: "STRING_VALUE",
+ *         Version: "STRING_VALUE",
+ *       },
+ *       SMSTemplate: {
+ *         Name: "STRING_VALUE",
+ *         Version: "STRING_VALUE",
+ *       },
+ *       VoiceTemplate: {
+ *         Name: "STRING_VALUE",
+ *         Version: "STRING_VALUE",
+ *       },
+ *     },
+ *     TraceId: "STRING_VALUE",
+ *   },
+ * };
+ * const command = new SendMessagesCommand(input);
+ * const response = await client.send(command);
+ * // { // SendMessagesResponse
+ * //   MessageResponse: { // MessageResponse
+ * //     ApplicationId: "STRING_VALUE", // required
+ * //     EndpointResult: { // MapOfEndpointMessageResult
+ * //       "<keys>": { // EndpointMessageResult
+ * //         Address: "STRING_VALUE",
+ * //         DeliveryStatus: "SUCCESSFUL" || "THROTTLED" || "TEMPORARY_FAILURE" || "PERMANENT_FAILURE" || "UNKNOWN_FAILURE" || "OPT_OUT" || "DUPLICATE", // required
+ * //         MessageId: "STRING_VALUE",
+ * //         StatusCode: Number("int"), // required
+ * //         StatusMessage: "STRING_VALUE",
+ * //         UpdatedToken: "STRING_VALUE",
+ * //       },
+ * //     },
+ * //     RequestId: "STRING_VALUE",
+ * //     Result: { // MapOfMessageResult
+ * //       "<keys>": { // MessageResult
+ * //         DeliveryStatus: "SUCCESSFUL" || "THROTTLED" || "TEMPORARY_FAILURE" || "PERMANENT_FAILURE" || "UNKNOWN_FAILURE" || "OPT_OUT" || "DUPLICATE", // required
+ * //         MessageId: "STRING_VALUE",
+ * //         StatusCode: Number("int"), // required
+ * //         StatusMessage: "STRING_VALUE",
+ * //         UpdatedToken: "STRING_VALUE",
+ * //       },
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param SendMessagesCommandInput - {@link SendMessagesCommandInput}
+ * @returns {@link SendMessagesCommandOutput}
+ * @see {@link SendMessagesCommandInput} for command's `input` shape.
+ * @see {@link SendMessagesCommandOutput} for command's `response` shape.
+ * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>Provides information about an API request or response.</p>
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *  <p>Provides information about an API request or response.</p>
+ *
+ * @throws {@link InternalServerErrorException} (server fault)
+ *  <p>Provides information about an API request or response.</p>
+ *
+ * @throws {@link MethodNotAllowedException} (client fault)
+ *  <p>Provides information about an API request or response.</p>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>Provides information about an API request or response.</p>
+ *
+ * @throws {@link PayloadTooLargeException} (client fault)
+ *  <p>Provides information about an API request or response.</p>
+ *
+ * @throws {@link TooManyRequestsException} (client fault)
+ *  <p>Provides information about an API request or response.</p>
+ *
+ * @throws {@link PinpointServiceException}
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
+ *
+ */
+export declare class SendMessagesCommand extends $Command<SendMessagesCommandInput, SendMessagesCommandOutput, PinpointClientResolvedConfig> {
+    readonly input: SendMessagesCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: SendMessagesCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendMessagesCommandInput, SendMessagesCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/ts3.4/commands/SendOTPMessageCommand.d.ts

@@ -1,37 +1,125 @@
-import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
-import { Command as $Command } from "@aws-sdk/smithy-client";
-import {
-  Handler,
-  HttpHandlerOptions as __HttpHandlerOptions,
-  MetadataBearer as __MetadataBearer,
-  MiddlewareStack,
-} from "@aws-sdk/types";
-import {
-  SendOTPMessageRequest,
-  SendOTPMessageResponse,
-} from "../models/models_1";
-import {
-  PinpointClientResolvedConfig,
-  ServiceInputTypes,
-  ServiceOutputTypes,
-} from "../PinpointClient";
-export interface SendOTPMessageCommandInput extends SendOTPMessageRequest {}
-export interface SendOTPMessageCommandOutput
-  extends SendOTPMessageResponse,
-    __MetadataBearer {}
-export declare class SendOTPMessageCommand extends $Command<
-  SendOTPMessageCommandInput,
-  SendOTPMessageCommandOutput,
-  PinpointClientResolvedConfig
-> {
-  readonly input: SendOTPMessageCommandInput;
-  static getEndpointParameterInstructions(): EndpointParameterInstructions;
-  constructor(input: SendOTPMessageCommandInput);
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: PinpointClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<SendOTPMessageCommandInput, SendOTPMessageCommandOutput>;
-  private serialize;
-  private deserialize;
-}
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { SendOTPMessageRequest, SendOTPMessageResponse } from "../models/models_1";
+import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
+/**
+ * @public
+ *
+ * The input for {@link SendOTPMessageCommand}.
+ */
+export interface SendOTPMessageCommandInput extends SendOTPMessageRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link SendOTPMessageCommand}.
+ */
+export interface SendOTPMessageCommandOutput extends SendOTPMessageResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Send an OTP message</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PinpointClient, SendOTPMessageCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
+ * // const { PinpointClient, SendOTPMessageCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
+ * const client = new PinpointClient(config);
+ * const input = { // SendOTPMessageRequest
+ *   ApplicationId: "STRING_VALUE", // required
+ *   SendOTPMessageRequestParameters: { // SendOTPMessageRequestParameters
+ *     AllowedAttempts: Number("int"),
+ *     BrandName: "STRING_VALUE", // required
+ *     Channel: "STRING_VALUE", // required
+ *     CodeLength: Number("int"),
+ *     DestinationIdentity: "STRING_VALUE", // required
+ *     EntityId: "STRING_VALUE",
+ *     Language: "STRING_VALUE",
+ *     OriginationIdentity: "STRING_VALUE", // required
+ *     ReferenceId: "STRING_VALUE", // required
+ *     TemplateId: "STRING_VALUE",
+ *     ValidityPeriod: Number("int"),
+ *   },
+ * };
+ * const command = new SendOTPMessageCommand(input);
+ * const response = await client.send(command);
+ * // { // SendOTPMessageResponse
+ * //   MessageResponse: { // MessageResponse
+ * //     ApplicationId: "STRING_VALUE", // required
+ * //     EndpointResult: { // MapOfEndpointMessageResult
+ * //       "<keys>": { // EndpointMessageResult
+ * //         Address: "STRING_VALUE",
+ * //         DeliveryStatus: "SUCCESSFUL" || "THROTTLED" || "TEMPORARY_FAILURE" || "PERMANENT_FAILURE" || "UNKNOWN_FAILURE" || "OPT_OUT" || "DUPLICATE", // required
+ * //         MessageId: "STRING_VALUE",
+ * //         StatusCode: Number("int"), // required
+ * //         StatusMessage: "STRING_VALUE",
+ * //         UpdatedToken: "STRING_VALUE",
+ * //       },
+ * //     },
+ * //     RequestId: "STRING_VALUE",
+ * //     Result: { // MapOfMessageResult
+ * //       "<keys>": { // MessageResult
+ * //         DeliveryStatus: "SUCCESSFUL" || "THROTTLED" || "TEMPORARY_FAILURE" || "PERMANENT_FAILURE" || "UNKNOWN_FAILURE" || "OPT_OUT" || "DUPLICATE", // required
+ * //         MessageId: "STRING_VALUE",
+ * //         StatusCode: Number("int"), // required
+ * //         StatusMessage: "STRING_VALUE",
+ * //         UpdatedToken: "STRING_VALUE",
+ * //       },
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param SendOTPMessageCommandInput - {@link SendOTPMessageCommandInput}
+ * @returns {@link SendOTPMessageCommandOutput}
+ * @see {@link SendOTPMessageCommandInput} for command's `input` shape.
+ * @see {@link SendOTPMessageCommandOutput} for command's `response` shape.
+ * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>Provides information about an API request or response.</p>
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *  <p>Provides information about an API request or response.</p>
+ *
+ * @throws {@link InternalServerErrorException} (server fault)
+ *  <p>Provides information about an API request or response.</p>
+ *
+ * @throws {@link MethodNotAllowedException} (client fault)
+ *  <p>Provides information about an API request or response.</p>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>Provides information about an API request or response.</p>
+ *
+ * @throws {@link PayloadTooLargeException} (client fault)
+ *  <p>Provides information about an API request or response.</p>
+ *
+ * @throws {@link TooManyRequestsException} (client fault)
+ *  <p>Provides information about an API request or response.</p>
+ *
+ * @throws {@link PinpointServiceException}
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
+ *
+ */
+export declare class SendOTPMessageCommand extends $Command<SendOTPMessageCommandInput, SendOTPMessageCommandOutput, PinpointClientResolvedConfig> {
+    readonly input: SendOTPMessageCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: SendOTPMessageCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendOTPMessageCommandInput, SendOTPMessageCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}