@aws-sdk/client-wickr 3.956.0

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

@@ -0,0 +1,211 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { GetSecurityGroupRequest, GetSecurityGroupResponse } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WickrClientResolvedConfig } from "../WickrClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetSecurityGroupCommand}.
+ */
+export interface GetSecurityGroupCommandInput extends GetSecurityGroupRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetSecurityGroupCommand}.
+ */
+export interface GetSecurityGroupCommandOutput extends GetSecurityGroupResponse, __MetadataBearer {
+}
+declare const GetSecurityGroupCommand_base: {
+    new (input: GetSecurityGroupCommandInput): import("@smithy/smithy-client").CommandImpl<GetSecurityGroupCommandInput, GetSecurityGroupCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: GetSecurityGroupCommandInput): import("@smithy/smithy-client").CommandImpl<GetSecurityGroupCommandInput, GetSecurityGroupCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Retrieves detailed information about a specific security group in a Wickr network, including its settings, member counts, and configuration.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WickrClient, GetSecurityGroupCommand } from "@aws-sdk/client-wickr"; // ES Modules import
+ * // const { WickrClient, GetSecurityGroupCommand } = 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 = { // GetSecurityGroupRequest
+ *   networkId: "STRING_VALUE", // required
+ *   groupId: "STRING_VALUE", // required
+ * };
+ * const command = new GetSecurityGroupCommand(input);
+ * const response = await client.send(command);
+ * // { // GetSecurityGroupResponse
+ * //   securityGroup: { // SecurityGroup
+ * //     activeMembers: Number("int"), // required
+ * //     botMembers: Number("int"), // required
+ * //     activeDirectoryGuid: "STRING_VALUE",
+ * //     id: "STRING_VALUE", // required
+ * //     isDefault: true || false, // required
+ * //     name: "STRING_VALUE", // required
+ * //     modified: Number("int"), // required
+ * //     securityGroupSettings: { // SecurityGroupSettings
+ * //       alwaysReauthenticate: true || false,
+ * //       atakPackageValues: [ // SecurityGroupStringList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       calling: { // CallingSettings
+ * //         canStart11Call: true || false,
+ * //         canVideoCall: true || false,
+ * //         forceTcpCall: true || false,
+ * //       },
+ * //       checkForUpdates: true || false,
+ * //       enableAtak: true || false,
+ * //       enableCrashReports: true || false,
+ * //       enableFileDownload: true || false,
+ * //       enableGuestFederation: true || false,
+ * //       enableNotificationPreview: true || false,
+ * //       enableOpenAccessOption: true || false,
+ * //       enableRestrictedGlobalFederation: true || false,
+ * //       filesEnabled: true || false,
+ * //       forceDeviceLockout: Number("int"),
+ * //       forceOpenAccess: true || false,
+ * //       forceReadReceipts: true || false,
+ * //       globalFederation: true || false,
+ * //       isAtoEnabled: true || false,
+ * //       isLinkPreviewEnabled: true || false,
+ * //       locationAllowMaps: true || false,
+ * //       locationEnabled: true || false,
+ * //       maxAutoDownloadSize: Number("long"),
+ * //       maxBor: Number("int"),
+ * //       maxTtl: Number("long"),
+ * //       messageForwardingEnabled: true || false,
+ * //       passwordRequirements: { // PasswordRequirements
+ * //         lowercase: Number("int"),
+ * //         minLength: Number("int"),
+ * //         numbers: Number("int"),
+ * //         symbols: Number("int"),
+ * //         uppercase: Number("int"),
+ * //       },
+ * //       presenceEnabled: true || false,
+ * //       quickResponses: [
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       showMasterRecoveryKey: true || false,
+ * //       shredder: { // ShredderSettings
+ * //         canProcessManually: true || false,
+ * //         intensity: Number("int"),
+ * //       },
+ * //       ssoMaxIdleMinutes: Number("int"),
+ * //       federationMode: Number("int"),
+ * //       lockoutThreshold: Number("int"),
+ * //       permittedNetworks: [ // PermittedNetworksList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       permittedWickrAwsNetworks: [ // WickrAwsNetworksList
+ * //         { // WickrAwsNetworks
+ * //           region: "STRING_VALUE", // required
+ * //           networkId: "STRING_VALUE", // required
+ * //         },
+ * //       ],
+ * //       permittedWickrEnterpriseNetworks: [ // PermittedWickrEnterpriseNetworksList
+ * //         { // PermittedWickrEnterpriseNetwork
+ * //           domain: "STRING_VALUE", // required
+ * //           networkId: "STRING_VALUE", // required
+ * //         },
+ * //       ],
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetSecurityGroupCommandInput - {@link GetSecurityGroupCommandInput}
+ * @returns {@link GetSecurityGroupCommandOutput}
+ * @see {@link GetSecurityGroupCommandInput} for command's `input` shape.
+ * @see {@link GetSecurityGroupCommandOutput} 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 Get security group successfully
+ * ```javascript
+ * //
+ * const input = {
+ *   groupId: "abc12345",
+ *   networkId: "12345678"
+ * };
+ * const command = new GetSecurityGroupCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   securityGroup: {
+ *     activeMembers: 50,
+ *     botMembers: 5,
+ *     id: "abc12345",
+ *     isDefault: true,
+ *     modified: 1638360000,
+ *     name: "default",
+ *     securityGroupSettings: {
+ *       federationMode: 1,
+ *       lockoutThreshold: 10
+ *     }
+ *   }
+ * }
+ * *\/
+ * ```
+ *
+ * @example Get security group - not found
+ * ```javascript
+ * //
+ * const input = {
+ *   groupId: "invalid99",
+ *   networkId: "12345678"
+ * };
+ * const command = new GetSecurityGroupCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class GetSecurityGroupCommand extends GetSecurityGroupCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetSecurityGroupRequest;
+            output: GetSecurityGroupResponse;
+        };
+        sdk: {
+            input: GetSecurityGroupCommandInput;
+            output: GetSecurityGroupCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,194 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { GetUserRequest, GetUserResponse } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WickrClientResolvedConfig } from "../WickrClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetUserCommand}.
+ */
+export interface GetUserCommandInput extends GetUserRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetUserCommand}.
+ */
+export interface GetUserCommandOutput extends GetUserResponse, __MetadataBearer {
+}
+declare const GetUserCommand_base: {
+    new (input: GetUserCommandInput): import("@smithy/smithy-client").CommandImpl<GetUserCommandInput, GetUserCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: GetUserCommandInput): import("@smithy/smithy-client").CommandImpl<GetUserCommandInput, GetUserCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Retrieves detailed information about a specific user in a Wickr network, including their profile, status, and activity history.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WickrClient, GetUserCommand } from "@aws-sdk/client-wickr"; // ES Modules import
+ * // const { WickrClient, GetUserCommand } = 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 = { // GetUserRequest
+ *   networkId: "STRING_VALUE", // required
+ *   userId: "STRING_VALUE", // required
+ *   startTime: new Date("TIMESTAMP"),
+ *   endTime: new Date("TIMESTAMP"),
+ * };
+ * const command = new GetUserCommand(input);
+ * const response = await client.send(command);
+ * // { // GetUserResponse
+ * //   userId: "STRING_VALUE", // required
+ * //   firstName: "STRING_VALUE",
+ * //   lastName: "STRING_VALUE",
+ * //   username: "STRING_VALUE",
+ * //   isAdmin: true || false,
+ * //   suspended: true || false,
+ * //   status: Number("int"),
+ * //   lastActivity: Number("int"),
+ * //   lastLogin: Number("int"),
+ * //   securityGroupIds: [ // SecurityGroupIdList
+ * //     "STRING_VALUE",
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param GetUserCommandInput - {@link GetUserCommandInput}
+ * @returns {@link GetUserCommandOutput}
+ * @see {@link GetUserCommandInput} for command's `input` shape.
+ * @see {@link GetUserCommandOutput} 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 Get user information
+ * ```javascript
+ * //
+ * const input = {
+ *   networkId: "12345678",
+ *   userId: "12345"
+ * };
+ * const command = new GetUserCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   firstName: "John",
+ *   isAdmin: false,
+ *   lastActivity: 1705500000,
+ *   lastLogin: 1705499000,
+ *   lastName: "Doe",
+ *   securityGroupIds: [
+ *     "BCTY8Qhe"
+ *   ],
+ *   status: 2,
+ *   suspended: false,
+ *   userId: "12345",
+ *   username: "john.doe@example.com"
+ * }
+ * *\/
+ * ```
+ *
+ * @example Get user info with activity time range
+ * ```javascript
+ * //
+ * const input = {
+ *   endTime: 1705500000,
+ *   networkId: "12345678",
+ *   startTime: 1704067200,
+ *   userId: "12345"
+ * };
+ * const command = new GetUserCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   firstName: "Jane",
+ *   isAdmin: true,
+ *   lastActivity: 1705400000,
+ *   lastLogin: 1705350000,
+ *   lastName: "Admin",
+ *   securityGroupIds: [
+ *     "BCTY8Qhe",
+ *     "ADMIN001"
+ *   ],
+ *   status: 2,
+ *   suspended: false,
+ *   userId: "12345",
+ *   username: "jane.admin@example.com"
+ * }
+ * *\/
+ * ```
+ *
+ * @example User not found error
+ * ```javascript
+ * //
+ * const input = {
+ *   networkId: "12345678",
+ *   userId: "99999"
+ * };
+ * const command = new GetUserCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
+ * ```
+ *
+ * @example Invalid userId error
+ * ```javascript
+ * //
+ * const input = {
+ *   networkId: "12345678",
+ *   userId: "99999"
+ * };
+ * const command = new GetUserCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class GetUserCommand extends GetUserCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetUserRequest;
+            output: GetUserResponse;
+        };
+        sdk: {
+            input: GetUserCommandInput;
+            output: GetUserCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,137 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { GetUsersCountRequest, GetUsersCountResponse } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WickrClientResolvedConfig } from "../WickrClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetUsersCountCommand}.
+ */
+export interface GetUsersCountCommandInput extends GetUsersCountRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetUsersCountCommand}.
+ */
+export interface GetUsersCountCommandOutput extends GetUsersCountResponse, __MetadataBearer {
+}
+declare const GetUsersCountCommand_base: {
+    new (input: GetUsersCountCommandInput): import("@smithy/smithy-client").CommandImpl<GetUsersCountCommandInput, GetUsersCountCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: GetUsersCountCommandInput): import("@smithy/smithy-client").CommandImpl<GetUsersCountCommandInput, GetUsersCountCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Retrieves the count of users in a Wickr network, categorized by their status (pending, active, rejected) and showing how many users can still be added.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WickrClient, GetUsersCountCommand } from "@aws-sdk/client-wickr"; // ES Modules import
+ * // const { WickrClient, GetUsersCountCommand } = 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 = { // GetUsersCountRequest
+ *   networkId: "STRING_VALUE", // required
+ * };
+ * const command = new GetUsersCountCommand(input);
+ * const response = await client.send(command);
+ * // { // GetUsersCountResponse
+ * //   pending: Number("int"), // required
+ * //   active: Number("int"), // required
+ * //   rejected: Number("int"), // required
+ * //   remaining: Number("int"), // required
+ * //   total: Number("int"), // required
+ * // };
+ *
+ * ```
+ *
+ * @param GetUsersCountCommandInput - {@link GetUsersCountCommandInput}
+ * @returns {@link GetUsersCountCommandOutput}
+ * @see {@link GetUsersCountCommandInput} for command's `input` shape.
+ * @see {@link GetUsersCountCommandOutput} 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 Get user counts for network
+ * ```javascript
+ * //
+ * const input = {
+ *   networkId: "12345678"
+ * };
+ * const command = new GetUsersCountCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   active: 25,
+ *   pending: 5,
+ *   rejected: 2,
+ *   remaining: 15,
+ *   total: 32
+ * }
+ * *\/
+ * ```
+ *
+ * @example Network with no users
+ * ```javascript
+ * //
+ * const input = {
+ *   networkId: "87654321"
+ * };
+ * const command = new GetUsersCountCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   active: 0,
+ *   pending: 0,
+ *   rejected: 0,
+ *   remaining: 50,
+ *   total: 0
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class GetUsersCountCommand extends GetUsersCountCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetUsersCountRequest;
+            output: GetUsersCountResponse;
+        };
+        sdk: {
+            input: GetUsersCountCommandInput;
+            output: GetUsersCountCommandOutput;
+        };
+    };
+}