@wix/workflows 1.0.4 → 1.0.5

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.
Files changed (25) hide show
  1. package/build/cjs/src/workflows-v1-card.http.d.ts +8 -8
  2. package/build/cjs/src/workflows-v1-card.http.js +8 -8
  3. package/build/cjs/src/workflows-v1-card.universal.d.ts +8 -8
  4. package/build/cjs/src/workflows-v1-card.universal.js +8 -8
  5. package/build/cjs/src/workflows-v1-phase.http.d.ts +6 -6
  6. package/build/cjs/src/workflows-v1-phase.http.js +6 -6
  7. package/build/cjs/src/workflows-v1-phase.universal.d.ts +6 -6
  8. package/build/cjs/src/workflows-v1-phase.universal.js +6 -6
  9. package/build/cjs/src/workflows-v1-workflow.http.d.ts +2 -2
  10. package/build/cjs/src/workflows-v1-workflow.http.js +2 -2
  11. package/build/cjs/src/workflows-v1-workflow.universal.d.ts +2 -2
  12. package/build/cjs/src/workflows-v1-workflow.universal.js +2 -2
  13. package/build/es/src/workflows-v1-card.http.d.ts +8 -8
  14. package/build/es/src/workflows-v1-card.http.js +8 -8
  15. package/build/es/src/workflows-v1-card.universal.d.ts +8 -8
  16. package/build/es/src/workflows-v1-card.universal.js +8 -8
  17. package/build/es/src/workflows-v1-phase.http.d.ts +6 -6
  18. package/build/es/src/workflows-v1-phase.http.js +6 -6
  19. package/build/es/src/workflows-v1-phase.universal.d.ts +6 -6
  20. package/build/es/src/workflows-v1-phase.universal.js +6 -6
  21. package/build/es/src/workflows-v1-workflow.http.d.ts +2 -2
  22. package/build/es/src/workflows-v1-workflow.http.js +2 -2
  23. package/build/es/src/workflows-v1-workflow.universal.d.ts +2 -2
  24. package/build/es/src/workflows-v1-workflow.universal.js +2 -2
  25. package/package.json +2 -2
package/build/cjs/src/workflows-v1-card.http.d.ts CHANGED
@@ -27,7 +27,7 @@ export declare function queryCards(payload: QueryCardsRequest): RequestOptionsFa
27
27
  * Sort order defaults to by `"phaseId"` and then by `"position"` ascending.
28
28
  *
29
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).
30
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
31
31
  */
32
32
  export declare function listCards(payload: ListCardsRequest): RequestOptionsFactory<ListCardsResponse>;
33
33
  /**
@@ -37,7 +37,7 @@ export declare function listCards(payload: ListCardsRequest): RequestOptionsFact
37
37
  * The `getCard()` function returns a Promise that resolves to the card with the specified ID.
38
38
  *
39
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).
40
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
41
41
  */
42
42
  export declare function getCard(payload: GetCardRequest): RequestOptionsFactory<GetCardResponse>;
43
43
  /**
@@ -50,7 +50,7 @@ export declare function getCard(payload: GetCardRequest): RequestOptionsFactory<
50
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
51
  *
52
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).
53
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
54
54
  */
55
55
  export declare function updateCard(payload: UpdateCardRequest): RequestOptionsFactory<UpdateCardResponse>;
56
56
  /**
@@ -64,7 +64,7 @@ export declare function updateCard(payload: UpdateCardRequest): RequestOptionsFa
64
64
  * When omitted, the newly created card is added to the specified phase as the top card within the phase.
65
65
  *
66
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).
67
+ * This function requires you to specify the ID of a workflow and phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
68
68
  *
69
69
  * > **Note:**
70
70
  * > Each workflow is limited to 5,000 cards.
@@ -79,7 +79,7 @@ export declare function createCard(payload: CreateCardRequest): RequestOptionsFa
79
79
  *
80
80
  * The `deleteCard()` function returns a Promise when the specified card has been deleted.
81
81
  *
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).
82
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
83
83
  */
84
84
  export declare function deleteCard(payload: DeleteCardRequest): RequestOptionsFactory<DeleteCardResponse>;
85
85
  /**
@@ -90,7 +90,7 @@ export declare function deleteCard(payload: DeleteCardRequest): RequestOptionsFa
90
90
  *
91
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
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).
93
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
94
94
  */
95
95
  export declare function moveCard(payload: MoveCardRequest): RequestOptionsFactory<MoveCardResponse>;
96
96
  /**
@@ -100,7 +100,7 @@ export declare function moveCard(payload: MoveCardRequest): RequestOptionsFactor
100
100
  * The `restoreCard()` function returns a Promise that resolves when the archived card has been restored.
101
101
  *
102
102
  *
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).
103
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
104
104
  *
105
105
  *
106
106
  * > **Note:**
@@ -117,6 +117,6 @@ export declare function restoreCard(payload: RestoreCardRequest): RequestOptions
117
117
  * The `archiveCard()` function returns a Promise that resolves when the card has been archived.
118
118
  *
119
119
  *
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).
120
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
121
121
  */
122
122
  export declare function archiveCard(payload: ArchiveCardRequest): RequestOptionsFactory<ArchiveCardResponse>;
package/build/cjs/src/workflows-v1-card.http.js CHANGED
@@ -111,7 +111,7 @@ exports.queryCards = queryCards;
111
111
  * Sort order defaults to by `"phaseId"` and then by `"position"` ascending.
112
112
  *
113
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).
114
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
115
115
  */
116
116
  function listCards(payload) {
117
117
  const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_listCardsRequest, {});
@@ -146,7 +146,7 @@ exports.listCards = listCards;
146
146
  * The `getCard()` function returns a Promise that resolves to the card with the specified ID.
147
147
  *
148
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).
149
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
150
150
  */
151
151
  function getCard(payload) {
152
152
  const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_getCardRequest, {});
@@ -184,7 +184,7 @@ exports.getCard = getCard;
184
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
185
  *
186
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).
187
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
188
188
  */
189
189
  function updateCard(payload) {
190
190
  const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_updateCardRequest, {
@@ -222,7 +222,7 @@ exports.updateCard = updateCard;
222
222
  * When omitted, the newly created card is added to the specified phase as the top card within the phase.
223
223
  *
224
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).
225
+ * This function requires you to specify the ID of a workflow and phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
226
226
  *
227
227
  * > **Note:**
228
228
  * > Each workflow is limited to 5,000 cards.
@@ -261,7 +261,7 @@ exports.createCard = createCard;
261
261
  *
262
262
  * The `deleteCard()` function returns a Promise when the specified card has been deleted.
263
263
  *
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).
264
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
265
265
  */
266
266
  function deleteCard(payload) {
267
267
  const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_deleteCardRequest, {});
@@ -294,7 +294,7 @@ exports.deleteCard = deleteCard;
294
294
  *
295
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
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).
297
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
298
298
  */
299
299
  function moveCard(payload) {
300
300
  const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_moveCardRequest, {});
@@ -326,7 +326,7 @@ exports.moveCard = moveCard;
326
326
  * The `restoreCard()` function returns a Promise that resolves when the archived card has been restored.
327
327
  *
328
328
  *
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).
329
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
330
330
  *
331
331
  *
332
332
  * > **Note:**
@@ -365,7 +365,7 @@ exports.restoreCard = restoreCard;
365
365
  * The `archiveCard()` function returns a Promise that resolves when the card has been archived.
366
366
  *
367
367
  *
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).
368
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
369
369
  */
370
370
  function archiveCard(payload) {
371
371
  const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_archiveCardRequest, {});
package/build/cjs/src/workflows-v1-card.universal.d.ts CHANGED
@@ -280,7 +280,7 @@ export interface QueryCardsOptions {
280
280
  * Sort order defaults to by `"phaseId"` and then by `"position"` ascending.
281
281
  *
282
282
  *
283
- * 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).
283
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
284
284
  *
285
285
  * This function is not a universal function and runs only on the backend.
286
286
  * @param workflowId - ID of the workflow whose cards will be listed.
@@ -336,7 +336,7 @@ export interface ListCardsOptions {
336
336
  * The `getCard()` function returns a Promise that resolves to the card with the specified ID.
337
337
  *
338
338
  *
339
- * 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).
339
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
340
340
  *
341
341
  * This function is not a universal function and runs only on the backend.
342
342
  * @param _id - ID of the card to retrieve.
@@ -354,7 +354,7 @@ export declare function getCard(_id: string): Promise<GetCardResponse>;
354
354
  * `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.
355
355
  *
356
356
  *
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).
357
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
358
358
  *
359
359
  * This function is not a universal function and runs only on the backend.
360
360
  * @param _id - ID of the card to update.
@@ -378,7 +378,7 @@ export interface UpdateCardOptions {
378
378
  * When omitted, the newly created card is added to the specified phase as the top card within the phase.
379
379
  *
380
380
  *
381
- * 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).
381
+ * This function requires you to specify the ID of a workflow and phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
382
382
  *
383
383
  * > **Note:**
384
384
  * > Each workflow is limited to 5,000 cards.
@@ -419,7 +419,7 @@ export interface CreateCardOptions {
419
419
  *
420
420
  * The `deleteCard()` function returns a Promise when the specified card has been deleted.
421
421
  *
422
- * 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).
422
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
423
423
  *
424
424
  * This function is not a universal function and runs only on the backend.
425
425
  * @param _id - ID of the card to delete.
@@ -435,7 +435,7 @@ export declare function deleteCard(_id: string): Promise<void>;
435
435
  *
436
436
  * 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`.
437
437
  *
438
- * 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).
438
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
439
439
  *
440
440
  * This function is not a universal function and runs only on the backend.
441
441
  * @param _id - ID of the card to move.
@@ -457,7 +457,7 @@ export interface MoveCardOptions {
457
457
  * The `restoreCard()` function returns a Promise that resolves when the archived card has been restored.
458
458
  *
459
459
  *
460
- * 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).
460
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
461
461
  *
462
462
  *
463
463
  * > **Note:**
@@ -489,7 +489,7 @@ export interface RestoreCardOptions {
489
489
  * The `archiveCard()` function returns a Promise that resolves when the card has been archived.
490
490
  *
491
491
  *
492
- * 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).
492
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
493
493
  *
494
494
  * This function is not a universal function and runs only on the backend.
495
495
  * @param _id - ID of the card to archive.
package/build/cjs/src/workflows-v1-card.universal.js CHANGED
@@ -149,7 +149,7 @@ exports.queryCards = queryCards;
149
149
  * Sort order defaults to by `"phaseId"` and then by `"position"` ascending.
150
150
  *
151
151
  *
152
- * 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).
152
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
153
153
  *
154
154
  * This function is not a universal function and runs only on the backend.
155
155
  * @param workflowId - ID of the workflow whose cards will be listed.
@@ -217,7 +217,7 @@ exports.listCards = listCards;
217
217
  * The `getCard()` function returns a Promise that resolves to the card with the specified ID.
218
218
  *
219
219
  *
220
- * 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).
220
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
221
221
  *
222
222
  * This function is not a universal function and runs only on the backend.
223
223
  * @param _id - ID of the card to retrieve.
@@ -278,7 +278,7 @@ exports.getCard = getCard;
278
278
  * `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.
279
279
  *
280
280
  *
281
- * 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).
281
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
282
282
  *
283
283
  * This function is not a universal function and runs only on the backend.
284
284
  * @param _id - ID of the card to update.
@@ -342,7 +342,7 @@ exports.updateCard = updateCard;
342
342
  * When omitted, the newly created card is added to the specified phase as the top card within the phase.
343
343
  *
344
344
  *
345
- * 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).
345
+ * This function requires you to specify the ID of a workflow and phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
346
346
  *
347
347
  * > **Note:**
348
348
  * > Each workflow is limited to 5,000 cards.
@@ -413,7 +413,7 @@ exports.createCard = createCard;
413
413
  *
414
414
  * The `deleteCard()` function returns a Promise when the specified card has been deleted.
415
415
  *
416
- * 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).
416
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
417
417
  *
418
418
  * This function is not a universal function and runs only on the backend.
419
419
  * @param _id - ID of the card to delete.
@@ -472,7 +472,7 @@ exports.deleteCard = deleteCard;
472
472
  *
473
473
  * 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`.
474
474
  *
475
- * 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).
475
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
476
476
  *
477
477
  * This function is not a universal function and runs only on the backend.
478
478
  * @param _id - ID of the card to move.
@@ -536,7 +536,7 @@ exports.moveCard = moveCard;
536
536
  * The `restoreCard()` function returns a Promise that resolves when the archived card has been restored.
537
537
  *
538
538
  *
539
- * 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).
539
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
540
540
  *
541
541
  *
542
542
  * > **Note:**
@@ -610,7 +610,7 @@ exports.restoreCard = restoreCard;
610
610
  * The `archiveCard()` function returns a Promise that resolves when the card has been archived.
611
611
  *
612
612
  *
613
- * 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).
613
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
614
614
  *
615
615
  * This function is not a universal function and runs only on the backend.
616
616
  * @param _id - ID of the card to archive.
package/build/cjs/src/workflows-v1-phase.http.d.ts CHANGED
@@ -20,7 +20,7 @@ export declare function queryPhases(payload: QueryPhasesRequest): RequestOptions
20
20
  * Use the `options` parameter to specify which phases to retrieve and in which order to retrieve them. Phases can be sorted based on their `"id"`, `"name"`, and `"position"`. If no `limit` parameter is passed, the first 50 cards are returned. Sort order defaults to by `"position"` ascending.
21
21
  *
22
22
  *
23
- * 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).
23
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
24
24
  */
25
25
  export declare function listPhases(payload: ListPhasesRequest): RequestOptionsFactory<ListPhasesResponse>;
26
26
  /**
@@ -29,7 +29,7 @@ export declare function listPhases(payload: ListPhasesRequest): RequestOptionsFa
29
29
  *
30
30
  * The `getPhaseInfo()` function returns a Promise that resolves to the phase with the specified ID.
31
31
  *
32
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
32
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
33
33
  */
34
34
  export declare function getPhase(payload: GetPhaseRequest): RequestOptionsFactory<GetPhaseResponse>;
35
35
  /**
@@ -42,7 +42,7 @@ export declare function getPhase(payload: GetPhaseRequest): RequestOptionsFactor
42
42
  * Only the properties passed in the `Phase` object will be updated. All other properties will remain the same.
43
43
  *
44
44
  *
45
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
45
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
46
46
  */
47
47
  export declare function updatePhase(payload: UpdatePhaseRequest): RequestOptionsFactory<UpdatePhaseResponse>;
48
48
  /**
@@ -58,7 +58,7 @@ export declare function updatePhase(payload: UpdatePhaseRequest): RequestOptions
58
58
  * When omitted, the newly created phase is added as the last non-win phase.
59
59
  *
60
60
  *
61
- * 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).
61
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
62
62
  */
63
63
  export declare function createPhase(payload: CreatePhaseRequest): RequestOptionsFactory<CreatePhaseResponse>;
64
64
  /**
@@ -68,7 +68,7 @@ export declare function createPhase(payload: CreatePhaseRequest): RequestOptions
68
68
  * The `deletePhase()` function returns a Promise when the specified phase has been deleted.
69
69
  *
70
70
  *
71
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
71
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
72
72
  */
73
73
  export declare function deletePhase(payload: DeletePhaseRequest): RequestOptionsFactory<DeletePhaseResponse>;
74
74
  /**
@@ -81,6 +81,6 @@ export declare function deletePhase(payload: DeletePhaseRequest): RequestOptions
81
81
  * Use the `options` parameter to specify the new phase position within the workflow. Any non-win phase can be moved to any non-win position. The win phase cannot be moved. Positions are zero-based, meaning the first position is `0`.
82
82
  *
83
83
  *
84
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
84
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
85
85
  */
86
86
  export declare function movePhase(payload: MovePhaseRequest): RequestOptionsFactory<MovePhaseResponse>;
package/build/cjs/src/workflows-v1-phase.http.js CHANGED
@@ -104,7 +104,7 @@ exports.queryPhases = queryPhases;
104
104
  * Use the `options` parameter to specify which phases to retrieve and in which order to retrieve them. Phases can be sorted based on their `"id"`, `"name"`, and `"position"`. If no `limit` parameter is passed, the first 50 cards are returned. Sort order defaults to by `"position"` ascending.
105
105
  *
106
106
  *
107
- * 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).
107
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
108
108
  */
109
109
  function listPhases(payload) {
110
110
  const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_listPhasesRequest, {});
@@ -140,7 +140,7 @@ exports.listPhases = listPhases;
140
140
  *
141
141
  * The `getPhaseInfo()` function returns a Promise that resolves to the phase with the specified ID.
142
142
  *
143
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
143
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
144
144
  */
145
145
  function getPhase(payload) {
146
146
  const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_getPhaseRequest, {});
@@ -180,7 +180,7 @@ exports.getPhase = getPhase;
180
180
  * Only the properties passed in the `Phase` object will be updated. All other properties will remain the same.
181
181
  *
182
182
  *
183
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
183
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
184
184
  */
185
185
  function updatePhase(payload) {
186
186
  const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_updatePhaseRequest, {});
@@ -218,7 +218,7 @@ exports.updatePhase = updatePhase;
218
218
  * When omitted, the newly created phase is added as the last non-win phase.
219
219
  *
220
220
  *
221
- * 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).
221
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
222
222
  */
223
223
  function createPhase(payload) {
224
224
  const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_createPhaseRequest, {});
@@ -250,7 +250,7 @@ exports.createPhase = createPhase;
250
250
  * The `deletePhase()` function returns a Promise when the specified phase has been deleted.
251
251
  *
252
252
  *
253
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
253
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
254
254
  */
255
255
  function deletePhase(payload) {
256
256
  const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_deletePhaseRequest, {});
@@ -285,7 +285,7 @@ exports.deletePhase = deletePhase;
285
285
  * Use the `options` parameter to specify the new phase position within the workflow. Any non-win phase can be moved to any non-win position. The win phase cannot be moved. Positions are zero-based, meaning the first position is `0`.
286
286
  *
287
287
  *
288
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
288
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
289
289
  */
290
290
  function movePhase(payload) {
291
291
  const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_movePhaseRequest, {});
package/build/cjs/src/workflows-v1-phase.universal.d.ts CHANGED
@@ -266,7 +266,7 @@ export interface QueryPhasesOptions {
266
266
  * Use the `options` parameter to specify which phases to retrieve and in which order to retrieve them. Phases can be sorted based on their `"id"`, `"name"`, and `"position"`. If no `limit` parameter is passed, the first 50 cards are returned. Sort order defaults to by `"position"` ascending.
267
267
  *
268
268
  *
269
- * 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).
269
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
270
270
  *
271
271
  * This function is not a universal function and runs only on the backend.
272
272
  * @param workflowId - ID of the workflow whose phases will be listed.
@@ -303,7 +303,7 @@ export interface ListPhasesOptions {
303
303
  *
304
304
  * The `getPhaseInfo()` function returns a Promise that resolves to the phase with the specified ID.
305
305
  *
306
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
306
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
307
307
  *
308
308
  * This function is not a universal function and runs only on the backend.
309
309
  * @param _id - ID of the phase to retrieve.
@@ -321,7 +321,7 @@ export declare function getPhase(_id: string): Promise<GetPhaseResponse>;
321
321
  * Only the properties passed in the `Phase` object will be updated. All other properties will remain the same.
322
322
  *
323
323
  *
324
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
324
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
325
325
  *
326
326
  * This function is not a universal function and runs only on the backend.
327
327
  * @param _id - ID of the phase to update.
@@ -347,7 +347,7 @@ export interface UpdatePhaseOptions {
347
347
  * When omitted, the newly created phase is added as the last non-win phase.
348
348
  *
349
349
  *
350
- * 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).
350
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
351
351
  *
352
352
  * This function is not a universal function and runs only on the backend.
353
353
  * @param workflowId - ID of the workflow to create the phase in.
@@ -379,7 +379,7 @@ export interface CreatePhaseOptions {
379
379
  * The `deletePhase()` function returns a Promise when the specified phase has been deleted.
380
380
  *
381
381
  *
382
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
382
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
383
383
  *
384
384
  * This function is not a universal function and runs only on the backend.
385
385
  * @param _id - ID of the phase to delete.
@@ -397,7 +397,7 @@ export declare function deletePhase(_id: string): Promise<void>;
397
397
  * Use the `options` parameter to specify the new phase position within the workflow. Any non-win phase can be moved to any non-win position. The win phase cannot be moved. Positions are zero-based, meaning the first position is `0`.
398
398
  *
399
399
  *
400
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
400
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
401
401
  *
402
402
  * This function is not a universal function and runs only on the backend.
403
403
  * @param newPosition - New phase position, where the first phase is `0`.
package/build/cjs/src/workflows-v1-phase.universal.js CHANGED
@@ -137,7 +137,7 @@ exports.queryPhases = queryPhases;
137
137
  * Use the `options` parameter to specify which phases to retrieve and in which order to retrieve them. Phases can be sorted based on their `"id"`, `"name"`, and `"position"`. If no `limit` parameter is passed, the first 50 cards are returned. Sort order defaults to by `"position"` ascending.
138
138
  *
139
139
  *
140
- * 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).
140
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
141
141
  *
142
142
  * This function is not a universal function and runs only on the backend.
143
143
  * @param workflowId - ID of the workflow whose phases will be listed.
@@ -201,7 +201,7 @@ exports.listPhases = listPhases;
201
201
  *
202
202
  * The `getPhaseInfo()` function returns a Promise that resolves to the phase with the specified ID.
203
203
  *
204
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
204
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
205
205
  *
206
206
  * This function is not a universal function and runs only on the backend.
207
207
  * @param _id - ID of the phase to retrieve.
@@ -262,7 +262,7 @@ exports.getPhase = getPhase;
262
262
  * Only the properties passed in the `Phase` object will be updated. All other properties will remain the same.
263
263
  *
264
264
  *
265
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
265
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
266
266
  *
267
267
  * This function is not a universal function and runs only on the backend.
268
268
  * @param _id - ID of the phase to update.
@@ -328,7 +328,7 @@ exports.updatePhase = updatePhase;
328
328
  * When omitted, the newly created phase is added as the last non-win phase.
329
329
  *
330
330
  *
331
- * 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).
331
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
332
332
  *
333
333
  * This function is not a universal function and runs only on the backend.
334
334
  * @param workflowId - ID of the workflow to create the phase in.
@@ -393,7 +393,7 @@ exports.createPhase = createPhase;
393
393
  * The `deletePhase()` function returns a Promise when the specified phase has been deleted.
394
394
  *
395
395
  *
396
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
396
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
397
397
  *
398
398
  * This function is not a universal function and runs only on the backend.
399
399
  * @param _id - ID of the phase to delete.
@@ -454,7 +454,7 @@ exports.deletePhase = deletePhase;
454
454
  * Use the `options` parameter to specify the new phase position within the workflow. Any non-win phase can be moved to any non-win position. The win phase cannot be moved. Positions are zero-based, meaning the first position is `0`.
455
455
  *
456
456
  *
457
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
457
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
458
458
  *
459
459
  * This function is not a universal function and runs only on the backend.
460
460
  * @param newPosition - New phase position, where the first phase is `0`.
package/build/cjs/src/workflows-v1-workflow.http.d.ts CHANGED
@@ -32,7 +32,7 @@ export declare function queryWorkflows(payload: QueryWorkflowsRequest): RequestO
32
32
  * The `getWorkflowInfo()` function returns a Promise that resolves to the workflow info with the specified ID.
33
33
  *
34
34
  *
35
- * 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).
35
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
36
36
  */
37
37
  export declare function getWorkflow(payload: GetWorkflowRequest): RequestOptionsFactory<GetWorkflowResponse>;
38
38
  /**
@@ -62,7 +62,7 @@ export declare function createWorkflow(payload: CreateWorkflowRequest): RequestO
62
62
  * The `deleteWorkflow()` function returns a Promise when the specified workflow has been deleted.
63
63
  *
64
64
  *
65
- * 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).
65
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
66
66
  */
67
67
  export declare function deleteWorkflow(payload: DeleteWorkflowRequest): RequestOptionsFactory<DeleteWorkflowResponse>;
68
68
  /** Sets up the default workflow. */
package/build/cjs/src/workflows-v1-workflow.http.js CHANGED
@@ -154,7 +154,7 @@ exports.queryWorkflows = queryWorkflows;
154
154
  * The `getWorkflowInfo()` function returns a Promise that resolves to the workflow info with the specified ID.
155
155
  *
156
156
  *
157
- * 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).
157
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
158
158
  */
159
159
  function getWorkflow(payload) {
160
160
  const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_getWorkflowRequest, {});
@@ -258,7 +258,7 @@ exports.createWorkflow = createWorkflow;
258
258
  * The `deleteWorkflow()` function returns a Promise when the specified workflow has been deleted.
259
259
  *
260
260
  *
261
- * 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).
261
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
262
262
  */
263
263
  function deleteWorkflow(payload) {
264
264
  const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_deleteWorkflowRequest, {});
package/build/cjs/src/workflows-v1-workflow.universal.d.ts CHANGED
@@ -345,7 +345,7 @@ export interface QueryWorkflowsOptions {
345
345
  * The `getWorkflowInfo()` function returns a Promise that resolves to the workflow info with the specified ID.
346
346
  *
347
347
  *
348
- * 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).
348
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
349
349
  *
350
350
  * This function is not a universal function and runs only on the backend.
351
351
  * @param _id - ID of the workflow to retrieve.
@@ -409,7 +409,7 @@ export interface CreateWorkflowOptions {
409
409
  * The `deleteWorkflow()` function returns a Promise when the specified workflow has been deleted.
410
410
  *
411
411
  *
412
- * 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).
412
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
413
413
  *
414
414
  * This function is not a universal function and runs only on the backend.
415
415
  * @param _id - ID of the workflow to delete.
package/build/cjs/src/workflows-v1-workflow.universal.js CHANGED
@@ -201,7 +201,7 @@ exports.queryWorkflows = queryWorkflows;
201
201
  * The `getWorkflowInfo()` function returns a Promise that resolves to the workflow info with the specified ID.
202
202
  *
203
203
  *
204
- * 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).
204
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
205
205
  *
206
206
  * This function is not a universal function and runs only on the backend.
207
207
  * @param _id - ID of the workflow to retrieve.
@@ -382,7 +382,7 @@ exports.createWorkflow = createWorkflow;
382
382
  * The `deleteWorkflow()` function returns a Promise when the specified workflow has been deleted.
383
383
  *
384
384
  *
385
- * 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).
385
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
386
386
  *
387
387
  * This function is not a universal function and runs only on the backend.
388
388
  * @param _id - ID of the workflow to delete.
package/build/es/src/workflows-v1-card.http.d.ts CHANGED
@@ -27,7 +27,7 @@ export declare function queryCards(payload: QueryCardsRequest): RequestOptionsFa
27
27
  * Sort order defaults to by `"phaseId"` and then by `"position"` ascending.
28
28
  *
29
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).
30
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
31
31
  */
32
32
  export declare function listCards(payload: ListCardsRequest): RequestOptionsFactory<ListCardsResponse>;
33
33
  /**
@@ -37,7 +37,7 @@ export declare function listCards(payload: ListCardsRequest): RequestOptionsFact
37
37
  * The `getCard()` function returns a Promise that resolves to the card with the specified ID.
38
38
  *
39
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).
40
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
41
41
  */
42
42
  export declare function getCard(payload: GetCardRequest): RequestOptionsFactory<GetCardResponse>;
43
43
  /**
@@ -50,7 +50,7 @@ export declare function getCard(payload: GetCardRequest): RequestOptionsFactory<
50
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
51
  *
52
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).
53
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
54
54
  */
55
55
  export declare function updateCard(payload: UpdateCardRequest): RequestOptionsFactory<UpdateCardResponse>;
56
56
  /**
@@ -64,7 +64,7 @@ export declare function updateCard(payload: UpdateCardRequest): RequestOptionsFa
64
64
  * When omitted, the newly created card is added to the specified phase as the top card within the phase.
65
65
  *
66
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).
67
+ * This function requires you to specify the ID of a workflow and phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
68
68
  *
69
69
  * > **Note:**
70
70
  * > Each workflow is limited to 5,000 cards.
@@ -79,7 +79,7 @@ export declare function createCard(payload: CreateCardRequest): RequestOptionsFa
79
79
  *
80
80
  * The `deleteCard()` function returns a Promise when the specified card has been deleted.
81
81
  *
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).
82
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
83
83
  */
84
84
  export declare function deleteCard(payload: DeleteCardRequest): RequestOptionsFactory<DeleteCardResponse>;
85
85
  /**
@@ -90,7 +90,7 @@ export declare function deleteCard(payload: DeleteCardRequest): RequestOptionsFa
90
90
  *
91
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
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).
93
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
94
94
  */
95
95
  export declare function moveCard(payload: MoveCardRequest): RequestOptionsFactory<MoveCardResponse>;
96
96
  /**
@@ -100,7 +100,7 @@ export declare function moveCard(payload: MoveCardRequest): RequestOptionsFactor
100
100
  * The `restoreCard()` function returns a Promise that resolves when the archived card has been restored.
101
101
  *
102
102
  *
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).
103
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
104
104
  *
105
105
  *
106
106
  * > **Note:**
@@ -117,6 +117,6 @@ export declare function restoreCard(payload: RestoreCardRequest): RequestOptions
117
117
  * The `archiveCard()` function returns a Promise that resolves when the card has been archived.
118
118
  *
119
119
  *
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).
120
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
121
121
  */
122
122
  export declare function archiveCard(payload: ArchiveCardRequest): RequestOptionsFactory<ArchiveCardResponse>;
package/build/es/src/workflows-v1-card.http.js CHANGED
@@ -107,7 +107,7 @@ export function queryCards(payload) {
107
107
  * Sort order defaults to by `"phaseId"` and then by `"position"` ascending.
108
108
  *
109
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).
110
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
111
111
  */
112
112
  export function listCards(payload) {
113
113
  const { toJSON: toReq, fromJSON: fromReq } = serializer(_listCardsRequest, {});
@@ -141,7 +141,7 @@ export function listCards(payload) {
141
141
  * The `getCard()` function returns a Promise that resolves to the card with the specified ID.
142
142
  *
143
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).
144
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
145
145
  */
146
146
  export function getCard(payload) {
147
147
  const { toJSON: toReq, fromJSON: fromReq } = serializer(_getCardRequest, {});
@@ -178,7 +178,7 @@ export function getCard(payload) {
178
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
179
  *
180
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).
181
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
182
182
  */
183
183
  export function updateCard(payload) {
184
184
  const { toJSON: toReq, fromJSON: fromReq } = serializer(_updateCardRequest, {
@@ -215,7 +215,7 @@ export function updateCard(payload) {
215
215
  * When omitted, the newly created card is added to the specified phase as the top card within the phase.
216
216
  *
217
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).
218
+ * This function requires you to specify the ID of a workflow and phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
219
219
  *
220
220
  * > **Note:**
221
221
  * > Each workflow is limited to 5,000 cards.
@@ -253,7 +253,7 @@ export function createCard(payload) {
253
253
  *
254
254
  * The `deleteCard()` function returns a Promise when the specified card has been deleted.
255
255
  *
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).
256
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
257
257
  */
258
258
  export function deleteCard(payload) {
259
259
  const { toJSON: toReq, fromJSON: fromReq } = serializer(_deleteCardRequest, {});
@@ -285,7 +285,7 @@ export function deleteCard(payload) {
285
285
  *
286
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
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).
288
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
289
289
  */
290
290
  export function moveCard(payload) {
291
291
  const { toJSON: toReq, fromJSON: fromReq } = serializer(_moveCardRequest, {});
@@ -316,7 +316,7 @@ export function moveCard(payload) {
316
316
  * The `restoreCard()` function returns a Promise that resolves when the archived card has been restored.
317
317
  *
318
318
  *
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).
319
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
320
320
  *
321
321
  *
322
322
  * > **Note:**
@@ -354,7 +354,7 @@ export function restoreCard(payload) {
354
354
  * The `archiveCard()` function returns a Promise that resolves when the card has been archived.
355
355
  *
356
356
  *
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).
357
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
358
358
  */
359
359
  export function archiveCard(payload) {
360
360
  const { toJSON: toReq, fromJSON: fromReq } = serializer(_archiveCardRequest, {});
package/build/es/src/workflows-v1-card.universal.d.ts CHANGED
@@ -280,7 +280,7 @@ export interface QueryCardsOptions {
280
280
  * Sort order defaults to by `"phaseId"` and then by `"position"` ascending.
281
281
  *
282
282
  *
283
- * 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).
283
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
284
284
  *
285
285
  * This function is not a universal function and runs only on the backend.
286
286
  * @param workflowId - ID of the workflow whose cards will be listed.
@@ -336,7 +336,7 @@ export interface ListCardsOptions {
336
336
  * The `getCard()` function returns a Promise that resolves to the card with the specified ID.
337
337
  *
338
338
  *
339
- * 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).
339
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
340
340
  *
341
341
  * This function is not a universal function and runs only on the backend.
342
342
  * @param _id - ID of the card to retrieve.
@@ -354,7 +354,7 @@ export declare function getCard(_id: string): Promise<GetCardResponse>;
354
354
  * `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.
355
355
  *
356
356
  *
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).
357
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
358
358
  *
359
359
  * This function is not a universal function and runs only on the backend.
360
360
  * @param _id - ID of the card to update.
@@ -378,7 +378,7 @@ export interface UpdateCardOptions {
378
378
  * When omitted, the newly created card is added to the specified phase as the top card within the phase.
379
379
  *
380
380
  *
381
- * 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).
381
+ * This function requires you to specify the ID of a workflow and phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
382
382
  *
383
383
  * > **Note:**
384
384
  * > Each workflow is limited to 5,000 cards.
@@ -419,7 +419,7 @@ export interface CreateCardOptions {
419
419
  *
420
420
  * The `deleteCard()` function returns a Promise when the specified card has been deleted.
421
421
  *
422
- * 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).
422
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
423
423
  *
424
424
  * This function is not a universal function and runs only on the backend.
425
425
  * @param _id - ID of the card to delete.
@@ -435,7 +435,7 @@ export declare function deleteCard(_id: string): Promise<void>;
435
435
  *
436
436
  * 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`.
437
437
  *
438
- * 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).
438
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
439
439
  *
440
440
  * This function is not a universal function and runs only on the backend.
441
441
  * @param _id - ID of the card to move.
@@ -457,7 +457,7 @@ export interface MoveCardOptions {
457
457
  * The `restoreCard()` function returns a Promise that resolves when the archived card has been restored.
458
458
  *
459
459
  *
460
- * 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).
460
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
461
461
  *
462
462
  *
463
463
  * > **Note:**
@@ -489,7 +489,7 @@ export interface RestoreCardOptions {
489
489
  * The `archiveCard()` function returns a Promise that resolves when the card has been archived.
490
490
  *
491
491
  *
492
- * 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).
492
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
493
493
  *
494
494
  * This function is not a universal function and runs only on the backend.
495
495
  * @param _id - ID of the card to archive.
package/build/es/src/workflows-v1-card.universal.js CHANGED
@@ -126,7 +126,7 @@ export function queryCards(options) {
126
126
  * Sort order defaults to by `"phaseId"` and then by `"position"` ascending.
127
127
  *
128
128
  *
129
- * 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).
129
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
130
130
  *
131
131
  * This function is not a universal function and runs only on the backend.
132
132
  * @param workflowId - ID of the workflow whose cards will be listed.
@@ -193,7 +193,7 @@ export function listCards(workflowId, options) {
193
193
  * The `getCard()` function returns a Promise that resolves to the card with the specified ID.
194
194
  *
195
195
  *
196
- * 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).
196
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
197
197
  *
198
198
  * This function is not a universal function and runs only on the backend.
199
199
  * @param _id - ID of the card to retrieve.
@@ -253,7 +253,7 @@ export function getCard(_id) {
253
253
  * `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.
254
254
  *
255
255
  *
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).
256
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
257
257
  *
258
258
  * This function is not a universal function and runs only on the backend.
259
259
  * @param _id - ID of the card to update.
@@ -316,7 +316,7 @@ export function updateCard(_id, options) {
316
316
  * When omitted, the newly created card is added to the specified phase as the top card within the phase.
317
317
  *
318
318
  *
319
- * 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).
319
+ * This function requires you to specify the ID of a workflow and phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
320
320
  *
321
321
  * > **Note:**
322
322
  * > Each workflow is limited to 5,000 cards.
@@ -386,7 +386,7 @@ export function createCard(identifiers, options) {
386
386
  *
387
387
  * The `deleteCard()` function returns a Promise when the specified card has been deleted.
388
388
  *
389
- * 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).
389
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
390
390
  *
391
391
  * This function is not a universal function and runs only on the backend.
392
392
  * @param _id - ID of the card to delete.
@@ -444,7 +444,7 @@ export function deleteCard(_id) {
444
444
  *
445
445
  * 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`.
446
446
  *
447
- * 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).
447
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
448
448
  *
449
449
  * This function is not a universal function and runs only on the backend.
450
450
  * @param _id - ID of the card to move.
@@ -507,7 +507,7 @@ export function moveCard(_id, options) {
507
507
  * The `restoreCard()` function returns a Promise that resolves when the archived card has been restored.
508
508
  *
509
509
  *
510
- * 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).
510
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
511
511
  *
512
512
  *
513
513
  * > **Note:**
@@ -580,7 +580,7 @@ export function restoreCard(_id, newPhaseId, options) {
580
580
  * The `archiveCard()` function returns a Promise that resolves when the card has been archived.
581
581
  *
582
582
  *
583
- * 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).
583
+ * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
584
584
  *
585
585
  * This function is not a universal function and runs only on the backend.
586
586
  * @param _id - ID of the card to archive.
package/build/es/src/workflows-v1-phase.http.d.ts CHANGED
@@ -20,7 +20,7 @@ export declare function queryPhases(payload: QueryPhasesRequest): RequestOptions
20
20
  * Use the `options` parameter to specify which phases to retrieve and in which order to retrieve them. Phases can be sorted based on their `"id"`, `"name"`, and `"position"`. If no `limit` parameter is passed, the first 50 cards are returned. Sort order defaults to by `"position"` ascending.
21
21
  *
22
22
  *
23
- * 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).
23
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
24
24
  */
25
25
  export declare function listPhases(payload: ListPhasesRequest): RequestOptionsFactory<ListPhasesResponse>;
26
26
  /**
@@ -29,7 +29,7 @@ export declare function listPhases(payload: ListPhasesRequest): RequestOptionsFa
29
29
  *
30
30
  * The `getPhaseInfo()` function returns a Promise that resolves to the phase with the specified ID.
31
31
  *
32
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
32
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
33
33
  */
34
34
  export declare function getPhase(payload: GetPhaseRequest): RequestOptionsFactory<GetPhaseResponse>;
35
35
  /**
@@ -42,7 +42,7 @@ export declare function getPhase(payload: GetPhaseRequest): RequestOptionsFactor
42
42
  * Only the properties passed in the `Phase` object will be updated. All other properties will remain the same.
43
43
  *
44
44
  *
45
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
45
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
46
46
  */
47
47
  export declare function updatePhase(payload: UpdatePhaseRequest): RequestOptionsFactory<UpdatePhaseResponse>;
48
48
  /**
@@ -58,7 +58,7 @@ export declare function updatePhase(payload: UpdatePhaseRequest): RequestOptions
58
58
  * When omitted, the newly created phase is added as the last non-win phase.
59
59
  *
60
60
  *
61
- * 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).
61
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
62
62
  */
63
63
  export declare function createPhase(payload: CreatePhaseRequest): RequestOptionsFactory<CreatePhaseResponse>;
64
64
  /**
@@ -68,7 +68,7 @@ export declare function createPhase(payload: CreatePhaseRequest): RequestOptions
68
68
  * The `deletePhase()` function returns a Promise when the specified phase has been deleted.
69
69
  *
70
70
  *
71
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
71
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
72
72
  */
73
73
  export declare function deletePhase(payload: DeletePhaseRequest): RequestOptionsFactory<DeletePhaseResponse>;
74
74
  /**
@@ -81,6 +81,6 @@ export declare function deletePhase(payload: DeletePhaseRequest): RequestOptions
81
81
  * Use the `options` parameter to specify the new phase position within the workflow. Any non-win phase can be moved to any non-win position. The win phase cannot be moved. Positions are zero-based, meaning the first position is `0`.
82
82
  *
83
83
  *
84
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
84
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
85
85
  */
86
86
  export declare function movePhase(payload: MovePhaseRequest): RequestOptionsFactory<MovePhaseResponse>;
package/build/es/src/workflows-v1-phase.http.js CHANGED
@@ -100,7 +100,7 @@ export function queryPhases(payload) {
100
100
  * Use the `options` parameter to specify which phases to retrieve and in which order to retrieve them. Phases can be sorted based on their `"id"`, `"name"`, and `"position"`. If no `limit` parameter is passed, the first 50 cards are returned. Sort order defaults to by `"position"` ascending.
101
101
  *
102
102
  *
103
- * 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).
103
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
104
104
  */
105
105
  export function listPhases(payload) {
106
106
  const { toJSON: toReq, fromJSON: fromReq } = serializer(_listPhasesRequest, {});
@@ -135,7 +135,7 @@ export function listPhases(payload) {
135
135
  *
136
136
  * The `getPhaseInfo()` function returns a Promise that resolves to the phase with the specified ID.
137
137
  *
138
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
138
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
139
139
  */
140
140
  export function getPhase(payload) {
141
141
  const { toJSON: toReq, fromJSON: fromReq } = serializer(_getPhaseRequest, {});
@@ -174,7 +174,7 @@ export function getPhase(payload) {
174
174
  * Only the properties passed in the `Phase` object will be updated. All other properties will remain the same.
175
175
  *
176
176
  *
177
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
177
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
178
178
  */
179
179
  export function updatePhase(payload) {
180
180
  const { toJSON: toReq, fromJSON: fromReq } = serializer(_updatePhaseRequest, {});
@@ -211,7 +211,7 @@ export function updatePhase(payload) {
211
211
  * When omitted, the newly created phase is added as the last non-win phase.
212
212
  *
213
213
  *
214
- * 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).
214
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
215
215
  */
216
216
  export function createPhase(payload) {
217
217
  const { toJSON: toReq, fromJSON: fromReq } = serializer(_createPhaseRequest, {});
@@ -242,7 +242,7 @@ export function createPhase(payload) {
242
242
  * The `deletePhase()` function returns a Promise when the specified phase has been deleted.
243
243
  *
244
244
  *
245
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
245
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
246
246
  */
247
247
  export function deletePhase(payload) {
248
248
  const { toJSON: toReq, fromJSON: fromReq } = serializer(_deletePhaseRequest, {});
@@ -276,7 +276,7 @@ export function deletePhase(payload) {
276
276
  * Use the `options` parameter to specify the new phase position within the workflow. Any non-win phase can be moved to any non-win position. The win phase cannot be moved. Positions are zero-based, meaning the first position is `0`.
277
277
  *
278
278
  *
279
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
279
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
280
280
  */
281
281
  export function movePhase(payload) {
282
282
  const { toJSON: toReq, fromJSON: fromReq } = serializer(_movePhaseRequest, {});
package/build/es/src/workflows-v1-phase.universal.d.ts CHANGED
@@ -266,7 +266,7 @@ export interface QueryPhasesOptions {
266
266
  * Use the `options` parameter to specify which phases to retrieve and in which order to retrieve them. Phases can be sorted based on their `"id"`, `"name"`, and `"position"`. If no `limit` parameter is passed, the first 50 cards are returned. Sort order defaults to by `"position"` ascending.
267
267
  *
268
268
  *
269
- * 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).
269
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
270
270
  *
271
271
  * This function is not a universal function and runs only on the backend.
272
272
  * @param workflowId - ID of the workflow whose phases will be listed.
@@ -303,7 +303,7 @@ export interface ListPhasesOptions {
303
303
  *
304
304
  * The `getPhaseInfo()` function returns a Promise that resolves to the phase with the specified ID.
305
305
  *
306
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
306
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
307
307
  *
308
308
  * This function is not a universal function and runs only on the backend.
309
309
  * @param _id - ID of the phase to retrieve.
@@ -321,7 +321,7 @@ export declare function getPhase(_id: string): Promise<GetPhaseResponse>;
321
321
  * Only the properties passed in the `Phase` object will be updated. All other properties will remain the same.
322
322
  *
323
323
  *
324
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
324
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
325
325
  *
326
326
  * This function is not a universal function and runs only on the backend.
327
327
  * @param _id - ID of the phase to update.
@@ -347,7 +347,7 @@ export interface UpdatePhaseOptions {
347
347
  * When omitted, the newly created phase is added as the last non-win phase.
348
348
  *
349
349
  *
350
- * 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).
350
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
351
351
  *
352
352
  * This function is not a universal function and runs only on the backend.
353
353
  * @param workflowId - ID of the workflow to create the phase in.
@@ -379,7 +379,7 @@ export interface CreatePhaseOptions {
379
379
  * The `deletePhase()` function returns a Promise when the specified phase has been deleted.
380
380
  *
381
381
  *
382
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
382
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
383
383
  *
384
384
  * This function is not a universal function and runs only on the backend.
385
385
  * @param _id - ID of the phase to delete.
@@ -397,7 +397,7 @@ export declare function deletePhase(_id: string): Promise<void>;
397
397
  * Use the `options` parameter to specify the new phase position within the workflow. Any non-win phase can be moved to any non-win position. The win phase cannot be moved. Positions are zero-based, meaning the first position is `0`.
398
398
  *
399
399
  *
400
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
400
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
401
401
  *
402
402
  * This function is not a universal function and runs only on the backend.
403
403
  * @param newPosition - New phase position, where the first phase is `0`.
package/build/es/src/workflows-v1-phase.universal.js CHANGED
@@ -114,7 +114,7 @@ export function queryPhases(options) {
114
114
  * Use the `options` parameter to specify which phases to retrieve and in which order to retrieve them. Phases can be sorted based on their `"id"`, `"name"`, and `"position"`. If no `limit` parameter is passed, the first 50 cards are returned. Sort order defaults to by `"position"` ascending.
115
115
  *
116
116
  *
117
- * 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).
117
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
118
118
  *
119
119
  * This function is not a universal function and runs only on the backend.
120
120
  * @param workflowId - ID of the workflow whose phases will be listed.
@@ -177,7 +177,7 @@ export function listPhases(workflowId, options) {
177
177
  *
178
178
  * The `getPhaseInfo()` function returns a Promise that resolves to the phase with the specified ID.
179
179
  *
180
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
180
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
181
181
  *
182
182
  * This function is not a universal function and runs only on the backend.
183
183
  * @param _id - ID of the phase to retrieve.
@@ -237,7 +237,7 @@ export function getPhase(_id) {
237
237
  * Only the properties passed in the `Phase` object will be updated. All other properties will remain the same.
238
238
  *
239
239
  *
240
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
240
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
241
241
  *
242
242
  * This function is not a universal function and runs only on the backend.
243
243
  * @param _id - ID of the phase to update.
@@ -302,7 +302,7 @@ export function updatePhase(_id, options) {
302
302
  * When omitted, the newly created phase is added as the last non-win phase.
303
303
  *
304
304
  *
305
- * 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).
305
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
306
306
  *
307
307
  * This function is not a universal function and runs only on the backend.
308
308
  * @param workflowId - ID of the workflow to create the phase in.
@@ -366,7 +366,7 @@ export function createPhase(workflowId, options) {
366
366
  * The `deletePhase()` function returns a Promise when the specified phase has been deleted.
367
367
  *
368
368
  *
369
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
369
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
370
370
  *
371
371
  * This function is not a universal function and runs only on the backend.
372
372
  * @param _id - ID of the phase to delete.
@@ -426,7 +426,7 @@ export function deletePhase(_id) {
426
426
  * Use the `options` parameter to specify the new phase position within the workflow. Any non-win phase can be moved to any non-win position. The win phase cannot be moved. Positions are zero-based, meaning the first position is `0`.
427
427
  *
428
428
  *
429
- * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
429
+ * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
430
430
  *
431
431
  * This function is not a universal function and runs only on the backend.
432
432
  * @param newPosition - New phase position, where the first phase is `0`.
package/build/es/src/workflows-v1-workflow.http.d.ts CHANGED
@@ -32,7 +32,7 @@ export declare function queryWorkflows(payload: QueryWorkflowsRequest): RequestO
32
32
  * The `getWorkflowInfo()` function returns a Promise that resolves to the workflow info with the specified ID.
33
33
  *
34
34
  *
35
- * 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).
35
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
36
36
  */
37
37
  export declare function getWorkflow(payload: GetWorkflowRequest): RequestOptionsFactory<GetWorkflowResponse>;
38
38
  /**
@@ -62,7 +62,7 @@ export declare function createWorkflow(payload: CreateWorkflowRequest): RequestO
62
62
  * The `deleteWorkflow()` function returns a Promise when the specified workflow has been deleted.
63
63
  *
64
64
  *
65
- * 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).
65
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
66
66
  */
67
67
  export declare function deleteWorkflow(payload: DeleteWorkflowRequest): RequestOptionsFactory<DeleteWorkflowResponse>;
68
68
  /** Sets up the default workflow. */
package/build/es/src/workflows-v1-workflow.http.js CHANGED
@@ -149,7 +149,7 @@ export function queryWorkflows(payload) {
149
149
  * The `getWorkflowInfo()` function returns a Promise that resolves to the workflow info with the specified ID.
150
150
  *
151
151
  *
152
- * 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).
152
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
153
153
  */
154
154
  export function getWorkflow(payload) {
155
155
  const { toJSON: toReq, fromJSON: fromReq } = serializer(_getWorkflowRequest, {});
@@ -250,7 +250,7 @@ export function createWorkflow(payload) {
250
250
  * The `deleteWorkflow()` function returns a Promise when the specified workflow has been deleted.
251
251
  *
252
252
  *
253
- * 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).
253
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
254
254
  */
255
255
  export function deleteWorkflow(payload) {
256
256
  const { toJSON: toReq, fromJSON: fromReq } = serializer(_deleteWorkflowRequest, {});
package/build/es/src/workflows-v1-workflow.universal.d.ts CHANGED
@@ -345,7 +345,7 @@ export interface QueryWorkflowsOptions {
345
345
  * The `getWorkflowInfo()` function returns a Promise that resolves to the workflow info with the specified ID.
346
346
  *
347
347
  *
348
- * 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).
348
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
349
349
  *
350
350
  * This function is not a universal function and runs only on the backend.
351
351
  * @param _id - ID of the workflow to retrieve.
@@ -409,7 +409,7 @@ export interface CreateWorkflowOptions {
409
409
  * The `deleteWorkflow()` function returns a Promise when the specified workflow has been deleted.
410
410
  *
411
411
  *
412
- * 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).
412
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
413
413
  *
414
414
  * This function is not a universal function and runs only on the backend.
415
415
  * @param _id - ID of the workflow to delete.
package/build/es/src/workflows-v1-workflow.universal.js CHANGED
@@ -177,7 +177,7 @@ export function queryWorkflows(options) {
177
177
  * The `getWorkflowInfo()` function returns a Promise that resolves to the workflow info with the specified ID.
178
178
  *
179
179
  *
180
- * 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).
180
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
181
181
  *
182
182
  * This function is not a universal function and runs only on the backend.
183
183
  * @param _id - ID of the workflow to retrieve.
@@ -355,7 +355,7 @@ export function createWorkflow(options) {
355
355
  * The `deleteWorkflow()` function returns a Promise when the specified workflow has been deleted.
356
356
  *
357
357
  *
358
- * 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).
358
+ * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
359
359
  *
360
360
  * This function is not a universal function and runs only on the backend.
361
361
  * @param _id - ID of the workflow to delete.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/workflows",
3
- "version": "1.0.4",
3
+ "version": "1.0.5",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -33,5 +33,5 @@
33
33
  "groupId": "com.wixpress.public-sdk-autogen"
34
34
  }
35
35
  },
36
- "falconPackageHash": "4a667f7ca1d81e16f049c5f4eb15242c3f7eaae06578d7fcd9da53ac"
36
+ "falconPackageHash": "ba39e4a6bc0028da6d2f489c4145954016b93b0adea25221f16af9a8"
37
37
  }