@rc-ex/core 1.4.1 → 1.5.0

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

@@ -0,0 +1,20 @@
+import Accounts from './Accounts';
+import type { RingCentralInterface, ParentInterface } 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(false)}/public`;
+  }
+
+  public accounts(accountId: string | null = null): Accounts {
+    return new Accounts(this, accountId);
+  }
+}
+export default Index;

package/src/paths/{Cx/SocialMessaging → Ai/Ringsense}/V1/index.ts

@@ -1,5 +1,4 @@
-import Identities from './Identities';
-import Contents from './Contents';
+import Public from './Public';
 import type { RingCentralInterface, ParentInterface } from '../../../../types';
 
 class Index {
@@ -14,12 +13,8 @@ class Index {
     return `${this._parent.path(false)}/v1`;
   }
 
-  public contents(contentId: string | null = null): Contents {
-    return new Contents(this, contentId);
-  }
-
-  public identities(identityId: string | null = null): Identities {
-    return new Identities(this, identityId);
+  public public(): Public {
+    return new Public(this);
   }
 }
 export default Index;

package/src/paths/{Cx/SocialMessaging → Ai/Ringsense}/index.ts

@@ -10,7 +10,7 @@ class Index {
     this.rc = _parent.rc;
   }
   public path(): string {
-    return `${this._parent.path(false)}/social-messaging`;
+    return `${this._parent.path(false)}/ringsense`;
   }
 
   public v1(): V1 {

package/src/paths/Ai/index.ts

@@ -1,3 +1,4 @@
+import Ringsense from './Ringsense';
 import Insights from './Insights';
 import Status from './Status';
 import Audio from './Audio';
@@ -29,5 +30,9 @@ class Index {
   public insights(): Insights {
     return new Insights(this);
   }
+
+  public ringsense(): Ringsense {
+    return new Ringsense(this);
+  }
 }
 export default Index;

package/src/paths/Restapi/Account/CallLog/index.ts

@@ -37,7 +37,9 @@ class Index {
   }
 
   /**
-   * Returns individual call log record(s) by ID. Batch syntax is supported.
+   * Returns individual call log record(s) by ID.
+   * [Batch syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported.
+   *
    * HTTP Method: get
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/call-log/{callRecordId}
    * Rate Limit Group: Heavy

package/src/paths/Restapi/Account/Extension/AddressBook/Contact/index.ts

@@ -62,7 +62,7 @@ class Index {
 
   /**
    * Returns the user personal contact(s).
-   * [Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported.
+   * [Batch request syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported.
    *
    * HTTP Method: get
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId}
@@ -80,7 +80,7 @@ class Index {
 
   /**
    * Updates the user personal contact(s) (full resource update).
-   * [Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported.
+   * [Batch request syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported.
    *
    * HTTP Method: put
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId}
@@ -107,7 +107,7 @@ class Index {
 
   /**
    * Deletes the user personal contact(s).
-   * [Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported.
+   * [Batch request syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported.
    *
    * HTTP Method: delete
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId}

package/src/paths/Restapi/Account/Extension/CallerBlocking/PhoneNumbers/index.ts

@@ -59,7 +59,7 @@ class Index {
 
   /**
    * Returns blocked or allowed phone number(s) by their ID(s).
-   * [Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported.
+   * [Batch request syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported.
    *
    * HTTP Method: get
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers/{blockedNumberId}
@@ -77,7 +77,7 @@ class Index {
 
   /**
    * Updates blocked or allowed phone number(s) by their ID(s).
-   * [Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported.
+   * [Batch request syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported.
    *
    * HTTP Method: put
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers/{blockedNumberId}
@@ -102,7 +102,9 @@ class Index {
   }
 
   /**
-   * Deletes blocked or allowed phone number(s) by their ID(s). Batch request is supported.
+   * Deletes blocked or allowed phone number(s) by their ID(s).
+   * [Batch request](https://developers.ringcentral.com/guide/basics/batch-requests) is supported.
+   *
    * HTTP Method: delete
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers/{blockedNumberId}
    * Rate Limit Group: Medium

package/src/paths/Restapi/Account/Extension/Device/index.ts

@@ -14,8 +14,8 @@ class Index {
     return `${this._parent.path()}/device`;
   }
   /**
-   * Returns devices of an extension or multiple extensions by their ID(s). Batch request
-   * is supported.
+   * Returns devices of an extension or multiple extensions by their ID(s).
+   * [Batch request syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported.
    *
    * HTTP Method: get
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/device

package/src/paths/Restapi/Account/Extension/MessageStore/index.ts

@@ -41,12 +41,11 @@ class Index {
   }
 
   /**
-   * Deletes conversation(s) by conversation ID(s). Batch request is
-   * supported, max number of IDs passed as query/path parameters is 50. Alternative
-   * syntax is supported - user conversations can be deleted by passing multiple
-   * IDs in request body as an array of string, max number of conversation IDs
-   * passed in request body is 100. In this case asterisk is used in the path instead
-   * of IDs
+   * Deletes conversation(s) by conversation ID(s).
+   * [Batch request syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported - maximum number
+   * of IDs passed as query/path parameters is 50. Alternative syntax is supported - the user's conversations can be deleted
+   * by passing multiple IDs in request body as an array of string. Maximum number of conversation IDs passed in request body
+   * is 100. In this case asterisk '*' is used in the path instead of IDs.
    *
    * HTTP Method: delete
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store
@@ -64,7 +63,8 @@ class Index {
 
   /**
    * Returns an individual message record or multiple records by the given message ID(s).
-   * The length of inbound messages is unlimited. Bulk syntax is supported.
+   * The length of inbound messages is unlimited. [Bulk syntax](https://developers.ringcentral.com/guide/basics/batch-requests)
+   * is supported.
    *
    * HTTP Method: get
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store/{messageId}
@@ -83,12 +83,11 @@ class Index {
   /**
    * Updates message(s) by their ID(s). Currently, only the `readStatus`
    * can be updated using this method.
-   *
-   * Bulk syntax is supported, max number of IDs passed as query/path
-   * parameters is 50. Alternative bulk syntax is also supported - user messages can be updated
-   * by passing multiple IDs in request body as an array of string, max number
-   * of IDs passed in the body is 1000. In this case asterisk is used in the
-   * path instead of IDs.
+   * [Bulk syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported,
+   * maximum number of IDs passed as query/path parameters is 50. Alternative bulk syntax is also
+   * supported - the user's messages can be updated by passing multiple IDs in request body as
+   * an array of string, maximum number of IDs passed in the body is 1000. In this case asterisk '*'
+   * is used in the path instead of IDs.
    *
    * HTTP Method: put
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store/{messageId}

package/src/paths/Restapi/Account/Extension/Presence/index.ts

@@ -20,7 +20,7 @@ class Index {
    * (the parameters `telephonyStatus`, `message`, `userStatus` and `dndStatus` are not returned at all) for the following extension types:
    * Department/Announcement Only/Take Messages Only (Voicemail)/Fax User/Paging Only Group/Shared Lines Group/IVR Menu/Application Extension/Park Location.
    * If the user requests his/her own presence status, the response contains actual presence status even if the status publication is turned off.
-   * [Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported. For batch requests the number of extensions
+   * [Batch request syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported. For batch requests the number of extensions
    * in one request is limited to 30. If more extensions are included in the request, the error code 400 Bad Request is returned with the logical error
    * code InvalidMultipartRequest and the corresponding message Extension Presence Info multipart request is limited to 30 extensions.
    *

package/src/paths/Restapi/Account/PhoneNumber/index.ts

@@ -39,7 +39,7 @@ class Index {
 
   /**
    * Returns phone number(s) belonging to a certain account or extension by phoneNumberId(s).
-   * [Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported.
+   * [Batch request syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported.
    *
    * HTTP Method: get
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/phone-number/{phoneNumberId}

package/src/paths/Restapi/Account/Telephony/Metadata/MultichannelRecordings/Content/index.ts

@@ -0,0 +1,33 @@
+import type ReadMultichannelCallRecordingContentParameters from '../../../../../../../definitions/ReadMultichannelCallRecordingContentParameters';
+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()}/content`;
+  }
+  /**
+   * Returns media content of a multichannel call recording
+   *
+   * **This API must be called via media API entry point, e.g. https://media.ringcentral.com**
+   *
+   * HTTP Method: get
+   * Endpoint: /restapi/{apiVersion}/account/{accountId}/telephony/metadata/multichannel-recordings/{metadataId}/content
+   * Rate Limit Group: Heavy
+   * App Permission: ReadCallRecording
+   */
+  public async get(
+    queryParams?: ReadMultichannelCallRecordingContentParameters,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<string> {
+    const r = await this.rc.get<string>(this.path(), queryParams, restRequestConfig);
+    return r.data;
+  }
+}
+export default Index;

package/src/paths/Restapi/Account/Telephony/Metadata/MultichannelRecordings/index.ts

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

package/src/paths/Restapi/Account/Telephony/Metadata/index.ts

@@ -0,0 +1,20 @@
+import MultichannelRecordings from './MultichannelRecordings';
+import type { RingCentralInterface, ParentInterface } 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(false)}/metadata`;
+  }
+
+  public multichannelRecordings(metadataId: string | null = null): MultichannelRecordings {
+    return new MultichannelRecordings(this, metadataId);
+  }
+}
+export default Index;

package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Recordings/index.ts

@@ -20,7 +20,9 @@ class Index {
     return `${this._parent.path()}/recordings`;
   }
   /**
-   * Starts a new call recording for the party
+   * Starts a new call recording for a call party.
+   * *Please note* this API does not allow conference calls to be recorded.
+   *
    * HTTP Method: post
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/recordings
    * Rate Limit Group: Light

package/src/paths/Restapi/Account/Telephony/index.ts

@@ -1,6 +1,7 @@
 import Conference from './Conference';
 import CallOut from './CallOut';
 import Sessions from './Sessions';
+import Metadata from './Metadata';
 import type { RingCentralInterface, ParentInterface } from '../../../../types';
 
 class Index {
@@ -15,6 +16,10 @@ class Index {
     return `${this._parent.path()}/telephony`;
   }
 
+  public metadata(): Metadata {
+    return new Metadata(this);
+  }
+
   public sessions(telephonySessionId: string | null = null): Sessions {
     return new Sessions(this, telephonySessionId);
   }

package/src/paths/TeamMessaging/V1/Persons/index.ts

@@ -18,7 +18,9 @@ class Index {
     return `${this._parent.path()}/persons`;
   }
   /**
-   * Returns a user or multiple users by their ID(s). Batch request is supported.
+   * Returns a user or multiple users by their ID(s).
+   * [Batch requests](https://developers.ringcentral.com/guide/basics/batch-requests) are supported.
+   *
    * HTTP Method: get
    * Endpoint: /team-messaging/v1/persons/{personId}
    * Rate Limit Group: Light