@wix/workflows 1.0.0

package/build/es/src/workflows-v1-phase.universal.js

@@ -0,0 +1,459 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { serializer, transformError } from '@wix/metro-runtime/velo';
+import * as ambassadorWixWorkflowsV1Phase from './workflows-v1-phase.http';
+let __verbose = false;
+function __log(...args) {
+    __verbose && console.log(...args);
+}
+function __inspect(obj) {
+    return obj;
+}
+export const __debug = {
+    verboseLogging: {
+        on: () => (__verbose = true),
+        off: () => (__verbose = false),
+    },
+};
+const _toVeloEntity = '$';
+const _fromVeloEntity = '$';
+/** describes the supported types of attachments (currently only supports Contact which is the default type) */
+export var AttachmentType;
+(function (AttachmentType) {
+    AttachmentType["ContactType"] = "ContactType";
+})(AttachmentType || (AttachmentType = {}));
+export var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder || (SortOrder = {}));
+const _createPhaseRequest = {};
+const _createPhaseResponse = {};
+const _deletePhaseRequest = {};
+const _deletePhaseResponse = {};
+const _getPhaseRequest = {};
+const _getPhaseResponse = {};
+const _listPhasesRequest = {};
+const _listPhasesResponse = {};
+const _movePhaseRequest = {};
+const _movePhaseResponse = {};
+const _queryPhasesRequest = {};
+const _queryPhasesResponse = {};
+const _updatePhaseRequest = {};
+const _updatePhaseResponse = {};
+/**
+ * Returns a list of phases according to:
+ * * paging: offset, limit
+ * * order: by some of the following fields: id, name, position
+ * * filter: by the following fields of PhaseInfo
+ * ** phaseInfo.id         - Guid
+ * ** phaseInfo.name       - Text
+ * ** phaseInfo.visibility - Text (Visible / Archived)
+ * @public
+ * @documentationMaturity preview
+ */
+export function queryPhases(options) {
+    var _a, _b, _c;
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = { query: '$[0].query' };
+        const responseTransformation = '$';
+        // @ts-ignore
+        const { httpClient, sideEffects } = arguments[1];
+        const { toAmbassadorRequest } = serializer({
+            rootSchema: _queryPhasesRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = serializer({
+            rootSchema: _queryPhasesResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [...['Array#phases']],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([options]);
+        const reqOpts = ambassadorWixWorkflowsV1Phase.queryPhases(payload);
+        __log(`"QueryPhases" sending request with: ${__inspect(reqOpts)}`);
+        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
+        try {
+            const result = yield httpClient.request(reqOpts);
+            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
+            return fromJSON(result.data);
+        }
+        catch (err) {
+            const transformedError = transformError(err, requestTransformation, [
+                'options',
+            ]);
+            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
+            throw transformedError;
+        }
+    });
+}
+/**
+ * Retrieves a list of active phases in the specified workflow.
+ *
+ * By default, the returned phases are sorted by their display order.
+ *
+ * The win phase is not an active phase
+ * and is therefore not returned with this endpoint.
+ * To get the win phase ID, use
+ * [Get Workflow](https://dev.wix.com/api/rest/workflows/workflows/workflows/get-workflow?branch=workflows).
+ * @param workflowId - ID of the workflow whose phases will be listed.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField workflowId
+ */
+export function listPhases(workflowId, options) {
+    var _a, _b, _c;
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = {
+            workflowId: '$[0]',
+            limit: '$[1].limit',
+            offset: '$[1].offset',
+            sort: '$[1].sort',
+        };
+        const responseTransformation = '$';
+        // @ts-ignore
+        const { httpClient, sideEffects } = arguments[2];
+        const { toAmbassadorRequest } = serializer({
+            rootSchema: _listPhasesRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = serializer({
+            rootSchema: _listPhasesResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [...['Array#phases']],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([workflowId, options]);
+        const reqOpts = ambassadorWixWorkflowsV1Phase.listPhases(payload);
+        __log(`"ListPhases" sending request with: ${__inspect(reqOpts)}`);
+        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
+        try {
+            const result = yield httpClient.request(reqOpts);
+            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
+            return fromJSON(result.data);
+        }
+        catch (err) {
+            const transformedError = transformError(err, requestTransformation, [
+                'workflowId',
+                'options',
+            ]);
+            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
+            throw transformedError;
+        }
+    });
+}
+/**
+ * Retrieves a phase and its cards.
+ * @param _id - ID of the phase to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export function getPhase(_id) {
+    var _a, _b, _c;
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = { id: '$[0]' };
+        const responseTransformation = '$';
+        // @ts-ignore
+        const { httpClient, sideEffects } = arguments[1];
+        const { toAmbassadorRequest } = serializer({
+            rootSchema: _getPhaseRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = serializer({
+            rootSchema: _getPhaseResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [...['phase']],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([_id]);
+        const reqOpts = ambassadorWixWorkflowsV1Phase.getPhase(payload);
+        __log(`"GetPhase" sending request with: ${__inspect(reqOpts)}`);
+        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
+        try {
+            const result = yield httpClient.request(reqOpts);
+            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
+            return fromJSON(result.data);
+        }
+        catch (err) {
+            const transformedError = transformError(err, requestTransformation, [
+                '_id',
+            ]);
+            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
+            throw transformedError;
+        }
+    });
+}
+/**
+ * Updates a phase's name.
+ *
+ * To reorder phases, use
+ * [Move Phase](https://dev.wix.com/api/rest/workflows/workflows/phases/move-phase).
+ * To reorder or rename cards, use the
+ * [Cards API](https://dev.wix.com/api/rest/workflows/workflows/cards).
+ * @param _id - ID of the phase to update.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export function updatePhase(_id, options) {
+    var _a, _b, _c;
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = { id: '$[0]', phase: '$[1].phase' };
+        const responseTransformation = '$';
+        // @ts-ignore
+        const { httpClient, sideEffects } = arguments[2];
+        const { toAmbassadorRequest } = serializer({
+            rootSchema: _updatePhaseRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = serializer({
+            rootSchema: _updatePhaseResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([_id, options]);
+        const reqOpts = ambassadorWixWorkflowsV1Phase.updatePhase(payload);
+        __log(`"UpdatePhase" sending request with: ${__inspect(reqOpts)}`);
+        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
+        try {
+            const result = yield httpClient.request(reqOpts);
+            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
+            return fromJSON(result.data);
+        }
+        catch (err) {
+            const transformedError = transformError(err, requestTransformation, [
+                '_id',
+                'options',
+            ]);
+            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
+            throw transformedError;
+        }
+    });
+}
+/**
+ * Creates a new phase in the specified workflow.
+ *
+ * When creating a phase, you provide a `name` and an optional `position`.
+ *
+ * Phases are displayed according to their position from left to right,
+ * starting from `0` and incrementing by 1.
+ * If you create or move a phase to an existing position,
+ * the phase in that position and any subsequent phases
+ * are shifted to the right by 1.
+ *
+ * If `position` is not specified,
+ * the new phase is given the rightmost position.
+ * @param workflowId - ID of the workflow to create the phase in.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.phase.name
+ * @requiredField workflowId
+ */
+export function createPhase(workflowId, options) {
+    var _a, _b, _c;
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = {
+            workflowId: '$[0]',
+            phase: '$[1].phase',
+            position: '$[1].position',
+        };
+        const responseTransformation = '$';
+        // @ts-ignore
+        const { httpClient, sideEffects } = arguments[2];
+        const { toAmbassadorRequest } = serializer({
+            rootSchema: _createPhaseRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = serializer({
+            rootSchema: _createPhaseResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([workflowId, options]);
+        const reqOpts = ambassadorWixWorkflowsV1Phase.createPhase(payload);
+        __log(`"CreatePhase" sending request with: ${__inspect(reqOpts)}`);
+        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
+        try {
+            const result = yield httpClient.request(reqOpts);
+            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
+            return fromJSON(result.data);
+        }
+        catch (err) {
+            const transformedError = transformError(err, requestTransformation, [
+                'workflowId',
+                'options',
+            ]);
+            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
+            throw transformedError;
+        }
+    });
+}
+/**
+ * Deletes a phase and its cards.
+ * @param _id - ID of the phase to delete.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export function deletePhase(_id) {
+    var _a, _b, _c;
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = { id: '$[0]' };
+        const responseTransformation = '$';
+        // @ts-ignore
+        const { httpClient, sideEffects } = arguments[1];
+        const { toAmbassadorRequest } = serializer({
+            rootSchema: _deletePhaseRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = serializer({
+            rootSchema: _deletePhaseResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([_id]);
+        const reqOpts = ambassadorWixWorkflowsV1Phase.deletePhase(payload);
+        __log(`"DeletePhase" sending request with: ${__inspect(reqOpts)}`);
+        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
+        try {
+            const result = yield httpClient.request(reqOpts);
+            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
+            return fromJSON(result.data);
+        }
+        catch (err) {
+            const transformedError = transformError(err, requestTransformation, [
+                '_id',
+            ]);
+            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
+            throw transformedError;
+        }
+    });
+}
+/**
+ * Moves a phase to a new position in its workflow.
+ *
+ * Phases are displayed according to their position from left to right,
+ * starting from `0` and incrementing by 1.
+ * If you create or move a phase to an existing position,
+ * the phase in that position and any subsequent phases
+ * are shifted to the right by 1.
+ * @param newPosition - New phase position, where the first phase is `0`.
+ *
+ * If a phase already occupies the specified position,
+ * that phase and any subsequent phases
+ * are shifted to the right by 1.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField identifiers
+ * @requiredField identifiers.id
+ * @requiredField identifiers.workflowId
+ * @requiredField newPosition
+ */
+export function movePhase(identifiers, newPosition) {
+    var _a, _b, _c;
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = {
+            workflowId: '$[0].workflowId',
+            id: '$[0]._id',
+            newPosition: '$[1]',
+        };
+        const responseTransformation = '$';
+        // @ts-ignore
+        const { httpClient, sideEffects } = arguments[2];
+        const { toAmbassadorRequest } = serializer({
+            rootSchema: _movePhaseRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = serializer({
+            rootSchema: _movePhaseResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([identifiers, newPosition]);
+        const reqOpts = ambassadorWixWorkflowsV1Phase.movePhase(payload);
+        __log(`"MovePhase" sending request with: ${__inspect(reqOpts)}`);
+        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
+        try {
+            const result = yield httpClient.request(reqOpts);
+            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
+            return fromJSON(result.data);
+        }
+        catch (err) {
+            const transformedError = transformError(err, requestTransformation, [
+                'identifiers',
+                'newPosition',
+            ]);
+            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
+            throw transformedError;
+        }
+    });
+}
+//# sourceMappingURL=workflows-v1-phase.universal.js.map

package/build/es/src/workflows-v1-phase.universal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflows-v1-phase.universal.js","sourceRoot":"","sources":["../../../src/workflows-v1-phase.universal.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAErE,OAAO,KAAK,6BAA6B,MAAM,2BAA2B,CAAC;AAE3E,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AA6F5B,+GAA+G;AAC/G,MAAM,CAAN,IAAY,cAEX;AAFD,WAAY,cAAc;IACxB,6CAA2B,CAAA;AAC7B,CAAC,EAFW,cAAc,KAAd,cAAc,QAEzB;AAqCD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AA2HD,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAC5B,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAEhC;;;;;;;;;;GAUG;AACH,MAAM,UAAgB,WAAW,CAC/B,OAA4B;;;QAE5B,MAAM,qBAAqB,GAAG,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;QACtD,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,UAAU,CAAC;YACzC,UAAU,EAAE,mBAAmB;YAC/B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;YAC9B,UAAU,EAAE,oBAAoB;YAChC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;gBAC5B,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;QAE/C,MAAM,OAAO,GAAG,6BAA6B,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAEnE,KAAK,CAAC,uCAAuC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEnE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,cAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAOD;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAgB,UAAU,CAC9B,UAAkB,EAClB,OAA2B;;;QAE3B,MAAM,qBAAqB,GAAG;YAC5B,UAAU,EAAE,MAAM;YAClB,KAAK,EAAE,YAAY;YACnB,MAAM,EAAE,aAAa;YACrB,IAAI,EAAE,WAAW;SAClB,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,UAAU,CAAC;YACzC,UAAU,EAAE,kBAAkB;YAC9B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;YAC9B,UAAU,EAAE,mBAAmB;YAC/B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;gBAC5B,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;QAE3D,MAAM,OAAO,GAAG,6BAA6B,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAElE,KAAK,CAAC,sCAAsC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAElE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,cAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,YAAY;gBACZ,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAyBD;;;;;;GAMG;AACH,MAAM,UAAgB,QAAQ,CAAC,GAAW;;;QACxC,MAAM,qBAAqB,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC;QAC7C,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,UAAU,CAAC;YACzC,UAAU,EAAE,gBAAgB;YAC5B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;YAC9B,UAAU,EAAE,iBAAiB;YAC7B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBACrB,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAE3C,MAAM,OAAO,GAAG,6BAA6B,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEhE,KAAK,CAAC,oCAAoC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEhE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,cAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,KAAK;aACN,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAgB,WAAW,CAC/B,GAAW,EACX,OAA4B;;;QAE5B,MAAM,qBAAqB,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;QAClE,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,UAAU,CAAC;YACzC,UAAU,EAAE,mBAAmB;YAC/B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;YAC9B,UAAU,EAAE,oBAAoB;YAChC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;QAEpD,MAAM,OAAO,GAAG,6BAA6B,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAEnE,KAAK,CAAC,uCAAuC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEnE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,cAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,KAAK;gBACL,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAOD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAgB,WAAW,CAC/B,UAAkB,EAClB,OAA4B;;;QAE5B,MAAM,qBAAqB,GAAG;YAC5B,UAAU,EAAE,MAAM;YAClB,KAAK,EAAE,YAAY;YACnB,QAAQ,EAAE,eAAe;SAC1B,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,UAAU,CAAC;YACzC,UAAU,EAAE,mBAAmB;YAC/B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;YAC9B,UAAU,EAAE,oBAAoB;YAChC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;QAE3D,MAAM,OAAO,GAAG,6BAA6B,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAEnE,KAAK,CAAC,uCAAuC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEnE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,cAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,YAAY;gBACZ,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAkBD;;;;;;GAMG;AACH,MAAM,UAAgB,WAAW,CAAC,GAAW;;;QAC3C,MAAM,qBAAqB,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC;QAC7C,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,UAAU,CAAC;YACzC,UAAU,EAAE,mBAAmB;YAC/B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;YAC9B,UAAU,EAAE,oBAAoB;YAChC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAE3C,MAAM,OAAO,GAAG,6BAA6B,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAEnE,KAAK,CAAC,uCAAuC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEnE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,cAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,KAAK;aACN,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAgB,SAAS,CAC7B,WAAiC,EACjC,WAA0B;;;QAE1B,MAAM,qBAAqB,GAAG;YAC5B,UAAU,EAAE,iBAAiB;YAC7B,EAAE,EAAE,UAAU;YACd,WAAW,EAAE,MAAM;SACpB,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,UAAU,CAAC;YACzC,UAAU,EAAE,iBAAiB;YAC7B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;YAC9B,UAAU,EAAE,kBAAkB;YAC9B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;QAEhE,MAAM,OAAO,GAAG,6BAA6B,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAEjE,KAAK,CAAC,qCAAqC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEjE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,cAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,aAAa;gBACb,aAAa;aACd,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF"}

package/build/es/src/workflows-v1-workflow.http.d.ts

@@ -0,0 +1,74 @@
+import { RequestOptionsFactory } from '@wix/sdk-types';
+import { CreateWorkflowRequest, CreateWorkflowResponse, DeleteWorkflowRequest, DeleteWorkflowResponse, GetWorkflowRequest, GetWorkflowResponse, ListWorkflowsRequest, ListWorkflowsResponse, QueryWorkflowsRequest, QueryWorkflowsResponse, SetupWorkflowRequest, SetupWorkflowResponse, UpdateWorkflowRequest, UpdateWorkflowResponse } from './workflows-v1-workflow.types';
+/**
+ * Retrieves a list of the site's workflows.
+ *
+ * By default,
+ * the returned workflows are sorted by `name` in ascending order.
+ * Sorting is applied lexicographically,
+ * so `"abc"` comes after `"XYZ"`.
+ */
+export declare function listWorkflows(payload: ListWorkflowsRequest): RequestOptionsFactory<ListWorkflowsResponse>;
+/**
+ * Returns a list of workflows according to:
+ * * paging: offset, limit
+ * * order: by some of the following fields: id, name, createdAt
+ * * filter: by the following fields of WorkflowInfo
+ * ** workflowInfo.id                          - Guid
+ * ** workflowInfo.name                        - Text
+ * ** workflowInfo.createdAt                   - Date
+ * ** workflowInfo.visibility                  - Text (Visible / Archived)
+ * ** workflowInfo.winPhaseId                  - Guid
+ */
+export declare function queryWorkflows(payload: QueryWorkflowsRequest): RequestOptionsFactory<QueryWorkflowsResponse>;
+/**
+ * Retrieves a workflow by ID.
+ *
+ * Use this endpoint to list all phases and the first cards for each phase.
+ *
+ * The returned workflow object contains all the active phases and the win phase.
+ * The active phases are available in the `phasesList.phases` array,
+ * and the win phase is available at `winPhase`.
+ * Each phase's ID is in the phase object at `info.id`.
+ * The phase ID is needed when
+ * [moving](https://dev.wix.com/api/rest/workflows/workflows/cards/move-card)
+ * or [restoring](https://dev.wix.com/api/rest/workflows/workflows/cards/restore-card)
+ * a card.
+ *
+ * By default, the workflow is returned with up to 10 cards per phase.
+ * You can change the number of cards returned
+ * with the `cardsInitialPageSize` parameter.
+ */
+export declare function getWorkflow(payload: GetWorkflowRequest): RequestOptionsFactory<GetWorkflowResponse>;
+/**
+ * Updates a workflow's name or description.
+ *
+ * To rename or reorder phases or cards, use the
+ * [Phases API](https://dev.wix.com/api/rest/workflows/workflows/phases)
+ * or the
+ * [Cards API](https://dev.wix.com/api/rest/workflows/workflows/cards),
+ * respectively.
+ */
+export declare function updateWorkflow(payload: UpdateWorkflowRequest): RequestOptionsFactory<UpdateWorkflowResponse>;
+/**
+ * Creates a new workflow.
+ *
+ * When creating a workflow, you provide a `name` and optional `description`,
+ * and the new workflow's `id` is returned.
+ * By default, the new workflow contains a `winPhase` named "Win".
+ * No other phases or cards are created.
+ *
+ * To continue building the workflow,
+ * use the returned workflow `id` to
+ * [create phases](https://dev.wix.com/api/rest/workflows/workflows/phases/create-phase)
+ * and [add cards](https://dev.wix.com/api/rest/drafts/workflows/cards/create-card)
+ * to the new phases.
+ *
+ * A site can have up to 30 workflows.
+ * When this limit is reached, calls to this endpoint result in a 403 error.
+ */
+export declare function createWorkflow(payload: CreateWorkflowRequest): RequestOptionsFactory<CreateWorkflowResponse>;
+/** Deletes a workflow and its phases and cards. */
+export declare function deleteWorkflow(payload: DeleteWorkflowRequest): RequestOptionsFactory<DeleteWorkflowResponse>;
+/** Sets up the default workflow. */
+export declare function setupWorkflow(payload: SetupWorkflowRequest): RequestOptionsFactory<SetupWorkflowResponse>;