@wildix/xbees-users-client 1.0.23 → 1.0.25

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

@@ -25,132 +25,408 @@ export declare class ForbiddenException extends __BaseException {
 }
 /**
  * @public
+ * @enum
  */
-export interface BatchGetUsersPbxLinkDataInput {
-    id: (string)[];
-}
+export declare const PbxLicenseType: {
+    readonly BASIC: "basic";
+    readonly BUSINESS: "business";
+    readonly ESSENTIAL: "essential";
+    readonly PREMIUM: "premium";
+    readonly WIZYCONF: "wizyconf";
+};
 /**
  * @public
  */
-export interface PbxLinkData {
+export type PbxLicenseType = typeof PbxLicenseType[keyof typeof PbxLicenseType];
+/**
+ * @public
+ */
+export interface User {
     id: string;
-    company: string;
-    domain?: string;
+    name?: string;
     email?: string;
+    phone?: string;
+    picture?: string;
+    locale?: string;
+    timeZone?: string;
+    company?: string;
+    bot?: boolean;
+    pbxDomain?: string;
+    pbxPort?: string;
+    pbxExtension?: string;
+    pbxSerial?: string;
+    pbxUserId?: string;
+    createdAt?: string;
+    updatedAt?: string;
 }
 /**
  * @public
  */
-export interface BatchGetUsersPbxLinkDataOutput {
-    users: (PbxLinkData)[];
+export interface BotDialogflowCxEndpoint {
+    /**
+     * Dialogflow Service Account Credentials
+     * @public
+     */
+    credentials: __DocumentType;
+    /**
+     * Dialogflow Agent Id (example - 88ff4635-0852-4f97-ae44-b19ae9fa6ea1
+     * @public
+     */
+    agent: string;
+    /**
+     * Dialogflow Agent Region (example: europe-west3)
+     * @public
+     */
+    location: string;
+    /**
+     * Language
+     * @public
+     */
+    language: string;
+}
+/**
+ * @public
+ */
+export interface BotOpenAiAssistantEndpoint {
+    key: string;
+    assistantId: string;
+}
+/**
+ * @public
+ */
+export interface BotSqsEndpoint {
+    url: string;
+    key: string;
+    secret: string;
+}
+/**
+ * @public
+ */
+export interface BotWebhookEndpoint {
+    url: string;
+    secret: string;
 }
 /**
  * @public
  */
-export interface BatchGetUsersStreamLinkDataInput {
+export interface BatchGetUsersInput {
     id: (string)[];
 }
 /**
  * @public
  */
-export interface StreamLinkData {
-    id: string;
-    email?: string;
-    phone?: string;
-    name?: string;
-    picture?: string;
-    company?: string;
-    pbxExtension?: string;
-    pbxSerial?: string;
-    pbxDomain?: string;
-    pbxPort?: string;
-    pbxUserId?: string;
-    pbxUpdatedAt?: string;
-    locale?: string;
-    timeZone?: string;
+export interface BatchGetUsersOutput {
+    /**
+     * A list of users that exist in the platform.
+     * @public
+     */
+    users: (User)[];
 }
 /**
  * @public
  */
-export interface BatchGetUsersStreamLinkDataOutput {
-    users: Record<string, StreamLinkData>;
+export interface BatchGetUsersPbxLinkDataInput {
+    id: (string)[];
 }
 /**
  * @public
  */
-export interface Bot {
-    id: string;
-    name: string;
-    picture?: string;
-    searchable?: boolean;
-    createdAt: string;
-    updated?: string;
+export interface UserPbxDialplanSettings {
 }
 /**
  * @public
  */
-export interface BotApiKey {
-    secret: string;
-    name?: string;
-    createdAt: string;
+export interface UserPersonalInfo {
+    /**
+     * Distinguished Name (DN) of the user in the directory (example: 'uid=9010198,o=com0,dc=wildix').
+     * @public
+     */
+    dn: string;
+    /**
+     * Unique identifier of the user (example: '9010198').
+     * @public
+     */
+    id: string;
+    /**
+     * Name of the user (example: 'John Doe').
+     * @public
+     */
+    name: string;
+    /**
+     * Extension number of the user (example: '111').
+     * @public
+     */
+    extension: string;
+    /**
+     * Office phone number of the user (example: '22222'). This field can be an empty string or undefined if not provided.
+     * @public
+     */
+    officePhone?: string;
+    /**
+     * Mobile phone number of the user (example: '22222'). This field can be an empty string or undefined if not provided.
+     * @public
+     */
+    mobilePhone?: string;
+    /**
+     * Fax number of the user (example: '22222'). This field can be an empty string or undefined if not provided.
+     * @public
+     */
+    faxNumber?: string;
+    /**
+     * Email address of the user (example: 'email@google.com'). This field can be an empty string or undefined if not provided.
+     * @public
+     */
+    email?: string;
+    /**
+     * Role of the user (example: 'admin').
+     * @public
+     */
+    role: string;
+    /**
+     * Language preference of the user (example: 'en').
+     * @public
+     */
+    language: string;
+    /**
+     * Dialplan associated with the user (example: 'users').
+     * @public
+     */
+    dialplan: string;
+    /**
+     * Fax dialplan associated with the user. Example: 'users'.
+     * @public
+     */
+    faxDialplan: string;
+    /**
+     * Department of the user (example: 'Sales'). This field can be an empty string or undefined if not provided.
+     * @public
+     */
+    departament?: string;
+    /**
+     * Public URL path of the user's picture (example: '/cticonnect/cticonnect_share/user_avatar_3688190.png?100&John Doe&98998generated').
+     * @public
+     */
+    picture: string;
+    /**
+     * Distinguished Name (DN) of the user's group in the directory. Example: 'gid=5194383,o=com0,dc=wildix'.
+     * @public
+     */
+    groupDn: string;
+    /**
+     * Name of the user's group.
+     * @public
+     */
+    groupName: string;
+    /**
+     * Jabber ID (JID) of the user. Example: '100@example.wildixin.com'.
+     * @public
+     */
+    jid: string;
+    /**
+     * Type of license assigned to the user.
+     * @public
+     */
+    licenseType: PbxLicenseType;
+    /**
+     * Login name of the user. This field can be an empty string or undefined if not provided.
+     * @public
+     */
+    login?: string;
+    /**
+     * PBX associated with the user. This field can be an empty string or undefined if not provided.
+     * @public
+     */
+    pbx?: string;
+    /**
+     * Distinguished Name (DN) of the PBX associated with the user. Example: 'pbxid=0800276a7b26,dc=wildix'.
+     * @public
+     */
+    pbxDn: string;
+    /**
+     * Source identifier for the user's authorization (example: '117868550326216144929').
+     * @public
+     */
+    sourceId?: string;
+    /**
+     * SIP password for the user, used to authenticate and secure SIP communications such as VoIP calls.
+     * @public
+     */
+    sipPassword?: string;
 }
 /**
  * @public
  */
-export declare class BotApiKeyNotFoundException extends __BaseException {
-    readonly name: "BotApiKeyNotFoundException";
-    readonly $fault: "client";
+export interface UserPbxInfo {
     /**
-     * @internal
+     * Network addresses associated with the PBX (example: ['krzhevitskywms4.wildixin.com']).
+     * @public
      */
-    constructor(opts: __ExceptionOptionType<BotApiKeyNotFoundException, __BaseException>);
+    networkAddresses: (string)[];
+    /**
+     * Specifies the HTTPs ports utilized by the PBX system (example: ['443']).
+     * @public
+     */
+    ports: (string)[];
+    /**
+     * Prefix used for external lines (eample: '0').
+     * @public
+     */
+    externalLinePrefix?: string;
+    /**
+     * Version of the PBX software (example: '5.03.20210820.2~67439e5d').
+     * @public
+     */
+    version: string;
+    /**
+     * Serial number of the PBX (example: '221100002aa2').
+     * @public
+     */
+    serial: string;
 }
 /**
  * @public
  */
-export interface BotDialogflowCxEndpoint {
+export interface UserPbxPersonalSettings {
+}
+/**
+ * @public
+ */
+export interface UserPbxServices {
+    xcaracal?: boolean;
+    wizyWebinar?: boolean;
+}
+/**
+ * @public
+ */
+export interface UserPbxLinkData {
     /**
-     * Dialogflow Service Account Credentials
+     * The unique identifier of the user (Cloud ID, not ID of the user on PBX).
      * @public
      */
-    credentials: __DocumentType;
+    id: string;
     /**
-     * Dialogflow Agent Id (example - 88ff4635-0852-4f97-ae44-b19ae9fa6ea1
+     * The ID of the tenant (company) associated with the user.
      * @public
      */
-    agent: string;
+    company: string;
     /**
-     * Dialogflow Agent Region (example: europe-west3)
+     * The name of the tenant (company) associated with the user.
      * @public
      */
-    location: string;
+    companyName?: string;
     /**
-     * Language
+     * The domain of the PBX where the user connected to.
      * @public
      */
-    language: string;
+    domain: string;
+    /**
+     * The email address of the user.
+     * @public
+     */
+    email?: string;
+    /**
+     * Personal information of the user.
+     * @public
+     */
+    info: UserPersonalInfo;
+    /**
+     * PBX information where user connected to.
+     * @public
+     */
+    pbx: UserPbxInfo;
+    /**
+     * A public URL of the user's picture (example: https://example.wildixin.com/cticonnect/cticonnect_share/user_avatar_3688190.png)
+     * @public
+     */
+    picture: string;
+    /**
+     * Indicates whether the picture was manually removed by the user. If true the application must show a placeholder instead of the default picture from the PBX.
+     * @public
+     */
+    pictureDeleted?: boolean;
+    /**
+     * The port used for the PBX connection.
+     * @public
+     */
+    port: string;
+    /**
+     * The serial number of the PBX.
+     * @public
+     */
+    serial: string;
+    /**
+     * Services associated with the user's PBX.
+     * @public
+     */
+    services?: UserPbxServices;
+    /**
+     * Personal settings (PBX) of the user.
+     * @public
+     */
+    personalSettings?: UserPbxPersonalSettings;
+    /**
+     * Dialplan settings (PBX) of the user.
+     * @public
+     */
+    dialplanSettings?: UserPbxDialplanSettings;
+    /**
+     * The AWS region where the PBX is located.
+     * @public
+     */
+    awsRegion?: string;
+    /**
+     * The date when link data was updated last time.
+     * @public
+     */
+    updatedAt?: string;
 }
 /**
  * @public
  */
-export interface BotOpenAiAssistantEndpoint {
-    key: string;
-    assistantId: string;
+export interface BatchGetUsersPbxLinkDataOutput {
+    users: (UserPbxLinkData)[];
 }
 /**
  * @public
  */
-export interface BotSqsEndpoint {
-    url: string;
-    key: string;
-    secret: string;
+export interface BatchGetUsersPbxLinkDataV1Input {
+    id: (string)[];
 }
 /**
  * @public
  */
-export interface BotWebhookEndpoint {
-    url: string;
+export interface BatchGetUsersPbxLinkDataV1Output {
+    users: (UserPbxLinkData)[];
+}
+/**
+ * @public
+ */
+export interface Bot {
+    id: string;
+    name: string;
+    picture?: string;
+    searchable?: boolean;
+    createdAt: string;
+    updated?: string;
+}
+/**
+ * @public
+ */
+export interface BotApiKey {
     secret: string;
+    name?: string;
+    createdAt: string;
+}
+/**
+ * @public
+ */
+export declare class BotApiKeyNotFoundException extends __BaseException {
+    readonly name: "BotApiKeyNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<BotApiKeyNotFoundException, __BaseException>);
 }
 /**
  * @public
@@ -387,6 +663,38 @@ export interface GetBotCallbackInput {
 export interface GetBotCallbackOutput {
     callback: BotCallback;
 }
+/**
+ * @public
+ */
+export interface GetUserInput {
+    /**
+     * The unique identifier of the user.
+     * @public
+     */
+    userId: string;
+}
+/**
+ * @public
+ */
+export interface GetUserOutput {
+    user: User;
+}
+/**
+ * @public
+ */
+export interface GetUserPbxLinkDataInput {
+    /**
+     * The unique identifier of the user (Cloud ID, not ID of the user on PBX).
+     * @public
+     */
+    userId: string;
+}
+/**
+ * @public
+ */
+export interface GetUserPbxLinkDataOutput {
+    user: UserPbxLinkData;
+}
 /**
  * @public
  */
@@ -422,6 +730,26 @@ export interface GetUserPbxLinkSuggestionOutput {
      */
     suggestion?: UserPbxLinkSuggestion;
 }
+/**
+ * @public
+ */
+export interface GetUserPbxLinkSuggestionV1Input {
+    /**
+     * An email address of the user when a service token is used. If not provided, the email will be taken from the token.
+     * @public
+     */
+    email?: string;
+}
+/**
+ * @public
+ */
+export interface GetUserPbxLinkSuggestionV1Output {
+    /**
+     * If the PBX data link information is available, the user can attempt to connect using the provided PBX domain and port. Can be empty if no information found for the specified email.
+     * @public
+     */
+    suggestion?: UserPbxLinkSuggestion;
+}
 /**
  * @public
  */
@@ -447,6 +775,116 @@ export interface ListBotsInput {
 export interface ListBotsOutput {
     bots: (Bot)[];
 }
+/**
+ * @public
+ */
+export interface UserQueryPredicate {
+    /**
+     * The type of PBX license required for the user query. This field is used to ensure that the user has the appropriate license type.
+     * @public
+     */
+    license?: PbxLicenseType;
+}
+/**
+ * @public
+ */
+export type UserQuery = UserQuery.EmailMember | UserQuery.IdMember | UserQuery.PhoneMember | UserQuery.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace UserQuery {
+    /**
+     * The unique identifier of the user (Cloud ID, not ID of the user on PBX).
+     * @public
+     */
+    interface IdMember {
+        id: string;
+        email?: never;
+        phone?: never;
+        $unknown?: never;
+    }
+    /**
+     * The email address of the user.
+     * @public
+     */
+    interface EmailMember {
+        id?: never;
+        email: string;
+        phone?: never;
+        $unknown?: never;
+    }
+    /**
+     * The phone number of the user.
+     * @public
+     */
+    interface PhoneMember {
+        id?: never;
+        email?: never;
+        phone: string;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        id?: never;
+        email?: never;
+        phone?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        id: (value: string) => T;
+        email: (value: string) => T;
+        phone: (value: string) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: UserQuery, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ */
+export interface QueryUserInput {
+    query: UserQuery;
+    /**
+     * A condition that must be satisfied for the user query to be considered valid. If this predicate is not met, a UserQueryPredicateNotMetException will be thrown.
+     * @public
+     */
+    predicate?: UserQueryPredicate;
+}
+/**
+ * @public
+ */
+export interface QueryUserOutput {
+    user: User;
+}
+/**
+ * @public
+ */
+export declare class UserQueryPredicateNotMetException extends __BaseException {
+    readonly name: "UserQueryPredicateNotMetException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<UserQueryPredicateNotMetException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface QueryUsersInput {
+    queries: (UserQuery)[];
+    predicate?: UserQueryPredicate;
+}
+/**
+ * @public
+ */
+export interface QueryUsersOutput {
+    /**
+     * A list of users that exist in the platform and matches predicate if specified.
+     * @public
+     */
+    users: (User)[];
+}
 /**
  * @public
  */
@@ -493,6 +931,22 @@ export interface UploadPictureInput {
 export interface UploadPictureOutput {
     url: string;
 }
+/**
+ * @public
+ */
+export interface UploadPictureV1Input {
+    /**
+     * A base64 encoded image file in PNG or JPG format, with dimensions of 140 x 140 pixels.
+     * @public
+     */
+    picture: string;
+}
+/**
+ * @public
+ */
+export interface UploadPictureV1Output {
+    url: string;
+}
 /**
  * @public
  */
@@ -515,3 +969,25 @@ export interface VerifyBotSecretKeyOutput {
     id: string;
     name?: string;
 }
+/**
+ * @public
+ */
+export interface VerifyBotSecretKeyV1Input {
+    /**
+     * A secret key string with "sk-"
+     * @public
+     */
+    secret: string;
+}
+/**
+ * @public
+ */
+export interface VerifyBotSecretKeyV1Output {
+    company: string;
+    /**
+     * A unique ID for the Bot that corresponds to the bot's x-bees user ID.
+     * @public
+     */
+    id: string;
+    name?: string;
+}