angles-javascript-client 1.0.46 → 3.0.1

package/dist/lib/requests/AttachmentRequests.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AttachmentRequests = void 0;
+const BaseRequests_1 = require("./BaseRequests");
+class AttachmentRequests extends BaseRequests_1.BaseRequests {
+    constructor(axiosInstance) {
+        super(axiosInstance);
+    }
+    /**
+     * Uploads an image from the browser.
+     *
+     * Takes a File/Blob and builds a native FormData, unlike ScreenshotRequests.saveScreenshot
+     * which reads from disk with `fs` and is therefore Node-only. Attachments are captured by
+     * a QA in the browser, so that path is unusable here. The Content-Type header is
+     * deliberately not set: the browser has to add its own multipart boundary.
+     */
+    uploadAttachment(file, owner, fileName) {
+        const formData = new FormData();
+        if (owner.testCaseId)
+            formData.append('testCaseId', owner.testCaseId);
+        if (owner.sharedStepId)
+            formData.append('sharedStepId', owner.sharedStepId);
+        if (owner.executionId)
+            formData.append('executionId', owner.executionId);
+        if (fileName) {
+            formData.append('attachment', file, fileName);
+        }
+        else {
+            formData.append('attachment', file);
+        }
+        return this.post('attachment', formData);
+    }
+    getAttachments(owner) {
+        const params = {};
+        if (owner.testCaseId)
+            params.testCaseId = owner.testCaseId;
+        if (owner.sharedStepId)
+            params.sharedStepId = owner.sharedStepId;
+        return this.get('attachment', { params });
+    }
+    getAttachment(attachmentId) {
+        return this.get(`attachment/${attachmentId}`);
+    }
+    /**
+     * The URL of the full-size image. Returned rather than fetched so it can be used
+     * directly as an <img src>, which is how the markdown `attachment:<id>` references in a
+     * step's expected result are resolved.
+     */
+    getAttachmentUrl(attachmentId) {
+        return `${this.axios.defaults.baseURL || ''}attachment/${attachmentId}/file`;
+    }
+    /** The thumbnail URL. Falls back to the original server-side, so it never 404s. */
+    getThumbnailUrl(attachmentId) {
+        return `${this.axios.defaults.baseURL || ''}attachment/${attachmentId}/thumbnail`;
+    }
+    /**
+     * Deletes an attachment. Rejected with 409 while any frozen test case version still
+     * references it - the file is the only copy of what that version's tester saw. Remove
+     * the image from the test case instead.
+     */
+    deleteAttachment(attachmentId) {
+        return this.delete(`attachment/${attachmentId}`);
+    }
+}
+exports.AttachmentRequests = AttachmentRequests;
+//# sourceMappingURL=AttachmentRequests.js.map

package/dist/lib/requests/AttachmentRequests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AttachmentRequests.js","sourceRoot":"","sources":["../../../src/lib/requests/AttachmentRequests.ts"],"names":[],"mappings":";;;AACA,iDAA8C;AAY9C,MAAa,kBAAmB,SAAQ,2BAAY;IAElD,YAAmB,aAA4B;QAC7C,KAAK,CAAC,aAAa,CAAC,CAAC;IACvB,CAAC;IAED;;;;;;;OAOG;IACI,gBAAgB,CAAC,IAAU,EAAE,KAAsB,EAAE,QAAiB;QAC3E,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;QAChC,IAAI,KAAK,CAAC,UAAU;YAAE,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QACtE,IAAI,KAAK,CAAC,YAAY;YAAE,QAAQ,CAAC,MAAM,CAAC,cAAc,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;QAC5E,IAAI,KAAK,CAAC,WAAW;YAAE,QAAQ,CAAC,MAAM,CAAC,aAAa,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;QACzE,IAAI,QAAQ,EAAE;YACZ,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;SAC/C;aAAM;YACL,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;SACrC;QACD,OAAO,IAAI,CAAC,IAAI,CAAa,YAAY,EAAE,QAAQ,CAAC,CAAC;IACvD,CAAC;IAEM,cAAc,CAAC,KAAsB;QAC1C,MAAM,MAAM,GAAQ,EAAE,CAAC;QACvB,IAAI,KAAK,CAAC,UAAU;YAAE,MAAM,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QAC3D,IAAI,KAAK,CAAC,YAAY;YAAE,MAAM,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;QACjE,OAAO,IAAI,CAAC,GAAG,CAAsB,YAAY,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACjE,CAAC;IAEM,aAAa,CAAC,YAAoB;QACvC,OAAO,IAAI,CAAC,GAAG,CAAa,cAAc,YAAY,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,YAAoB;QAC1C,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,cAAc,YAAY,OAAO,CAAC;IAC/E,CAAC;IAED,mFAAmF;IAC5E,eAAe,CAAC,YAAoB;QACzC,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,cAAc,YAAY,YAAY,CAAC;IACpF,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,YAAoB;QAC1C,OAAO,IAAI,CAAC,MAAM,CAAkB,cAAc,YAAY,EAAE,CAAC,CAAC;IACpE,CAAC;CAEF;AA7DD,gDA6DC"}

package/dist/lib/requests/BuildRequests.d.ts

@@ -6,6 +6,7 @@ import { Build } from '../models/Build';
 import { Artifact } from '../models/Artifact';
 import { BuildsResponse } from '../models/response/BuildsResponse';
 import { DefaultResponse } from '../models/response/DefaultResponse';
+import { ExecutionTypes } from '../models/enum/ExecutionTypes';
 export declare class BuildRequests extends BaseRequests {
     constructor(axiosInstance: AxiosInstance);
     createBuild(request: CreateBuild): Promise<Build>;
@@ -18,8 +19,12 @@ export declare class BuildRequests extends BaseRequests {
      * @param {boolean} [returnExecutionDetails=false]
      */
     getBuilds(teamId: string, buildIds: string[], returnExecutionDetails: boolean): Promise<BuildsResponse>;
-    getBuildsWithFilters(teamId: string, filterEnvironments: string[], filterComponents: string[], skip: number, limit: number): Promise<BuildsResponse>;
-    getBuildsWithDateFilters(teamId: string, filterEnvironments: string[], filterComponents: string[], skip: number, limit: number, fromDate: Date, toDate: Date): Promise<BuildsResponse>;
+    /**
+     * @param {ExecutionTypes=} executionType - narrow to automated or manual builds. Omit
+     * for both, preserving the behaviour every existing caller relies on.
+     */
+    getBuildsWithFilters(teamId: string, filterEnvironments: string[], filterComponents: string[], skip: number, limit: number, executionType?: ExecutionTypes): Promise<BuildsResponse>;
+    getBuildsWithDateFilters(teamId: string, filterEnvironments: string[], filterComponents: string[], skip: number, limit: number, fromDate: Date, toDate: Date, executionType?: ExecutionTypes): Promise<BuildsResponse>;
     /**
      * This function will remove builds by age (including executions and screenshots).
      * NOTE: this can not be reversed, once deleted all builds and assets will have been removed.

package/dist/lib/requests/BuildRequests.js

@@ -29,12 +29,19 @@ class BuildRequests extends BaseRequests_1.BaseRequests {
             requestPath += `&returnExecutionDetails=${returnExecutionDetails}`;
         return this.get(requestPath);
     }
-    getBuildsWithFilters(teamId, filterEnvironments, filterComponents, skip, limit) {
+    /**
+     * @param {ExecutionTypes=} executionType - narrow to automated or manual builds. Omit
+     * for both, preserving the behaviour every existing caller relies on.
+     */
+    getBuildsWithFilters(teamId, filterEnvironments, filterComponents, skip, limit, executionType) {
         let params = {
             teamId,
             skip,
             limit,
         };
+        if (executionType) {
+            params.executionType = executionType;
+        }
         if (filterEnvironments && filterEnvironments.length > 0) {
             params = Object.assign({ environmentIds: filterEnvironments.join(',') }, params);
         }
@@ -45,7 +52,7 @@ class BuildRequests extends BaseRequests_1.BaseRequests {
             params,
         });
     }
-    getBuildsWithDateFilters(teamId, filterEnvironments, filterComponents, skip, limit, fromDate, toDate) {
+    getBuildsWithDateFilters(teamId, filterEnvironments, filterComponents, skip, limit, fromDate, toDate, executionType) {
         let params = {
             teamId,
             skip,
@@ -53,6 +60,9 @@ class BuildRequests extends BaseRequests_1.BaseRequests {
             fromDate: moment_1.default(fromDate).format('YYYY-MM-DD'),
             toDate: moment_1.default(toDate).format('YYYY-MM-DD'),
         };
+        if (executionType) {
+            params.executionType = executionType;
+        }
         if (filterEnvironments && filterEnvironments.length > 0) {
             params = Object.assign({ environmentIds: filterEnvironments.join(',') }, params);
         }

package/dist/lib/requests/BuildRequests.js.map

@@ -1 +1 @@
-{"version":3,"file":"BuildRequests.js","sourceRoot":"","sources":["../../../src/lib/requests/BuildRequests.ts"],"names":[],"mappings":";;;;;;AACA,iDAA8C;AAO9C,oDAA4B;AAE5B,MAAa,aAAc,SAAQ,2BAAY;IAE7C,YAAmB,aAA4B;QAC7C,KAAK,CAAC,aAAa,CAAC,CAAC;IACvB,CAAC;IAEM,WAAW,CAAC,OAAoB;QACrC,OAAO,IAAI,CAAC,IAAI,CAAQ,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;OAOG;IACI,SAAS,CAAC,MAAa,EAAE,QAAkB,EAAE,sBAA+B;QACjF,IAAI,WAAW,GAAG,iBAAiB,MAAM,EAAE,CAAC;QAC5C,IAAI,QAAQ;YAAE,WAAW,IAAI,aAAa,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/D,IAAI,sBAAsB;YAAE,WAAW,IAAI,2BAA2B,sBAAsB,EAAE,CAAC;QAC/F,OAAO,IAAI,CAAC,GAAG,CAAiB,WAAW,CAAC,CAAC;IAC/C,CAAC;IAEM,oBAAoB,CAAC,MAAa,EAAE,kBAA4B,EAAE,gBAA0B,EAAE,IAAY,EAAE,KAAY;QAC7H,IAAI,MAAM,GAAO;YACf,MAAM;YACN,IAAI;YACJ,KAAK;SACN,CAAC;QACF,IAAI,kBAAkB,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE;YACvD,MAAM,mBACJ,cAAc,EAAE,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,IACzC,MAAM,CACV,CAAC;SACH;QACD,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE;YACnD,MAAM,mBACJ,YAAY,EAAE,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,IACrC,MAAM,CACV,CAAC;SACH;QACD,OAAO,IAAI,CAAC,GAAG,CAAiB,QAAQ,EAAE;YACxC,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAEM,wBAAwB,CAAC,MAAa,EAAE,kBAA4B,EAAE,gBAA0B,EAAE,IAAY,EAAE,KAAY,EAAE,QAAc,EAAE,MAAY;QAC/J,IAAI,MAAM,GAAO;YACf,MAAM;YACN,IAAI;YACJ,KAAK;YACL,QAAQ,EAAE,gBAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC;YAC/C,MAAM,EAAE,gBAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC;SAC5C,CAAC;QACF,IAAI,kBAAkB,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE;YACvD,MAAM,mBACJ,cAAc,EAAE,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,IACzC,MAAM,CACV,CAAC;SACH;QACD,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE;YACnD,MAAM,mBACJ,YAAY,EAAE,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,IACrC,MAAM,CACV,CAAC;SACH;QACD,OAAO,IAAI,CAAC,GAAG,CAAiB,QAAQ,EAAE;YACxC,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;OAOG;IACI,YAAY,CAAC,MAAc,EAAE,SAAiB;QACnD,OAAO,IAAI,CAAC,MAAM,CAAkB,OAAO,EAAE;YAC3C,MAAM,EAAE;gBACN,MAAM;gBACN,SAAS;aACV;SACF,CAAC,CAAC;IACL,CAAC;IAEM,QAAQ,CAAC,OAAe;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAQ,SAAS,OAAO,EAAE,CAAC,CAAC;IAC7C,CAAC;IAEM,cAAc,CAAC,OAAe;QACnC,OAAO,IAAI,CAAC,GAAG,CAAgB,SAAS,OAAO,SAAS,CAAC,CAAC;IAC5D,CAAC;IAEM,WAAW,CAAC,OAAe;QAChC,OAAO,IAAI,CAAC,MAAM,CAAkB,SAAS,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,qBAAqB;IAEd,OAAO,CAAC,OAAe,EAAE,IAAa;QAC3C,OAAO,IAAI,CAAC,GAAG,CAAQ,SAAS,OAAO,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;OAOG;IACI,aAAa,CAAC,OAAe,EAAE,UAA6B;QACjE,OAAO,IAAI,CAAC,GAAG,CACb,SAAS,OAAO,aAAa,EAC7B;YACE,UAAU;SACX,EACD;YACE,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;SACF,CACF,CAAC;IACJ,CAAC;IAEM,YAAY,CAAC,OAAe,EAAE,SAAqB;QACxD,OAAO,IAAI,CAAC,GAAG,CACb,SAAS,OAAO,YAAY,EAC5B;YACE,SAAS;SACV,EACD;YACE,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;SACF,CACF,CAAC;IACJ,CAAC;CAEF;AA/ID,sCA+IC"}
+{"version":3,"file":"BuildRequests.js","sourceRoot":"","sources":["../../../src/lib/requests/BuildRequests.ts"],"names":[],"mappings":";;;;;;AACA,iDAA8C;AAQ9C,oDAA4B;AAE5B,MAAa,aAAc,SAAQ,2BAAY;IAE7C,YAAmB,aAA4B;QAC7C,KAAK,CAAC,aAAa,CAAC,CAAC;IACvB,CAAC;IAEM,WAAW,CAAC,OAAoB;QACrC,OAAO,IAAI,CAAC,IAAI,CAAQ,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;OAOG;IACI,SAAS,CAAC,MAAa,EAAE,QAAkB,EAAE,sBAA+B;QACjF,IAAI,WAAW,GAAG,iBAAiB,MAAM,EAAE,CAAC;QAC5C,IAAI,QAAQ;YAAE,WAAW,IAAI,aAAa,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/D,IAAI,sBAAsB;YAAE,WAAW,IAAI,2BAA2B,sBAAsB,EAAE,CAAC;QAC/F,OAAO,IAAI,CAAC,GAAG,CAAiB,WAAW,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACI,oBAAoB,CAAC,MAAa,EAAE,kBAA4B,EAAE,gBAA0B,EAAE,IAAY,EAAE,KAAY,EAAE,aAA8B;QAC7J,IAAI,MAAM,GAAO;YACf,MAAM;YACN,IAAI;YACJ,KAAK;SACN,CAAC;QACF,IAAI,aAAa,EAAE;YACjB,MAAM,CAAC,aAAa,GAAG,aAAa,CAAC;SACtC;QACD,IAAI,kBAAkB,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE;YACvD,MAAM,mBACJ,cAAc,EAAE,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,IACzC,MAAM,CACV,CAAC;SACH;QACD,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE;YACnD,MAAM,mBACJ,YAAY,EAAE,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,IACrC,MAAM,CACV,CAAC;SACH;QACD,OAAO,IAAI,CAAC,GAAG,CAAiB,QAAQ,EAAE;YACxC,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAEM,wBAAwB,CAAC,MAAa,EAAE,kBAA4B,EAAE,gBAA0B,EAAE,IAAY,EAAE,KAAY,EAAE,QAAc,EAAE,MAAY,EAAE,aAA8B;QAC/L,IAAI,MAAM,GAAO;YACf,MAAM;YACN,IAAI;YACJ,KAAK;YACL,QAAQ,EAAE,gBAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC;YAC/C,MAAM,EAAE,gBAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC;SAC5C,CAAC;QACF,IAAI,aAAa,EAAE;YACjB,MAAM,CAAC,aAAa,GAAG,aAAa,CAAC;SACtC;QACD,IAAI,kBAAkB,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE;YACvD,MAAM,mBACJ,cAAc,EAAE,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,IACzC,MAAM,CACV,CAAC;SACH;QACD,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE;YACnD,MAAM,mBACJ,YAAY,EAAE,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,IACrC,MAAM,CACV,CAAC;SACH;QACD,OAAO,IAAI,CAAC,GAAG,CAAiB,QAAQ,EAAE;YACxC,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;OAOG;IACI,YAAY,CAAC,MAAc,EAAE,SAAiB;QACnD,OAAO,IAAI,CAAC,MAAM,CAAkB,OAAO,EAAE;YAC3C,MAAM,EAAE;gBACN,MAAM;gBACN,SAAS;aACV;SACF,CAAC,CAAC;IACL,CAAC;IAEM,QAAQ,CAAC,OAAe;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAQ,SAAS,OAAO,EAAE,CAAC,CAAC;IAC7C,CAAC;IAEM,cAAc,CAAC,OAAe;QACnC,OAAO,IAAI,CAAC,GAAG,CAAgB,SAAS,OAAO,SAAS,CAAC,CAAC;IAC5D,CAAC;IAEM,WAAW,CAAC,OAAe;QAChC,OAAO,IAAI,CAAC,MAAM,CAAkB,SAAS,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,qBAAqB;IAEd,OAAO,CAAC,OAAe,EAAE,IAAa;QAC3C,OAAO,IAAI,CAAC,GAAG,CAAQ,SAAS,OAAO,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;OAOG;IACI,aAAa,CAAC,OAAe,EAAE,UAA6B;QACjE,OAAO,IAAI,CAAC,GAAG,CACb,SAAS,OAAO,aAAa,EAC7B;YACE,UAAU;SACX,EACD;YACE,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;SACF,CACF,CAAC;IACJ,CAAC;IAEM,YAAY,CAAC,OAAe,EAAE,SAAqB;QACxD,OAAO,IAAI,CAAC,GAAG,CACb,SAAS,OAAO,YAAY,EAC5B;YACE,SAAS;SACV,EACD;YACE,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;SACF,CACF,CAAC;IACJ,CAAC;CAEF;AAzJD,sCAyJC"}

package/dist/lib/requests/CustomFieldRequests.d.ts

@@ -0,0 +1,23 @@
+import { AxiosInstance } from 'axios';
+import { BaseRequests } from './BaseRequests';
+import { CustomFieldDefinition } from '../models/manual/CustomFieldDefinition';
+import { CreateCustomField } from '../models/requests/CreateCustomField';
+import { CustomFieldsResponse, CustomFieldDeleteResponse } from '../models/response/ManualResponses';
+export declare class CustomFieldRequests extends BaseRequests {
+    constructor(axiosInstance: AxiosInstance);
+    /** Admin only. */
+    createCustomField(request: CreateCustomField): Promise<CustomFieldDefinition>;
+    /** Readable by any team member - the authoring form needs the definitions. */
+    getCustomFields(teamId: string, includeArchived?: boolean, appliesTo?: string): Promise<CustomFieldsResponse>;
+    getCustomField(fieldId: string): Promise<CustomFieldDefinition>;
+    /**
+     * Admin only. The key can never change; the type and in-use options cannot change while
+     * test cases hold values for them.
+     */
+    updateCustomField(fieldId: string, request: Partial<CreateCustomField>): Promise<CustomFieldDefinition>;
+    /**
+     * Admin only. A field in use anywhere is archived rather than deleted, so historical
+     * values keep the label and type needed to render them - check `archived` on the result.
+     */
+    deleteCustomField(fieldId: string): Promise<CustomFieldDeleteResponse>;
+}

package/dist/lib/requests/CustomFieldRequests.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomFieldRequests = void 0;
+const BaseRequests_1 = require("./BaseRequests");
+class CustomFieldRequests extends BaseRequests_1.BaseRequests {
+    constructor(axiosInstance) {
+        super(axiosInstance);
+    }
+    /** Admin only. */
+    createCustomField(request) {
+        return this.post('custom-field', request);
+    }
+    /** Readable by any team member - the authoring form needs the definitions. */
+    getCustomFields(teamId, includeArchived = false, appliesTo) {
+        const params = { teamId };
+        if (includeArchived)
+            params.includeArchived = true;
+        if (appliesTo)
+            params.appliesTo = appliesTo;
+        return this.get('custom-field', { params });
+    }
+    getCustomField(fieldId) {
+        return this.get(`custom-field/${fieldId}`);
+    }
+    /**
+     * Admin only. The key can never change; the type and in-use options cannot change while
+     * test cases hold values for them.
+     */
+    updateCustomField(fieldId, request) {
+        return this.put(`custom-field/${fieldId}`, request);
+    }
+    /**
+     * Admin only. A field in use anywhere is archived rather than deleted, so historical
+     * values keep the label and type needed to render them - check `archived` on the result.
+     */
+    deleteCustomField(fieldId) {
+        return this.delete(`custom-field/${fieldId}`);
+    }
+}
+exports.CustomFieldRequests = CustomFieldRequests;
+//# sourceMappingURL=CustomFieldRequests.js.map

package/dist/lib/requests/CustomFieldRequests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomFieldRequests.js","sourceRoot":"","sources":["../../../src/lib/requests/CustomFieldRequests.ts"],"names":[],"mappings":";;;AACA,iDAA8C;AAQ9C,MAAa,mBAAoB,SAAQ,2BAAY;IAEnD,YAAmB,aAA4B;QAC7C,KAAK,CAAC,aAAa,CAAC,CAAC;IACvB,CAAC;IAED,kBAAkB;IACX,iBAAiB,CAAC,OAA0B;QACjD,OAAO,IAAI,CAAC,IAAI,CAAwB,cAAc,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED,8EAA8E;IACvE,eAAe,CAAC,MAAc,EAAE,kBAA2B,KAAK,EAAE,SAAkB;QACzF,MAAM,MAAM,GAAQ,EAAE,MAAM,EAAE,CAAC;QAC/B,IAAI,eAAe;YAAE,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC;QACnD,IAAI,SAAS;YAAE,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;QAC5C,OAAO,IAAI,CAAC,GAAG,CAAuB,cAAc,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACpE,CAAC;IAEM,cAAc,CAAC,OAAe;QACnC,OAAO,IAAI,CAAC,GAAG,CAAwB,gBAAgB,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACI,iBAAiB,CAAC,OAAe,EAAE,OAAmC;QAC3E,OAAO,IAAI,CAAC,GAAG,CAAwB,gBAAgB,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;OAGG;IACI,iBAAiB,CAAC,OAAe;QACtC,OAAO,IAAI,CAAC,MAAM,CAA4B,gBAAgB,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;CAEF;AAvCD,kDAuCC"}

package/dist/lib/requests/ManualTestCaseRequests.d.ts

@@ -0,0 +1,38 @@
+import { AxiosInstance } from 'axios';
+import { BaseRequests } from './BaseRequests';
+import { ManualTestCase } from '../models/manual/ManualTestCase';
+import { ManualTestCaseVersion } from '../models/manual/ManualTestCaseVersion';
+import { CreateManualTestCase } from '../models/requests/CreateManualTestCase';
+import { ManualTestCasesResponse, ManualTestCaseVersionsResponse, ManualChangeHistoryResponse } from '../models/response/ManualResponses';
+import { DefaultResponse } from '../models/response/DefaultResponse';
+export interface ManualTestCaseFilters {
+    status?: string[];
+    priority?: string[];
+    tags?: string[];
+    search?: string;
+    limit?: number;
+    skip?: number;
+}
+export declare class ManualTestCaseRequests extends BaseRequests {
+    constructor(axiosInstance: AxiosInstance);
+    createTestCase(request: CreateManualTestCase): Promise<ManualTestCase>;
+    getTestCases(teamId: string, filters?: ManualTestCaseFilters): Promise<ManualTestCasesResponse>;
+    /**
+     * Retrieves the mutable head.
+     *
+     * @param {boolean} [expand=false] resolve shared-step placeholders into the steps a
+     * tester would actually follow. This is a preview of what the next frozen version will
+     * contain, not a substitute for reading a version.
+     */
+    getTestCase(caseId: string, expand?: boolean): Promise<ManualTestCase>;
+    updateTestCase(caseId: string, request: Partial<CreateManualTestCase>): Promise<ManualTestCase>;
+    cloneTestCase(caseId: string, title?: string, comment?: string): Promise<ManualTestCase>;
+    deleteTestCase(caseId: string): Promise<DefaultResponse>;
+    getVersions(caseId: string): Promise<ManualTestCaseVersionsResponse>;
+    /**
+     * Retrieves the frozen content of one version - what an execution recorded against that
+     * version renders, unaffected by any later edit to the test case.
+     */
+    getVersion(caseId: string, version: number): Promise<ManualTestCaseVersion>;
+    getHistory(caseId: string, limit?: number, skip?: number): Promise<ManualChangeHistoryResponse>;
+}

package/dist/lib/requests/ManualTestCaseRequests.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManualTestCaseRequests = void 0;
+const BaseRequests_1 = require("./BaseRequests");
+class ManualTestCaseRequests extends BaseRequests_1.BaseRequests {
+    constructor(axiosInstance) {
+        super(axiosInstance);
+    }
+    createTestCase(request) {
+        return this.post('manual-test-case', request);
+    }
+    getTestCases(teamId, filters = {}) {
+        const params = { teamId };
+        if (filters.status && filters.status.length > 0)
+            params.status = filters.status.join(',');
+        if (filters.priority && filters.priority.length > 0)
+            params.priority = filters.priority.join(',');
+        if (filters.tags && filters.tags.length > 0)
+            params.tags = filters.tags.join(',');
+        if (filters.search)
+            params.search = filters.search;
+        if (filters.limit !== undefined)
+            params.limit = filters.limit;
+        if (filters.skip !== undefined)
+            params.skip = filters.skip;
+        return this.get('manual-test-case', { params });
+    }
+    /**
+     * Retrieves the mutable head.
+     *
+     * @param {boolean} [expand=false] resolve shared-step placeholders into the steps a
+     * tester would actually follow. This is a preview of what the next frozen version will
+     * contain, not a substitute for reading a version.
+     */
+    getTestCase(caseId, expand = false) {
+        const params = {};
+        if (expand)
+            params.expand = true;
+        return this.get(`manual-test-case/${caseId}`, { params });
+    }
+    updateTestCase(caseId, request) {
+        return this.put(`manual-test-case/${caseId}`, request);
+    }
+    cloneTestCase(caseId, title, comment) {
+        return this.post(`manual-test-case/${caseId}/clone`, { title, comment });
+    }
+    deleteTestCase(caseId) {
+        return this.delete(`manual-test-case/${caseId}`);
+    }
+    getVersions(caseId) {
+        return this.get(`manual-test-case/${caseId}/version`);
+    }
+    /**
+     * Retrieves the frozen content of one version - what an execution recorded against that
+     * version renders, unaffected by any later edit to the test case.
+     */
+    getVersion(caseId, version) {
+        return this.get(`manual-test-case/${caseId}/version/${version}`);
+    }
+    getHistory(caseId, limit, skip) {
+        const params = {};
+        if (limit !== undefined)
+            params.limit = limit;
+        if (skip !== undefined)
+            params.skip = skip;
+        return this.get(`manual-test-case/${caseId}/history`, { params });
+    }
+}
+exports.ManualTestCaseRequests = ManualTestCaseRequests;
+//# sourceMappingURL=ManualTestCaseRequests.js.map

package/dist/lib/requests/ManualTestCaseRequests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ManualTestCaseRequests.js","sourceRoot":"","sources":["../../../src/lib/requests/ManualTestCaseRequests.ts"],"names":[],"mappings":";;;AACA,iDAA8C;AAoB9C,MAAa,sBAAuB,SAAQ,2BAAY;IAEtD,YAAmB,aAA4B;QAC7C,KAAK,CAAC,aAAa,CAAC,CAAC;IACvB,CAAC;IAEM,cAAc,CAAC,OAA6B;QACjD,OAAO,IAAI,CAAC,IAAI,CAAiB,kBAAkB,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAEM,YAAY,CAAC,MAAc,EAAE,UAAiC,EAAE;QACrE,MAAM,MAAM,GAAQ,EAAE,MAAM,EAAE,CAAC;QAC/B,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;YAAE,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1F,IAAI,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC;YAAE,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAClG,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;YAAE,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAClF,IAAI,OAAO,CAAC,MAAM;YAAE,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QACnD,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS;YAAE,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC9D,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;YAAE,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QAC3D,OAAO,IAAI,CAAC,GAAG,CAA0B,kBAAkB,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;OAMG;IACI,WAAW,CAAC,MAAc,EAAE,SAAkB,KAAK;QACxD,MAAM,MAAM,GAAQ,EAAE,CAAC;QACvB,IAAI,MAAM;YAAE,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC;QACjC,OAAO,IAAI,CAAC,GAAG,CAAiB,oBAAoB,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC5E,CAAC;IAEM,cAAc,CAAC,MAAc,EAAE,OAAsC;QAC1E,OAAO,IAAI,CAAC,GAAG,CAAiB,oBAAoB,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAEM,aAAa,CAAC,MAAc,EAAE,KAAc,EAAE,OAAgB;QACnE,OAAO,IAAI,CAAC,IAAI,CAAiB,oBAAoB,MAAM,QAAQ,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAEM,cAAc,CAAC,MAAc;QAClC,OAAO,IAAI,CAAC,MAAM,CAAkB,oBAAoB,MAAM,EAAE,CAAC,CAAC;IACpE,CAAC;IAEM,WAAW,CAAC,MAAc;QAC/B,OAAO,IAAI,CAAC,GAAG,CAAiC,oBAAoB,MAAM,UAAU,CAAC,CAAC;IACxF,CAAC;IAED;;;OAGG;IACI,UAAU,CAAC,MAAc,EAAE,OAAe;QAC/C,OAAO,IAAI,CAAC,GAAG,CAAwB,oBAAoB,MAAM,YAAY,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAEM,UAAU,CAAC,MAAc,EAAE,KAAc,EAAE,IAAa;QAC7D,MAAM,MAAM,GAAQ,EAAE,CAAC;QACvB,IAAI,KAAK,KAAK,SAAS;YAAE,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;QAC9C,IAAI,IAAI,KAAK,SAAS;YAAE,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;QAC3C,OAAO,IAAI,CAAC,GAAG,CAA8B,oBAAoB,MAAM,UAAU,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACjG,CAAC;CAEF;AAjED,wDAiEC"}

package/dist/lib/requests/ManualTestRunRequests.d.ts

@@ -0,0 +1,36 @@
+import { AxiosInstance } from 'axios';
+import { BaseRequests } from './BaseRequests';
+import { ManualTestRun } from '../models/manual/ManualTestRun';
+import { CreateManualTestRun } from '../models/requests/CreateManualTestRun';
+import { RecordManualResult } from '../models/requests/RecordManualResult';
+import { ManualRunStates } from '../models/enum/ManualRunStates';
+import { ManualTestRunsResponse } from '../models/response/ManualResponses';
+import { DefaultResponse } from '../models/response/DefaultResponse';
+export declare class ManualTestRunRequests extends BaseRequests {
+    constructor(axiosInstance: AxiosInstance);
+    /**
+     * Creates the run and the manual-tagged build its results are written into. Each
+     * selected case is bound to its current frozen version.
+     */
+    createTestRun(request: CreateManualTestRun): Promise<ManualTestRun>;
+    getTestRuns(teamId: string, status?: string[], assignedTo?: string, limit?: number, skip?: number): Promise<ManualTestRunsResponse>;
+    /**
+     * @param {boolean} [expand=false] include each case's bound frozen version - the steps
+     * the tester should follow. The execution view needs this; the list view does not.
+     */
+    getTestRun(runId: string, expand?: boolean): Promise<ManualTestRun>;
+    updateTestRun(runId: string, request: Partial<CreateManualTestRun>): Promise<ManualTestRun>;
+    /**
+     * Records one case's result, writing a manual execution into the run's build so it
+     * counts on the dashboards. Re-recording updates that execution rather than adding one.
+     */
+    recordResult(runId: string, caseId: string, request: RecordManualResult): Promise<ManualTestRun>;
+    /**
+     * Moves a not-yet-run case onto the latest version of its test case. Refused with a 409
+     * once a result exists - that would re-point an execution at content it never ran.
+     */
+    rebindTestCase(runId: string, caseId: string): Promise<ManualTestRun>;
+    updateStatus(runId: string, status: ManualRunStates): Promise<ManualTestRun>;
+    /** Removes the run along with its backing build and executions. Team lead access. */
+    deleteTestRun(runId: string): Promise<DefaultResponse>;
+}

package/dist/lib/requests/ManualTestRunRequests.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManualTestRunRequests = void 0;
+const BaseRequests_1 = require("./BaseRequests");
+class ManualTestRunRequests extends BaseRequests_1.BaseRequests {
+    constructor(axiosInstance) {
+        super(axiosInstance);
+    }
+    /**
+     * Creates the run and the manual-tagged build its results are written into. Each
+     * selected case is bound to its current frozen version.
+     */
+    createTestRun(request) {
+        return this.post('manual-test-run', request);
+    }
+    getTestRuns(teamId, status, assignedTo, limit, skip) {
+        const params = { teamId };
+        if (status && status.length > 0)
+            params.status = status.join(',');
+        if (assignedTo)
+            params.assignedTo = assignedTo;
+        if (limit !== undefined)
+            params.limit = limit;
+        if (skip !== undefined)
+            params.skip = skip;
+        return this.get('manual-test-run', { params });
+    }
+    /**
+     * @param {boolean} [expand=false] include each case's bound frozen version - the steps
+     * the tester should follow. The execution view needs this; the list view does not.
+     */
+    getTestRun(runId, expand = false) {
+        const params = {};
+        if (expand)
+            params.expand = true;
+        return this.get(`manual-test-run/${runId}`, { params });
+    }
+    updateTestRun(runId, request) {
+        return this.put(`manual-test-run/${runId}`, request);
+    }
+    /**
+     * Records one case's result, writing a manual execution into the run's build so it
+     * counts on the dashboards. Re-recording updates that execution rather than adding one.
+     */
+    recordResult(runId, caseId, request) {
+        return this.put(`manual-test-run/${runId}/test-case/${caseId}/result`, request);
+    }
+    /**
+     * Moves a not-yet-run case onto the latest version of its test case. Refused with a 409
+     * once a result exists - that would re-point an execution at content it never ran.
+     */
+    rebindTestCase(runId, caseId) {
+        return this.put(`manual-test-run/${runId}/test-case/${caseId}/rebind`, {});
+    }
+    updateStatus(runId, status) {
+        return this.put(`manual-test-run/${runId}/status`, { status });
+    }
+    /** Removes the run along with its backing build and executions. Team lead access. */
+    deleteTestRun(runId) {
+        return this.delete(`manual-test-run/${runId}`);
+    }
+}
+exports.ManualTestRunRequests = ManualTestRunRequests;
+//# sourceMappingURL=ManualTestRunRequests.js.map

package/dist/lib/requests/ManualTestRunRequests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ManualTestRunRequests.js","sourceRoot":"","sources":["../../../src/lib/requests/ManualTestRunRequests.ts"],"names":[],"mappings":";;;AACA,iDAA8C;AAQ9C,MAAa,qBAAsB,SAAQ,2BAAY;IAErD,YAAmB,aAA4B;QAC7C,KAAK,CAAC,aAAa,CAAC,CAAC;IACvB,CAAC;IAED;;;OAGG;IACI,aAAa,CAAC,OAA4B;QAC/C,OAAO,IAAI,CAAC,IAAI,CAAgB,iBAAiB,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAEM,WAAW,CAAC,MAAc,EAAE,MAAiB,EAAE,UAAmB,EAAE,KAAc,EAAE,IAAa;QACtG,MAAM,MAAM,GAAQ,EAAE,MAAM,EAAE,CAAC;QAC/B,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;YAAE,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAClE,IAAI,UAAU;YAAE,MAAM,CAAC,UAAU,GAAG,UAAU,CAAC;QAC/C,IAAI,KAAK,KAAK,SAAS;YAAE,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;QAC9C,IAAI,IAAI,KAAK,SAAS;YAAE,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;QAC3C,OAAO,IAAI,CAAC,GAAG,CAAyB,iBAAiB,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;OAGG;IACI,UAAU,CAAC,KAAa,EAAE,SAAkB,KAAK;QACtD,MAAM,MAAM,GAAQ,EAAE,CAAC;QACvB,IAAI,MAAM;YAAE,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC;QACjC,OAAO,IAAI,CAAC,GAAG,CAAgB,mBAAmB,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACzE,CAAC;IAEM,aAAa,CAAC,KAAa,EAAE,OAAqC;QACvE,OAAO,IAAI,CAAC,GAAG,CAAgB,mBAAmB,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,KAAa,EAAE,MAAc,EAAE,OAA2B;QAC5E,OAAO,IAAI,CAAC,GAAG,CAAgB,mBAAmB,KAAK,cAAc,MAAM,SAAS,EAAE,OAAO,CAAC,CAAC;IACjG,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,KAAa,EAAE,MAAc;QACjD,OAAO,IAAI,CAAC,GAAG,CAAgB,mBAAmB,KAAK,cAAc,MAAM,SAAS,EAAE,EAAE,CAAC,CAAC;IAC5F,CAAC;IAEM,YAAY,CAAC,KAAa,EAAE,MAAuB;QACxD,OAAO,IAAI,CAAC,GAAG,CAAgB,mBAAmB,KAAK,SAAS,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAChF,CAAC;IAED,qFAAqF;IAC9E,aAAa,CAAC,KAAa;QAChC,OAAO,IAAI,CAAC,MAAM,CAAkB,mBAAmB,KAAK,EAAE,CAAC,CAAC;IAClE,CAAC;CAEF;AA9DD,sDA8DC"}

package/dist/lib/requests/MetricRequests.d.ts

@@ -1,6 +1,7 @@
 import { AxiosInstance } from 'axios';
 import { BaseRequests } from './BaseRequests';
 import { GroupingPeriods } from "../models/enum/GroupingPeriods";
+import { ExecutionTypes } from '../models/enum/ExecutionTypes';
 import { PhaseMetrics } from "../models/response/PhaseMetrics";
 import { ScreenshotMetrics } from "../models/response/ScreenshotMetrics";
 export declare class MetricRequests extends BaseRequests {
@@ -13,8 +14,11 @@ export declare class MetricRequests extends BaseRequests {
      * @param fromDate
      * @param toDate
      * @param groupingPeriod
+     * @param {ExecutionTypes=} executionType - narrow to automated or manual results.
+     * Omit for both, which is what every caller saw before manual runs existed. Each period
+     * also carries an executionTypeBreakdown regardless, for stacking the two.
      */
-    getPhaseMetrics(teamId: string, componentId: string, fromDate: Date, toDate: Date, groupingPeriod: GroupingPeriods): Promise<PhaseMetrics>;
+    getPhaseMetrics(teamId: string, componentId: string, fromDate: Date, toDate: Date, groupingPeriod: GroupingPeriods, executionType?: ExecutionTypes): Promise<PhaseMetrics>;
     /**
      *  Will retrieve screenshot metrics grouped by tags and views.
      *

package/dist/lib/requests/MetricRequests.js

@@ -18,8 +18,11 @@ class MetricRequests extends BaseRequests_1.BaseRequests {
      * @param fromDate
      * @param toDate
      * @param groupingPeriod
+     * @param {ExecutionTypes=} executionType - narrow to automated or manual results.
+     * Omit for both, which is what every caller saw before manual runs existed. Each period
+     * also carries an executionTypeBreakdown regardless, for stacking the two.
      */
-    getPhaseMetrics(teamId, componentId, fromDate, toDate, groupingPeriod) {
+    getPhaseMetrics(teamId, componentId, fromDate, toDate, groupingPeriod, executionType) {
         const url = new URL(this.axios.defaults.baseURL + `/metrics/phase?teamId=${teamId}`);
         if (componentId) {
             url.searchParams.append('componentId', componentId);
@@ -33,6 +36,9 @@ class MetricRequests extends BaseRequests_1.BaseRequests {
         if (groupingPeriod) {
             url.searchParams.append('groupingPeriod', groupingPeriod);
         }
+        if (executionType) {
+            url.searchParams.append('executionType', executionType);
+        }
         return this.get(url.toString());
     }
     /**

package/dist/lib/requests/MetricRequests.js.map

@@ -1 +1 @@
-{"version":3,"file":"MetricRequests.js","sourceRoot":"","sources":["../../../src/lib/requests/MetricRequests.ts"],"names":[],"mappings":";;;;;;AACA,oDAA4B;AAC5B,iDAA8C;AAK9C,MAAa,cAAe,SAAQ,2BAAY;IAE9C,YAAmB,aAA4B;QAC7C,KAAK,CAAC,aAAa,CAAC,CAAC;IACvB,CAAC;IAED;;;;;;;;OAQG;IACI,eAAe,CAAC,MAAc,EAAE,WAAmB,EAAE,QAAc,EAAE,MAAY,EAAE,cAA+B;QACvH,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,GAAG,yBAAyB,MAAM,EAAE,CAAC,CAAC;QACrF,IAAI,WAAW,EAAE;YAAE,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;SAAE;QACzE,IAAI,QAAQ,EAAE;YAAE,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,EAAE,gBAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;SAAE;QAC7F,IAAI,MAAM,EAAE;YAAE,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,EAAE,gBAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;SAAE;QACvF,IAAI,cAAc,EAAE;YAAE,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC;SAAE;QAClF,OAAO,IAAI,CAAC,GAAG,CAAe,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;OAOG;IACI,oBAAoB,CAAC,IAAY,EAAE,GAAW,EAAE,KAAa,EAAE,SAAkB;QACtF,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,GAAG,sBAAsB,CAAC,CAAC;QAC1E,IAAI,IAAI,EAAE;YAAE,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;SAAE;QACpD,IAAI,GAAG,EAAE;YAAE,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;SAAE;QACjD,IAAI,KAAK,EAAE;YAAE,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;SAAE;QAC/D,IAAI,SAAS,EAAE;YAAE,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;SAAE;QAC3E,OAAO,IAAI,CAAC,GAAG,CAAoB,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;IACrD,CAAC;CACF;AAxCD,wCAwCC"}
+{"version":3,"file":"MetricRequests.js","sourceRoot":"","sources":["../../../src/lib/requests/MetricRequests.ts"],"names":[],"mappings":";;;;;;AACA,oDAA4B;AAC5B,iDAA8C;AAM9C,MAAa,cAAe,SAAQ,2BAAY;IAE9C,YAAmB,aAA4B;QAC7C,KAAK,CAAC,aAAa,CAAC,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;OAWG;IACI,eAAe,CAAC,MAAc,EAAE,WAAmB,EAAE,QAAc,EAAE,MAAY,EAAE,cAA+B,EAAE,aAA8B;QACvJ,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,GAAG,yBAAyB,MAAM,EAAE,CAAC,CAAC;QACrF,IAAI,WAAW,EAAE;YAAE,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;SAAE;QACzE,IAAI,QAAQ,EAAE;YAAE,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,EAAE,gBAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;SAAE;QAC7F,IAAI,MAAM,EAAE;YAAE,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,EAAE,gBAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;SAAE;QACvF,IAAI,cAAc,EAAE;YAAE,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC;SAAE;QAClF,IAAI,aAAa,EAAE;YAAE,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;SAAE;QAC/E,OAAO,IAAI,CAAC,GAAG,CAAe,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;OAOG;IACI,oBAAoB,CAAC,IAAY,EAAE,GAAW,EAAE,KAAa,EAAE,SAAkB;QACtF,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,GAAG,sBAAsB,CAAC,CAAC;QAC1E,IAAI,IAAI,EAAE;YAAE,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;SAAE;QACpD,IAAI,GAAG,EAAE;YAAE,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;SAAE;QACjD,IAAI,KAAK,EAAE;YAAE,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;SAAE;QAC/D,IAAI,SAAS,EAAE;YAAE,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;SAAE;QAC3E,OAAO,IAAI,CAAC,GAAG,CAAoB,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;IACrD,CAAC;CACF;AA5CD,wCA4CC"}

package/dist/lib/requests/ScreenshotRequests.d.ts

@@ -5,6 +5,7 @@ import { StoreScreenshot } from '../models/requests/StoreScreenshot';
 import { ImageCompareResponse } from '../models/response/ImageCompareResponse';
 import { ImageFindResponse } from '../models/response/ImageFindResponse';
 import { FindImageOptions } from '../models/requests/FindImageOptions';
+import { CompareOptions } from '../models/requests/CompareOptions';
 import { DefaultResponse } from "../models/response/DefaultResponse";
 export declare class ScreenshotRequests extends BaseRequests {
     constructor(axiosInstance: AxiosInstance);
@@ -25,8 +26,17 @@ export declare class ScreenshotRequests extends BaseRequests {
     deleteScreenshot(screenshotId: string): Promise<DefaultResponse>;
     getScreenshotImage(screenshotId: string): Promise<AxiosResponse>;
     getDynamicBaselineImage(screenshotId: string, numberOfImagesToCompare: number): Promise<Screenshot>;
-    getBaselineCompareImage(screenshotId: string, cache: boolean): Promise<AxiosResponse>;
-    getBaselineCompare(screenshotId: string): Promise<ImageCompareResponse>;
+    /**
+     * Compares two stored screenshots and returns the comparison statistics.
+     * @param {CompareOptions} [options] - algorithm/threshold/regions
+     */
+    compareScreenshots(screenshotId: string, screenshotCompareId: string, options?: CompareOptions): Promise<ImageCompareResponse>;
+    /**
+     * Compares two stored screenshots and resolves with the diff image.
+     */
+    compareScreenshotsImage(screenshotId: string, screenshotCompareId: string, cache?: boolean, options?: CompareOptions): Promise<AxiosResponse>;
+    getBaselineCompareImage(screenshotId: string, cache: boolean, options?: CompareOptions): Promise<AxiosResponse>;
+    getBaselineCompare(screenshotId: string, options?: CompareOptions): Promise<ImageCompareResponse>;
     /**
      * Finds a stored screenshot (the template) within another stored screenshot using
      * multi-scale template matching, and returns the matched region(s).

package/dist/lib/requests/ScreenshotRequests.js

@@ -107,17 +107,35 @@ class ScreenshotRequests extends BaseRequests_1.BaseRequests {
         }
         return this.get(path);
     }
-    // TODO: Get screenshot compare Resemblejs JSON
-    // TODO: get screenshot compare Resemblejs Image
-    getBaselineCompareImage(screenshotId, cache) {
+    /**
+     * Compares two stored screenshots and returns the comparison statistics.
+     * @param {CompareOptions} [options] - algorithm/threshold/regions
+     */
+    compareScreenshots(screenshotId, screenshotCompareId, options) {
+        return this.get(`screenshot/${screenshotId}/compare/${screenshotCompareId}`, {
+            params: options,
+        });
+    }
+    /**
+     * Compares two stored screenshots and resolves with the diff image.
+     */
+    compareScreenshotsImage(screenshotId, screenshotCompareId, cache, options) {
+        return this.get(`screenshot/${screenshotId}/compare/${screenshotCompareId}/image`, {
+            params: Object.assign({ useCache: cache || false }, options),
+            responseType: 'arraybuffer',
+        });
+    }
+    getBaselineCompareImage(screenshotId, cache, options) {
         const useCache = cache || false;
         return this.get(`screenshot/${screenshotId}/baseline/compare/image/`, {
-            params: { useCache },
+            params: Object.assign({ useCache }, options),
             responseType: 'arraybuffer'
         });
     }
-    getBaselineCompare(screenshotId) {
-        return this.get(`screenshot/${screenshotId}/baseline/compare/`);
+    getBaselineCompare(screenshotId, options) {
+        return this.get(`screenshot/${screenshotId}/baseline/compare/`, {
+            params: options,
+        });
     }
     /**
      * Finds a stored screenshot (the template) within another stored screenshot using

package/dist/lib/requests/ScreenshotRequests.js.map

@@ -1 +1 @@
-{"version":3,"file":"ScreenshotRequests.js","sourceRoot":"","sources":["../../../src/lib/requests/ScreenshotRequests.ts"],"names":[],"mappings":";;;;;;AACA,0DAAiC;AACjC,iDAA8C;AAQ9C,MAAa,kBAAmB,SAAQ,2BAAY;IAElD,YAAmB,aAA4B;QAC7C,KAAK,CAAC,aAAa,CAAC,CAAC;IACvB,CAAC;IAEM,cAAc,CAAC,eAAgC;QACpD,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAC7B,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QACzB,MAAM,QAAQ,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAChC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAG,QAAQ,EAAE,GAAG,eAAe,CAAC;QACtE,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACpC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC9B,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC;QACtD,IAAI,IAAI;YAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QACxD,IAAI,QAAQ,EAAE;YACZ,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;gBAChD,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;SACJ;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QACxD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACzC,MAAM,UAAU,GAAG,EAAE,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACjD,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;QACpD,OAAO,IAAI,CAAC,IAAI,CAAa,aAAa,EAAE,QAAQ,EAAE;YACpD,OAAO,EAAE,QAAQ,CAAC,UAAU,EAAE;SAC/B,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,sBAAsB,CAAC,OAAe,EAAE,KAAa;QAC1D,MAAM,MAAM,GAAO,EAAE,OAAO,EAAE,CAAC;QAC/B,IAAI,KAAK,EAAE;YAAE,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;SAAE;QACpC,OAAO,IAAI,CAAC,GAAG,CAAe,aAAa,EAAE;YAC3C,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAEM,cAAc,CAAC,aAAuB;QAC3C,OAAO,IAAI,CAAC,GAAG,CAAe,aAAa,EAAE;YAC3C,MAAM,EAAE;gBACN,aAAa,EAAE,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC;aACvC;SACF,CAAC,CAAC;IACL,CAAC;IAEM,kBAAkB,CAAC,IAAY,EAAE,KAAa;QACnD,OAAO,IAAI,CAAC,GAAG,CAAW,kBAAkB,EAAE;YAC5C,MAAM,EAAE;gBACN,IAAI;gBACJ,KAAK;aACN;SACF,CAAC,CAAC;IACL,CAAC;IAEM,iBAAiB,CAAC,GAAW,EAAE,KAAa;QACjD,OAAO,IAAI,CAAC,GAAG,CAAW,iBAAiB,EAAE;YAC3C,MAAM,EAAE;gBACN,GAAG;gBACH,KAAK;aACN;SACF,CAAC,CAAC;IACL,CAAC;IAEM,0BAA0B,CAAC,IAAY,EAAE,UAAkB,EAAE,KAAa,EAAE,MAAc;QAC/F,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE;YAC9B,MAAM,EAAE;gBACN,IAAI;gBACJ,UAAU;gBACV,KAAK;gBACL,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;IAEM,+BAA+B,CAAC,IAAY,EAAE,YAAoB;QACvE,OAAO,IAAI,CAAC,GAAG,CAAe,6BAA6B,EAAE;YAC3D,MAAM,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE;SAC/B,CAAC,CAAC;IACL,CAAC;IAEM,0BAA0B,CAAC,GAAW,EAAE,YAAoB;QACjE,OAAO,IAAI,CAAC,GAAG,CAAe,wBAAwB,EAAE;YACtD,MAAM,EAAE,EAAE,GAAG,EAAE,YAAY,EAAE;SAC9B,CAAC,CAAC;IACL,CAAC;IAEM,aAAa,CAAC,YAAoB;QACvC,OAAO,IAAI,CAAC,GAAG,CAAa,cAAc,YAAY,EAAE,CAAC,CAAC;IAC5D,CAAC;IAEM,gBAAgB,CAAC,YAAoB;QAC1C,OAAO,IAAI,CAAC,MAAM,CAAkB,cAAc,YAAY,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,0BAA0B;IAEnB,kBAAkB,CAAC,YAAoB;QAC5C,OAAO,IAAI,CAAC,GAAG,CAAgB,cAAc,YAAY,QAAQ,EAC/D,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC,CAAC;IACrC,CAAC;IAEM,uBAAuB,CAAC,YAAoB,EAAE,uBAA+B;QAClF,IAAI,IAAI,GAAG,cAAc,YAAY,mBAAmB,CAAC;QACzD,IAAI,uBAAuB,IAAI,uBAAuB,GAAG,CAAC,EAAE;YAC1D,IAAI,GAAG,GAAG,IAAI,4BAA4B,uBAAuB,EAAE,CAAA;SACpE;QACD,OAAO,IAAI,CAAC,GAAG,CAAa,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,+CAA+C;IAE/C,gDAAgD;IAEzC,uBAAuB,CAAC,YAAoB,EAAE,KAAc;QACjE,MAAM,QAAQ,GAAG,KAAK,IAAI,KAAK,CAAC;QAChC,OAAO,IAAI,CAAC,GAAG,CAAgB,cAAc,YAAY,0BAA0B,EACjF;YACE,MAAM,EAAE,EAAE,QAAQ,EAAE;YACpB,YAAY,EAAE,aAAa;SAC5B,CAAC,CAAC;IACP,CAAC;IAEM,kBAAkB,CAAC,YAAoB;QAC5C,OAAO,IAAI,CAAC,GAAG,CAAuB,cAAc,YAAY,oBAAoB,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;OAMG;IACI,qBAAqB,CAAC,YAAoB,EAAE,oBAA4B,EAAE,OAA0B;QACzG,OAAO,IAAI,CAAC,GAAG,CAAoB,cAAc,YAAY,SAAS,oBAAoB,EAAE,EAAE;YAC5F,MAAM,EAAE,OAAO;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,0BAA0B,CAAC,YAAoB,EAAE,oBAA4B,EAAE,OAA0B;QAC9G,OAAO,IAAI,CAAC,GAAG,CAAgB,cAAc,YAAY,SAAS,oBAAoB,QAAQ,EAAE;YAC9F,MAAM,EAAE,OAAO;YACf,YAAY,EAAE,aAAa;SAC5B,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,6BAA6B,CAAC,YAAoB,EAAE,gBAAwB,EAAE,OAA0B;QAC7G,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAC7B,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QACzB,MAAM,QAAQ,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAChD,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;QACpF,OAAO,IAAI,CAAC,IAAI,CAAoB,cAAc,YAAY,OAAO,EAAE,QAAQ,EAAE;YAC/E,OAAO,EAAE,QAAQ,CAAC,UAAU,EAAE;YAC9B,MAAM,EAAE,OAAO;SAChB,CAAC,CAAC;IACL,CAAC;CAEF;AA9KD,gDA8KC"}
+{"version":3,"file":"ScreenshotRequests.js","sourceRoot":"","sources":["../../../src/lib/requests/ScreenshotRequests.ts"],"names":[],"mappings":";;;;;;AACA,0DAAiC;AACjC,iDAA8C;AAS9C,MAAa,kBAAmB,SAAQ,2BAAY;IAElD,YAAmB,aAA4B;QAC7C,KAAK,CAAC,aAAa,CAAC,CAAC;IACvB,CAAC;IAEM,cAAc,CAAC,eAAgC;QACpD,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAC7B,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QACzB,MAAM,QAAQ,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAChC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAG,QAAQ,EAAE,GAAG,eAAe,CAAC;QACtE,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACpC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC9B,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC;QACtD,IAAI,IAAI;YAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QACxD,IAAI,QAAQ,EAAE;YACZ,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;gBAChD,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;SACJ;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QACxD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACzC,MAAM,UAAU,GAAG,EAAE,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACjD,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;QACpD,OAAO,IAAI,CAAC,IAAI,CAAa,aAAa,EAAE,QAAQ,EAAE;YACpD,OAAO,EAAE,QAAQ,CAAC,UAAU,EAAE;SAC/B,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,sBAAsB,CAAC,OAAe,EAAE,KAAa;QAC1D,MAAM,MAAM,GAAO,EAAE,OAAO,EAAE,CAAC;QAC/B,IAAI,KAAK,EAAE;YAAE,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;SAAE;QACpC,OAAO,IAAI,CAAC,GAAG,CAAe,aAAa,EAAE;YAC3C,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAEM,cAAc,CAAC,aAAuB;QAC3C,OAAO,IAAI,CAAC,GAAG,CAAe,aAAa,EAAE;YAC3C,MAAM,EAAE;gBACN,aAAa,EAAE,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC;aACvC;SACF,CAAC,CAAC;IACL,CAAC;IAEM,kBAAkB,CAAC,IAAY,EAAE,KAAa;QACnD,OAAO,IAAI,CAAC,GAAG,CAAW,kBAAkB,EAAE;YAC5C,MAAM,EAAE;gBACN,IAAI;gBACJ,KAAK;aACN;SACF,CAAC,CAAC;IACL,CAAC;IAEM,iBAAiB,CAAC,GAAW,EAAE,KAAa;QACjD,OAAO,IAAI,CAAC,GAAG,CAAW,iBAAiB,EAAE;YAC3C,MAAM,EAAE;gBACN,GAAG;gBACH,KAAK;aACN;SACF,CAAC,CAAC;IACL,CAAC;IAEM,0BAA0B,CAAC,IAAY,EAAE,UAAkB,EAAE,KAAa,EAAE,MAAc;QAC/F,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE;YAC9B,MAAM,EAAE;gBACN,IAAI;gBACJ,UAAU;gBACV,KAAK;gBACL,MAAM;aACP;SACF,CAAC,CAAC;IACL,CAAC;IAEM,+BAA+B,CAAC,IAAY,EAAE,YAAoB;QACvE,OAAO,IAAI,CAAC,GAAG,CAAe,6BAA6B,EAAE;YAC3D,MAAM,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE;SAC/B,CAAC,CAAC;IACL,CAAC;IAEM,0BAA0B,CAAC,GAAW,EAAE,YAAoB;QACjE,OAAO,IAAI,CAAC,GAAG,CAAe,wBAAwB,EAAE;YACtD,MAAM,EAAE,EAAE,GAAG,EAAE,YAAY,EAAE;SAC9B,CAAC,CAAC;IACL,CAAC;IAEM,aAAa,CAAC,YAAoB;QACvC,OAAO,IAAI,CAAC,GAAG,CAAa,cAAc,YAAY,EAAE,CAAC,CAAC;IAC5D,CAAC;IAEM,gBAAgB,CAAC,YAAoB;QAC1C,OAAO,IAAI,CAAC,MAAM,CAAkB,cAAc,YAAY,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,0BAA0B;IAEnB,kBAAkB,CAAC,YAAoB;QAC5C,OAAO,IAAI,CAAC,GAAG,CAAgB,cAAc,YAAY,QAAQ,EAC/D,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC,CAAC;IACrC,CAAC;IAEM,uBAAuB,CAAC,YAAoB,EAAE,uBAA+B;QAClF,IAAI,IAAI,GAAG,cAAc,YAAY,mBAAmB,CAAC;QACzD,IAAI,uBAAuB,IAAI,uBAAuB,GAAG,CAAC,EAAE;YAC1D,IAAI,GAAG,GAAG,IAAI,4BAA4B,uBAAuB,EAAE,CAAA;SACpE;QACD,OAAO,IAAI,CAAC,GAAG,CAAa,IAAI,CAAC,CAAC;IACpC,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,YAAoB,EAAE,mBAA2B,EAAE,OAAwB;QACnG,OAAO,IAAI,CAAC,GAAG,CAAuB,cAAc,YAAY,YAAY,mBAAmB,EAAE,EAAE;YACjG,MAAM,EAAE,OAAO;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,uBAAuB,CAAC,YAAoB,EAAE,mBAA2B,EAAE,KAAe,EAAE,OAAwB;QACzH,OAAO,IAAI,CAAC,GAAG,CAAgB,cAAc,YAAY,YAAY,mBAAmB,QAAQ,EAAE;YAChG,MAAM,kBAAI,QAAQ,EAAE,KAAK,IAAI,KAAK,IAAK,OAAO,CAAE;YAChD,YAAY,EAAE,aAAa;SAC5B,CAAC,CAAC;IACL,CAAC;IAEM,uBAAuB,CAAC,YAAoB,EAAE,KAAc,EAAE,OAAwB;QAC3F,MAAM,QAAQ,GAAG,KAAK,IAAI,KAAK,CAAC;QAChC,OAAO,IAAI,CAAC,GAAG,CAAgB,cAAc,YAAY,0BAA0B,EACjF;YACE,MAAM,kBAAI,QAAQ,IAAK,OAAO,CAAE;YAChC,YAAY,EAAE,aAAa;SAC5B,CAAC,CAAC;IACP,CAAC;IAEM,kBAAkB,CAAC,YAAoB,EAAE,OAAwB;QACtE,OAAO,IAAI,CAAC,GAAG,CAAuB,cAAc,YAAY,oBAAoB,EAAE;YACpF,MAAM,EAAE,OAAO;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,qBAAqB,CAAC,YAAoB,EAAE,oBAA4B,EAAE,OAA0B;QACzG,OAAO,IAAI,CAAC,GAAG,CAAoB,cAAc,YAAY,SAAS,oBAAoB,EAAE,EAAE;YAC5F,MAAM,EAAE,OAAO;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,0BAA0B,CAAC,YAAoB,EAAE,oBAA4B,EAAE,OAA0B;QAC9G,OAAO,IAAI,CAAC,GAAG,CAAgB,cAAc,YAAY,SAAS,oBAAoB,QAAQ,EAAE;YAC9F,MAAM,EAAE,OAAO;YACf,YAAY,EAAE,aAAa;SAC5B,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,6BAA6B,CAAC,YAAoB,EAAE,gBAAwB,EAAE,OAA0B;QAC7G,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAC7B,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QACzB,MAAM,QAAQ,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAChD,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;QACpF,OAAO,IAAI,CAAC,IAAI,CAAoB,cAAc,YAAY,OAAO,EAAE,QAAQ,EAAE;YAC/E,OAAO,EAAE,QAAQ,CAAC,UAAU,EAAE;YAC9B,MAAM,EAAE,OAAO;SAChB,CAAC,CAAC;IACL,CAAC;CAEF;AAhMD,gDAgMC"}

package/dist/lib/requests/SharedStepRequests.d.ts

@@ -0,0 +1,24 @@
+import { AxiosInstance } from 'axios';
+import { BaseRequests } from './BaseRequests';
+import { SharedStep } from '../models/manual/SharedStep';
+import { CreateSharedStep } from '../models/requests/CreateSharedStep';
+import { SharedStepsResponse, SharedStepUsageResponse, SharedStepUpdateResponse, ManualChangeHistoryResponse } from '../models/response/ManualResponses';
+import { DefaultResponse } from '../models/response/DefaultResponse';
+export declare class SharedStepRequests extends BaseRequests {
+    constructor(axiosInstance: AxiosInstance);
+    createSharedStep(request: CreateSharedStep): Promise<SharedStep>;
+    getSharedSteps(teamId: string, search?: string, limit?: number, skip?: number): Promise<SharedStepsResponse>;
+    getSharedStep(sharedStepId: string): Promise<SharedStep>;
+    /**
+     * Lists the test cases including this shared step - how many an edit will re-version,
+     * and which ones block a delete. Worth calling before either.
+     */
+    getUsage(sharedStepId: string): Promise<SharedStepUsageResponse>;
+    /**
+     * Updates the shared step. Changing its steps re-versions every referencing test case;
+     * the response's `cascade` reports how many. Renaming cascades to nothing.
+     */
+    updateSharedStep(sharedStepId: string, request: Partial<CreateSharedStep>): Promise<SharedStepUpdateResponse>;
+    deleteSharedStep(sharedStepId: string): Promise<DefaultResponse>;
+    getHistory(sharedStepId: string, limit?: number, skip?: number): Promise<ManualChangeHistoryResponse>;
+}