1.19.0

js/chrisAPI/dist/types/client.d.ts

@@ -60,6 +60,7 @@ export default class Client {
     pacsFilesUrl: string;
     serviceFilesUrl: string;
     fileBrowserUrl: string;
+    downloadTokensUrl: string;
     userUrl: string;
     adminUrl: string;
     /**
@@ -782,6 +783,7 @@ export default class Client {
      * @param {string} [searchParams.SeriesDescription] - match file's SeriesDescription containing this string
      * @param {string} [searchParams.min_creation_date] - match file's creation_date greater than this date string
      * @param {string} [searchParams.max_creation_date] - match file's creation_date lesser than this date string
+     * @param {string} [searchParams.pacs_identifier] - match file's PACS exactly with this string
      * @param {number} [timeout=30000] - request timeout
      *
      * @return {Promise<PACSFileList>} - JS Promise, resolves to a ``PACSFileList`` object
@@ -811,6 +813,7 @@ export default class Client {
         SeriesDescription?: string;
         min_creation_date?: string;
         max_creation_date?: string;
+        pacs_identifier?: string;
     }, timeout?: number): Promise<PACSFileList>;
     /**
      * Get a PACS file resource object given its id.
@@ -835,6 +838,7 @@ export default class Client {
      * @param {string|number} [searchParams.fname_nslashes] - match file's path containing this number of slashes
      * @param {string} [searchParams.min_creation_date] - match file's creation_date greater than this date string
      * @param {string} [searchParams.max_creation_date] - match file's creation_date lesser than this date string
+     * @param {string} [searchParams.service_identifier] - match file's service exactly with this string
      * @param {number} [timeout=30000] - request timeout
      *
      * @return {Promise<ServiceFileList>} - JS Promise, resolves to a ``ServiceFileList`` object
@@ -849,6 +853,7 @@ export default class Client {
         fname_nslashes?: string | number;
         min_creation_date?: string;
         max_creation_date?: string;
+        service_identifier?: string;
     }, timeout?: number): Promise<ServiceFileList>;
     /**
      * Get a service file resource object given its id.
@@ -897,6 +902,40 @@ export default class Client {
      * @return {Promise<FileBrowserFolder|null>} - JS Promise, resolves to a ``FileBrowserFolder`` object or ``null``
      */
     getFileBrowserFolderByPath(path: string, timeout?: number): Promise<FileBrowserFolder | null>;
+    /**
+     * Get a paginated list of file download tokens for the authenticated user from the REST API
+     * given query search parameters. If no search parameters then get the default first page.
+     *
+     * @param {Object} [searchParams=null] - search parameters object
+     * @param {number} [searchParams.limit] - page limit
+     * @param {number} [searchParams.offset] - page offset
+     * @param {number} [searchParams.id] - match file download token id exactly with this number
+     * @param {number} [timeout=30000] - request timeout
+     *
+     * @return {Promise<DownloadTokenList>} - JS Promise, resolves to a ``DownloadTokenList`` object
+     */
+    getDownloadTokens(searchParams?: {
+        limit?: number;
+        offset?: number;
+        id?: number;
+    }, timeout?: number): Promise<DownloadTokenList>;
+    /**
+     * Get a download token resource object given its id.
+     *
+     * @param {number} id - file download token id
+     * @param {number} [timeout=30000] - request timeout
+     *
+     * @return {Promise<DownloadToken>} - JS Promise, resolves to a ``DownloadToken`` object
+     */
+    getDownloadToken(id: number, timeout?: number): Promise<DownloadToken>;
+    /**
+     * Create a new file download token resource through the REST API.
+     *
+     * @param {number} [timeout=30000] - request timeout
+     *
+     * @return {Promise<DownloadToken>} - JS Promise, resolves to a ``DownloadToken`` object
+     */
+    createDownloadToken(timeout?: number): Promise<DownloadToken>;
     /**
      * Get a user resource object for the currently authenticated user.
      * @param {number} [timeout=30000] - request timeout
@@ -949,4 +988,6 @@ import { ServiceFileList } from "./servicefile";
 import { ServiceFile } from "./servicefile";
 import { FileBrowserFolderList } from "./filebrowser";
 import { FileBrowserFolder } from "./filebrowser";
+import { DownloadTokenList } from "./downloadtoken";
+import { DownloadToken } from "./downloadtoken";
 import User from "./user";

js/chrisAPI/dist/types/downloadtoken.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Download token item resource object representing a file download token.
+ */
+export class DownloadToken extends ItemResource {
+    /**
+     * Constructor
+     *
+     * @param {string} url - url of the resource
+     * @param {Object} auth - authentication object
+     * @param {string} auth.token - authentication token
+     */
+    constructor(url: string, auth: {
+        token: string;
+    });
+}
+/**
+ * Download token list resource object representing a list of a user's file download tokens.
+ */
+export class DownloadTokenList extends ListResource {
+    /**
+     * Constructor
+     *
+     * @param {string} url - url of the resource
+     * @param {Object} auth - authentication object
+     * @param {string} auth.token - authentication token
+     */
+    constructor(url: string, auth: {
+        token: string;
+    });
+    /**
+     * Make a POST request to this download token list resource to create a new file download token
+     * item resource through the REST API.
+     *
+     * @param {number} [timeout=30000] - request timeout
+     *
+     * @return {Promise<this>} - JS Promise, resolves to ``this`` object
+     */
+    post(timeout?: number): Promise<DownloadTokenList>;
+}
+import { ItemResource } from "./resource";
+import { ListResource } from "./resource";

js/chrisAPI/dist/types/filebrowser.d.ts

@@ -52,6 +52,14 @@ export class FileBrowserFolder extends ItemResource {
         limit?: number;
         offset?: number;
     }, timeout?: number): Promise<FileBrowserFolderLinkFileList>;
+    /**
+     * Make a DELETE request to delete this file browser folder item resource through the REST API.
+     *
+     * @param {number} [timeout=30000] - request timeout
+     *
+     * @return {Promise} - JS Promise
+     */
+    delete(timeout?: number): Promise<any>;
 }
 /**
  * File browser folder list resource object representing a list of folders.

js/chrisAPI/dist/types/index.d.ts

@@ -74,4 +74,6 @@ import { FileBrowserFolderFileList } from "./filebrowser";
 import { FileBrowserFolderFile } from "./filebrowser";
 import { FileBrowserFolderLinkFileList } from "./filebrowser";
 import { FileBrowserFolderLinkFile } from "./filebrowser";
-export { Request, Collection, RequestException, ListResource, ItemResource, Resource, ChrisInstance, FeedList, PublicFeedList, Feed, ComputeResourceAdminList, ComputeResourceAdmin, PluginAdminList, PluginAdmin, PluginList, PluginMetaPluginList, Plugin, PluginMetaList, PluginMeta, PluginParameterList, PluginParameter, PluginComputeResourceList, ComputeResourceList, ComputeResource, PluginInstanceDescendantList, PluginInstanceList, PluginInstance, AllPluginInstanceList, PluginInstanceSplitList, PluginInstanceSplit, PluginInstanceParameterList, PluginInstanceParameter, FeedPluginInstanceList, PipelineInstancePluginInstanceList, WorkflowPluginInstanceList, PipelineList, PipelinePluginList, PipelinePluginPipingList, Pipeline, PipelinePipingDefaultParameterList, PluginPiping, PipingDefaultParameter, PipelineSourceFileList, PipelineSourceFile, AllPipelineInstanceList, PipelineInstanceList, PipelineInstance, AllWorkflowList, WorkflowList, Workflow, TagList, Tag, TagTaggingList, FeedTaggingList, Tagging, TagFeedList, FeedTagList, Note, User, CommentList, Comment, UserFileList, UserFile, PACSFileList, PACSFile, ServiceFileList, ServiceFile, FileBrowserFolderList, FileBrowserFolderChildList, FileBrowserFolder, FileBrowserFolderFileList, FileBrowserFolderFile, FileBrowserFolderLinkFileList, FileBrowserFolderLinkFile };
+import { DownloadTokenList } from "./downloadtoken";
+import { DownloadToken } from "./downloadtoken";
+export { Request, Collection, RequestException, ListResource, ItemResource, Resource, ChrisInstance, FeedList, PublicFeedList, Feed, ComputeResourceAdminList, ComputeResourceAdmin, PluginAdminList, PluginAdmin, PluginList, PluginMetaPluginList, Plugin, PluginMetaList, PluginMeta, PluginParameterList, PluginParameter, PluginComputeResourceList, ComputeResourceList, ComputeResource, PluginInstanceDescendantList, PluginInstanceList, PluginInstance, AllPluginInstanceList, PluginInstanceSplitList, PluginInstanceSplit, PluginInstanceParameterList, PluginInstanceParameter, FeedPluginInstanceList, PipelineInstancePluginInstanceList, WorkflowPluginInstanceList, PipelineList, PipelinePluginList, PipelinePluginPipingList, Pipeline, PipelinePipingDefaultParameterList, PluginPiping, PipingDefaultParameter, PipelineSourceFileList, PipelineSourceFile, AllPipelineInstanceList, PipelineInstanceList, PipelineInstance, AllWorkflowList, WorkflowList, Workflow, TagList, Tag, TagTaggingList, FeedTaggingList, Tagging, TagFeedList, FeedTagList, Note, User, CommentList, Comment, UserFileList, UserFile, PACSFileList, PACSFile, ServiceFileList, ServiceFile, FileBrowserFolderList, FileBrowserFolderChildList, FileBrowserFolder, FileBrowserFolderFileList, FileBrowserFolderFile, FileBrowserFolderLinkFileList, FileBrowserFolderLinkFile, DownloadTokenList, DownloadToken };

js/chrisAPI/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fnndsc/chrisapi",
-  "version": "1.17.0",
+  "version": "1.19.0",
   "description": "JavaScript6 client for the ChRIS API",
   "main": "./dist/node/main.js",
   "types": "./dist/types/index.d.ts",