@aws-sdk/client-pinpoint 3.335.0 → 3.335.1

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

@@ -1,37 +1,106 @@
-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 {
-  UpdateGcmChannelRequest,
-  UpdateGcmChannelResponse,
-} from "../models/models_1";
-import {
-  PinpointClientResolvedConfig,
-  ServiceInputTypes,
-  ServiceOutputTypes,
-} from "../PinpointClient";
-export interface UpdateGcmChannelCommandInput extends UpdateGcmChannelRequest {}
-export interface UpdateGcmChannelCommandOutput
-  extends UpdateGcmChannelResponse,
-    __MetadataBearer {}
-export declare class UpdateGcmChannelCommand extends $Command<
-  UpdateGcmChannelCommandInput,
-  UpdateGcmChannelCommandOutput,
-  PinpointClientResolvedConfig
-> {
-  readonly input: UpdateGcmChannelCommandInput;
-  static getEndpointParameterInstructions(): EndpointParameterInstructions;
-  constructor(input: UpdateGcmChannelCommandInput);
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: PinpointClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<UpdateGcmChannelCommandInput, UpdateGcmChannelCommandOutput>;
-  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 { UpdateGcmChannelRequest, UpdateGcmChannelResponse } from "../models/models_1";
+import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
+/**
+ * @public
+ *
+ * The input for {@link UpdateGcmChannelCommand}.
+ */
+export interface UpdateGcmChannelCommandInput extends UpdateGcmChannelRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateGcmChannelCommand}.
+ */
+export interface UpdateGcmChannelCommandOutput extends UpdateGcmChannelResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PinpointClient, UpdateGcmChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
+ * // const { PinpointClient, UpdateGcmChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
+ * const client = new PinpointClient(config);
+ * const input = { // UpdateGcmChannelRequest
+ *   ApplicationId: "STRING_VALUE", // required
+ *   GCMChannelRequest: { // GCMChannelRequest
+ *     ApiKey: "STRING_VALUE", // required
+ *     Enabled: true || false,
+ *   },
+ * };
+ * const command = new UpdateGcmChannelCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateGcmChannelResponse
+ * //   GCMChannelResponse: { // GCMChannelResponse
+ * //     ApplicationId: "STRING_VALUE",
+ * //     CreationDate: "STRING_VALUE",
+ * //     Credential: "STRING_VALUE", // required
+ * //     Enabled: true || false,
+ * //     HasCredential: true || false,
+ * //     Id: "STRING_VALUE",
+ * //     IsArchived: true || false,
+ * //     LastModifiedBy: "STRING_VALUE",
+ * //     LastModifiedDate: "STRING_VALUE",
+ * //     Platform: "STRING_VALUE", // required
+ * //     Version: Number("int"),
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateGcmChannelCommandInput - {@link UpdateGcmChannelCommandInput}
+ * @returns {@link UpdateGcmChannelCommandOutput}
+ * @see {@link UpdateGcmChannelCommandInput} for command's `input` shape.
+ * @see {@link UpdateGcmChannelCommandOutput} 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 UpdateGcmChannelCommand extends $Command<UpdateGcmChannelCommandInput, UpdateGcmChannelCommandOutput, PinpointClientResolvedConfig> {
+    readonly input: UpdateGcmChannelCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateGcmChannelCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateGcmChannelCommandInput, UpdateGcmChannelCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -1,38 +1,162 @@
-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 {
-  UpdateInAppTemplateRequest,
-  UpdateInAppTemplateResponse,
-} from "../models/models_1";
-import {
-  PinpointClientResolvedConfig,
-  ServiceInputTypes,
-  ServiceOutputTypes,
-} from "../PinpointClient";
-export interface UpdateInAppTemplateCommandInput
-  extends UpdateInAppTemplateRequest {}
-export interface UpdateInAppTemplateCommandOutput
-  extends UpdateInAppTemplateResponse,
-    __MetadataBearer {}
-export declare class UpdateInAppTemplateCommand extends $Command<
-  UpdateInAppTemplateCommandInput,
-  UpdateInAppTemplateCommandOutput,
-  PinpointClientResolvedConfig
-> {
-  readonly input: UpdateInAppTemplateCommandInput;
-  static getEndpointParameterInstructions(): EndpointParameterInstructions;
-  constructor(input: UpdateInAppTemplateCommandInput);
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: PinpointClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<UpdateInAppTemplateCommandInput, UpdateInAppTemplateCommandOutput>;
-  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 { UpdateInAppTemplateRequest, UpdateInAppTemplateResponse } from "../models/models_1";
+import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
+/**
+ * @public
+ *
+ * The input for {@link UpdateInAppTemplateCommand}.
+ */
+export interface UpdateInAppTemplateCommandInput extends UpdateInAppTemplateRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateInAppTemplateCommand}.
+ */
+export interface UpdateInAppTemplateCommandOutput extends UpdateInAppTemplateResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Updates an existing message template for messages sent through the in-app message channel.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PinpointClient, UpdateInAppTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
+ * // const { PinpointClient, UpdateInAppTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
+ * const client = new PinpointClient(config);
+ * const input = { // UpdateInAppTemplateRequest
+ *   CreateNewVersion: true || false,
+ *   InAppTemplateRequest: { // InAppTemplateRequest
+ *     Content: [ // ListOfInAppMessageContent
+ *       { // InAppMessageContent
+ *         BackgroundColor: "STRING_VALUE",
+ *         BodyConfig: { // InAppMessageBodyConfig
+ *           Alignment: "LEFT" || "CENTER" || "RIGHT", // required
+ *           Body: "STRING_VALUE", // required
+ *           TextColor: "STRING_VALUE", // required
+ *         },
+ *         HeaderConfig: { // InAppMessageHeaderConfig
+ *           Alignment: "LEFT" || "CENTER" || "RIGHT", // required
+ *           Header: "STRING_VALUE", // required
+ *           TextColor: "STRING_VALUE", // required
+ *         },
+ *         ImageUrl: "STRING_VALUE",
+ *         PrimaryBtn: { // InAppMessageButton
+ *           Android: { // OverrideButtonConfiguration
+ *             ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
+ *             Link: "STRING_VALUE",
+ *           },
+ *           DefaultConfig: { // DefaultButtonConfiguration
+ *             BackgroundColor: "STRING_VALUE",
+ *             BorderRadius: Number("int"),
+ *             ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
+ *             Link: "STRING_VALUE",
+ *             Text: "STRING_VALUE", // required
+ *             TextColor: "STRING_VALUE",
+ *           },
+ *           IOS: {
+ *             ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
+ *             Link: "STRING_VALUE",
+ *           },
+ *           Web: {
+ *             ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
+ *             Link: "STRING_VALUE",
+ *           },
+ *         },
+ *         SecondaryBtn: {
+ *           Android: {
+ *             ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
+ *             Link: "STRING_VALUE",
+ *           },
+ *           DefaultConfig: {
+ *             BackgroundColor: "STRING_VALUE",
+ *             BorderRadius: Number("int"),
+ *             ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
+ *             Link: "STRING_VALUE",
+ *             Text: "STRING_VALUE", // required
+ *             TextColor: "STRING_VALUE",
+ *           },
+ *           IOS: {
+ *             ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
+ *             Link: "STRING_VALUE",
+ *           },
+ *           Web: "<OverrideButtonConfiguration>",
+ *         },
+ *       },
+ *     ],
+ *     CustomConfig: { // MapOf__string
+ *       "<keys>": "STRING_VALUE",
+ *     },
+ *     Layout: "BOTTOM_BANNER" || "TOP_BANNER" || "OVERLAYS" || "MOBILE_FEED" || "MIDDLE_BANNER" || "CAROUSEL",
+ *     tags: {
+ *       "<keys>": "STRING_VALUE",
+ *     },
+ *     TemplateDescription: "STRING_VALUE",
+ *   },
+ *   TemplateName: "STRING_VALUE", // required
+ *   Version: "STRING_VALUE",
+ * };
+ * const command = new UpdateInAppTemplateCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateInAppTemplateResponse
+ * //   MessageBody: { // MessageBody
+ * //     Message: "STRING_VALUE",
+ * //     RequestID: "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateInAppTemplateCommandInput - {@link UpdateInAppTemplateCommandInput}
+ * @returns {@link UpdateInAppTemplateCommandOutput}
+ * @see {@link UpdateInAppTemplateCommandInput} for command's `input` shape.
+ * @see {@link UpdateInAppTemplateCommandOutput} 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 UpdateInAppTemplateCommand extends $Command<UpdateInAppTemplateCommandInput, UpdateInAppTemplateCommandOutput, PinpointClientResolvedConfig> {
+    readonly input: UpdateInAppTemplateCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateInAppTemplateCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateInAppTemplateCommandInput, UpdateInAppTemplateCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}