@wildix/xbees-users-client 1.0.22 → 1.0.24

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

@@ -0,0 +1,120 @@
+import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
+import { GetUserPbxLinkDataInput, GetUserPbxLinkDataOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetUserPbxLinkDataCommand}.
+ */
+export interface GetUserPbxLinkDataCommandInput extends GetUserPbxLinkDataInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetUserPbxLinkDataCommand}.
+ */
+export interface GetUserPbxLinkDataCommandOutput extends GetUserPbxLinkDataOutput, __MetadataBearer {
+}
+declare const GetUserPbxLinkDataCommand_base: {
+    new (input: GetUserPbxLinkDataCommandInput): import("@smithy/smithy-client").CommandImpl<GetUserPbxLinkDataCommandInput, GetUserPbxLinkDataCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetUserPbxLinkDataCommandInput): import("@smithy/smithy-client").CommandImpl<GetUserPbxLinkDataCommandInput, GetUserPbxLinkDataCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * @public
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { UsersClient, GetUserPbxLinkDataCommand } from "@wildix/xbees-users-client"; // ES Modules import
+ * // const { UsersClient, GetUserPbxLinkDataCommand } = require("@wildix/xbees-users-client"); // CommonJS import
+ * const client = new UsersClient(config);
+ * const input = { // GetUserPbxLinkDataInput
+ *   id: "STRING_VALUE", // required
+ * };
+ * const command = new GetUserPbxLinkDataCommand(input);
+ * const response = await client.send(command);
+ * // { // GetUserPbxLinkDataOutput
+ * //   user: { // UserPbxLinkData
+ * //     id: "STRING_VALUE", // required
+ * //     company: "STRING_VALUE", // required
+ * //     companyName: "STRING_VALUE",
+ * //     domain: "STRING_VALUE", // required
+ * //     email: "STRING_VALUE",
+ * //     info: { // UserPersonalInfo
+ * //       dn: "STRING_VALUE", // required
+ * //       id: "STRING_VALUE", // required
+ * //       name: "STRING_VALUE", // required
+ * //       extension: "STRING_VALUE", // required
+ * //       officePhone: "STRING_VALUE",
+ * //       mobilePhone: "STRING_VALUE",
+ * //       faxNumber: "STRING_VALUE",
+ * //       email: "STRING_VALUE",
+ * //       role: "STRING_VALUE", // required
+ * //       language: "STRING_VALUE", // required
+ * //       dialplan: "STRING_VALUE", // required
+ * //       faxDialplan: "STRING_VALUE", // required
+ * //       departament: "STRING_VALUE",
+ * //       picture: "STRING_VALUE", // required
+ * //       groupDn: "STRING_VALUE", // required
+ * //       groupName: "STRING_VALUE", // required
+ * //       jid: "STRING_VALUE", // required
+ * //       licenseType: "basic" || "essential" || "business" || "premium" || "wizyconf", // required
+ * //       login: "STRING_VALUE",
+ * //       pbx: "STRING_VALUE",
+ * //       pbxDn: "STRING_VALUE", // required
+ * //       sourceId: "STRING_VALUE",
+ * //       sipPassword: "STRING_VALUE",
+ * //     },
+ * //     pbx: { // UserPbxInfo
+ * //       networkAddresses: [ // UserPbxInfoNetworkAddresses // required
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       ports: [ // UserPbxInfoPorts // required
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       externalLinePrefix: "STRING_VALUE",
+ * //       version: "STRING_VALUE", // required
+ * //       serial: "STRING_VALUE", // required
+ * //     },
+ * //     picture: "STRING_VALUE", // required
+ * //     pictureDeleted: true || false,
+ * //     port: "STRING_VALUE", // required
+ * //     serial: "STRING_VALUE", // required
+ * //     services: { // UserPbxServices
+ * //       xcaracal: true || false,
+ * //       wizyWebinar: true || false,
+ * //     },
+ * //     personalSettings: {},
+ * //     dialplanSettings: {},
+ * //     awsRegion: "STRING_VALUE",
+ * //     updatedAt: "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetUserPbxLinkDataCommandInput - {@link GetUserPbxLinkDataCommandInput}
+ * @returns {@link GetUserPbxLinkDataCommandOutput}
+ * @see {@link GetUserPbxLinkDataCommandInput} for command's `input` shape.
+ * @see {@link GetUserPbxLinkDataCommandOutput} for command's `response` shape.
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
+ *
+ * @throws {@link UserNotFoundException} (client fault)
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link UsersServiceException}
+ * <p>Base exception class for all service exceptions from Users service.</p>
+ *
+ */
+export declare class GetUserPbxLinkDataCommand extends GetUserPbxLinkDataCommand_base {
+}

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

@@ -0,0 +1,92 @@
+import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
+import { QueryUserInput, QueryUserOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link QueryUserCommand}.
+ */
+export interface QueryUserCommandInput extends QueryUserInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link QueryUserCommand}.
+ */
+export interface QueryUserCommandOutput extends QueryUserOutput, __MetadataBearer {
+}
+declare const QueryUserCommand_base: {
+    new (input: QueryUserCommandInput): import("@smithy/smithy-client").CommandImpl<QueryUserCommandInput, QueryUserCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: QueryUserCommandInput): import("@smithy/smithy-client").CommandImpl<QueryUserCommandInput, QueryUserCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * @public
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { UsersClient, QueryUserCommand } from "@wildix/xbees-users-client"; // ES Modules import
+ * // const { UsersClient, QueryUserCommand } = require("@wildix/xbees-users-client"); // CommonJS import
+ * const client = new UsersClient(config);
+ * const input = { // QueryUserInput
+ *   query: { // UserQuery Union: only one key present
+ *     id: "STRING_VALUE",
+ *     email: "STRING_VALUE",
+ *     phone: "STRING_VALUE",
+ *   },
+ *   predicate: { // UserQueryPredicate
+ *     license: "basic" || "essential" || "business" || "premium" || "wizyconf",
+ *   },
+ * };
+ * const command = new QueryUserCommand(input);
+ * const response = await client.send(command);
+ * // { // QueryUserOutput
+ * //   user: { // User
+ * //     id: "STRING_VALUE", // required
+ * //     name: "STRING_VALUE",
+ * //     email: "STRING_VALUE",
+ * //     phone: "STRING_VALUE",
+ * //     picture: "STRING_VALUE",
+ * //     locale: "STRING_VALUE",
+ * //     timeZone: "STRING_VALUE",
+ * //     company: "STRING_VALUE",
+ * //     bot: true || false,
+ * //     pbxDomain: "STRING_VALUE",
+ * //     pbxPort: "STRING_VALUE",
+ * //     pbxExtension: "STRING_VALUE",
+ * //     pbxSerial: "STRING_VALUE",
+ * //     pbxUserId: "STRING_VALUE",
+ * //     createdAt: "STRING_VALUE",
+ * //     updatedAt: "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param QueryUserCommandInput - {@link QueryUserCommandInput}
+ * @returns {@link QueryUserCommandOutput}
+ * @see {@link QueryUserCommandInput} for command's `input` shape.
+ * @see {@link QueryUserCommandOutput} for command's `response` shape.
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
+ *
+ * @throws {@link UserNotFoundException} (client fault)
+ *
+ * @throws {@link UserQueryPredicateNotMetException} (client fault)
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link UsersServiceException}
+ * <p>Base exception class for all service exceptions from Users service.</p>
+ *
+ */
+export declare class QueryUserCommand extends QueryUserCommand_base {
+}

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

@@ -0,0 +1,92 @@
+import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
+import { QueryUsersInput, QueryUsersOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link QueryUsersCommand}.
+ */
+export interface QueryUsersCommandInput extends QueryUsersInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link QueryUsersCommand}.
+ */
+export interface QueryUsersCommandOutput extends QueryUsersOutput, __MetadataBearer {
+}
+declare const QueryUsersCommand_base: {
+    new (input: QueryUsersCommandInput): import("@smithy/smithy-client").CommandImpl<QueryUsersCommandInput, QueryUsersCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: QueryUsersCommandInput): import("@smithy/smithy-client").CommandImpl<QueryUsersCommandInput, QueryUsersCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * @public
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { UsersClient, QueryUsersCommand } from "@wildix/xbees-users-client"; // ES Modules import
+ * // const { UsersClient, QueryUsersCommand } = require("@wildix/xbees-users-client"); // CommonJS import
+ * const client = new UsersClient(config);
+ * const input = { // QueryUsersInput
+ *   queries: [ // UsersQueryList // required
+ *     { // UserQuery Union: only one key present
+ *       id: "STRING_VALUE",
+ *       email: "STRING_VALUE",
+ *       phone: "STRING_VALUE",
+ *     },
+ *   ],
+ *   predicate: { // UserQueryPredicate
+ *     license: "basic" || "essential" || "business" || "premium" || "wizyconf",
+ *   },
+ * };
+ * const command = new QueryUsersCommand(input);
+ * const response = await client.send(command);
+ * // { // QueryUsersOutput
+ * //   users: [ // UsersList // required
+ * //     { // User
+ * //       id: "STRING_VALUE", // required
+ * //       name: "STRING_VALUE",
+ * //       email: "STRING_VALUE",
+ * //       phone: "STRING_VALUE",
+ * //       picture: "STRING_VALUE",
+ * //       locale: "STRING_VALUE",
+ * //       timeZone: "STRING_VALUE",
+ * //       company: "STRING_VALUE",
+ * //       bot: true || false,
+ * //       pbxDomain: "STRING_VALUE",
+ * //       pbxPort: "STRING_VALUE",
+ * //       pbxExtension: "STRING_VALUE",
+ * //       pbxSerial: "STRING_VALUE",
+ * //       pbxUserId: "STRING_VALUE",
+ * //       createdAt: "STRING_VALUE",
+ * //       updatedAt: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param QueryUsersCommandInput - {@link QueryUsersCommandInput}
+ * @returns {@link QueryUsersCommandOutput}
+ * @see {@link QueryUsersCommandInput} for command's `input` shape.
+ * @see {@link QueryUsersCommandOutput} for command's `response` shape.
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link UsersServiceException}
+ * <p>Base exception class for all service exceptions from Users service.</p>
+ *
+ */
+export declare class QueryUsersCommand extends QueryUsersCommand_base {
+}

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

@@ -1,5 +1,5 @@
+export * from "./BatchGetUsersCommand";
 export * from "./BatchGetUsersPbxLinkDataCommand";
-export * from "./BatchGetUsersStreamLinkDataCommand";
 export * from "./ChangeUserEmailCommand";
 export * from "./CreateBotCommand";
 export * from "./CreateBotApiKeyCommand";
@@ -7,9 +7,13 @@ export * from "./DeleteBotCommand";
 export * from "./DeleteBotApiKeyCommand";
 export * from "./GetBotCommand";
 export * from "./GetBotCallbackCommand";
+export * from "./GetUserCommand";
+export * from "./GetUserPbxLinkDataCommand";
 export * from "./GetUserPbxLinkSuggestionCommand";
 export * from "./ListBotApiKeysCommand";
 export * from "./ListBotsCommand";
+export * from "./QueryUserCommand";
+export * from "./QueryUsersCommand";
 export * from "./UpdateBotCommand";
 export * from "./UpdateBotCallbackCommand";
 export * from "./UploadPictureCommand";