@rc-ex/core 1.3.8 → 1.3.10

package/src/definitions/PermissionsCapabilities.ts

@@ -0,0 +1,21 @@
+/**
+ * Advanced permissions capabilities. Returned if `advancedPermissions` query parameter is set to `true`.
+ */
+interface PermissionsCapabilities {
+  /**
+   * Specifies whether the user is enabled with the listed permission or not
+   */
+  enabled?: boolean;
+
+  /**
+   * Specifies if the user can manage the listed permission and is allowed to enable it on other users
+   */
+  manageEnabled?: boolean;
+
+  /**
+   * Specifies if the users who were enabled with the listed permission can grant it further to other users
+   */
+  grantEnabled?: boolean;
+}
+
+export default PermissionsCapabilities;

package/src/definitions/ReadUserRoleParameters.ts

@@ -0,0 +1,12 @@
+/**
+ * Query parameters for operation readUserRole
+ */
+interface ReadUserRoleParameters {
+  /**
+   * Specifies whether to return advanced permissions capabilities within `permissionsCapabilities` resource.
+   *  The default value is false.
+   */
+  advancedPermissions?: boolean;
+}
+
+export default ReadUserRoleParameters;

package/src/definitions/Recording.ts

@@ -5,35 +5,51 @@ import type JsValue from './JsValue';
  */
 interface Recording {
   /**
-   * recording id
+   * Recording id
+   * Required
    */
   id?: string;
 
   /**
-   * recording start time
+   * Recording start time
    * Format: int64
    */
   startTime?: number;
 
   /**
-   * recording url
+   * Secure Link to the recording file
    */
-  contentUri?: string;
+  url?: string;
 
   /**
    */
   metadata?: JsValue;
 
   /**
-   * recording status
+   * Recording processing status
    */
-  status?: 'Processing' | 'Processed' | 'Error' | 'Corrupted' | 'InProgress';
+  status?: 'Processing' | 'Processed' | 'Error' | 'Corrupted' | 'InProgress' | 'Purged' | 'Failed';
 
   /**
-   * availability status
+   * Availability status
    * Required
    */
   availabilityStatus?: 'Alive' | 'Deleted' | 'Purged' | 'NotAvailable';
+
+  /**
+   * During meeting AI team analyze code and after meeting finished generates text summary about this meeting
+   */
+  longSummary?: string;
+
+  /**
+   * During meeting AI team analyze code and after meeting finished generates text summary about this meeting
+   */
+  shortSummary?: string;
+
+  /**
+   * During meeting AI team analyze code and after meeting finished generates key words used in meeting
+   */
+  keywords?: string[];
 }
 
 export default Recording;

package/src/definitions/RecordingsPreferences.ts

@@ -1,4 +1,5 @@
 import type EveryoneCanControl from './EveryoneCanControl';
+import type AutoShared from './AutoShared';
 
 /**
  * Recordings preferences
@@ -7,6 +8,10 @@ interface RecordingsPreferences {
   /**
    */
   everyoneCanControl?: EveryoneCanControl;
+
+  /**
+   */
+  autoShared?: AutoShared;
 }
 
 export default RecordingsPreferences;

package/src/definitions/RoleResource.ts

@@ -2,20 +2,24 @@ import type PermissionIdResource from './PermissionIdResource';
 
 interface RoleResource {
   /**
+   * Link to a role resource
    * Format: uri
    */
   uri?: string;
 
   /**
+   * Internal identifier of a role
    */
   id?: string;
 
   /**
+   * Dispayed name of a role
    * Example: Super Admin
    */
   displayName?: string;
 
   /**
+   * Role description
    * Example: Primary company administrator role
    */
   description?: string;
@@ -26,12 +30,14 @@ interface RoleResource {
   siteCompatible?: boolean;
 
   /**
+   * Specifies if a user role is custom
    */
   custom?: boolean;
 
   /**
+   * Specifies resource for permission
    */
-  scope?: string;
+  scope?: 'Account' | 'AllExtensions' | 'Federation' | 'NonUserExtensions' | 'RoleBased' | 'Self' | 'UserExtensions';
 
   /**
    */

package/src/definitions/SessionInfoResponse.ts

@@ -0,0 +1,50 @@
+interface SessionInfoResponse {
+  /**
+   * Identifier (key) of a client application
+   * Required
+   */
+  client_id?: string;
+
+  /**
+   * List of permissions (space separated) granted to the application with this token
+   * Example: AccountInfo CallLog ExtensionInfo Messages SMS
+   */
+  scope?: string;
+
+  /**
+   * Subject of the token (extension ID or the owner)
+   */
+  sub?: string;
+
+  /**
+   * RC account ID associated with the token
+   */
+  account_id?: string;
+
+  /**
+   * Remaining time in seconds until session expiration due to absolute timeout
+   * Format: int32
+   */
+  session_expires_in?: number;
+
+  /**
+   * Absolute value of session expiration time in ISO date formatted string
+   * Format: date-time
+   * Example: 2023-04-01T12:00:01Z
+   */
+  session_expiration_time?: string;
+
+  /**
+   * OAuth session ID
+   * Required
+   */
+  session_id?: string;
+
+  /**
+   * Nominal value of session idle timeout in seconds
+   * Format: int32
+   */
+  session_idle_timeout?: number;
+}
+
+export default SessionInfoResponse;

package/src/definitions/SipInfoResponse.ts

@@ -5,7 +5,7 @@ interface SipInfoResponse {
   username?: string;
 
   /**
-   * User password
+   * User password. Not returned if SipDigest is not enabled
    * Format: password
    */
   password?: string;

package/src/definitions/SocMsgListContentsParameters.ts

@@ -0,0 +1,70 @@
+/**
+ * Query parameters for operation socMsgListContents
+ */
+interface SocMsgListContentsParameters {
+  /**
+   * Filter based on the specified intervention identifiers.
+   * Example: 7f946431b6eebffafae642cc,re946431b6eebffafae642cc
+   */
+  intervention?: string[];
+
+  /**
+   * Filter based on the specified identity identifiers.
+   * Example: 7f946431b6eebffafae642cc,re946431b6eebffafae642cc
+   */
+  identity?: string[];
+
+  /**
+   * Filter based on the specified identity group identifiers.
+   * Example: 7f946431b6eebffafae642cc,re946431b6eebffafae642cc
+   */
+  identityGroup?: string[];
+
+  /**
+   * Filter based on the specified channel identifiers.
+   * Example: 7f946431b6eebffafae642cc
+   */
+  source?: string[];
+
+  /**
+   * Filter based on the specified thread identifiers.
+   * Example: 7f946431b6eebffafae642cc
+   */
+  thread?: string[];
+
+  /**
+   * Filter based on the specified text(s). Provided multiple times, the values are ANDed.
+   */
+  text?: string[];
+
+  /**
+   * Filter for specified status.
+   */
+  status?: ('New' | 'Assigned' | 'Replied' | 'UserReply' | 'UserInitiated' | 'Ignored')[];
+
+  /**
+   * Ordering by creationTime is descending by default.
+   * Example: +creationTime
+   * Default: -creationTime
+   */
+  orderBy?: '-creationTime' | '+creationTime' | 'creationTime';
+
+  /**
+   * The token indicating the particular page of the result set to be retrieved.
+   *  If omitted the first page will be returned.
+   */
+  pageToken?: string;
+
+  /**
+   * The number of items per page. If provided value in the request
+   *  is greater than a maximum, the maximum value is applied
+   * Maximum: 1000
+   * Minimum: 1
+   * Format: int32
+   * Example: 100
+   * Default: 100
+   */
+  perPage?: number;
+}
+
+export default SocMsgListContentsParameters;

package/src/definitions/SocMsgListIdentitiesParameters.ts

@@ -0,0 +1,50 @@
+/**
+ * Query parameters for operation socMsgListIdentities
+ */
+interface SocMsgListIdentitiesParameters {
+  /**
+   * Filter based on the specified sourceId.
+   */
+  sourceId?: string;
+
+  /**
+   * Filter based on the specified identityGroupId.
+   */
+  identityGroupId?: string;
+
+  /**
+   * Filter based on the specified userId.
+   */
+  userId?: string;
+
+  /**
+   * Filter based on the specified uuid.
+   */
+  uuid?: string;
+
+  /**
+   * Ordering by creationTime is descending by default.
+   * Example: +creationTime
+   * Default: -creationTime
+   */
+  orderBy?: '-creationTime' | '+creationTime' | 'creationTime';
+
+  /**
+   * The token indicating the particular page of the result set to be retrieved.
+   *  If omitted the first page will be returned.
+   */
+  pageToken?: string;
+
+  /**
+   * The number of items per page. If provided value in the request
+   *  is greater than a maximum, the maximum value is applied
+   * Maximum: 1000
+   * Minimum: 1
+   * Format: int32
+   * Example: 100
+   * Default: 100
+   */
+  perPage?: number;
+}
+
+export default SocMsgListIdentitiesParameters;

package/src/definitions/TokenInfo.ts

@@ -57,6 +57,29 @@ interface TokenInfo {
    * OIDC ID token (if OpenId Connect flow was activated during authorization)
    */
   id_token?: string;
+
+  /**
+   * OAuth session ID
+   */
+  session_id?: string;
+
+  /**
+   * Absolute value of session expiration time as ISO datetime
+   * Format: date-time
+   */
+  session_expiration_time?: string;
+
+  /**
+   * Remaining time (in seconds) until session expiration due to absolute timeout
+   * Format: int32
+   */
+  session_expires_in?: number;
+
+  /**
+   * Nominal session idle timeout in seconds
+   * Format: int32
+   */
+  session_idle_timeout?: number;
 }
 
 export default TokenInfo;

package/src/definitions/TokenIntrospectionResponse.ts

@@ -0,0 +1,56 @@
+interface TokenIntrospectionResponse {
+  /**
+   * Is presented token valid and active
+   * Required
+   * Example: true
+   */
+  active?: boolean;
+
+  /**
+   * List of permissions (space separated) granted to the application with this token
+   * Example: AccountInfo CallLog ExtensionInfo Messages SMS
+   */
+  scope?: string;
+
+  /**
+   * Identifier (key) of a client application
+   */
+  client_id?: string;
+
+  /**
+   * Type of token. The only supported value is `bearer`
+   * Example: bearer
+   */
+  token_type?: string;
+
+  /**
+   * Timestamp indicating when this token will expire in seconds since January 1 1970 UTC
+   * Format: int64
+   * Example: 1706715293
+   */
+  exp?: number;
+
+  /**
+   * Timestamp indicating when this token was originally issued in seconds since January 1 1970 UTC
+   * Format: int64
+   * Example: 1706711693
+   */
+  iat?: number;
+
+  /**
+   * Subject of the token (extension ID or the owner)
+   */
+  sub?: string;
+
+  /**
+   * RC account ID associated with the token
+   */
+  account_id?: string;
+
+  /**
+   * OAuth session ID associated with the token
+   */
+  session_id?: string;
+}
+
+export default TokenIntrospectionResponse;

package/src/definitions/UserPhoneNumberInfo.ts

@@ -68,7 +68,7 @@ interface UserPhoneNumberInfo {
   /**
    * Extension subtype, if applicable. For any unsupported subtypes the 'Unknown' value will be returned
    */
-  subType?: 'VideoPro' | 'VideoProPlus' | 'DigitalSignage' | 'Unknown';
+  subType?: 'VideoPro' | 'VideoProPlus' | 'DigitalSignage' | 'Unknown' | 'Emergency';
 
   /**
    * Usage type of phone number. Numbers of 'NumberPool' type will not be returned for phone number list requests

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

@@ -0,0 +1,98 @@
+import type CreateContentRequest from '../../../../../definitions/CreateContentRequest';
+import type SocMsgListContentsParameters from '../../../../../definitions/SocMsgListContentsParameters';
+import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../types';
+
+class Index {
+  public rc: RingCentralInterface;
+  public _parent: ParentInterface;
+  public contentId: string | null;
+
+  public constructor(_parent: ParentInterface, contentId: string | null = null) {
+    this._parent = _parent;
+    this.rc = _parent.rc;
+    this.contentId = contentId;
+  }
+  public path(withParameter = true): string {
+    if (withParameter && this.contentId !== null) {
+      return `${this._parent.path()}/contents/${this.contentId}`;
+    }
+    return `${this._parent.path()}/contents`;
+  }
+  /**
+   * List contents by creation date. The default creation 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 query parameters provided shall 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.
+   *
+   * HTTP Method: get
+   * Endpoint: /cx/social-messaging/v1/contents
+   * Rate Limit Group: Light
+   * App Permission: SocialMessaging
+   */
+  public async list(
+    queryParams?: SocMsgListContentsParameters,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<string> {
+    const r = await this.rc.get<string>(this.path(false), queryParams, restRequestConfig);
+    return r.data;
+  }
+
+  /**
+   * Creates new content for use in discussions.
+   *
+   * This request is used to reply to already-posted content or to initiate a discussion. If authorized, the
+   * authenticated user will be used as the content author.
+   *
+   * Content will be created and pushed asynchronously to the channel. When the content is successfully pushed to
+   * the channel, the Content.Exported event will be reported.
+   *
+   * The account context of this request is determined by the RC Account Id associated with the access token provided
+   * in the Authorization header.
+   *
+   * Replying to customer content is usually possible unless the channel or conversation is read only. Composing
+   * content, on the contrary, depends on the channel itself.
+   *
+   * * The channel may not support it (and be purely reactive like Instagram, Messenger, etc.).
+   *
+   * * Some channels (usually public accounts like Twitter or Facebook pages) allow for the publishing of content
+   * without targeting specific individuals.
+   *
+   * * Some channels (usually non-public media) require specific targeting (phone number for SMS, email address
+   * for email, customer_id, etc.) to be able to create content. This is channel-specific and detailed under the
+   * generic parameters.
+   *
+   * HTTP Method: post
+   * Endpoint: /cx/social-messaging/v1/contents
+   * Rate Limit Group: Light
+   * App Permission: SocialMessaging
+   */
+  public async post(
+    createContentRequest: CreateContentRequest,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<string> {
+    const r = await this.rc.post<string>(this.path(false), createContentRequest, undefined, restRequestConfig);
+    return r.data;
+  }
+
+  /**
+   * Retrieves the content from the given id.
+   *
+   * HTTP Method: get
+   * Endpoint: /cx/social-messaging/v1/contents/{contentId}
+   * Rate Limit Group: Light
+   * App Permission: SocialMessaging
+   */
+  public async get(restRequestConfig?: RestRequestConfig): Promise<string> {
+    if (this.contentId === null) {
+      throw new Error('contentId must be specified.');
+    }
+    const r = await this.rc.get<string>(this.path(), undefined, restRequestConfig);
+    return r.data;
+  }
+}
+export default Index;

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

@@ -0,0 +1,27 @@
+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()}/anonymize`;
+  }
+  /**
+   * Anonymizes an Identity.
+   *
+   * HTTP Method: post
+   * Endpoint: /cx/social-messaging/v1/identities/{identityId}/anonymize
+   * Rate Limit Group: Light
+   * App Permission: SocialMessaging
+   */
+  public async post(restRequestConfig?: RestRequestConfig): Promise<string> {
+    const r = await this.rc.post<string>(this.path(), {}, undefined, restRequestConfig);
+    return r.data;
+  }
+}
+export default Index;

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

@@ -0,0 +1,29 @@
+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()}/deanonymize`;
+  }
+  /**
+   * Flag Identity for deanonymization.
+   *
+   * The next time a content from this Identity will be imported, the identity will be imported again.
+   *
+   * HTTP Method: post
+   * Endpoint: /cx/social-messaging/v1/identities/{identityId}/deanonymize
+   * Rate Limit Group: Light
+   * App Permission: SocialMessaging
+   */
+  public async post(restRequestConfig?: RestRequestConfig): Promise<string> {
+    const r = await this.rc.post<string>(this.path(), {}, undefined, restRequestConfig);
+    return r.data;
+  }
+}
+export default Index;

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

@@ -0,0 +1,33 @@
+import type ImportIdentityRequest from '../../../../../../definitions/ImportIdentityRequest';
+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()}/import`;
+  }
+  /**
+   * Import an identity from given identifier.
+   *
+   * Available only for Email channels.
+   *
+   * HTTP Method: post
+   * Endpoint: /cx/social-messaging/v1/identities/import
+   * Rate Limit Group: Light
+   * App Permission: SocialMessaging
+   */
+  public async post(
+    importIdentityRequest: ImportIdentityRequest,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<string> {
+    const r = await this.rc.post<string>(this.path(), importIdentityRequest, undefined, restRequestConfig);
+    return r.data;
+  }
+}
+export default Index;