@wildix/xbees-users-client 1.1.0 → 1.2.3

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

@@ -1,152 +0,0 @@
-import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
-import { QueryColleaguesInput, QueryColleaguesOutput } 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 QueryColleaguesCommand}.
- */
-export interface QueryColleaguesCommandInput extends QueryColleaguesInput {
-}
-/**
- * @public
- *
- * The output of {@link QueryColleaguesCommand}.
- */
-export interface QueryColleaguesCommandOutput extends QueryColleaguesOutput, __MetadataBearer {
-}
-declare const QueryColleaguesCommand_base: {
-    new (input: QueryColleaguesCommandInput): import("@smithy/smithy-client").CommandImpl<QueryColleaguesCommandInput, QueryColleaguesCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    new (...[input]: [] | [QueryColleaguesCommandInput]): import("@smithy/smithy-client").CommandImpl<QueryColleaguesCommandInput, QueryColleaguesCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
-};
-/**
- * Searches for colleagues using various filters and search criteria, with optional auto-invitation for new users.
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { UsersClient, QueryColleaguesCommand } from "@wildix/xbees-users-client"; // ES Modules import
- * // const { UsersClient, QueryColleaguesCommand } = require("@wildix/xbees-users-client"); // CommonJS import
- * const client = new UsersClient(config);
- * const input = { // QueryColleaguesInput
- *   company: "STRING_VALUE",
- *   query: { // QueryColleaguesParameters
- *     id: [ // ColleaguesFilterList
- *       "STRING_VALUE",
- *     ],
- *     extension: [
- *       "STRING_VALUE",
- *     ],
- *     officePhone: [
- *       "STRING_VALUE",
- *     ],
- *     mobilePhone: [
- *       "STRING_VALUE",
- *     ],
- *     name: [
- *       "STRING_VALUE",
- *     ],
- *     email: "<ColleaguesFilterList>",
- *     department: "<ColleaguesFilterList>",
- *     search: "STRING_VALUE",
- *     searchFields: [ // PbxColleaguesQueryFieldList
- *       "extension" || "officePhone" || "mobilePhone" || "name" || "email" || "role" || "groupDn" || "language" || "dialplan" || "faxDialplan" || "department" || "login" || "id" || "pbxDn" || "picture" || "sourceId" || "licenseType",
- *     ],
- *     searchStrategy: "contain" || "startsWith",
- *     sort: [
- *       "extension" || "officePhone" || "mobilePhone" || "name" || "email" || "role" || "groupDn" || "language" || "dialplan" || "faxDialplan" || "department" || "login" || "id" || "pbxDn" || "picture" || "sourceId" || "licenseType",
- *     ],
- *     start: Number("int"),
- *     count: Number("int"),
- *     dir: "asc" || "desc",
- *   },
- *   invite: true || false,
- * };
- * const command = new QueryColleaguesCommand(input);
- * const response = await client.send(command);
- * // { // QueryColleaguesOutput
- * //   colleagues: [ // QueryColleaguesOutputItemList // required
- * //     { // QueryColleaguesOutputItem
- * //       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",
- * //         pbxGroupId: "STRING_VALUE",
- * //         createdAt: "STRING_VALUE",
- * //         updatedAt: "STRING_VALUE",
- * //       },
- * //       colleague: { // PbxColleague
- * //         id: "STRING_VALUE", // required
- * //         name: "STRING_VALUE",
- * //         login: "STRING_VALUE",
- * //         extension: "STRING_VALUE", // required
- * //         officePhone: "STRING_VALUE",
- * //         mobilePhone: "STRING_VALUE",
- * //         faxNumber: "STRING_VALUE",
- * //         email: "STRING_VALUE",
- * //         pbxDn: "STRING_VALUE", // required
- * //         pbx: "STRING_VALUE", // required
- * //         role: "admin" || "user" || "fax" || "park_orbit" || "room", // required
- * //         groupName: "STRING_VALUE", // required
- * //         groupDn: "STRING_VALUE", // required
- * //         language: "STRING_VALUE", // required
- * //         dialplan: "STRING_VALUE", // required
- * //         faxDialplan: "STRING_VALUE", // required
- * //         department: "STRING_VALUE",
- * //         picture: "STRING_VALUE", // required
- * //         sourceId: "STRING_VALUE",
- * //         licenseType: "basic" || "essential" || "business" || "premium" || "wizyconf", // required
- * //         jid: "STRING_VALUE", // required
- * //       },
- * //     },
- * //   ],
- * // };
- *
- * ```
- *
- * @param QueryColleaguesCommandInput - {@link QueryColleaguesCommandInput}
- * @returns {@link QueryColleaguesCommandOutput}
- * @see {@link QueryColleaguesCommandInput} for command's `input` shape.
- * @see {@link QueryColleaguesCommandOutput} 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>
- *
- *
- * @public
- */
-export declare class QueryColleaguesCommand extends QueryColleaguesCommand_base {
-    /** @internal type navigation helper, not in runtime. */
-    protected static __types: {
-        api: {
-            input: QueryColleaguesInput;
-            output: QueryColleaguesOutput;
-        };
-        sdk: {
-            input: QueryColleaguesCommandInput;
-            output: QueryColleaguesCommandOutput;
-        };
-    };
-}

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

@@ -1,105 +0,0 @@
-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;
-};
-/**
- * Searches for a single user using a query with optional predicate validation.
- * @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",
- * //     pbxGroupId: "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>
- *
- *
- * @public
- */
-export declare class QueryUserCommand extends QueryUserCommand_base {
-    /** @internal type navigation helper, not in runtime. */
-    protected static __types: {
-        api: {
-            input: QueryUserInput;
-            output: QueryUserOutput;
-        };
-        sdk: {
-            input: QueryUserCommandInput;
-            output: QueryUserCommandOutput;
-        };
-    };
-}

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

@@ -1,105 +0,0 @@
-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;
-};
-/**
- * Searches for multiple users using queries with optional predicate validation.
- * @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",
- * //       pbxGroupId: "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>
- *
- *
- * @public
- */
-export declare class QueryUsersCommand extends QueryUsersCommand_base {
-    /** @internal type navigation helper, not in runtime. */
-    protected static __types: {
-        api: {
-            input: QueryUsersInput;
-            output: QueryUsersOutput;
-        };
-        sdk: {
-            input: QueryUsersCommandInput;
-            output: QueryUsersCommandOutput;
-        };
-    };
-}

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

@@ -1,75 +0,0 @@
-import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
-import { ToggleTranscriptionEmailNotificationsSubscriptionInput, ToggleTranscriptionEmailNotificationsSubscriptionOutput } 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 ToggleTranscriptionEmailNotificationsSubscriptionCommand}.
- */
-export interface ToggleTranscriptionEmailNotificationsSubscriptionCommandInput extends ToggleTranscriptionEmailNotificationsSubscriptionInput {
-}
-/**
- * @public
- *
- * The output of {@link ToggleTranscriptionEmailNotificationsSubscriptionCommand}.
- */
-export interface ToggleTranscriptionEmailNotificationsSubscriptionCommandOutput extends ToggleTranscriptionEmailNotificationsSubscriptionOutput, __MetadataBearer {
-}
-declare const ToggleTranscriptionEmailNotificationsSubscriptionCommand_base: {
-    new (input: ToggleTranscriptionEmailNotificationsSubscriptionCommandInput): import("@smithy/smithy-client").CommandImpl<ToggleTranscriptionEmailNotificationsSubscriptionCommandInput, ToggleTranscriptionEmailNotificationsSubscriptionCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    new (__0_0: ToggleTranscriptionEmailNotificationsSubscriptionCommandInput): import("@smithy/smithy-client").CommandImpl<ToggleTranscriptionEmailNotificationsSubscriptionCommandInput, ToggleTranscriptionEmailNotificationsSubscriptionCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
-};
-/**
- * Using unsubscribeToken from email you can Toggle transcription email notifications subscription
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { UsersClient, ToggleTranscriptionEmailNotificationsSubscriptionCommand } from "@wildix/xbees-users-client"; // ES Modules import
- * // const { UsersClient, ToggleTranscriptionEmailNotificationsSubscriptionCommand } = require("@wildix/xbees-users-client"); // CommonJS import
- * const client = new UsersClient(config);
- * const input = { // ToggleTranscriptionEmailNotificationsSubscriptionInput
- *   unsubscribeToken: "STRING_VALUE", // required
- *   subscribe: true || false, // required
- * };
- * const command = new ToggleTranscriptionEmailNotificationsSubscriptionCommand(input);
- * const response = await client.send(command);
- * // {};
- *
- * ```
- *
- * @param ToggleTranscriptionEmailNotificationsSubscriptionCommandInput - {@link ToggleTranscriptionEmailNotificationsSubscriptionCommandInput}
- * @returns {@link ToggleTranscriptionEmailNotificationsSubscriptionCommandOutput}
- * @see {@link ToggleTranscriptionEmailNotificationsSubscriptionCommandInput} for command's `input` shape.
- * @see {@link ToggleTranscriptionEmailNotificationsSubscriptionCommandOutput} 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>
- *
- *
- * @public
- */
-export declare class ToggleTranscriptionEmailNotificationsSubscriptionCommand extends ToggleTranscriptionEmailNotificationsSubscriptionCommand_base {
-    /** @internal type navigation helper, not in runtime. */
-    protected static __types: {
-        api: {
-            input: ToggleTranscriptionEmailNotificationsSubscriptionInput;
-            output: {};
-        };
-        sdk: {
-            input: ToggleTranscriptionEmailNotificationsSubscriptionCommandInput;
-            output: ToggleTranscriptionEmailNotificationsSubscriptionCommandOutput;
-        };
-    };
-}

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

@@ -1,75 +0,0 @@
-import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
-import { ToggleUnreadEmailNotificationsSubscriptionInput, ToggleUnreadEmailNotificationsSubscriptionOutput } 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 ToggleUnreadEmailNotificationsSubscriptionCommand}.
- */
-export interface ToggleUnreadEmailNotificationsSubscriptionCommandInput extends ToggleUnreadEmailNotificationsSubscriptionInput {
-}
-/**
- * @public
- *
- * The output of {@link ToggleUnreadEmailNotificationsSubscriptionCommand}.
- */
-export interface ToggleUnreadEmailNotificationsSubscriptionCommandOutput extends ToggleUnreadEmailNotificationsSubscriptionOutput, __MetadataBearer {
-}
-declare const ToggleUnreadEmailNotificationsSubscriptionCommand_base: {
-    new (input: ToggleUnreadEmailNotificationsSubscriptionCommandInput): import("@smithy/smithy-client").CommandImpl<ToggleUnreadEmailNotificationsSubscriptionCommandInput, ToggleUnreadEmailNotificationsSubscriptionCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    new (__0_0: ToggleUnreadEmailNotificationsSubscriptionCommandInput): import("@smithy/smithy-client").CommandImpl<ToggleUnreadEmailNotificationsSubscriptionCommandInput, ToggleUnreadEmailNotificationsSubscriptionCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
-};
-/**
- * Using unsubscribeToken from email you can Toggle unread messages email notifications subscription
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { UsersClient, ToggleUnreadEmailNotificationsSubscriptionCommand } from "@wildix/xbees-users-client"; // ES Modules import
- * // const { UsersClient, ToggleUnreadEmailNotificationsSubscriptionCommand } = require("@wildix/xbees-users-client"); // CommonJS import
- * const client = new UsersClient(config);
- * const input = { // ToggleUnreadEmailNotificationsSubscriptionInput
- *   unsubscribeToken: "STRING_VALUE", // required
- *   subscribe: true || false, // required
- * };
- * const command = new ToggleUnreadEmailNotificationsSubscriptionCommand(input);
- * const response = await client.send(command);
- * // {};
- *
- * ```
- *
- * @param ToggleUnreadEmailNotificationsSubscriptionCommandInput - {@link ToggleUnreadEmailNotificationsSubscriptionCommandInput}
- * @returns {@link ToggleUnreadEmailNotificationsSubscriptionCommandOutput}
- * @see {@link ToggleUnreadEmailNotificationsSubscriptionCommandInput} for command's `input` shape.
- * @see {@link ToggleUnreadEmailNotificationsSubscriptionCommandOutput} 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>
- *
- *
- * @public
- */
-export declare class ToggleUnreadEmailNotificationsSubscriptionCommand extends ToggleUnreadEmailNotificationsSubscriptionCommand_base {
-    /** @internal type navigation helper, not in runtime. */
-    protected static __types: {
-        api: {
-            input: ToggleUnreadEmailNotificationsSubscriptionInput;
-            output: {};
-        };
-        sdk: {
-            input: ToggleUnreadEmailNotificationsSubscriptionCommandInput;
-            output: ToggleUnreadEmailNotificationsSubscriptionCommandOutput;
-        };
-    };
-}