o2g-node-sdk 2.4.0 → 2.5.0

package/dist/types/o2g-pbx-mngt.d.ts

@@ -0,0 +1,244 @@
+import { Model } from './types/pbxmngt/model';
+import { PbxAttribute } from './types/pbxmngt/pbx-attribute';
+import { PbxObject } from './types/pbxmngt/pbx-object';
+import { InstanceFilter } from './types/pbxmngt/instance-filter';
+import EventEmitter from 'events';
+import { Pbx } from './types/pbxmngt/pbx';
+/**
+ * PbxManagement service allows an administrator to manage an OmniPCX
+ * Enterprise, that is to create, modify or delete any object or sub-object in the
+ * OmniPCX Enterprise object model. Using this service requires having a
+ * <b>MANAGEMENT</b> license.
+ * <p>
+ * <b>WARNING:</b> Using this service requires a good knowledge of the
+ * OmniPCX Enterprise object model.
+ * <p>
+ * The service uses two kinds of resource: the object model resource and the
+ * object instance resource.
+ * <p><b><u>The object model</u></b>: The object model can be retrieved for the whole PBX
+ * or for a particular object. It provides the detail of object attributes:
+ * whether the attribute is mandatory or optional in the object creation, what
+ * range of values is authorized, and what the possible enumeration values are.
+ * <p><b><u>The object instance</u></b>: It is used to create, modify, retrieve or remove
+ * any instances of any object, given the reference of this object. For the
+ * creation or modification of an object, the body must be compliant with
+ * the object model.
+ * <p>
+ * The list of sub-objects returned by a get instance of an object corresponds
+ * to the relative path of the first instantiable objects in the hierarchy,
+ * in order to be able by recursion to build the path to access any object
+ * and sub-object.
+ * <p>
+ * When accessing an object which is a sub-object, the full path must be given:
+ * `{object1Name}/{object1Id}/{object2Name}/{object2Id}/.../{objectxName}/{objectxId}`.
+ *
+ * @example
+ * ```typescript
+ * // Inspect the object model for the Subscriber object
+ * const model = await O2G.pbxManagement.getObjectModel(1, "Subscriber");
+ *
+ * // Query all analog subscriber instances on node 1
+ * const ids = await O2G.pbxManagement.getObjectInstances(1, "Subscriber", "StationType==ANALOG");
+ *
+ * if (ids && ids.length > 0) {
+ *     // Retrieve a specific subscriber with selected attributes
+ *     const obj = await O2G.pbxManagement.getObject(
+ *         1, "Subscriber", ids[0],
+ *         [new PbxAttribute("StationType"), new PbxAttribute("Directory")]
+ *     );
+ *
+ *     // Modify an attribute
+ *     await O2G.pbxManagement.setObject(
+ *         1, "Subscriber", ids[0],
+ *         [new PbxAttribute("Directory", "60200")]
+ *     );
+ * }
+ *
+ * // Create a new subscriber
+ * await O2G.pbxManagement.createObject(1, "Subscriber", [
+ *     new PbxAttribute("StationType", "ANALOG"),
+ *     new PbxAttribute("Directory", "60300")
+ * ]);
+ *
+ * // Delete a subscriber, forcing deletion even if they have voice mails
+ * await O2G.pbxManagement.deleteObject(1, "Subscriber", "60300", true);
+ *
+ * // Listen for object change events
+ * O2G.pbxManagement.on(PbxManagement.ON_PBX_OBJECT_INSTANCE_MODIFIED, (event) => {
+ *     console.log("Object modified:", event.objectName, event.objectId);
+ * });
+ * ```
+ */
+export declare class PbxManagement extends EventEmitter {
+    #private;
+    /**
+     * Occurs when a PBX object instance is created.
+     * Only Object Subscriber is concerned by this event.
+     * @event
+     */
+    static readonly ON_PBX_OBJECT_INSTANCE_CREATED = "OnPbxObjectInstanceCreated";
+    /**
+     * Occurs when a PBX object instance is deleted.
+     * Only Object Subscriber is concerned by this event.
+     * @event
+     */
+    static readonly ON_PBX_OBJECT_INSTANCE_DELETED = "OnPbxObjectInstanceDeleted";
+    /**
+     * Occurs when a PBX object instance is modified.
+     * Only Object Subscriber is concerned by this event.
+     * @event
+     */
+    static readonly ON_PBX_OBJECT_INSTANCE_MODIFIED = "OnPbxObjectInstanceModified";
+    /**
+     * Gets the list of OmniPCX Enterprise nodes connected on this O2G server.
+     *
+     * @returns the list of node ids on success; `null` otherwise.
+     */
+    getPbxs(): Promise<number[] | null>;
+    /**
+     * Gets the OmniPCX Enterprise specified by its node id.
+     *
+     * @param nodeId the PCX Enterprise node id
+     * @returns the {@link Pbx} on success; `null` otherwise.
+     */
+    getPbx(nodeId: number): Promise<Pbx | null>;
+    /**
+     * Gets the description of the data model for the specified object on the
+     * specified OmniPCX Enterprise node.
+     * <p>
+     * If `objectName` is `null`, the global object model of the OmniPCX Enterprise
+     * node is returned.
+     *
+     * @example
+     * ```typescript
+     * // Get the global object model for node 1
+     * const globalModel = await O2G.pbxManagement.getObjectModel(1);
+     *
+     * // Get the model for a specific object
+     * const subscriberModel = await O2G.pbxManagement.getObjectModel(1, "Subscriber");
+     * ```
+     *
+     * @param nodeId     the OmniPCX Enterprise node id
+     * @param objectName the object name, or `null` to retrieve the global model
+     * @returns the {@link Model} on success; `null` otherwise.
+     */
+    getObjectModel(nodeId: number, objectName?: string | null): Promise<Model | null>;
+    /**
+     * Gets the node (root) object.
+     *
+     * @param nodeId the OmniPCX Enterprise node id
+     * @returns the root {@link PbxObject} on success; `null` otherwise.
+     */
+    getNodeObject(nodeId: number): Promise<PbxObject | null>;
+    /**
+     * Gets the object specified by its instance definition and its instance id.
+     *
+     * @example
+     * ```typescript
+     * // Retrieve all attributes of a subscriber
+     * const obj = await O2G.pbxManagement.getObject(1, "Subscriber", "60200");
+     *
+     * // Retrieve only specific attributes using a comma-separated string
+     * const partial = await O2G.pbxManagement.getObject(
+     *     1, "Subscriber", "60200", "StationType,Directory"
+     * );
+     *
+     * // Retrieve specific attributes using a PbxAttribute array
+     * const typed = await O2G.pbxManagement.getObject(
+     *     1, "Subscriber", "60200",
+     *     [new PbxAttribute("StationType"), new PbxAttribute("Directory")]
+     * );
+     * ```
+     *
+     * @param nodeId                   the OmniPCX Enterprise node id
+     * @param objectInstanceDefinition the object instance definition
+     * @param objectId                 the object instance id
+     * @param attributes               optional attributes to retrieve — either a
+     *                                 comma-separated attribute name string or an
+     *                                 array of {@link PbxAttribute} objects
+     * @returns the {@link PbxObject} on success; `null` otherwise.
+     */
+    getObject(nodeId: number, objectInstanceDefinition: string, objectId: string, attributes?: string | PbxAttribute[] | null): Promise<PbxObject | null>;
+    /**
+     * Queries the list of object instances that match the specified filter.
+     * <p>
+     * A filter can be built using the {@link InstanceFilter} class, or provided
+     * as a string expression.
+     *
+     * @example
+     * ```typescript
+     * // Using an InstanceFilter object
+     * const filter = InstanceFilter.create(
+     *     "StationType",
+     *     AttributeFilter.Equals,
+     *     "ANALOG"
+     * );
+     * const ids = await O2G.pbxManagement.getObjectInstances(1, "Subscriber", filter);
+     *
+     * // Using a string expression
+     * const ids2 = await O2G.pbxManagement.getObjectInstances(
+     *     1, "Subscriber", "StationType==ANALOG"
+     * );
+     *
+     * // Get all instances with no filter
+     * const all = await O2G.pbxManagement.getObjectInstances(1, "Subscriber");
+     * ```
+     *
+     * @param nodeId                   the OmniPCX Enterprise node id
+     * @param objectInstanceDefinition the object instance definition
+     * @param filter                   an optional filter — either an {@link InstanceFilter}
+     *                                 object or a string expression
+     * @returns the list of matching object instance ids on success; `null` otherwise.
+     */
+    getObjectInstances(nodeId: number, objectInstanceDefinition: string, filter?: string | InstanceFilter | null): Promise<string[] | null>;
+    /**
+     * Changes one or several attribute values of the specified object.
+     *
+     * @param nodeId                   the OmniPCX Enterprise node id
+     * @param objectInstanceDefinition the object instance definition
+     * @param objectId                 the object instance id
+     * @param attributes               the array of attributes to change
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see createObject
+     * @see deleteObject
+     */
+    setObject(nodeId: number, objectInstanceDefinition: string, objectId: string, attributes: PbxAttribute[]): Promise<boolean>;
+    /**
+     * Deletes the specified instance of an object.
+     * <p>
+     * The `forceDelete` option is not available for all objects — check its
+     * availability in the {@link Model} corresponding to the object. It can be
+     * used, for example, to delete a `Subscriber` that has voice mails in their
+     * mailbox.
+     *
+     * @example
+     * ```typescript
+     * // Standard delete
+     * await O2G.pbxManagement.deleteObject(1, "Subscriber", "60200");
+     *
+     * // Force delete — use when standard delete is blocked (e.g. subscriber has voice mails)
+     * await O2G.pbxManagement.deleteObject(1, "Subscriber", "60200", true);
+     * ```
+     *
+     * @param nodeId                   the OmniPCX Enterprise node id
+     * @param objectInstanceDefinition the object instance definition
+     * @param objectId                 the object instance id
+     * @param forceDelete              if `true`, uses the FORCED_DELETE action
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see createObject
+     * @see setObject
+     */
+    deleteObject(nodeId: number, objectInstanceDefinition: string, objectId: string, forceDelete?: boolean): Promise<boolean>;
+    /**
+     * Creates a new object with the specified collection of attributes.
+     *
+     * @param nodeId                   the OmniPCX Enterprise node id
+     * @param objectInstanceDefinition the object instance definition
+     * @param attributes               the array of attributes to set at object creation
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see setObject
+     * @see deleteObject
+     */
+    createObject(nodeId: number, objectInstanceDefinition: string, attributes: PbxAttribute[]): Promise<boolean>;
+}
+//# sourceMappingURL=o2g-pbx-mngt.d.ts.map

package/dist/types/o2g-pbx-mngt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"o2g-pbx-mngt.d.ts","sourceRoot":"","sources":["../../src/o2g-pbx-mngt.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,YAAY,MAAM,QAAQ,CAAC;AAOlC,OAAO,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgEG;AACH,qBAAa,aAAc,SAAQ,YAAY;;IAG3C;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,8BAA8B,gCAAgC;IAE9E;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,8BAA8B,gCAAgC;IAE9E;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,+BAA+B,iCAAiC;IAehF;;;;OAIG;IACG,OAAO,IAAI,OAAO,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC;IAIzC;;;;;OAKG;IACG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC;IAIjD;;;;;;;;;;;;;;;;;;;OAmBG;IACG,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAI7F;;;;;OAKG;IACG,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IAI9D;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,SAAS,CACX,MAAM,EAAE,MAAM,EACd,wBAAwB,EAAE,MAAM,EAChC,QAAQ,EAAE,MAAM,EAChB,UAAU,GAAE,MAAM,GAAG,YAAY,EAAE,GAAG,IAAW,GAClD,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IAI5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,kBAAkB,CACpB,MAAM,EAAE,MAAM,EACd,wBAAwB,EAAE,MAAM,EAChC,MAAM,GAAE,MAAM,GAAG,cAAc,GAAG,IAAW,GAC9C,OAAO,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC;IAI3B;;;;;;;;;;OAUG;IACG,SAAS,CACX,MAAM,EAAE,MAAM,EACd,wBAAwB,EAAE,MAAM,EAChC,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,YAAY,EAAE,GAC3B,OAAO,CAAC,OAAO,CAAC;IAInB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,YAAY,CACd,MAAM,EAAE,MAAM,EACd,wBAAwB,EAAE,MAAM,EAChC,QAAQ,EAAE,MAAM,EAChB,WAAW,UAAQ,GACpB,OAAO,CAAC,OAAO,CAAC;IAInB;;;;;;;;;OASG;IACG,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,wBAAwB,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAGrH"}

package/dist/types/o2g-phone-set-prog.d.ts

@@ -0,0 +1,269 @@
+import { DynamicState } from './types/phoneset/dynamic-state';
+import { Pin } from './types/phoneset/pin';
+import { ProgrammeableKey } from './types/phoneset/prog-key';
+import { SoftKey } from './types/phoneset/soft-key';
+import { Device } from './types/common/device';
+/**
+ * This service allows managing the programmable keys, soft keys, and device settings
+ * of the phone sets assigned to a user.
+ * <p>
+ * Most methods accept a `loginName` parameter. When `loginName` is `null`, the operation
+ * applies to the user of the current session. When specified, it allows an administrator
+ * to manage another user's devices.
+ *
+ * @example
+ * ```typescript
+ * // Current session user — pass null for loginName
+ * const devices = await O2G.phoneSetProgramming.getDevices(null);
+ * if (devices && devices.length > 0) {
+ *     const deviceId = devices[0].id;
+ *
+ *     // Retrieve all programmed keys
+ *     const keys = await O2G.phoneSetProgramming.getProgrammedKeys(null, deviceId);
+ *
+ *     // Assign a new programmable key at position 1
+ *     const key = new ProgrammeableKey({ position: 1, type: "SPEED_DIAL", number: "5001" });
+ *     await O2G.phoneSetProgramming.setProgrammableKey(null, deviceId, key);
+ *
+ *     // Lock the device
+ *     await O2G.phoneSetProgramming.lockDevice(null, deviceId);
+ *
+ *     // Unlock when done
+ *     await O2G.phoneSetProgramming.unlockDevice(null, deviceId);
+ * }
+ *
+ * // Administrator managing another user's device
+ * const adminDevices = await O2G.phoneSetProgramming.getDevices("jdoe");
+ * ```
+ */
+export declare class PhoneSetProgramming {
+    #private;
+    /**
+     * Retrieves the list of devices assigned to the specified user.
+     *
+     * @param loginName the user login name, or `null` for the current session user.
+     * @returns the list of {@link Device} objects on success; `null` otherwise.
+     */
+    getDevices(loginName: string | null): Promise<Device[] | null>;
+    /**
+     * Retrieves the information of a specific device assigned to the specified user.
+     *
+     * @param loginName the user login name, or `null` for the current session user.
+     * @param deviceId  the device identifier
+     * @returns the {@link Device} information on success; `null` otherwise.
+     */
+    getDevice(loginName: string | null, deviceId: string): Promise<Device | null>;
+    /**
+     * Retrieves all programmable keys of the specified device, including unassigned positions.
+     * <p>
+     * Use this method when you need to know the full layout of the device, including
+     * empty positions. To retrieve only the keys that have been assigned, use
+     * {@link getProgrammedKeys} instead.
+     *
+     * @example
+     * ```typescript
+     * // Get all positions (including empty ones) to inspect the full key layout
+     * const allKeys = await O2G.phoneSetProgramming.getProgrammableKeys(null, "1234");
+     *
+     * // Get only the assigned keys to display what is currently programmed
+     * const assignedKeys = await O2G.phoneSetProgramming.getProgrammedKeys(null, "1234");
+     *
+     * console.log(`Total positions: ${allKeys?.length}`);
+     * console.log(`Assigned keys: ${assignedKeys?.length}`);
+     * ```
+     *
+     * @param loginName the user login name, or `null` for the current session user.
+     * @param deviceId  the device identifier
+     * @returns the list of {@link ProgrammeableKey} objects on success; `null` otherwise.
+     * @see getProgrammedKeys
+     */
+    getProgrammableKeys(loginName: string | null, deviceId: string): Promise<ProgrammeableKey[] | null>;
+    /**
+     * Retrieves only the programmed (assigned) programmable keys of the specified device.
+     * <p>
+     * Use this method when you only need the keys that have been assigned. To retrieve
+     * the full layout including unassigned positions, use {@link getProgrammableKeys} instead.
+     *
+     * @param loginName the user login name, or `null` for the current session user.
+     * @param deviceId  the device identifier
+     * @returns the list of assigned {@link ProgrammeableKey} objects on success; `null` otherwise.
+     * @see getProgrammableKeys
+     */
+    getProgrammedKeys(loginName: string | null, deviceId: string): Promise<ProgrammeableKey[] | null>;
+    /**
+     * Assigns or updates a programmable key on the specified device.
+     *
+     * @param loginName the user login name, or `null` for the current session user.
+     * @param deviceId  the device identifier
+     * @param key       the programmable key configuration to set
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see deleteProgrammableKey
+     */
+    setProgrammableKey(loginName: string | null, deviceId: string, key: ProgrammeableKey): Promise<boolean>;
+    /**
+     * Deletes the programmable key at the specified position on the given device.
+     *
+     * @param loginName the user login name, or `null` for the current session user.
+     * @param deviceId  the device identifier
+     * @param position  the position of the programmable key to delete
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see setProgrammableKey
+     */
+    deleteProgrammableKey(loginName: string | null, deviceId: string, position: number): Promise<boolean>;
+    /**
+     * Retrieves the soft keys of the specified device.
+     *
+     * @param loginName the user login name, or `null` for the current session user.
+     * @param deviceId  the device identifier
+     * @returns the list of {@link SoftKey} objects on success; `null` otherwise.
+     */
+    getSoftKeys(loginName: string | null, deviceId: string): Promise<SoftKey[] | null>;
+    /**
+     * Assigns or updates a soft key on the specified device.
+     *
+     * @param loginName the user login name, or `null` for the current session user.
+     * @param deviceId  the device identifier
+     * @param key       the soft key configuration to set
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see deleteSoftKey
+     */
+    setSoftKey(loginName: string | null, deviceId: string, key: SoftKey): Promise<boolean>;
+    /**
+     * Deletes the soft key at the specified position on the given device.
+     *
+     * @param loginName the user login name, or `null` for the current session user.
+     * @param deviceId  the device identifier
+     * @param position  the position of the soft key to delete
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see setSoftKey
+     */
+    deleteSoftKey(loginName: string | null, deviceId: string, position: number): Promise<boolean>;
+    /**
+     * Locks the specified device, preventing it from being used to place or receive calls.
+     *
+     * @param loginName the user login name, or `null` for the current session user.
+     * @param deviceId  the device identifier
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see unlockDevice
+     */
+    lockDevice(loginName: string | null, deviceId: string): Promise<boolean>;
+    /**
+     * Unlocks the specified device, restoring normal call capabilities.
+     *
+     * @param loginName the user login name, or `null` for the current session user.
+     * @param deviceId  the device identifier
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see lockDevice
+     */
+    unlockDevice(loginName: string | null, deviceId: string): Promise<boolean>;
+    /**
+     * Enables the camp-on feature on the specified device.
+     * <p>
+     * When camp-on is enabled, the user is automatically connected when a busy
+     * destination becomes available.
+     *
+     * @param loginName the user login name, or `null` for the current session user.
+     * @param deviceId  the device identifier
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see disableCampon
+     */
+    enableCampon(loginName: string | null, deviceId: string): Promise<boolean>;
+    /**
+     * Disables the camp-on feature on the specified device.
+     *
+     * @param loginName the user login name, or `null` for the current session user.
+     * @param deviceId  the device identifier
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see enableCampon
+     */
+    disableCampon(loginName: string | null, deviceId: string): Promise<boolean>;
+    /**
+     * Retrieves the PIN code configuration of the specified device.
+     *
+     * @param loginName the user login name, or `null` for the current session user.
+     * @param deviceId  the device identifier
+     * @returns the {@link Pin} configuration on success; `null` otherwise.
+     * @see setPinCode
+     */
+    getPinCode(loginName: string | null, deviceId: string): Promise<Pin | null>;
+    /**
+     * Sets the PIN code on the specified device.
+     *
+     * @param loginName the user login name, or `null` for the current session user.
+     * @param deviceId  the device identifier
+     * @param code      the PIN configuration to set
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see getPinCode
+     */
+    setPinCode(loginName: string | null, deviceId: string, code: Pin): Promise<boolean>;
+    /**
+     * Retrieves the dynamic state of the specified device.
+     * <p>
+     * The dynamic state reflects runtime settings such as the associated device
+     * and remote extension activation status.
+     *
+     * @param loginName the user login name, or `null` for the current session user.
+     * @param deviceId  the device identifier
+     * @returns the {@link DynamicState} on success; `null` otherwise.
+     */
+    getDynamicState(loginName: string | null, deviceId: string): Promise<DynamicState | null>;
+    /**
+     * Associates an additional device with the specified device.
+     * <p>
+     * The associate feature allows calls to ring simultaneously on both devices,
+     * which is useful for example to have a mobile phone ring alongside a desk phone.
+     *
+     * @example
+     * ```typescript
+     * // Associate a mobile number with the desk phone so both ring simultaneously
+     * await O2G.phoneSetProgramming.setAssociate(null, "1234", "0612345678");
+     *
+     * // Check the dynamic state to verify the association is active
+     * const state = await O2G.phoneSetProgramming.getDynamicState(null, "1234");
+     * console.log("Associated device:", state?.associatedNumber);
+     * ```
+     *
+     * @param loginName the user login name, or `null` for the current session user.
+     * @param deviceId  the device identifier
+     * @param associate the phone number of the device to associate
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     */
+    setAssociate(loginName: string | null, deviceId: string, associate: string): Promise<boolean>;
+    /**
+     * Activates the remote extension on the specified device.
+     * <p>
+     * When activated, the device operates as a remote extension, allowing the user
+     * to use an off-site phone as if it were connected to the PBX.
+     *
+     * @example
+     * ```typescript
+     * // Check current remote extension state before activating
+     * const state = await O2G.phoneSetProgramming.getDynamicState(null, "1234");
+     * console.log("Remote extension active:", state?.remoteExtensionActivated);
+     *
+     * // Activate the remote extension
+     * await O2G.phoneSetProgramming.activateRemoteExtension(null, "1234");
+     *
+     * // Deactivate when the user returns to the office
+     * await O2G.phoneSetProgramming.deactivateRemoteExtension(null, "1234");
+     * ```
+     *
+     * @param loginName the user login name, or `null` for the current session user.
+     * @param deviceId  the device identifier
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see deactivateRemoteExtension
+     * @see getDynamicState
+     */
+    activateRemoteExtension(loginName: string | null, deviceId: string): Promise<boolean>;
+    /**
+     * Deactivates the remote extension on the specified device.
+     *
+     * @param loginName the user login name, or `null` for the current session user.
+     * @param deviceId  the device identifier
+     * @returns `true` if the operation succeeded; `false` otherwise.
+     * @see activateRemoteExtension
+     * @see getDynamicState
+     */
+    deactivateRemoteExtension(loginName: string | null, deviceId: string): Promise<boolean>;
+}
+//# sourceMappingURL=o2g-phone-set-prog.d.ts.map

package/dist/types/o2g-phone-set-prog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"o2g-phone-set-prog.d.ts","sourceRoot":"","sources":["../../src/o2g-phone-set-prog.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,EAAE,GAAG,EAAE,MAAM,sBAAsB,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,qBAAa,mBAAmB;;IAU5B;;;;;OAKG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC;IAIpE;;;;;;OAMG;IACG,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAInF;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,GAAG,IAAI,CAAC;IAIzG;;;;;;;;;;OAUG;IACG,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,GAAG,IAAI,CAAC;IAIvG;;;;;;;;OAQG;IACG,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;IAI7G;;;;;;;;OAQG;IACG,qBAAqB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI3G;;;;;;OAMG;IACG,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC;IAIxF;;;;;;;;OAQG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAI5F;;;;;;;;OAQG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAInG;;;;;;;OAOG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI9E;;;;;;;OAOG;IACG,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIhF;;;;;;;;;;OAUG;IACG,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIhF;;;;;;;OAOG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIjF;;;;;;;OAOG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC;IAIjF;;;;;;;;OAQG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAIzF;;;;;;;;;OASG;IACG,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAI/F;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAInG;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,uBAAuB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI3F;;;;;;;;OAQG;IACG,yBAAyB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;CAGhG"}