@rc-ex/core 1.6.17 → 1.7.0

package/dist/esm/definitions/CommRingAlwaysGroupActionResourceTargets.d.ts

@@ -0,0 +1,14 @@
+import CommReferencedExtensionResource from "./CommReferencedExtensionResource.js";
+interface CommRingAlwaysGroupActionResourceTargets {
+    /** */
+    name?: string;
+    /**
+     * Ring target type. Applicable for all desktop and mobile applications.
+     *  Ensures applications ring all the time during a call
+     * Example: AllMobileRingTarget
+     */
+    type?: "AllDesktopRingTarget" | "AllMobileRingTarget";
+    /** */
+    extension?: CommReferencedExtensionResource;
+}
+export default CommRingAlwaysGroupActionResourceTargets;

package/dist/esm/definitions/CommRingAlwaysGroupActionResourceTargets.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommRingAlwaysRingTargetResource.d.ts

@@ -0,0 +1,11 @@
+interface CommRingAlwaysRingTargetResource {
+    /** */
+    name?: string;
+    /**
+     * Ring target type. Applicable for all desktop and mobile applications.
+     *  Ensures applications ring all the time during a call
+     * Required
+     */
+    type?: "AllDesktopRingTarget" | "AllMobileRingTarget";
+}
+export default CommRingAlwaysRingTargetResource;

package/dist/esm/definitions/CommRingAlwaysRingTargetResource.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommRingGroupActionRequest.d.ts

@@ -0,0 +1,35 @@
+import CommRingGroupActionRequestTargets from "./CommRingGroupActionRequestTargets.js";
+/**
+ * Action information
+ */
+interface CommRingGroupActionRequest {
+    /**
+     * Action type
+     * Required
+     * Example: RingGroupAction
+     */
+    type?: "PlayConnectingMessageAction" | "PlayConnectingPromptAction" | "PlayWelcomePromptAction" | "ScreeningAction" | "RingGroupAction" | "RingAlwaysGroupAction" | "TerminatingAction";
+    /**
+     * Specifies if an action is enabled
+     * Required
+     */
+    enabled?: boolean;
+    /**
+     * Required
+     */
+    targets?: CommRingGroupActionRequestTargets[];
+    /**
+     * Custom start time. Applicable for 'Custom' dispatching type
+     * Format: int32
+     * Example: 5
+     */
+    customStartOffset?: number;
+    /**
+     * Duration of calling
+     * Required
+     * Format: int32
+     * Example: 5
+     */
+    duration?: number;
+}
+export default CommRingGroupActionRequest;

package/dist/esm/definitions/CommRingGroupActionRequest.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommRingGroupActionRequestTargets.d.ts

@@ -0,0 +1,22 @@
+import CommReferencedExtensionResource from "./CommReferencedExtensionResource.js";
+import CommDeviceRequest from "./CommDeviceRequest.js";
+import CommPhoneNumberResource from "./CommPhoneNumberResource.js";
+import CommIntegrationRequest from "./CommIntegrationRequest.js";
+interface CommRingGroupActionRequestTargets {
+    /**
+     * Ring target type
+     * Example: PhoneNumberRingTarget
+     */
+    type?: "AllDesktopRingTarget" | "AllMobileRingTarget" | "CoworkerRingTarget" | "DeviceRingTarget" | "HotdeskRingTarget" | "ImsPhoneNumberRingTarget" | "IntegrationRingTarget" | "PhoneNumberRingTarget";
+    /** */
+    extension?: CommReferencedExtensionResource;
+    /** */
+    device?: CommDeviceRequest;
+    /** */
+    destination?: CommPhoneNumberResource;
+    /** */
+    integration?: CommIntegrationRequest;
+    /** */
+    name?: string;
+}
+export default CommRingGroupActionRequestTargets;

package/dist/esm/definitions/CommRingGroupActionRequestTargets.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommRingGroupActionResource.d.ts

@@ -0,0 +1,36 @@
+import CommRingGroupActionResourceTargets from "./CommRingGroupActionResourceTargets.js";
+/**
+ * Action information
+ */
+interface CommRingGroupActionResource {
+    /**
+     * Action type
+     * Required
+     * Example: RingGroupAction
+     */
+    type?: "PlayConnectingMessageAction" | "PlayConnectingPromptAction" | "PlayWelcomePromptAction" | "ScreeningAction" | "RingGroupAction" | "RingAlwaysGroupAction" | "TerminatingAction";
+    /**
+     * Specifies if an action is enabled
+     * Required
+     */
+    enabled?: boolean;
+    /**
+     * Target information
+     * Required
+     */
+    targets?: CommRingGroupActionResourceTargets[];
+    /**
+     * Custom start time in seconds. Applicable for 'Custom' dispatching type
+     * Format: int32
+     * Example: 5
+     */
+    customStartOffset?: number;
+    /**
+     * Duration of calling in seconds
+     * Required
+     * Format: int32
+     * Example: 5
+     */
+    duration?: number;
+}
+export default CommRingGroupActionResource;

package/dist/esm/definitions/CommRingGroupActionResource.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommRingGroupActionResourceTargets.d.ts

@@ -0,0 +1,22 @@
+import CommReferencedExtensionResource from "./CommReferencedExtensionResource.js";
+import CommDeviceResource from "./CommDeviceResource.js";
+import CommPhoneNumberResource from "./CommPhoneNumberResource.js";
+import CommIntegrationResource from "./CommIntegrationResource.js";
+interface CommRingGroupActionResourceTargets {
+    /** */
+    name?: string;
+    /**
+     * Ring target type
+     * Example: PhoneNumberRingTarget
+     */
+    type?: "AllDesktopRingTarget" | "AllMobileRingTarget" | "CoworkerRingTarget" | "DeviceRingTarget" | "HotdeskRingTarget" | "ImsPhoneNumberRingTarget" | "IntegrationRingTarget" | "PhoneNumberRingTarget";
+    /** */
+    extension?: CommReferencedExtensionResource;
+    /** */
+    device?: CommDeviceResource;
+    /** */
+    destination?: CommPhoneNumberResource;
+    /** */
+    integration?: CommIntegrationResource;
+}
+export default CommRingGroupActionResourceTargets;

package/dist/esm/definitions/CommRingGroupActionResourceTargets.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommRingTargetRequest.d.ts

@@ -0,0 +1,8 @@
+interface CommRingTargetRequest {
+    /**
+     * Ring target type
+     * Required
+     */
+    type?: "AllDesktopRingTarget" | "AllMobileRingTarget" | "CoworkerRingTarget" | "DeviceRingTarget" | "HotdeskRingTarget" | "ImsPhoneNumberRingTarget" | "IntegrationRingTarget" | "PhoneNumberRingTarget";
+}
+export default CommRingTargetRequest;

package/dist/esm/definitions/CommRingTargetRequest.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommRingTargetResource.d.ts

@@ -0,0 +1,10 @@
+interface CommRingTargetResource {
+    /** */
+    name?: string;
+    /**
+     * Ring target type
+     * Required
+     */
+    type?: "AllDesktopRingTarget" | "AllMobileRingTarget" | "CoworkerRingTarget" | "DeviceRingTarget" | "HotdeskRingTarget" | "ImsPhoneNumberRingTarget" | "IntegrationRingTarget" | "PhoneNumberRingTarget";
+}
+export default CommRingTargetResource;

package/dist/esm/definitions/CommRingTargetResource.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommScreeningActionRequest.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Action information
+ */
+interface CommScreeningActionRequest {
+    /**
+     * Action type
+     * Required
+     * Example: ScreeningAction
+     */
+    type?: "PlayConnectingMessageAction" | "PlayConnectingPromptAction" | "PlayWelcomePromptAction" | "ScreeningAction" | "RingGroupAction" | "RingAlwaysGroupAction" | "TerminatingAction";
+    /**
+     * Screening type
+     * Required
+     */
+    screening?: "NoCallerId" | "UnknownCallerId" | "Always";
+    /**
+     * Specifies if an action is enabled
+     * Required
+     */
+    enabled?: boolean;
+    /** */
+    screeningResult?: "AskToAnswer" | "PlayCallerNameOnly";
+}
+export default CommScreeningActionRequest;

package/dist/esm/definitions/CommScreeningActionRequest.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommScreeningActionResource.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Action information
+ */
+interface CommScreeningActionResource {
+    /**
+     * Action type
+     * Required
+     * Example: ScreeningAction
+     */
+    type?: "PlayConnectingMessageAction" | "PlayConnectingPromptAction" | "PlayWelcomePromptAction" | "ScreeningAction" | "RingGroupAction" | "RingAlwaysGroupAction" | "TerminatingAction";
+    /**
+     * Screening type
+     * Required
+     */
+    screening?: "NoCallerId" | "UnknownCallerId" | "Always";
+    /**
+     * Specifies if an action is enabled
+     */
+    enabled?: boolean;
+    /**
+     * Required
+     */
+    screeningResult?: "AskToAnswer" | "PlayCallerNameOnly";
+}
+export default CommScreeningActionResource;

package/dist/esm/definitions/CommScreeningActionResource.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommStateBasedRuleResource.d.ts

@@ -0,0 +1,29 @@
+import CommStateDispatchingResource from "./CommStateDispatchingResource.js";
+import CommStateDispatchingRefResource from "./CommStateDispatchingRefResource.js";
+import CommStateResource from "./CommStateResource.js";
+/**
+ * State-based rule information
+ */
+interface CommStateBasedRuleResource {
+    /**
+     * Id/Type of a state the rule is based on
+     * Required
+     */
+    id?: "after-hours" | "work-hours" | "dnd" | "forward-all-calls" | "agent";
+    /**
+     * Predefined name of a state-based rule (similar to the name of a state)
+     * Required
+     */
+    displayName?: "After Hours" | "Work Hours" | "Do not disturb" | "Forward all calls" | "Agent";
+    /**
+     * Required
+     */
+    dispatching?: CommStateDispatchingResource;
+    /** */
+    dispatchingRef?: CommStateDispatchingRefResource;
+    /**
+     * Required
+     */
+    state?: CommStateResource;
+}
+export default CommStateBasedRuleResource;

package/dist/esm/definitions/CommStateBasedRuleResource.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommStateBasedRuleUpdateRequest.d.ts

@@ -0,0 +1,9 @@
+import CommDispatchingRequest from "./CommDispatchingRequest.js";
+/**
+ * State-based rule update request
+ */
+interface CommStateBasedRuleUpdateRequest {
+    /** */
+    dispatching?: CommDispatchingRequest;
+}
+export default CommStateBasedRuleUpdateRequest;

package/dist/esm/definitions/CommStateBasedRuleUpdateRequest.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommStateBasedRulesResource.d.ts

@@ -0,0 +1,16 @@
+import CommStateBasedRuleResource from "./CommStateBasedRuleResource.js";
+import EnumeratedPagingModel from "./EnumeratedPagingModel.js";
+/**
+ * State-based rule information
+ */
+interface CommStateBasedRulesResource {
+    /**
+     * Required
+     */
+    records?: CommStateBasedRuleResource[];
+    /**
+     * Required
+     */
+    paging?: EnumeratedPagingModel;
+}
+export default CommStateBasedRulesResource;

package/dist/esm/definitions/CommStateBasedRulesResource.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommStateConditionRequest.d.ts

@@ -0,0 +1,8 @@
+interface CommStateConditionRequest {
+    /**
+     * Ring target type
+     * Required
+     */
+    type?: "Schedule" | "State";
+}
+export default CommStateConditionRequest;

package/dist/esm/definitions/CommStateConditionRequest.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommStateConditionResource.d.ts

@@ -0,0 +1,8 @@
+interface CommStateConditionResource {
+    /**
+     * Ring target type
+     * Required
+     */
+    type?: "Schedule" | "State";
+}
+export default CommStateConditionResource;

package/dist/esm/definitions/CommStateConditionResource.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommStateDispatchingRefResource.d.ts

@@ -0,0 +1,11 @@
+import CommStateDispatchingResource from "./CommStateDispatchingResource.js";
+interface CommStateDispatchingRefResource {
+    /**
+     * Id/Type of a state the rule is based on
+     * Required
+     */
+    ruleId?: "after-hours" | "work-hours" | "dnd" | "forward-all-calls" | "agent";
+    /** */
+    dispatching?: CommStateDispatchingResource;
+}
+export default CommStateDispatchingRefResource;

package/dist/esm/definitions/CommStateDispatchingRefResource.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommStateDispatchingResource.d.ts

@@ -0,0 +1,14 @@
+import CommStateDispatchingResourceActions from "./CommStateDispatchingResourceActions.js";
+interface CommStateDispatchingResource {
+    /**
+     * Action information
+     * Required
+     */
+    actions?: CommStateDispatchingResourceActions[];
+    /**
+     * Call dispatching type
+     * Required
+     */
+    type?: "RingAtOnce" | "RingInOrder" | "Custom" | "Terminate";
+}
+export default CommStateDispatchingResource;

package/dist/esm/definitions/CommStateDispatchingResource.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommStateDispatchingResourceActions.d.ts

@@ -0,0 +1,46 @@
+import CommGreetingResource from "./CommGreetingResource.js";
+import CommStateDispatchingResourceActionsTargets from "./CommStateDispatchingResourceActionsTargets.js";
+interface CommStateDispatchingResourceActions {
+    /**
+     * Action type
+     * Example: TerminatingAction
+     */
+    type?: "PlayConnectingMessageAction" | "PlayConnectingPromptAction" | "PlayWelcomePromptAction" | "ScreeningAction" | "RingGroupAction" | "RingAlwaysGroupAction" | "TerminatingAction";
+    /** */
+    greeting?: CommGreetingResource;
+    /**
+     * Specifies if an action is enabled
+     */
+    enabled?: boolean;
+    /**
+     * Screening type
+     */
+    screening?: "NoCallerId" | "UnknownCallerId" | "Always";
+    /** */
+    screeningResult?: "AskToAnswer" | "PlayCallerNameOnly";
+    /**
+     * Action information
+     */
+    targets?: CommStateDispatchingResourceActionsTargets[];
+    /**
+     * Custom start time in seconds. Applicable for 'Custom' dispatching type
+     * Format: int32
+     * Example: 5
+     */
+    customStartOffset?: number;
+    /**
+     * Duration of calling in seconds
+     * Format: int32
+     * Example: 5
+     */
+    duration?: number;
+    /**
+     * Terminating target type
+     */
+    ringingTargetType?: "ExtensionTerminatingTarget" | "PhoneNumberTerminatingTarget" | "PlayAnnouncementTerminatingTarget" | "VoiceMailTerminatingTarget" | "ImsVoiceMailTerminatingTarget";
+    /**
+     * Terminating target type
+     */
+    terminatingTargetType?: "ExtensionTerminatingTarget" | "PhoneNumberTerminatingTarget" | "PlayAnnouncementTerminatingTarget" | "VoiceMailTerminatingTarget" | "ImsVoiceMailTerminatingTarget";
+}
+export default CommStateDispatchingResourceActions;

package/dist/esm/definitions/CommStateDispatchingResourceActions.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommStateDispatchingResourceActionsTargets.d.ts

@@ -0,0 +1,27 @@
+import CommReferencedExtensionResource from "./CommReferencedExtensionResource.js";
+import CommDeviceResource from "./CommDeviceResource.js";
+import CommPhoneNumberResource from "./CommPhoneNumberResource.js";
+import CommIntegrationResource from "./CommIntegrationResource.js";
+import CommTerminatingPromptResource from "./CommTerminatingPromptResource.js";
+interface CommStateDispatchingResourceActionsTargets {
+    /** */
+    name?: string;
+    /**
+     * Terminating target type
+     * Example: ImsVoiceMailTerminatingTarget
+     */
+    type?: "ExtensionTerminatingTarget" | "PhoneNumberTerminatingTarget" | "PlayAnnouncementTerminatingTarget" | "VoiceMailTerminatingTarget" | "ImsVoiceMailTerminatingTarget";
+    /** */
+    extension?: CommReferencedExtensionResource;
+    /** */
+    device?: CommDeviceResource;
+    /** */
+    destination?: CommPhoneNumberResource;
+    /** */
+    integration?: CommIntegrationResource;
+    /** */
+    prompt?: CommTerminatingPromptResource;
+    /** */
+    dispatchingType?: "Ringing" | "Terminating";
+}
+export default CommStateDispatchingResourceActionsTargets;

package/dist/esm/definitions/CommStateDispatchingResourceActionsTargets.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommStateRefConditionRequest.d.ts

@@ -0,0 +1,13 @@
+import CommReferenceStateResource from "./CommReferenceStateResource.js";
+interface CommStateRefConditionRequest {
+    /**
+     * Ring target type
+     * Required
+     */
+    type?: "Schedule" | "State";
+    /**
+     * Required
+     */
+    state?: CommReferenceStateResource;
+}
+export default CommStateRefConditionRequest;

package/dist/esm/definitions/CommStateRefConditionRequest.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommStateRefConditionResource.d.ts

@@ -0,0 +1,11 @@
+import CommStateReferenceResource from "./CommStateReferenceResource.js";
+interface CommStateRefConditionResource {
+    /**
+     * Ring target type
+     * Required
+     */
+    type?: "Schedule" | "State";
+    /** */
+    state?: CommStateReferenceResource;
+}
+export default CommStateRefConditionResource;

package/dist/esm/definitions/CommStateRefConditionResource.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommStateReferenceResource.d.ts

@@ -0,0 +1,18 @@
+import CommStateScheduleConditionResource from "./CommStateScheduleConditionResource.js";
+interface CommStateReferenceResource {
+    /**
+     * Id/Type of a state the rule is based on
+     * Required
+     */
+    id?: "after-hours" | "work-hours" | "dnd" | "forward-all-calls" | "agent";
+    /**
+     * Predefined name of a state-based rule (similar to the name of a state)
+     * Required
+     */
+    displayName?: "After Hours" | "Work Hours" | "Do not disturb" | "Forward all calls" | "Agent";
+    /**
+     * Required
+     */
+    conditions?: CommStateScheduleConditionResource[];
+}
+export default CommStateReferenceResource;

package/dist/esm/definitions/CommStateReferenceResource.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommStateResource.d.ts

@@ -0,0 +1,22 @@
+interface CommStateResource {
+    /**
+     * Id/Type of a state the rule is based on
+     * Required
+     */
+    id?: "after-hours" | "work-hours" | "dnd" | "forward-all-calls" | "agent";
+    /**
+     * Specifies if a state is enabled or not. *Work Hours* and *After Hours* states cannot be disabled
+     * Required
+     */
+    enabled?: boolean;
+    /**
+     * Predefined name of a state-based rule (similar to the name of a state)
+     * Required
+     */
+    displayName?: "After Hours" | "Work Hours" | "Do not disturb" | "Forward all calls" | "Agent";
+    /**
+     * Required
+     */
+    conditions?: object[];
+}
+export default CommStateResource;

package/dist/esm/definitions/CommStateResource.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommStateScheduleConditionRequest.d.ts

@@ -0,0 +1,13 @@
+import CommStateScheduleResource from "./CommStateScheduleResource.js";
+interface CommStateScheduleConditionRequest {
+    /**
+     * Ring target type
+     * Required
+     */
+    type?: "Schedule" | "State";
+    /**
+     * Required
+     */
+    schedule?: CommStateScheduleResource;
+}
+export default CommStateScheduleConditionRequest;

package/dist/esm/definitions/CommStateScheduleConditionRequest.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommStateScheduleConditionResource.d.ts

@@ -0,0 +1,13 @@
+import CommStateScheduleResource from "./CommStateScheduleResource.js";
+interface CommStateScheduleConditionResource {
+    /**
+     * Ring target type
+     * Required
+     */
+    type?: "Schedule" | "State";
+    /**
+     * Required
+     */
+    schedule?: CommStateScheduleResource;
+}
+export default CommStateScheduleConditionResource;

package/dist/esm/definitions/CommStateScheduleConditionResource.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommStateScheduleResource.d.ts

@@ -0,0 +1,8 @@
+import CommStateScheduleResourceTriggers from "./CommStateScheduleResourceTriggers.js";
+interface CommStateScheduleResource {
+    /**
+     * Required
+     */
+    triggers?: CommStateScheduleResourceTriggers[];
+}
+export default CommStateScheduleResource;

package/dist/esm/definitions/CommStateScheduleResource.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommStateScheduleResourceTriggers.d.ts

@@ -0,0 +1,21 @@
+import CommWeeklyItemsResource from "./CommWeeklyItemsResource.js";
+interface CommStateScheduleResourceTriggers {
+    /**
+     * Trigger type
+     * Example: Range
+     */
+    triggerType?: "Daily" | "Weekly" | "Range";
+    /**
+     * Start time in format hh:mm:ss
+     * Format: time
+     */
+    startTime?: string;
+    /**
+     * End time in format hh:mm:ss
+     * Format: time
+     */
+    endTime?: string;
+    /** */
+    ranges?: CommWeeklyItemsResource;
+}
+export default CommStateScheduleResourceTriggers;

package/dist/esm/definitions/CommStateScheduleResourceTriggers.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/CommStateUpdateRequest.d.ts

@@ -0,0 +1,9 @@
+interface CommStateUpdateRequest {
+    /**
+     * Specifies if a state is enabled or not. *Work Hours* and *After Hours* states cannot be disabled
+     */
+    enabled?: boolean;
+    /** */
+    conditions?: object[];
+}
+export default CommStateUpdateRequest;

package/dist/esm/definitions/CommStateUpdateRequest.js

@@ -0,0 +1 @@
+export {};