o2g-node-sdk 1.0.0

package/dist/types/users/users-types.d.ts

@@ -0,0 +1,129 @@
+/**
+ * Define the device type
+ */
+export declare enum DeviceType {
+    /**
+     * The device is a DECT device
+     */
+    DECT = "DECT",
+    /**
+     * The device is a deskphone
+     */
+    DESKPHONE = "DESKPHONE",
+    /**
+     * The device is a mobile device
+     */
+    MOBILE = "MOBILE",
+    /**
+     * The device is a softphone
+     */
+    SOFTPHONE = "SOFTPHONE"
+}
+/**
+ * Device represents a device of a user.
+ */
+export type Device = {
+    /**
+     * The device type
+     */
+    type: DeviceType;
+    /**
+     * The device identifier which is used to identify the device in telephony requests and events.
+     */
+    id: string;
+    /**
+     * The device sub-type. When set, the device sub-type provide information about the device model.
+     */
+    subType?: string;
+};
+/**
+ * The type of voice mail a user can have
+ */
+export declare enum VoicemailType {
+    /**
+     * Internal 4635 voice mail.
+     */
+    VM_4635 = "VM_4635",
+    /**
+     * Internal 4645 voice mail.
+     */
+    VM_4645 = "VM_4645",
+    /**
+     * External voice mail.
+     */
+    EXTERNAL = "EXTERNAL"
+}
+export type User = {
+    /**
+     * The user company phone. This company phone number is the phone
+     * number of the main device when the user has a multi-device configuration.
+     */
+    companyPhone: string;
+    /**
+     * The user's first name.
+     */
+    firstName: string;
+    /**
+     * The user's last name.
+     */
+    lastName: string;
+    /**
+     * The user's login.
+     */
+    loginName: string;
+    /**
+     * The user's voice mail information.
+     */
+    voicemail: {
+        /**
+         * The voice mail number.
+         */
+        number: string;
+        /**
+         * The voice mail type.
+         */
+        type: VoicemailType;
+    };
+    /**
+     * The user's devices.
+     */
+    devices: Device[];
+    /**
+     * The OmniPCX Enterprise node this user is configured on.
+     */
+    nodeId: number;
+    /**
+     * User external login
+     */
+    externalLogin: string;
+};
+/**
+ * Preferences represents the preferred settings of a user.
+ */
+export type Preferences = {
+    /**
+     * The preferred GUI language. This is the language the user prefers
+     * when it uses an application with a graphical user interface.
+     */
+    guiLanguage: string;
+    /**
+     * The prefered OXE language. This is the language the user prefers when
+     * it uses his phone set.
+     */
+    oxeLanguage: string;
+};
+/**
+ * SupportedLanguages represents the languages supported by a user.
+ *
+ * @see {@link Preferences}.
+ */
+export type SupportedLanguages = {
+    /**
+     * The supported languages.
+     */
+    supportedLanguages: string[];
+    /**
+     * The supported GUI languages.
+     */
+    supportedGuiLanguages: string[];
+};

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "o2g-node-sdk",
+  "version": "1.0.0",
+  "description": "A Node.js library for O2G.",
+  "main": "dist/o2g-node-sdk.js",
+  "scripts": {
+    "tsc": "tsc",
+    "build": "webpack --config webpack.config.js",
+    "docs": "typedoc --options typedoc.json",
+    "clean": "rm -rf dist docs"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "commonjs",
+  "devDependencies": {
+    "@types/node": "^24.0.13",
+    "@types/node-fetch": "^2.6.12",
+    "ts-loader": "^9.5.2",
+    "typedoc": "^0.28.7",
+    "typescript": "^5.8.3",
+    "webpack": "^5.100.1",
+    "webpack-cli": "^6.0.1"
+  },
+  "dependencies": {
+    "fetch-cookie": "^3.1.0",
+    "inversify": "^7.6.1",
+    "node-fetch": "^3.3.2",
+    "reflect-metadata": "^0.2.2",
+    "tough-cookie": "^5.1.2",
+    "uuid": "^11.1.0"
+  }
+}