@rc-ex/core 1.3.8 → 1.3.10

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

@@ -0,0 +1,75 @@
+import Deanonymize from './Deanonymize';
+import Anonymize from './Anonymize';
+import Import from './Import';
+import type SocMsgListIdentitiesParameters from '../../../../../definitions/SocMsgListIdentitiesParameters';
+import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../types';
+
+class Index {
+  public rc: RingCentralInterface;
+  public _parent: ParentInterface;
+  public identityId: string | null;
+
+  public constructor(_parent: ParentInterface, identityId: string | null = null) {
+    this._parent = _parent;
+    this.rc = _parent.rc;
+    this.identityId = identityId;
+  }
+  public path(withParameter = true): string {
+    if (withParameter && this.identityId !== null) {
+      return `${this._parent.path()}/identities/${this.identityId}`;
+    }
+    return `${this._parent.path()}/identities`;
+  }
+  /**
+   * List identities 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 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/identities
+   * Rate Limit Group: Light
+   * App Permission: SocialMessaging
+   */
+  public async list(
+    queryParams?: SocMsgListIdentitiesParameters,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<string> {
+    const r = await this.rc.get<string>(this.path(false), queryParams, restRequestConfig);
+    return r.data;
+  }
+
+  /**
+   * Renders an identity from given id.
+   *
+   * HTTP Method: get
+   * Endpoint: /cx/social-messaging/v1/identities/{identityId}
+   * Rate Limit Group: Light
+   * App Permission: SocialMessaging
+   */
+  public async get(restRequestConfig?: RestRequestConfig): Promise<string> {
+    if (this.identityId === null) {
+      throw new Error('identityId must be specified.');
+    }
+    const r = await this.rc.get<string>(this.path(), undefined, restRequestConfig);
+    return r.data;
+  }
+
+  public import(): Import {
+    return new Import(this);
+  }
+
+  public anonymize(): Anonymize {
+    return new Anonymize(this);
+  }
+
+  public deanonymize(): Deanonymize {
+    return new Deanonymize(this);
+  }
+}
+export default Index;

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

@@ -0,0 +1,25 @@
+import Identities from './Identities';
+import Contents from './Contents';
+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)}/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);
+  }
+}
+export default Index;

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

@@ -0,0 +1,20 @@
+import V1 from './V1';
+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)}/social-messaging`;
+  }
+
+  public v1(): V1 {
+    return new V1(this);
+  }
+}
+export default Index;

package/src/paths/Cx/index.ts

@@ -0,0 +1,18 @@
+import SocialMessaging from './SocialMessaging';
+import type { RingCentralInterface } from '../../types';
+
+class Index {
+  public rc: RingCentralInterface;
+
+  public constructor(rc: RingCentralInterface) {
+    this.rc = rc;
+  }
+  public path(): string {
+    return '/cx';
+  }
+
+  public socialMessaging(): SocialMessaging {
+    return new SocialMessaging(this);
+  }
+}
+export default Index;

package/src/paths/Rcvideo/V1/Account/Extension/Recordings/index.ts

@@ -14,7 +14,9 @@ class Index {
     return `${this._parent.path()}/recordings`;
   }
   /**
-   * Returns the list of meeting recordings belonging to particular user.
+   * Returns all recordings available for specific extension.
+   * This endpoint is used in admin recording service, not regular web
+   *
    * HTTP Method: get
    * Endpoint: /rcvideo/v1/account/{accountId}/extension/{extensionId}/recordings
    * Rate Limit Group: Light

package/src/paths/Rcvideo/V1/Account/Recordings/index.ts

@@ -14,7 +14,9 @@ class Index {
     return `${this._parent.path()}/recordings`;
   }
   /**
-   * Returns the list of meeting recordings belonging to all account users.
+   * Returns all account recordings.
+   * This endpoint is used in Admin recording service, not regular web
+   *
    * HTTP Method: get
    * Endpoint: /rcvideo/v1/account/{accountId}/recordings
    * Rate Limit Group: Light

package/src/paths/Rcvideo/V1/Accounts/Extensions/Delegators/index.ts

@@ -1,5 +1,4 @@
 import type DelegatorsListResult from '../../../../../../definitions/DelegatorsListResult';
-import type RcvListDelegatorsParameters from '../../../../../../definitions/RcvListDelegatorsParameters';
 import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../../types';
 
 class Index {
@@ -20,11 +19,8 @@ class Index {
    * Rate Limit Group: Medium
    * App Permission: Video
    */
-  public async get(
-    queryParams?: RcvListDelegatorsParameters,
-    restRequestConfig?: RestRequestConfig,
-  ): Promise<DelegatorsListResult> {
-    const r = await this.rc.get<DelegatorsListResult>(this.path(), queryParams, restRequestConfig);
+  public async get(restRequestConfig?: RestRequestConfig): Promise<DelegatorsListResult> {
+    const r = await this.rc.get<DelegatorsListResult>(this.path(), undefined, restRequestConfig);
     return r.data;
   }
 }

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

@@ -1,7 +1,6 @@
 import BulkAssign from './BulkAssign';
 import Presence from './Presence';
 import Members from './Members';
-import type CallQueueUpdateDetails from '../../../../definitions/CallQueueUpdateDetails';
 import type CallQueueDetails from '../../../../definitions/CallQueueDetails';
 import type CallQueues from '../../../../definitions/CallQueues';
 import type ListCallQueuesParameters from '../../../../definitions/ListCallQueuesParameters';
@@ -25,7 +24,6 @@ class Index {
   }
   /**
    * Returns a call queue list.
-   *
    * HTTP Method: get
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/call-queues
    * Rate Limit Group: Medium
@@ -42,7 +40,6 @@ class Index {
 
   /**
    * Returns basic information on a call queue group extension.
-   *
    * HTTP Method: get
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/call-queues/{groupId}
    * Rate Limit Group: Light
@@ -67,13 +64,13 @@ class Index {
    * User Permission: EditUserInfo
    */
   public async put(
-    callQueueUpdateDetails: CallQueueUpdateDetails,
+    callQueueDetails: CallQueueDetails,
     restRequestConfig?: RestRequestConfig,
   ): Promise<CallQueueDetails> {
     if (this.groupId === null) {
       throw new Error('groupId must be specified.');
     }
-    const r = await this.rc.put<CallQueueDetails>(this.path(), callQueueUpdateDetails, undefined, restRequestConfig);
+    const r = await this.rc.put<CallQueueDetails>(this.path(), callQueueDetails, undefined, restRequestConfig);
     return r.data;
   }
 

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

@@ -0,0 +1,31 @@
+import type RolesCollectionResource from '../../../../../definitions/RolesCollectionResource';
+import type ListOfAvailableForAssigningRolesParameters from '../../../../../definitions/ListOfAvailableForAssigningRolesParameters';
+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()}/assignable-roles`;
+  }
+  /**
+   * Returns a list of roles which can be assigned to a given extension.
+   * HTTP Method: get
+   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/assignable-roles
+   * Rate Limit Group: Medium
+   * App Permission: RoleManagement
+   */
+  public async get(
+    queryParams?: ListOfAvailableForAssigningRolesParameters,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<RolesCollectionResource> {
+    const r = await this.rc.get<RolesCollectionResource>(this.path(), queryParams, restRequestConfig);
+    return r.data;
+  }
+}
+export default Index;

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

@@ -15,7 +15,6 @@ class Index {
   }
   /**
    * Returns overflow settings for a call queue specified in path.
-   *
    * HTTP Method: get
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{callQueueId}/overflow-settings
    * Rate Limit Group: Heavy

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

@@ -7,6 +7,7 @@ import OverflowSettings from './OverflowSettings';
 import AddressBookSync from './AddressBookSync';
 import ForwardingNumber from './ForwardingNumber';
 import UnifiedPresence from './UnifiedPresence';
+import AssignableRoles from './AssignableRoles';
 import CallerBlocking from './CallerBlocking';
 import BusinessHours from './BusinessHours';
 import AnsweringRule from './AnsweringRule';
@@ -247,6 +248,10 @@ class Index {
     return new CallerBlocking(this);
   }
 
+  public assignableRoles(): AssignableRoles {
+    return new AssignableRoles(this);
+  }
+
   public unifiedPresence(): UnifiedPresence {
     return new UnifiedPresence(this);
   }

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

@@ -1,6 +1,7 @@
 import BulkAssign from './BulkAssign';
 import Default from './Default';
 import type DeleteCustomRoleParameters from '../../../../definitions/DeleteCustomRoleParameters';
+import type ReadUserRoleParameters from '../../../../definitions/ReadUserRoleParameters';
 import type RoleResource from '../../../../definitions/RoleResource';
 import type RolesCollectionResource from '../../../../definitions/RolesCollectionResource';
 import type ListUserRolesParameters from '../../../../definitions/ListUserRolesParameters';
@@ -59,11 +60,11 @@ class Index {
    * App Permission: ReadAccounts
    * User Permission: ReadUserRoles
    */
-  public async get(restRequestConfig?: RestRequestConfig): Promise<RoleResource> {
+  public async get(queryParams?: ReadUserRoleParameters, restRequestConfig?: RestRequestConfig): Promise<RoleResource> {
     if (this.roleId === null) {
       throw new Error('roleId must be specified.');
     }
-    const r = await this.rc.get<RoleResource>(this.path(), undefined, restRequestConfig);
+    const r = await this.rc.get<RoleResource>(this.path(), queryParams, restRequestConfig);
     return r.data;
   }
 
@@ -75,11 +76,11 @@ class Index {
    * App Permission: RoleManagement
    * User Permission: EditUserRoles
    */
-  public async put(roleResource: RoleResource, restRequestConfig?: RestRequestConfig): Promise<string> {
+  public async put(roleResource: RoleResource, restRequestConfig?: RestRequestConfig): Promise<RoleResource> {
     if (this.roleId === null) {
       throw new Error('roleId must be specified.');
     }
-    const r = await this.rc.put<string>(this.path(), roleResource, undefined, restRequestConfig);
+    const r = await this.rc.put<RoleResource>(this.path(), roleResource, undefined, restRequestConfig);
     return r.data;
   }
 

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

@@ -0,0 +1,42 @@
+import type TokenIntrospectionResponse from '../../../../definitions/TokenIntrospectionResponse';
+import type IntrospectTokenRequest from '../../../../definitions/IntrospectTokenRequest';
+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()}/introspect`;
+  }
+  /**
+   * Determines state and metadata for a given token (access token, refresh token
+   * or authorization code)
+   *
+   * 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.
+   *
+   * HTTP Method: post
+   * Endpoint: /restapi/oauth/introspect
+   * Rate Limit Group: Auth
+   * App Permission: Interoperability
+   */
+  public async post(
+    introspectTokenRequest: IntrospectTokenRequest,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<TokenIntrospectionResponse> {
+    const r = await this.rc.post<TokenIntrospectionResponse>(
+      this.path(),
+      introspectTokenRequest,
+      undefined,
+      restRequestConfig,
+    );
+    return r.data;
+  }
+}
+export default Index;

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

@@ -0,0 +1,27 @@
+import type SessionInfoResponse from '../../../../definitions/SessionInfoResponse';
+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()}/session-info`;
+  }
+  /**
+   * Returns information about current OAuth session
+   *
+   * HTTP Method: get
+   * Endpoint: /restapi/oauth/session-info
+   * Rate Limit Group: Auth
+   */
+  public async get(restRequestConfig?: RestRequestConfig): Promise<SessionInfoResponse> {
+    const r = await this.rc.get<SessionInfoResponse>(this.path(), undefined, restRequestConfig);
+    return r.data;
+  }
+}
+export default Index;

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

@@ -1,3 +1,5 @@
+import SessionInfo from './SessionInfo';
+import Introspect from './Introspect';
 import Authorize from './Authorize';
 import Revoke from './Revoke';
 import Token from './Token';
@@ -26,5 +28,13 @@ 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;