Method apiCall

packages/web-api/src/WebClient.ts:140–163

* Generic method for calling a Web API method * * @param method the Web API method to call {@see https://api.slack.com/methods} * @param options options

(method: string, options?: WebAPICallOptions)

   * @param options options
   */
  public async apiCall(method: string, options?: WebAPICallOptions): Promise<WebAPICallResult> {
    this.logger.debug('apiCall() start');

    if (typeof options === 'string' || typeof options === 'number' || typeof options === 'boolean') {
      throw new TypeError(`Expected an options argument but instead received a ${typeof options}`);
    }

    const response = await this.makeRequest(method, Object.assign(
      { token: this.token },
      options,
    ));
    const result = this.buildResult(response);

    // log warnings in response metadata
    if (result.response_metadata !== undefined && result.response_metadata.warnings !== undefined) {
      result.response_metadata.warnings.forEach(this.logger.warn.bind(this.logger));
    }

    if (!result.ok) {
      throw platformErrorFromResult(result as (WebAPICallResult & { error: string; }));
    }

    return result;
  }

  /**
   * Iterate over the result pages of a cursor-paginated Web API method. This method can return two types of values,