Merge pull request #839 from aoberoi/feat-remote-files

Adds support for the Remote Files API
slackapi · Jul 26, 2019 · 8d56368 · 8d56368
2 parents bf4f18d + 162b489
commit 8d56368
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 1 deletion.
diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts
@@ -145,7 +145,7 @@ export interface Datepicker extends Action {
  * Block Types
  */
 
-export type KnownBlock = ImageBlock | ContextBlock | ActionsBlock | DividerBlock | SectionBlock;
+export type KnownBlock = ImageBlock | ContextBlock | ActionsBlock | DividerBlock | SectionBlock | FileBlock;
 
 export interface Block {
   type: string;
@@ -180,6 +180,12 @@ export interface SectionBlock extends Block {
   accessory?: KnownAction | Action | ImageElement;
 }
 
+export interface FileBlock extends Block {
+  type: 'file';
+  source: string; // 'remote'
+  external_id: string;
+}
+
 export interface MessageAttachment {
   blocks?: (KnownBlock | Block)[];
   fallback?: string; // either this or text must be defined

diff --git a/packages/web-api/src/WebClient.ts b/packages/web-api/src/WebClient.ts
@@ -397,6 +397,14 @@ export class WebClient extends EventEmitter<WebClientEvent> {
     comments: {
       delete: (this.apiCall.bind(this, 'files.comments.delete')) as Method<methods.FilesCommentsDeleteArguments>,
     },
+    remote: {
+      info: (this.apiCall.bind(this, 'files.remote.info')) as Method<methods.FilesRemoteInfoArguments>,
+      list: (this.apiCall.bind(this, 'files.remote.list')) as Method<methods.FilesRemoteListArguments>,
+      add: (this.apiCall.bind(this, 'files.remote.add')) as Method<methods.FilesRemoteAddArguments>,
+      update: (this.apiCall.bind(this, 'files.remote.update')) as Method<methods.FilesRemoteUpdateArguments>,
+      remove: (this.apiCall.bind(this, 'files.remote.remove')) as Method<methods.FilesRemoteRemoveArguments>,
+      share: (this.apiCall.bind(this, 'files.remote.share')) as Method<methods.FilesRemoteShareArguments>,
+    },
   };
 
   /**

diff --git a/packages/web-api/src/methods.ts b/packages/web-api/src/methods.ts
@@ -363,6 +363,49 @@ export interface FilesCommentsDeleteArguments extends WebAPICallOptions, TokenOv
   file: string; // file id
   id: string; // comment id
 }
+// either file or external_id is required
+export interface FilesRemoteInfoArguments extends WebAPICallOptions, TokenOverridable {
+  // either one of the file or external_id arguments are required
+  file?: string;
+  external_id?: string;
+}
+export interface FilesRemoteListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
+  ts_from?: string;
+  ts_to?: string;
+  channel?: string;
+}
+cursorPaginationEnabledMethods.add('files.remote.list');
+export interface FilesRemoteAddArguments extends WebAPICallOptions, TokenOverridable {
+  title: string;
+  external_url: string;
+  external_id: string; // a unique identifier for the file in your system
+  filetype: string; // possible values (except for 'auto'): https://api.slack.com/types/file#file_types
+  preview_image?: Buffer | Stream;
+  indexable_file_contents?: Buffer | Stream;
+}
+export interface FilesRemoteUpdateArguments extends WebAPICallOptions, TokenOverridable {
+  title?: string;
+  external_url?: string;
+  filetype?: string; // possible values (except for 'auto'): https://api.slack.com/types/file#file_types
+  preview_image?: Buffer | Stream;
+  indexable_file_contents?: Buffer | Stream;
+
+  // either one of the file or external_id arguments are required
+  file?: string;
+  external_id?: string;
+}
+export interface FilesRemoteRemoveArguments extends WebAPICallOptions, TokenOverridable {
+  // either one of the file or external_id arguments are required
+  file?: string;
+  external_id?: string;
+}
+export interface FilesRemoteShareArguments extends WebAPICallOptions, TokenOverridable {
+  channels: string; // comma-separated list of channel ids
+
+  // either one of the file or external_id arguments are required
+  file?: string;
+  external_id?: string;
+}
 
   /*
    * `groups.*`