@wix/auto_sdk_crm_pipelines 1.0.0 → 1.0.1

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 (41) hide show
  1. package/build/cjs/index.d.ts +76 -130
  2. package/build/cjs/index.js +194 -977
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +998 -15
  5. package/build/cjs/index.typings.js +146 -767
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +133 -1005
  8. package/build/cjs/meta.js +128 -682
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +76 -130
  11. package/build/es/index.mjs +184 -947
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +998 -15
  14. package/build/es/index.typings.mjs +138 -743
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +133 -1005
  17. package/build/es/meta.mjs +121 -659
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/internal/cjs/index.d.ts +76 -163
  20. package/build/internal/cjs/index.js +194 -977
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +998 -15
  23. package/build/internal/cjs/index.typings.js +146 -767
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +133 -1005
  26. package/build/internal/cjs/meta.js +128 -682
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/internal/es/index.d.mts +76 -163
  29. package/build/internal/es/index.mjs +184 -947
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +998 -15
  32. package/build/internal/es/index.typings.mjs +138 -743
  33. package/build/internal/es/index.typings.mjs.map +1 -1
  34. package/build/internal/es/meta.d.mts +133 -1005
  35. package/build/internal/es/meta.mjs +121 -659
  36. package/build/internal/es/meta.mjs.map +1 -1
  37. package/package.json +3 -3
  38. package/build/cjs/crm-pipelines-v1-card-pipelines.universal-DGtqU_Zb.d.ts +0 -2265
  39. package/build/es/crm-pipelines-v1-card-pipelines.universal-DGtqU_Zb.d.mts +0 -2265
  40. package/build/internal/cjs/crm-pipelines-v1-card-pipelines.universal-BHszxzqA.d.ts +0 -2303
  41. package/build/internal/es/crm-pipelines-v1-card-pipelines.universal-BHszxzqA.d.mts +0 -2303
@@ -1,202 +1,115 @@
1
1
  import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
2
- import { C as CreateCardOptions, a as Card, b as CreateCardApplicationErrors, U as UpdateCardOptions, c as UpdateCardApplicationErrors, M as MoveCardOptions, d as MoveCardResponse, e as MoveCardApplicationErrors, f as CardSearch, S as SearchCardsOptions, g as SearchCardsResponse, h as SearchCardsByStageOptions, i as SearchCardsByStageResponse, B as BulkCreateCardsOptions, j as BulkCreateCardsResponse, k as MaskedCard, l as BulkUpdateCardsOptions, m as BulkUpdateCardsResponse, n as BulkDeleteCardsResponse, o as BulkUpdateCardTagsOptions, p as BulkUpdateCardTagsResponse, q as BulkUpdateCardTagsApplicationErrors, r as BulkUpdateCardTagsByFilterOptions, s as BulkUpdateCardTagsByFilterResponse, t as BulkUpdateCardTagsByFilterApplicationErrors, u as CardAssignedEnvelope, v as CardCreatedEnvelope, w as CardDeletedEnvelope, x as CardMovedEnvelope, y as CardOverdueEnvelope, z as CardStaleEnvelope, A as CardUpdatedEnvelope, D as CardsQueryBuilder, E as CardQuery, F as typedQueryCards } from './crm-pipelines-v1-card-pipelines.universal-BHszxzqA.mjs';
3
- export { bl as AccountInfo, bo as AccountInfoMetadata, bg as ActionEvent, aq as Aggregation, aD as AggregationData, ar as AggregationKindOneOf, aW as AggregationResults, aX as AggregationResultsResultOneOf, aK as AggregationResultsScalarResult, Q as AggregationType, bC as AggregationTypeWithLiterals, b0 as ApplicationError, bm as BaseEventMetadata, b2 as BulkActionMetadata, b1 as BulkCardResult, a_ as BulkCreateCardsRequest, b5 as BulkDeleteCardsRequest, b6 as BulkDeleteCardsResponseBulkCardResult, aZ as BulkSearchCardsResult, b9 as BulkUpdateCardTagsByFilterRequest, b7 as BulkUpdateCardTagsRequest, b8 as BulkUpdateCardTagsResult, b3 as BulkUpdateCardsRequest, b4 as BulkUpdateCardsResponseBulkCardResult, a2 as CardAssigned, a1 as CardMoved, a3 as CardOverdue, bq as CardQuerySpec, br as CardSearchSpec, V as CardSource, a4 as CardStale, bp as CardsQueryResult, bG as CommonQueryWithEntityContext, bH as CommonSearchWithEntityContext, Y as ContactInfo, a7 as ContactsNotFound, a5 as CreateCardRequest, a6 as CreateCardResponse, aj as CursorPaging, al as CursorPagingMetadata, ag as CursorQuery, ah as CursorQueryPagingMethodOneOf, ao as CursorSearch, ap as CursorSearchPagingMethodOneOf, am as Cursors, ay as DateHistogramAggregation, aS as DateHistogramResult, aU as DateHistogramResults, ad as DeleteCardRequest, ae as DeleteCardResponse, ba as DomainEvent, bb as DomainEventBodyOneOf, bh as Empty, bc as EntityCreatedEvent, bf as EntityDeletedEvent, be as EntityUpdatedEvent, bn as EventMetadata, _ as ExtendedFields, a8 as GetCardRequest, a9 as GetCardResponse, aT as GroupByValueResults, bj as IdentificationData, bk as IdentificationDataIdOneOf, at as IncludeMissingValuesOptions, L as Interval, bB as IntervalWithLiterals, a$ as ItemMetadata, Z as LinkedEntity, bi as MessageEnvelope, J as MissingValues, by as MissingValuesWithLiterals, R as Mode, bD as ModeWithLiterals, X as Money, ac as MoveCardRequest, T as NameFormat, bE as NameFormatWithLiterals, aB as NestedAggregation, az as NestedAggregationItem, aA as NestedAggregationItemKindOneOf, aG as NestedAggregationResults, aH as NestedAggregationResultsResultOneOf, N as NestedAggregationType, bA as NestedAggregationTypeWithLiterals, aP as NestedResultValue, aQ as NestedResultValueResultOneOf, aV as NestedResults, aL as NestedValueAggregationResult, O as Outcome, bu as OutcomeWithLiterals, P as Priority, bt as PriorityWithLiterals, $ as PrivateTags, af as QueryCardsRequest, ak as QueryCardsResponse, aw as RangeAggregation, aF as RangeAggregationResult, as as RangeBucket, aN as RangeResult, aJ as RangeResults, bd as RestoreInfo, aR as Results, ax as ScalarAggregation, aO as ScalarResult, K as ScalarType, bz as ScalarTypeWithLiterals, aY as SearchCardsByStageRequest, an as SearchCardsRequest, aC as SearchDetails, I as SortDirection, bx as SortDirectionWithLiterals, G as SortOrder, bv as SortOrderWithLiterals, H as SortType, bw as SortTypeWithLiterals, ai as Sorting, a0 as TagList, aa as UpdateCardRequest, ab as UpdateCardResponse, au as ValueAggregation, av as ValueAggregationOptionsOneOf, aE as ValueAggregationResult, aM as ValueResult, aI as ValueResults, W as WebhookIdentityType, bF as WebhookIdentityTypeWithLiterals, bs as utils } from './crm-pipelines-v1-card-pipelines.universal-BHszxzqA.mjs';
2
+ import { Pipeline, UpdatePipeline, UpdatePipelineApplicationErrors, DeletePipelineApplicationErrors, BulkUpdatePipelineTagsOptions, BulkUpdatePipelineTagsResponse, BulkUpdatePipelineTagsApplicationErrors, BulkUpdatePipelineTagsByFilterOptions, BulkUpdatePipelineTagsByFilterResponse, BulkUpdatePipelineTagsByFilterApplicationErrors, PipelineCreatedEnvelope, PipelineDeletedEnvelope, PipelineUpdatedEnvelope, PipelinesQueryBuilder, PipelineQuery, typedQueryPipelines } from './index.typings.mjs';
3
+ export { AccountInfo, AccountInfoMetadata, ActionEvent, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkUpdatePipelineTagsByFilterRequest, BulkUpdatePipelineTagsRequest, BulkUpdatePipelineTagsResult, CommonQueryWithEntityContext, CreatePipelineRequest, CreatePipelineResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeletePipelineRequest, DeletePipelineResponse, DomainEvent, DomainEventBodyOneOf, DoneStage, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, GetPipelineRequest, GetPipelineResponse, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, MessageEnvelope, Outcome, OutcomeWithLiterals, PipelineQuerySpec, PipelinesQueryResult, PrivateTags, QueryPipelinesRequest, QueryPipelinesResponse, RestoreInfo, SortOrder, SortOrderWithLiterals, Sorting, Stage, TagList, UpdatePipelineRequest, UpdatePipelineResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, utils } from './index.typings.mjs';
4
4
 
5
- declare function createCard$1(httpClient: HttpClient): CreateCardSignature;
6
- interface CreateCardSignature {
5
+ declare function createPipeline$1(httpClient: HttpClient): CreatePipelineSignature;
6
+ interface CreatePipelineSignature {
7
7
  /**
8
- * Creates a card in a specific pipeline stage.
9
- * @returns Created card.
10
- */
11
- (options?: NonNullablePaths<CreateCardOptions, `card.name` | `card.pipelineId` | `card.stageId`, 3>): Promise<NonNullablePaths<Card, `priority` | `value.value` | `value.currency` | `outcome` | `additionalContacts` | `linkedEntities` | `linkedEntities.${number}.entityId` | `linkedEntities.${number}.referencedEntity` | `tags.privateTags.tagIds`, 4> & {
12
- __applicationErrorsType?: CreateCardApplicationErrors;
13
- }>;
14
- }
15
- declare function getCard$1(httpClient: HttpClient): GetCardSignature;
16
- interface GetCardSignature {
17
- /**
18
- * Retrieves a card by ID.
19
- * @param - Card ID to retrieve.
20
- * @returns Retrieved card.
21
- */
22
- (cardId: string): Promise<NonNullablePaths<Card, `priority` | `value.value` | `value.currency` | `outcome` | `additionalContacts` | `linkedEntities` | `linkedEntities.${number}.entityId` | `linkedEntities.${number}.referencedEntity` | `tags.privateTags.tagIds`, 4>>;
23
- }
24
- declare function updateCard$1(httpClient: HttpClient): UpdateCardSignature;
25
- interface UpdateCardSignature {
26
- /**
27
- * Updates a card by ID.
28
- *
29
- * Each time the card is updated, `revision` increments by 1. The current `revision` must be specified when updating the card. This ensures you're working with the latest card and prevents unintended overwrites.
8
+ * Creates a pipeline with defined stages and a final stage.
30
9
  *
31
- * The card's `pipelineId` and `currency` fields can't be updated.
32
- * @param - Card ID.
33
- * @returns Updated card.
10
+ * Pipelines must have at least one stage in addition to the `doneStage`.
11
+ * You must specify allowed outcomes that cards can have when moved to the final stage.
12
+ * @param - Pipeline to create.
13
+ * @returns Created pipeline.
34
14
  */
35
- (_id: string, options?: UpdateCardOptions): Promise<NonNullablePaths<Card, `priority` | `value.value` | `value.currency` | `outcome` | `additionalContacts` | `linkedEntities` | `linkedEntities.${number}.entityId` | `linkedEntities.${number}.referencedEntity` | `tags.privateTags.tagIds`, 4> & {
36
- __applicationErrorsType?: UpdateCardApplicationErrors;
37
- }>;
15
+ (pipeline: NonNullablePaths<Pipeline, `doneStage` | `doneStage.allowedOutcomes` | `doneStage.name` | `name` | `stages` | `stages.${number}.name`, 4>): Promise<NonNullablePaths<Pipeline, `stages` | `doneStage.allowedOutcomes` | `tags.privateTags.tagIds`, 4>>;
38
16
  }
39
- declare function moveCard$1(httpClient: HttpClient): MoveCardSignature;
40
- interface MoveCardSignature {
17
+ declare function getPipeline$1(httpClient: HttpClient): GetPipelineSignature;
18
+ interface GetPipelineSignature {
41
19
  /**
42
- * Moves a card to a different stage within the same pipeline.
43
- *
44
- * Cards can only be moved between stages within the same pipeline.
45
- *
46
- * Each time a card is moved, its `revision` increments by 1.
47
- * @param - Card ID to move.
48
- * @param - ID of the stage to move the card to.
20
+ * Retrieves a pipeline by ID.
21
+ * @param - Pipeline ID to retrieve.
22
+ * @returns Retrieved pipeline.
49
23
  */
50
- (cardId: string, stageId: string, options?: NonNullablePaths<MoveCardOptions, `revision`, 2>): Promise<NonNullablePaths<MoveCardResponse, `card.priority` | `card.value.value` | `card.value.currency` | `card.outcome` | `card.additionalContacts` | `card.linkedEntities` | `card.linkedEntities.${number}.entityId` | `card.linkedEntities.${number}.referencedEntity` | `card.tags.privateTags.tagIds`, 5> & {
51
- __applicationErrorsType?: MoveCardApplicationErrors;
52
- }>;
24
+ (pipelineId: string): Promise<NonNullablePaths<Pipeline, `stages` | `doneStage.allowedOutcomes` | `tags.privateTags.tagIds`, 4>>;
53
25
  }
54
- declare function deleteCard$1(httpClient: HttpClient): DeleteCardSignature;
55
- interface DeleteCardSignature {
26
+ declare function updatePipeline$1(httpClient: HttpClient): UpdatePipelineSignature;
27
+ interface UpdatePipelineSignature {
56
28
  /**
57
- * Deletes a card.
29
+ * Updates a pipeline.
58
30
  *
59
- * Deleting a card permanently removes it from a site.
60
- * @param - Card ID to delete.
61
- */
62
- (cardId: string): Promise<void>;
63
- }
64
- declare function searchCards$1(httpClient: HttpClient): SearchCardsSignature;
65
- interface SearchCardsSignature {
66
- /**
67
- * Retrieves a list of cards given the provided free-text search expression, filtering, and sorting.
31
+ * Each time the pipeline is updated, `revision` increments by 1. The current `revision` must be specified when updating the pipeline. This ensures you're working with the latest pipeline and prevents unintended overwrites.
68
32
  *
69
- * By default, cards are sorted by `updatedDate` in descending order.
33
+ * >**Note:**
34
+ * > You can add and remove stages by calling this method. However, the done stage and any stages that contain cards can't be removed.
70
35
  *
71
- * For a detailed list of supported filters, sorting options, and search capabilities, see [Cards: Supported Filters, Sorting, and Search](https://dev.wix.com/docs/api-reference/crm/crm/pipelines-wip/card-v1/sort-filter-and-search).
72
- *
73
- * To learn more about working with _Search_ methods, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
74
- * @param - Search options.
36
+ * </blockquote>
37
+ * @param - Pipeline ID.
38
+ * @returns Updated pipeline.
75
39
  */
76
- (search: CardSearch, options?: SearchCardsOptions): Promise<NonNullablePaths<SearchCardsResponse, `cards` | `cards.${number}.priority` | `cards.${number}.value.value` | `cards.${number}.value.currency` | `cards.${number}.outcome` | `aggregationData.results` | `aggregationData.results.${number}.scalar.type` | `aggregationData.results.${number}.scalar.value` | `aggregationData.results.${number}.name` | `aggregationData.results.${number}.type` | `aggregationData.results.${number}.fieldPath`, 6>>;
40
+ (_id: string, pipeline: NonNullablePaths<UpdatePipeline, `revision`, 2>): Promise<NonNullablePaths<Pipeline, `stages` | `doneStage.allowedOutcomes` | `tags.privateTags.tagIds`, 4> & {
41
+ __applicationErrorsType?: UpdatePipelineApplicationErrors;
42
+ }>;
77
43
  }
78
- declare function searchCardsByStage$1(httpClient: HttpClient): SearchCardsByStageSignature;
79
- interface SearchCardsByStageSignature {
44
+ declare function deletePipeline$1(httpClient: HttpClient): DeletePipelineSignature;
45
+ interface DeletePipelineSignature {
80
46
  /**
81
- * Retrieves a list of cards by the pipeline's stage, given the provided free-text search expression, filtering, and sorting.
82
- *
83
- * By default, cards are sorted by `updatedDate` in descending order.
84
- *
85
- * For a detailed list of supported filters, sorting options, and search capabilities, see [Cards: Supported Filters, Sorting, and Search](https://dev.wix.com/docs/api-reference/crm/crm/pipelines-wip/card-v1/sort-filter-and-search).
47
+ * Deletes a pipeline.
86
48
  *
87
- * To learn more about working with _Search_ methods, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
88
- * @param - ID of the pipeline in which to look for cards.
49
+ * >**Notes:**
50
+ * > - You can't delete a pipeline that contains cards. Make sure to remove all cards in the pipeline before calling this method.
51
+ * > - Deleting a pipeline permanently removes it from a site.
52
+ * @param - Pipeline ID.
89
53
  */
90
- (pipelineId: string, options?: NonNullablePaths<SearchCardsByStageOptions, `stageIds`, 2>): Promise<NonNullablePaths<SearchCardsByStageResponse, `results`, 2>>;
91
- }
92
- /** @internal */
93
- declare function bulkCreateCards$1(httpClient: HttpClient): BulkCreateCardsSignature;
94
- interface BulkCreateCardsSignature {
95
- /**
96
- * Creates multiple cards.
97
- * @param - List of cards to create.
98
- */
99
- (cards: NonNullablePaths<Card, `name` | `pipelineId` | `stageId`, 2>[], options?: BulkCreateCardsOptions): Promise<NonNullablePaths<BulkCreateCardsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.priority` | `results.${number}.item.value.value` | `results.${number}.item.value.currency` | `results.${number}.item.outcome` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
100
- }
101
- /** @internal */
102
- declare function bulkUpdateCards$1(httpClient: HttpClient): BulkUpdateCardsSignature;
103
- interface BulkUpdateCardsSignature {
104
- /**
105
- * Updates multiple cards.
106
- * @param - List of cards to update.
107
- */
108
- (cards: NonNullablePaths<MaskedCard, `card._id` | `card.revision`, 3>[], options?: BulkUpdateCardsOptions): Promise<NonNullablePaths<BulkUpdateCardsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.priority` | `results.${number}.item.value.value` | `results.${number}.item.value.currency` | `results.${number}.item.outcome` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
109
- }
110
- /** @internal */
111
- declare function bulkDeleteCards$1(httpClient: HttpClient): BulkDeleteCardsSignature;
112
- interface BulkDeleteCardsSignature {
113
- /**
114
- * Deletes multiple cards.
115
- * @param - Card IDs to delete.
116
- */
117
- (cardIds: string[]): Promise<NonNullablePaths<BulkDeleteCardsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
54
+ (pipelineId: string): Promise<void & {
55
+ __applicationErrorsType?: DeletePipelineApplicationErrors;
56
+ }>;
118
57
  }
119
- declare function bulkUpdateCardTags$1(httpClient: HttpClient): BulkUpdateCardTagsSignature;
120
- interface BulkUpdateCardTagsSignature {
58
+ declare function bulkUpdatePipelineTags$1(httpClient: HttpClient): BulkUpdatePipelineTagsSignature;
59
+ interface BulkUpdatePipelineTagsSignature {
121
60
  /**
122
- * Updates tags on multiple cards by specified card IDs.
61
+ * Updates tags on multiple pipelines by specified pipeline IDs.
123
62
  *
124
- * If you specify a tag that in both `assignTags` and `unassignTags`, the tag is assigned to the cards.
125
- * @param - List of card IDs whose tags will be updated.
63
+ * If you specify a tag in both `assignTags` and `unassignTags`, the tag is assigned to the pipelines.
64
+ * @param - List of pipeline IDs to update.
126
65
  */
127
- (cardIds: string[], options?: BulkUpdateCardTagsOptions): Promise<NonNullablePaths<BulkUpdateCardTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
128
- __applicationErrorsType?: BulkUpdateCardTagsApplicationErrors;
66
+ (pipelineIds: string[], options?: BulkUpdatePipelineTagsOptions): Promise<NonNullablePaths<BulkUpdatePipelineTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
67
+ __applicationErrorsType?: BulkUpdatePipelineTagsApplicationErrors;
129
68
  }>;
130
69
  }
131
- declare function bulkUpdateCardTagsByFilter$1(httpClient: HttpClient): BulkUpdateCardTagsByFilterSignature;
132
- interface BulkUpdateCardTagsByFilterSignature {
70
+ declare function bulkUpdatePipelineTagsByFilter$1(httpClient: HttpClient): BulkUpdatePipelineTagsByFilterSignature;
71
+ interface BulkUpdatePipelineTagsByFilterSignature {
133
72
  /**
134
- * Asynchronously updates tags on multiple cards using a filter to specify which cards to update.
73
+ * Updates tags on multiple pipelines, using a filter to select which pipelines to update.
135
74
  *
136
- * An empty filter updates all cards in the pipeline.
75
+ * If you don't specify a filter, all pipelines on the site are updated.
76
+ * If you specify a tag in both `assignTags` and `unassignTags`, the tag is assigned to the pipelines.
137
77
  *
138
- * If you specify a tag in both `assignTags` and `unassignTags`, the tag is assigned to the cards.
139
- * @param - Filter object.
78
+ * > **Note:**
79
+ * > This is an asynchronous method that returns a job ID for tracking progress.
80
+ * To get the status of the job, call [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job).
81
+ * @param - Filter to select which pipelines to update.
140
82
  */
141
- (filter: Record<string, any>, options?: BulkUpdateCardTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateCardTagsByFilterResponse, `jobId`, 2> & {
142
- __applicationErrorsType?: BulkUpdateCardTagsByFilterApplicationErrors;
83
+ (filter: Record<string, any>, options?: BulkUpdatePipelineTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdatePipelineTagsByFilterResponse, `jobId`, 2> & {
84
+ __applicationErrorsType?: BulkUpdatePipelineTagsByFilterApplicationErrors;
143
85
  }>;
144
86
  }
145
- declare const onCardAssigned$1: EventDefinition<CardAssignedEnvelope, "wix.crm.pipelines.v1.card_assigned">;
146
- declare const onCardCreated$1: EventDefinition<CardCreatedEnvelope, "wix.crm.pipelines.v1.card_created">;
147
- declare const onCardDeleted$1: EventDefinition<CardDeletedEnvelope, "wix.crm.pipelines.v1.card_deleted">;
148
- declare const onCardMoved$1: EventDefinition<CardMovedEnvelope, "wix.crm.pipelines.v1.card_moved">;
149
- declare const onCardOverdue$1: EventDefinition<CardOverdueEnvelope, "wix.crm.pipelines.v1.card_overdue">;
150
- declare const onCardStale$1: EventDefinition<CardStaleEnvelope, "wix.crm.pipelines.v1.card_stale">;
151
- declare const onCardUpdated$1: EventDefinition<CardUpdatedEnvelope, "wix.crm.pipelines.v1.card_updated">;
87
+ declare const onPipelineCreated$1: EventDefinition<PipelineCreatedEnvelope, "wix.crm.pipelines.v1.pipeline_created">;
88
+ declare const onPipelineDeleted$1: EventDefinition<PipelineDeletedEnvelope, "wix.crm.pipelines.v1.pipeline_deleted">;
89
+ declare const onPipelineUpdated$1: EventDefinition<PipelineUpdatedEnvelope, "wix.crm.pipelines.v1.pipeline_updated">;
152
90
 
153
- declare function customQueryCards(httpClient: HttpClient): {
154
- (): CardsQueryBuilder;
155
- (query: CardQuery): ReturnType<typeof typedQueryCards>;
91
+ declare function customQueryPipelines(httpClient: HttpClient): {
92
+ (): PipelinesQueryBuilder;
93
+ (query: PipelineQuery): ReturnType<typeof typedQueryPipelines>;
156
94
  };
157
- declare const createCard: MaybeContext<BuildRESTFunction<typeof createCard$1> & typeof createCard$1>;
158
- declare const getCard: MaybeContext<BuildRESTFunction<typeof getCard$1> & typeof getCard$1>;
159
- declare const updateCard: MaybeContext<BuildRESTFunction<typeof updateCard$1> & typeof updateCard$1>;
160
- declare const moveCard: MaybeContext<BuildRESTFunction<typeof moveCard$1> & typeof moveCard$1>;
161
- declare const deleteCard: MaybeContext<BuildRESTFunction<typeof deleteCard$1> & typeof deleteCard$1>;
162
- declare const searchCards: MaybeContext<BuildRESTFunction<typeof searchCards$1> & typeof searchCards$1>;
163
- declare const searchCardsByStage: MaybeContext<BuildRESTFunction<typeof searchCardsByStage$1> & typeof searchCardsByStage$1>;
164
- /** @internal */
165
- declare const bulkCreateCards: MaybeContext<BuildRESTFunction<typeof bulkCreateCards$1> & typeof bulkCreateCards$1>;
166
- /** @internal */
167
- declare const bulkUpdateCards: MaybeContext<BuildRESTFunction<typeof bulkUpdateCards$1> & typeof bulkUpdateCards$1>;
168
- /** @internal */
169
- declare const bulkDeleteCards: MaybeContext<BuildRESTFunction<typeof bulkDeleteCards$1> & typeof bulkDeleteCards$1>;
170
- declare const bulkUpdateCardTags: MaybeContext<BuildRESTFunction<typeof bulkUpdateCardTags$1> & typeof bulkUpdateCardTags$1>;
171
- declare const bulkUpdateCardTagsByFilter: MaybeContext<BuildRESTFunction<typeof bulkUpdateCardTagsByFilter$1> & typeof bulkUpdateCardTagsByFilter$1>;
172
- declare const queryCards: MaybeContext<BuildRESTFunction<typeof customQueryCards> & typeof customQueryCards>;
173
- /**
174
- * Triggered when a card is assigned.
175
- */
176
- declare const onCardAssigned: BuildEventDefinition<typeof onCardAssigned$1> & typeof onCardAssigned$1;
177
- /**
178
- * Triggered when a card is created.
179
- */
180
- declare const onCardCreated: BuildEventDefinition<typeof onCardCreated$1> & typeof onCardCreated$1;
181
- /**
182
- * Triggered when a card is deleted.
183
- */
184
- declare const onCardDeleted: BuildEventDefinition<typeof onCardDeleted$1> & typeof onCardDeleted$1;
185
- /**
186
- * Triggered when a card is moved from one stage to another.
187
- */
188
- declare const onCardMoved: BuildEventDefinition<typeof onCardMoved$1> & typeof onCardMoved$1;
95
+ declare const createPipeline: MaybeContext<BuildRESTFunction<typeof createPipeline$1> & typeof createPipeline$1>;
96
+ declare const getPipeline: MaybeContext<BuildRESTFunction<typeof getPipeline$1> & typeof getPipeline$1>;
97
+ declare const updatePipeline: MaybeContext<BuildRESTFunction<typeof updatePipeline$1> & typeof updatePipeline$1>;
98
+ declare const deletePipeline: MaybeContext<BuildRESTFunction<typeof deletePipeline$1> & typeof deletePipeline$1>;
99
+ declare const bulkUpdatePipelineTags: MaybeContext<BuildRESTFunction<typeof bulkUpdatePipelineTags$1> & typeof bulkUpdatePipelineTags$1>;
100
+ declare const bulkUpdatePipelineTagsByFilter: MaybeContext<BuildRESTFunction<typeof bulkUpdatePipelineTagsByFilter$1> & typeof bulkUpdatePipelineTagsByFilter$1>;
101
+ declare const queryPipelines: MaybeContext<BuildRESTFunction<typeof customQueryPipelines> & typeof customQueryPipelines>;
189
102
  /**
190
- * Triggered when a card's `dueDate` passes.
103
+ * Triggered when a pipeline is created.
191
104
  */
192
- declare const onCardOverdue: BuildEventDefinition<typeof onCardOverdue$1> & typeof onCardOverdue$1;
105
+ declare const onPipelineCreated: BuildEventDefinition<typeof onPipelineCreated$1> & typeof onPipelineCreated$1;
193
106
  /**
194
- * Triggered when a card's `staleDate` passes.
107
+ * Triggered when a pipeline is deleted.
195
108
  */
196
- declare const onCardStale: BuildEventDefinition<typeof onCardStale$1> & typeof onCardStale$1;
109
+ declare const onPipelineDeleted: BuildEventDefinition<typeof onPipelineDeleted$1> & typeof onPipelineDeleted$1;
197
110
  /**
198
- * Triggered when a card is updated.
111
+ * Triggered when a pipeline is updated.
199
112
  */
200
- declare const onCardUpdated: BuildEventDefinition<typeof onCardUpdated$1> & typeof onCardUpdated$1;
113
+ declare const onPipelineUpdated: BuildEventDefinition<typeof onPipelineUpdated$1> & typeof onPipelineUpdated$1;
201
114
 
202
- export { BulkCreateCardsOptions, BulkCreateCardsResponse, BulkDeleteCardsResponse, BulkUpdateCardTagsApplicationErrors, BulkUpdateCardTagsByFilterApplicationErrors, BulkUpdateCardTagsByFilterOptions, BulkUpdateCardTagsByFilterResponse, BulkUpdateCardTagsOptions, BulkUpdateCardTagsResponse, BulkUpdateCardsOptions, BulkUpdateCardsResponse, Card, CardAssignedEnvelope, CardCreatedEnvelope, CardDeletedEnvelope, CardMovedEnvelope, CardOverdueEnvelope, CardQuery, CardSearch, CardStaleEnvelope, CardUpdatedEnvelope, CardsQueryBuilder, CreateCardApplicationErrors, CreateCardOptions, MaskedCard, MoveCardApplicationErrors, MoveCardOptions, MoveCardResponse, SearchCardsByStageOptions, SearchCardsByStageResponse, SearchCardsOptions, SearchCardsResponse, UpdateCardApplicationErrors, UpdateCardOptions, bulkCreateCards, bulkDeleteCards, bulkUpdateCardTags, bulkUpdateCardTagsByFilter, bulkUpdateCards, createCard, deleteCard, getCard, moveCard, onCardAssigned, onCardCreated, onCardDeleted, onCardMoved, onCardOverdue, onCardStale, onCardUpdated, queryCards, searchCards, searchCardsByStage, updateCard };
115
+ export { BulkUpdatePipelineTagsApplicationErrors, BulkUpdatePipelineTagsByFilterApplicationErrors, BulkUpdatePipelineTagsByFilterOptions, BulkUpdatePipelineTagsByFilterResponse, BulkUpdatePipelineTagsOptions, BulkUpdatePipelineTagsResponse, DeletePipelineApplicationErrors, Pipeline, PipelineCreatedEnvelope, PipelineDeletedEnvelope, PipelineQuery, PipelineUpdatedEnvelope, PipelinesQueryBuilder, UpdatePipeline, UpdatePipelineApplicationErrors, bulkUpdatePipelineTags, bulkUpdatePipelineTagsByFilter, createPipeline, deletePipeline, getPipeline, onPipelineCreated, onPipelineDeleted, onPipelineUpdated, queryPipelines, updatePipeline };