o2g-node-sdk 1.0.1 → 2.4.1

package/dist/types/types/comlog/query-filter.d.ts

@@ -0,0 +1,79 @@
+import { FilterOption } from './filter-option';
+import { Role } from './role';
+/**
+ * Represents a filter used to query communication log records.
+ * <p>
+ * This filter can be applied when retrieving records via
+ * {@link CommunicationLog.getComRecords}. All parameters are optional —
+ * omitted parameters are not applied to the query.
+ * <p>
+ * The filter allows specifying:
+ * <ul>
+ *   <li>a date range (`after` / `before`)</li>
+ *   <li>a call reference</li>
+ *   <li>a remote party identifier</li>
+ *   <li>a participant role</li>
+ *   <li>additional search options (e.g. unanswered calls)</li>
+ * </ul>
+ *
+ * @example
+ * ```typescript
+ * // Filter unanswered records in January 2026
+ * const filter = new QueryFilter({
+ *     after: new Date('2026-01-01'),
+ *     before: new Date('2026-01-31'),
+ *     options: [FilterOption.UNANSWERED]
+ * });
+ *
+ * const result = await O2G.comlog.getComRecords(filter);
+ *
+ * // Filter by call reference and role
+ * const filter2 = new QueryFilter({
+ *     callRef: '12345',
+ *     role: Role.CALLER
+ * });
+ * ```
+ *
+ * @see CommunicationLog.getComRecords
+ */
+export declare class QueryFilter {
+    #private;
+    /**
+     * Creates a new `QueryFilter`.
+     *
+     * @param params optional filter parameters
+     */
+    constructor(params: {
+        after?: Date;
+        before?: Date;
+        options?: Set<FilterOption> | FilterOption[];
+        callRef?: string;
+        remotePartyId?: string;
+        role?: Role;
+    });
+    /**
+     * The start date of the query filter — records created after this date are included.
+     */
+    get after(): Date | null;
+    /**
+     * The end date of the query filter — records created before this date are included.
+     */
+    get before(): Date | null;
+    /**
+     * The set of filter options applied to the query (e.g. unanswered calls only).
+     */
+    get options(): ReadonlySet<FilterOption>;
+    /**
+     * The call reference used for filtering.
+     */
+    get callRef(): string | null;
+    /**
+     * The remote party identifier used for filtering.
+     */
+    get remotePartyId(): string | null;
+    /**
+     * The participant role used for filtering.
+     */
+    get role(): Role;
+}
+//# sourceMappingURL=query-filter.d.ts.map

package/dist/types/types/comlog/query-filter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-filter.d.ts","sourceRoot":"","sources":["../../../../src/types/comlog/query-filter.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,qBAAa,WAAW;;IAQpB;;;;OAIG;gBACS,MAAM,EAAE;QAChB,KAAK,CAAC,EAAE,IAAI,CAAC;QACb,MAAM,CAAC,EAAE,IAAI,CAAC;QACd,OAAO,CAAC,EAAE,GAAG,CAAC,YAAY,CAAC,GAAG,YAAY,EAAE,CAAC;QAC7C,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,IAAI,CAAC,EAAE,IAAI,CAAC;KACf;IASD;;OAEG;IACH,IAAI,KAAK,IAAI,IAAI,GAAG,IAAI,CAEvB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,IAAI,GAAG,IAAI,CAExB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,WAAW,CAAC,YAAY,CAAC,CAEvC;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,MAAM,GAAG,IAAI,CAE3B;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,MAAM,GAAG,IAAI,CAEjC;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,IAAI,CAEf;CACJ"}

package/dist/types/types/comlog/query-result.d.ts

@@ -0,0 +1,55 @@
+import { ComRecord } from './com-record';
+import { Page } from './page';
+/**
+ * `QueryResult` represents the result of a communication log query.
+ *
+ * Instances of this class contain the records returned by a query, along with
+ * paging information and the total count of matching records.
+ *
+ * The associated {@link Page} object provides details about the current page,
+ * including the offset and limit, and can be used to navigate through pages
+ * of results.
+ *
+ * Each `QueryResult` contains:
+ * - The total number of records matching the query (`count`)
+ * - Paging information for the current result set (`page`)
+ * - The list of communication records (`records`)
+ *
+ * <p><b>Usage example:</b></p>
+ *
+ * ```ts
+ * const result: QueryResult = QueryResult.fromJson(rawJson);
+ *
+ * console.log(result.count);     // total number of matching records
+ * console.log(result.page.offset); // current page offset
+ * console.log(result.records);   // array of ComRecord objects
+ * ```
+ *
+ * <p>
+ * Instances are immutable. The `fromJson` static method should be used
+ * to create a `QueryResult` from raw JSON returned by the O2G API.
+ * </p>
+ *
+ * @see CommunicationLogService#getComRecords
+ */
+export declare class QueryResult {
+    #private;
+    /**
+     * Returns the total number of records in this result.
+     *
+     * @return the number of records
+     */
+    get count(): number;
+    /**
+     * Returns the page information associated with this result.
+     * <p>
+     * The {@link Page} object provides the offset and limit used to retrieve
+     * this set of records and can be used to navigate through the pages.
+     *
+     * @return the page
+     */
+    get page(): Page;
+    /** Gets the list of communication records returned by the query. */
+    get records(): ComRecord[];
+}
+//# sourceMappingURL=query-result.d.ts.map

package/dist/types/types/comlog/query-result.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-result.d.ts","sourceRoot":"","sources":["../../../../src/types/comlog/query-result.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,qBAAa,WAAW;;IAcpB;;;;OAIG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;;;;;;OAOG;IACH,IAAI,IAAI,IAAI,IAAI,CAEf;IAED,oEAAoE;IACpE,IAAI,OAAO,IAAI,SAAS,EAAE,CAEzB;CAeJ"}

package/dist/types/{comlog → types/comlog}/reason.d.ts

@@ -59,3 +59,4 @@ export declare enum Reason {
      */
     UNKNOWN = "UNKNOWN"
 }
+//# sourceMappingURL=reason.d.ts.map

package/dist/types/types/comlog/reason.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reason.d.ts","sourceRoot":"","sources":["../../../../src/types/comlog/reason.ts"],"names":[],"mappings":"AAmBA;;GAEG;AACH,oBAAY,MAAM;IACd;;OAEG;IACH,cAAc,mBAAmB;IAEjC;;OAEG;IACH,cAAc,mBAAmB;IAEjC;;OAEG;IACH,SAAS,cAAc;IAEvB;;OAEG;IACH,IAAI,SAAS;IAEb;;OAEG;IACH,WAAW,gBAAgB;IAE3B;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,SAAS,cAAc;IAEvB;;OAEG;IACH,UAAU,eAAe;IAEzB;;OAEG;IACH,oBAAoB,yBAAyB;IAE7C;;OAEG;IACH,WAAW,gBAAgB;IAE3B;;OAEG;IACH,oBAAoB,yBAAyB;IAE7C;;OAEG;IACH,SAAS,cAAc;IAEvB;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,OAAO,YAAY;CACtB"}

package/dist/types/{comlog → types/comlog}/role.d.ts

@@ -15,3 +15,4 @@ export declare enum Role {
      */
     UNKNOWN = "UNKNOWN"
 }
+//# sourceMappingURL=role.d.ts.map

package/dist/types/types/comlog/role.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"role.d.ts","sourceRoot":"","sources":["../../../../src/types/comlog/role.ts"],"names":[],"mappings":"AAmBA;;GAEG;AACH,oBAAY,IAAI;IACZ;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,OAAO,YAAY;CACtB"}

package/dist/types/types/common/date-range.d.ts

@@ -0,0 +1,17 @@
+/**
+ * DateRange represents an interval between two dates.
+ */
+export declare class DateRange {
+    #private;
+    /**
+     * Constructs a new DateRange, with the specified "from" date and "to" date.
+     * @param from the beginning of the range
+     * @param to the end of the range
+     */
+    constructor(from: Date, to: Date);
+    /** Returns the "from" date. */
+    get from(): Date;
+    /** Returns the "to" date. */
+    get to(): Date;
+}
+//# sourceMappingURL=date-range.d.ts.map

package/dist/types/types/common/date-range.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"date-range.d.ts","sourceRoot":"","sources":["../../../../src/types/common/date-range.ts"],"names":[],"mappings":"AAmBA;;GAEG;AACH,qBAAa,SAAS;;IAIlB;;;;OAIG;gBACS,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI;IAQhC,+BAA+B;IAC/B,IAAI,IAAI,IAAI,IAAI,CAEf;IAED,6BAA6B;IAC7B,IAAI,EAAE,IAAI,IAAI,CAEb;CACJ"}

package/dist/types/types/common/day-of-week.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Defines the day of a week.
+ */
+export declare enum DayOfWeek {
+    MONDAY = "MONDAY",
+    TUESDAY = "TUESDAY",
+    WEDNESDAY = "WEDNESDAY",
+    THURSDAY = "THURSDAY",
+    FRIDAY = "FRIDAY",
+    SATURDAY = "SATURDAY",
+    SUNDAY = "SUNDAY"
+}
+export declare namespace DayOfWeek {
+}
+//# sourceMappingURL=day-of-week.d.ts.map

package/dist/types/types/common/day-of-week.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"day-of-week.d.ts","sourceRoot":"","sources":["../../../../src/types/common/day-of-week.ts"],"names":[],"mappings":"AAqBA;;GAEG;AACH,oBAAY,SAAS;IACjB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,MAAM,WAAW;CACpB;AAGD,yBAAiB,SAAS,CAAC;CAoC1B"}

package/dist/types/types/common/device-type.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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"
+}
+//# sourceMappingURL=device-type.d.ts.map

package/dist/types/types/common/device-type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-type.d.ts","sourceRoot":"","sources":["../../../../src/types/common/device-type.ts"],"names":[],"mappings":"AAmBA;;GAEG;AACH,oBAAY,UAAU;IAClB;;OAEG;IACH,IAAI,SAAS;IAEb;;OAEG;IACH,SAAS,cAAc;IAEvB;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,SAAS,cAAc;CAC1B"}

package/dist/types/types/common/device.d.ts

@@ -0,0 +1,75 @@
+import { DeviceType } from './device-type';
+/**
+ * Represents a telephony device for a user.
+ */
+export declare class Device {
+    #private;
+    /**
+     * Private constructor. Use `Device.fromJson()` to create instances.
+     * @param type - The device type
+     * @param id - The device identifier
+     * @param subType - Optional device sub-type
+     */
+    private constructor();
+    /** Get the device type */
+    get type(): DeviceType | null;
+    /** Get the device identifier */
+    get id(): string | null;
+    /** Get the device sub-type, if any */
+    get subType(): string | null;
+}
+/**
+ * Namespace for device-related types.
+ */
+export declare namespace Device {
+    /**
+     * Represents the capabilities of a device.
+     *
+     * Each device has a unique `deviceId` and may support various telephony
+     * operations, such as making calls, business calls, private calls, or
+     * unparking calls. Use `Capabilities.fromJson()` to create instances
+     * from JSON data.
+     */
+    class Capabilities {
+        #private;
+        /**
+         * Private constructor. Use `Capabilities.fromJson()` to create instances.
+         *
+         * @param deviceId - The unique identifier of the device
+         * @param makeCall - Whether the device can make a call
+         * @param makeBusinessCall - Whether the device can make a business call
+         * @param makePrivateCall - Whether the device can make a private call
+         * @param unParkCall - Whether the device can unpark a call
+         */
+        private constructor();
+        /**
+         * Returns the unique identifier of the device.
+         */
+        get deviceId(): string;
+        /**
+         * Indicates whether the device can make a regular call.
+         *
+         * @returns `true` if the device can make calls; otherwise `false` (default `false`)
+         */
+        get canMakeCall(): boolean;
+        /**
+         * Indicates whether the device can make a business call.
+         *
+         * @returns `true` if the device can make business calls; otherwise `false` (default `false`)
+         */
+        get canMakeBusinessCall(): boolean;
+        /**
+         * Indicates whether the device can make a private call.
+         *
+         * @returns `true` if the device can make private calls; otherwise `false` (default `false`)
+         */
+        get canMakePrivateCall(): boolean;
+        /**
+         * Indicates whether the device can unpark a call.
+         *
+         * @returns `true` if the device can unpark calls; otherwise `false` (default `false`)
+         */
+        get canUnParkCall(): boolean;
+    }
+}
+//# sourceMappingURL=device.d.ts.map

package/dist/types/types/common/device.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"device.d.ts","sourceRoot":"","sources":["../../../../src/types/common/device.ts"],"names":[],"mappings":"AAqBA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C;;GAEG;AACH,qBAAa,MAAM;;IAKf;;;;;OAKG;IACH,OAAO;IAMP,0BAA0B;IAC1B,IAAI,IAAI,IAAI,UAAU,GAAG,IAAI,CAE5B;IAED,gCAAgC;IAChC,IAAI,EAAE,IAAI,MAAM,GAAG,IAAI,CAEtB;IAED,sCAAsC;IACtC,IAAI,OAAO,IAAI,MAAM,GAAG,IAAI,CAE3B;CAWJ;AAED;;GAEG;AACH,yBAAiB,MAAM,CAAC;IACpB;;;;;;;OAOG;IACH,MAAa,YAAY;;QAOrB;;;;;;;;WAQG;QACH,OAAO;QAcP;;WAEG;QACH,IAAI,QAAQ,IAAI,MAAM,CAErB;QAED;;;;WAIG;QACH,IAAI,WAAW,IAAI,OAAO,CAEzB;QAED;;;;WAIG;QACH,IAAI,mBAAmB,IAAI,OAAO,CAEjC;QAED;;;;WAIG;QACH,IAAI,kBAAkB,IAAI,OAAO,CAEhC;QAED;;;;WAIG;QACH,IAAI,aAAa,IAAI,OAAO,CAE3B;KAmBJ;CACJ"}

package/dist/types/types/common/identifier.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Represents the information used to uniquely identify a participant; either the login name or the phone number.
+ */
+export declare class Identifier {
+    #private;
+    private constructor();
+    /**
+     * Returns the login name of the participant.
+     *
+     * @return the login name, or `null` if not available
+     */
+    get loginName(): string | null;
+    /**
+     * Returns the phone number of the participant.
+     *
+     * @return the phone number, or `null` if not available
+     */
+    get phoneNumber(): string | null;
+}
+//# sourceMappingURL=identifier.d.ts.map

package/dist/types/types/common/identifier.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"identifier.d.ts","sourceRoot":"","sources":["../../../../src/types/common/identifier.ts"],"names":[],"mappings":"AAqBA;;GAEG;AACH,qBAAa,UAAU;;IAInB,OAAO;IAKP;;;;OAIG;IACH,IAAI,SAAS,IAAI,MAAM,GAAG,IAAI,CAE7B;IAED;;;;OAIG;IACH,IAAI,WAAW,IAAI,MAAM,GAAG,IAAI,CAE/B;CAWJ"}

package/dist/types/types/common/main-type.d.ts

@@ -0,0 +1,26 @@
+/**
+ * MainType represents the main type a participant can be.
+ */
+export declare enum MainType {
+    /**
+     * The participant is a user of the system.
+     */
+    USER = "USER",
+    /**
+     * The participant is a device of the system.
+     */
+    DEVICE = "DEVICE",
+    /**
+     * The participant is a service of the system. For exemple the voice mail.
+     */
+    SERVICE = "SERVICE",
+    /**
+     * The participant is not a user of the system.
+     */
+    EXTERNAL = "EXTERNAL",
+    /**
+     * The participant type has not been identified.
+     */
+    UNKNOWN = "UNKNOWN"
+}
+//# sourceMappingURL=main-type.d.ts.map

package/dist/types/types/common/main-type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main-type.d.ts","sourceRoot":"","sources":["../../../../src/types/common/main-type.ts"],"names":[],"mappings":"AAmBA;;GAEG;AACH,oBAAY,QAAQ;IAChB;;OAEG;IACH,IAAI,SAAS;IAEb;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,QAAQ,aAAa;IAErB;;OAEG;IACH,OAAO,YAAY;CACtB"}

package/dist/types/types/common/party-info-type.d.ts

@@ -0,0 +1,22 @@
+import { MainType } from './main-type';
+/**
+ * Represents the type of a party in a call, composed of a main type and an
+ * optional sub-type.
+ * <p>
+ * Available via {@link PartyInfo.type} on call participants and party information.
+ *
+ * @see PartyInfo
+ */
+export declare class PartyInfoType {
+    #private;
+    /**
+     * The main type of this party.
+     */
+    get main(): MainType;
+    /**
+     * The sub-type of this party, providing additional classification.
+     * `null` if no sub-type is defined.
+     */
+    get subType(): string | null;
+}
+//# sourceMappingURL=party-info-type.d.ts.map

package/dist/types/types/common/party-info-type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"party-info-type.d.ts","sourceRoot":"","sources":["../../../../src/types/common/party-info-type.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC;;;;;;;GAOG;AACH,qBAAa,aAAa;;IAYtB;;OAEG;IACH,IAAI,IAAI,IAAI,QAAQ,CAEnB;IAED;;;OAGG;IACH,IAAI,OAAO,IAAI,MAAM,GAAG,IAAI,CAE3B;CAQJ"}

package/dist/types/types/common/party-info.d.ts

@@ -0,0 +1,28 @@
+import { Identifier } from './identifier';
+import { PartyInfoType } from './party-info-type';
+/**
+ * Represents a party involved in a call.
+ */
+export declare class PartyInfo {
+    #private;
+    /**
+     * Private constructor. Use `PartyInfo.fromJson()` to create instances.
+     * @param id - Participant identifier
+     * @param firstName - First name
+     * @param lastName - Last name
+     * @param displayName - Display name
+     * @param type - Participant type
+     */
+    private constructor();
+    /** Get the participant identifier */
+    get id(): Identifier;
+    /** Get the participant's first name */
+    get firstName(): string | null;
+    /** Get the participant's last name */
+    get lastName(): string | null;
+    /** Get the participant's display name */
+    get displayName(): string | null;
+    /** Get the participant's type */
+    get type(): PartyInfoType | null;
+}
+//# sourceMappingURL=party-info.d.ts.map

package/dist/types/types/common/party-info.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"party-info.d.ts","sourceRoot":"","sources":["../../../../src/types/common/party-info.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElD;;GAEG;AACH,qBAAa,SAAS;;IAOlB;;;;;;;OAOG;IACH,OAAO;IAcP,qCAAqC;IACrC,IAAI,EAAE,IAAI,UAAU,CAEnB;IAED,uCAAuC;IACvC,IAAI,SAAS,IAAI,MAAM,GAAG,IAAI,CAE7B;IAED,sCAAsC;IACtC,IAAI,QAAQ,IAAI,MAAM,GAAG,IAAI,CAE5B;IAED,yCAAyC;IACzC,IAAI,WAAW,IAAI,MAAM,GAAG,IAAI,CAE/B;IAED,iCAAiC;IACjC,IAAI,IAAI,IAAI,aAAa,GAAG,IAAI,CAE/B;CAiBJ"}

package/dist/types/types/common/service-state.d.ts

@@ -0,0 +1,20 @@
+/**
+ * ServiceState represents the possible operational states of a CCD entity,
+ * such as a pilot, queue, or processing group.
+ *
+ * The service state indicates whether the entity is available to handle calls or
+ * otherwise engaged.
+ *
+ * @since 2.7.4
+ */
+export declare enum ServiceState {
+    /** The service is closed and not available for call handling. */
+    Closed = "Closed",
+    /** The service is opened and available to handle calls. */
+    Opened = "Opened",
+    /** The service is blocked and temporarily unavailable. */
+    Blocked = "Blocked",
+    /** The state of the service is unknown. */
+    Unknown = "unknown"
+}
+//# sourceMappingURL=service-state.d.ts.map

package/dist/types/types/common/service-state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service-state.d.ts","sourceRoot":"","sources":["../../../../src/types/common/service-state.ts"],"names":[],"mappings":"AAmBA;;;;;;;;GAQG;AACH,oBAAY,YAAY;IACpB,iEAAiE;IACjE,MAAM,WAAW;IAEjB,2DAA2D;IAC3D,MAAM,WAAW;IAEjB,0DAA0D;IAC1D,OAAO,YAAY;IAEnB,2CAA2C;IAC3C,OAAO,YAAY;CACtB"}

package/dist/types/types/directory/criteria.d.ts

@@ -0,0 +1,95 @@
+import { FilterItem } from './filter-item';
+import { OperationFilter } from './operation-filter';
+/**
+ * Represents a filter criteria to apply on a directory search.
+ *
+ * A simple criteria is a tuple of the form: `[Attribute, Operation, Value]`.
+ * Example: `[LAST_NAME, BEGINS_WITH, "fr"]`.
+ *
+ * A `Criteria` can also be a logical combination (AND / OR) of multiple other `Criteria` objects.
+ *
+ * ## Acceptable values for attributes
+ * | Value        | Description         |
+ * |--------------|---------------------|
+ * | LAST_NAME    | The last name       |
+ * | FIRST_NAME   | The first name      |
+ * | LOGIN_NAME   | The login name      |
+ * | PHONE_NUMBER | The phone number    |
+ *
+ * ## Acceptable values for operations
+ * | Value            | Description                                         |
+ * |------------------|-----------------------------------------------------|
+ * | BEGINS_WITH      | Attribute must begin with the given value           |
+ * | ENDS_WITH        | Attribute must end with the given value             |
+ * | CONTAINS         | Attribute must contain the given value              |
+ * | EQUAL_IGNORE_CASE| Attribute equals the value (case-insensitive)       |
+ *
+ * ## Examples
+ * ```ts
+ * // Search users whose last name begins with 'b'
+ * const criteria = Criteria.create(
+ *     FilterItem.LAST_NAME,
+ *     OperationFilter.BEGINS_WITH,
+ *     'b'
+ * );
+ *
+ * // Search users whose last name begins with 'b' AND first name contains 'ja'
+ * const criteria2 = Criteria.and(
+ *     Criteria.create(
+ *         FilterItem.LAST_NAME,
+ *         OperationFilter.BEGINS_WITH,
+ *         'b'
+ *     ),
+ *     Criteria.create(
+ *         FilterItem.FIRST_NAME,
+ *         OperationFilter.CONTAINS,
+ *         'ja'
+ *     )
+ * );
+ * ```
+ */
+export declare class Criteria {
+    #private;
+    /**
+     * Creates a new search `Criteria` with the specified attribute, operation, and value.
+     *
+     * @param field - The attribute to filter
+     * @param operation - The operation to apply
+     * @param value - The value to match
+     * @returns A new `Criteria` instance
+     */
+    static create(field: FilterItem, operation: OperationFilter, value: string): Criteria;
+    /**
+     * Creates a `Criteria` that is the logical OR of multiple criteria.
+     *
+     * @param criterias - One or more `Criteria` objects
+     * @returns A new `Criteria` representing the OR combination
+     */
+    static or(...criterias: Criteria[]): Criteria;
+    /**
+     * Creates a `Criteria` that is the logical AND of multiple criteria.
+     *
+     * @param criterias - One or more `Criteria` objects
+     * @returns A new `Criteria` representing the AND combination
+     */
+    static and(...criterias: Criteria[]): Criteria;
+    /**
+     * Returns the operation of this filter.
+     *
+     * @returns The operation as a string (or "AND"/"OR" for logical combinations)
+     */
+    get operation(): string;
+    /**
+     * Returns the field of this filter.
+     *
+     * @returns The field as a string, or `null` for logical combinations
+     */
+    get field(): string | null;
+    /**
+     * Returns the operand of this `Criteria`.
+     *
+     * @returns The operand value (`string` for single filters, `Criteria[]` for logical combinations)
+     */
+    get operand(): string | Criteria[];
+}
+//# sourceMappingURL=criteria.d.ts.map

package/dist/types/types/directory/criteria.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"criteria.d.ts","sourceRoot":"","sources":["../../../../src/types/directory/criteria.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,qBAAa,QAAQ;;IAmBjB;;;;;;;OAOG;IACH,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,GAAG,QAAQ;IAIrF;;;;;OAKG;IACH,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,QAAQ,EAAE,GAAG,QAAQ;IAI7C;;;;;OAKG;IACH,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,EAAE,QAAQ,EAAE,GAAG,QAAQ;IAI9C;;;;OAIG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;;;OAIG;IACH,IAAI,KAAK,IAAI,MAAM,GAAG,IAAI,CAEzB;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,MAAM,GAAG,QAAQ,EAAE,CAEjC;CAgBJ"}

package/dist/types/{directory → types/directory}/filter-item.d.ts

@@ -5,17 +5,18 @@ export declare enum FilterItem {
     /**
      * The last name.
      */
-    LAST_NAME = 0,
+    LAST_NAME = "lastName",
     /**
      * The first name.
      */
-    FIRST_NAME = 1,
+    FIRST_NAME = "firstName",
     /**
      * The phone number.
      */
-    PHONE_NUMBER = 2,
+    PHONE_NUMBER = "id.phoneNumber",
     /**
      * The login name.
      */
-    LOGIN_NAME = 3
+    LOGIN_NAME = "id.loginName"
 }
+//# sourceMappingURL=filter-item.d.ts.map

package/dist/types/types/directory/filter-item.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter-item.d.ts","sourceRoot":"","sources":["../../../../src/types/directory/filter-item.ts"],"names":[],"mappings":"AAmBA;;GAEG;AACH,oBAAY,UAAU;IAClB;;OAEG;IACH,SAAS,aAAa;IAEtB;;OAEG;IACH,UAAU,cAAc;IAExB;;OAEG;IACH,YAAY,mBAAmB;IAE/B;;OAEG;IACH,UAAU,iBAAiB;CAC9B"}

package/dist/types/types/directory/logical-operation.d.ts

@@ -0,0 +1,14 @@
+/**
+ * LogicalOperation represents a logical operation AND or OR.
+ */
+export declare enum LogicalOperation {
+    /**
+     * The OR logica operation
+     */
+    OR = "OR",
+    /**
+     * The AND logical operation
+     */
+    AND = "AND"
+}
+//# sourceMappingURL=logical-operation.d.ts.map

package/dist/types/types/directory/logical-operation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logical-operation.d.ts","sourceRoot":"","sources":["../../../../src/types/directory/logical-operation.ts"],"names":[],"mappings":"AAmBA;;GAEG;AACH,oBAAY,gBAAgB;IACxB;;OAEG;IACH,EAAE,OAAO;IAET;;OAEG;IACH,GAAG,QAAQ;CACd"}

package/dist/types/{directory → types/directory}/operation-filter.d.ts

@@ -5,17 +5,18 @@ export declare enum OperationFilter {
     /**
      * The attribute and the given value are equals (case insensitive).
      */
-    EQUAL_IGNORE_CASE = 0,
+    EQUAL_IGNORE_CASE = "EQUAL_IGNORE_CASE",
     /**
      * The attribute begins with the value.
      */
-    BEGINS_WITH = 1,
+    BEGINS_WITH = "BEGIN_WITH",
     /**
      * The attribute contains the value.
      */
-    CONTAINS = 2,
+    CONTAINS = "CONTAIN",
     /**
      * The attribute ends with the value.
      */
-    ENDS_WITH = 3
+    ENDS_WITH = "END_WITH"
 }
+//# sourceMappingURL=operation-filter.d.ts.map

package/dist/types/types/directory/operation-filter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"operation-filter.d.ts","sourceRoot":"","sources":["../../../../src/types/directory/operation-filter.ts"],"names":[],"mappings":"AAmBA;;GAEG;AACH,oBAAY,eAAe;IACvB;;OAEG;IACH,iBAAiB,sBAAsB;IAEvC;;OAEG;IACH,WAAW,eAAe;IAE1B;;OAEG;IACH,QAAQ,YAAY;IAEpB;;OAEG;IACH,SAAS,aAAa;CACzB"}

package/dist/types/types/directory/result-item.d.ts

@@ -0,0 +1,22 @@
+import { PartyInfo } from '../common/party-info';
+/**
+ * Represents a single batch of contacts returned from a directory search.
+ *
+ * Each `ResultItem` contains a collection of `PartyInfo` objects representing
+ * the contacts found in that batch.
+ *
+ */
+export declare class ResultItem {
+    #private;
+    private constructor();
+    /**
+     * Returns the contacts found in this batch.
+     *
+     * The returned array is read-only. Modifying the array directly will not
+     * affect the internal state of the `ResultItem`.
+     *
+     * @returns A read-only array of `PartyInfo` objects, or `null` if no contacts are available.
+     */
+    get contacts(): ReadonlyArray<PartyInfo> | null;
+}
+//# sourceMappingURL=result-item.d.ts.map

package/dist/types/types/directory/result-item.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"result-item.d.ts","sourceRoot":"","sources":["../../../../src/types/directory/result-item.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD;;;;;;GAMG;AACH,qBAAa,UAAU;;IAGnB,OAAO;IAIP;;;;;;;OAOG;IACH,IAAI,QAAQ,IAAI,aAAa,CAAC,SAAS,CAAC,GAAG,IAAI,CAE9C;CAWJ"}