@aws-sdk/client-wickr 3.956.0

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

@@ -0,0 +1,191 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { BatchReinviteUserRequest, BatchReinviteUserResponse } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WickrClientResolvedConfig } from "../WickrClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link BatchReinviteUserCommand}.
+ */
+export interface BatchReinviteUserCommandInput extends BatchReinviteUserRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link BatchReinviteUserCommand}.
+ */
+export interface BatchReinviteUserCommandOutput extends BatchReinviteUserResponse, __MetadataBearer {
+}
+declare const BatchReinviteUserCommand_base: {
+    new (input: BatchReinviteUserCommandInput): import("@smithy/smithy-client").CommandImpl<BatchReinviteUserCommandInput, BatchReinviteUserCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: BatchReinviteUserCommandInput): import("@smithy/smithy-client").CommandImpl<BatchReinviteUserCommandInput, BatchReinviteUserCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Resends invitation codes to multiple users who have pending invitations in a Wickr network. This operation is useful when users haven't accepted their initial invitations or when invitations have expired.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WickrClient, BatchReinviteUserCommand } from "@aws-sdk/client-wickr"; // ES Modules import
+ * // const { WickrClient, BatchReinviteUserCommand } = require("@aws-sdk/client-wickr"); // CommonJS import
+ * // import type { WickrClientConfig } from "@aws-sdk/client-wickr";
+ * const config = {}; // type is WickrClientConfig
+ * const client = new WickrClient(config);
+ * const input = { // BatchReinviteUserRequest
+ *   networkId: "STRING_VALUE", // required
+ *   userIds: [ // UserIds // required
+ *     "STRING_VALUE",
+ *   ],
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new BatchReinviteUserCommand(input);
+ * const response = await client.send(command);
+ * // { // BatchReinviteUserResponse
+ * //   message: "STRING_VALUE",
+ * //   successful: [ // BatchUserSuccessResponseItems
+ * //     { // BatchUserSuccessResponseItem
+ * //       userId: "STRING_VALUE", // required
+ * //     },
+ * //   ],
+ * //   failed: [ // BatchUserErrorResponseItems
+ * //     { // BatchUserErrorResponseItem
+ * //       field: "STRING_VALUE",
+ * //       reason: "STRING_VALUE",
+ * //       userId: "STRING_VALUE", // required
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param BatchReinviteUserCommandInput - {@link BatchReinviteUserCommandInput}
+ * @returns {@link BatchReinviteUserCommandOutput}
+ * @see {@link BatchReinviteUserCommandInput} for command's `input` shape.
+ * @see {@link BatchReinviteUserCommandOutput} for command's `response` shape.
+ * @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
+ *
+ * @throws {@link BadRequestError} (client fault)
+ *  <p>The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.</p>
+ *
+ * @throws {@link ForbiddenError} (client fault)
+ *  <p>Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.</p>
+ *
+ * @throws {@link InternalServerError} (server fault)
+ *  <p>An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.</p>
+ *
+ * @throws {@link RateLimitError} (client fault)
+ *  <p>The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.</p>
+ *
+ * @throws {@link ResourceNotFoundError} (client fault)
+ *  <p>The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.</p>
+ *
+ * @throws {@link UnauthorizedError} (client fault)
+ *  <p>The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.</p>
+ *
+ * @throws {@link ValidationError} (client fault)
+ *  <p>One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.</p>
+ *
+ * @throws {@link WickrServiceException}
+ * <p>Base exception class for all service exceptions from Wickr service.</p>
+ *
+ *
+ * @example Batch reinvite users successfully
+ * ```javascript
+ * //
+ * const input = {
+ *   networkId: "12345678",
+ *   userIds: [
+ *     "12345",
+ *     "67890"
+ *   ]
+ * };
+ * const command = new BatchReinviteUserCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   failed:   [],
+ *   successful: [
+ *     {
+ *       userId: "12345"
+ *     },
+ *     {
+ *       userId: "67890"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @example Batch reinvite users - partial success
+ * ```javascript
+ * //
+ * const input = {
+ *   networkId: "12345678",
+ *   userIds: [
+ *     "12345",
+ *     "99999"
+ *   ]
+ * };
+ * const command = new BatchReinviteUserCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   failed: [
+ *     {
+ *       reason: "user not found in current network",
+ *       userId: "99999"
+ *     }
+ *   ],
+ *   successful: [
+ *     {
+ *       userId: "12345"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @example Batch reinvite users - cannot reinvite
+ * ```javascript
+ * //
+ * const input = {
+ *   networkId: "12345678",
+ *   userIds: [
+ *     "54321"
+ *   ]
+ * };
+ * const command = new BatchReinviteUserCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   failed: [
+ *     {
+ *       reason: "user cannot be reinvited",
+ *       userId: "54321"
+ *     }
+ *   ],
+ *   successful:   []
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class BatchReinviteUserCommand extends BatchReinviteUserCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: BatchReinviteUserRequest;
+            output: BatchReinviteUserResponse;
+        };
+        sdk: {
+            input: BatchReinviteUserCommandInput;
+            output: BatchReinviteUserCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,190 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { BatchResetDevicesForUserRequest, BatchResetDevicesForUserResponse } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WickrClientResolvedConfig } from "../WickrClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link BatchResetDevicesForUserCommand}.
+ */
+export interface BatchResetDevicesForUserCommandInput extends BatchResetDevicesForUserRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link BatchResetDevicesForUserCommand}.
+ */
+export interface BatchResetDevicesForUserCommandOutput extends BatchResetDevicesForUserResponse, __MetadataBearer {
+}
+declare const BatchResetDevicesForUserCommand_base: {
+    new (input: BatchResetDevicesForUserCommandInput): import("@smithy/smithy-client").CommandImpl<BatchResetDevicesForUserCommandInput, BatchResetDevicesForUserCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: BatchResetDevicesForUserCommandInput): import("@smithy/smithy-client").CommandImpl<BatchResetDevicesForUserCommandInput, BatchResetDevicesForUserCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Resets multiple devices for a specific user in a Wickr network. This operation forces the selected devices to log out and requires users to re-authenticate, which is useful for security purposes or when devices need to be revoked.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WickrClient, BatchResetDevicesForUserCommand } from "@aws-sdk/client-wickr"; // ES Modules import
+ * // const { WickrClient, BatchResetDevicesForUserCommand } = require("@aws-sdk/client-wickr"); // CommonJS import
+ * // import type { WickrClientConfig } from "@aws-sdk/client-wickr";
+ * const config = {}; // type is WickrClientConfig
+ * const client = new WickrClient(config);
+ * const input = { // BatchResetDevicesForUserRequest
+ *   networkId: "STRING_VALUE", // required
+ *   userId: "STRING_VALUE", // required
+ *   appIds: [ // AppIds // required
+ *     "STRING_VALUE",
+ *   ],
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new BatchResetDevicesForUserCommand(input);
+ * const response = await client.send(command);
+ * // { // BatchResetDevicesForUserResponse
+ * //   message: "STRING_VALUE",
+ * //   successful: [ // BatchDeviceSuccessResponseItems
+ * //     { // BatchDeviceSuccessResponseItem
+ * //       appId: "STRING_VALUE", // required
+ * //     },
+ * //   ],
+ * //   failed: [ // BatchDeviceErrorResponseItems
+ * //     { // BatchDeviceErrorResponseItem
+ * //       field: "STRING_VALUE",
+ * //       reason: "STRING_VALUE",
+ * //       appId: "STRING_VALUE", // required
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param BatchResetDevicesForUserCommandInput - {@link BatchResetDevicesForUserCommandInput}
+ * @returns {@link BatchResetDevicesForUserCommandOutput}
+ * @see {@link BatchResetDevicesForUserCommandInput} for command's `input` shape.
+ * @see {@link BatchResetDevicesForUserCommandOutput} for command's `response` shape.
+ * @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
+ *
+ * @throws {@link BadRequestError} (client fault)
+ *  <p>The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.</p>
+ *
+ * @throws {@link ForbiddenError} (client fault)
+ *  <p>Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.</p>
+ *
+ * @throws {@link InternalServerError} (server fault)
+ *  <p>An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.</p>
+ *
+ * @throws {@link RateLimitError} (client fault)
+ *  <p>The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.</p>
+ *
+ * @throws {@link ResourceNotFoundError} (client fault)
+ *  <p>The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.</p>
+ *
+ * @throws {@link UnauthorizedError} (client fault)
+ *  <p>The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.</p>
+ *
+ * @throws {@link ValidationError} (client fault)
+ *  <p>One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.</p>
+ *
+ * @throws {@link WickrServiceException}
+ * <p>Base exception class for all service exceptions from Wickr service.</p>
+ *
+ *
+ * @example Successful device reset
+ * ```javascript
+ * //
+ * const input = {
+ *   appIds: [
+ *     "d3135a42dcb6437780b16c3ca9581fe64e6822773cd6b965d25fc9929c89aca6",
+ *     "e4246b53edc7548891c27d4da0692fe75f7933884de7c076e36gca030d90bdb7"
+ *   ],
+ *   networkId: "12345678",
+ *   userId: "12345"
+ * };
+ * const command = new BatchResetDevicesForUserCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   failed:   [],
+ *   message: "success",
+ *   successful: [
+ *     {
+ *       appId: "d3135a42dcb6437780b16c3ca9581fe64e6822773cd6b965d25fc9929c89aca6"
+ *     },
+ *     {
+ *       appId: "e4246b53edc7548891c27d4da0692fe75f7933884de7c076e36gca030d90bdb7"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @example Partial failure device reset
+ * ```javascript
+ * //
+ * const input = {
+ *   appIds: [
+ *     "d3135a42dcb6437780b16c3ca9581fe64e6822773cd6b965d25fc9929c89aca6",
+ *     "invalid-app-id"
+ *   ],
+ *   networkId: "12345678",
+ *   userId: "12345"
+ * };
+ * const command = new BatchResetDevicesForUserCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   failed: [
+ *     {
+ *       appId: "invalid-app-id",
+ *       field: "appId",
+ *       reason: "Invalid app ID."
+ *     }
+ *   ],
+ *   message: "partial success",
+ *   successful: [
+ *     {
+ *       appId: "d3135a42dcb6437780b16c3ca9581fe64e6822773cd6b965d25fc9929c89aca6"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @example Invalid network ID error
+ * ```javascript
+ * //
+ * const input = {
+ *   appIds: [
+ *     "d3135a42dcb6437780b16c3ca9581fe64e6822773cd6b965d25fc9929c89aca6"
+ *   ],
+ *   networkId: "00000000",
+ *   userId: "12345"
+ * };
+ * const command = new BatchResetDevicesForUserCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class BatchResetDevicesForUserCommand extends BatchResetDevicesForUserCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: BatchResetDevicesForUserRequest;
+            output: BatchResetDevicesForUserResponse;
+        };
+        sdk: {
+            input: BatchResetDevicesForUserCommandInput;
+            output: BatchResetDevicesForUserCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,174 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { BatchToggleUserSuspendStatusRequest, BatchToggleUserSuspendStatusResponse } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WickrClientResolvedConfig } from "../WickrClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link BatchToggleUserSuspendStatusCommand}.
+ */
+export interface BatchToggleUserSuspendStatusCommandInput extends BatchToggleUserSuspendStatusRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link BatchToggleUserSuspendStatusCommand}.
+ */
+export interface BatchToggleUserSuspendStatusCommandOutput extends BatchToggleUserSuspendStatusResponse, __MetadataBearer {
+}
+declare const BatchToggleUserSuspendStatusCommand_base: {
+    new (input: BatchToggleUserSuspendStatusCommandInput): import("@smithy/smithy-client").CommandImpl<BatchToggleUserSuspendStatusCommandInput, BatchToggleUserSuspendStatusCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: BatchToggleUserSuspendStatusCommandInput): import("@smithy/smithy-client").CommandImpl<BatchToggleUserSuspendStatusCommandInput, BatchToggleUserSuspendStatusCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Suspends or unsuspends multiple users in a Wickr network. Suspended users cannot access the network until they are unsuspended. This operation is useful for temporarily restricting access without deleting user accounts.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WickrClient, BatchToggleUserSuspendStatusCommand } from "@aws-sdk/client-wickr"; // ES Modules import
+ * // const { WickrClient, BatchToggleUserSuspendStatusCommand } = require("@aws-sdk/client-wickr"); // CommonJS import
+ * // import type { WickrClientConfig } from "@aws-sdk/client-wickr";
+ * const config = {}; // type is WickrClientConfig
+ * const client = new WickrClient(config);
+ * const input = { // BatchToggleUserSuspendStatusRequest
+ *   networkId: "STRING_VALUE", // required
+ *   suspend: true || false, // required
+ *   userIds: [ // UserIds // required
+ *     "STRING_VALUE",
+ *   ],
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new BatchToggleUserSuspendStatusCommand(input);
+ * const response = await client.send(command);
+ * // { // BatchToggleUserSuspendStatusResponse
+ * //   message: "STRING_VALUE",
+ * //   successful: [ // BatchUserSuccessResponseItems
+ * //     { // BatchUserSuccessResponseItem
+ * //       userId: "STRING_VALUE", // required
+ * //     },
+ * //   ],
+ * //   failed: [ // BatchUserErrorResponseItems
+ * //     { // BatchUserErrorResponseItem
+ * //       field: "STRING_VALUE",
+ * //       reason: "STRING_VALUE",
+ * //       userId: "STRING_VALUE", // required
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param BatchToggleUserSuspendStatusCommandInput - {@link BatchToggleUserSuspendStatusCommandInput}
+ * @returns {@link BatchToggleUserSuspendStatusCommandOutput}
+ * @see {@link BatchToggleUserSuspendStatusCommandInput} for command's `input` shape.
+ * @see {@link BatchToggleUserSuspendStatusCommandOutput} for command's `response` shape.
+ * @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
+ *
+ * @throws {@link BadRequestError} (client fault)
+ *  <p>The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.</p>
+ *
+ * @throws {@link ForbiddenError} (client fault)
+ *  <p>Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.</p>
+ *
+ * @throws {@link InternalServerError} (server fault)
+ *  <p>An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.</p>
+ *
+ * @throws {@link RateLimitError} (client fault)
+ *  <p>The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.</p>
+ *
+ * @throws {@link ResourceNotFoundError} (client fault)
+ *  <p>The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.</p>
+ *
+ * @throws {@link UnauthorizedError} (client fault)
+ *  <p>The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.</p>
+ *
+ * @throws {@link ValidationError} (client fault)
+ *  <p>One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.</p>
+ *
+ * @throws {@link WickrServiceException}
+ * <p>Base exception class for all service exceptions from Wickr service.</p>
+ *
+ *
+ * @example Suspend multiple users
+ * ```javascript
+ * //
+ * const input = {
+ *   clientToken: "6ba7b815-9dad-11d1-80b4-00c04fd430c8",
+ *   networkId: "12345678",
+ *   suspend: true,
+ *   userIds: [
+ *     "123",
+ *     "456"
+ *   ]
+ * };
+ * const command = new BatchToggleUserSuspendStatusCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   failed:   [],
+ *   message: "success",
+ *   successful: [
+ *     {
+ *       userId: "123"
+ *     },
+ *     {
+ *       userId: "456"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @example Unsuspend users with partial failure
+ * ```javascript
+ * //
+ * const input = {
+ *   networkId: "12345678",
+ *   suspend: false,
+ *   userIds: [
+ *     "123",
+ *     "456"
+ *   ]
+ * };
+ * const command = new BatchToggleUserSuspendStatusCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   failed: [
+ *     {
+ *       field: "username",
+ *       reason: "User not found",
+ *       userId: "456"
+ *     }
+ *   ],
+ *   message: "partial success",
+ *   successful: [
+ *     {
+ *       userId: "123"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class BatchToggleUserSuspendStatusCommand extends BatchToggleUserSuspendStatusCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: BatchToggleUserSuspendStatusRequest;
+            output: BatchToggleUserSuspendStatusResponse;
+        };
+        sdk: {
+            input: BatchToggleUserSuspendStatusCommandInput;
+            output: BatchToggleUserSuspendStatusCommandOutput;
+        };
+    };
+}