@wildix/xbees-users-client 1.0.38 → 1.0.40

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

@@ -43,21 +43,21 @@ export type PbxLicenseType = typeof PbxLicenseType[keyof typeof PbxLicenseType];
  */
 export interface User {
     id: 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;
+    name?: string | undefined;
+    email?: string | undefined;
+    phone?: string | undefined;
+    picture?: string | undefined;
+    locale?: string | undefined;
+    timeZone?: string | undefined;
+    company?: string | undefined;
+    bot?: boolean | undefined;
+    pbxDomain?: string | undefined;
+    pbxPort?: string | undefined;
+    pbxExtension?: string | undefined;
+    pbxSerial?: string | undefined;
+    pbxUserId?: string | undefined;
+    createdAt?: string | undefined;
+    updatedAt?: string | undefined;
 }
 /**
  * @public
@@ -126,13 +126,13 @@ export type PbxColleagueRole = typeof PbxColleagueRole[keyof typeof PbxColleague
  */
 export interface PbxColleague {
     id: string;
-    name?: string;
-    login?: string;
+    name?: string | undefined;
+    login?: string | undefined;
     extension: string;
-    officePhone?: string;
-    mobilePhone?: string;
-    faxNumber?: string;
-    email?: string;
+    officePhone?: string | undefined;
+    mobilePhone?: string | undefined;
+    faxNumber?: string | undefined;
+    email?: string | undefined;
     pbxDn: string;
     pbx: string;
     role: PbxColleagueRole;
@@ -141,9 +141,9 @@ export interface PbxColleague {
     language: string;
     dialplan: string;
     faxDialplan: string;
-    department?: string;
+    department?: string | undefined;
     picture: string;
-    sourceId?: string;
+    sourceId?: string | undefined;
     licenseType: PbxLicenseType;
     jid: string;
 }
@@ -284,22 +284,22 @@ export interface UserPersonalInfo {
      * Office phone number of the user (example: '22222'). This field can be an empty string or undefined if not provided.
      * @public
      */
-    officePhone?: string;
+    officePhone?: string | undefined;
     /**
      * Mobile phone number of the user (example: '22222'). This field can be an empty string or undefined if not provided.
      * @public
      */
-    mobilePhone?: string;
+    mobilePhone?: string | undefined;
     /**
      * Fax number of the user (example: '22222'). This field can be an empty string or undefined if not provided.
      * @public
      */
-    faxNumber?: string;
+    faxNumber?: string | undefined;
     /**
      * Email address of the user (example: 'email@google.com'). This field can be an empty string or undefined if not provided.
      * @public
      */
-    email?: string;
+    email?: string | undefined;
     /**
      * Role of the user (example: 'admin').
      * @public
@@ -324,7 +324,7 @@ export interface UserPersonalInfo {
      * Department of the user (example: 'Sales'). This field can be an empty string or undefined if not provided.
      * @public
      */
-    departament?: string;
+    departament?: string | undefined;
     /**
      * Public URL path of the user's picture (example: '/cticonnect/cticonnect_share/user_avatar_3688190.png?100&John Doe&98998generated').
      * @public
@@ -354,12 +354,12 @@ export interface UserPersonalInfo {
      * Login name of the user. This field can be an empty string or undefined if not provided.
      * @public
      */
-    login?: string;
+    login?: string | undefined;
     /**
      * PBX associated with the user. This field can be an empty string or undefined if not provided.
      * @public
      */
-    pbx?: string;
+    pbx?: string | undefined;
     /**
      * Distinguished Name (DN) of the PBX associated with the user. Example: 'pbxid=0800276a7b26,dc=wildix'.
      * @public
@@ -369,12 +369,12 @@ export interface UserPersonalInfo {
      * Source identifier for the user's authorization (example: '117868550326216144929').
      * @public
      */
-    sourceId?: string;
+    sourceId?: string | undefined;
     /**
      * SIP password for the user, used to authenticate and secure SIP communications such as VoIP calls.
      * @public
      */
-    sipPassword?: string;
+    sipPassword?: string | undefined;
 }
 /**
  * @public
@@ -394,7 +394,7 @@ export interface UserPbxInfo {
      * Prefix used for external lines (eample: '0').
      * @public
      */
-    externalLinePrefix?: string;
+    externalLinePrefix?: string | undefined;
     /**
      * Version of the PBX software (example: '5.03.20210820.2~67439e5d').
      * @public
@@ -415,8 +415,8 @@ export interface UserPbxPersonalSettings {
  * @public
  */
 export interface UserPbxServices {
-    xcaracal?: boolean;
-    wizyWebinar?: boolean;
+    xcaracal?: boolean | undefined;
+    wizyWebinar?: boolean | undefined;
 }
 /**
  * @public
@@ -436,7 +436,7 @@ export interface UserPbxLinkData {
      * The name of the tenant (company) associated with the user.
      * @public
      */
-    companyName?: string;
+    companyName?: string | undefined;
     /**
      * The domain of the PBX where the user connected to.
      * @public
@@ -446,7 +446,7 @@ export interface UserPbxLinkData {
      * The email address of the user.
      * @public
      */
-    email?: string;
+    email?: string | undefined;
     /**
      * Personal information of the user.
      * @public
@@ -466,7 +466,7 @@ export interface UserPbxLinkData {
      * 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;
+    pictureDeleted?: boolean | undefined;
     /**
      * The port used for the PBX connection.
      * @public
@@ -481,27 +481,27 @@ export interface UserPbxLinkData {
      * Services associated with the user's PBX.
      * @public
      */
-    services?: UserPbxServices;
+    services?: UserPbxServices | undefined;
     /**
      * Personal settings (PBX) of the user.
      * @public
      */
-    personalSettings?: UserPbxPersonalSettings;
+    personalSettings?: UserPbxPersonalSettings | undefined;
     /**
      * Dialplan settings (PBX) of the user.
      * @public
      */
-    dialplanSettings?: UserPbxDialplanSettings;
+    dialplanSettings?: UserPbxDialplanSettings | undefined;
     /**
      * The AWS region where the PBX is located.
      * @public
      */
-    awsRegion?: string;
+    awsRegion?: string | undefined;
     /**
      * The date when link data was updated last time.
      * @public
      */
-    updatedAt?: string;
+    updatedAt?: string | undefined;
 }
 /**
  * @public
@@ -521,6 +521,18 @@ export interface BatchGetUsersPbxLinkDataV1Input {
 export interface BatchGetUsersPbxLinkDataV1Output {
     users: (UserPbxLinkData)[];
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const BotAccess: {
+    readonly EVERYBODY: "EVERYBODY";
+    readonly ORGANIZATION: "ORGANIZATION";
+};
+/**
+ * @public
+ */
+export type BotAccess = typeof BotAccess[keyof typeof BotAccess];
 /**
  * @public
  * @enum
@@ -540,21 +552,34 @@ export type BotIntegrationType = typeof BotIntegrationType[keyof typeof BotInteg
  * @public
  */
 export interface Bot {
-    id: string;
     name: string;
-    picture?: string;
-    searchable?: boolean;
+    /**
+     * A link to the bot picture.
+     * @public
+     */
+    picture?: string | undefined;
+    /**
+     * Indicates whether the bot can be discovered by colleagues in the application.
+     * @public
+     */
+    searchable?: boolean | undefined;
+    /**
+     * Defines who is allowed to use the bot. Default is EVERYBODY.
+     * @public
+     */
+    access?: BotAccess | undefined;
+    id: string;
     integrationType: BotIntegrationType;
     integrationApiKeysCount: number;
     createdAt: string;
-    updated?: string;
+    updated?: string | undefined;
 }
 /**
  * @public
  */
 export interface BotApiKey {
     secret: string;
-    name?: string;
+    name?: string | undefined;
     createdAt: string;
 }
 /**
@@ -575,6 +600,7 @@ export declare class BotApiKeyNotFoundException extends __BaseException {
 export declare const BotLlmEmbeddedToolType: {
     readonly DELEGATE: "DELEGATE";
     readonly HANDOVER: "HANDOVER";
+    readonly SUGGESTIONS: "SUGGESTIONS";
 };
 /**
  * @public
@@ -590,7 +616,7 @@ export interface BotLlmEmbeddedTool {
      * The parameters the functions accepts.
      * @public
      */
-    parameters?: __DocumentType;
+    parameters?: __DocumentType | undefined;
 }
 /**
  * @public
@@ -612,7 +638,7 @@ export interface BotLlmFunctionIntegrationWebhookAuthorizationOAuth {
     clientId: string;
     clientSecret: string;
     endpointUrl: string;
-    scope?: string;
+    scope?: string | undefined;
 }
 /**
  * @public
@@ -684,11 +710,11 @@ export type BotLlmFunctionIntegrationMethod = typeof BotLlmFunctionIntegrationMe
  */
 export interface BotLlmFunctionIntegrationWebhook {
     url: string;
-    method?: BotLlmFunctionIntegrationMethod;
-    async?: boolean;
-    authorization?: BotLlmFunctionIntegrationWebhookAuthorization;
-    headers?: (BotLlmFunctionIntegrationWebhookHeader)[];
-    parameters?: __DocumentType;
+    method?: BotLlmFunctionIntegrationMethod | undefined;
+    async?: boolean | undefined;
+    authorization?: BotLlmFunctionIntegrationWebhookAuthorization | undefined;
+    headers?: (BotLlmFunctionIntegrationWebhookHeader)[] | undefined;
+    parameters?: __DocumentType | undefined;
 }
 /**
  * @public
@@ -728,13 +754,13 @@ export interface BotLlmFunctionDefinition {
      * A description of what the function does, used by the model to choose when and how to call the function.
      * @public
      */
-    description?: string;
+    description?: string | undefined;
     /**
      * The parameters the functions accepts, described as a JSON Schema object.
      * @public
      */
-    parameters?: __DocumentType;
-    integration?: BotLlmFunctionIntegration;
+    parameters?: __DocumentType | undefined;
+    integration?: BotLlmFunctionIntegration | undefined;
 }
 /**
  * @public
@@ -752,7 +778,7 @@ export type BotLlmToolType = typeof BotLlmToolType[keyof typeof BotLlmToolType];
  */
 export interface BotLlmTool {
     type: BotLlmToolType;
-    function?: BotLlmFunctionDefinition;
+    function?: BotLlmFunctionDefinition | undefined;
 }
 /**
  * @public
@@ -763,12 +789,12 @@ export interface BotLlmEndpoint {
      * Embedded functions to use within chat session.
      * @public
      */
-    embeddedTools?: (BotLlmEmbeddedTool)[];
+    embeddedTools?: (BotLlmEmbeddedTool)[] | undefined;
     /**
      * Custom tools to be used within chat session.
      * @public
      */
-    tools?: (BotLlmTool)[];
+    tools?: (BotLlmTool)[] | undefined;
 }
 /**
  * @public
@@ -843,7 +869,7 @@ export declare namespace BotEndpoint {
  * @public
  */
 export interface BotCallback {
-    endpoint?: BotEndpoint;
+    endpoint?: BotEndpoint | undefined;
 }
 /**
  * @public
@@ -876,12 +902,12 @@ export interface NewEmailData {
      * By default, API expects that company id will be the same for both new and old emails. If no - this field should be provided
      * @public
      */
-    companyId?: string;
+    companyId?: string | undefined;
     /**
      * Target PBX domain name for cases with few PBXes in one WMS-network
      * @public
      */
-    pbxDomain?: string;
+    pbxDomain?: string | undefined;
 }
 /**
  * @public
@@ -892,7 +918,7 @@ export interface OldEmailData {
      * By default, API expects that company id will be the same for both new and old emails. If no - this field should be provided
      * @public
      */
-    companyId?: string;
+    companyId?: string | undefined;
 }
 /**
  * @public
@@ -933,18 +959,23 @@ export declare class UserNotFoundException extends __BaseException {
  * @public
  */
 export interface CreateBotInput {
-    company?: string;
     name: string;
     /**
      * A link to the bot picture.
      * @public
      */
-    picture?: string;
+    picture?: string | undefined;
+    /**
+     * Indicates whether the bot can be discovered by colleagues in the application.
+     * @public
+     */
+    searchable?: boolean | undefined;
     /**
-     * A flag enables users to discover the bot via the search function in the x-bees application.
+     * Defines who is allowed to use the bot. Default is EVERYBODY.
      * @public
      */
-    searchable?: boolean;
+    access?: BotAccess | undefined;
+    company?: string | undefined;
     callback: BotCallback;
 }
 /**
@@ -957,9 +988,9 @@ export interface CreateBotOutput {
  * @public
  */
 export interface CreateBotApiKeyInput {
-    company?: string;
+    company?: string | undefined;
     botId: string;
-    name?: string;
+    name?: string | undefined;
 }
 /**
  * @public
@@ -976,13 +1007,13 @@ export interface CreateSystemBotInput {
      * The unique identifier of the tenant when a service token is used.
      * @public
      */
-    company?: string;
+    company?: string | undefined;
     name: string;
     /**
      * A URL pointing to the bot's avatar.
      * @public
      */
-    picture?: string;
+    picture?: string | undefined;
 }
 /**
  * @public
@@ -994,7 +1025,7 @@ export interface CreateSystemBotOutput {
  * @public
  */
 export interface DeleteBotInput {
-    company?: string;
+    company?: string | undefined;
     botId: string;
 }
 /**
@@ -1006,7 +1037,7 @@ export interface DeleteBotOutput {
  * @public
  */
 export interface DeleteBotApiKeyInput {
-    company?: string;
+    company?: string | undefined;
     botId: string;
     apiKeySecret: string;
 }
@@ -1021,14 +1052,14 @@ export interface DeleteBotApiKeyOutput {
 export interface DirectoryItem {
     extension: string;
     name: string;
-    department?: string;
-    group?: string;
+    department?: string | undefined;
+    group?: string | undefined;
 }
 /**
  * @public
  */
 export interface GetBotInput {
-    company?: string;
+    company?: string | undefined;
     botId: string;
 }
 /**
@@ -1041,7 +1072,7 @@ export interface GetBotOutput {
  * @public
  */
 export interface GetBotCallbackInput {
-    company?: string;
+    company?: string | undefined;
     botId: string;
 }
 /**
@@ -1106,7 +1137,7 @@ export interface GetUserPbxLinkSuggestionInput {
      * 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;
+    email?: string | undefined;
 }
 /**
  * @public
@@ -1131,7 +1162,7 @@ export interface GetUserPbxLinkSuggestionOutput {
      * 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;
+    suggestion?: UserPbxLinkSuggestion | undefined;
 }
 /**
  * @public
@@ -1141,7 +1172,7 @@ 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;
+    email?: string | undefined;
 }
 /**
  * @public
@@ -1151,7 +1182,7 @@ 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;
+    suggestion?: UserPbxLinkSuggestion | undefined;
 }
 /**
  * @public
@@ -1161,13 +1192,13 @@ export interface IntelligenceSearchInput {
      * The unique identifier of the tenant when a service token is used. Only for s2s auth
      * @public
      */
-    company?: string;
+    company?: string | undefined;
     search: string;
     /**
      * Optional extension to exclude from search results. Used to prevent returning the caller's own record when searching.
      * @public
      */
-    excludeExtension?: string;
+    excludeExtension?: string | undefined;
 }
 /**
  * @public
@@ -1179,7 +1210,7 @@ export interface IntelligenceSearchOutput {
  * @public
  */
 export interface ListBotApiKeysInput {
-    company?: string;
+    company?: string | undefined;
     botId: string;
 }
 /**
@@ -1192,7 +1223,7 @@ export interface ListBotApiKeysOutput {
  * @public
  */
 export interface ListBotsInput {
-    company?: string;
+    company?: string | undefined;
 }
 /**
  * @public
@@ -1208,12 +1239,12 @@ export interface PartialUpdateUserEmailNotificationsSettingsInput {
      * A flag that indicates whether the system should send email notifications about unread messages.
      * @public
      */
-    unread?: boolean;
+    unread?: boolean | undefined;
     /**
      * A flag that indicates whether the system should send email notifications about AI transcription.
      * @public
      */
-    transcription?: boolean;
+    transcription?: boolean | undefined;
     /**
      * The unique identifier of the user (Cloud ID, not ID of the user on PBX).
      * @public
@@ -1230,20 +1261,20 @@ export interface PartialUpdateUserEmailNotificationsSettingsOutput {
  * @public
  */
 export interface QueryColleaguesParameters {
-    id?: (string)[];
-    extension?: (string)[];
-    officePhone?: (string)[];
-    mobilePhone?: (string)[];
-    name?: (string)[];
-    email?: (string)[];
-    department?: (string)[];
-    search?: string;
-    searchFields?: (PbxColleaguesQueryField)[];
-    searchStrategy?: PbxColleaguesSearchStrategy;
-    sort?: (PbxColleaguesQueryField)[];
-    start?: number;
-    count?: number;
-    dir?: GetPbxColleaguesDir;
+    id?: (string)[] | undefined;
+    extension?: (string)[] | undefined;
+    officePhone?: (string)[] | undefined;
+    mobilePhone?: (string)[] | undefined;
+    name?: (string)[] | undefined;
+    email?: (string)[] | undefined;
+    department?: (string)[] | undefined;
+    search?: string | undefined;
+    searchFields?: (PbxColleaguesQueryField)[] | undefined;
+    searchStrategy?: PbxColleaguesSearchStrategy | undefined;
+    sort?: (PbxColleaguesQueryField)[] | undefined;
+    start?: number | undefined;
+    count?: number | undefined;
+    dir?: GetPbxColleaguesDir | undefined;
 }
 /**
  * @public
@@ -1253,8 +1284,8 @@ export interface QueryColleaguesInput {
      * The unique identifier of the tenant when a service token is used.
      * @public
      */
-    company?: string;
-    query?: QueryColleaguesParameters;
+    company?: string | undefined;
+    query?: QueryColleaguesParameters | undefined;
 }
 /**
  * @public
@@ -1264,7 +1295,7 @@ export interface QueryColleaguesOutputItem {
      * A user object associated on the cloud for this colleague that is registered on the WMS.
      * @public
      */
-    user?: User;
+    user?: User | undefined;
     /**
      * A colleague object returned by the PBX.
      * @public
@@ -1289,7 +1320,7 @@ 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;
+    license?: PbxLicenseType | undefined;
 }
 /**
  * @public
@@ -1355,7 +1386,7 @@ export interface QueryUserInput {
      * 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;
+    predicate?: UserQueryPredicate | undefined;
 }
 /**
  * @public
@@ -1379,7 +1410,7 @@ export declare class UserQueryPredicateNotMetException extends __BaseException {
  */
 export interface QueryUsersInput {
     queries: (UserQuery)[];
-    predicate?: UserQueryPredicate;
+    predicate?: UserQueryPredicate | undefined;
 }
 /**
  * @public
@@ -1427,11 +1458,24 @@ export interface ToggleUnreadEmailNotificationsSubscriptionOutput {
  * @public
  */
 export interface UpdateBotInput {
-    company?: string;
-    botId: string;
     name: string;
-    picture?: string;
-    searchable?: boolean;
+    /**
+     * A link to the bot picture.
+     * @public
+     */
+    picture?: string | undefined;
+    /**
+     * Indicates whether the bot can be discovered by colleagues in the application.
+     * @public
+     */
+    searchable?: boolean | undefined;
+    /**
+     * Defines who is allowed to use the bot. Default is EVERYBODY.
+     * @public
+     */
+    access?: BotAccess | undefined;
+    company?: string | undefined;
+    botId: string;
 }
 /**
  * @public
@@ -1443,7 +1487,7 @@ export interface UpdateBotOutput {
  * @public
  */
 export interface UpdateBotCallbackInput {
-    company?: string;
+    company?: string | undefined;
     botId: string;
     callback: BotCallback;
 }
@@ -1461,12 +1505,12 @@ export interface UpdateUserEmailNotificationsSettingsInput {
      * A flag that indicates whether the system should send email notifications about unread messages.
      * @public
      */
-    unread?: boolean;
+    unread?: boolean | undefined;
     /**
      * A flag that indicates whether the system should send email notifications about AI transcription.
      * @public
      */
-    transcription?: boolean;
+    transcription?: boolean | undefined;
     /**
      * The unique identifier of the user (Cloud ID, not ID of the user on PBX).
      * @public
@@ -1531,7 +1575,7 @@ export interface VerifyBotSecretKeyOutput {
      * @public
      */
     id: string;
-    name?: string;
+    name?: string | undefined;
 }
 /**
  * @public
@@ -1553,5 +1597,5 @@ export interface VerifyBotSecretKeyV1Output {
      * @public
      */
     id: string;
-    name?: string;
+    name?: string | undefined;
 }