@wix/auto_sdk_crm_pipelines 1.0.0

package/build/internal/es/index.d.mts

@@ -0,0 +1,202 @@
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+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';
+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';
+
+declare function createCard$1(httpClient: HttpClient): CreateCardSignature;
+interface CreateCardSignature {
+    /**
+     * Creates a card in a specific pipeline stage.
+     * @returns Created card.
+     */
+    (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> & {
+        __applicationErrorsType?: CreateCardApplicationErrors;
+    }>;
+}
+declare function getCard$1(httpClient: HttpClient): GetCardSignature;
+interface GetCardSignature {
+    /**
+     * Retrieves a card by ID.
+     * @param - Card ID to retrieve.
+     * @returns Retrieved card.
+     */
+    (cardId: string): Promise<NonNullablePaths<Card, `priority` | `value.value` | `value.currency` | `outcome` | `additionalContacts` | `linkedEntities` | `linkedEntities.${number}.entityId` | `linkedEntities.${number}.referencedEntity` | `tags.privateTags.tagIds`, 4>>;
+}
+declare function updateCard$1(httpClient: HttpClient): UpdateCardSignature;
+interface UpdateCardSignature {
+    /**
+     * Updates a card by ID.
+     *
+     * 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.
+     *
+     * The card's `pipelineId` and `currency` fields can't be updated.
+     * @param - Card ID.
+     * @returns Updated card.
+     */
+    (_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> & {
+        __applicationErrorsType?: UpdateCardApplicationErrors;
+    }>;
+}
+declare function moveCard$1(httpClient: HttpClient): MoveCardSignature;
+interface MoveCardSignature {
+    /**
+     * Moves a card to a different stage within the same pipeline.
+     *
+     * Cards can only be moved between stages within the same pipeline.
+     *
+     * Each time a card is moved, its `revision` increments by 1.
+     * @param - Card ID to move.
+     * @param - ID of the stage to move the card to.
+     */
+    (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> & {
+        __applicationErrorsType?: MoveCardApplicationErrors;
+    }>;
+}
+declare function deleteCard$1(httpClient: HttpClient): DeleteCardSignature;
+interface DeleteCardSignature {
+    /**
+     * Deletes a card.
+     *
+     * Deleting a card permanently removes it from a site.
+     * @param - Card ID to delete.
+     */
+    (cardId: string): Promise<void>;
+}
+declare function searchCards$1(httpClient: HttpClient): SearchCardsSignature;
+interface SearchCardsSignature {
+    /**
+     * Retrieves a list of cards given the provided free-text search expression, filtering, and sorting.
+     *
+     * By default, cards are sorted by `updatedDate` in descending order.
+     *
+     * 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).
+     *
+     * 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).
+     * @param - Search options.
+     */
+    (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>>;
+}
+declare function searchCardsByStage$1(httpClient: HttpClient): SearchCardsByStageSignature;
+interface SearchCardsByStageSignature {
+    /**
+     * Retrieves a list of cards by the pipeline's stage, given the provided free-text search expression, filtering, and sorting.
+     *
+     * By default, cards are sorted by `updatedDate` in descending order.
+     *
+     * 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).
+     *
+     * 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).
+     * @param - ID of the pipeline in which to look for cards.
+     */
+    (pipelineId: string, options?: NonNullablePaths<SearchCardsByStageOptions, `stageIds`, 2>): Promise<NonNullablePaths<SearchCardsByStageResponse, `results`, 2>>;
+}
+/** @internal */
+declare function bulkCreateCards$1(httpClient: HttpClient): BulkCreateCardsSignature;
+interface BulkCreateCardsSignature {
+    /**
+     * Creates multiple cards.
+     * @param - List of cards to create.
+     */
+    (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>>;
+}
+/** @internal */
+declare function bulkUpdateCards$1(httpClient: HttpClient): BulkUpdateCardsSignature;
+interface BulkUpdateCardsSignature {
+    /**
+     * Updates multiple cards.
+     * @param - List of cards to update.
+     */
+    (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>>;
+}
+/** @internal */
+declare function bulkDeleteCards$1(httpClient: HttpClient): BulkDeleteCardsSignature;
+interface BulkDeleteCardsSignature {
+    /**
+     * Deletes multiple cards.
+     * @param - Card IDs to delete.
+     */
+    (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>>;
+}
+declare function bulkUpdateCardTags$1(httpClient: HttpClient): BulkUpdateCardTagsSignature;
+interface BulkUpdateCardTagsSignature {
+    /**
+     * Updates tags on multiple cards by specified card IDs.
+     *
+     * If you specify a tag that in both `assignTags` and `unassignTags`, the tag is assigned to the cards.
+     * @param - List of card IDs whose tags will be updated.
+     */
+    (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> & {
+        __applicationErrorsType?: BulkUpdateCardTagsApplicationErrors;
+    }>;
+}
+declare function bulkUpdateCardTagsByFilter$1(httpClient: HttpClient): BulkUpdateCardTagsByFilterSignature;
+interface BulkUpdateCardTagsByFilterSignature {
+    /**
+     * Asynchronously updates tags on multiple cards using a filter to specify which cards to update.
+     *
+     * An empty filter updates all cards in the pipeline.
+     *
+     * If you specify a tag in both `assignTags` and `unassignTags`, the tag is assigned to the cards.
+     * @param - Filter object.
+     */
+    (filter: Record<string, any>, options?: BulkUpdateCardTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateCardTagsByFilterResponse, `jobId`, 2> & {
+        __applicationErrorsType?: BulkUpdateCardTagsByFilterApplicationErrors;
+    }>;
+}
+declare const onCardAssigned$1: EventDefinition<CardAssignedEnvelope, "wix.crm.pipelines.v1.card_assigned">;
+declare const onCardCreated$1: EventDefinition<CardCreatedEnvelope, "wix.crm.pipelines.v1.card_created">;
+declare const onCardDeleted$1: EventDefinition<CardDeletedEnvelope, "wix.crm.pipelines.v1.card_deleted">;
+declare const onCardMoved$1: EventDefinition<CardMovedEnvelope, "wix.crm.pipelines.v1.card_moved">;
+declare const onCardOverdue$1: EventDefinition<CardOverdueEnvelope, "wix.crm.pipelines.v1.card_overdue">;
+declare const onCardStale$1: EventDefinition<CardStaleEnvelope, "wix.crm.pipelines.v1.card_stale">;
+declare const onCardUpdated$1: EventDefinition<CardUpdatedEnvelope, "wix.crm.pipelines.v1.card_updated">;
+
+declare function customQueryCards(httpClient: HttpClient): {
+    (): CardsQueryBuilder;
+    (query: CardQuery): ReturnType<typeof typedQueryCards>;
+};
+declare const createCard: MaybeContext<BuildRESTFunction<typeof createCard$1> & typeof createCard$1>;
+declare const getCard: MaybeContext<BuildRESTFunction<typeof getCard$1> & typeof getCard$1>;
+declare const updateCard: MaybeContext<BuildRESTFunction<typeof updateCard$1> & typeof updateCard$1>;
+declare const moveCard: MaybeContext<BuildRESTFunction<typeof moveCard$1> & typeof moveCard$1>;
+declare const deleteCard: MaybeContext<BuildRESTFunction<typeof deleteCard$1> & typeof deleteCard$1>;
+declare const searchCards: MaybeContext<BuildRESTFunction<typeof searchCards$1> & typeof searchCards$1>;
+declare const searchCardsByStage: MaybeContext<BuildRESTFunction<typeof searchCardsByStage$1> & typeof searchCardsByStage$1>;
+/** @internal */
+declare const bulkCreateCards: MaybeContext<BuildRESTFunction<typeof bulkCreateCards$1> & typeof bulkCreateCards$1>;
+/** @internal */
+declare const bulkUpdateCards: MaybeContext<BuildRESTFunction<typeof bulkUpdateCards$1> & typeof bulkUpdateCards$1>;
+/** @internal */
+declare const bulkDeleteCards: MaybeContext<BuildRESTFunction<typeof bulkDeleteCards$1> & typeof bulkDeleteCards$1>;
+declare const bulkUpdateCardTags: MaybeContext<BuildRESTFunction<typeof bulkUpdateCardTags$1> & typeof bulkUpdateCardTags$1>;
+declare const bulkUpdateCardTagsByFilter: MaybeContext<BuildRESTFunction<typeof bulkUpdateCardTagsByFilter$1> & typeof bulkUpdateCardTagsByFilter$1>;
+declare const queryCards: MaybeContext<BuildRESTFunction<typeof customQueryCards> & typeof customQueryCards>;
+/**
+ * Triggered when a card is assigned.
+ */
+declare const onCardAssigned: BuildEventDefinition<typeof onCardAssigned$1> & typeof onCardAssigned$1;
+/**
+ * Triggered when a card is created.
+ */
+declare const onCardCreated: BuildEventDefinition<typeof onCardCreated$1> & typeof onCardCreated$1;
+/**
+ * Triggered when a card is deleted.
+ */
+declare const onCardDeleted: BuildEventDefinition<typeof onCardDeleted$1> & typeof onCardDeleted$1;
+/**
+ * Triggered when a card is moved from one stage to another.
+ */
+declare const onCardMoved: BuildEventDefinition<typeof onCardMoved$1> & typeof onCardMoved$1;
+/**
+ * Triggered when a card's `dueDate` passes.
+ */
+declare const onCardOverdue: BuildEventDefinition<typeof onCardOverdue$1> & typeof onCardOverdue$1;
+/**
+ * Triggered when a card's `staleDate` passes.
+ */
+declare const onCardStale: BuildEventDefinition<typeof onCardStale$1> & typeof onCardStale$1;
+/**
+ * Triggered when a card is updated.
+ */
+declare const onCardUpdated: BuildEventDefinition<typeof onCardUpdated$1> & typeof onCardUpdated$1;
+
+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 };