@rc-ex/debug 1.3.11 → 1.4.0

package/dist/core/src/definitions/EmergencyLocationInfo.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Emergency response location information
+ */
+interface EmergencyLocationInfo {
+    /**
+     * Internal identifier of an emergency response location
+     * Required
+     */
+    id?: string;
+    /**
+     * Emergency response location name
+     */
+    name?: string;
+    /**
+     * Address format identifier
+     */
+    addressFormatId?: string;
+    /**
+     * Emergency address status. Only supported for extension-level (personal) endpoints
+     */
+    addressStatus?: "Valid" | "Invalid" | "Provisioning" | "Deprovisioned";
+}
+export default EmergencyLocationInfo;

package/dist/core/src/definitions/EmergencyLocationRequestResource.d.ts

@@ -0,0 +1,31 @@
+import type EmergencyAddressResourceRequest from "./EmergencyAddressResourceRequest.js";
+import type SiteBasicInfo from "./SiteBasicInfo.js";
+interface EmergencyLocationRequestResource {
+    /**
+     */
+    address?: EmergencyAddressResourceRequest;
+    /**
+     * Emergency response location name
+     */
+    name?: string;
+    /**
+     */
+    site?: SiteBasicInfo;
+    /**
+     * Address format ID
+     */
+    addressFormatId?: string;
+    /**
+     * Visibility of an emergency response location. If `Private`
+     *  is set, then a location is visible only for restricted number of users,
+     *  specified in `owners` array
+     * Default: Public
+     */
+    visibility?: "Public";
+    /**
+     * Specifies emergency address validation during the ERL creation/update.
+     *  If set to 'true', then address validation for non-US addresses is skipped
+     */
+    trusted?: boolean;
+}
+export default EmergencyLocationRequestResource;

package/dist/core/src/definitions/EmergencyLocationResponseResource.d.ts

@@ -0,0 +1,67 @@
+import type EmergencyLocationAddressResource from "./EmergencyLocationAddressResource.js";
+import type LocationOwnerInfo from "./LocationOwnerInfo.js";
+import type SiteBasicInfo from "./SiteBasicInfo.js";
+/**
+ * Company emergency response location details
+ */
+interface EmergencyLocationResponseResource {
+    /**
+     * Link to an emergency location resource
+     */
+    uri?: string;
+    /**
+     * Internal identifier of an emergency response location
+     */
+    id?: string;
+    /**
+     */
+    address?: EmergencyLocationAddressResource;
+    /**
+     * Emergency response location name
+     */
+    name?: string;
+    /**
+     */
+    site?: SiteBasicInfo;
+    /**
+     * Emergency address status
+     */
+    addressStatus?: "Valid" | "Invalid" | "Provisioning" | "Deprovisioned";
+    /**
+     * Status of emergency response location usage.
+     */
+    usageStatus?: "Active" | "Inactive";
+    /**
+     * Resulting status of emergency address synchronization. Returned
+     *  if `syncEmergencyAddress` parameter is set to `true`
+     */
+    syncStatus?: "Verified" | "Updated" | "Deleted" | "ActivationProcess" | "NotRequired" | "Unsupported" | "Failed";
+    /**
+     */
+    addressType?: "LocationWithElins" | "LocationWithEndpoint";
+    /**
+     * Visibility of an emergency response location. If `Private`
+     *  is set, then location is visible only for the restricted number of users,
+     *  specified in `owners` array
+     * Default: Public
+     */
+    visibility?: "Private" | "Public";
+    /**
+     * List of private location owners
+     */
+    owners?: LocationOwnerInfo[];
+    /**
+     * Address format ID
+     */
+    addressFormatId?: string;
+    /**
+     * Address format statuses
+     */
+    addressFormatStatus?: "Actual" | "Outdated" | "Deprecated";
+    /**
+     * Specifies emergency address validation during the ERL creation/update.
+     *  If set to 'true', then address validation for non-US addresses is skipped
+     */
+    trusted?: boolean;
+}
+export default EmergencyLocationResponseResource;

package/dist/core/src/definitions/EmergencyLocationsPaging.d.ts

@@ -0,0 +1,33 @@
+interface EmergencyLocationsPaging {
+    /**
+     * Required
+     * Format: int32
+     */
+    page?: number;
+    /**
+     * Required
+     * Format: int32
+     */
+    totalPages?: number;
+    /**
+     * Required
+     * Format: int32
+     */
+    perPage?: number;
+    /**
+     * Required
+     * Format: int32
+     */
+    totalElements?: number;
+    /**
+     * Required
+     * Format: int32
+     */
+    pageStart?: number;
+    /**
+     * Required
+     * Format: int32
+     */
+    pageEnd?: number;
+}
+export default EmergencyLocationsPaging;

package/dist/core/src/definitions/EmergencyLocationsResource.d.ts

@@ -0,0 +1,19 @@
+import type CommonEmergencyLocationResource from "./CommonEmergencyLocationResource.js";
+import type EmergencyLocationsPaging from "./EmergencyLocationsPaging.js";
+import type PageNavigationModel from "./PageNavigationModel.js";
+interface EmergencyLocationsResource {
+    /**
+     * Link to an emergency locations resource
+     */
+    uri?: string;
+    /**
+     */
+    records?: CommonEmergencyLocationResource[];
+    /**
+     */
+    paging?: EmergencyLocationsPaging;
+    /**
+     */
+    navigation?: PageNavigationModel;
+}
+export default EmergencyLocationsResource;

package/dist/core/src/definitions/EmergencyServiceAddressResourceRequest.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Address for emergency cases. The same emergency address is assigned to all
+ * numbers of a single device. If the emergency address is also specified in
+ * `emergency` resource, then this value is ignored
+ *
+ */
+interface EmergencyServiceAddressResourceRequest {
+    /**
+     * First line address
+     */
+    street?: string;
+    /**
+     * Second line address (apartment, suite, unit, building, floor,
+     *  etc.)
+     */
+    street2?: string;
+    /**
+     * Postal (Zip) code
+     */
+    zip?: string;
+    /**
+     * Customer name
+     */
+    customerName?: string;
+    /**
+     * State/province name
+     */
+    state?: string;
+    /**
+     * Internal identifier of a state
+     */
+    stateId?: string;
+    /**
+     * Country name
+     */
+    country?: string;
+    /**
+     * Internal identifier of a country
+     */
+    countryId?: string;
+}
+export default EmergencyServiceAddressResourceRequest;

package/dist/core/src/definitions/EnumeratedPagingModel.d.ts

@@ -0,0 +1,50 @@
+interface EnumeratedPagingModel {
+    /**
+     * Current page size, describes how many items are in each page.
+     *  Matches "perPage" parameter from the request.
+     * Required
+     * Maximum: 1000
+     * Minimum: 1
+     * Format: int32
+     * Example: 50
+     */
+    perPage?: number;
+    /**
+     * The current page number. 1-indexed, so the first page is 1
+     *  by default. May be omitted if result is empty (because non-existent page
+     *  was specified or perPage=0 was requested)
+     * Maximum: 1000
+     * Minimum: 1
+     * Format: int32
+     * Example: 5
+     */
+    page?: number;
+    /**
+     * The zero-based number of the first element on the current page.
+     *  Omitted if the page is omitted or result is empty
+     * Format: int32
+     */
+    pageStart?: number;
+    /**
+     * The zero-based index of the last element on the current page.
+     *  Omitted if the page is omitted or result is empty
+     * Format: int32
+     * Example: 5
+     */
+    pageEnd?: number;
+    /**
+     * The total number of pages in a dataset. May be omitted for
+     *  some resources due to performance reasons
+     * Format: int32
+     * Example: 25
+     */
+    totalPages?: number;
+    /**
+     * The total number of elements in a dataset. May be omitted for
+     *  some resource due to performance reasons
+     * Format: int32
+     * Example: 25
+     */
+    totalElements?: number;
+}
+export default EnumeratedPagingModel;

package/dist/core/src/definitions/ErrorEntity.d.ts

@@ -0,0 +1,19 @@
+interface ErrorEntity {
+    /**
+     * Error code
+     */
+    errorCode?: string;
+    /**
+     * Error message
+     */
+    message?: string;
+    /**
+     * Name of invalid parameter
+     */
+    parameterName?: string;
+    /**
+     * Value of invalid parameter
+     */
+    parameterValue?: string;
+}
+export default ErrorEntity;

package/dist/core/src/definitions/EventRecurrenceInfo.d.ts

@@ -0,0 +1,25 @@
+interface EventRecurrenceInfo {
+    /**
+     * Event recurrence settings. For non-periodic events the value
+     *  is `None`. Must be greater or equal to event duration: 1- Day/Weekday;
+     *  7 - Week; 28 - Month; 365 - Year
+     */
+    schedule?: "None" | "Day" | "Weekday" | "Week" | "Month" | "Year";
+    /**
+     * Condition of ending an event
+     */
+    endingCondition?: "None" | "Count" | "Date";
+    /**
+     * Count of event iterations. For periodic events only. Value range is 1 - 10.
+     *  Must be specified if `endingCondition` is `Count`
+     * Format: int32
+     */
+    endingAfter?: number;
+    /**
+     * Iterations ending datetime for periodic events in
+     *  [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
+     * Format: date-time
+     */
+    endingOn?: string;
+}
+export default EventRecurrenceInfo;

package/dist/core/src/definitions/EveryoneCanControl.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Controls whether participants can start and pause recording
+ */
+interface EveryoneCanControl {
+    /**
+     * Controls whether preference is enabled
+     * Example: true
+     */
+    enabled?: boolean;
+    /**
+     * Describes whether preference is locked on Service Web
+     */
+    locked?: boolean;
+}
+export default EveryoneCanControl;

package/dist/core/src/definitions/EveryoneTeamInfo.d.ts

@@ -0,0 +1,29 @@
+interface EveryoneTeamInfo {
+    /**
+     * Internal identifier of a chat
+     */
+    id?: string;
+    /**
+     * Type of chat
+     */
+    type?: "Everyone";
+    /**
+     * Chat name
+     */
+    name?: string;
+    /**
+     * Chat description
+     */
+    description?: string;
+    /**
+     * Chat creation datetime in ISO 8601 format
+     * Format: date-time
+     */
+    creationTime?: string;
+    /**
+     * Chat last change datetime in ISO 8601 format
+     * Format: date-time
+     */
+    lastModifiedTime?: string;
+}
+export default EveryoneTeamInfo;

package/dist/core/src/definitions/ExportTaskResultInfo.d.ts

@@ -0,0 +1,17 @@
+interface ExportTaskResultInfo {
+    /**
+     * Internal identifier of a dataset
+     */
+    id?: string;
+    /**
+     * Link for downloading a dataset
+     * Format: uri
+     */
+    uri?: string;
+    /**
+     * Size of ta dataset in bytes
+     * Format: int64
+     */
+    size?: number;
+}
+export default ExportTaskResultInfo;

package/dist/core/src/definitions/ExtensionBulkUpdateInfo.d.ts

@@ -0,0 +1,88 @@
+import type CallQueueInfoRequest from "./CallQueueInfoRequest.js";
+import type ContactInfoUpdateRequest from "./ContactInfoUpdateRequest.js";
+import type CostCenterInfo from "./CostCenterInfo.js";
+import type CustomFieldInfo from "./CustomFieldInfo.js";
+import type ExtensionRegionalSettingRequest from "./ExtensionRegionalSettingRequest.js";
+import type ExtensionStatusInfo from "./ExtensionStatusInfo.js";
+import type ProvisioningSiteInfo from "./ProvisioningSiteInfo.js";
+import type ReferenceInfo from "./ReferenceInfo.js";
+import type UserTransitionInfo from "./UserTransitionInfo.js";
+interface ExtensionBulkUpdateInfo {
+    /**
+     * Internal identifier of an extension
+     */
+    id?: string;
+    /**
+     * Extension status
+     */
+    status?: "Enabled" | "Disabled" | "Frozen" | "NotActivated";
+    /**
+     */
+    statusInfo?: ExtensionStatusInfo;
+    /**
+     * Type of suspension
+     */
+    reason?: string;
+    /**
+     * Free form user comment
+     */
+    comment?: string;
+    /**
+     * Extension number available
+     */
+    extensionNumber?: string;
+    /**
+     */
+    contact?: ContactInfoUpdateRequest;
+    /**
+     */
+    regionalSettings?: ExtensionRegionalSettingRequest;
+    /**
+     * Initial configuration wizard state
+     * Default: NotStarted
+     */
+    setupWizardState?: "NotStarted" | "Incomplete" | "Completed";
+    /**
+     * Additional extension identifier created by partner application
+     *  and applied on client side
+     */
+    partnerId?: string;
+    /**
+     * IVR PIN
+     */
+    ivrPin?: string;
+    /**
+     * Password for extension
+     */
+    password?: string;
+    /**
+     */
+    callQueueInfo?: CallQueueInfoRequest;
+    /**
+     */
+    transition?: UserTransitionInfo;
+    /**
+     */
+    costCenter?: CostCenterInfo;
+    /**
+     */
+    customFields?: CustomFieldInfo[];
+    /**
+     * Hides extension from showing in company directory. Supported for extensions of User type only
+     */
+    hidden?: boolean;
+    /**
+     */
+    site?: ProvisioningSiteInfo;
+    /**
+     * Extension type. Please note that legacy 'Department' extension
+     *  type corresponds to 'Call Queue' extensions in modern RingCentral
+     *  product terminology
+     */
+    type?: "User" | "FaxUser" | "VirtualUser" | "DigitalUser" | "Department" | "Announcement" | "Voicemail" | "SharedLinesGroup" | "PagingOnly" | "IvrMenu" | "ApplicationExtension" | "ParkLocation" | "DelegatedLinesGroup";
+    /**
+     * List of non-RC internal identifiers assigned to an extension
+     */
+    references?: ReferenceInfo[];
+}
+export default ExtensionBulkUpdateInfo;

package/dist/core/src/definitions/ExtensionBulkUpdateRequest.d.ts

@@ -0,0 +1,11 @@
+import type ExtensionBulkUpdateInfo from "./ExtensionBulkUpdateInfo.js";
+/**
+ * List of extensions to be updated
+ */
+interface ExtensionBulkUpdateRequest {
+    /**
+     * Required
+     */
+    records?: ExtensionBulkUpdateInfo[];
+}
+export default ExtensionBulkUpdateRequest;

package/dist/core/src/definitions/ExtensionBulkUpdateTaskResource.d.ts

@@ -0,0 +1,39 @@
+import type ExtensionBulkUpdateTaskResult from "./ExtensionBulkUpdateTaskResult.js";
+/**
+ * Information on a task for updating multiple extensions
+ *
+ */
+interface ExtensionBulkUpdateTaskResource {
+    /**
+     * Link to a task resource
+     * Required
+     * Format: uri
+     */
+    uri?: string;
+    /**
+     * Internal identifier of a task
+     * Required
+     */
+    id?: string;
+    /**
+     * Task status
+     * Required
+     */
+    status?: "Accepted" | "InProgress" | "Completed" | "Failed";
+    /**
+     * Task creation date/time
+     * Required
+     * Format: date-time
+     */
+    creationTime?: string;
+    /**
+     * Task latest update date/time
+     * Required
+     * Format: date-time
+     */
+    lastModifiedTime?: string;
+    /**
+     */
+    result?: ExtensionBulkUpdateTaskResult;
+}
+export default ExtensionBulkUpdateTaskResource;

package/dist/core/src/definitions/ExtensionBulkUpdateTaskResult.d.ts

@@ -0,0 +1,14 @@
+import type ErrorEntity from "./ErrorEntity.js";
+import type ExtensionBulkUpdateTaskResultAffectedItems from "./ExtensionBulkUpdateTaskResultAffectedItems.js";
+/**
+ * Resulting record of a task on multiple extensions update
+ */
+interface ExtensionBulkUpdateTaskResult {
+    /**
+     */
+    affectedItems?: ExtensionBulkUpdateTaskResultAffectedItems;
+    /**
+     */
+    errors?: ErrorEntity[];
+}
+export default ExtensionBulkUpdateTaskResult;

package/dist/core/src/definitions/ExtensionBulkUpdateTaskResultAffectedItems.d.ts

@@ -0,0 +1,7 @@
+import type ExtensionUpdateShortResult from "./ExtensionUpdateShortResult.js";
+interface ExtensionBulkUpdateTaskResultAffectedItems {
+    /**
+     */
+    result?: ExtensionUpdateShortResult[];
+}
+export default ExtensionBulkUpdateTaskResultAffectedItems;

package/dist/core/src/definitions/ExtensionCallQueuePresence.d.ts

@@ -0,0 +1,11 @@
+import type PresenceCallQueueInfo from "./PresenceCallQueueInfo.js";
+interface ExtensionCallQueuePresence {
+    /**
+     */
+    callQueue?: PresenceCallQueueInfo;
+    /**
+     * Call queue agent availability for calls of this queue
+     */
+    acceptCalls?: boolean;
+}
+export default ExtensionCallQueuePresence;

package/dist/core/src/definitions/ExtensionCallQueuePresenceList.d.ts

@@ -0,0 +1,7 @@
+import type ExtensionCallQueuePresence from "./ExtensionCallQueuePresence.js";
+interface ExtensionCallQueuePresenceList {
+    /**
+     */
+    records?: ExtensionCallQueuePresence[];
+}
+export default ExtensionCallQueuePresenceList;

package/dist/core/src/definitions/ExtensionCallQueueUpdatePresence.d.ts

@@ -0,0 +1,11 @@
+import type CallQueueId from "./CallQueueId.js";
+interface ExtensionCallQueueUpdatePresence {
+    /**
+     */
+    callQueue?: CallQueueId;
+    /**
+     * Call queue agent availability for calls of this queue
+     */
+    acceptCalls?: boolean;
+}
+export default ExtensionCallQueueUpdatePresence;

package/dist/core/src/definitions/ExtensionCallQueueUpdatePresenceList.d.ts

@@ -0,0 +1,7 @@
+import type ExtensionCallQueueUpdatePresence from "./ExtensionCallQueueUpdatePresence.js";
+interface ExtensionCallQueueUpdatePresenceList {
+    /**
+     */
+    records?: ExtensionCallQueueUpdatePresence[];
+}
+export default ExtensionCallQueueUpdatePresenceList;

package/dist/core/src/definitions/ExtensionCallerIdInfo.d.ts

@@ -0,0 +1,26 @@
+import type CallerIdByDevice from "./CallerIdByDevice.js";
+import type CallerIdByFeature from "./CallerIdByFeature.js";
+interface ExtensionCallerIdInfo {
+    /**
+     * Canonical URL of a caller ID resource
+     * Format: uri
+     */
+    uri?: string;
+    /**
+     */
+    byDevice?: CallerIdByDevice[];
+    /**
+     */
+    byFeature?: CallerIdByFeature[];
+    /**
+     * If `true`, then user first name and last name will be used
+     *  as caller ID when making outbound calls from extension
+     */
+    extensionNameForOutboundCalls?: boolean;
+    /**
+     * If `true`, then extension number will be used as caller ID
+     *  when making internal calls
+     */
+    extensionNumberForInternalCalls?: boolean;
+}
+export default ExtensionCallerIdInfo;

package/dist/core/src/definitions/ExtensionCountryInfoRequest.d.ts

@@ -0,0 +1,7 @@
+interface ExtensionCountryInfoRequest {
+    /**
+     * Internal identifier of a country
+     */
+    id?: string;
+}
+export default ExtensionCountryInfoRequest;