@wix/workflows 1.0.1 → 1.0.2
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/src/workflows-v1-card.http.d.ts +81 -64
- package/build/cjs/src/workflows-v1-card.http.js +81 -64
- package/build/cjs/src/workflows-v1-card.http.js.map +1 -1
- package/build/cjs/src/workflows-v1-card.universal.d.ts +105 -72
- package/build/cjs/src/workflows-v1-card.universal.js +105 -72
- package/build/cjs/src/workflows-v1-card.universal.js.map +1 -1
- package/build/es/src/workflows-v1-card.http.d.ts +81 -64
- package/build/es/src/workflows-v1-card.http.js +81 -64
- package/build/es/src/workflows-v1-card.http.js.map +1 -1
- package/build/es/src/workflows-v1-card.universal.d.ts +105 -72
- package/build/es/src/workflows-v1-card.universal.js +105 -72
- package/build/es/src/workflows-v1-card.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,105 +1,122 @@
|
|
|
1
1
|
import { RequestOptionsFactory } from '@wix/sdk-types';
|
|
2
2
|
import { ArchiveCardRequest, ArchiveCardResponse, CreateCardRequest, CreateCardResponse, DeleteCardRequest, DeleteCardResponse, GetCardRequest, GetCardResponse, ListCardsRequest, ListCardsResponse, MoveCardRequest, MoveCardResponse, QueryCardsRequest, QueryCardsResponse, RestoreCardRequest, RestoreCardResponse, UpdateCardRequest, UpdateCardResponse } from './workflows-v1-card.types';
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
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)
|
|
4
|
+
* The `queryCards()` function builds a query to retrieve a list of contacts and returns a `CardsQueryBuilder` object.
|
|
5
|
+
*
|
|
6
|
+
* The returned object contains the query definition, which is typically used to run the query using the `find()` function.
|
|
7
|
+
*
|
|
8
|
+
* You can refine the query by chaining `CardsQueryBuilder` functions onto the query. `CardsQueryBuilder` functions enable you to control the results `queryCards()` returns.
|
|
16
9
|
*/
|
|
17
10
|
export declare function queryCards(payload: QueryCardsRequest): RequestOptionsFactory<QueryCardsResponse>;
|
|
18
11
|
/**
|
|
19
|
-
* Retrieves a list of
|
|
12
|
+
* Retrieves a list of a workflow's cards.
|
|
13
|
+
*
|
|
14
|
+
*
|
|
15
|
+
* The `listCards()` function returns a Promise that resolves to a list of the specified workflow's cards.
|
|
16
|
+
*
|
|
17
|
+
*
|
|
18
|
+
* Use the `options` parameter to specify which cards to retrieve and in which order to retrieve them. Must use either `phaseId` or `fetchOnlyArchived`.
|
|
19
|
+
*
|
|
20
|
+
*
|
|
21
|
+
* Cards can be sorted based on their `"id"`, `"name"`, `"phaseId"`, `"createdDate"`, `"updatedDate"`, `"source"`, and `"position"`.
|
|
22
|
+
*
|
|
20
23
|
*
|
|
21
|
-
*
|
|
24
|
+
* If no `limit` parameter is passed, the first 50 cards are returned.
|
|
25
|
+
*
|
|
26
|
+
*
|
|
27
|
+
* Sort order defaults to by `"phaseId"` and then by `"position"` ascending.
|
|
28
|
+
*
|
|
29
|
+
*
|
|
30
|
+
* This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
|
|
22
31
|
*/
|
|
23
32
|
export declare function listCards(payload: ListCardsRequest): RequestOptionsFactory<ListCardsResponse>;
|
|
24
33
|
/**
|
|
25
|
-
* Retrieves a card.
|
|
34
|
+
* Retrieves a workflow card by ID.
|
|
35
|
+
*
|
|
26
36
|
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
37
|
+
* The `getCard()` function returns a Promise that resolves to the card with the specified ID.
|
|
38
|
+
*
|
|
39
|
+
*
|
|
40
|
+
* This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
|
|
30
41
|
*/
|
|
31
42
|
export declare function getCard(payload: GetCardRequest): RequestOptionsFactory<GetCardResponse>;
|
|
32
43
|
/**
|
|
33
|
-
* Updates
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
44
|
+
* Updates an existing workflow card.
|
|
45
|
+
*
|
|
46
|
+
*
|
|
47
|
+
* The `updateCardFields()` function returns a Promise that resolves when the card has been updated with the specified values.
|
|
48
|
+
*
|
|
49
|
+
*
|
|
50
|
+
* `contactId` is not a required field, but if the parameter is not passed, the field will default to empty and the card will not be associated with any contact.
|
|
51
|
+
*
|
|
52
|
+
*
|
|
53
|
+
* This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
|
|
41
54
|
*/
|
|
42
55
|
export declare function updateCard(payload: UpdateCardRequest): RequestOptionsFactory<UpdateCardResponse>;
|
|
43
56
|
/**
|
|
44
|
-
* Creates a new card
|
|
57
|
+
* Creates a new workflow card.
|
|
58
|
+
*
|
|
45
59
|
*
|
|
46
|
-
*
|
|
60
|
+
* The `createCard()` function returns a Promise that resolves to the created card's ID when the card is created in the specified workflow phase.
|
|
47
61
|
*
|
|
48
|
-
*
|
|
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.
|
|
62
|
+
* Pass a value for the `position` parameter to specify the newly created card's position within the specified phase. Positions are zero-based, meaning the first position is `0`.
|
|
53
63
|
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
64
|
+
* When omitted, the newly created card is added to the specified phase as the top card within the phase.
|
|
65
|
+
*
|
|
66
|
+
*
|
|
67
|
+
* This function requires you to specify the ID of a workflow and phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
|
|
68
|
+
*
|
|
69
|
+
* > **Note:**
|
|
70
|
+
* > Each workflow is limited to 5,000 cards.
|
|
71
|
+
* > If this limit is reached, `createCard()` throws an error.
|
|
72
|
+
* > [Archive cards](#archivecard) when they're no longer needed
|
|
73
|
+
* > to reduce card count and avoid hitting the limit.
|
|
56
74
|
*/
|
|
57
75
|
export declare function createCard(payload: CreateCardRequest): RequestOptionsFactory<CreateCardResponse>;
|
|
58
76
|
/**
|
|
59
|
-
* Deletes a card
|
|
77
|
+
* Deletes a workflow card by ID.
|
|
78
|
+
*
|
|
60
79
|
*
|
|
61
|
-
*
|
|
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.
|
|
80
|
+
* The `deleteCard()` function returns a Promise when the specified card has been deleted.
|
|
65
81
|
*
|
|
66
|
-
*
|
|
67
|
-
* its attached contact can be attached to another card in an active phase.
|
|
82
|
+
* This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
|
|
68
83
|
*/
|
|
69
84
|
export declare function deleteCard(payload: DeleteCardRequest): RequestOptionsFactory<DeleteCardResponse>;
|
|
70
85
|
/**
|
|
71
|
-
* Moves a card to
|
|
86
|
+
* Moves a card to a new position within a workflow.
|
|
72
87
|
*
|
|
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
88
|
*
|
|
79
|
-
*
|
|
80
|
-
*
|
|
89
|
+
* The `moveCard()` function returns a Promise when the specified card has been moved to the new position.
|
|
90
|
+
*
|
|
91
|
+
* Use the `options` parameter to specify the phase and position within that phase to move the card to. Positions are zero-based, meaning the first position is `0`.
|
|
92
|
+
*
|
|
93
|
+
* This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
|
|
81
94
|
*/
|
|
82
95
|
export declare function moveCard(payload: MoveCardRequest): RequestOptionsFactory<MoveCardResponse>;
|
|
83
96
|
/**
|
|
84
|
-
* Restores an archived card
|
|
97
|
+
* Restores an archived workflow card.
|
|
98
|
+
*
|
|
99
|
+
*
|
|
100
|
+
* The `restoreCard()` function returns a Promise that resolves when the archived card has been restored.
|
|
101
|
+
*
|
|
85
102
|
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
*
|
|
103
|
+
* This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
|
|
104
|
+
*
|
|
105
|
+
*
|
|
106
|
+
* > **Note:**
|
|
107
|
+
* > Each workflow is limited to 5,000 cards.
|
|
108
|
+
* > If this limit is reached, `createCard()` throws an error.
|
|
109
|
+
* > [Archive cards](#archivecard) when they're no longer needed
|
|
110
|
+
* > to reduce card count and avoid hitting the limit.
|
|
91
111
|
*/
|
|
92
112
|
export declare function restoreCard(payload: RestoreCardRequest): RequestOptionsFactory<RestoreCardResponse>;
|
|
93
113
|
/**
|
|
94
|
-
* Archives a card
|
|
114
|
+
* Archives a workflow card.
|
|
115
|
+
*
|
|
116
|
+
*
|
|
117
|
+
* The `archiveCard()` function returns a Promise that resolves when the card has been archived.
|
|
95
118
|
*
|
|
96
|
-
* Archived cards are still visible to site contributors in the
|
|
97
|
-
* [workflow](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fworkflows).
|
|
98
|
-
* To see archived cards, use
|
|
99
|
-
* [List Cards](https://dev.wix.com/api/rest/workflows/workflows/cards/list-cards)
|
|
100
|
-
* and set `fetchArcived` to `true`.
|
|
101
119
|
*
|
|
102
|
-
*
|
|
103
|
-
* its attached contact can be attached to another card in an active phase.
|
|
120
|
+
* This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
|
|
104
121
|
*/
|
|
105
122
|
export declare function archiveCard(payload: ArchiveCardRequest): RequestOptionsFactory<ArchiveCardResponse>;
|
|
@@ -60,18 +60,11 @@ function resolveComWixpressWorkflowApiV1CardsServiceUrl(opts) {
|
|
|
60
60
|
return (0, metro_runtime_2.resolveUrl)(Object.assign(opts, { domainToMappings }));
|
|
61
61
|
}
|
|
62
62
|
/**
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
* ** cardInfo.name - Text
|
|
69
|
-
* ** cardInfo.source - Text
|
|
70
|
-
* ** cardInfo.position - Number
|
|
71
|
-
* ** cardInfo.createdAt - Date
|
|
72
|
-
* ** cardInfo.updatedAt - Date
|
|
73
|
-
* ** cardInfo.primaryAttachment.contactId - Guid
|
|
74
|
-
* ** cardInfo.visibility - Text (Visible / Archived)
|
|
63
|
+
* The `queryCards()` function builds a query to retrieve a list of contacts and returns a `CardsQueryBuilder` object.
|
|
64
|
+
*
|
|
65
|
+
* The returned object contains the query definition, which is typically used to run the query using the `find()` function.
|
|
66
|
+
*
|
|
67
|
+
* You can refine the query by chaining `CardsQueryBuilder` functions onto the query. `CardsQueryBuilder` functions enable you to control the results `queryCards()` returns.
|
|
75
68
|
*/
|
|
76
69
|
function queryCards(payload) {
|
|
77
70
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_queryCardsRequest, {});
|
|
@@ -100,9 +93,25 @@ function queryCards(payload) {
|
|
|
100
93
|
}
|
|
101
94
|
exports.queryCards = queryCards;
|
|
102
95
|
/**
|
|
103
|
-
* Retrieves a list of
|
|
96
|
+
* Retrieves a list of a workflow's cards.
|
|
97
|
+
*
|
|
98
|
+
*
|
|
99
|
+
* The `listCards()` function returns a Promise that resolves to a list of the specified workflow's cards.
|
|
100
|
+
*
|
|
101
|
+
*
|
|
102
|
+
* Use the `options` parameter to specify which cards to retrieve and in which order to retrieve them. Must use either `phaseId` or `fetchOnlyArchived`.
|
|
103
|
+
*
|
|
104
|
+
*
|
|
105
|
+
* Cards can be sorted based on their `"id"`, `"name"`, `"phaseId"`, `"createdDate"`, `"updatedDate"`, `"source"`, and `"position"`.
|
|
106
|
+
*
|
|
104
107
|
*
|
|
105
|
-
*
|
|
108
|
+
* If no `limit` parameter is passed, the first 50 cards are returned.
|
|
109
|
+
*
|
|
110
|
+
*
|
|
111
|
+
* Sort order defaults to by `"phaseId"` and then by `"position"` ascending.
|
|
112
|
+
*
|
|
113
|
+
*
|
|
114
|
+
* This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
|
|
106
115
|
*/
|
|
107
116
|
function listCards(payload) {
|
|
108
117
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_listCardsRequest, {});
|
|
@@ -131,11 +140,13 @@ function listCards(payload) {
|
|
|
131
140
|
}
|
|
132
141
|
exports.listCards = listCards;
|
|
133
142
|
/**
|
|
134
|
-
* Retrieves a card.
|
|
143
|
+
* Retrieves a workflow card by ID.
|
|
144
|
+
*
|
|
135
145
|
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
*
|
|
146
|
+
* The `getCard()` function returns a Promise that resolves to the card with the specified ID.
|
|
147
|
+
*
|
|
148
|
+
*
|
|
149
|
+
* This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
|
|
139
150
|
*/
|
|
140
151
|
function getCard(payload) {
|
|
141
152
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_getCardRequest, {});
|
|
@@ -164,14 +175,16 @@ function getCard(payload) {
|
|
|
164
175
|
}
|
|
165
176
|
exports.getCard = getCard;
|
|
166
177
|
/**
|
|
167
|
-
* Updates
|
|
168
|
-
*
|
|
169
|
-
*
|
|
170
|
-
*
|
|
171
|
-
*
|
|
172
|
-
*
|
|
173
|
-
*
|
|
174
|
-
*
|
|
178
|
+
* Updates an existing workflow card.
|
|
179
|
+
*
|
|
180
|
+
*
|
|
181
|
+
* The `updateCardFields()` function returns a Promise that resolves when the card has been updated with the specified values.
|
|
182
|
+
*
|
|
183
|
+
*
|
|
184
|
+
* `contactId` is not a required field, but if the parameter is not passed, the field will default to empty and the card will not be associated with any contact.
|
|
185
|
+
*
|
|
186
|
+
*
|
|
187
|
+
* This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
|
|
175
188
|
*/
|
|
176
189
|
function updateCard(payload) {
|
|
177
190
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_updateCardRequest, {
|
|
@@ -199,18 +212,23 @@ function updateCard(payload) {
|
|
|
199
212
|
}
|
|
200
213
|
exports.updateCard = updateCard;
|
|
201
214
|
/**
|
|
202
|
-
* Creates a new card
|
|
215
|
+
* Creates a new workflow card.
|
|
216
|
+
*
|
|
203
217
|
*
|
|
204
|
-
*
|
|
218
|
+
* The `createCard()` function returns a Promise that resolves to the created card's ID when the card is created in the specified workflow phase.
|
|
205
219
|
*
|
|
206
|
-
*
|
|
207
|
-
* starting from `0` and incrementing by 1.
|
|
208
|
-
* If you create or move a card to an existing position,
|
|
209
|
-
* the card in that position and any subsequent cards
|
|
210
|
-
* are shifted down by 1.
|
|
220
|
+
* Pass a value for the `position` parameter to specify the newly created card's position within the specified phase. Positions are zero-based, meaning the first position is `0`.
|
|
211
221
|
*
|
|
212
|
-
*
|
|
213
|
-
*
|
|
222
|
+
* When omitted, the newly created card is added to the specified phase as the top card within the phase.
|
|
223
|
+
*
|
|
224
|
+
*
|
|
225
|
+
* This function requires you to specify the ID of a workflow and phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
|
|
226
|
+
*
|
|
227
|
+
* > **Note:**
|
|
228
|
+
* > Each workflow is limited to 5,000 cards.
|
|
229
|
+
* > If this limit is reached, `createCard()` throws an error.
|
|
230
|
+
* > [Archive cards](#archivecard) when they're no longer needed
|
|
231
|
+
* > to reduce card count and avoid hitting the limit.
|
|
214
232
|
*/
|
|
215
233
|
function createCard(payload) {
|
|
216
234
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_createCardRequest, {
|
|
@@ -238,15 +256,12 @@ function createCard(payload) {
|
|
|
238
256
|
}
|
|
239
257
|
exports.createCard = createCard;
|
|
240
258
|
/**
|
|
241
|
-
* Deletes a card
|
|
259
|
+
* Deletes a workflow card by ID.
|
|
260
|
+
*
|
|
242
261
|
*
|
|
243
|
-
*
|
|
244
|
-
* To keep the card available for site contributors, use
|
|
245
|
-
* [Archive Card](https://dev.wix.com/api/rest/workflows/workflows/cards/archive-card)
|
|
246
|
-
* instead.
|
|
262
|
+
* The `deleteCard()` function returns a Promise when the specified card has been deleted.
|
|
247
263
|
*
|
|
248
|
-
*
|
|
249
|
-
* its attached contact can be attached to another card in an active phase.
|
|
264
|
+
* This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
|
|
250
265
|
*/
|
|
251
266
|
function deleteCard(payload) {
|
|
252
267
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_deleteCardRequest, {});
|
|
@@ -272,16 +287,14 @@ function deleteCard(payload) {
|
|
|
272
287
|
}
|
|
273
288
|
exports.deleteCard = deleteCard;
|
|
274
289
|
/**
|
|
275
|
-
* Moves a card to
|
|
290
|
+
* Moves a card to a new position within a workflow.
|
|
276
291
|
*
|
|
277
|
-
* To move a card, the new phase ID must be provided.
|
|
278
|
-
* You can use
|
|
279
|
-
* [Get Workflow](https://dev.wix.com/api/rest/workflows/workflows/workflows/get-workflow)
|
|
280
|
-
* to get IDs for all the phases in the workflow,
|
|
281
|
-
* including the win phase.
|
|
282
292
|
*
|
|
283
|
-
*
|
|
284
|
-
*
|
|
293
|
+
* The `moveCard()` function returns a Promise when the specified card has been moved to the new position.
|
|
294
|
+
*
|
|
295
|
+
* Use the `options` parameter to specify the phase and position within that phase to move the card to. Positions are zero-based, meaning the first position is `0`.
|
|
296
|
+
*
|
|
297
|
+
* This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
|
|
285
298
|
*/
|
|
286
299
|
function moveCard(payload) {
|
|
287
300
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_moveCardRequest, {});
|
|
@@ -307,13 +320,20 @@ function moveCard(payload) {
|
|
|
307
320
|
}
|
|
308
321
|
exports.moveCard = moveCard;
|
|
309
322
|
/**
|
|
310
|
-
* Restores an archived card
|
|
323
|
+
* Restores an archived workflow card.
|
|
324
|
+
*
|
|
325
|
+
*
|
|
326
|
+
* The `restoreCard()` function returns a Promise that resolves when the archived card has been restored.
|
|
327
|
+
*
|
|
311
328
|
*
|
|
312
|
-
*
|
|
313
|
-
*
|
|
314
|
-
*
|
|
315
|
-
*
|
|
316
|
-
*
|
|
329
|
+
* This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
|
|
330
|
+
*
|
|
331
|
+
*
|
|
332
|
+
* > **Note:**
|
|
333
|
+
* > Each workflow is limited to 5,000 cards.
|
|
334
|
+
* > If this limit is reached, `createCard()` throws an error.
|
|
335
|
+
* > [Archive cards](#archivecard) when they're no longer needed
|
|
336
|
+
* > to reduce card count and avoid hitting the limit.
|
|
317
337
|
*/
|
|
318
338
|
function restoreCard(payload) {
|
|
319
339
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_restoreCardRequest, {});
|
|
@@ -339,16 +359,13 @@ function restoreCard(payload) {
|
|
|
339
359
|
}
|
|
340
360
|
exports.restoreCard = restoreCard;
|
|
341
361
|
/**
|
|
342
|
-
* Archives a card
|
|
362
|
+
* Archives a workflow card.
|
|
363
|
+
*
|
|
364
|
+
*
|
|
365
|
+
* The `archiveCard()` function returns a Promise that resolves when the card has been archived.
|
|
343
366
|
*
|
|
344
|
-
* Archived cards are still visible to site contributors in the
|
|
345
|
-
* [workflow](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fworkflows).
|
|
346
|
-
* To see archived cards, use
|
|
347
|
-
* [List Cards](https://dev.wix.com/api/rest/workflows/workflows/cards/list-cards)
|
|
348
|
-
* and set `fetchArcived` to `true`.
|
|
349
367
|
*
|
|
350
|
-
*
|
|
351
|
-
* its attached contact can be attached to another card in an active phase.
|
|
368
|
+
* This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
|
|
352
369
|
*/
|
|
353
370
|
function archiveCard(payload) {
|
|
354
371
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_archiveCardRequest, {});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"workflows-v1-card.http.js","sourceRoot":"","sources":["../../../src/workflows-v1-card.http.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AACvD,8DAA2D;AAC3D,sDAAgD;AAwBhD,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,KAAK,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;AACpC,MAAM,SAAS,GAAG;IAChB,OAAO,EAAE,2BAA2B;IACpC,SAAS,EAAE,2BAA2B;IACtC,SAAS,EAAE,2BAA2B;IACtC,WAAW,EAAE,2BAA2B;IACxC,WAAW,EAAE,2BAA2B;CACzC,CAAC;AACF,MAAM,kBAAkB,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;AACjD,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,eAAe,GAAG,EAAE,CAAC;AAC3B,MAAM,gBAAgB,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AAC3C,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,kBAAkB,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;AAC9C,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAC5B,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;AAC/C,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,kBAAkB,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AACrD,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAE/B,SAAS,8CAA8C,CACrD,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,2BAA2B;gBACpC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,sBAAsB;gBAC/B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,2BAA2B;gBACpC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,YAAY;gBACrB,QAAQ,EAAE,EAAE;aACb;SACF;KACF,CAAC;IAEF,OAAO,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED
|
|
1
|
+
{"version":3,"file":"workflows-v1-card.http.js","sourceRoot":"","sources":["../../../src/workflows-v1-card.http.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AACvD,8DAA2D;AAC3D,sDAAgD;AAwBhD,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,KAAK,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;AACpC,MAAM,SAAS,GAAG;IAChB,OAAO,EAAE,2BAA2B;IACpC,SAAS,EAAE,2BAA2B;IACtC,SAAS,EAAE,2BAA2B;IACtC,WAAW,EAAE,2BAA2B;IACxC,WAAW,EAAE,2BAA2B;CACzC,CAAC;AACF,MAAM,kBAAkB,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;AACjD,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,eAAe,GAAG,EAAE,CAAC;AAC3B,MAAM,gBAAgB,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AAC3C,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,kBAAkB,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;AAC9C,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAC5B,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;AAC/C,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,kBAAkB,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AACrD,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAE/B,SAAS,8CAA8C,CACrD,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,2BAA2B;gBACpC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,sBAAsB;gBAC/B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,2BAA2B;gBACpC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,YAAY;gBACrB,QAAQ,EAAE,EAAE;aACb;SACF;KACF,CAAC;IAEF,OAAO,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,UAAU,CACxB,OAA0B;IAE1B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,kBAAkB,EAClB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,mBAAmB,EAAE;QAC5D,KAAK;QACL,SAAS;KACV,CAAC,CAAC;IAEH,SAAS,YAAY,CAAC,EAAE,IAAI,EAAO;QACjC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,uBAAuB;YACnC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,sDAAsD;YACjE,GAAG,EAAE,8CAA8C,CAAC;gBAClD,SAAS,EAAE,iBAAiB;gBAC5B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,YAAY,CAAC,OAAO,GAAG,OAAO,CAAC;IAE/B,OAAO,YAAY,CAAC;AACtB,CAAC;AAjCD,gCAiCC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAgB,SAAS,CACvB,OAAyB;IAEzB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,iBAAiB,EACjB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,kBAAkB,EAAE;QAC3D,KAAK;QACL,SAAS;KACV,CAAC,CAAC;IAEH,SAAS,WAAW,CAAC,EAAE,IAAI,EAAO;QAChC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,uBAAuB;YACnC,MAAM,EAAE,KAAY;YACpB,SAAS,EAAE,qDAAqD;YAChE,GAAG,EAAE,8CAA8C,CAAC;gBAClD,SAAS,EAAE,kCAAkC;gBAC7C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,iCAAiB,EAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,WAAW,CAAC,OAAO,GAAG,OAAO,CAAC;IAE9B,OAAO,WAAW,CAAC;AACrB,CAAC;AAjCD,8BAiCC;AAED;;;;;;;;GAQG;AACH,SAAgB,OAAO,CACrB,OAAuB;IAEvB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,eAAe,EAAE,EAAE,CAAC,CAAC;IAC7E,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,gBAAgB,EAAE;QACzD,KAAK;QACL,SAAS;KACV,CAAC,CAAC;IAEH,SAAS,SAAS,CAAC,EAAE,IAAI,EAAO;QAC9B,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,uBAAuB;YACnC,MAAM,EAAE,KAAY;YACpB,SAAS,EAAE,mDAAmD;YAC9D,GAAG,EAAE,8CAA8C,CAAC;gBAClD,SAAS,EAAE,gBAAgB;gBAC3B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,iCAAiB,EAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,SAAS,CAAC,OAAO,GAAG,OAAO,CAAC;IAE5B,OAAO,SAAS,CAAC;AACnB,CAAC;AA9BD,0BA8BC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,UAAU,CACxB,OAA0B;IAE1B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,kBAAkB,EAAE;QAC1E,SAAS;KACV,CAAC,CAAC;IACH,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;IAElE,SAAS,YAAY,CAAC,EAAE,IAAI,EAAO;QACjC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,uBAAuB;YACnC,MAAM,EAAE,OAAc;YACtB,SAAS,EAAE,sDAAsD;YACjE,GAAG,EAAE,8CAA8C,CAAC;gBAClD,SAAS,EAAE,gBAAgB;gBAC3B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,YAAY,CAAC,OAAO,GAAG,OAAO,CAAC;IAE/B,OAAO,YAAY,CAAC;AACtB,CAAC;AA7BD,gCA6BC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,UAAU,CACxB,OAA0B;IAE1B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,kBAAkB,EAAE;QAC1E,SAAS;KACV,CAAC,CAAC;IACH,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;IAElE,SAAS,YAAY,CAAC,EAAE,IAAI,EAAO;QACjC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,uBAAuB;YACnC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,sDAAsD;YACjE,GAAG,EAAE,8CAA8C,CAAC;gBAClD,SAAS,EAAE,mDAAmD;gBAC9D,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,YAAY,CAAC,OAAO,GAAG,OAAO,CAAC;IAE/B,OAAO,YAAY,CAAC;AACtB,CAAC;AA7BD,gCA6BC;AAED;;;;;;;GAOG;AACH,SAAgB,UAAU,CACxB,OAA0B;IAE1B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,kBAAkB,EAClB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;IAElE,SAAS,YAAY,CAAC,EAAE,IAAI,EAAO;QACjC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,uBAAuB;YACnC,MAAM,EAAE,QAAe;YACvB,SAAS,EAAE,sDAAsD;YACjE,GAAG,EAAE,8CAA8C,CAAC;gBAClD,SAAS,EAAE,gBAAgB;gBAC3B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,iCAAiB,EAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,YAAY,CAAC,OAAO,GAAG,OAAO,CAAC;IAE/B,OAAO,YAAY,CAAC;AACtB,CAAC;AA9BD,gCA8BC;AAED;;;;;;;;;GASG;AACH,SAAgB,QAAQ,CACtB,OAAwB;IAExB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;IAC9E,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;IAEhE,SAAS,UAAU,CAAC,EAAE,IAAI,EAAO;QAC/B,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,uBAAuB;YACnC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,oDAAoD;YAC/D,GAAG,EAAE,8CAA8C,CAAC;gBAClD,SAAS,EAAE,qBAAqB;gBAChC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC;IAE7B,OAAO,UAAU,CAAC;AACpB,CAAC;AA3BD,4BA2BC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,WAAW,CACzB,OAA2B;IAE3B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,mBAAmB,EACnB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC;IAEnE,SAAS,aAAa,CAAC,EAAE,IAAI,EAAO;QAClC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,uBAAuB;YACnC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,uDAAuD;YAClE,GAAG,EAAE,8CAA8C,CAAC;gBAClD,SAAS,EAAE,wBAAwB;gBACnC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;IAEhC,OAAO,aAAa,CAAC;AACvB,CAAC;AA9BD,kCA8BC;AAED;;;;;;;;GAQG;AACH,SAAgB,WAAW,CACzB,OAA2B;IAE3B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,mBAAmB,EACnB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC;IAEnE,SAAS,aAAa,CAAC,EAAE,IAAI,EAAO;QAClC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,uBAAuB;YACnC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,uDAAuD;YAClE,GAAG,EAAE,8CAA8C,CAAC;gBAClD,SAAS,EAAE,wBAAwB;gBACnC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;IAEhC,OAAO,aAAa,CAAC;AACvB,CAAC;AA9BD,kCA8BC"}
|