@wix/workflows 1.0.3 → 1.0.5

package/build/cjs/src/workflows-v1-card.http.d.ts

@@ -27,7 +27,7 @@ export declare function queryCards(payload: QueryCardsRequest): RequestOptionsFa
  * Sort order defaults to by `"phaseId"` and then by `"position"` ascending.
  *
  *
- * 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).
+ * 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).
  */
 export declare function listCards(payload: ListCardsRequest): RequestOptionsFactory<ListCardsResponse>;
 /**
@@ -37,7 +37,7 @@ export declare function listCards(payload: ListCardsRequest): RequestOptionsFact
  * The `getCard()` function returns a Promise that resolves to the card with the specified ID.
  *
  *
- * 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).
+ * 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).
  */
 export declare function getCard(payload: GetCardRequest): RequestOptionsFactory<GetCardResponse>;
 /**
@@ -50,7 +50,7 @@ export declare function getCard(payload: GetCardRequest): RequestOptionsFactory<
  * `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.
  *
  *
- * 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).
+ * 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).
  */
 export declare function updateCard(payload: UpdateCardRequest): RequestOptionsFactory<UpdateCardResponse>;
 /**
@@ -64,7 +64,7 @@ export declare function updateCard(payload: UpdateCardRequest): RequestOptionsFa
  * When omitted, the newly created card is added to the specified phase as the top card within the phase.
  *
  *
- * 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).
+ * 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).
  *
  *  > **Note:**
  *  > Each workflow is limited to 5,000 cards.
@@ -79,7 +79,7 @@ export declare function createCard(payload: CreateCardRequest): RequestOptionsFa
  *
  * The `deleteCard()` function returns a Promise when the specified card has been deleted.
  *
- * 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).
+ * 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).
  */
 export declare function deleteCard(payload: DeleteCardRequest): RequestOptionsFactory<DeleteCardResponse>;
 /**
@@ -90,7 +90,7 @@ export declare function deleteCard(payload: DeleteCardRequest): RequestOptionsFa
  *
  * 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`.
  *
- * 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).
+ * 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).
  */
 export declare function moveCard(payload: MoveCardRequest): RequestOptionsFactory<MoveCardResponse>;
 /**
@@ -100,7 +100,7 @@ export declare function moveCard(payload: MoveCardRequest): RequestOptionsFactor
  * The `restoreCard()` function returns a Promise that resolves when the archived card has been restored.
  *
  *
- * 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).
+ * 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).
  *
  *
  * > **Note:**
@@ -117,6 +117,6 @@ export declare function restoreCard(payload: RestoreCardRequest): RequestOptions
  * The `archiveCard()` function returns a Promise that resolves when the card has been archived.
  *
  *
- * 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).
+ * 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).
  */
 export declare function archiveCard(payload: ArchiveCardRequest): RequestOptionsFactory<ArchiveCardResponse>;

package/build/cjs/src/workflows-v1-card.http.js

@@ -111,7 +111,7 @@ exports.queryCards = queryCards;
  * Sort order defaults to by `"phaseId"` and then by `"position"` ascending.
  *
  *
- * 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).
+ * 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).
  */
 function listCards(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_listCardsRequest, {});
@@ -146,7 +146,7 @@ exports.listCards = listCards;
  * The `getCard()` function returns a Promise that resolves to the card with the specified ID.
  *
  *
- * 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).
+ * 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).
  */
 function getCard(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_getCardRequest, {});
@@ -184,7 +184,7 @@ exports.getCard = getCard;
  * `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.
  *
  *
- * 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).
+ * 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).
  */
 function updateCard(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_updateCardRequest, {
@@ -222,7 +222,7 @@ exports.updateCard = updateCard;
  * When omitted, the newly created card is added to the specified phase as the top card within the phase.
  *
  *
- * 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).
+ * 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).
  *
  *  > **Note:**
  *  > Each workflow is limited to 5,000 cards.
@@ -261,7 +261,7 @@ exports.createCard = createCard;
  *
  * The `deleteCard()` function returns a Promise when the specified card has been deleted.
  *
- * 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).
+ * 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).
  */
 function deleteCard(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_deleteCardRequest, {});
@@ -294,7 +294,7 @@ exports.deleteCard = deleteCard;
  *
  * 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`.
  *
- * 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).
+ * 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).
  */
 function moveCard(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_moveCardRequest, {});
@@ -326,7 +326,7 @@ exports.moveCard = moveCard;
  * The `restoreCard()` function returns a Promise that resolves when the archived card has been restored.
  *
  *
- * 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).
+ * 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).
  *
  *
  * > **Note:**
@@ -365,7 +365,7 @@ exports.restoreCard = restoreCard;
  * The `archiveCard()` function returns a Promise that resolves when the card has been archived.
  *
  *
- * 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).
+ * 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).
  */
 function archiveCard(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_archiveCardRequest, {});

package/build/cjs/src/workflows-v1-card.universal.d.ts

@@ -280,7 +280,7 @@ export interface QueryCardsOptions {
  * Sort order defaults to by `"phaseId"` and then by `"position"` ascending.
  *
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param workflowId - ID of the workflow whose cards will be listed.
@@ -336,7 +336,7 @@ export interface ListCardsOptions {
  * The `getCard()` function returns a Promise that resolves to the card with the specified ID.
  *
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param _id - ID of the card to retrieve.
@@ -354,7 +354,7 @@ export declare function getCard(_id: string): Promise<GetCardResponse>;
  * `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.
  *
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param _id - ID of the card to update.
@@ -378,7 +378,7 @@ export interface UpdateCardOptions {
  * When omitted, the newly created card is added to the specified phase as the top card within the phase.
  *
  *
- * 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).
+ * 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).
  *
  *  > **Note:**
  *  > Each workflow is limited to 5,000 cards.
@@ -419,7 +419,7 @@ export interface CreateCardOptions {
  *
  * The `deleteCard()` function returns a Promise when the specified card has been deleted.
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param _id - ID of the card to delete.
@@ -435,7 +435,7 @@ export declare function deleteCard(_id: string): Promise<void>;
  *
  * 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`.
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param _id - ID of the card to move.
@@ -457,7 +457,7 @@ export interface MoveCardOptions {
  * The `restoreCard()` function returns a Promise that resolves when the archived card has been restored.
  *
  *
- * 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).
+ * 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).
  *
  *
  * > **Note:**
@@ -489,7 +489,7 @@ export interface RestoreCardOptions {
  * The `archiveCard()` function returns a Promise that resolves when the card has been archived.
  *
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param _id - ID of the card to archive.

package/build/cjs/src/workflows-v1-card.universal.js

@@ -149,7 +149,7 @@ exports.queryCards = queryCards;
  * Sort order defaults to by `"phaseId"` and then by `"position"` ascending.
  *
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param workflowId - ID of the workflow whose cards will be listed.
@@ -217,7 +217,7 @@ exports.listCards = listCards;
  * The `getCard()` function returns a Promise that resolves to the card with the specified ID.
  *
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param _id - ID of the card to retrieve.
@@ -278,7 +278,7 @@ exports.getCard = getCard;
  * `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.
  *
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param _id - ID of the card to update.
@@ -342,7 +342,7 @@ exports.updateCard = updateCard;
  * When omitted, the newly created card is added to the specified phase as the top card within the phase.
  *
  *
- * 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).
+ * 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).
  *
  *  > **Note:**
  *  > Each workflow is limited to 5,000 cards.
@@ -413,7 +413,7 @@ exports.createCard = createCard;
  *
  * The `deleteCard()` function returns a Promise when the specified card has been deleted.
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param _id - ID of the card to delete.
@@ -472,7 +472,7 @@ exports.deleteCard = deleteCard;
  *
  * 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`.
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param _id - ID of the card to move.
@@ -536,7 +536,7 @@ exports.moveCard = moveCard;
  * The `restoreCard()` function returns a Promise that resolves when the archived card has been restored.
  *
  *
- * 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).
+ * 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).
  *
  *
  * > **Note:**
@@ -610,7 +610,7 @@ exports.restoreCard = restoreCard;
  * The `archiveCard()` function returns a Promise that resolves when the card has been archived.
  *
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param _id - ID of the card to archive.

package/build/cjs/src/workflows-v1-phase.http.d.ts

@@ -20,7 +20,7 @@ export declare function queryPhases(payload: QueryPhasesRequest): RequestOptions
  * 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.
  *
  *
- * 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).
+ * 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).
  */
 export declare function listPhases(payload: ListPhasesRequest): RequestOptionsFactory<ListPhasesResponse>;
 /**
@@ -29,7 +29,7 @@ export declare function listPhases(payload: ListPhasesRequest): RequestOptionsFa
  *
  * The `getPhaseInfo()` function returns a Promise that resolves to the phase with the specified ID.
  *
- * 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).
+ * 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).
  */
 export declare function getPhase(payload: GetPhaseRequest): RequestOptionsFactory<GetPhaseResponse>;
 /**
@@ -42,7 +42,7 @@ export declare function getPhase(payload: GetPhaseRequest): RequestOptionsFactor
  * Only the properties passed in the `Phase` object will be updated. All other properties will remain the same.
  *
  *
- * 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).
+ * 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).
  */
 export declare function updatePhase(payload: UpdatePhaseRequest): RequestOptionsFactory<UpdatePhaseResponse>;
 /**
@@ -58,7 +58,7 @@ export declare function updatePhase(payload: UpdatePhaseRequest): RequestOptions
  * When omitted, the newly created phase is added as the last non-win phase.
  *
  *
- * 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).
+ * 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).
  */
 export declare function createPhase(payload: CreatePhaseRequest): RequestOptionsFactory<CreatePhaseResponse>;
 /**
@@ -68,7 +68,7 @@ export declare function createPhase(payload: CreatePhaseRequest): RequestOptions
  * The `deletePhase()` function returns a Promise when the specified phase has been deleted.
  *
  *
- * 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).
+ * 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).
  */
 export declare function deletePhase(payload: DeletePhaseRequest): RequestOptionsFactory<DeletePhaseResponse>;
 /**
@@ -81,6 +81,6 @@ export declare function deletePhase(payload: DeletePhaseRequest): RequestOptions
  * 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`.
  *
  *
- * 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).
+ * 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).
  */
 export declare function movePhase(payload: MovePhaseRequest): RequestOptionsFactory<MovePhaseResponse>;

package/build/cjs/src/workflows-v1-phase.http.js

@@ -104,7 +104,7 @@ exports.queryPhases = queryPhases;
  * 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.
  *
  *
- * 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).
+ * 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).
  */
 function listPhases(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_listPhasesRequest, {});
@@ -140,7 +140,7 @@ exports.listPhases = listPhases;
  *
  * The `getPhaseInfo()` function returns a Promise that resolves to the phase with the specified ID.
  *
- * 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).
+ * 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).
  */
 function getPhase(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_getPhaseRequest, {});
@@ -180,7 +180,7 @@ exports.getPhase = getPhase;
  * Only the properties passed in the `Phase` object will be updated. All other properties will remain the same.
  *
  *
- * 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).
+ * 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).
  */
 function updatePhase(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_updatePhaseRequest, {});
@@ -218,7 +218,7 @@ exports.updatePhase = updatePhase;
  * When omitted, the newly created phase is added as the last non-win phase.
  *
  *
- * 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).
+ * 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).
  */
 function createPhase(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_createPhaseRequest, {});
@@ -250,7 +250,7 @@ exports.createPhase = createPhase;
  * The `deletePhase()` function returns a Promise when the specified phase has been deleted.
  *
  *
- * 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).
+ * 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).
  */
 function deletePhase(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_deletePhaseRequest, {});
@@ -285,7 +285,7 @@ exports.deletePhase = deletePhase;
  * 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`.
  *
  *
- * 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).
+ * 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).
  */
 function movePhase(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_movePhaseRequest, {});

package/build/cjs/src/workflows-v1-phase.universal.d.ts

@@ -266,7 +266,7 @@ export interface QueryPhasesOptions {
  * 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.
  *
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param workflowId - ID of the workflow whose phases will be listed.
@@ -303,7 +303,7 @@ export interface ListPhasesOptions {
  *
  * The `getPhaseInfo()` function returns a Promise that resolves to the phase with the specified ID.
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param _id - ID of the phase to retrieve.
@@ -321,7 +321,7 @@ export declare function getPhase(_id: string): Promise<GetPhaseResponse>;
  * Only the properties passed in the `Phase` object will be updated. All other properties will remain the same.
  *
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param _id - ID of the phase to update.
@@ -347,7 +347,7 @@ export interface UpdatePhaseOptions {
  * When omitted, the newly created phase is added as the last non-win phase.
  *
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param workflowId - ID of the workflow to create the phase in.
@@ -379,7 +379,7 @@ export interface CreatePhaseOptions {
  * The `deletePhase()` function returns a Promise when the specified phase has been deleted.
  *
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param _id - ID of the phase to delete.
@@ -397,7 +397,7 @@ export declare function deletePhase(_id: string): Promise<void>;
  * 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`.
  *
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param newPosition - New phase position, where the first phase is `0`.

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

@@ -137,7 +137,7 @@ exports.queryPhases = queryPhases;
  * 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.
  *
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param workflowId - ID of the workflow whose phases will be listed.
@@ -201,7 +201,7 @@ exports.listPhases = listPhases;
  *
  * The `getPhaseInfo()` function returns a Promise that resolves to the phase with the specified ID.
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param _id - ID of the phase to retrieve.
@@ -262,7 +262,7 @@ exports.getPhase = getPhase;
  * Only the properties passed in the `Phase` object will be updated. All other properties will remain the same.
  *
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param _id - ID of the phase to update.
@@ -328,7 +328,7 @@ exports.updatePhase = updatePhase;
  * When omitted, the newly created phase is added as the last non-win phase.
  *
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param workflowId - ID of the workflow to create the phase in.
@@ -393,7 +393,7 @@ exports.createPhase = createPhase;
  * The `deletePhase()` function returns a Promise when the specified phase has been deleted.
  *
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param _id - ID of the phase to delete.
@@ -454,7 +454,7 @@ exports.deletePhase = deletePhase;
  * 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`.
  *
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param newPosition - New phase position, where the first phase is `0`.

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

@@ -32,7 +32,7 @@ export declare function queryWorkflows(payload: QueryWorkflowsRequest): RequestO
  * The `getWorkflowInfo()` function returns a Promise that resolves to the workflow info with the specified ID.
  *
  *
- * 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).
+ * 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).
  */
 export declare function getWorkflow(payload: GetWorkflowRequest): RequestOptionsFactory<GetWorkflowResponse>;
 /**
@@ -62,7 +62,7 @@ export declare function createWorkflow(payload: CreateWorkflowRequest): RequestO
  * The `deleteWorkflow()` function returns a Promise when the specified workflow has been deleted.
  *
  *
- * 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).
+ * 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).
  */
 export declare function deleteWorkflow(payload: DeleteWorkflowRequest): RequestOptionsFactory<DeleteWorkflowResponse>;
 /** Sets up the default workflow. */

package/build/cjs/src/workflows-v1-workflow.http.js

@@ -154,7 +154,7 @@ exports.queryWorkflows = queryWorkflows;
  * The `getWorkflowInfo()` function returns a Promise that resolves to the workflow info with the specified ID.
  *
  *
- * 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).
+ * 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).
  */
 function getWorkflow(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_getWorkflowRequest, {});
@@ -258,7 +258,7 @@ exports.createWorkflow = createWorkflow;
  * The `deleteWorkflow()` function returns a Promise when the specified workflow has been deleted.
  *
  *
- * 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).
+ * 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).
  */
 function deleteWorkflow(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_deleteWorkflowRequest, {});

package/build/cjs/src/workflows-v1-workflow.universal.d.ts

@@ -345,7 +345,7 @@ export interface QueryWorkflowsOptions {
  * The `getWorkflowInfo()` function returns a Promise that resolves to the workflow info with the specified ID.
  *
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param _id - ID of the workflow to retrieve.
@@ -379,6 +379,7 @@ export interface GetWorkflowOptions {
  * @param _id - ID of the workflow to update.
  * @public
  * @requiredField _id
+ * @param options - Options to use when updating a workflow.
  */
 export declare function updateWorkflow(_id: string, options?: UpdateWorkflowOptions): Promise<void>;
 export interface UpdateWorkflowOptions {
@@ -394,6 +395,7 @@ export interface UpdateWorkflowOptions {
  * This function is not a universal function and runs only on the backend.
  * @public
  * @requiredField options.workflow.name
+ * @param options - Options to use when creating a workflow.
  */
 export declare function createWorkflow(options?: CreateWorkflowOptions): Promise<CreateWorkflowResponse>;
 export interface CreateWorkflowOptions {
@@ -407,7 +409,7 @@ export interface CreateWorkflowOptions {
  * The `deleteWorkflow()` function returns a Promise when the specified workflow has been deleted.
  *
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param _id - ID of the workflow to delete.

package/build/cjs/src/workflows-v1-workflow.universal.js

@@ -201,7 +201,7 @@ exports.queryWorkflows = queryWorkflows;
  * The `getWorkflowInfo()` function returns a Promise that resolves to the workflow info with the specified ID.
  *
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param _id - ID of the workflow to retrieve.
@@ -273,6 +273,7 @@ exports.getWorkflow = getWorkflow;
  * @param _id - ID of the workflow to update.
  * @public
  * @requiredField _id
+ * @param options - Options to use when updating a workflow.
  */
 function updateWorkflow(_id, options) {
     var _a, _b, _c;
@@ -328,6 +329,7 @@ exports.updateWorkflow = updateWorkflow;
  * This function is not a universal function and runs only on the backend.
  * @public
  * @requiredField options.workflow.name
+ * @param options - Options to use when creating a workflow.
  */
 function createWorkflow(options) {
     var _a, _b, _c;
@@ -380,7 +382,7 @@ exports.createWorkflow = createWorkflow;
  * The `deleteWorkflow()` function returns a Promise when the specified workflow has been deleted.
  *
  *
- * 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).
+ * 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).
  *
  * This function is not a universal function and runs only on the backend.
  * @param _id - ID of the workflow to delete.