o2g-node-sdk 1.0.0 → 2.4.0

package/dist/types/analytics/time-range.d.ts

@@ -1,22 +0,0 @@
-/**
- * TimeRange represents an interval between two dates. It is used to filter analytics requests.
- * @see {@link Analytics.getChargingsFromFilter} and {@link Analytics.getChargingFiles}
- */
-export declare class TimeRange {
-    private _from;
-    private _to;
-    /**
-     * Construct a new TimeRange, with the specified "from" date and "to" date.
-     * @param from the begining 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;
-}

package/dist/types/cc-agent/cc-agent-events.d.ts

@@ -1,54 +0,0 @@
-import { O2GEvent } from "../../internal/events/o2g-event";
-import { AgentSkill, OperatorState } from "./cc-agent-types";
-/**
- * Event sent when CCD agent skills is modified: one or several skills has been activate or deactivate.
- */
-export type OnAgentSkillChanged = O2GEvent<'OnAgentSkillChanged', {
-    /**
-     * Login name of the user receiving the event.
-     */
-    loginName: string;
-    /**
-     * Set of skills of the agent (the event contains the whole set).
-     */
-    skills: AgentSkill[];
-}>;
-/**
- * Event sent when CCD operator state is modified.
- */
-export type OnAgentStateChanged = O2GEvent<'OnAgentStateChanged', {
-    /**
-     * Login name of the user receiving the event.
-     */
-    loginName: string;
-    /**
-     * CCD operator state.
-     */
-    state: OperatorState;
-}>;
-/**
- * Event sent after an CCD agent has requested the assistance of its supervisor and when the request is canceled by the agent or when the request is rejected by the supervisor.
- */
-export type OnSupervisorHelpCancelled = O2GEvent<'OnSupervisorHelpCancelled', {
-    /**
-     * Login name of the user receiving the event.
-     */
-    loginName: string;
-    /**
-     * On the agent, the number of the supervisor which the help has been initially requested.
-     */
-    agentNumber: string;
-}>;
-/**
- * Event sent when an CCD agent requests the assistance of its supervisor.
- */
-export type OnSupervisorHelpRequested = O2GEvent<'OnSupervisorHelpRequested', {
-    /**
-     * Login name of the user receiving the event.
-     */
-    loginName: string;
-    /**
-     * On the agent, the number of the supervisor which the help has been requested.
-     */
-    agentNumber: string;
-}>;

package/dist/types/cc-agent/cc-agent-types.d.ts

@@ -1,71 +0,0 @@
-import { OperatorDynamicState } from "./operator-dyn-state";
-import { OperatorMainState } from "./operator-main-state";
-import { OperatorType } from "./operator-type";
-/**
- * Represents a CCD operator skill.
- * Skills are used by the "Advanced Call Routing" strategy.
- */
-export interface AgentSkill {
-    /** Unique identifier of this skill */
-    number: number;
-    /** Skill level */
-    level: number;
-    /** Whether the skill is active */
-    active: boolean;
-}
-/**
- * Represents the group configuration of a CCD operator.
- */
-export interface AgentGroups {
-    /** Preferred agent group */
-    preferred: string;
-    /** All agent groups the operator is part of */
-    groups: string[];
-}
-/**
- * Represents the configuration of a CCD operator.
- */
-export interface OperatorConfig {
-    /** Operator type: agent or supervisor */
-    type: OperatorType;
-    /** Associated pro-acd station */
-    proacd: string;
-    /** Groups the operator belongs to */
-    groups: AgentGroups;
-    /** Whether the operator can choose their agent group */
-    selfAssign: boolean;
-    /** Operator's skill set mapped by skill number */
-    skills: Map<number, AgentSkill>;
-    /** Whether headset feature is enabled */
-    headset: boolean;
-    /** Whether help request to supervisor is enabled */
-    help: boolean;
-    /** Whether the operator is multiline */
-    multiline: boolean;
-}
-/**
- * Represents the state of a CCD operator.
- */
-export interface OperatorState {
-    /** Static (main) state */
-    mainState: OperatorMainState;
-    /** Dynamic (sub) state */
-    subState: OperatorDynamicState;
-    /** Device number of the pro-acd the operator is logged into */
-    proAcdDeviceNumber: string;
-    /** Agent group the operator is currently logged into */
-    pgNumber: string;
-    /** Reason index for withdrawal, if applicable */
-    withdrawReason?: number;
-    /** Whether the operator is in withdrawal state */
-    withdraw: boolean;
-}
-/**
- * Represents a reason for agent withdrawal used in statistics.
- */
-export interface WithdrawReason {
-    /** Index of the reason */
-    index: number;
-    /** Human-readable label for the reason */
-    label: string;
-}

package/dist/types/cc-agent/intrusion-mode.d.ts

@@ -1,24 +0,0 @@
-/**
- * IntrusionMode represents the possible intrusion mode.
- * <p>
- * A supervisor can intrude in an established CCD call. The intrusion depends on the IntrusionMode.
- * @see {@link CallCenterAgent.requestIntrusion}
- */
-export declare enum IntrusionMode {
-    /**
-     * The supervisor can talk to both the agent and the remote customer.
-     */
-    NORMAL = "NORMAL",
-    /**
-    * The supervisor can only talk to the agent but listen to the remote customer.
-    */
-    RESTRICTED = "RESTRICTED",
-    /**
-     * The supervisor only listens to the conversation between agent and customer.
-     */
-    DISCRETE = "DISCRETE",
-    /**
-     * The supervisor stops the intrusion
-     */
-    STOP = "STOP"
-}

package/dist/types/cc-agent/operator-dyn-state.d.ts

@@ -1,56 +0,0 @@
-/**
- * OperatorDynamicState represents the CCD operator dynamic state.
- */
-export declare enum OperatorDynamicState {
-    /**
-     * The operator is ready.
-     */
-    READY = "READY",
-    /**
-     * The operator is logged but out of an agent group.
-     */
-    OUT_OF_PG = "OUT_OF_PG",
-    /**
-     * The operator is busy.
-     */
-    BUSY = "BUSY",
-    /**
-     * The operator is in the transaction code phase.
-     */
-    TRANSACTION_CODE_INPUT = "TRANSACTION_CODE_INPUT",
-    /**
-     * The operator is in the automatic wrapup phase.
-     */
-    WRAPUP = "WRAPUP",
-    /**
-     * The operator is in pause.
-     */
-    PAUSE = "PAUSE",
-    /**
-     * The operator is in withdraw from the call distribution.
-     */
-    WITHDRAW = "WITHDRAW",
-    /**
-     * The operator is in withdraw from the call distribution because he is treating
-     * an IM.
-     */
-    WRAPUP_IM = "WRAPUP_IM",
-    /**
-     * The operator is in withdraw from the call distribution because he is treating
-     * an email.
-     */
-    WRAPUP_EMAIL = "WRAPUP_EMAIL",
-    /**
-     * The operator is in withdraw from the call distribution because he is treating
-     * an email, nevertheless, a CCD call can be distributed on this operator.
-     */
-    WRAPUP_EMAIL_INTERRUPTIBLE = "WRAPUP_EMAIL_INTERRUPTIBLE",
-    /**
-     * The operator is in wrapup after an outbound call.
-     */
-    WRAPUP_OUTBOUND = "WRAPUP_OUTBOUND",
-    /**
-     * The operator is in wrapup after a callback call.
-     */
-    WRAPUP_CALLBACK = "WRAPUP_CALLBACK"
-}

package/dist/types/cc-agent/operator-main-state.d.ts

@@ -1,21 +0,0 @@
-/**
- * OperatorMainState represents the login, logoff status of a CCD operator.
- */
-export declare enum OperatorMainState {
-    /**
-     * The O2G server is unable to get the operator main state.
-     */
-    UNKNOWN = "UNKNOWN",
-    /**
-     * The operator is logged on a pro-acd set.
-     */
-    LOG_ON = "LOG_ON",
-    /**
-     * The operator is logged off.
-     */
-    LOG_OFF = "LOG_OFF",
-    /**
-     * Error status.
-     */
-    ERROR = "ERROR"
-}

package/dist/types/cc-agent/operator-type.d.ts

@@ -1,16 +0,0 @@
-/**
- * OperatorType represents the CCD operator, either Agent or Supervisor.
- */
-export declare enum OperatorType {
-    /**
-     * CCD Agent.
-     */
-    AGENT = "AGENT",
-    /**
-     * CCD Supervisor.
-     */
-    SUPERVISOR = "SUPERVISOR"
-}
-export declare namespace OperatorType {
-    function isOperatorType(value: string): value is OperatorType;
-}

package/dist/types/cc-mngt/calendar/abstract-calendar.d.ts

@@ -1,7 +0,0 @@
-import { Transition } from "./transition";
-export declare abstract class AbstractCalendar<T> {
-    protected transitions: Map<T, Transition[]>;
-    constructor(transitions: Map<T, Transition[]>);
-    protected _getTransitions(element: T): Transition[] | undefined;
-    protected _getItemAt(element: T, index: number): Transition | undefined;
-}

package/dist/types/cc-mngt/calendar/calendar.d.ts

@@ -1,19 +0,0 @@
-import { ExceptionCalendar } from "./exception-calendar";
-import { NormalCalendar } from "./normal-calendar";
-/**
- * Represents a calendar associated with a CCD pilot.
- *
- * A calendar consists of:
- * - A normal calendar: defines pilot behavior for each day of the week (up to 10 time slots per day).
- * - An exception calendar: overrides normal days with special rules (e.g., holidays).
- */
-export interface Calendar {
-    /**
-     * A set of transitions defined for each day of the week.
-     */
-    normalDays: NormalCalendar | null;
-    /**
-     * A collection of exception days with their own transitions.
-     */
-    exceptionDays: ExceptionCalendar | null;
-}

package/dist/types/cc-mngt/calendar/day-of-week.d.ts

@@ -1,33 +0,0 @@
-/**
- * Defines the day of a week.
- */
-export declare enum DayOfWeek {
-    /**
-     * The day-of-week of Monday.
-     */
-    MONDAY = "MONDAY",
-    /**
-     * The day-of-week of Tuesday.
-     */
-    TUESDAY = "TUESDAY",
-    /**
-     * The day-of-week of Wednesday.
-     */
-    WEDNESDAY = "WEDNESDAY",
-    /**
-     * The day-of-week of Thursday.
-     */
-    THURSDAY = "THURSDAY",
-    /**
-     * The day-of-week of Friday.
-     */
-    FRIDAY = "FRIDAY",
-    /**
-     * The day-of-week of Saturday.
-     */
-    SATURDAY = "SATURDAY",
-    /**
-     * The day-of-week of Sunday.
-     */
-    SUNDAY = "SUNDAY"
-}

package/dist/types/cc-mngt/calendar/exception-calendar.d.ts

@@ -1,26 +0,0 @@
-import { AbstractCalendar } from "./abstract-calendar";
-import { Transition } from "./transition";
-/**
- * Represents the exceptional calendar associated with a CCD pilot.
- *
- * This calendar defines special days (like holidays) that override the normal calendar behavior.
- * Each exceptional day can have up to 10 transitions (time slots).
- */
-export declare class ExceptionCalendar extends AbstractCalendar<Date> {
-    constructor(transitions: Map<Date, Transition[]>);
-    /**
-     * Get the set of exceptional dates in this calendar.
-     */
-    getExceptionDates(): Set<Date>;
-    /**
-     * Get a specific transition for an exceptional date and index.
-     * @param date the date
-     * @param index Index of the transition (0-9)
-     */
-    getTransitionAt(date: Date, index: number): Transition | undefined;
-    /**
-     * Get all transitions for a given exceptional date.
-     * @param date the date
-     */
-    getTransitions(date: Date): Transition[];
-}

package/dist/types/cc-mngt/calendar/normal-calendar.d.ts

@@ -1,27 +0,0 @@
-import { AbstractCalendar } from "./abstract-calendar";
-import { DayOfWeek } from "./day-of-week";
-import { Transition } from "./transition";
-/**
- * Represents the normal calendar associated with a CCD pilot.
- *
- * The normal calendar defines pilot behavior for each day of the week.
- * You can define up to 10 time slots per day, for a maximum of 70 per week.
- */
-export declare class NormalCalendar extends AbstractCalendar<DayOfWeek> {
-    constructor(transitions: Map<DayOfWeek, Transition[]>);
-    /**
-     * Get the set of days of week that have transitions configured.
-     */
-    getDays(): Set<DayOfWeek>;
-    /**
-     * Get a specific transition by day and index.
-     * @param day The day of the week
-     * @param index The transition index
-     */
-    getTransitionAt(day: DayOfWeek, index: number): Transition | undefined;
-    /**
-     * Get all transitions for a specific day.
-     * @param day The day of the week
-     */
-    getTransitions(day: DayOfWeek): Transition[];
-}

package/dist/types/cc-mngt/calendar/transition.d.ts

@@ -1,49 +0,0 @@
-/**
- * Represents the possible operating modes of a CCD pilot.
- */
-export declare enum PilotOperatingMode {
-    /**
-     * The pilot operates in normal (opened) mode.
-     */
-    NORMAL = "NORMAL",
-    /**
-     * The pilot operates in closed mode.
-     */
-    CLOSED = "CLOSED",
-    /**
-     * The pilot operates in forward mode.
-     */
-    FORWARD = "FORWARD"
-}
-/**
- * Represents a transition in a CCD pilot calendar.
- */
-export interface Transition {
-    /**
-     * The pilot rule number associated with this transition.
-     */
-    ruleNumber: number;
-    /**
-     * The mode in which the pilot is operating during this transition.
-     */
-    mode: PilotOperatingMode;
-    /**
-     * The start time of this transition during the day.
-     */
-    time: Transition.Time;
-}
-export declare namespace Transition {
-    /**
-     * Represents the starting time of a transition in a pilot calendar.
-     * Time is in 24-hour format.
-     */
-    class Time {
-        private _hour;
-        private _minute;
-        constructor(_hour: number, _minute: number);
-        get hour(): number;
-        get minute(): number;
-        toString(): string;
-        static parse(value: string): Time;
-    }
-}

package/dist/types/cc-mngt/pilot-rule-set.d.ts

@@ -1,27 +0,0 @@
-import { PilotRule } from "./pilot-rule";
-export declare class PilotRuleSet {
-    private rules;
-    protected constructor(rules: Map<number, PilotRule>);
-    /**
-     * Returns the rule with the specified number.
-     * @param number The rule number
-     * @returns The pilot rule with the specified number or undefined if not found.
-     */
-    get(number: number): PilotRule | undefined;
-    /**
-     * Determines whether the specified rule exists in this rule set.
-     * @param number The rule number to search
-     * @returns true if the rule is present; false otherwise.
-     */
-    contains(number: number): boolean;
-    /**
-     * Returns the set of rule numbers contained in this rule set.
-     * @returns A Set containing the rule numbers.
-     */
-    getRulesNumbers(): Set<number>;
-    /**
-     * Returns the rules in this rule set.
-     * @returns A collection (array) of PilotRule.
-     */
-    getRules(): PilotRule[];
-}

package/dist/types/cc-mngt/pilot-rule.d.ts

@@ -1,14 +0,0 @@
-export declare class PilotRule {
-    private _number;
-    private _name;
-    private _active;
-    private constructor();
-    get number(): number;
-    get name(): string;
-    get active(): boolean;
-    static build(obj: {
-        number: number;
-        name: string;
-        active: boolean;
-    }): PilotRule;
-}

package/dist/types/cc-mngt/pilot.d.ts

@@ -1,56 +0,0 @@
-import { PilotRuleSet } from "./pilot-rule-set";
-export declare class Pilot {
-    private _number;
-    private _name;
-    private _state;
-    private _detailedState;
-    private _waitingTime;
-    private _saturation;
-    private _rules;
-    private _possibleTransfer;
-    private _supervisedTransfer;
-    protected constructor(data: {
-        number: string;
-        name: string;
-        state: Pilot.ServiceState;
-        detailedState: Pilot.Status;
-        waitingTime: number;
-        saturation: boolean;
-        rules: PilotRuleSet;
-        possibleTransfer: boolean;
-        supervisedTransfer: boolean;
-    });
-    get number(): string;
-    get name(): string;
-    get state(): Pilot.ServiceState;
-    get detailedState(): Pilot.Status;
-    get waitingTime(): number;
-    get saturation(): boolean;
-    get rules(): PilotRuleSet;
-    get possibleTransfer(): boolean;
-    get supervisedTransfer(): boolean;
-}
-export declare namespace Pilot {
-    /**
-     * Service state for th epilot
-     */
-    enum ServiceState {
-        Closed = 0,
-        Opened = 1,
-        Blocked = 2,
-        unknown = 3
-    }
-    /**
-     * CCD pilot status.
-     */
-    enum Status {
-        OPEN = 0,
-        BLOCKED = 1,
-        BLOCKED_ON_RULE = 2,
-        BLOCKED_ON_BLOCKED_RULE = 3,
-        GENERAL_FORWARDING = 4,
-        GENERAL_FORWARDING_ON_RULE = 5,
-        BLOCKED_ON_GENERAL_FORWARDING_RULE = 6,
-        OTHER = 7
-    }
-}

package/dist/types/cc-pilot/cc-pilot-events.d.ts

@@ -1,111 +0,0 @@
-import { O2GEvent } from "../../internal/events/o2g-event";
-import { CallCause } from "../telephony/telephony-events";
-import { TrunkIdentification } from "../telephony/telephony-types";
-/**
- * Describes data associated to a pilot call.
- */
-export type CallDataPilot = {
-    /**
-     * Initial user called for this call.
-     */
-    initialCalled: string;
-    /**
-     * true it's a anonymous call.
-     */
-    anonymous: boolean;
-    /**
-     * Associated data (or Correlator data).
-     */
-    associatedData: string;
-    /**
-     * Hexa binary array format for Associated data (or Correlator data).
-     */
-    hexaBinaryAssociatedData: string;
-    /**
-     * TrunkIdentification if external call
-     */
-    trunkIdentification: TrunkIdentification;
-    /**
-     * if the call has been rerouted in the network (absent if not)
-     */
-    networkRerouted: boolean;
-};
-/**
- * This event indicates that a new call arrives on a pilot.
- */
-export type OnPilotCallCreated = O2GEvent<'OnPilotCallCreated', {
-    /**
-     * Pilot number.
-     */
-    pilot: string;
-    /**
-     * Caller number.
-     */
-    caller: string;
-    /**
-      * The call reference.
-      */
-    callRef: string;
-    /**
-     * Cause of the event.
-     */
-    cause: CallCause;
-    /**
-     * Call data
-     */
-    callData: CallDataPilot;
-}>;
-/**
- * This event indicates that the call has been queued.
- */
-export type OnPilotCallQueued = O2GEvent<'OnPilotCallQueued', {
-    /**
-     * Pilot number.
-     */
-    pilot: string;
-    /**
-     * Caller number.
-     */
-    caller: string;
-    /**
-     * Queue number (if distribution) or identifier (if overflow).
-     */
-    queue: string;
-    /**
-      * The call reference.
-      */
-    callRef: string;
-    /**
-     * Cause of the event.
-     */
-    cause: CallCause;
-    /**
-     * Number of queued calls in the pilot queue.
-     */
-    numberOfQueued: number;
-}>;
-/**
- * This event indicates that the call has been removed from the pilot: cause distribution, cancel or overflow.
- */
-export type OnPilotCallRemoved = O2GEvent<'OnPilotCallRemoved', {
-    /**
-     * Pilot number.
-     */
-    pilot: string;
-    /**
-     * ReleasingDevice number.
-     */
-    releasingDevice: string;
-    /**
-     * new Destination number.
-     */
-    newDestination: string;
-    /**
-     * The call reference.
-     */
-    callRef: string;
-    /**
-     * Cause of the event.
-     */
-    cause: CallCause;
-}>;