@rc-ex/core 1.3.14 → 1.4.0

package/src/definitions/TokenInfo.ts

@@ -7,7 +7,7 @@ interface TokenInfo {
   access_token?: string;
 
   /**
-   * Issued access token TTL (time-to-live) in seconds
+   * Access token TTL (time-to-live) in seconds
    * Required
    * Format: int32
    * Example: 7199
@@ -15,68 +15,74 @@ interface TokenInfo {
   expires_in?: number;
 
   /**
-   * OAuth refresh token (in case the one was issued)
+   * OAuth refresh token (if issued)
    * Example: U1BCMDFUMDRKV1MwMXxzLFL4ec6A0XMsUv9wLriecyxS_w
    */
   refresh_token?: string;
 
   /**
-   * Issued refresh token TTL (time-to-live) in seconds
+   * Refresh token TTL (time-to-live) in seconds
    * Format: int32
    * Example: 604799
    */
   refresh_token_expires_in?: number;
 
   /**
-   * List of permissions (space separated) granted to the application with this access token
+   * The list of space separated application permissions (OAuth scopes)
    * Required
    * Example: AccountInfo CallLog ExtensionInfo Messages SMS
    */
   scope?: string;
 
   /**
-   * Type of token. The only supported value is `bearer`. This value should be used when specifying access token in `Authorization` header of subsequent API requests
+   * Type of the token. The only supported value is `bearer`. This value should be used when specifying access token in `Authorization` header of subsequent API requests
    * Required
    * Example: bearer
    */
-  token_type?: string;
+  token_type?: 'bearer';
 
   /**
-   * Token owner (extension/user) identifier
+   * Token owner's identifier. Contains RingCentral user (extension) ID
    * Example: 256440016
    */
   owner_id?: string;
 
   /**
-   * Application instance identifier
+   * Client application instance identifier that matches the value provided by the client,
+   *  or generated by the server if a client has not provided this value
    * Example: 8zXq6oaLT7WvwWITlGiA1A
    */
   endpoint_id?: string;
 
   /**
-   * OIDC ID token (if OpenID Connect flow was activated during authorization)
+   * OpenID Connect ID token (if OpenID Connect flow was activated during authorization)
    */
   id_token?: string;
 
   /**
-   * OAuth session ID
+   * Remaining time in seconds until session expiration due to absolute timeout.
+   *  Returned only if absolute session timeout is enforced
+   * Format: int32
    */
-  session_id?: string;
+  session_expires_in?: number;
 
   /**
-   * Absolute value of session expiration time as an ISO timestamp
+   * Absolute value of session expiration time in ISO date formatted string.
+   *  Returned only if absolute session timeout is enforced
    * Format: date-time
+   * Example: 2023-04-01T12:00:01Z
    */
   session_expiration_time?: string;
 
   /**
-   * Remaining time (in seconds) until session expiration due to the absolute timeout
-   * Format: int32
+   * OAuth session ID
+   * Required
    */
-  session_expires_in?: number;
+  session_id?: string;
 
   /**
-   * Nominal session idle timeout in seconds
+   * Nominal value of session idle timeout in seconds.
+   *  Returned only if idle session timeout is enforced
    * Format: int32
    */
   session_idle_timeout?: number;

package/src/paths/Cx/SocialMessaging/V1/Identities/index.ts

@@ -1,4 +1,4 @@
-import type SocMsgListIdentitiesParameters from '../../../../../definitions/SocMsgListIdentitiesParameters';
+import type ListSocialMessagingIdentitiesParameters from '../../../../../definitions/ListSocialMessagingIdentitiesParameters';
 import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../types';
 
 class Index {
@@ -18,15 +18,14 @@ class Index {
     return `${this._parent.path()}/identities`;
   }
   /**
-   * List identities by creation date. The default order is descending.
+   * Returns a list of identities filtered by creation date. The default order is descending.
    *
-   * The account context of this request is determined by the RC Account Id associated with the access token provided
-   * in the Authorization header.
+   * The account context of this request is determined by the RC Account ID associated with
+   * the access token provided in the Authorization header.
    *
-   * The query parameters provided shall be considered an AND operation to filter the list.
+   * The query parameters provided will be considered an AND operation to filter the list.
    *
-   * A query parameter not specified or a query parameter provided with no value is treated as not required for
-   * filtering the list.
+   * A query parameter which is not specified or provided with the null value will be ignored.
    *
    * HTTP Method: get
    * Endpoint: /cx/social-messaging/v1/identities
@@ -34,7 +33,7 @@ class Index {
    * App Permission: SocialMessaging
    */
   public async list(
-    queryParams?: SocMsgListIdentitiesParameters,
+    queryParams?: ListSocialMessagingIdentitiesParameters,
     restRequestConfig?: RestRequestConfig,
   ): Promise<string> {
     const r = await this.rc.get<string>(this.path(false), queryParams, restRequestConfig);
@@ -42,8 +41,7 @@ class Index {
   }
 
   /**
-   * Renders an identity from given id.
-   *
+   * Returns an identity by ID specified in path.
    * HTTP Method: get
    * Endpoint: /cx/social-messaging/v1/identities/{identityId}
    * Rate Limit Group: Light

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

@@ -0,0 +1,115 @@
+import type MessageTemplateUpdateRequest from '../../../../../definitions/MessageTemplateUpdateRequest';
+import type MessageTemplateResponse from '../../../../../definitions/MessageTemplateResponse';
+import type MessageTemplateRequest from '../../../../../definitions/MessageTemplateRequest';
+import type MessageTemplatesListResponse from '../../../../../definitions/MessageTemplatesListResponse';
+import type ListUserMessageTemplatesParameters from '../../../../../definitions/ListUserMessageTemplatesParameters';
+import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../types';
+
+class Index {
+  public rc: RingCentralInterface;
+  public _parent: ParentInterface;
+  public templateId: string | null;
+
+  public constructor(_parent: ParentInterface, templateId: string | null = null) {
+    this._parent = _parent;
+    this.rc = _parent.rc;
+    this.templateId = templateId;
+  }
+  public path(withParameter = true): string {
+    if (withParameter && this.templateId !== null) {
+      return `${this._parent.path()}/message-store-templates/${this.templateId}`;
+    }
+    return `${this._parent.path()}/message-store-templates`;
+  }
+  /**
+   * Returns a list of user's personal text message templates.
+   * HTTP Method: get
+   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store-templates
+   * Rate Limit Group: Light
+   * App Permission: ReadAccounts
+   */
+  public async list(
+    queryParams?: ListUserMessageTemplatesParameters,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<MessageTemplatesListResponse> {
+    const r = await this.rc.get<MessageTemplatesListResponse>(this.path(false), queryParams, restRequestConfig);
+    return r.data;
+  }
+
+  /**
+   * Creates a user personal text message template.
+   * Maximum number of personal templates is 25 per user.
+   * Max length of the `body` property is 1000 symbols (2-byte UTF-16 encoded).
+   *
+   * HTTP Method: post
+   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store-templates
+   * Rate Limit Group: Medium
+   * App Permission: EditExtensions
+   */
+  public async post(
+    messageTemplateRequest: MessageTemplateRequest,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<MessageTemplateResponse> {
+    const r = await this.rc.post<MessageTemplateResponse>(
+      this.path(false),
+      messageTemplateRequest,
+      undefined,
+      restRequestConfig,
+    );
+    return r.data;
+  }
+
+  /**
+   * Returns a user personal text message template by ID.
+   * HTTP Method: get
+   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store-templates/{templateId}
+   * Rate Limit Group: Light
+   * App Permission: ReadAccounts
+   */
+  public async get(restRequestConfig?: RestRequestConfig): Promise<MessageTemplateResponse> {
+    if (this.templateId === null) {
+      throw new Error('templateId must be specified.');
+    }
+    const r = await this.rc.get<MessageTemplateResponse>(this.path(), undefined, restRequestConfig);
+    return r.data;
+  }
+
+  /**
+   * Updates a user personal text message template.
+   * HTTP Method: put
+   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store-templates/{templateId}
+   * Rate Limit Group: Medium
+   * App Permission: EditExtensions
+   */
+  public async put(
+    messageTemplateUpdateRequest: MessageTemplateUpdateRequest,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<MessageTemplateResponse> {
+    if (this.templateId === null) {
+      throw new Error('templateId must be specified.');
+    }
+    const r = await this.rc.put<MessageTemplateResponse>(
+      this.path(),
+      messageTemplateUpdateRequest,
+      undefined,
+      restRequestConfig,
+    );
+    return r.data;
+  }
+
+  /**
+   * Deletes a user personal text message template.
+   * HTTP Method: delete
+   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store-templates/{templateId}
+   * Rate Limit Group: Medium
+   * App Permission: EditExtensions
+   */
+  public async delete(restRequestConfig?: RestRequestConfig): Promise<string> {
+    if (this.templateId === null) {
+      throw new Error('templateId must be specified.');
+    }
+    const r = await this.rc.delete<string>(this.path(), {}, undefined, restRequestConfig);
+    return r.data;
+  }
+}
+export default Index;

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

@@ -1,3 +1,4 @@
+import MessageStoreTemplates from './MessageStoreTemplates';
 import NotificationSettings from './NotificationSettings';
 import CallQueuePresence from './CallQueuePresence';
 import VideoConfiguration from './VideoConfiguration';
@@ -287,5 +288,9 @@ class Index {
   public notificationSettings(): NotificationSettings {
     return new NotificationSettings(this);
   }
+
+  public messageStoreTemplates(templateId: string | null = null): MessageStoreTemplates {
+    return new MessageStoreTemplates(this, templateId);
+  }
 }
 export default Index;

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

@@ -0,0 +1,112 @@
+import type MessageTemplateUpdateRequest from '../../../../definitions/MessageTemplateUpdateRequest';
+import type MessageTemplateResponse from '../../../../definitions/MessageTemplateResponse';
+import type MessageTemplateRequest from '../../../../definitions/MessageTemplateRequest';
+import type MessageTemplatesListResponse from '../../../../definitions/MessageTemplatesListResponse';
+import type ListCompanyMessageTemplatesParameters from '../../../../definitions/ListCompanyMessageTemplatesParameters';
+import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../types';
+
+class Index {
+  public rc: RingCentralInterface;
+  public _parent: ParentInterface;
+  public templateId: string | null;
+
+  public constructor(_parent: ParentInterface, templateId: string | null = null) {
+    this._parent = _parent;
+    this.rc = _parent.rc;
+    this.templateId = templateId;
+  }
+  public path(withParameter = true): string {
+    if (withParameter && this.templateId !== null) {
+      return `${this._parent.path()}/message-store-templates/${this.templateId}`;
+    }
+    return `${this._parent.path()}/message-store-templates`;
+  }
+  /**
+   * Returns a list of company text message templates.
+   * HTTP Method: get
+   * Endpoint: /restapi/{apiVersion}/account/{accountId}/message-store-templates
+   * Rate Limit Group: Light
+   * App Permission: ReadAccounts
+   */
+  public async list(
+    queryParams?: ListCompanyMessageTemplatesParameters,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<MessageTemplatesListResponse> {
+    const r = await this.rc.get<MessageTemplatesListResponse>(this.path(false), queryParams, restRequestConfig);
+    return r.data;
+  }
+
+  /**
+   * Creates a new text message template on a company level. Maximum number of company templates is 50.
+   * HTTP Method: post
+   * Endpoint: /restapi/{apiVersion}/account/{accountId}/message-store-templates
+   * Rate Limit Group: Medium
+   * App Permission: EditAccounts
+   */
+  public async post(
+    messageTemplateRequest: MessageTemplateRequest,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<MessageTemplateResponse> {
+    const r = await this.rc.post<MessageTemplateResponse>(
+      this.path(false),
+      messageTemplateRequest,
+      undefined,
+      restRequestConfig,
+    );
+    return r.data;
+  }
+
+  /**
+   * Returns a company text message template by ID.
+   * HTTP Method: get
+   * Endpoint: /restapi/{apiVersion}/account/{accountId}/message-store-templates/{templateId}
+   * Rate Limit Group: Light
+   * App Permission: ReadAccounts
+   */
+  public async get(restRequestConfig?: RestRequestConfig): Promise<MessageTemplateResponse> {
+    if (this.templateId === null) {
+      throw new Error('templateId must be specified.');
+    }
+    const r = await this.rc.get<MessageTemplateResponse>(this.path(), undefined, restRequestConfig);
+    return r.data;
+  }
+
+  /**
+   * Updates a company text message template.
+   * HTTP Method: put
+   * Endpoint: /restapi/{apiVersion}/account/{accountId}/message-store-templates/{templateId}
+   * Rate Limit Group: Medium
+   * App Permission: EditAccounts
+   */
+  public async put(
+    messageTemplateUpdateRequest: MessageTemplateUpdateRequest,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<MessageTemplateResponse> {
+    if (this.templateId === null) {
+      throw new Error('templateId must be specified.');
+    }
+    const r = await this.rc.put<MessageTemplateResponse>(
+      this.path(),
+      messageTemplateUpdateRequest,
+      undefined,
+      restRequestConfig,
+    );
+    return r.data;
+  }
+
+  /**
+   * Deletes a company text message template.
+   * HTTP Method: delete
+   * Endpoint: /restapi/{apiVersion}/account/{accountId}/message-store-templates/{templateId}
+   * Rate Limit Group: Medium
+   * App Permission: EditAccounts
+   */
+  public async delete(restRequestConfig?: RestRequestConfig): Promise<string> {
+    if (this.templateId === null) {
+      throw new Error('templateId must be specified.');
+    }
+    const r = await this.rc.delete<string>(this.path(), {}, undefined, restRequestConfig);
+    return r.data;
+  }
+}
+export default Index;

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;