@rc-ex/core 1.6.5 → 1.6.7

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

@@ -1,178 +0,0 @@
-import PatchContactParameters from "../../../../../../definitions/PatchContactParameters.js";
-import UpdateContactParameters from "../../../../../../definitions/UpdateContactParameters.js";
-import PersonalContactResource from "../../../../../../definitions/PersonalContactResource.js";
-import CreateContactParameters from "../../../../../../definitions/CreateContactParameters.js";
-import PersonalContactRequest from "../../../../../../definitions/PersonalContactRequest.js";
-import ContactList from "../../../../../../definitions/ContactList.js";
-import ListContactsParameters from "../../../../../../definitions/ListContactsParameters.js";
-import {
-  ParentInterface,
-  RestRequestConfig,
-  RingCentralInterface,
-} from "../../../../../../types.js";
-
-class Index {
-  public rc: RingCentralInterface;
-  public _parent: ParentInterface;
-  public contactId: string | null;
-
-  public constructor(
-    _parent: ParentInterface,
-    contactId: string | null = null,
-  ) {
-    this._parent = _parent;
-    this.rc = _parent.rc;
-    this.contactId = contactId;
-  }
-  public path(withParameter = true): string {
-    if (withParameter && this.contactId !== null) {
-      return `${this._parent.path()}/contact/${this.contactId}`;
-    }
-    return `${this._parent.path()}/contact`;
-  }
-  /**
-   * Returns the user personal contacts.
-   *
-   * HTTP Method: get
-   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/address-book/contact
-   * Rate Limit Group: Heavy
-   * App Permission: ReadContacts
-   * User Permission: ReadPersonalContacts
-   */
-  public async list(
-    queryParams?: ListContactsParameters,
-    restRequestConfig?: RestRequestConfig,
-  ): Promise<ContactList> {
-    const r = await this.rc.get<ContactList>(
-      this.path(false),
-      queryParams,
-      restRequestConfig,
-    );
-    return r.data;
-  }
-
-  /**
-   * Creates the user personal contact.
-   *
-   * HTTP Method: post
-   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/address-book/contact
-   * Rate Limit Group: Heavy
-   * App Permission: Contacts
-   * User Permission: EditPersonalContacts
-   */
-  public async post(
-    personalContactRequest: PersonalContactRequest,
-    queryParams?: CreateContactParameters,
-    restRequestConfig?: RestRequestConfig,
-  ): Promise<PersonalContactResource> {
-    const r = await this.rc.post<PersonalContactResource>(
-      this.path(false),
-      personalContactRequest,
-      queryParams,
-      restRequestConfig,
-    );
-    return r.data;
-  }
-
-  /**
-   * Returns the user personal contact(s).
-   * [Batch request syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported.
-   *
-   * HTTP Method: get
-   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId}
-   * Rate Limit Group: Heavy
-   * App Permission: ReadContacts
-   * User Permission: ReadPersonalContacts
-   */
-  public async get(
-    restRequestConfig?: RestRequestConfig,
-  ): Promise<PersonalContactResource> {
-    if (this.contactId === null) {
-      throw new Error("contactId must be specified.");
-    }
-    const r = await this.rc.get<PersonalContactResource>(
-      this.path(),
-      undefined,
-      restRequestConfig,
-    );
-    return r.data;
-  }
-
-  /**
-   * Updates the user personal contact(s) (full resource update).
-   * [Batch request syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported.
-   *
-   * HTTP Method: put
-   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId}
-   * Rate Limit Group: Heavy
-   * App Permission: Contacts
-   * User Permission: EditPersonalContacts
-   */
-  public async put(
-    personalContactRequest: PersonalContactRequest,
-    queryParams?: UpdateContactParameters,
-    restRequestConfig?: RestRequestConfig,
-  ): Promise<PersonalContactResource> {
-    if (this.contactId === null) {
-      throw new Error("contactId must be specified.");
-    }
-    const r = await this.rc.put<PersonalContactResource>(
-      this.path(),
-      personalContactRequest,
-      queryParams,
-      restRequestConfig,
-    );
-    return r.data;
-  }
-
-  /**
-   * Deletes the user personal contact(s).
-   * [Batch request syntax](https://developers.ringcentral.com/guide/basics/batch-requests) is supported.
-   *
-   * HTTP Method: delete
-   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId}
-   * Rate Limit Group: Heavy
-   * App Permission: Contacts
-   * User Permission: EditPersonalContacts
-   */
-  public async delete(restRequestConfig?: RestRequestConfig): Promise<string> {
-    if (this.contactId === null) {
-      throw new Error("contactId must be specified.");
-    }
-    const r = await this.rc.delete<string>(
-      this.path(),
-      {},
-      undefined,
-      restRequestConfig,
-    );
-    return r.data;
-  }
-
-  /**
-   * Updates particular values of a personal contact attributes specified in request (partial resource update). Omitted attributes will remain unchanged.
-   * If any attribute is passed in request body with the null value, then this attribute value will be removed.
-   *
-   * HTTP Method: patch
-   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId}
-   * Rate Limit Group: Heavy
-   * App Permission: Contacts
-   * User Permission: EditPersonalContacts
-   */
-  public async patch(
-    personalContactRequest: PersonalContactRequest,
-    queryParams?: PatchContactParameters,
-    restRequestConfig?: RestRequestConfig,
-  ): Promise<PersonalContactResource> {
-    if (this.contactId === null) {
-      throw new Error("contactId must be specified.");
-    }
-    const r = await this.rc.patch<PersonalContactResource>(
-      this.path(),
-      personalContactRequest,
-      queryParams,
-      restRequestConfig,
-    );
-    return r.data;
-  }
-}
-export default Index;

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

@@ -1,20 +0,0 @@
-import Contact from "./Contact/index.js";
-import { ParentInterface, RingCentralInterface } from "../../../../../types.js";
-
-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()}/address-book`;
-  }
-
-  public contact(contactId: string | null = null): Contact {
-    return new Contact(this, contactId);
-  }
-}
-export default Index;

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

@@ -1,41 +0,0 @@
-import AddressBookSync from "../../../../../definitions/AddressBookSync.js";
-import SyncAddressBookParameters from "../../../../../definitions/SyncAddressBookParameters.js";
-import {
-  ParentInterface,
-  RestRequestConfig,
-  RingCentralInterface,
-} from "../../../../../types.js";
-
-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()}/address-book-sync`;
-  }
-  /**
-   * Synchronizes user contacts.
-   *
-   * HTTP Method: get
-   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/address-book-sync
-   * Rate Limit Group: Heavy
-   * App Permission: ReadContacts
-   * User Permission: ReadPersonalContacts
-   */
-  public async get(
-    queryParams?: SyncAddressBookParameters,
-    restRequestConfig?: RestRequestConfig,
-  ): Promise<AddressBookSync> {
-    const r = await this.rc.get<AddressBookSync>(
-      this.path(),
-      queryParams,
-      restRequestConfig,
-    );
-    return r.data;
-  }
-}
-export default Index;

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

@@ -1,62 +0,0 @@
-import BusinessSiteCollectionRequest from "../../../../../definitions/BusinessSiteCollectionRequest.js";
-import BusinessSiteCollectionResource from "../../../../../definitions/BusinessSiteCollectionResource.js";
-import {
-  ParentInterface,
-  RestRequestConfig,
-  RingCentralInterface,
-} from "../../../../../types.js";
-
-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()}/administered-sites`;
-  }
-  /**
-   * Returns a list of sites administered by the current user.
-   * HTTP Method: get
-   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/administered-sites
-   * Rate Limit Group: Medium
-   * App Permission: ReadAccounts
-   * User Permission: ReadExtensions
-   */
-  public async get(
-    restRequestConfig?: RestRequestConfig,
-  ): Promise<BusinessSiteCollectionResource> {
-    const r = await this.rc.get<BusinessSiteCollectionResource>(
-      this.path(),
-      undefined,
-      restRequestConfig,
-    );
-    return r.data;
-  }
-
-  /**
-   * Updates the sites administered by the current user.
-   * Please note: Only IDs of records are used for update.
-   *
-   * HTTP Method: put
-   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/administered-sites
-   * Rate Limit Group: Medium
-   * App Permission: EditAccounts
-   * User Permission: EditAssignedRoles
-   */
-  public async put(
-    businessSiteCollectionRequest: BusinessSiteCollectionRequest,
-    restRequestConfig?: RestRequestConfig,
-  ): Promise<BusinessSiteCollectionResource> {
-    const r = await this.rc.put<BusinessSiteCollectionResource>(
-      this.path(),
-      businessSiteCollectionRequest,
-      undefined,
-      restRequestConfig,
-    );
-    return r.data;
-  }
-}
-export default Index;

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

@@ -1,139 +0,0 @@
-import UpdateAnsweringRuleRequest from "../../../../../definitions/UpdateAnsweringRuleRequest.js";
-import CallHandlingRuleInfo from "../../../../../definitions/CallHandlingRuleInfo.js";
-import ReadAnsweringRuleParameters from "../../../../../definitions/ReadAnsweringRuleParameters.js";
-import CustomAnsweringRuleInfo from "../../../../../definitions/CustomAnsweringRuleInfo.js";
-import CreateAnsweringRuleRequest from "../../../../../definitions/CreateAnsweringRuleRequest.js";
-import UserAnsweringRuleList from "../../../../../definitions/UserAnsweringRuleList.js";
-import ListAnsweringRulesParameters from "../../../../../definitions/ListAnsweringRulesParameters.js";
-import {
-  ParentInterface,
-  RestRequestConfig,
-  RingCentralInterface,
-} from "../../../../../types.js";
-
-class Index {
-  public rc: RingCentralInterface;
-  public _parent: ParentInterface;
-  public ruleId: string | null;
-
-  public constructor(_parent: ParentInterface, ruleId: string | null = null) {
-    this._parent = _parent;
-    this.rc = _parent.rc;
-    this.ruleId = ruleId;
-  }
-  public path(withParameter = true): string {
-    if (withParameter && this.ruleId !== null) {
-      return `${this._parent.path()}/answering-rule/${this.ruleId}`;
-    }
-    return `${this._parent.path()}/answering-rule`;
-  }
-  /**
-   * Returns call handling rules of an extension.
-   * HTTP Method: get
-   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/answering-rule
-   * Rate Limit Group: Medium
-   * App Permission: ReadAccounts
-   * User Permission: ReadUserAnsweringRules
-   */
-  public async list(
-    queryParams?: ListAnsweringRulesParameters,
-    restRequestConfig?: RestRequestConfig,
-  ): Promise<UserAnsweringRuleList> {
-    const r = await this.rc.get<UserAnsweringRuleList>(
-      this.path(false),
-      queryParams,
-      restRequestConfig,
-    );
-    return r.data;
-  }
-
-  /**
-   * Creates a custom call handling rule for a particular caller ID.
-   * HTTP Method: post
-   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/answering-rule
-   * Rate Limit Group: Medium
-   * App Permission: EditExtensions
-   * User Permission: EditUserAnsweringRules
-   */
-  public async post(
-    createAnsweringRuleRequest: CreateAnsweringRuleRequest,
-    restRequestConfig?: RestRequestConfig,
-  ): Promise<CustomAnsweringRuleInfo> {
-    const r = await this.rc.post<CustomAnsweringRuleInfo>(
-      this.path(false),
-      createAnsweringRuleRequest,
-      undefined,
-      restRequestConfig,
-    );
-    return r.data;
-  }
-
-  /**
-   * Returns a call handling rule by ID.
-   * HTTP Method: get
-   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}
-   * Rate Limit Group: Light
-   * App Permission: ReadAccounts
-   * User Permission: ReadUserAnsweringRules
-   */
-  public async get(
-    queryParams?: ReadAnsweringRuleParameters,
-    restRequestConfig?: RestRequestConfig,
-  ): Promise<CallHandlingRuleInfo> {
-    if (this.ruleId === null) {
-      throw new Error("ruleId must be specified.");
-    }
-    const r = await this.rc.get<CallHandlingRuleInfo>(
-      this.path(),
-      queryParams,
-      restRequestConfig,
-    );
-    return r.data;
-  }
-
-  /**
-   * Updates a custom call handling rule for a particular caller ID.
-   * HTTP Method: put
-   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}
-   * Rate Limit Group: Medium
-   * App Permission: EditExtensions
-   * User Permission: EditUserAnsweringRules
-   */
-  public async put(
-    updateAnsweringRuleRequest: UpdateAnsweringRuleRequest,
-    restRequestConfig?: RestRequestConfig,
-  ): Promise<CallHandlingRuleInfo> {
-    if (this.ruleId === null) {
-      throw new Error("ruleId must be specified.");
-    }
-    const r = await this.rc.put<CallHandlingRuleInfo>(
-      this.path(),
-      updateAnsweringRuleRequest,
-      undefined,
-      restRequestConfig,
-    );
-    return r.data;
-  }
-
-  /**
-   * Deletes a custom call handling rule by a particular ID.
-   * HTTP Method: delete
-   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}
-   * Rate Limit Group: Medium
-   * App Permission: EditExtensions
-   * User Permission: EditUserAnsweringRules
-   */
-  public async delete(restRequestConfig?: RestRequestConfig): Promise<string> {
-    if (this.ruleId === null) {
-      throw new Error("ruleId 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/AssignableRoles/index.ts

@@ -1,39 +0,0 @@
-import RolesCollectionResource from "../../../../../definitions/RolesCollectionResource.js";
-import ListOfAvailableForAssigningRolesParameters from "../../../../../definitions/ListOfAvailableForAssigningRolesParameters.js";
-import {
-  ParentInterface,
-  RestRequestConfig,
-  RingCentralInterface,
-} from "../../../../../types.js";
-
-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/AssignedRole/Default/index.ts

@@ -1,39 +0,0 @@
-import AssignedRolesResource from "../../../../../../definitions/AssignedRolesResource.js";
-import {
-  ParentInterface,
-  RestRequestConfig,
-  RingCentralInterface,
-} from "../../../../../../types.js";
-
-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()}/default`;
-  }
-  /**
-   * Assigns the default role to the currently logged-in user extension.
-   * HTTP Method: put
-   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/assigned-role/default
-   * Rate Limit Group: Medium
-   * App Permission: RoleManagement
-   * User Permission: Users
-   */
-  public async put(
-    restRequestConfig?: RestRequestConfig,
-  ): Promise<AssignedRolesResource> {
-    const r = await this.rc.put<AssignedRolesResource>(
-      this.path(),
-      {},
-      undefined,
-      restRequestConfig,
-    );
-    return r.data;
-  }
-}
-export default Index;

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

@@ -1,66 +0,0 @@
-import Default from "./Default/index.js";
-import AssignedRolesResource from "../../../../../definitions/AssignedRolesResource.js";
-import ListUserAssignedRolesParameters from "../../../../../definitions/ListUserAssignedRolesParameters.js";
-import {
-  ParentInterface,
-  RestRequestConfig,
-  RingCentralInterface,
-} from "../../../../../types.js";
-
-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()}/assigned-role`;
-  }
-  /**
-   * Returns a list of roles assigned to the current extension.
-   * HTTP Method: get
-   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/assigned-role
-   * Rate Limit Group: Light
-   * App Permission: ReadAccounts
-   * User Permission: ReadAssignedRoles
-   */
-  public async get(
-    queryParams?: ListUserAssignedRolesParameters,
-    restRequestConfig?: RestRequestConfig,
-  ): Promise<AssignedRolesResource> {
-    const r = await this.rc.get<AssignedRolesResource>(
-      this.path(),
-      queryParams,
-      restRequestConfig,
-    );
-    return r.data;
-  }
-
-  /**
-   * Updates a list of roles assigned to the current user.
-   * HTTP Method: put
-   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/assigned-role
-   * Rate Limit Group: Medium
-   * App Permission: RoleManagement
-   * User Permission: EditAssignedRoles
-   */
-  public async put(
-    assignedRolesResource: AssignedRolesResource,
-    restRequestConfig?: RestRequestConfig,
-  ): Promise<AssignedRolesResource> {
-    const r = await this.rc.put<AssignedRolesResource>(
-      this.path(),
-      assignedRolesResource,
-      undefined,
-      restRequestConfig,
-    );
-    return r.data;
-  }
-
-  public default(): Default {
-    return new Default(this);
-  }
-}
-export default Index;

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

@@ -1,38 +0,0 @@
-import AuthProfileCheckResource from "../../../../../../definitions/AuthProfileCheckResource.js";
-import CheckUserPermissionParameters from "../../../../../../definitions/CheckUserPermissionParameters.js";
-import {
-  ParentInterface,
-  RestRequestConfig,
-  RingCentralInterface,
-} from "../../../../../../types.js";
-
-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()}/check`;
-  }
-  /**
-   * Checks if a certain user permission is activated for a particular extension.
-   * HTTP Method: get
-   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/authz-profile/check
-   * Rate Limit Group: Light
-   */
-  public async get(
-    queryParams?: CheckUserPermissionParameters,
-    restRequestConfig?: RestRequestConfig,
-  ): Promise<AuthProfileCheckResource> {
-    const r = await this.rc.get<AuthProfileCheckResource>(
-      this.path(),
-      queryParams,
-      restRequestConfig,
-    );
-    return r.data;
-  }
-}
-export default Index;

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

@@ -1,45 +0,0 @@
-import Check from "./Check/index.js";
-import AuthProfileResource from "../../../../../definitions/AuthProfileResource.js";
-import ReadAuthorizationProfileParameters from "../../../../../definitions/ReadAuthorizationProfileParameters.js";
-import {
-  ParentInterface,
-  RestRequestConfig,
-  RingCentralInterface,
-} from "../../../../../types.js";
-
-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()}/authz-profile`;
-  }
-  /**
-   * Returns a list of user permissions granted at authorization procedure.
-   * Please note: Some permissions may be restricted by extension type.
-   *
-   * HTTP Method: get
-   * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/authz-profile
-   * Rate Limit Group: Medium
-   */
-  public async get(
-    queryParams?: ReadAuthorizationProfileParameters,
-    restRequestConfig?: RestRequestConfig,
-  ): Promise<AuthProfileResource> {
-    const r = await this.rc.get<AuthProfileResource>(
-      this.path(),
-      queryParams,
-      restRequestConfig,
-    );
-    return r.data;
-  }
-
-  public check(): Check {
-    return new Check(this);
-  }
-}
-export default Index;