@rc-ex/core 1.3.15 → 1.4.1

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

@@ -20,7 +20,7 @@ class Index {
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/service-info
    * Rate Limit Group: Light
    * App Permission: ReadAccounts
-   * User Permission: ReadServicePlanInfo
+   * User Permission: ReadCompanyInfo
    */
   public async get(restRequestConfig?: RestRequestConfig): Promise<AccountServiceInfo> {
     const r = await this.rc.get<AccountServiceInfo>(this.path(), undefined, restRequestConfig);

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

@@ -1,6 +1,7 @@
 import EmergencyAddressAutoUpdate from './EmergencyAddressAutoUpdate';
 import MessageStoreConfiguration from './MessageStoreConfiguration';
 import AddressBookBulkUpload from './AddressBookBulkUpload';
+import MessageStoreTemplates from './MessageStoreTemplates';
 import CallMonitoringGroups from './CallMonitoringGroups';
 import ExtensionBulkUpdate from './ExtensionBulkUpdate';
 import MessageStoreReport from './MessageStoreReport';
@@ -202,6 +203,10 @@ class Index {
     return new CallMonitoringGroups(this, groupId);
   }
 
+  public messageStoreTemplates(templateId: string | null = null): MessageStoreTemplates {
+    return new MessageStoreTemplates(this, templateId);
+  }
+
   public addressBookBulkUpload(): AddressBookBulkUpload {
     return new AddressBookBulkUpload(this);
   }

package/src/paths/Restapi/Oauth/Authorize/index.ts

@@ -1,4 +1,5 @@
 import type AuthorizeRequest from '../../../../definitions/AuthorizeRequest';
+import type AuthorizeParameters from '../../../../definitions/AuthorizeParameters';
 import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../types';
 
 class Index {
@@ -13,18 +14,32 @@ class Index {
     return `${this._parent.path()}/authorize`;
   }
   /**
-   * Performs OAuth 2.0 authorization (GET version)
+   * Performs Authentication of the End-User by sending the User Agent to the Authorization Server's
+   * Authorization Endpoint for Authentication and Authorization,
+   * using request parameters defined by OAuth 2.0 [RFC-6749](https://datatracker.ietf.org/doc/html/rfc6749#section-3.1)
+   * and additional parameters and parameter values defined by
+   * [OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#AuthorizationEndpoint).
+   *
+   * This is the version that uses HTTP `GET` method.
+   *
    * HTTP Method: get
    * Endpoint: /restapi/oauth/authorize
    * Rate Limit Group: Auth
    */
-  public async get(restRequestConfig?: RestRequestConfig): Promise<string> {
-    const r = await this.rc.get<string>(this.path(), undefined, restRequestConfig);
+  public async get(queryParams?: AuthorizeParameters, restRequestConfig?: RestRequestConfig): Promise<string> {
+    const r = await this.rc.get<string>(this.path(), queryParams, restRequestConfig);
     return r.data;
   }
 
   /**
-   * Performs OAuth 2.0 authorization (POST version)
+   * Performs Authentication of the End-User by sending the User Agent to the Authorization Server's
+   * Authorization Endpoint for Authentication and Authorization,
+   * using request parameters defined by OAuth 2.0 [RFC-6749](https://datatracker.ietf.org/doc/html/rfc6749#section-3.1)
+   * and additional parameters and parameter values defined by
+   * [OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#AuthorizationEndpoint).
+   *
+   * This is the version that uses HTTP `POST` method.
+   *
    * HTTP Method: post
    * Endpoint: /restapi/oauth/authorize
    * Rate Limit Group: Auth

package/src/paths/Restapi/Oauth/Revoke/index.ts

@@ -15,11 +15,13 @@ class Index {
   }
   /**
    * Revokes all active access/refresh tokens and invalidates the OAuth session basing on token provided.
-   * `token` parameter may be passed in query string or body and may represent access or refresh token.
+   * The `token` parameter may be passed in query string or body and may represent access or refresh token.
    *
-   * Depending on client application type
-   * requests to this endpoint may require authentication with HTTP Basic scheme
-   * using registered client ID and client secret as login and password, correspondingly.
+   * This endpoint is defined by [RFC-7009 "OAuth 2.0 Token Revocation"](https://datatracker.ietf.org/doc/html/rfc7009)
+   *
+   * For confidential client application types
+   * this endpoint requires client authentication using one of the supported
+   * methods (`client_secret_basic`, `client_secret_jwt` or `private_key_jwt`)
    *
    * HTTP Method: post
    * Endpoint: /restapi/oauth/revoke

package/src/paths/Restapi/Oauth/Token/index.ts

@@ -16,9 +16,12 @@ class Index {
   /**
    * Returns access (and potentially refresh) tokens for making API requests.
    *
-   * Depending on client application type
-   * requests to this endpoint may require authentication with HTTP Basic scheme
-   * using registered client ID and client secret as login and password, correspondingly.
+   * For confidential client application types
+   * this endpoint requires client authentication using one of the supported
+   * methods (`client_secret_basic`, `client_secret_jwt` or `private_key_jwt`)
+   *
+   * For non-confidential client application types
+   * the client identifier must be provided via `client_id` request attribute.
    *
    * HTTP Method: post
    * Endpoint: /restapi/oauth/token

package/src/paths/Restapi/Oauth/index.ts

@@ -1,5 +1,3 @@
-import SessionInfo from './SessionInfo';
-import Introspect from './Introspect';
 import Authorize from './Authorize';
 import Revoke from './Revoke';
 import Token from './Token';
@@ -28,13 +26,5 @@ class Index {
   public authorize(): Authorize {
     return new Authorize(this);
   }
-
-  public introspect(): Introspect {
-    return new Introspect(this);
-  }
-
-  public sessionInfo(): SessionInfo {
-    return new SessionInfo(this);
-  }
 }
 export default Index;

package/src/paths/Restapi/V2/Accounts/CostCenters/index.ts

@@ -0,0 +1,28 @@
+import type CostCenterList from '../../../../../definitions/CostCenterList';
+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()}/cost-centers`;
+  }
+  /**
+   * Returns the list of cost centers of the account specified in path.
+   * HTTP Method: get
+   * Endpoint: /restapi/v2/accounts/{accountId}/cost-centers
+   * Rate Limit Group: Light
+   * App Permission: ReadAccounts
+   * User Permission: CostCenterManagement
+   */
+  public async get(restRequestConfig?: RestRequestConfig): Promise<CostCenterList> {
+    const r = await this.rc.get<CostCenterList>(this.path(), undefined, restRequestConfig);
+    return r.data;
+  }
+}
+export default Index;

package/src/paths/Restapi/V2/Accounts/Extensions/CallFlipNumbers/index.ts

@@ -0,0 +1,67 @@
+import type CallFlipNumberListResource from '../../../../../../definitions/CallFlipNumberListResource';
+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()}/call-flip-numbers`;
+  }
+  /**
+   * Returns call flip settings. Call flip destination is an extension level setting.
+   * The following numbers can be used for call flip:
+   *
+   * * User's DL numbers (added/removed automatically by the System)
+   * * PSTN numbers in E.164 format (added/removed manually by User)
+   *
+   * Call flip list is generally limited up to 10 numbers.
+   *
+   * **Please note:** This API is only working with the new Communication Handling flow.
+   * To ensure that please check if the 'NewCallHandlingAndForwarding' feature is supported.
+   *
+   * HTTP Method: get
+   * Endpoint: /restapi/v2/accounts/{accountId}/extensions/{extensionId}/call-flip-numbers
+   * Rate Limit Group: Light
+   * App Permission: ReadAccounts
+   */
+  public async get(restRequestConfig?: RestRequestConfig): Promise<CallFlipNumberListResource> {
+    const r = await this.rc.get<CallFlipNumberListResource>(this.path(), undefined, restRequestConfig);
+    return r.data;
+  }
+
+  /**
+   * Updates call flip settings. Call flip destination is an extension level setting.
+   * The following numbers can be used for call flip:
+   *
+   * * User's DL numbers (added/removed automatically by the System)
+   * * PSTN numbers in E.164 format (added/removed manually by User)
+   *
+   * Call flip list is generally limited up to 10 numbers.
+   *
+   * **Please note:** This API is only working with the new Communication Handling flow.
+   * To ensure that please check if the 'NewCallHandlingAndForwarding' feature is supported.
+   *
+   * HTTP Method: put
+   * Endpoint: /restapi/v2/accounts/{accountId}/extensions/{extensionId}/call-flip-numbers
+   * Rate Limit Group: Medium
+   * App Permission: EditExtensions
+   */
+  public async put(
+    callFlipNumberListResource: CallFlipNumberListResource,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<CallFlipNumberListResource> {
+    const r = await this.rc.put<CallFlipNumberListResource>(
+      this.path(),
+      callFlipNumberListResource,
+      undefined,
+      restRequestConfig,
+    );
+    return r.data;
+  }
+}
+export default Index;

package/src/paths/Restapi/V2/Accounts/Extensions/index.ts

@@ -1,3 +1,4 @@
+import CallFlipNumbers from './CallFlipNumbers';
 import Devices from './Devices';
 import type BulkDeleteUsersResponse from '../../../../../definitions/BulkDeleteUsersResponse';
 import type BulkDeleteUsersRequest from '../../../../../definitions/BulkDeleteUsersRequest';
@@ -42,5 +43,9 @@ class Index {
   public devices(deviceId: string | null = null): Devices {
     return new Devices(this, deviceId);
   }
+
+  public callFlipNumbers(): CallFlipNumbers {
+    return new CallFlipNumbers(this);
+  }
 }
 export default Index;

package/src/paths/Restapi/V2/Accounts/PhoneNumbers/BulkAdd/index.ts

@@ -43,7 +43,7 @@ class Index {
   }
 
   /**
-   * Returns the result of asynchronous operation which adds phone numbers to the account Inventory.
+   * Returns the result of asynchronous operation which adds phone numbers to the account inventory.
    *
    * HTTP Method: get
    * Endpoint: /restapi/v2/accounts/{accountId}/phone-numbers/bulk-add/{taskId}

package/src/paths/Restapi/V2/Accounts/PhoneNumbers/Replace/index.ts

@@ -14,7 +14,7 @@ class Index {
     return `${this._parent.path()}/replace`;
   }
   /**
-   * Replaces (swaps) phone numbers from Inventory with the main, company, direct or company fax numbers.
+   * Replaces (swaps) phone numbers from inventory with the main, company, direct or company fax numbers.
    * This method is used to replace temporary numbers when the porting process is complete.
    *
    * HTTP Method: post

package/src/paths/Restapi/V2/Accounts/PhoneNumbers/index.ts

@@ -44,10 +44,10 @@ class Index {
   }
 
   /**
-   * This method can only delete numbers that meet one of the following requirements:
-   *   - numbers that have `"usageType": "Inventory"`
-   *   - `"Forwarded"` numbers
-   *   - `"Forwarded Company"` numbers
+   * This method can only delete numbers that of the following usage types:
+   *   - `Inventory`,
+   *   - `ForwardedNumber`,
+   *   - `ForwardedCompanyNumber`.
    *
    * In other words, this method will not delete numbers which are in use on the account - extension direct numbers,
    * main number, etc. It is possible to indicate phone numbers to be deleted using their IDs or exact string values
@@ -76,8 +76,8 @@ class Index {
    * Assigns or reassigns a phone number as a company or extension number.
    *
    * Assign scenarios supported:
-   * - from Inventory to a company number;
-   * - from Inventory to an extension number.
+   * - from inventory to a company number;
+   * - from inventory to an extension number.
    *
    * Reassign scenarios supported:
    * - from an extension to another extension;

package/src/paths/Restapi/V2/Accounts/index.ts

@@ -3,6 +3,7 @@ import SendWelcomeEmail from './SendWelcomeEmail';
 import BatchProvisioning from './BatchProvisioning';
 import DeviceInventory from './DeviceInventory';
 import PhoneNumbers from './PhoneNumbers';
+import CostCenters from './CostCenters';
 import Extensions from './Extensions';
 import Devices from './Devices';
 import type AccountInfo from '../../../../definitions/AccountInfo';
@@ -48,6 +49,10 @@ class Index {
     return new Extensions(this);
   }
 
+  public costCenters(): CostCenters {
+    return new CostCenters(this);
+  }
+
   public phoneNumbers(phoneNumberId: string | null = null): PhoneNumbers {
     return new PhoneNumbers(this, phoneNumberId);
   }

package/src/paths/TeamMessaging/V1/Chats/Posts/index.ts

@@ -37,7 +37,11 @@ class Index {
   }
 
   /**
-   * Creates a post in the chat specified in path. Any mention can be added within the `text` attribute of the request body in .md format - `![:Type](id)`, where `type` is one of (Person, Team, File, Note, Task, Event, Link, Card) and `id` is a unique identifier of the mentioned object of the specified type. Attachments of the following types (File, Card, Event, Note) can also be added to a post by passing type and ID of attachment(s) in request body.
+   * Creates a post in the chat specified in path. Any mention can be added within the `text` attribute of
+   * the request body in .md format - `![:Type](id)`, where `type` is one of (Person, Team, File, Note,
+   * Task, Event, Link, Card) and `id` is a unique identifier of the mentioned object of the specified type.
+   * Attachments can also be added to a post by passing the type and ID of attachment(s) in request body.
+   *
    * HTTP Method: post
    * Endpoint: /team-messaging/v1/chats/{chatId}/posts
    * Rate Limit Group: Medium