@rc-ex/core 1.4.1 → 1.5.0

package/src/definitions/RecordingInsights.ts

@@ -0,0 +1,92 @@
+import type AIInsights from './AIInsights';
+
+interface RecordingInsights {
+  /**
+   * Title of the call
+   * Required
+   * Example: Call from 1234567890 to 0987654321
+   */
+  title?: string;
+
+  /**
+   * URI of the call recording
+   * Example: https://ringsense.ringcentral.com/calls/2e67979e-ff82-4171-ae30-20c0c1f19b27
+   */
+  rsRecordUri?: string;
+
+  /**
+   * Source rc application of the recording
+   * Required
+   * Example: pbx
+   */
+  domain?: 'pbx';
+
+  /**
+   * Recording ID of the domain
+   * Required
+   * Example: 4b57_384543
+   */
+  sourceRecordId?: string;
+
+  /**
+   * Session ID of the domain
+   * Required
+   * Example: cbac2b78-6f74-4257-8167-dff864de2263!us-10-dca09@us-10
+   */
+  sourceSessionId?: string;
+
+  /**
+   * Optional call direction in case of phone call recording
+   * Example: Inbound
+   */
+  callDirection?: 'Inbound' | 'Outbound';
+
+  /**
+   * Extension id of the call recording owner
+   * Required
+   * Example: 123456789
+   */
+  ownerExtensionId?: string;
+
+  /**
+   * Duration of the call recording (in ms)
+   * Required
+   * Format: int32
+   * Example: 112000
+   */
+  recordingDurationMs?: number;
+
+  /**
+   * Start time of the call recording
+   * Required
+   * Format: date-time
+   */
+  recordingStartTime?: string;
+
+  /**
+   * Creation time of the call insights
+   * Required
+   * Format: date-time
+   */
+  creationTime?: string;
+
+  /**
+   * Last modified time of the call insights
+   * Required
+   * Format: date-time
+   */
+  lastModifiedTime?: string;
+
+  /**
+   * List of the participants in the call
+   * Required
+   */
+  speakerInfo?: object[];
+
+  /**
+   * Required
+   */
+  insights?: AIInsights;
+}
+
+export default RecordingInsights;

package/src/definitions/ScimUserSearchResponse.ts

@@ -1,10 +1,10 @@
-import type ScimUserResponse from './ScimUserResponse';
+import type ScimUserShortInfo from './ScimUserShortInfo';
 
 interface ScimUserSearchResponse {
   /**
    * User list
    */
-  Resources?: ScimUserResponse[];
+  Resources?: ScimUserShortInfo[];
 
   /**
    * Format: int64

package/src/definitions/ScimUserShortInfo.ts

@@ -0,0 +1,62 @@
+import type ScimEmail from './ScimEmail';
+import type ScimName from './ScimName';
+import type ScimPhoto from './ScimPhoto';
+import type ScimEnterpriseUser from './ScimEnterpriseUser';
+import type ScimMeta from './ScimMeta';
+
+interface ScimUserShortInfo {
+  /**
+   * User status
+   */
+  active?: boolean;
+
+  /**
+   * Required
+   */
+  emails?: ScimEmail[];
+
+  /**
+   * External unique resource ID defined by provisioning client
+   */
+  externalId?: string;
+
+  /**
+   * Unique resource ID defined by RingCentral
+   */
+  id?: string;
+
+  /**
+   * Required
+   */
+  name?: ScimName;
+
+  /**
+   */
+  photos?: ScimPhoto[];
+
+  /**
+   * Required
+   */
+  schemas?: 'urn:ietf:params:scim:schemas:core:2.0:User'[];
+
+  /**
+   * User title
+   */
+  title?: string;
+
+  /**
+   */
+  'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User'?: ScimEnterpriseUser;
+
+  /**
+   * MUST be same as work type email address
+   * Required
+   */
+  userName?: string;
+
+  /**
+   */
+  meta?: ScimMeta;
+}
+
+export default ScimUserShortInfo;

package/src/definitions/SearchDirectoryEntriesParameters.ts

@@ -3,8 +3,8 @@
  */
 interface SearchDirectoryEntriesParameters {
   /**
-   * Flag to enable cross-site limitation checking
-   * Example: true
+   * Allows to make lookups across a whole directory skipping a filtering logic of Cross-Site access management feature.
+   * Default: true
    */
   accessibleSitesOnly?: boolean;
 

package/src/definitions/{ServiceInfoPlan.ts → ServiceInfoPlanV2.ts}

@@ -1,7 +1,7 @@
 /**
  * Information on account service plan
  */
-interface ServiceInfoPlan {
+interface ServiceInfoPlanV2 {
   /**
    * Internal identifier of a service plan
    */
@@ -11,10 +11,6 @@ interface ServiceInfoPlan {
    * Name of a service plan
    */
   name?: string;
-
-  /**
-   */
-  freemiumProductType?: 'Freyja' | 'Phoenix';
 }
 
-export default ServiceInfoPlan;
+export default ServiceInfoPlanV2;

package/src/definitions/ServiceInfoV2.ts

@@ -2,7 +2,7 @@ import type ServiceInfoPackage from './ServiceInfoPackage';
 import type ServiceInfoBrand from './ServiceInfoBrand';
 import type ServiceInfoContractedCountryId from './ServiceInfoContractedCountryId';
 import type ServiceInfoUBrand from './ServiceInfoUBrand';
-import type ServiceInfoPlan from './ServiceInfoPlan';
+import type ServiceInfoPlanV2 from './ServiceInfoPlanV2';
 
 /**
  * Service Plan information (billing package, brand, etc.)
@@ -31,7 +31,7 @@ interface ServiceInfoV2 {
 
   /**
    */
-  servicePlan?: ServiceInfoPlan;
+  servicePlan?: ServiceInfoPlanV2;
 }
 
 export default ServiceInfoV2;

package/src/definitions/ShippingInfo.ts

@@ -14,7 +14,7 @@ interface ShippingInfo {
    *  Finally, it is changed to `Shipped` which means that the distributor has shipped the device.
    * Example: Shipped
    */
-  status?: 'Initial' | 'Accepted' | 'Shipped';
+  status?: 'Initial' | 'Accepted' | 'Shipped' | "Won't ship";
 
   /**
    * Shipping carrier name. Appears only if the device status is 'Shipped'

package/src/definitions/SipData.ts

@@ -0,0 +1,23 @@
+/**
+ * SIP (Session Initiation Protocol) information.
+ * Returned if query parameter sipData is set to 'True'
+ *
+ */
+interface SipData {
+  /**
+   * Recipient's data
+   */
+  toTag?: string;
+
+  /**
+   * Sender's data
+   */
+  fromTag?: string;
+
+  /**
+   * SIP call identifier
+   */
+  callId?: string;
+}
+
+export default SipData;

package/src/definitions/SummaryInsightUnit.ts

@@ -0,0 +1,26 @@
+interface SummaryInsightUnit {
+  /**
+   * Value of the summary
+   * Required
+   * Example: conversational insights text
+   */
+  value?: string;
+
+  /**
+   * Start time of the insight (in sec)
+   * Required
+   * Format: float
+   * Example: 1.2
+   */
+  start?: number;
+
+  /**
+   * End time of the insight (in sec)
+   * Required
+   * Format: float
+   * Example: 4.2
+   */
+  end?: number;
+}
+
+export default SummaryInsightUnit;

package/src/definitions/SyncAccountCallLogParameters.ts

@@ -14,7 +14,10 @@ interface SyncAccountCallLogParameters {
   syncToken?: string;
 
   /**
-   * The start datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is the current moment
+   * Starting date for the resulting records in ISO 8601 format, including
+   *  timezone, for example *2016-03-10T18:07:52.534Z*. The range is limited to the last 30 days from the current moment.
+   *  If not specified, the default value is a log history date (date of account creation/call log deletion), and
+   *  no time range limitation applied
    * Format: date-time
    */
   dateFrom?: string;

package/src/definitions/SyncMessagesParameters.ts

@@ -63,9 +63,9 @@ interface SyncMessagesParameters {
   syncType?: 'FSync' | 'ISync';
 
   /**
-   * This query parameter will filter voicemail messages based on its owner.
-   *  This parameter should be controlled by the 'SharedVoicemail' feature.
-   *  If the feature is disabled this filter shouldn't be applied.
+   * Filters voicemail messages based on the owner extension. Supported if the 'SharedVoicemail'
+   *  feature is enabled.
+   * Default: Personal
    */
   voicemailOwner?: string[];
 }

package/src/definitions/SyncUserCallLogParameters.ts

@@ -14,9 +14,10 @@ interface SyncUserCallLogParameters {
   syncToken?: string;
 
   /**
-   * The start datetime for resulting records in ISO 8601 format including
-   *  timezone, for example 2016-03-10T18:07:52.534Z. The default value is the
-   *  current moment
+   * Starting date for the resulting records in ISO 8601 format, including
+   *  timezone, for example *2016-03-10T18:07:52.534Z*. The range is limited to the last 30 days from the current moment.
+   *  If not specified, the default value is a log history date (date of account creation/call log deletion), and
+   *  no time range limitation applied
    * Format: date-time
    */
   dateFrom?: string;

package/src/definitions/TMMessageAttachmentInfo.ts

@@ -15,6 +15,17 @@ interface TMMessageAttachmentInfo {
    */
   type?: 'Card' | 'Event' | 'File' | 'Note' | 'Task';
 
+  /**
+   * Link to a binary content
+   * Format: uri
+   */
+  contentUri?: string;
+
+  /**
+   * Name of a file
+   */
+  name?: string;
+
   /**
    * A string of default text that will be rendered in the case that the client does not support Interactive Messages
    */

package/src/definitions/TelephonySessionsEventPartyInfo.ts

@@ -1,20 +1,28 @@
 import type CallPartyInfo from './CallPartyInfo';
-import type CallSessionStatusInfo from './CallSessionStatusInfo';
+import type RecordingInfo from './RecordingInfo';
+import type CallStatusInfo from './CallStatusInfo';
+import type ParkInfo from './ParkInfo';
+import type SipData from './SipData';
+import type UiCallInfo from './UiCallInfo';
 
 interface TelephonySessionsEventPartyInfo {
   /**
+   * Internal identifier of an account
    */
   accountId?: string;
 
   /**
+   * Internal identifier of an extension
    */
   extensionId?: string;
 
   /**
+   * Internal identifier of a party
    */
   id?: string;
 
   /**
+   * Call direction
    */
   direction?: 'Inbound' | 'Outbound';
 
@@ -28,7 +36,54 @@ interface TelephonySessionsEventPartyInfo {
 
   /**
    */
-  status?: CallSessionStatusInfo;
+  recordings?: RecordingInfo[];
+
+  /**
+   */
+  status?: CallStatusInfo;
+
+  /**
+   */
+  park?: ParkInfo;
+
+  /**
+   * Specifies if it's a queue call
+   */
+  queueCall?: boolean;
+
+  /**
+   * Specifies if a call was missed by the party
+   */
+  missedCall?: boolean;
+
+  /**
+   * If `true` then the party is not connected to a session voice
+   *  conference, `false` means the party is connected to other parties in a
+   *  session
+   */
+  standAlone?: boolean;
+
+  /**
+   * Specifies if a call participant is muted or not. **Note:**
+   *  If a call is also controlled via Hard phone or RingCentral App (not only
+   *  through the API by calling call control methods) then it cannot be fully
+   *  muted/unmuted via API only, in this case the action should be duplicated
+   *  via Hard phone/RC App interfaces
+   */
+  muted?: boolean;
+
+  /**
+   * Defines party role in Server Side Conference
+   */
+  conferenceRole?: 'Host' | 'Participant';
+
+  /**
+   */
+  sipData?: SipData;
+
+  /**
+   */
+  uiCallInfo?: UiCallInfo;
 }
 
 export default TelephonySessionsEventPartyInfo;

package/src/definitions/TemplateInfo.ts

@@ -11,8 +11,13 @@ interface TemplateInfo {
   id?: string;
 
   /**
+   * Description of a template
    */
-  type?: 'UserSettings' | 'CallHandling';
+  description?: string;
+
+  /**
+   */
+  type?: 'UserSettings' | 'CallHandling' | 'LimitedExtensions';
 
   /**
    * Name of a template

package/src/definitions/TranscriptInsightUnit.ts

@@ -0,0 +1,36 @@
+/**
+ * One utterance of a call. Each utterance is a speakerId, text, start and end time
+ */
+interface TranscriptInsightUnit {
+  /**
+   * Participant ID
+   * Required
+   * Example: p-32423
+   */
+  speakerId?: string;
+
+  /**
+   * Text of the utterance
+   * Required
+   * Example: Hello user!
+   */
+  text?: string;
+
+  /**
+   * Start time of the utterance (in sec)
+   * Required
+   * Format: float
+   * Example: 1.2
+   */
+  start?: number;
+
+  /**
+   * End time of the utterance (in sec)
+   * Required
+   * Format: float
+   * Example: 4.2
+   */
+  end?: number;
+}
+
+export default TranscriptInsightUnit;

package/src/definitions/TransitionInfo.ts

@@ -0,0 +1,16 @@
+import type ExtensionRegionalSettingRequest from './ExtensionRegionalSettingRequest';
+
+interface TransitionInfo {
+  /**
+   * Specifies if a welcome/activation email is sent to the new users
+   *  (with the extension status transition from 'Unassigned' to 'NotActivated/Disabled')
+   * Default: true
+   */
+  sendWelcomeEmail?: boolean;
+
+  /**
+   */
+  regionalSettings?: ExtensionRegionalSettingRequest;
+}
+
+export default TransitionInfo;

package/src/definitions/UiCallInfo.ts

@@ -0,0 +1,16 @@
+import type UiCallInfoRecord from './UiCallInfoRecord';
+
+/**
+ * Call information on user interface
+ */
+interface UiCallInfo {
+  /**
+   */
+  primary?: UiCallInfoRecord;
+
+  /**
+   */
+  additional?: UiCallInfoRecord;
+}
+
+export default UiCallInfo;

package/src/definitions/UiCallInfoRecord.ts

@@ -0,0 +1,14 @@
+interface UiCallInfoRecord {
+  /**
+   * UI call info type
+   */
+  type?: 'QueueName' | 'CallerIdName';
+
+  /**
+   * UI call info value
+   * Example: John Doe
+   */
+  value?: string;
+}
+
+export default UiCallInfoRecord;

package/src/definitions/VoicemailOwnerResource.ts

@@ -0,0 +1,16 @@
+/**
+ * Voicemail owner information. Supported for shared voicemail messages only
+ */
+interface VoicemailOwnerResource {
+  /**
+   * Name of a voicemail owner
+   */
+  name?: string;
+
+  /**
+   * Internal identifier of an extension
+   */
+  extensionId?: string;
+}
+
+export default VoicemailOwnerResource;

package/src/index.ts

@@ -208,12 +208,16 @@ class RingCentral implements RingCentralInterface {
       // nothing to revoke
       return;
     }
-    if (!this.rest.clientId || !this.rest.clientSecret) {
-      // no clientId or clientSecret, the token is from external source, cannot revoke
+    if (!this.rest.clientId) {
+      // if no clientId, the token is from external source, cannot revoke
+      // no clientSecret is fine, since PKCE doesn't have clientSecret
       return;
     }
     const temp = tokenToRevoke ?? this.token?.access_token ?? this.token?.refresh_token;
-    await this.restapi(null).oauth().revoke().post({ token: temp });
+    await this.restapi(null)
+      .oauth()
+      .revoke()
+      .post({ token: temp, client_id: this.rest.clientId } as any); // todo: spec doesn't allow client_id
     this.token = undefined;
   }
 

package/src/paths/Ai/Ringsense/V1/Public/Accounts/Domains/Records/Insights/index.ts

@@ -0,0 +1,31 @@
+import type RecordingInsights from '../../../../../../../../../definitions/RecordingInsights';
+import type GetRecordingInsightsParameters from '../../../../../../../../../definitions/GetRecordingInsightsParameters';
+import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../../../../../types';
+
+class Index {
+  public rc: RingCentralInterface;
+  public _parent: ParentInterface;
+
+  public constructor(_parent: ParentInterface) {
+    this._parent = _parent;
+    this.rc = _parent.rc;
+  }
+  public path(): string {
+    return `${this._parent.path()}/insights`;
+  }
+  /**
+   * Returns the insights of a call recording
+   * HTTP Method: get
+   * Endpoint: /ai/ringsense/v1/public/accounts/{accountId}/domains/{domain}/records/{sourceRecordId}/insights
+   * Rate Limit Group: Light
+   * App Permission: RingSense
+   */
+  public async get(
+    queryParams?: GetRecordingInsightsParameters,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<RecordingInsights> {
+    const r = await this.rc.get<RecordingInsights>(this.path(), queryParams, restRequestConfig);
+    return r.data;
+  }
+}
+export default Index;

package/src/paths/Ai/Ringsense/V1/Public/Accounts/Domains/Records/index.ts

@@ -0,0 +1,25 @@
+import Insights from './Insights';
+import type { RingCentralInterface, ParentInterface } from '../../../../../../../../types';
+
+class Index {
+  public rc: RingCentralInterface;
+  public _parent: ParentInterface;
+  public sourceRecordId: string | null;
+
+  public constructor(_parent: ParentInterface, sourceRecordId: string | null = null) {
+    this._parent = _parent;
+    this.rc = _parent.rc;
+    this.sourceRecordId = sourceRecordId;
+  }
+  public path(withParameter = true): string {
+    if (withParameter && this.sourceRecordId !== null) {
+      return `${this._parent.path()}/records/${this.sourceRecordId}`;
+    }
+    return `${this._parent.path()}/records`;
+  }
+
+  public insights(): Insights {
+    return new Insights(this);
+  }
+}
+export default Index;

package/src/paths/Ai/Ringsense/V1/Public/Accounts/Domains/index.ts

@@ -0,0 +1,25 @@
+import Records from './Records';
+import type { RingCentralInterface, ParentInterface } from '../../../../../../../types';
+
+class Index {
+  public rc: RingCentralInterface;
+  public _parent: ParentInterface;
+  public domain: string | null;
+
+  public constructor(_parent: ParentInterface, domain: string | null = null) {
+    this._parent = _parent;
+    this.rc = _parent.rc;
+    this.domain = domain;
+  }
+  public path(withParameter = true): string {
+    if (withParameter && this.domain !== null) {
+      return `${this._parent.path()}/domains/${this.domain}`;
+    }
+    return `${this._parent.path()}/domains`;
+  }
+
+  public records(sourceRecordId: string | null = null): Records {
+    return new Records(this, sourceRecordId);
+  }
+}
+export default Index;

package/src/paths/Ai/Ringsense/V1/Public/Accounts/index.ts

@@ -0,0 +1,25 @@
+import Domains from './Domains';
+import type { RingCentralInterface, ParentInterface } from '../../../../../../types';
+
+class Index {
+  public rc: RingCentralInterface;
+  public _parent: ParentInterface;
+  public accountId: string | null;
+
+  public constructor(_parent: ParentInterface, accountId: string | null = null) {
+    this._parent = _parent;
+    this.rc = _parent.rc;
+    this.accountId = accountId;
+  }
+  public path(withParameter = true): string {
+    if (withParameter && this.accountId !== null) {
+      return `${this._parent.path()}/accounts/${this.accountId}`;
+    }
+    return `${this._parent.path()}/accounts`;
+  }
+
+  public domains(domain: string | null = null): Domains {
+    return new Domains(this, domain);
+  }
+}
+export default Index;