@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.
- package/build/cjs/index.d.ts +76 -130
- package/build/cjs/index.js +194 -977
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +998 -15
- package/build/cjs/index.typings.js +146 -767
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +133 -1005
- package/build/cjs/meta.js +128 -682
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +76 -130
- package/build/es/index.mjs +184 -947
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +998 -15
- package/build/es/index.typings.mjs +138 -743
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +133 -1005
- package/build/es/meta.mjs +121 -659
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +76 -163
- package/build/internal/cjs/index.js +194 -977
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +998 -15
- package/build/internal/cjs/index.typings.js +146 -767
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +133 -1005
- package/build/internal/cjs/meta.js +128 -682
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +76 -163
- package/build/internal/es/index.mjs +184 -947
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +998 -15
- package/build/internal/es/index.typings.mjs +138 -743
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +133 -1005
- package/build/internal/es/meta.mjs +121 -659
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +3 -3
- package/build/cjs/crm-pipelines-v1-card-pipelines.universal-DGtqU_Zb.d.ts +0 -2265
- package/build/es/crm-pipelines-v1-card-pipelines.universal-DGtqU_Zb.d.mts +0 -2265
- package/build/internal/cjs/crm-pipelines-v1-card-pipelines.universal-BHszxzqA.d.ts +0 -2303
- package/build/internal/es/crm-pipelines-v1-card-pipelines.universal-BHszxzqA.d.mts +0 -2303
package/build/es/index.d.mts
CHANGED
|
@@ -1,169 +1,115 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
-
import {
|
|
3
|
-
export {
|
|
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
|
|
6
|
-
interface
|
|
5
|
+
declare function createPipeline$1(httpClient: HttpClient): CreatePipelineSignature;
|
|
6
|
+
interface CreatePipelineSignature {
|
|
7
7
|
/**
|
|
8
|
-
* Creates a
|
|
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.
|
|
30
|
-
*
|
|
31
|
-
* The card's `pipelineId` and `currency` fields can't be updated.
|
|
32
|
-
* @param - Card ID.
|
|
33
|
-
* @returns Updated card.
|
|
34
|
-
*/
|
|
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
|
-
}>;
|
|
38
|
-
}
|
|
39
|
-
declare function moveCard$1(httpClient: HttpClient): MoveCardSignature;
|
|
40
|
-
interface MoveCardSignature {
|
|
41
|
-
/**
|
|
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.
|
|
8
|
+
* Creates a pipeline with defined stages and a final stage.
|
|
45
9
|
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
* @param -
|
|
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.
|
|
49
14
|
*/
|
|
50
|
-
(
|
|
51
|
-
__applicationErrorsType?: MoveCardApplicationErrors;
|
|
52
|
-
}>;
|
|
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>>;
|
|
53
16
|
}
|
|
54
|
-
declare function
|
|
55
|
-
interface
|
|
17
|
+
declare function getPipeline$1(httpClient: HttpClient): GetPipelineSignature;
|
|
18
|
+
interface GetPipelineSignature {
|
|
56
19
|
/**
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
* @param - Card ID to delete.
|
|
20
|
+
* Retrieves a pipeline by ID.
|
|
21
|
+
* @param - Pipeline ID to retrieve.
|
|
22
|
+
* @returns Retrieved pipeline.
|
|
61
23
|
*/
|
|
62
|
-
(
|
|
24
|
+
(pipelineId: string): Promise<NonNullablePaths<Pipeline, `stages` | `doneStage.allowedOutcomes` | `tags.privateTags.tagIds`, 4>>;
|
|
63
25
|
}
|
|
64
|
-
declare function
|
|
65
|
-
interface
|
|
26
|
+
declare function updatePipeline$1(httpClient: HttpClient): UpdatePipelineSignature;
|
|
27
|
+
interface UpdatePipelineSignature {
|
|
66
28
|
/**
|
|
67
|
-
*
|
|
29
|
+
* Updates a pipeline.
|
|
68
30
|
*
|
|
69
|
-
*
|
|
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.
|
|
70
32
|
*
|
|
71
|
-
*
|
|
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.
|
|
72
35
|
*
|
|
73
|
-
*
|
|
74
|
-
* @param -
|
|
36
|
+
* </blockquote>
|
|
37
|
+
* @param - Pipeline ID.
|
|
38
|
+
* @returns Updated pipeline.
|
|
75
39
|
*/
|
|
76
|
-
(
|
|
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
|
|
79
|
-
interface
|
|
44
|
+
declare function deletePipeline$1(httpClient: HttpClient): DeletePipelineSignature;
|
|
45
|
+
interface DeletePipelineSignature {
|
|
80
46
|
/**
|
|
81
|
-
*
|
|
82
|
-
*
|
|
83
|
-
* By default, cards are sorted by `updatedDate` in descending order.
|
|
47
|
+
* Deletes a pipeline.
|
|
84
48
|
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
* @param - ID
|
|
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
|
|
54
|
+
(pipelineId: string): Promise<void & {
|
|
55
|
+
__applicationErrorsType?: DeletePipelineApplicationErrors;
|
|
56
|
+
}>;
|
|
91
57
|
}
|
|
92
|
-
declare function
|
|
93
|
-
interface
|
|
58
|
+
declare function bulkUpdatePipelineTags$1(httpClient: HttpClient): BulkUpdatePipelineTagsSignature;
|
|
59
|
+
interface BulkUpdatePipelineTagsSignature {
|
|
94
60
|
/**
|
|
95
|
-
* Updates tags on multiple
|
|
61
|
+
* Updates tags on multiple pipelines by specified pipeline IDs.
|
|
96
62
|
*
|
|
97
|
-
* If you specify a tag
|
|
98
|
-
* @param - List of
|
|
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.
|
|
99
65
|
*/
|
|
100
|
-
(
|
|
101
|
-
__applicationErrorsType?:
|
|
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;
|
|
102
68
|
}>;
|
|
103
69
|
}
|
|
104
|
-
declare function
|
|
105
|
-
interface
|
|
70
|
+
declare function bulkUpdatePipelineTagsByFilter$1(httpClient: HttpClient): BulkUpdatePipelineTagsByFilterSignature;
|
|
71
|
+
interface BulkUpdatePipelineTagsByFilterSignature {
|
|
106
72
|
/**
|
|
107
|
-
*
|
|
73
|
+
* Updates tags on multiple pipelines, using a filter to select which pipelines to update.
|
|
108
74
|
*
|
|
109
|
-
*
|
|
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.
|
|
110
77
|
*
|
|
111
|
-
*
|
|
112
|
-
*
|
|
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.
|
|
113
82
|
*/
|
|
114
|
-
(filter: Record<string, any>, options?:
|
|
115
|
-
__applicationErrorsType?:
|
|
83
|
+
(filter: Record<string, any>, options?: BulkUpdatePipelineTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdatePipelineTagsByFilterResponse, `jobId`, 2> & {
|
|
84
|
+
__applicationErrorsType?: BulkUpdatePipelineTagsByFilterApplicationErrors;
|
|
116
85
|
}>;
|
|
117
86
|
}
|
|
118
|
-
declare const
|
|
119
|
-
declare const
|
|
120
|
-
declare const
|
|
121
|
-
declare const onCardMoved$1: EventDefinition<CardMovedEnvelope, "wix.crm.pipelines.v1.card_moved">;
|
|
122
|
-
declare const onCardOverdue$1: EventDefinition<CardOverdueEnvelope, "wix.crm.pipelines.v1.card_overdue">;
|
|
123
|
-
declare const onCardStale$1: EventDefinition<CardStaleEnvelope, "wix.crm.pipelines.v1.card_stale">;
|
|
124
|
-
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">;
|
|
125
90
|
|
|
126
|
-
declare function
|
|
127
|
-
():
|
|
128
|
-
(query:
|
|
91
|
+
declare function customQueryPipelines(httpClient: HttpClient): {
|
|
92
|
+
(): PipelinesQueryBuilder;
|
|
93
|
+
(query: PipelineQuery): ReturnType<typeof typedQueryPipelines>;
|
|
129
94
|
};
|
|
130
|
-
declare const
|
|
131
|
-
declare const
|
|
132
|
-
declare const
|
|
133
|
-
declare const
|
|
134
|
-
declare const
|
|
135
|
-
declare const
|
|
136
|
-
declare const
|
|
137
|
-
declare const bulkUpdateCardTags: MaybeContext<BuildRESTFunction<typeof bulkUpdateCardTags$1> & typeof bulkUpdateCardTags$1>;
|
|
138
|
-
declare const bulkUpdateCardTagsByFilter: MaybeContext<BuildRESTFunction<typeof bulkUpdateCardTagsByFilter$1> & typeof bulkUpdateCardTagsByFilter$1>;
|
|
139
|
-
declare const queryCards: MaybeContext<BuildRESTFunction<typeof customQueryCards> & typeof customQueryCards>;
|
|
140
|
-
/**
|
|
141
|
-
* Triggered when a card is assigned.
|
|
142
|
-
*/
|
|
143
|
-
declare const onCardAssigned: BuildEventDefinition<typeof onCardAssigned$1> & typeof onCardAssigned$1;
|
|
144
|
-
/**
|
|
145
|
-
* Triggered when a card is created.
|
|
146
|
-
*/
|
|
147
|
-
declare const onCardCreated: BuildEventDefinition<typeof onCardCreated$1> & typeof onCardCreated$1;
|
|
148
|
-
/**
|
|
149
|
-
* Triggered when a card is deleted.
|
|
150
|
-
*/
|
|
151
|
-
declare const onCardDeleted: BuildEventDefinition<typeof onCardDeleted$1> & typeof onCardDeleted$1;
|
|
152
|
-
/**
|
|
153
|
-
* Triggered when a card is moved from one stage to another.
|
|
154
|
-
*/
|
|
155
|
-
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>;
|
|
156
102
|
/**
|
|
157
|
-
* Triggered when a
|
|
103
|
+
* Triggered when a pipeline is created.
|
|
158
104
|
*/
|
|
159
|
-
declare const
|
|
105
|
+
declare const onPipelineCreated: BuildEventDefinition<typeof onPipelineCreated$1> & typeof onPipelineCreated$1;
|
|
160
106
|
/**
|
|
161
|
-
* Triggered when a
|
|
107
|
+
* Triggered when a pipeline is deleted.
|
|
162
108
|
*/
|
|
163
|
-
declare const
|
|
109
|
+
declare const onPipelineDeleted: BuildEventDefinition<typeof onPipelineDeleted$1> & typeof onPipelineDeleted$1;
|
|
164
110
|
/**
|
|
165
|
-
* Triggered when a
|
|
111
|
+
* Triggered when a pipeline is updated.
|
|
166
112
|
*/
|
|
167
|
-
declare const
|
|
113
|
+
declare const onPipelineUpdated: BuildEventDefinition<typeof onPipelineUpdated$1> & typeof onPipelineUpdated$1;
|
|
168
114
|
|
|
169
|
-
export {
|
|
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 };
|