@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>;
|
|
@@ -57,18 +57,11 @@ function resolveComWixpressWorkflowApiV1CardsServiceUrl(opts) {
|
|
|
57
57
|
return resolveUrl(Object.assign(opts, { domainToMappings }));
|
|
58
58
|
}
|
|
59
59
|
/**
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
* ** cardInfo.name - Text
|
|
66
|
-
* ** cardInfo.source - Text
|
|
67
|
-
* ** cardInfo.position - Number
|
|
68
|
-
* ** cardInfo.createdAt - Date
|
|
69
|
-
* ** cardInfo.updatedAt - Date
|
|
70
|
-
* ** cardInfo.primaryAttachment.contactId - Guid
|
|
71
|
-
* ** cardInfo.visibility - Text (Visible / Archived)
|
|
60
|
+
* The `queryCards()` function builds a query to retrieve a list of contacts and returns a `CardsQueryBuilder` object.
|
|
61
|
+
*
|
|
62
|
+
* The returned object contains the query definition, which is typically used to run the query using the `find()` function.
|
|
63
|
+
*
|
|
64
|
+
* You can refine the query by chaining `CardsQueryBuilder` functions onto the query. `CardsQueryBuilder` functions enable you to control the results `queryCards()` returns.
|
|
72
65
|
*/
|
|
73
66
|
export function queryCards(payload) {
|
|
74
67
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_queryCardsRequest, {});
|
|
@@ -96,9 +89,25 @@ export function queryCards(payload) {
|
|
|
96
89
|
return __queryCards;
|
|
97
90
|
}
|
|
98
91
|
/**
|
|
99
|
-
* Retrieves a list of
|
|
92
|
+
* Retrieves a list of a workflow's cards.
|
|
93
|
+
*
|
|
94
|
+
*
|
|
95
|
+
* The `listCards()` function returns a Promise that resolves to a list of the specified workflow's cards.
|
|
96
|
+
*
|
|
97
|
+
*
|
|
98
|
+
* Use the `options` parameter to specify which cards to retrieve and in which order to retrieve them. Must use either `phaseId` or `fetchOnlyArchived`.
|
|
99
|
+
*
|
|
100
|
+
*
|
|
101
|
+
* Cards can be sorted based on their `"id"`, `"name"`, `"phaseId"`, `"createdDate"`, `"updatedDate"`, `"source"`, and `"position"`.
|
|
102
|
+
*
|
|
100
103
|
*
|
|
101
|
-
*
|
|
104
|
+
* If no `limit` parameter is passed, the first 50 cards are returned.
|
|
105
|
+
*
|
|
106
|
+
*
|
|
107
|
+
* Sort order defaults to by `"phaseId"` and then by `"position"` ascending.
|
|
108
|
+
*
|
|
109
|
+
*
|
|
110
|
+
* 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).
|
|
102
111
|
*/
|
|
103
112
|
export function listCards(payload) {
|
|
104
113
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_listCardsRequest, {});
|
|
@@ -126,11 +135,13 @@ export function listCards(payload) {
|
|
|
126
135
|
return __listCards;
|
|
127
136
|
}
|
|
128
137
|
/**
|
|
129
|
-
* Retrieves a card.
|
|
138
|
+
* Retrieves a workflow card by ID.
|
|
139
|
+
*
|
|
130
140
|
*
|
|
131
|
-
*
|
|
132
|
-
*
|
|
133
|
-
*
|
|
141
|
+
* The `getCard()` function returns a Promise that resolves to the card with the specified ID.
|
|
142
|
+
*
|
|
143
|
+
*
|
|
144
|
+
* 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).
|
|
134
145
|
*/
|
|
135
146
|
export function getCard(payload) {
|
|
136
147
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_getCardRequest, {});
|
|
@@ -158,14 +169,16 @@ export function getCard(payload) {
|
|
|
158
169
|
return __getCard;
|
|
159
170
|
}
|
|
160
171
|
/**
|
|
161
|
-
* Updates
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
*
|
|
165
|
-
*
|
|
166
|
-
*
|
|
167
|
-
*
|
|
168
|
-
*
|
|
172
|
+
* Updates an existing workflow card.
|
|
173
|
+
*
|
|
174
|
+
*
|
|
175
|
+
* The `updateCardFields()` function returns a Promise that resolves when the card has been updated with the specified values.
|
|
176
|
+
*
|
|
177
|
+
*
|
|
178
|
+
* `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.
|
|
179
|
+
*
|
|
180
|
+
*
|
|
181
|
+
* 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).
|
|
169
182
|
*/
|
|
170
183
|
export function updateCard(payload) {
|
|
171
184
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_updateCardRequest, {
|
|
@@ -192,18 +205,23 @@ export function updateCard(payload) {
|
|
|
192
205
|
return __updateCard;
|
|
193
206
|
}
|
|
194
207
|
/**
|
|
195
|
-
* Creates a new card
|
|
208
|
+
* Creates a new workflow card.
|
|
209
|
+
*
|
|
196
210
|
*
|
|
197
|
-
*
|
|
211
|
+
* The `createCard()` function returns a Promise that resolves to the created card's ID when the card is created in the specified workflow phase.
|
|
198
212
|
*
|
|
199
|
-
*
|
|
200
|
-
* starting from `0` and incrementing by 1.
|
|
201
|
-
* If you create or move a card to an existing position,
|
|
202
|
-
* the card in that position and any subsequent cards
|
|
203
|
-
* are shifted down by 1.
|
|
213
|
+
* 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`.
|
|
204
214
|
*
|
|
205
|
-
*
|
|
206
|
-
*
|
|
215
|
+
* When omitted, the newly created card is added to the specified phase as the top card within the phase.
|
|
216
|
+
*
|
|
217
|
+
*
|
|
218
|
+
* 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).
|
|
219
|
+
*
|
|
220
|
+
* > **Note:**
|
|
221
|
+
* > Each workflow is limited to 5,000 cards.
|
|
222
|
+
* > If this limit is reached, `createCard()` throws an error.
|
|
223
|
+
* > [Archive cards](#archivecard) when they're no longer needed
|
|
224
|
+
* > to reduce card count and avoid hitting the limit.
|
|
207
225
|
*/
|
|
208
226
|
export function createCard(payload) {
|
|
209
227
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_createCardRequest, {
|
|
@@ -230,15 +248,12 @@ export function createCard(payload) {
|
|
|
230
248
|
return __createCard;
|
|
231
249
|
}
|
|
232
250
|
/**
|
|
233
|
-
* Deletes a card
|
|
251
|
+
* Deletes a workflow card by ID.
|
|
252
|
+
*
|
|
234
253
|
*
|
|
235
|
-
*
|
|
236
|
-
* To keep the card available for site contributors, use
|
|
237
|
-
* [Archive Card](https://dev.wix.com/api/rest/workflows/workflows/cards/archive-card)
|
|
238
|
-
* instead.
|
|
254
|
+
* The `deleteCard()` function returns a Promise when the specified card has been deleted.
|
|
239
255
|
*
|
|
240
|
-
*
|
|
241
|
-
* its attached contact can be attached to another card in an active phase.
|
|
256
|
+
* 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).
|
|
242
257
|
*/
|
|
243
258
|
export function deleteCard(payload) {
|
|
244
259
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_deleteCardRequest, {});
|
|
@@ -263,16 +278,14 @@ export function deleteCard(payload) {
|
|
|
263
278
|
return __deleteCard;
|
|
264
279
|
}
|
|
265
280
|
/**
|
|
266
|
-
* Moves a card to
|
|
281
|
+
* Moves a card to a new position within a workflow.
|
|
267
282
|
*
|
|
268
|
-
* To move a card, the new phase ID must be provided.
|
|
269
|
-
* You can use
|
|
270
|
-
* [Get Workflow](https://dev.wix.com/api/rest/workflows/workflows/workflows/get-workflow)
|
|
271
|
-
* to get IDs for all the phases in the workflow,
|
|
272
|
-
* including the win phase.
|
|
273
283
|
*
|
|
274
|
-
*
|
|
275
|
-
*
|
|
284
|
+
* The `moveCard()` function returns a Promise when the specified card has been moved to the new position.
|
|
285
|
+
*
|
|
286
|
+
* 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`.
|
|
287
|
+
*
|
|
288
|
+
* 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).
|
|
276
289
|
*/
|
|
277
290
|
export function moveCard(payload) {
|
|
278
291
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_moveCardRequest, {});
|
|
@@ -297,13 +310,20 @@ export function moveCard(payload) {
|
|
|
297
310
|
return __moveCard;
|
|
298
311
|
}
|
|
299
312
|
/**
|
|
300
|
-
* Restores an archived card
|
|
313
|
+
* Restores an archived workflow card.
|
|
314
|
+
*
|
|
315
|
+
*
|
|
316
|
+
* The `restoreCard()` function returns a Promise that resolves when the archived card has been restored.
|
|
317
|
+
*
|
|
301
318
|
*
|
|
302
|
-
*
|
|
303
|
-
*
|
|
304
|
-
*
|
|
305
|
-
*
|
|
306
|
-
*
|
|
319
|
+
* 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).
|
|
320
|
+
*
|
|
321
|
+
*
|
|
322
|
+
* > **Note:**
|
|
323
|
+
* > Each workflow is limited to 5,000 cards.
|
|
324
|
+
* > If this limit is reached, `createCard()` throws an error.
|
|
325
|
+
* > [Archive cards](#archivecard) when they're no longer needed
|
|
326
|
+
* > to reduce card count and avoid hitting the limit.
|
|
307
327
|
*/
|
|
308
328
|
export function restoreCard(payload) {
|
|
309
329
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_restoreCardRequest, {});
|
|
@@ -328,16 +348,13 @@ export function restoreCard(payload) {
|
|
|
328
348
|
return __restoreCard;
|
|
329
349
|
}
|
|
330
350
|
/**
|
|
331
|
-
* Archives a card
|
|
351
|
+
* Archives a workflow card.
|
|
352
|
+
*
|
|
353
|
+
*
|
|
354
|
+
* The `archiveCard()` function returns a Promise that resolves when the card has been archived.
|
|
332
355
|
*
|
|
333
|
-
* Archived cards are still visible to site contributors in the
|
|
334
|
-
* [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).
|
|
335
|
-
* To see archived cards, use
|
|
336
|
-
* [List Cards](https://dev.wix.com/api/rest/workflows/workflows/cards/list-cards)
|
|
337
|
-
* and set `fetchArcived` to `true`.
|
|
338
356
|
*
|
|
339
|
-
*
|
|
340
|
-
* its attached contact can be attached to another card in an active phase.
|
|
357
|
+
* 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).
|
|
341
358
|
*/
|
|
342
359
|
export function archiveCard(payload) {
|
|
343
360
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_archiveCardRequest, {});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"workflows-v1-card.http.js","sourceRoot":"","sources":["../../../src/workflows-v1-card.http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;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,UAAU,CAAC,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,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;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,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CACxB,OAA0B;IAE1B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,kBAAkB,EAClB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,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;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,SAAS,CACvB,OAAyB;IAEzB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,iBAAiB,EACjB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,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,iBAAiB,CAAC,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;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,OAAO,CACrB,OAAuB;IAEvB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;IAC7E,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,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,iBAAiB,CAAC,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;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,UAAU,CACxB,OAA0B;IAE1B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,kBAAkB,EAAE;QAC1E,SAAS;KACV,CAAC,CAAC;IACH,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,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;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,UAAU,CACxB,OAA0B;IAE1B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,kBAAkB,EAAE;QAC1E,SAAS;KACV,CAAC,CAAC;IACH,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,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;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,UAAU,CACxB,OAA0B;IAE1B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,kBAAkB,EAClB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,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,iBAAiB,CAAC,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;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,QAAQ,CACtB,OAAwB;IAExB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;IAC9E,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,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;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,WAAW,CACzB,OAA2B;IAE3B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,mBAAmB,EACnB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,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;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,WAAW,CACzB,OAA2B;IAE3B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,mBAAmB,EACnB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,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"}
|