@rc-ex/core 1.3.3 → 1.3.5

package/src/paths/Webinar/Notifications/V1/Subscriptions/index.ts

@@ -1,15 +1,13 @@
 import Renew from './Renew';
-import UpdateSubscriptionRequest from '../../../../../definitions/UpdateSubscriptionRequest';
-import SubscriptionInfo from '../../../../../definitions/SubscriptionInfo';
-import CreateWebhookSubscriptionRequest from '../../../../../definitions/CreateWebhookSubscriptionRequest';
-import SubscriptionListResource from '../../../../../definitions/SubscriptionListResource';
-import { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../types';
+import type UpdateSubscriptionRequest from '../../../../../definitions/UpdateSubscriptionRequest';
+import type SubscriptionInfo from '../../../../../definitions/SubscriptionInfo';
+import type CreateWebhookSubscriptionRequest from '../../../../../definitions/CreateWebhookSubscriptionRequest';
+import type SubscriptionListResource from '../../../../../definitions/SubscriptionListResource';
+import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../types';
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
-
   public subscriptionId: string | null;
 
   public constructor(_parent: ParentInterface, subscriptionId: string | null = null) {
@@ -17,14 +15,12 @@ class Index {
     this.rc = _parent.rc;
     this.subscriptionId = subscriptionId;
   }
-
   public path(withParameter = true): string {
     if (withParameter && this.subscriptionId !== null) {
       return `${this._parent.path()}/subscriptions/${this.subscriptionId}`;
     }
     return `${this._parent.path()}/subscriptions`;
   }
-
   /**
    * Returns a list of webinar subscriptions created by the user for the current authorized client application.
    * HTTP Method: get
@@ -42,8 +38,16 @@ class Index {
    * Endpoint: /webinar/notifications/v1/subscriptions
    * Rate Limit Group: Medium
    */
-  public async post(createWebhookSubscriptionRequest: CreateWebhookSubscriptionRequest, restRequestConfig?: RestRequestConfig): Promise<SubscriptionInfo> {
-    const r = await this.rc.post<SubscriptionInfo>(this.path(false), createWebhookSubscriptionRequest, undefined, restRequestConfig);
+  public async post(
+    createWebhookSubscriptionRequest: CreateWebhookSubscriptionRequest,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<SubscriptionInfo> {
+    const r = await this.rc.post<SubscriptionInfo>(
+      this.path(false),
+      createWebhookSubscriptionRequest,
+      undefined,
+      restRequestConfig,
+    );
     return r.data;
   }
 
@@ -63,18 +67,21 @@ class Index {
 
   /**
    * Updates the existing subscription. The client application can extend/narrow
- * the list of events for which it receives notifications within this subscription.
- * If event filters are specified, calling this method modifies them for the
- * existing subscription. The method also allows to set the subscription expiration time.
- * If other than `events` and `expiresIn` parameters are passed in the request they will be ignored.
- * If the request body is empty then the specified subscription will be just renewed without any
- * event filter modifications and with default expiration time.
- *
+   * the list of events for which it receives notifications within this subscription.
+   * If event filters are specified, calling this method modifies them for the
+   * existing subscription. The method also allows to set the subscription expiration time.
+   * If other than `events` and `expiresIn` parameters are passed in the request they will be ignored.
+   * If the request body is empty then the specified subscription will be just renewed without any
+   * event filter modifications and with default expiration time.
+   *
    * HTTP Method: put
    * Endpoint: /webinar/notifications/v1/subscriptions/{subscriptionId}
    * Rate Limit Group: Medium
    */
-  public async put(updateSubscriptionRequest: UpdateSubscriptionRequest, restRequestConfig?: RestRequestConfig): Promise<SubscriptionInfo> {
+  public async put(
+    updateSubscriptionRequest: UpdateSubscriptionRequest,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<SubscriptionInfo> {
     if (this.subscriptionId === null) {
       throw new Error('subscriptionId must be specified.');
     }

package/src/paths/Webinar/Notifications/V1/index.ts

@@ -1,21 +1,19 @@
 import Subscriptions from './Subscriptions';
-import { RingCentralInterface, ParentInterface } from '../../../../types';
+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(withParameter = false): string {
+  public path(): string {
     return `${this._parent.path(false)}/v1`;
   }
 
-  public subscriptions(subscriptionId: (string | null) = null): Subscriptions {
+  public subscriptions(subscriptionId: string | null = null): Subscriptions {
     return new Subscriptions(this, subscriptionId);
   }
 }

package/src/paths/Webinar/Notifications/index.ts

@@ -1,17 +1,15 @@
 import V1 from './V1';
-import { RingCentralInterface, ParentInterface } from '../../../types';
+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(withParameter = false): string {
+  public path(): string {
     return `${this._parent.path(false)}/notifications`;
   }
 

package/src/paths/Webinar/Registration/V1/Sessions/Registrants/index.ts

@@ -1,16 +1,14 @@
-import RegistrantModel from '../../../../../../definitions/RegistrantModel';
-import RcwRegGetRegistrantParameters from '../../../../../../definitions/RcwRegGetRegistrantParameters';
-import RegistrantModelResponsePost from '../../../../../../definitions/RegistrantModelResponsePost';
-import RegistrantBaseModel from '../../../../../../definitions/RegistrantBaseModel';
-import RegistrantListResource from '../../../../../../definitions/RegistrantListResource';
-import RcwRegListRegistrantsParameters from '../../../../../../definitions/RcwRegListRegistrantsParameters';
-import { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../../types';
+import type RegistrantModelWithQuestionnaire from '../../../../../../definitions/RegistrantModelWithQuestionnaire';
+import type RcwRegGetRegistrantParameters from '../../../../../../definitions/RcwRegGetRegistrantParameters';
+import type RegistrantModelResponsePostWithQuestionnaire from '../../../../../../definitions/RegistrantModelResponsePostWithQuestionnaire';
+import type RegistrantBaseModelWithQuestionnaire from '../../../../../../definitions/RegistrantBaseModelWithQuestionnaire';
+import type RegistrantListResource from '../../../../../../definitions/RegistrantListResource';
+import type RcwRegListRegistrantsParameters from '../../../../../../definitions/RcwRegListRegistrantsParameters';
+import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../../types';
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
-
   public registrantId: string | null;
 
   public constructor(_parent: ParentInterface, registrantId: string | null = null) {
@@ -18,75 +16,87 @@ class Index {
     this.rc = _parent.rc;
     this.registrantId = registrantId;
   }
-
   public path(withParameter = true): string {
     if (withParameter && this.registrantId !== null) {
       return `${this._parent.path()}/registrants/${this.registrantId}`;
     }
     return `${this._parent.path()}/registrants`;
   }
-
   /**
    * Returns the list of Registrants ordered by "id" ascending.
- *
- * A caller must be an authorized user: either a host of the webinar or an IT Admin:
- * a user from host's account with "WebinarSettings" permission.
- *
+   *
+   * A caller must be an authorized user: either a host of the webinar or an IT Admin:
+   * a user from host's account with "WebinarSettings" permission.
+   *
    * HTTP Method: get
    * Endpoint: /webinar/registration/v1/sessions/{sessionId}/registrants
    * Rate Limit Group: Heavy
    * App Permission: ReadWebinars
    */
-  public async list(queryParams?: RcwRegListRegistrantsParameters, restRequestConfig?: RestRequestConfig): Promise<RegistrantListResource> {
+  public async list(
+    queryParams?: RcwRegListRegistrantsParameters,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<RegistrantListResource> {
     const r = await this.rc.get<RegistrantListResource>(this.path(false), queryParams, restRequestConfig);
     return r.data;
   }
 
   /**
    * Creates a new Registrant for a given session.
- *
- * Registration MUST be open for the session for this call to succeed (otherwise it should return HTTP 403).
- *
- * A caller must be an authorized user: either a host of the webinar or an IT Admin:
- * a user from host's account with "WebinarSettings" permission.
- *
+   *
+   * Registration MUST be open for the session for this call to succeed (otherwise it should return HTTP 403).
+   *
+   * A caller must be an authorized user: either a host of the webinar or an IT Admin:
+   * a user from host's account with "WebinarSettings" permission.
+   *
    * HTTP Method: post
    * Endpoint: /webinar/registration/v1/sessions/{sessionId}/registrants
    * Rate Limit Group: Heavy
    * App Permission: EditWebinars
    */
-  public async post(registrantBaseModel: RegistrantBaseModel, restRequestConfig?: RestRequestConfig): Promise<RegistrantModelResponsePost> {
-    const r = await this.rc.post<RegistrantModelResponsePost>(this.path(false), registrantBaseModel, undefined, restRequestConfig);
+  public async post(
+    registrantBaseModelWithQuestionnaire: RegistrantBaseModelWithQuestionnaire,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<RegistrantModelResponsePostWithQuestionnaire> {
+    const r = await this.rc.post<RegistrantModelResponsePostWithQuestionnaire>(
+      this.path(false),
+      registrantBaseModelWithQuestionnaire,
+      undefined,
+      restRequestConfig,
+    );
     return r.data;
   }
 
   /**
    * Returns a Registrant by ID.
- *
- * A caller must be an authorized user: either a host of the webinar or an IT Admin:
- * a user from host's account with "WebinarSettings" permission.
- *
+   *
+   * A caller must be an authorized user: either a host of the webinar or an IT Admin:
+   * a user from host's account with "WebinarSettings" permission.
+   *
    * HTTP Method: get
    * Endpoint: /webinar/registration/v1/sessions/{sessionId}/registrants/{registrantId}
    * Rate Limit Group: Heavy
    * App Permission: ReadWebinars
    */
-  public async get(queryParams?: RcwRegGetRegistrantParameters, restRequestConfig?: RestRequestConfig): Promise<RegistrantModel> {
+  public async get(
+    queryParams?: RcwRegGetRegistrantParameters,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<RegistrantModelWithQuestionnaire> {
     if (this.registrantId === null) {
       throw new Error('registrantId must be specified.');
     }
-    const r = await this.rc.get<RegistrantModel>(this.path(), queryParams, restRequestConfig);
+    const r = await this.rc.get<RegistrantModelWithQuestionnaire>(this.path(), queryParams, restRequestConfig);
     return r.data;
   }
 
   /**
    * Deletes a Registrant by ID.
- *
- * Session must not be in finished state (otherwise it should return HTTP 403).
- *
- * A caller must be an authorized user: either a host of the webinar or an IT Admin:
- * a user from host's account with "WebinarSettings" permission.
- *
+   *
+   * Session must not be in finished state (otherwise it should return HTTP 403).
+   *
+   * A caller must be an authorized user: either a host of the webinar or an IT Admin:
+   * a user from host's account with "WebinarSettings" permission.
+   *
    * HTTP Method: delete
    * Endpoint: /webinar/registration/v1/sessions/{sessionId}/registrants/{registrantId}
    * Rate Limit Group: Heavy

package/src/paths/Webinar/Registration/V1/Sessions/index.ts

@@ -1,12 +1,10 @@
 import Registrants from './Registrants';
-import RegSessionModel from '../../../../../definitions/RegSessionModel';
-import { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../types';
+import type RegSessionModel from '../../../../../definitions/RegSessionModel';
+import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../types';
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
-
   public sessionId: string | null;
 
   public constructor(_parent: ParentInterface, sessionId: string | null = null) {
@@ -14,20 +12,18 @@ class Index {
     this.rc = _parent.rc;
     this.sessionId = sessionId;
   }
-
   public path(withParameter = true): string {
     if (withParameter && this.sessionId !== null) {
       return `${this._parent.path()}/sessions/${this.sessionId}`;
     }
     return `${this._parent.path()}/sessions`;
   }
-
   /**
    * Returns a registration Session information by ID.
- *
- * A caller must be an authorized user: either a host of the webinar or an IT Admin:
- * a user from host's account with "WebinarSettings" permission.
- *
+   *
+   * A caller must be an authorized user: either a host of the webinar or an IT Admin:
+   * a user from host's account with "WebinarSettings" permission.
+   *
    * HTTP Method: get
    * Endpoint: /webinar/registration/v1/sessions/{sessionId}
    * Rate Limit Group: Heavy
@@ -43,20 +39,23 @@ class Index {
 
   /**
    * Updates a Session by ID.
- *
- * This is a PARTIAL update (PATCH), client may call it providing only attributes which are to be changed.
- *
- * A caller must be an authorized user: either a host of the webinar or an IT Admin:
- * a user from host's account with "WebinarSettings" permission.
- *
- * If a session record with given ID doesn't exist on Registration Service side the API should return HTTP 404.
- *
+   *
+   * This is a PARTIAL update (PATCH), client may call it providing only attributes which are to be changed.
+   *
+   * A caller must be an authorized user: either a host of the webinar or an IT Admin:
+   * a user from host's account with "WebinarSettings" permission.
+   *
+   * If a session record with given ID doesn't exist on Registration Service side the API should return HTTP 404.
+   *
    * HTTP Method: patch
    * Endpoint: /webinar/registration/v1/sessions/{sessionId}
    * Rate Limit Group: Heavy
    * App Permission: EditWebinars
    */
-  public async patch(regSessionModel: RegSessionModel, restRequestConfig?: RestRequestConfig): Promise<RegSessionModel> {
+  public async patch(
+    regSessionModel: RegSessionModel,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<RegSessionModel> {
     if (this.sessionId === null) {
       throw new Error('sessionId must be specified.');
     }
@@ -64,7 +63,7 @@ class Index {
     return r.data;
   }
 
-  public registrants(registrantId: (string | null) = null): Registrants {
+  public registrants(registrantId: string | null = null): Registrants {
     return new Registrants(this, registrantId);
   }
 }

package/src/paths/Webinar/Registration/V1/index.ts

@@ -1,21 +1,19 @@
 import Sessions from './Sessions';
-import { RingCentralInterface, ParentInterface } from '../../../../types';
+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(withParameter = false): string {
+  public path(): string {
     return `${this._parent.path(false)}/v1`;
   }
 
-  public sessions(sessionId: (string | null) = null): Sessions {
+  public sessions(sessionId: string | null = null): Sessions {
     return new Sessions(this, sessionId);
   }
 }

package/src/paths/Webinar/Registration/index.ts

@@ -1,17 +1,15 @@
 import V1 from './V1';
-import { RingCentralInterface, ParentInterface } from '../../../types';
+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(withParameter = false): string {
+  public path(): string {
     return `${this._parent.path(false)}/registration`;
   }
 

package/src/paths/Webinar/index.ts

@@ -2,7 +2,7 @@ import Configuration from './Configuration';
 import Notifications from './Notifications';
 import Registration from './Registration';
 import History from './History';
-import { RingCentralInterface } from '../../types';
+import type { RingCentralInterface } from '../../types';
 
 class Index {
   public rc: RingCentralInterface;
@@ -10,8 +10,7 @@ class Index {
   public constructor(rc: RingCentralInterface) {
     this.rc = rc;
   }
-
-  public path(withParameter = false): string {
+  public path(): string {
     return '/webinar';
   }