@wix/workflows 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +3 -0
- package/build/cjs/index.js +26 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/src/workflows-v1-card.http.d.ts +92 -0
- package/build/cjs/src/workflows-v1-card.http.js +339 -0
- package/build/cjs/src/workflows-v1-card.http.js.map +1 -0
- package/build/cjs/src/workflows-v1-card.public.d.ts +15 -0
- package/build/cjs/src/workflows-v1-card.public.js +57 -0
- package/build/cjs/src/workflows-v1-card.public.js.map +1 -0
- package/build/cjs/src/workflows-v1-card.types.d.ts +240 -0
- package/build/cjs/src/workflows-v1-card.types.js +14 -0
- package/build/cjs/src/workflows-v1-card.types.js.map +1 -0
- package/build/cjs/src/workflows-v1-card.universal.d.ts +449 -0
- package/build/cjs/src/workflows-v1-card.universal.js +569 -0
- package/build/cjs/src/workflows-v1-card.universal.js.map +1 -0
- package/build/cjs/src/workflows-v1-phase.http.d.ts +61 -0
- package/build/cjs/src/workflows-v1-phase.http.js +288 -0
- package/build/cjs/src/workflows-v1-phase.http.js.map +1 -0
- package/build/cjs/src/workflows-v1-phase.public.d.ts +14 -0
- package/build/cjs/src/workflows-v1-phase.public.js +51 -0
- package/build/cjs/src/workflows-v1-phase.public.js.map +1 -0
- package/build/cjs/src/workflows-v1-phase.types.d.ts +234 -0
- package/build/cjs/src/workflows-v1-phase.types.js +14 -0
- package/build/cjs/src/workflows-v1-phase.types.js.map +1 -0
- package/build/cjs/src/workflows-v1-phase.universal.d.ts +388 -0
- package/build/cjs/src/workflows-v1-phase.universal.js +488 -0
- package/build/cjs/src/workflows-v1-phase.universal.js.map +1 -0
- package/build/cjs/src/workflows-v1-workflow.http.d.ts +74 -0
- package/build/cjs/src/workflows-v1-workflow.http.js +315 -0
- package/build/cjs/src/workflows-v1-workflow.http.js.map +1 -0
- package/build/cjs/src/workflows-v1-workflow.public.d.ts +14 -0
- package/build/cjs/src/workflows-v1-workflow.public.js +51 -0
- package/build/cjs/src/workflows-v1-workflow.public.js.map +1 -0
- package/build/cjs/src/workflows-v1-workflow.types.d.ts +273 -0
- package/build/cjs/src/workflows-v1-workflow.types.js +14 -0
- package/build/cjs/src/workflows-v1-workflow.types.js.map +1 -0
- package/build/cjs/src/workflows-v1-workflow.universal.d.ts +424 -0
- package/build/cjs/src/workflows-v1-workflow.universal.js +478 -0
- package/build/cjs/src/workflows-v1-workflow.universal.js.map +1 -0
- package/build/es/index.d.ts +3 -0
- package/build/es/index.js +4 -0
- package/build/es/index.js.map +1 -0
- package/build/es/src/workflows-v1-card.http.d.ts +92 -0
- package/build/es/src/workflows-v1-card.http.js +328 -0
- package/build/es/src/workflows-v1-card.http.js.map +1 -0
- package/build/es/src/workflows-v1-card.public.d.ts +15 -0
- package/build/es/src/workflows-v1-card.public.js +44 -0
- package/build/es/src/workflows-v1-card.public.js.map +1 -0
- package/build/es/src/workflows-v1-card.types.d.ts +240 -0
- package/build/es/src/workflows-v1-card.types.js +11 -0
- package/build/es/src/workflows-v1-card.types.js.map +1 -0
- package/build/es/src/workflows-v1-card.universal.d.ts +449 -0
- package/build/es/src/workflows-v1-card.universal.js +539 -0
- package/build/es/src/workflows-v1-card.universal.js.map +1 -0
- package/build/es/src/workflows-v1-phase.http.d.ts +61 -0
- package/build/es/src/workflows-v1-phase.http.js +278 -0
- package/build/es/src/workflows-v1-phase.http.js.map +1 -0
- package/build/es/src/workflows-v1-phase.public.d.ts +14 -0
- package/build/es/src/workflows-v1-phase.public.js +39 -0
- package/build/es/src/workflows-v1-phase.public.js.map +1 -0
- package/build/es/src/workflows-v1-phase.types.d.ts +234 -0
- package/build/es/src/workflows-v1-phase.types.js +11 -0
- package/build/es/src/workflows-v1-phase.types.js.map +1 -0
- package/build/es/src/workflows-v1-phase.universal.d.ts +388 -0
- package/build/es/src/workflows-v1-phase.universal.js +459 -0
- package/build/es/src/workflows-v1-phase.universal.js.map +1 -0
- package/build/es/src/workflows-v1-workflow.http.d.ts +74 -0
- package/build/es/src/workflows-v1-workflow.http.js +305 -0
- package/build/es/src/workflows-v1-workflow.http.js.map +1 -0
- package/build/es/src/workflows-v1-workflow.public.d.ts +14 -0
- package/build/es/src/workflows-v1-workflow.public.js +39 -0
- package/build/es/src/workflows-v1-workflow.public.js.map +1 -0
- package/build/es/src/workflows-v1-workflow.types.d.ts +273 -0
- package/build/es/src/workflows-v1-workflow.types.js +11 -0
- package/build/es/src/workflows-v1-workflow.types.js.map +1 -0
- package/build/es/src/workflows-v1-workflow.universal.d.ts +424 -0
- package/build/es/src/workflows-v1-workflow.universal.js +449 -0
- package/build/es/src/workflows-v1-workflow.universal.js.map +1 -0
- package/package.json +37 -0
|
@@ -0,0 +1,478 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
|
|
5
|
+
}) : (function(o, m, k, k2) {
|
|
6
|
+
if (k2 === undefined) k2 = k;
|
|
7
|
+
o[k2] = m[k];
|
|
8
|
+
}));
|
|
9
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
10
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
11
|
+
}) : function(o, v) {
|
|
12
|
+
o["default"] = v;
|
|
13
|
+
});
|
|
14
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
15
|
+
if (mod && mod.__esModule) return mod;
|
|
16
|
+
var result = {};
|
|
17
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
18
|
+
__setModuleDefault(result, mod);
|
|
19
|
+
return result;
|
|
20
|
+
};
|
|
21
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
22
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
23
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
24
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
25
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
26
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
27
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
28
|
+
});
|
|
29
|
+
};
|
|
30
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
31
|
+
exports.setupWorkflow = exports.deleteWorkflow = exports.createWorkflow = exports.updateWorkflow = exports.getWorkflow = exports.queryWorkflows = exports.listWorkflows = exports.SortOrder = exports.AttachmentType = exports.__debug = void 0;
|
|
32
|
+
const velo_1 = require("@wix/metro-runtime/velo");
|
|
33
|
+
const ambassadorWixWorkflowsV1Workflow = __importStar(require("./workflows-v1-workflow.http"));
|
|
34
|
+
let __verbose = false;
|
|
35
|
+
function __log(...args) {
|
|
36
|
+
__verbose && console.log(...args);
|
|
37
|
+
}
|
|
38
|
+
function __inspect(obj) {
|
|
39
|
+
return obj;
|
|
40
|
+
}
|
|
41
|
+
exports.__debug = {
|
|
42
|
+
verboseLogging: {
|
|
43
|
+
on: () => (__verbose = true),
|
|
44
|
+
off: () => (__verbose = false),
|
|
45
|
+
},
|
|
46
|
+
};
|
|
47
|
+
const _toVeloEntity = '$';
|
|
48
|
+
const _fromVeloEntity = '$';
|
|
49
|
+
/** describes the supported types of attachments (currently only supports Contact which is the default type) */
|
|
50
|
+
var AttachmentType;
|
|
51
|
+
(function (AttachmentType) {
|
|
52
|
+
AttachmentType["ContactType"] = "ContactType";
|
|
53
|
+
})(AttachmentType = exports.AttachmentType || (exports.AttachmentType = {}));
|
|
54
|
+
var SortOrder;
|
|
55
|
+
(function (SortOrder) {
|
|
56
|
+
SortOrder["ASC"] = "ASC";
|
|
57
|
+
SortOrder["DESC"] = "DESC";
|
|
58
|
+
})(SortOrder = exports.SortOrder || (exports.SortOrder = {}));
|
|
59
|
+
const _createWorkflowRequest = {};
|
|
60
|
+
const _createWorkflowResponse = {};
|
|
61
|
+
const _deleteWorkflowRequest = {};
|
|
62
|
+
const _deleteWorkflowResponse = {};
|
|
63
|
+
const _getWorkflowRequest = {};
|
|
64
|
+
const _getWorkflowResponse = {};
|
|
65
|
+
const _listWorkflowsRequest = {};
|
|
66
|
+
const _listWorkflowsResponse = {};
|
|
67
|
+
const _queryWorkflowsRequest = {};
|
|
68
|
+
const _queryWorkflowsResponse = {};
|
|
69
|
+
const _setupWorkflowRequest = {};
|
|
70
|
+
const _setupWorkflowResponse = {};
|
|
71
|
+
const _updateWorkflowRequest = {};
|
|
72
|
+
const _updateWorkflowResponse = {};
|
|
73
|
+
/**
|
|
74
|
+
* Retrieves a list of the site's workflows.
|
|
75
|
+
*
|
|
76
|
+
* By default,
|
|
77
|
+
* the returned workflows are sorted by `name` in ascending order.
|
|
78
|
+
* Sorting is applied lexicographically,
|
|
79
|
+
* so `"abc"` comes after `"XYZ"`.
|
|
80
|
+
* @public
|
|
81
|
+
* @documentationMaturity preview
|
|
82
|
+
*/
|
|
83
|
+
function listWorkflows(options) {
|
|
84
|
+
var _a, _b, _c;
|
|
85
|
+
return __awaiter(this, arguments, void 0, function* () {
|
|
86
|
+
const requestTransformation = {
|
|
87
|
+
limit: '$[0].limit',
|
|
88
|
+
offset: '$[0].offset',
|
|
89
|
+
sort: '$[0].sort',
|
|
90
|
+
};
|
|
91
|
+
const responseTransformation = '$';
|
|
92
|
+
// @ts-ignore
|
|
93
|
+
const { httpClient, sideEffects } = arguments[1];
|
|
94
|
+
const { toAmbassadorRequest } = (0, velo_1.serializer)({
|
|
95
|
+
rootSchema: _listWorkflowsRequest,
|
|
96
|
+
depSchemas: {},
|
|
97
|
+
fqdnTransformation: {
|
|
98
|
+
paths: [],
|
|
99
|
+
transformation: _fromVeloEntity,
|
|
100
|
+
},
|
|
101
|
+
customTransformation: requestTransformation,
|
|
102
|
+
});
|
|
103
|
+
const { fromJSON } = (0, velo_1.serializer)({
|
|
104
|
+
rootSchema: _listWorkflowsResponse,
|
|
105
|
+
depSchemas: {},
|
|
106
|
+
fqdnTransformation: {
|
|
107
|
+
paths: [],
|
|
108
|
+
transformation: _toVeloEntity,
|
|
109
|
+
},
|
|
110
|
+
customTransformation: responseTransformation,
|
|
111
|
+
});
|
|
112
|
+
const payload = toAmbassadorRequest([options]);
|
|
113
|
+
const reqOpts = ambassadorWixWorkflowsV1Workflow.listWorkflows(payload);
|
|
114
|
+
__log(`"ListWorkflows" sending request with: ${__inspect(reqOpts)}`);
|
|
115
|
+
(_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
|
|
116
|
+
try {
|
|
117
|
+
const result = yield httpClient.request(reqOpts);
|
|
118
|
+
(_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
|
|
119
|
+
return fromJSON(result.data);
|
|
120
|
+
}
|
|
121
|
+
catch (err) {
|
|
122
|
+
const transformedError = (0, velo_1.transformError)(err, requestTransformation, [
|
|
123
|
+
'options',
|
|
124
|
+
]);
|
|
125
|
+
(_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
|
|
126
|
+
throw transformedError;
|
|
127
|
+
}
|
|
128
|
+
});
|
|
129
|
+
}
|
|
130
|
+
exports.listWorkflows = listWorkflows;
|
|
131
|
+
/**
|
|
132
|
+
* Returns a list of workflows according to:
|
|
133
|
+
* * paging: offset, limit
|
|
134
|
+
* * order: by some of the following fields: id, name, createdAt
|
|
135
|
+
* * filter: by the following fields of WorkflowInfo
|
|
136
|
+
* ** workflowInfo.id - Guid
|
|
137
|
+
* ** workflowInfo.name - Text
|
|
138
|
+
* ** workflowInfo.createdAt - Date
|
|
139
|
+
* ** workflowInfo.visibility - Text (Visible / Archived)
|
|
140
|
+
* ** workflowInfo.winPhaseId - Guid
|
|
141
|
+
* @public
|
|
142
|
+
* @documentationMaturity preview
|
|
143
|
+
*/
|
|
144
|
+
function queryWorkflows(options) {
|
|
145
|
+
var _a, _b, _c;
|
|
146
|
+
return __awaiter(this, arguments, void 0, function* () {
|
|
147
|
+
const requestTransformation = { query: '$[0].query' };
|
|
148
|
+
const responseTransformation = '$';
|
|
149
|
+
// @ts-ignore
|
|
150
|
+
const { httpClient, sideEffects } = arguments[1];
|
|
151
|
+
const { toAmbassadorRequest } = (0, velo_1.serializer)({
|
|
152
|
+
rootSchema: _queryWorkflowsRequest,
|
|
153
|
+
depSchemas: {},
|
|
154
|
+
fqdnTransformation: {
|
|
155
|
+
paths: [],
|
|
156
|
+
transformation: _fromVeloEntity,
|
|
157
|
+
},
|
|
158
|
+
customTransformation: requestTransformation,
|
|
159
|
+
});
|
|
160
|
+
const { fromJSON } = (0, velo_1.serializer)({
|
|
161
|
+
rootSchema: _queryWorkflowsResponse,
|
|
162
|
+
depSchemas: {},
|
|
163
|
+
fqdnTransformation: {
|
|
164
|
+
paths: [...['Array#workflows']],
|
|
165
|
+
transformation: _toVeloEntity,
|
|
166
|
+
},
|
|
167
|
+
customTransformation: responseTransformation,
|
|
168
|
+
});
|
|
169
|
+
const payload = toAmbassadorRequest([options]);
|
|
170
|
+
const reqOpts = ambassadorWixWorkflowsV1Workflow.queryWorkflows(payload);
|
|
171
|
+
__log(`"QueryWorkflows" sending request with: ${__inspect(reqOpts)}`);
|
|
172
|
+
(_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
|
|
173
|
+
try {
|
|
174
|
+
const result = yield httpClient.request(reqOpts);
|
|
175
|
+
(_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
|
|
176
|
+
return fromJSON(result.data);
|
|
177
|
+
}
|
|
178
|
+
catch (err) {
|
|
179
|
+
const transformedError = (0, velo_1.transformError)(err, requestTransformation, [
|
|
180
|
+
'options',
|
|
181
|
+
]);
|
|
182
|
+
(_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
|
|
183
|
+
throw transformedError;
|
|
184
|
+
}
|
|
185
|
+
});
|
|
186
|
+
}
|
|
187
|
+
exports.queryWorkflows = queryWorkflows;
|
|
188
|
+
/**
|
|
189
|
+
* Retrieves a workflow by ID.
|
|
190
|
+
*
|
|
191
|
+
* Use this endpoint to list all phases and the first cards for each phase.
|
|
192
|
+
*
|
|
193
|
+
* The returned workflow object contains all the active phases and the win phase.
|
|
194
|
+
* The active phases are available in the `phasesList.phases` array,
|
|
195
|
+
* and the win phase is available at `winPhase`.
|
|
196
|
+
* Each phase's ID is in the phase object at `info.id`.
|
|
197
|
+
* The phase ID is needed when
|
|
198
|
+
* [moving](https://dev.wix.com/api/rest/workflows/workflows/cards/move-card)
|
|
199
|
+
* or [restoring](https://dev.wix.com/api/rest/workflows/workflows/cards/restore-card)
|
|
200
|
+
* a card.
|
|
201
|
+
*
|
|
202
|
+
* By default, the workflow is returned with up to 10 cards per phase.
|
|
203
|
+
* You can change the number of cards returned
|
|
204
|
+
* with the `cardsInitialPageSize` parameter.
|
|
205
|
+
* @param _id - ID of the workflow to retrieve.
|
|
206
|
+
* @public
|
|
207
|
+
* @documentationMaturity preview
|
|
208
|
+
* @requiredField _id
|
|
209
|
+
*/
|
|
210
|
+
function getWorkflow(_id, options) {
|
|
211
|
+
var _a, _b, _c;
|
|
212
|
+
return __awaiter(this, arguments, void 0, function* () {
|
|
213
|
+
const requestTransformation = {
|
|
214
|
+
id: '$[0]',
|
|
215
|
+
cardsPerPhase: '$[1].cardsPerPhase',
|
|
216
|
+
};
|
|
217
|
+
const responseTransformation = '$';
|
|
218
|
+
// @ts-ignore
|
|
219
|
+
const { httpClient, sideEffects } = arguments[2];
|
|
220
|
+
const { toAmbassadorRequest } = (0, velo_1.serializer)({
|
|
221
|
+
rootSchema: _getWorkflowRequest,
|
|
222
|
+
depSchemas: {},
|
|
223
|
+
fqdnTransformation: {
|
|
224
|
+
paths: [],
|
|
225
|
+
transformation: _fromVeloEntity,
|
|
226
|
+
},
|
|
227
|
+
customTransformation: requestTransformation,
|
|
228
|
+
});
|
|
229
|
+
const { fromJSON } = (0, velo_1.serializer)({
|
|
230
|
+
rootSchema: _getWorkflowResponse,
|
|
231
|
+
depSchemas: {},
|
|
232
|
+
fqdnTransformation: {
|
|
233
|
+
paths: [...['workflow']],
|
|
234
|
+
transformation: _toVeloEntity,
|
|
235
|
+
},
|
|
236
|
+
customTransformation: responseTransformation,
|
|
237
|
+
});
|
|
238
|
+
const payload = toAmbassadorRequest([_id, options]);
|
|
239
|
+
const reqOpts = ambassadorWixWorkflowsV1Workflow.getWorkflow(payload);
|
|
240
|
+
__log(`"GetWorkflow" sending request with: ${__inspect(reqOpts)}`);
|
|
241
|
+
(_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
|
|
242
|
+
try {
|
|
243
|
+
const result = yield httpClient.request(reqOpts);
|
|
244
|
+
(_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
|
|
245
|
+
return fromJSON(result.data);
|
|
246
|
+
}
|
|
247
|
+
catch (err) {
|
|
248
|
+
const transformedError = (0, velo_1.transformError)(err, requestTransformation, [
|
|
249
|
+
'_id',
|
|
250
|
+
'options',
|
|
251
|
+
]);
|
|
252
|
+
(_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
|
|
253
|
+
throw transformedError;
|
|
254
|
+
}
|
|
255
|
+
});
|
|
256
|
+
}
|
|
257
|
+
exports.getWorkflow = getWorkflow;
|
|
258
|
+
/**
|
|
259
|
+
* Updates a workflow's name or description.
|
|
260
|
+
*
|
|
261
|
+
* To rename or reorder phases or cards, use the
|
|
262
|
+
* [Phases API](https://dev.wix.com/api/rest/workflows/workflows/phases)
|
|
263
|
+
* or the
|
|
264
|
+
* [Cards API](https://dev.wix.com/api/rest/workflows/workflows/cards),
|
|
265
|
+
* respectively.
|
|
266
|
+
* @param _id - ID of the workflow to update.
|
|
267
|
+
* @public
|
|
268
|
+
* @documentationMaturity preview
|
|
269
|
+
* @requiredField _id
|
|
270
|
+
*/
|
|
271
|
+
function updateWorkflow(_id, options) {
|
|
272
|
+
var _a, _b, _c;
|
|
273
|
+
return __awaiter(this, arguments, void 0, function* () {
|
|
274
|
+
const requestTransformation = { id: '$[0]', workflow: '$[1].workflow' };
|
|
275
|
+
const responseTransformation = '$';
|
|
276
|
+
// @ts-ignore
|
|
277
|
+
const { httpClient, sideEffects } = arguments[2];
|
|
278
|
+
const { toAmbassadorRequest } = (0, velo_1.serializer)({
|
|
279
|
+
rootSchema: _updateWorkflowRequest,
|
|
280
|
+
depSchemas: {},
|
|
281
|
+
fqdnTransformation: {
|
|
282
|
+
paths: [],
|
|
283
|
+
transformation: _fromVeloEntity,
|
|
284
|
+
},
|
|
285
|
+
customTransformation: requestTransformation,
|
|
286
|
+
});
|
|
287
|
+
const { fromJSON } = (0, velo_1.serializer)({
|
|
288
|
+
rootSchema: _updateWorkflowResponse,
|
|
289
|
+
depSchemas: {},
|
|
290
|
+
fqdnTransformation: {
|
|
291
|
+
paths: [],
|
|
292
|
+
transformation: _toVeloEntity,
|
|
293
|
+
},
|
|
294
|
+
customTransformation: responseTransformation,
|
|
295
|
+
});
|
|
296
|
+
const payload = toAmbassadorRequest([_id, options]);
|
|
297
|
+
const reqOpts = ambassadorWixWorkflowsV1Workflow.updateWorkflow(payload);
|
|
298
|
+
__log(`"UpdateWorkflow" sending request with: ${__inspect(reqOpts)}`);
|
|
299
|
+
(_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
|
|
300
|
+
try {
|
|
301
|
+
const result = yield httpClient.request(reqOpts);
|
|
302
|
+
(_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
|
|
303
|
+
return fromJSON(result.data);
|
|
304
|
+
}
|
|
305
|
+
catch (err) {
|
|
306
|
+
const transformedError = (0, velo_1.transformError)(err, requestTransformation, [
|
|
307
|
+
'_id',
|
|
308
|
+
'options',
|
|
309
|
+
]);
|
|
310
|
+
(_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
|
|
311
|
+
throw transformedError;
|
|
312
|
+
}
|
|
313
|
+
});
|
|
314
|
+
}
|
|
315
|
+
exports.updateWorkflow = updateWorkflow;
|
|
316
|
+
/**
|
|
317
|
+
* Creates a new workflow.
|
|
318
|
+
*
|
|
319
|
+
* When creating a workflow, you provide a `name` and optional `description`,
|
|
320
|
+
* and the new workflow's `id` is returned.
|
|
321
|
+
* By default, the new workflow contains a `winPhase` named "Win".
|
|
322
|
+
* No other phases or cards are created.
|
|
323
|
+
*
|
|
324
|
+
* To continue building the workflow,
|
|
325
|
+
* use the returned workflow `id` to
|
|
326
|
+
* [create phases](https://dev.wix.com/api/rest/workflows/workflows/phases/create-phase)
|
|
327
|
+
* and [add cards](https://dev.wix.com/api/rest/drafts/workflows/cards/create-card)
|
|
328
|
+
* to the new phases.
|
|
329
|
+
*
|
|
330
|
+
* A site can have up to 30 workflows.
|
|
331
|
+
* When this limit is reached, calls to this endpoint result in a 403 error.
|
|
332
|
+
* @public
|
|
333
|
+
* @documentationMaturity preview
|
|
334
|
+
* @requiredField options.workflow.name
|
|
335
|
+
*/
|
|
336
|
+
function createWorkflow(options) {
|
|
337
|
+
var _a, _b, _c;
|
|
338
|
+
return __awaiter(this, arguments, void 0, function* () {
|
|
339
|
+
const requestTransformation = { workflow: '$[0].workflow' };
|
|
340
|
+
const responseTransformation = '$';
|
|
341
|
+
// @ts-ignore
|
|
342
|
+
const { httpClient, sideEffects } = arguments[1];
|
|
343
|
+
const { toAmbassadorRequest } = (0, velo_1.serializer)({
|
|
344
|
+
rootSchema: _createWorkflowRequest,
|
|
345
|
+
depSchemas: {},
|
|
346
|
+
fqdnTransformation: {
|
|
347
|
+
paths: [],
|
|
348
|
+
transformation: _fromVeloEntity,
|
|
349
|
+
},
|
|
350
|
+
customTransformation: requestTransformation,
|
|
351
|
+
});
|
|
352
|
+
const { fromJSON } = (0, velo_1.serializer)({
|
|
353
|
+
rootSchema: _createWorkflowResponse,
|
|
354
|
+
depSchemas: {},
|
|
355
|
+
fqdnTransformation: {
|
|
356
|
+
paths: [],
|
|
357
|
+
transformation: _toVeloEntity,
|
|
358
|
+
},
|
|
359
|
+
customTransformation: responseTransformation,
|
|
360
|
+
});
|
|
361
|
+
const payload = toAmbassadorRequest([options]);
|
|
362
|
+
const reqOpts = ambassadorWixWorkflowsV1Workflow.createWorkflow(payload);
|
|
363
|
+
__log(`"CreateWorkflow" sending request with: ${__inspect(reqOpts)}`);
|
|
364
|
+
(_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
|
|
365
|
+
try {
|
|
366
|
+
const result = yield httpClient.request(reqOpts);
|
|
367
|
+
(_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
|
|
368
|
+
return fromJSON(result.data);
|
|
369
|
+
}
|
|
370
|
+
catch (err) {
|
|
371
|
+
const transformedError = (0, velo_1.transformError)(err, requestTransformation, [
|
|
372
|
+
'options',
|
|
373
|
+
]);
|
|
374
|
+
(_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
|
|
375
|
+
throw transformedError;
|
|
376
|
+
}
|
|
377
|
+
});
|
|
378
|
+
}
|
|
379
|
+
exports.createWorkflow = createWorkflow;
|
|
380
|
+
/**
|
|
381
|
+
* Deletes a workflow and its phases and cards.
|
|
382
|
+
* @param _id - ID of the workflow to delete.
|
|
383
|
+
* @public
|
|
384
|
+
* @documentationMaturity preview
|
|
385
|
+
* @requiredField _id
|
|
386
|
+
*/
|
|
387
|
+
function deleteWorkflow(_id) {
|
|
388
|
+
var _a, _b, _c;
|
|
389
|
+
return __awaiter(this, arguments, void 0, function* () {
|
|
390
|
+
const requestTransformation = { id: '$[0]' };
|
|
391
|
+
const responseTransformation = '$';
|
|
392
|
+
// @ts-ignore
|
|
393
|
+
const { httpClient, sideEffects } = arguments[1];
|
|
394
|
+
const { toAmbassadorRequest } = (0, velo_1.serializer)({
|
|
395
|
+
rootSchema: _deleteWorkflowRequest,
|
|
396
|
+
depSchemas: {},
|
|
397
|
+
fqdnTransformation: {
|
|
398
|
+
paths: [],
|
|
399
|
+
transformation: _fromVeloEntity,
|
|
400
|
+
},
|
|
401
|
+
customTransformation: requestTransformation,
|
|
402
|
+
});
|
|
403
|
+
const { fromJSON } = (0, velo_1.serializer)({
|
|
404
|
+
rootSchema: _deleteWorkflowResponse,
|
|
405
|
+
depSchemas: {},
|
|
406
|
+
fqdnTransformation: {
|
|
407
|
+
paths: [],
|
|
408
|
+
transformation: _toVeloEntity,
|
|
409
|
+
},
|
|
410
|
+
customTransformation: responseTransformation,
|
|
411
|
+
});
|
|
412
|
+
const payload = toAmbassadorRequest([_id]);
|
|
413
|
+
const reqOpts = ambassadorWixWorkflowsV1Workflow.deleteWorkflow(payload);
|
|
414
|
+
__log(`"DeleteWorkflow" sending request with: ${__inspect(reqOpts)}`);
|
|
415
|
+
(_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
|
|
416
|
+
try {
|
|
417
|
+
const result = yield httpClient.request(reqOpts);
|
|
418
|
+
(_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
|
|
419
|
+
return fromJSON(result.data);
|
|
420
|
+
}
|
|
421
|
+
catch (err) {
|
|
422
|
+
const transformedError = (0, velo_1.transformError)(err, requestTransformation, [
|
|
423
|
+
'_id',
|
|
424
|
+
]);
|
|
425
|
+
(_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
|
|
426
|
+
throw transformedError;
|
|
427
|
+
}
|
|
428
|
+
});
|
|
429
|
+
}
|
|
430
|
+
exports.deleteWorkflow = deleteWorkflow;
|
|
431
|
+
/**
|
|
432
|
+
* Sets up the default workflow.
|
|
433
|
+
* @public
|
|
434
|
+
* @documentationMaturity preview
|
|
435
|
+
*/
|
|
436
|
+
function setupWorkflow() {
|
|
437
|
+
var _a, _b, _c;
|
|
438
|
+
return __awaiter(this, arguments, void 0, function* () {
|
|
439
|
+
const requestTransformation = {};
|
|
440
|
+
const responseTransformation = '$';
|
|
441
|
+
// @ts-ignore
|
|
442
|
+
const { httpClient, sideEffects } = arguments[0];
|
|
443
|
+
const { toAmbassadorRequest } = (0, velo_1.serializer)({
|
|
444
|
+
rootSchema: _setupWorkflowRequest,
|
|
445
|
+
depSchemas: {},
|
|
446
|
+
fqdnTransformation: {
|
|
447
|
+
paths: [],
|
|
448
|
+
transformation: _fromVeloEntity,
|
|
449
|
+
},
|
|
450
|
+
customTransformation: requestTransformation,
|
|
451
|
+
});
|
|
452
|
+
const { fromJSON } = (0, velo_1.serializer)({
|
|
453
|
+
rootSchema: _setupWorkflowResponse,
|
|
454
|
+
depSchemas: {},
|
|
455
|
+
fqdnTransformation: {
|
|
456
|
+
paths: [],
|
|
457
|
+
transformation: _toVeloEntity,
|
|
458
|
+
},
|
|
459
|
+
customTransformation: responseTransformation,
|
|
460
|
+
});
|
|
461
|
+
const payload = toAmbassadorRequest([]);
|
|
462
|
+
const reqOpts = ambassadorWixWorkflowsV1Workflow.setupWorkflow(payload);
|
|
463
|
+
__log(`"SetupWorkflow" sending request with: ${__inspect(reqOpts)}`);
|
|
464
|
+
(_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
|
|
465
|
+
try {
|
|
466
|
+
const result = yield httpClient.request(reqOpts);
|
|
467
|
+
(_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
|
|
468
|
+
return fromJSON(result.data);
|
|
469
|
+
}
|
|
470
|
+
catch (err) {
|
|
471
|
+
const transformedError = (0, velo_1.transformError)(err, requestTransformation, []);
|
|
472
|
+
(_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
|
|
473
|
+
throw transformedError;
|
|
474
|
+
}
|
|
475
|
+
});
|
|
476
|
+
}
|
|
477
|
+
exports.setupWorkflow = setupWorkflow;
|
|
478
|
+
//# sourceMappingURL=workflows-v1-workflow.universal.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"workflows-v1-workflow.universal.js","sourceRoot":"","sources":["../../../src/workflows-v1-workflow.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAqE;AAErE,+FAAiF;AAEjF,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;AAEY,QAAA,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;AA2I5B,+GAA+G;AAC/G,IAAY,cAEX;AAFD,WAAY,cAAc;IACxB,6CAA2B,CAAA;AAC7B,CAAC,EAFW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAEzB;AA0FD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AAiED,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,uBAAuB,GAAG,EAAE,CAAC;AACnC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,uBAAuB,GAAG,EAAE,CAAC;AACnC,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,uBAAuB,GAAG,EAAE,CAAC;AACnC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,uBAAuB,GAAG,EAAE,CAAC;AAEnC;;;;;;;;;GASG;AACH,SAAsB,aAAa,CACjC,OAA8B;;;QAE9B,MAAM,qBAAqB,GAAG;YAC5B,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,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,qBAAqB;YACjC,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,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,sBAAsB;YAClC,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,OAAO,CAAC,CAAC,CAAC;QAE/C,MAAM,OAAO,GAAG,gCAAgC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAExE,KAAK,CAAC,yCAAyC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAErE,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,IAAA,qBAAc,EAAC,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;AAxDD,sCAwDC;AA4BD;;;;;;;;;;;;GAYG;AACH,SAAsB,cAAc,CAClC,OAA+B;;;QAE/B,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,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,sBAAsB;YAClC,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,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,uBAAuB;YACnC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;gBAC/B,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,gCAAgC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAEzE,KAAK,CAAC,0CAA0C,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEtE,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,IAAA,qBAAc,EAAC,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;AApDD,wCAoDC;AAOD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAsB,WAAW,CAC/B,GAAW,EACX,OAA4B;;;QAE5B,MAAM,qBAAqB,GAAG;YAC5B,EAAE,EAAE,MAAM;YACV,aAAa,EAAE,oBAAoB;SACpC,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,IAAA,iBAAU,EAAC;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,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,oBAAoB;YAChC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;gBACxB,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,gCAAgC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAEtE,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,IAAA,qBAAc,EAAC,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;AAzDD,kCAyDC;AAcD;;;;;;;;;;;;GAYG;AACH,SAAsB,cAAc,CAClC,GAAW,EACX,OAA+B;;;QAE/B,MAAM,qBAAqB,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,CAAC;QACxE,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,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,sBAAsB;YAClC,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,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,uBAAuB;YACnC,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,gCAAgC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAEzE,KAAK,CAAC,0CAA0C,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEtE,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,IAAA,qBAAc,EAAC,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;AAtDD,wCAsDC;AAOD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAsB,cAAc,CAClC,OAA+B;;;QAE/B,MAAM,qBAAqB,GAAG,EAAE,QAAQ,EAAE,eAAe,EAAE,CAAC;QAC5D,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,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,sBAAsB;YAClC,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,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,uBAAuB;YACnC,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,OAAO,CAAC,CAAC,CAAC;QAE/C,MAAM,OAAO,GAAG,gCAAgC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAEzE,KAAK,CAAC,0CAA0C,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEtE,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,IAAA,qBAAc,EAAC,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;AApDD,wCAoDC;AAOD;;;;;;GAMG;AACH,SAAsB,cAAc,CAAC,GAAW;;;QAC9C,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,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,sBAAsB;YAClC,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,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,uBAAuB;YACnC,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,gCAAgC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAEzE,KAAK,CAAC,0CAA0C,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEtE,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,IAAA,qBAAc,EAAC,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;AAlDD,wCAkDC;AAED;;;;GAIG;AACH,SAAsB,aAAa;;;QACjC,MAAM,qBAAqB,GAAG,EAAE,CAAC;QACjC,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,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,qBAAqB;YACjC,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,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,sBAAsB;YAClC,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,EAAE,CAAC,CAAC;QAExC,MAAM,OAAO,GAAG,gCAAgC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAExE,KAAK,CAAC,yCAAyC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAErE,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,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE,EAAE,CAAC,CAAC;YACxE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAhDD,sCAgDC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,gCAAgC,CAAC;AACxD,OAAO,KAAK,MAAM,MAAM,iCAAiC,CAAC;AAC1D,OAAO,KAAK,SAAS,MAAM,oCAAoC,CAAC"}
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import { RequestOptionsFactory } from '@wix/sdk-types';
|
|
2
|
+
import { CreateCardRequest, CreateCardResponse, DeleteCardRequest, DeleteCardResponse, GetCardRequest, GetCardResponse, ListCardsRequest, ListCardsResponse, MoveCardRequest, MoveCardResponse, QueryCardsRequest, QueryCardsResponse, RestoreCardRequest, RestoreCardResponse, UpdateCardRequest, UpdateCardResponse } from './workflows-v1-card.types';
|
|
3
|
+
/**
|
|
4
|
+
* Returns a list of cards according to:
|
|
5
|
+
* * paging: offset, limit
|
|
6
|
+
* * order: by some of the following fields: id, name, createdAt, updatedAt, position, phaseId
|
|
7
|
+
* * filter: by the following fields of CardInfo
|
|
8
|
+
* ** cardInfo.id - Guid
|
|
9
|
+
* ** cardInfo.name - Text
|
|
10
|
+
* ** cardInfo.source - Text
|
|
11
|
+
* ** cardInfo.position - Number
|
|
12
|
+
* ** cardInfo.createdAt - Date
|
|
13
|
+
* ** cardInfo.updatedAt - Date
|
|
14
|
+
* ** cardInfo.primaryAttachment.contactId - Guid
|
|
15
|
+
* ** cardInfo.visibility - Text (Visible / Archived)
|
|
16
|
+
*/
|
|
17
|
+
export declare function queryCards(payload: QueryCardsRequest): RequestOptionsFactory<QueryCardsResponse>;
|
|
18
|
+
/**
|
|
19
|
+
* Retrieves a list of cards in the specified workflow.
|
|
20
|
+
*
|
|
21
|
+
* By default, the returned cards are sorted by their display order.
|
|
22
|
+
*/
|
|
23
|
+
export declare function listCards(payload: ListCardsRequest): RequestOptionsFactory<ListCardsResponse>;
|
|
24
|
+
/**
|
|
25
|
+
* Retrieves a card.
|
|
26
|
+
*
|
|
27
|
+
* If the specified card is archived, an empty object is returned.
|
|
28
|
+
* You can restore the card with
|
|
29
|
+
* [Restore Card](https://dev.wix.com/api/rest/workflows/workflows/cards/restore-card).
|
|
30
|
+
*/
|
|
31
|
+
export declare function getCard(payload: GetCardRequest): RequestOptionsFactory<GetCardResponse>;
|
|
32
|
+
/**
|
|
33
|
+
* Updates a card's properties.
|
|
34
|
+
*
|
|
35
|
+
* To reorder cards, use
|
|
36
|
+
* [Move Card](https://dev.wix.com/api/rest/workflows/workflows/cards/move-card).
|
|
37
|
+
* To archive or restore a card, use
|
|
38
|
+
* [Archive Card](https://dev.wix.com/api/rest/workflows/workflows/cards/archive-card)
|
|
39
|
+
* or [Restore Card](https://dev.wix.com/api/rest/workflows/workflows/cards/restore-card),
|
|
40
|
+
* respectively.
|
|
41
|
+
*/
|
|
42
|
+
export declare function updateCard(payload: UpdateCardRequest): RequestOptionsFactory<UpdateCardResponse>;
|
|
43
|
+
/**
|
|
44
|
+
* Creates a new card in the specified phase and workflow.
|
|
45
|
+
*
|
|
46
|
+
* When creating a card, you provide a `name` and an optional `position`.
|
|
47
|
+
*
|
|
48
|
+
* Cards are displayed according to their position from top to bottom,
|
|
49
|
+
* starting from `0` and incrementing by 1.
|
|
50
|
+
* If you create or move a card to an existing position,
|
|
51
|
+
* the card in that position and any subsequent cards
|
|
52
|
+
* are shifted down by 1.
|
|
53
|
+
*
|
|
54
|
+
* If `position` is not specified,
|
|
55
|
+
* the new card is given the bottom position.
|
|
56
|
+
*/
|
|
57
|
+
export declare function createCard(payload: CreateCardRequest): RequestOptionsFactory<CreateCardResponse>;
|
|
58
|
+
/**
|
|
59
|
+
* Deletes a card from a workflow.
|
|
60
|
+
*
|
|
61
|
+
* Deleted cards are removed from the workflow completely and can't be restored.
|
|
62
|
+
* To keep the card available for site contributors, use
|
|
63
|
+
* [Archive Card](https://dev.wix.com/api/rest/workflows/workflows/cards/archive-card)
|
|
64
|
+
* instead.
|
|
65
|
+
*
|
|
66
|
+
* After a card is deleted,
|
|
67
|
+
* its attached contact can be attached to another card in an active phase.
|
|
68
|
+
*/
|
|
69
|
+
export declare function deleteCard(payload: DeleteCardRequest): RequestOptionsFactory<DeleteCardResponse>;
|
|
70
|
+
/**
|
|
71
|
+
* Moves a card to another phase or a new position within the current phase.
|
|
72
|
+
*
|
|
73
|
+
* To move a card, the new phase ID must be provided.
|
|
74
|
+
* You can use
|
|
75
|
+
* [Get Workflow](https://dev.wix.com/api/rest/workflows/workflows/workflows/get-workflow)
|
|
76
|
+
* to get IDs for all the phases in the workflow,
|
|
77
|
+
* including the win phase.
|
|
78
|
+
*
|
|
79
|
+
* If a card is moved to the win phase,
|
|
80
|
+
* its attached contact can be attached to another card in an active phase.
|
|
81
|
+
*/
|
|
82
|
+
export declare function moveCard(payload: MoveCardRequest): RequestOptionsFactory<MoveCardResponse>;
|
|
83
|
+
/**
|
|
84
|
+
* Restores an archived card to the specified phase.
|
|
85
|
+
*
|
|
86
|
+
* To restore a card, the new phase ID must be provided.
|
|
87
|
+
* You can use
|
|
88
|
+
* [Get Workflow](https://dev.wix.com/api/rest/workflows/workflows/workflows/get-workflow)
|
|
89
|
+
* to get IDs for all the phases in the workflow,
|
|
90
|
+
* including the win phase.
|
|
91
|
+
*/
|
|
92
|
+
export declare function restoreCard(payload: RestoreCardRequest): RequestOptionsFactory<RestoreCardResponse>;
|