@aws-sdk/client-socialmessaging 3.1060.0 → 3.1061.0

package/dist-types/commands/UpdateWhatsAppFlowAssetsCommand.d.ts

@@ -0,0 +1,105 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { UpdateWhatsAppFlowAssetsInput, UpdateWhatsAppFlowAssetsOutput } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, SocialMessagingClientResolvedConfig } from "../SocialMessagingClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateWhatsAppFlowAssetsCommand}.
+ */
+export interface UpdateWhatsAppFlowAssetsCommandInput extends UpdateWhatsAppFlowAssetsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateWhatsAppFlowAssetsCommand}.
+ */
+export interface UpdateWhatsAppFlowAssetsCommandOutput extends UpdateWhatsAppFlowAssetsOutput, __MetadataBearer {
+}
+declare const UpdateWhatsAppFlowAssetsCommand_base: {
+    new (input: UpdateWhatsAppFlowAssetsCommandInput): import("@smithy/core/client").CommandImpl<UpdateWhatsAppFlowAssetsCommandInput, UpdateWhatsAppFlowAssetsCommandOutput, SocialMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateWhatsAppFlowAssetsCommandInput): import("@smithy/core/client").CommandImpl<UpdateWhatsAppFlowAssetsCommandInput, UpdateWhatsAppFlowAssetsCommandOutput, SocialMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): {
+        [x: string]: unknown;
+    };
+};
+/**
+ * <p>Updates the Flow JSON definition (assets) of a WhatsApp Flow. Updating a published Flow's assets reverts it to DRAFT status, requiring re-publishing.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SocialMessagingClient, UpdateWhatsAppFlowAssetsCommand } from "@aws-sdk/client-socialmessaging"; // ES Modules import
+ * // const { SocialMessagingClient, UpdateWhatsAppFlowAssetsCommand } = require("@aws-sdk/client-socialmessaging"); // CommonJS import
+ * // import type { SocialMessagingClientConfig } from "@aws-sdk/client-socialmessaging";
+ * const config = {}; // type is SocialMessagingClientConfig
+ * const client = new SocialMessagingClient(config);
+ * const input = { // UpdateWhatsAppFlowAssetsInput
+ *   id: "STRING_VALUE", // required
+ *   flowId: "STRING_VALUE", // required
+ *   flowJson: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")   // required
+ * };
+ * const command = new UpdateWhatsAppFlowAssetsCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateWhatsAppFlowAssetsOutput
+ * //   validationErrors: [ // ValidationErrorList
+ * //     "STRING_VALUE",
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateWhatsAppFlowAssetsCommandInput - {@link UpdateWhatsAppFlowAssetsCommandInput}
+ * @returns {@link UpdateWhatsAppFlowAssetsCommandOutput}
+ * @see {@link UpdateWhatsAppFlowAssetsCommandInput} for command's `input` shape.
+ * @see {@link UpdateWhatsAppFlowAssetsCommandOutput} for command's `response` shape.
+ * @see {@link SocialMessagingClientResolvedConfig | config} for SocialMessagingClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedByMetaException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link DependencyException} (server fault)
+ *  <p>Thrown when performing an action because a dependency would be broken.</p>
+ *
+ * @throws {@link InternalServiceException} (server fault)
+ *  <p>The request processing has failed because of an unknown error, exception, or
+ *          failure.</p>
+ *
+ * @throws {@link InvalidParametersException} (client fault)
+ *  <p>One or more parameters provided to the action are not valid.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource was not found.</p>
+ *
+ * @throws {@link ThrottledRequestException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request contains an invalid parameter value. </p>
+ *
+ * @throws {@link SocialMessagingServiceException}
+ * <p>Base exception class for all service exceptions from SocialMessaging service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateWhatsAppFlowAssetsCommand extends UpdateWhatsAppFlowAssetsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateWhatsAppFlowAssetsInput;
+            output: UpdateWhatsAppFlowAssetsOutput;
+        };
+        sdk: {
+            input: UpdateWhatsAppFlowAssetsCommandInput;
+            output: UpdateWhatsAppFlowAssetsCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateWhatsAppFlowCommand.d.ts

@@ -0,0 +1,104 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { UpdateWhatsAppFlowInput, UpdateWhatsAppFlowOutput } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, SocialMessagingClientResolvedConfig } from "../SocialMessagingClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateWhatsAppFlowCommand}.
+ */
+export interface UpdateWhatsAppFlowCommandInput extends UpdateWhatsAppFlowInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateWhatsAppFlowCommand}.
+ */
+export interface UpdateWhatsAppFlowCommandOutput extends UpdateWhatsAppFlowOutput, __MetadataBearer {
+}
+declare const UpdateWhatsAppFlowCommand_base: {
+    new (input: UpdateWhatsAppFlowCommandInput): import("@smithy/core/client").CommandImpl<UpdateWhatsAppFlowCommandInput, UpdateWhatsAppFlowCommandOutput, SocialMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateWhatsAppFlowCommandInput): import("@smithy/core/client").CommandImpl<UpdateWhatsAppFlowCommandInput, UpdateWhatsAppFlowCommandOutput, SocialMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): {
+        [x: string]: unknown;
+    };
+};
+/**
+ * <p>Updates the metadata of a WhatsApp Flow, such as its name or categories. This does not update the Flow JSON definition. Use <a href="https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_UpdateWhatsAppFlowAssets.html">UpdateWhatsAppFlowAssets</a> to update the Flow JSON.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SocialMessagingClient, UpdateWhatsAppFlowCommand } from "@aws-sdk/client-socialmessaging"; // ES Modules import
+ * // const { SocialMessagingClient, UpdateWhatsAppFlowCommand } = require("@aws-sdk/client-socialmessaging"); // CommonJS import
+ * // import type { SocialMessagingClientConfig } from "@aws-sdk/client-socialmessaging";
+ * const config = {}; // type is SocialMessagingClientConfig
+ * const client = new SocialMessagingClient(config);
+ * const input = { // UpdateWhatsAppFlowInput
+ *   id: "STRING_VALUE", // required
+ *   flowId: "STRING_VALUE", // required
+ *   flowName: "STRING_VALUE",
+ *   categories: [ // MetaFlowCategoryList
+ *     "SIGN_UP" || "SIGN_IN" || "APPOINTMENT_BOOKING" || "LEAD_GENERATION" || "SHOPPING" || "CONTACT_US" || "CUSTOMER_SUPPORT" || "SURVEY" || "OTHER",
+ *   ],
+ * };
+ * const command = new UpdateWhatsAppFlowCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UpdateWhatsAppFlowCommandInput - {@link UpdateWhatsAppFlowCommandInput}
+ * @returns {@link UpdateWhatsAppFlowCommandOutput}
+ * @see {@link UpdateWhatsAppFlowCommandInput} for command's `input` shape.
+ * @see {@link UpdateWhatsAppFlowCommandOutput} for command's `response` shape.
+ * @see {@link SocialMessagingClientResolvedConfig | config} for SocialMessagingClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedByMetaException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link DependencyException} (server fault)
+ *  <p>Thrown when performing an action because a dependency would be broken.</p>
+ *
+ * @throws {@link InternalServiceException} (server fault)
+ *  <p>The request processing has failed because of an unknown error, exception, or
+ *          failure.</p>
+ *
+ * @throws {@link InvalidParametersException} (client fault)
+ *  <p>One or more parameters provided to the action are not valid.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource was not found.</p>
+ *
+ * @throws {@link ThrottledRequestException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request contains an invalid parameter value. </p>
+ *
+ * @throws {@link SocialMessagingServiceException}
+ * <p>Base exception class for all service exceptions from SocialMessaging service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateWhatsAppFlowCommand extends UpdateWhatsAppFlowCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateWhatsAppFlowInput;
+            output: {};
+        };
+        sdk: {
+            input: UpdateWhatsAppFlowCommandInput;
+            output: UpdateWhatsAppFlowCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateWhatsAppMessageTemplateCommand.d.ts

@@ -60,6 +60,9 @@ declare const UpdateWhatsAppMessageTemplateCommand_base: {
  * @see {@link UpdateWhatsAppMessageTemplateCommandOutput} for command's `response` shape.
  * @see {@link SocialMessagingClientResolvedConfig | config} for SocialMessagingClient's `config` shape.
  *
+ * @throws {@link AccessDeniedByMetaException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
  * @throws {@link DependencyException} (server fault)
  *  <p>Thrown when performing an action because a dependency would be broken.</p>
  *

package/dist-types/commands/index.d.ts

@@ -1,21 +1,31 @@
 export * from "./AssociateWhatsAppBusinessAccountCommand";
+export * from "./CreateWhatsAppFlowCommand";
 export * from "./CreateWhatsAppMessageTemplateCommand";
 export * from "./CreateWhatsAppMessageTemplateFromLibraryCommand";
 export * from "./CreateWhatsAppMessageTemplateMediaCommand";
+export * from "./DeleteWhatsAppFlowCommand";
 export * from "./DeleteWhatsAppMessageMediaCommand";
 export * from "./DeleteWhatsAppMessageTemplateCommand";
+export * from "./DeprecateWhatsAppFlowCommand";
 export * from "./DisassociateWhatsAppBusinessAccountCommand";
 export * from "./GetLinkedWhatsAppBusinessAccountCommand";
 export * from "./GetLinkedWhatsAppBusinessAccountPhoneNumberCommand";
+export * from "./GetWhatsAppFlowCommand";
+export * from "./GetWhatsAppFlowPreviewCommand";
 export * from "./GetWhatsAppMessageMediaCommand";
 export * from "./GetWhatsAppMessageTemplateCommand";
 export * from "./ListLinkedWhatsAppBusinessAccountsCommand";
 export * from "./ListTagsForResourceCommand";
+export * from "./ListWhatsAppFlowAssetsCommand";
+export * from "./ListWhatsAppFlowsCommand";
 export * from "./ListWhatsAppMessageTemplatesCommand";
 export * from "./ListWhatsAppTemplateLibraryCommand";
 export * from "./PostWhatsAppMessageMediaCommand";
+export * from "./PublishWhatsAppFlowCommand";
 export * from "./PutWhatsAppBusinessAccountEventDestinationsCommand";
 export * from "./SendWhatsAppMessageCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
+export * from "./UpdateWhatsAppFlowAssetsCommand";
+export * from "./UpdateWhatsAppFlowCommand";
 export * from "./UpdateWhatsAppMessageTemplateCommand";

package/dist-types/models/enums.d.ts

@@ -10,3 +10,22 @@ export declare const RegistrationStatus: {
  * @public
  */
 export type RegistrationStatus = (typeof RegistrationStatus)[keyof typeof RegistrationStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const MetaFlowCategory: {
+    readonly APPOINTMENT_BOOKING: "APPOINTMENT_BOOKING";
+    readonly CONTACT_US: "CONTACT_US";
+    readonly CUSTOMER_SUPPORT: "CUSTOMER_SUPPORT";
+    readonly LEAD_GENERATION: "LEAD_GENERATION";
+    readonly OTHER: "OTHER";
+    readonly SHOPPING: "SHOPPING";
+    readonly SIGN_IN: "SIGN_IN";
+    readonly SIGN_UP: "SIGN_UP";
+    readonly SURVEY: "SURVEY";
+};
+/**
+ * @public
+ */
+export type MetaFlowCategory = (typeof MetaFlowCategory)[keyof typeof MetaFlowCategory];