add apps.permissions.resources.list, apps.permissions.scopes.list [#565]

.gitignore

@@ -6,3 +6,4 @@ examples/package-lock.json
 
 # nyc test coverage
 .nyc_output
+package-lock.json

docs/_reference/IncomingWebhook.md

@@ -8,13 +8,13 @@ A client for Slack's Incoming Webhooks
 **Kind**: static class of [<code>@slack/client</code>](#module_@slack/client)  
 
 * [.IncomingWebhook](#module_@slack/client.IncomingWebhook)
-    * [.send(message)](#module_@slack/client.IncomingWebhook+send) ⇒ <code>Promise.&lt;module:@slack/client/dist/IncomingWebhook.IncomingWebhookResult&gt;</code>
+    * [.send(message)](#module_@slack/client.IncomingWebhook+send) ⇒ [<code>Promise.&lt;IncomingWebhookResult&gt;</code>](#module_@slack/client.IncomingWebhookResult)
     * [.send(message, callback)](#module_@slack/client.IncomingWebhook+send)
     * [.send(message, callback)](#module_@slack/client.IncomingWebhook+send)
 
 <a name="module_@slack/client.IncomingWebhook+send"></a>
 
-### incomingWebhook.send(message) ⇒ <code>Promise.&lt;module:@slack/client/dist/IncomingWebhook.IncomingWebhookResult&gt;</code>
+### incomingWebhook.send(message) ⇒ [<code>Promise.&lt;IncomingWebhookResult&gt;</code>](#module_@slack/client.IncomingWebhookResult)
 Send a notification to a conversation
 
 **Kind**: instance method of [<code>IncomingWebhook</code>](#module_@slack/client.IncomingWebhook)  

src/WebClient.ts

@@ -216,6 +216,14 @@ export class WebClient extends EventEmitter {
     permissions: {
       info: (this.apiCall.bind(this, 'apps.permissions.info')) as Method<methods.AppsPermissionsInfoArguments>,
       request: (this.apiCall.bind(this, 'apps.permissions.request')) as Method<methods.AppsPermissionsRequestArguments>,
+      resources: {
+        list: (this.apiCall.bind(this, 'apps.permissions.resources.list')) as
+          Method<methods.AppsPermissionsResourcesListArguments>,
+      },
+      scopes: {
+        list: (this.apiCall.bind(this, 'apps.permissions.scopes.list')) as
+          Method<methods.AppsPermissionsScopesListArguments>,
+      },
     },
   };
 
@@ -573,7 +581,7 @@ export class WebClient extends EventEmitter {
   /**
    * Processes an HTTP response into a WebAPICallResult by performing JSON parsing on the body and merging relevent
    * HTTP headers into the object.
-   * @param response
+   * @param response - an http response
    */
   private buildResult(response: got.Response<string>): WebAPICallResult {
     const data = JSON.parse(response.body);
@@ -674,10 +682,9 @@ function canBodyBeFormMultipart(body: FormCanBeURLEncoded | BodyCanBeFormMultipa
   return isStream(body);
 }
 
-
 /**
  * A factory to create WebAPIRequestError objects
- * @param original
+ * @param original - original error
  */
 function requestErrorWithOriginal(original: Error): WebAPIRequestError {
   const error = errorWithCode(
@@ -691,7 +698,7 @@ function requestErrorWithOriginal(original: Error): WebAPIRequestError {
 
 /**
  * A factory to create WebAPIReadError objects
- * @param original
+ * @param original - original error
  */
 function readErrorWithOriginal(original: Error): WebAPIReadError {
   const error = errorWithCode(
@@ -705,7 +712,7 @@ function readErrorWithOriginal(original: Error): WebAPIReadError {
 
 /**
  * A factory to create WebAPIHTTPError objects
- * @param original
+ * @param original - original error
  */
 function httpErrorWithOriginal(original: Error): WebAPIHTTPError {
   const error = errorWithCode(

src/methods.ts

@@ -155,6 +155,8 @@ export type AppsPermissionsRequestArguments = TokenOverridable & {
   scopes: string; // comma-separated list of scopes
   trigger_id: string;
 };
+export type AppsPermissionsResourcesListArguments = TokenOverridable & CursorPaginationEnabled;
+export type AppsPermissionsScopesListArguments = TokenOverridable & {};
 
   /*
    * `auth.*`

support/jsdoc/@slack-client-dist-IncomingWebhook.js

@@ -29,10 +29,3 @@ export class IncomingWebhookReadError {
 export class IncomingWebhookRequestError {
 }
 
-/**
- * @interface module:@slack/client/dist/IncomingWebhook.IncomingWebhookResult
- * @property {string} text
- */
-export class IncomingWebhookResult {
-}
-

support/jsdoc/@slack-client-dist-methods.js

@@ -2,12 +2,41 @@
  * @module @slack/client/dist/methods
  */
 
+/**
+ * @interface module:@slack/client/dist/methods.AttachmentAction
+ * @property {string} [id]
+ * @property {module:@slack/client/dist/methods.Confirmation} [confirm]
+ * @property {string} [data_source]
+ * @property {number} [min_query_length]
+ * @property {string} [name]
+ * @property {Array<module:@slack/client/dist/methods.OptionField>} [options]
+ * @property {Array<module:@slack/client/dist/methods.__type>} [option_groups]
+ * @property {Array<module:@slack/client/dist/methods.OptionField>} [selected_options]
+ * @property {string} [style]
+ * @property {string} text
+ * @property {string} type
+ * @property {string} [value]
+ * @property {string} [url]
+ */
+export class AttachmentAction {
+}
+
 /**
  * @interface module:@slack/client/dist/methods.AuxiliaryArguments
  */
 export class AuxiliaryArguments {
 }
 
+/**
+ * @interface module:@slack/client/dist/methods.Confirmation
+ * @property {string} [dismiss_text]
+ * @property {string} [ok_text]
+ * @property {string} text
+ * @property {string} [title]
+ */
+export class Confirmation {
+}
+
 /**
  * @interface module:@slack/client/dist/methods.CursorPaginationEnabled
  * @property {number} [limit]
@@ -22,6 +51,7 @@ export class CursorPaginationEnabled {
  * @property {string} callback_id
  * @property {Array<module:@slack/client/dist/methods.__type>} elements
  * @property {string} [submit_label]
+ * @property {boolean} [notify_on_cancel]
  */
 export class Dialog {
 }
@@ -56,7 +86,7 @@ export class LocaleAware {
  * @property {string} [footer]
  * @property {string} [footer_icon]
  * @property {string} [ts]
- * @property {Array<module:@slack/client/dist/methods.__type>} [actions]
+ * @property {Array<module:@slack/client/dist/methods.AttachmentAction>} [actions]
  * @property {string} [callback_id]
  * @property {Array<"pretext" | "text" | "fields">} [mrkdwn_in]
  */
@@ -69,6 +99,23 @@ export class MessageAttachment {
 export class Method {
 }
 
+/**
+ * @interface module:@slack/client/dist/methods.OptionField
+ * @property {string} [description]
+ * @property {string} text
+ * @property {string} value
+ */
+export class OptionField {
+}
+
+/**
+ * @interface module:@slack/client/dist/methods.SelectOption
+ * @property {string} label
+ * @property {string} value
+ */
+export class SelectOption {
+}
+
 /**
  * @interface module:@slack/client/dist/methods.TimelinePaginationEnabled
  * @property {string} [oldest]

support/jsdoc/@slack-client.js

@@ -50,7 +50,7 @@ export class IncomingWebhook {
    * Send a notification to a conversation
    * @param {string | module:@slack/client.IncomingWebhookSendArguments} message the message (a simple string, or an object describing the message)
    * @function module:@slack/client.IncomingWebhook#send
-   * @returns {Promise<module:@slack/client/dist/IncomingWebhook.IncomingWebhookResult>}
+   * @returns {Promise<module:@slack/client.IncomingWebhookResult>}
    */
   send() {}
 
@@ -81,6 +81,13 @@ export class IncomingWebhook {
 export class IncomingWebhookDefaultArguments {
 }
 
+/**
+ * @interface module:@slack/client.IncomingWebhookResult
+ * @property {string} text
+ */
+export class IncomingWebhookResult {
+}
+
 /**
  * @interface module:@slack/client.IncomingWebhookResultCallback
  */