@aws-sdk/client-socialmessaging 3.1133.0 → 3.1135.0

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

@@ -0,0 +1,115 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { GetWhatsAppCallPermissionInput, GetWhatsAppCallPermissionOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link GetWhatsAppCallPermissionCommand}.
+ */
+export interface GetWhatsAppCallPermissionCommandInput extends GetWhatsAppCallPermissionInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetWhatsAppCallPermissionCommand}.
+ */
+export interface GetWhatsAppCallPermissionCommandOutput extends GetWhatsAppCallPermissionOutput, __MetadataBearer {
+}
+declare const GetWhatsAppCallPermissionCommand_base: {
+    new (input: GetWhatsAppCallPermissionCommandInput): import("@smithy/core/client").CommandImpl<GetWhatsAppCallPermissionCommandInput, GetWhatsAppCallPermissionCommandOutput, import("..").SocialMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: GetWhatsAppCallPermissionCommandInput): import("@smithy/core/client").CommandImpl<GetWhatsAppCallPermissionCommandInput, GetWhatsAppCallPermissionCommandOutput, import("..").SocialMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Retrieves the current calling permission for a WhatsApp end user, along with the calling actions the business is allowed to take with that user. Provide the destination phone number or the business-scoped user ID to identify the end user.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SocialMessagingClient, GetWhatsAppCallPermissionCommand } from "@aws-sdk/client-socialmessaging"; // ES Modules import
+ * // const { SocialMessagingClient, GetWhatsAppCallPermissionCommand } = 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 = { // GetWhatsAppCallPermissionInput
+ *   originationPhoneNumberId: "STRING_VALUE", // required
+ *   destinationPhoneNumber: "STRING_VALUE",
+ *   endUserBsuid: "STRING_VALUE",
+ * };
+ * const command = new GetWhatsAppCallPermissionCommand(input);
+ * const response = await client.send(command);
+ * // { // GetWhatsAppCallPermissionOutput
+ * //   permission: { // WhatsAppCallPermission
+ * //     status: "STRING_VALUE", // required
+ * //     expirationTime: new Date("TIMESTAMP"),
+ * //   },
+ * //   actions: [ // WhatsAppCallPermissionActionList // required
+ * //     { // WhatsAppCallPermissionAction
+ * //       actionName: "STRING_VALUE", // required
+ * //       canPerformAction: true || false, // required
+ * //       limits: [ // WhatsAppCallPermissionLimitList // required
+ * //         { // WhatsAppCallPermissionLimit
+ * //           timePeriod: "STRING_VALUE", // required
+ * //           maxAllowed: Number("int"), // required
+ * //           currentUsage: Number("int"), // required
+ * //           limitExpirationTime: new Date("TIMESTAMP"),
+ * //         },
+ * //       ],
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param GetWhatsAppCallPermissionCommandInput - {@link GetWhatsAppCallPermissionCommandInput}
+ * @returns {@link GetWhatsAppCallPermissionCommandOutput}
+ * @see {@link GetWhatsAppCallPermissionCommandInput} for command's `input` shape.
+ * @see {@link GetWhatsAppCallPermissionCommandOutput} 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 GetWhatsAppCallPermissionCommand extends GetWhatsAppCallPermissionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetWhatsAppCallPermissionInput;
+            output: GetWhatsAppCallPermissionOutput;
+        };
+        sdk: {
+            input: GetWhatsAppCallPermissionCommandInput;
+            output: GetWhatsAppCallPermissionCommandOutput;
+        };
+    };
+}

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

@@ -24,7 +24,7 @@ declare const PutWhatsAppBusinessPublicKeyCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
- * Sets the business public key used to encrypt the data exchanged with the endpoint of a data exchange Flow.
+ * <p>Sets the business public key used to encrypt the data exchanged with the endpoint of a data exchange Flow.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -0,0 +1,101 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { SendWhatsAppCallEventInput, SendWhatsAppCallEventOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link SendWhatsAppCallEventCommand}.
+ */
+export interface SendWhatsAppCallEventCommandInput extends SendWhatsAppCallEventInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link SendWhatsAppCallEventCommand}.
+ */
+export interface SendWhatsAppCallEventCommandOutput extends SendWhatsAppCallEventOutput, __MetadataBearer {
+}
+declare const SendWhatsAppCallEventCommand_base: {
+    new (input: SendWhatsAppCallEventCommandInput): import("@smithy/core/client").CommandImpl<SendWhatsAppCallEventCommandInput, SendWhatsAppCallEventCommandOutput, import("..").SocialMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: SendWhatsAppCallEventCommandInput): import("@smithy/core/client").CommandImpl<SendWhatsAppCallEventCommandInput, SendWhatsAppCallEventCommandOutput, import("..").SocialMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Sends a WhatsApp calling event, such as connecting or terminating a call, for a business phone number. This operation passes the event through to Meta. To use this operation, the origination phone number must belong to a WhatsApp Business Account that is linked to your Amazon Web Services account.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SocialMessagingClient, SendWhatsAppCallEventCommand } from "@aws-sdk/client-socialmessaging"; // ES Modules import
+ * // const { SocialMessagingClient, SendWhatsAppCallEventCommand } = 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 = { // SendWhatsAppCallEventInput
+ *   originationPhoneNumberId: "STRING_VALUE", // required
+ *   metaApiVersion: "STRING_VALUE", // required
+ *   callEvent: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")   // required
+ * };
+ * const command = new SendWhatsAppCallEventCommand(input);
+ * const response = await client.send(command);
+ * // { // SendWhatsAppCallEventOutput
+ * //   callId: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param SendWhatsAppCallEventCommandInput - {@link SendWhatsAppCallEventCommandInput}
+ * @returns {@link SendWhatsAppCallEventCommandOutput}
+ * @see {@link SendWhatsAppCallEventCommandInput} for command's `input` shape.
+ * @see {@link SendWhatsAppCallEventCommandOutput} 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 ConflictException} (client fault)
+ *  <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.</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 SendWhatsAppCallEventCommand extends SendWhatsAppCallEventCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: SendWhatsAppCallEventInput;
+            output: SendWhatsAppCallEventOutput;
+        };
+        sdk: {
+            input: SendWhatsAppCallEventCommandInput;
+            output: SendWhatsAppCallEventCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,131 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { UpdateLinkedWhatsAppBusinessAccountPhoneNumberInput, UpdateLinkedWhatsAppBusinessAccountPhoneNumberOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommand}.
+ */
+export interface UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommandInput extends UpdateLinkedWhatsAppBusinessAccountPhoneNumberInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommand}.
+ */
+export interface UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommandOutput extends UpdateLinkedWhatsAppBusinessAccountPhoneNumberOutput, __MetadataBearer {
+}
+declare const UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommand_base: {
+    new (input: UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommandInput): import("@smithy/core/client").CommandImpl<UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommandInput, UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommandOutput, import("..").SocialMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommandInput): import("@smithy/core/client").CommandImpl<UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommandInput, UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommandOutput, import("..").SocialMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates the calling settings for a linked WhatsApp business phone number, such as whether calling is enabled and the hours during which the business accepts calls.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SocialMessagingClient, UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommand } from "@aws-sdk/client-socialmessaging"; // ES Modules import
+ * // const { SocialMessagingClient, UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommand } = 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 = { // UpdateLinkedWhatsAppBusinessAccountPhoneNumberInput
+ *   id: "STRING_VALUE", // required
+ *   callSettings: { // WhatsAppCallSettings
+ *     callEnabled: true || false, // required
+ *     callHours: { // WhatsAppCallHours
+ *       enabled: true || false, // required
+ *       timezone: "STRING_VALUE", // required
+ *       weeklyOperatingHours: [ // WhatsAppWeeklyOperatingHoursList // required
+ *         { // WhatsAppWeeklyOperatingHoursEntry
+ *           dayOfWeek: "MONDAY" || "TUESDAY" || "WEDNESDAY" || "THURSDAY" || "FRIDAY" || "SATURDAY" || "SUNDAY", // required
+ *           openTime: { // WhatsAppTimeOfDay
+ *             hours: Number("int"), // required
+ *             minutes: Number("int"), // required
+ *           },
+ *           closeTime: {
+ *             hours: Number("int"), // required
+ *             minutes: Number("int"), // required
+ *           },
+ *         },
+ *       ],
+ *       holidaySchedule: [ // WhatsAppHolidayScheduleList
+ *         { // WhatsAppHolidayScheduleEntry
+ *           date: "STRING_VALUE", // required
+ *           startTime: {
+ *             hours: Number("int"), // required
+ *             minutes: Number("int"), // required
+ *           },
+ *           endTime: {
+ *             hours: Number("int"), // required
+ *             minutes: Number("int"), // required
+ *           },
+ *         },
+ *       ],
+ *     },
+ *     callIconVisibility: "STRING_VALUE",
+ *     callbackPermissionStatus: "STRING_VALUE",
+ *   },
+ * };
+ * const command = new UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateLinkedWhatsAppBusinessAccountPhoneNumberOutput
+ * //   phoneNumberId: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommandInput - {@link UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommandInput}
+ * @returns {@link UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommandOutput}
+ * @see {@link UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommandInput} for command's `input` shape.
+ * @see {@link UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommandOutput} 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 UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommand extends UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateLinkedWhatsAppBusinessAccountPhoneNumberInput;
+            output: UpdateLinkedWhatsAppBusinessAccountPhoneNumberOutput;
+        };
+        sdk: {
+            input: UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommandInput;
+            output: UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommandOutput;
+        };
+    };
+}

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

@@ -12,6 +12,7 @@ export * from "./DisassociateWhatsAppBusinessAccountCommand";
 export * from "./GetLinkedWhatsAppBusinessAccountCommand";
 export * from "./GetLinkedWhatsAppBusinessAccountPhoneNumberCommand";
 export * from "./GetWhatsAppBusinessPublicKeyCommand";
+export * from "./GetWhatsAppCallPermissionCommand";
 export * from "./GetWhatsAppFlowCommand";
 export * from "./GetWhatsAppFlowPreviewCommand";
 export * from "./GetWhatsAppMessageMediaCommand";
@@ -26,10 +27,12 @@ export * from "./PostWhatsAppMessageMediaCommand";
 export * from "./PublishWhatsAppFlowCommand";
 export * from "./PutWhatsAppBusinessAccountEventDestinationsCommand";
 export * from "./PutWhatsAppBusinessPublicKeyCommand";
+export * from "./SendWhatsAppCallEventCommand";
 export * from "./SendWhatsAppConversionEventCommand";
 export * from "./SendWhatsAppMessageCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
+export * from "./UpdateLinkedWhatsAppBusinessAccountPhoneNumberCommand";
 export * from "./UpdateWhatsAppFlowAssetsCommand";
 export * from "./UpdateWhatsAppFlowCommand";
 export * from "./UpdateWhatsAppMessageTemplateCommand";

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

@@ -29,3 +29,20 @@ export declare const MetaFlowCategory: {
  * @public
  */
 export type MetaFlowCategory = (typeof MetaFlowCategory)[keyof typeof MetaFlowCategory];
+/**
+ * @public
+ * @enum
+ */
+export declare const WhatsAppDayOfWeek: {
+    readonly FRIDAY: "FRIDAY";
+    readonly MONDAY: "MONDAY";
+    readonly SATURDAY: "SATURDAY";
+    readonly SUNDAY: "SUNDAY";
+    readonly THURSDAY: "THURSDAY";
+    readonly TUESDAY: "TUESDAY";
+    readonly WEDNESDAY: "WEDNESDAY";
+};
+/**
+ * @public
+ */
+export type WhatsAppDayOfWeek = (typeof WhatsAppDayOfWeek)[keyof typeof WhatsAppDayOfWeek];

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

@@ -86,6 +86,18 @@ export declare class ValidationException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
+/**
+ * <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.</p>
+ * @public
+ */
+export declare class ConflictException extends __BaseException {
+    readonly name: "ConflictException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
+}
 /**
  * <p>The request processing has failed because of an unknown error, exception, or
  *          failure.</p>