@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,228 +1,117 @@
1
- import { $ as CreateCardRequest$1, a0 as CreateCardResponse$1, a2 as GetCardRequest$1, a3 as GetCardResponse$1, a4 as UpdateCardRequest$1, a5 as UpdateCardResponse$1, a6 as MoveCardRequest$1, d as MoveCardResponse$1, a7 as DeleteCardRequest$1, a8 as DeleteCardResponse$1, a9 as QueryCardsRequest$1, ae as QueryCardsResponse$1, ah as SearchCardsRequest$1, g as SearchCardsResponse$1, aS as SearchCardsByStageRequest$1, i as SearchCardsByStageResponse$1, aU as BulkCreateCardsRequest$1, aV as BulkCreateCardsResponse$1, a_ as BulkUpdateCardsRequest$1, b0 as BulkUpdateCardsResponse$1, b2 as BulkDeleteCardsRequest$1, b3 as BulkDeleteCardsResponse$1, b5 as BulkUpdateCardTagsRequest$1, j as BulkUpdateCardTagsResponse$1, b7 as BulkUpdateCardTagsByFilterRequest$1, m as BulkUpdateCardTagsByFilterResponse$1 } from './crm-pipelines-v1-card-pipelines.universal-DGtqU_Zb.js';
1
+ import { CreatePipelineRequest as CreatePipelineRequest$1, CreatePipelineResponse as CreatePipelineResponse$1, GetPipelineRequest as GetPipelineRequest$1, GetPipelineResponse as GetPipelineResponse$1, UpdatePipelineRequest as UpdatePipelineRequest$1, UpdatePipelineResponse as UpdatePipelineResponse$1, DeletePipelineRequest as DeletePipelineRequest$1, DeletePipelineResponse as DeletePipelineResponse$1, QueryPipelinesRequest as QueryPipelinesRequest$1, QueryPipelinesResponse as QueryPipelinesResponse$1, BulkUpdatePipelineTagsRequest as BulkUpdatePipelineTagsRequest$1, BulkUpdatePipelineTagsResponse as BulkUpdatePipelineTagsResponse$1, BulkUpdatePipelineTagsByFilterRequest as BulkUpdatePipelineTagsByFilterRequest$1, BulkUpdatePipelineTagsByFilterResponse as BulkUpdatePipelineTagsByFilterResponse$1 } from './index.typings.js';
2
2
  import '@wix/sdk-types';
3
3
 
4
4
  /**
5
- * A business entity representing a deal, lead, opportunity, or project that moves through pipeline stages.
5
+ * A structured business process workflow consisting of multiple ordered stages and a final stage.
6
6
  *
7
- * Cards contain comprehensive business information including contact details, monetary values,
8
- * priorities, due dates, and outcomes. They progress through pipeline stages as work advances
9
- * and can be assigned to team members for ownership and responsibility tracking.
7
+ * Pipelines define the path that cards (deals, leads, projects, etc.) follow from start to completion.
8
+ * Each pipeline has a currency setting that applies to all monetary values within that pipeline.
9
+ * Pipeline stages can be configured with stale duration settings to identify workflow delays.
10
10
  */
11
- interface Card {
11
+ interface Pipeline {
12
12
  /**
13
- * Card ID.
13
+ * Pipeline ID.
14
14
  * @format GUID
15
15
  * @readonly
16
16
  */
17
17
  id?: string | null;
18
18
  /**
19
- * Revision number, which increments by 1 each time the card is updated.
20
- * To prevent conflicting changes, the current revision must be passed when updating the card.
19
+ * Revision number, which increments by 1 each time the pipeline is updated.
20
+ * To prevent conflicting changes, the current revision must be passed when updating the pipeline.
21
+ *
22
+ * Ignored when creating a pipeline.
21
23
  * @readonly
22
24
  */
23
25
  revision?: string | null;
24
26
  /**
25
- * Date and time the card was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.
27
+ * Date and time the pipeline was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.
26
28
  * @readonly
27
29
  */
28
30
  createdDate?: Date | null;
29
31
  /**
30
- * Date and time the card was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.
32
+ * Date and time the pipeline was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.
31
33
  * @readonly
32
34
  */
33
35
  updatedDate?: Date | null;
34
36
  /**
35
- * ID of the pipeline containing this card.
36
- * @format GUID
37
- * @readonly
38
- */
39
- pipelineId?: string | null;
40
- /**
41
- * ID of the cards' current.
42
- * @format GUID
43
- */
44
- stageId?: string | null;
45
- /**
46
- * Date and time when the card last moved between stagesin [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.
47
- * @readonly
48
- */
49
- stageUpdatedDate?: Date | null;
50
- /**
51
- * How the card was moved to its current stage.
52
- * @readonly
53
- */
54
- stageUpdateSource?: CardSource;
55
- /**
56
- * The Card name.
37
+ * Pipeline name.
57
38
  * @minLength 1
58
- * @maxLength 100
39
+ * @maxLength 60
59
40
  */
60
41
  name?: string | null;
61
42
  /**
62
- * Card description.
63
- * @maxLength 1000
64
- */
65
- description?: string | null;
66
- /**
67
- * Priority level of the card for task management.
68
- *
69
- * Default: `P3_MEDIUM`
70
- */
71
- priority?: PriorityWithLiterals;
72
- /**
73
- * ID of the Wix user assigned to manage the card.
74
- * @format GUID
75
- */
76
- assigneeId?: string | null;
77
- /**
78
- * Date and time when the card is expected to moved to the done stage in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.
79
- * If the card remains active past this date, it becomes overdue.
80
- */
81
- dueDate?: Date | null;
82
- /**
83
- * Date and time when the card becomes stale based on the stage's stale duration setting in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.
84
- * This date is automatically calculated and updated when the card moves to a new stage.
85
- * @readonly
86
- */
87
- staleDate?: Date | null;
88
- /** Monetary value assigned to the card. */
89
- value?: Money;
90
- /**
91
- * Final outcome of the card when moved to the done stage.
43
+ * Currency code for monetary values in this pipeline. Must be a valid ISO 4217 currency code. For example, `USD`.
92
44
  *
93
- * Default: `NONE`
94
- */
95
- outcome?: OutcomeWithLiterals;
96
- /** Primary contact associated with the card. */
97
- mainContact?: ContactInfo;
98
- /**
99
- * Secondary contacts associated with the card.
100
- * @maxSize 10
45
+ * Default: Based on the site's currency settings.
46
+ * @format CURRENCY
47
+ * @immutable
101
48
  */
102
- additionalContacts?: ContactInfo[];
49
+ currency?: string | null;
103
50
  /**
104
- * Other entities linked to the card.
105
- *
106
- * For example, orders, invoices, activities, or other relevant entities.
107
- * @maxSize 20
51
+ * Pipeline stages in order.
52
+ * Cards move through these stages as they progress through the business process.
53
+ * @minSize 1
54
+ * @maxSize 30
108
55
  */
109
- linkedEntities?: LinkedEntity[];
56
+ stages?: Stage[];
57
+ /** The final pipeline stage where cards receive a final outcome. */
58
+ doneStage?: DoneStage;
110
59
  /** Extended fields data. */
111
60
  extendedFields?: ExtendedFields;
112
- /** Tags for organizing and categorizing the card. */
61
+ /** Tags for organizing and categorizing pipelines. */
113
62
  tags?: PrivateTags;
114
63
  }
115
- interface CardSource {
64
+ interface Stage {
116
65
  /**
117
- * ID of the Wix user who last moved the card.
66
+ * Stage ID.
118
67
  * @format GUID
119
68
  * @readonly
120
69
  */
121
- userId?: string | null;
70
+ id?: string | null;
71
+ /**
72
+ * Stage name.
73
+ * @minLength 1
74
+ * @maxLength 40
75
+ */
76
+ name?: string | null;
77
+ /**
78
+ * The duration (in hours) a card can remain in this stage before becoming stale.
79
+ * When a card exceeds this duration, it's marked as stale to indicate potential workflow delays.
80
+ * @min 1
81
+ * @max 100000
82
+ */
83
+ staleDurationInHours?: number | null;
84
+ }
85
+ interface DoneStage {
122
86
  /**
123
- * ID of the app that last moved the card.
87
+ * Done stage ID.
124
88
  * @format GUID
125
89
  * @readonly
126
90
  */
127
- appId?: string | null;
128
- }
129
- declare enum Priority {
130
- /** Urgent priority. Card requires immediate attention. */
131
- P1_URGENT = "P1_URGENT",
132
- /** High priority. Card is important and should be addressed promptly. */
133
- P2_HIGH = "P2_HIGH",
134
- /** Medium priority. Card should be completed within regular workflow timelines. */
135
- P3_MEDIUM = "P3_MEDIUM",
136
- /** Low priority. Card can be addressed when time and resources allow. */
137
- P4_LOW = "P4_LOW"
138
- }
139
- /** @enumType */
140
- type PriorityWithLiterals = Priority | 'P1_URGENT' | 'P2_HIGH' | 'P3_MEDIUM' | 'P4_LOW';
141
- /**
142
- * Monetary amount with currency information.
143
- * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
144
- */
145
- interface Money {
91
+ id?: string | null;
146
92
  /**
147
- * Monetary amount. For example, `"3.99"`, or `"-4.99"` for a negative amount.
148
- * @format DECIMAL_VALUE
149
- * @decimalValue options { maxScale:2 }
93
+ * Done stage name.
94
+ * @minLength 1
95
+ * @maxLength 40
150
96
  */
151
- value?: string;
97
+ name?: string | null;
152
98
  /**
153
- * Three-letter currency code in ISO-4217 format.
154
- * Currency is the same as the pipeline currency and is immutable.
155
- * @format CURRENCY
156
- * @readonly
99
+ * Outcomes that cards can have when moved to the done stage.
100
+ * @minSize 1
101
+ * @maxSize 3
157
102
  */
158
- currency?: string;
103
+ allowedOutcomes?: OutcomeWithLiterals[];
159
104
  }
160
105
  declare enum Outcome {
161
- /** No specific outcome. The card reached the final stage but hasn't been specified as successful or unsuccessful. */
106
+ /** No specific outcome. The process reached the final stage but has not been specified as successful or unsuccessful. */
162
107
  NONE = "NONE",
163
- /** Successful outcome. The card achieved its intended goal. */
108
+ /** Successful outcome. The process achieved its intended goal. */
164
109
  WON = "WON",
165
- /** Unsuccessful outcome. The card didn't achieve its intended goal. */
110
+ /** Unsuccessful outcome. The process didn't achieve its intended goal. */
166
111
  LOST = "LOST"
167
112
  }
168
113
  /** @enumType */
169
114
  type OutcomeWithLiterals = Outcome | 'NONE' | 'WON' | 'LOST';
170
- interface ContactInfo {
171
- /**
172
- * ID of the contact associated with the card.
173
- * @format GUID
174
- */
175
- contactId?: string | null;
176
- /**
177
- * Contact's first name.
178
- * @readonly
179
- * @maxLength 50
180
- */
181
- firstName?: string | null;
182
- /**
183
- * Contact's last name.
184
- * @readonly
185
- * @maxLength 50
186
- */
187
- lastName?: string | null;
188
- /**
189
- * Contact's primary email.
190
- * @format EMAIL
191
- * @maxLength 320
192
- * @readonly
193
- */
194
- email?: string | null;
195
- /**
196
- * Contact's primary phone.
197
- * @minLength 1
198
- * @maxLength 50
199
- * @readonly
200
- */
201
- phone?: string | null;
202
- }
203
- interface LinkedEntity {
204
- /**
205
- * ID of the linked entity.
206
- * @format GUID
207
- */
208
- entityId?: string;
209
- /**
210
- * Linked entity type.
211
- *
212
- * Identifies the type of entity associated with this card such as a contact submitted by a form, or an invoice sent to close a deal.
213
- * You can store any value that helps identify the entity type.
214
- * Use the item selection provider key to make the item selectable by the client.
215
- * For example, an invoice uses "13ee94c1-b635-8505-3391-97919052c16f_InvoiceSelectionProvider".
216
- * @minLength 1
217
- * @maxLength 100
218
- */
219
- referencedEntity?: string;
220
- /**
221
- * Date and time the entity was linked to the card in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format.
222
- * @readonly
223
- */
224
- linkedDate?: Date | null;
225
- }
226
115
  interface ExtendedFields {
227
116
  /**
228
117
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
@@ -246,98 +135,43 @@ interface TagList {
246
135
  */
247
136
  tagIds?: string[];
248
137
  }
249
- interface CardMoved {
250
- /** The card that moved. */
251
- card?: Card;
252
- /**
253
- * The ID of the stage to which the card was moved.
254
- * @format GUID
255
- */
256
- targetStageId?: string;
257
- /**
258
- * The ID of the stage from which the card was moved.
259
- * @format GUID
260
- */
261
- sourceStageId?: string;
262
- }
263
- interface CardAssigned {
264
- /** The card that is assigned. */
265
- card?: Card;
266
- }
267
- interface CardOverdue {
268
- /** The card that is overdue. */
269
- card?: Card;
138
+ interface CreatePipelineRequest {
139
+ /** Pipeline to create. */
140
+ pipeline: Pipeline;
270
141
  }
271
- interface CardStale {
272
- /** The card that is stale. */
273
- card?: Card;
274
- }
275
- interface CreateCardRequest {
276
- /** Card to create. */
277
- card?: Card;
278
- }
279
- interface CreateCardResponse {
280
- /** Created card. */
281
- card?: Card;
282
- }
283
- interface ContactsNotFound {
284
- /**
285
- * The contact IDs that were not found.
286
- * @format GUID
287
- * @minSize 1
288
- * @maxSize 11
289
- */
290
- contactIds?: string[] | null;
142
+ interface CreatePipelineResponse {
143
+ /** Created pipeline. */
144
+ pipeline?: Pipeline;
291
145
  }
292
- interface GetCardRequest {
146
+ interface GetPipelineRequest {
293
147
  /**
294
- * Card ID to retrieve.
148
+ * Pipeline ID to retrieve.
295
149
  * @format GUID
296
150
  */
297
- cardId: string;
298
- }
299
- interface GetCardResponse {
300
- /** Retrieved card. */
301
- card?: Card;
151
+ pipelineId: string;
302
152
  }
303
- interface UpdateCardRequest {
304
- /** Card to update, may be partial. */
305
- card?: Card;
153
+ interface GetPipelineResponse {
154
+ /** Retrieved pipeline. */
155
+ pipeline?: Pipeline;
306
156
  }
307
- interface UpdateCardResponse {
308
- /** Updated card. */
309
- card?: Card;
310
- }
311
- interface MoveCardRequest {
312
- /**
313
- * Card ID to move.
314
- * @format GUID
315
- */
316
- cardId: string;
317
- /**
318
- * ID of the stage to move the card to.
319
- * @format GUID
320
- */
321
- stageId: string;
322
- /** Revision of the card to move. Moving the card changes the `stageId` on the card and increases `revision` by 1. */
323
- revision: string | null;
324
- /** New card outcome. */
325
- outcome?: OutcomeWithLiterals;
157
+ interface UpdatePipelineRequest {
158
+ /** Pipeline to update, may be partial. */
159
+ pipeline: Pipeline;
326
160
  }
327
- interface MoveCardResponse {
328
- /** Updated card. */
329
- card?: Card;
161
+ interface UpdatePipelineResponse {
162
+ /** Updated pipeline. */
163
+ pipeline?: Pipeline;
330
164
  }
331
- interface DeleteCardRequest {
165
+ interface DeletePipelineRequest {
332
166
  /**
333
- * Card ID to delete.
167
+ * Pipeline ID.
334
168
  * @format GUID
335
169
  */
336
- cardId: string;
170
+ pipelineId: string;
337
171
  }
338
- interface DeleteCardResponse {
172
+ interface DeletePipelineResponse {
339
173
  }
340
- interface QueryCardsRequest {
174
+ interface QueryPipelinesRequest {
341
175
  /** Query options. */
342
176
  query?: CursorQuery;
343
177
  }
@@ -351,13 +185,13 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
351
185
  /**
352
186
  * Filter object.
353
187
  *
354
- * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
188
+ * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
355
189
  */
356
190
  filter?: Record<string, any> | null;
357
191
  /**
358
192
  * Sort object.
359
193
  *
360
- * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
194
+ * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
361
195
  * @maxSize 5
362
196
  */
363
197
  sort?: Sorting[];
@@ -388,7 +222,7 @@ declare enum SortOrder {
388
222
  type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
389
223
  interface CursorPaging {
390
224
  /**
391
- * Maximum number of items to return in the results. Default is 50.
225
+ * Maximum number of items to return.
392
226
  * @max 100
393
227
  */
394
228
  limit?: number | null;
@@ -401,9 +235,9 @@ interface CursorPaging {
401
235
  */
402
236
  cursor?: string | null;
403
237
  }
404
- interface QueryCardsResponse {
405
- /** List of cards. */
406
- cards?: Card[];
238
+ interface QueryPipelinesResponse {
239
+ /** Retrieved pipelines. */
240
+ pipelines?: Pipeline[];
407
241
  /** Paging metadata. */
408
242
  pagingMetadata?: CursorPagingMetadata;
409
243
  }
@@ -432,581 +266,33 @@ interface Cursors {
432
266
  */
433
267
  prev?: string | null;
434
268
  }
435
- interface SearchCardsRequest {
436
- /** Search options. */
437
- search?: CursorSearch;
438
- /**
439
- * Specifies how contact names should be formatted and ordered when filtering, sorting, or searching cards by contact names.
440
- * By default, names are ordered by first name followed by last name.
441
- * When set to `"BY_LAST_NAME"`, names are ordered by last name followed by first name.
442
- */
443
- nameFormat?: NameFormatWithLiterals;
444
- }
445
- interface CursorSearch extends CursorSearchPagingMethodOneOf {
446
- /**
447
- * Cursor paging options.
448
- *
449
- * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
450
- */
451
- cursorPaging?: CursorPaging;
452
- /**
453
- * Filter object.
454
- *
455
- * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
456
- */
457
- filter?: Record<string, any> | null;
458
- /**
459
- * List of sort objects.
460
- *
461
- * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
462
- * @maxSize 10
463
- */
464
- sort?: Sorting[];
465
- /**
466
- * Aggregations are a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
467
- * @maxSize 10
468
- */
469
- aggregations?: Aggregation[];
470
- /** Free text to match in searchable fields. */
471
- search?: SearchDetails;
472
- /**
473
- * UTC offset or IANA time zone. Valid values are
474
- * ISO 8601 UTC offsets, such as +02:00 or -06:00,
475
- * and IANA time zone IDs, such as Europe/Rome.
476
- *
477
- * Affects all filters and aggregations returned values.
478
- * You may override this behavior in a specific filter by providing
479
- * timestamps including time zone. For example, `"2023-12-20T10:52:34.795Z"`.
480
- * @maxLength 50
481
- */
482
- timeZone?: string | null;
483
- }
484
- /** @oneof */
485
- interface CursorSearchPagingMethodOneOf {
486
- /**
487
- * Cursor paging options.
488
- *
489
- * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
490
- */
491
- cursorPaging?: CursorPaging;
492
- }
493
- interface Aggregation extends AggregationKindOneOf {
494
- /** Value aggregation. */
495
- value?: ValueAggregation;
496
- /** Range aggregation. */
497
- range?: RangeAggregation;
498
- /** Scalar aggregation. */
499
- scalar?: ScalarAggregation;
500
- /** Date histogram aggregation. */
501
- dateHistogram?: DateHistogramAggregation;
502
- /** Nested aggregation. */
503
- nested?: NestedAggregation;
504
- /**
505
- * User-defined name of aggregation, should be unique, will appear in aggregation results.
506
- * @maxLength 100
507
- */
508
- name?: string | null;
509
- /** Type of aggregation, client must provide matching aggregation field below. */
510
- type?: AggregationTypeWithLiterals;
511
- /**
512
- * Field to aggregate by, use dot notation to specify json path.
513
- * @maxLength 200
514
- */
515
- fieldPath?: string;
516
- }
517
- /** @oneof */
518
- interface AggregationKindOneOf {
519
- /** Value aggregation. */
520
- value?: ValueAggregation;
521
- /** Range aggregation. */
522
- range?: RangeAggregation;
523
- /** Scalar aggregation. */
524
- scalar?: ScalarAggregation;
525
- /** Date histogram aggregation. */
526
- dateHistogram?: DateHistogramAggregation;
527
- /** Nested aggregation. */
528
- nested?: NestedAggregation;
529
- }
530
- interface RangeBucket {
531
- /** Inclusive lower bound of the range. Required if `to` is not provided. */
532
- from?: number | null;
533
- /** Exclusive upper bound of the range. Required if `from` is not provided. */
534
- to?: number | null;
535
- }
536
- declare enum SortType {
537
- /** Sort by number of matches. */
538
- COUNT = "COUNT",
539
- /** Sort by value of the field alphabetically. */
540
- VALUE = "VALUE"
541
- }
542
- /** @enumType */
543
- type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
544
- declare enum SortDirection {
545
- /** Sort in descending order. */
546
- DESC = "DESC",
547
- /** Sort in ascending order. */
548
- ASC = "ASC"
549
- }
550
- /** @enumType */
551
- type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
552
- declare enum MissingValues {
553
- /** Exclude missing values from the aggregation results. */
554
- EXCLUDE = "EXCLUDE",
555
- /** Include missing values in the aggregation results. */
556
- INCLUDE = "INCLUDE"
557
- }
558
- /** @enumType */
559
- type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
560
- interface IncludeMissingValuesOptions {
561
- /**
562
- * Specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
563
- * @maxLength 20
564
- */
565
- addToBucket?: string;
566
- }
567
- declare enum ScalarType {
568
- /** Count of distinct values. */
569
- COUNT_DISTINCT = "COUNT_DISTINCT",
570
- /** Minimum value. */
571
- MIN = "MIN",
572
- /** Maximum value. */
573
- MAX = "MAX"
574
- }
575
- /** @enumType */
576
- type ScalarTypeWithLiterals = ScalarType | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
577
- interface ValueAggregation extends ValueAggregationOptionsOneOf {
578
- /** Options for including missing values. */
579
- includeOptions?: IncludeMissingValuesOptions;
580
- /** Whether to sort by number of matches or value of the field. */
581
- sortType?: SortTypeWithLiterals;
582
- /** Whether to sort in ascending or descending order. */
583
- sortDirection?: SortDirectionWithLiterals;
584
- /** How many aggregations to return. Can be between 1 and 250. 10 is the default. */
585
- limit?: number | null;
586
- /** Whether to include or exclude missing values from the aggregation results. Default: `EXCLUDE`. */
587
- missingValues?: MissingValuesWithLiterals;
588
- }
589
- /** @oneof */
590
- interface ValueAggregationOptionsOneOf {
591
- /** Options for including missing values. */
592
- includeOptions?: IncludeMissingValuesOptions;
593
- }
594
- declare enum NestedAggregationType {
595
- /** An aggregation where result buckets are dynamically built - one per unique value. */
596
- VALUE = "VALUE",
597
- /** An aggregation, where user can define set of ranges - each representing a bucket. */
598
- RANGE = "RANGE",
599
- /** A single-value metric aggregation. For example, min, max, sum, avg. */
600
- SCALAR = "SCALAR",
601
- /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.). */
602
- DATE_HISTOGRAM = "DATE_HISTOGRAM"
603
- }
604
- /** @enumType */
605
- type NestedAggregationTypeWithLiterals = NestedAggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
606
- interface RangeAggregation {
607
- /**
608
- * List of range buckets, where during aggregation each entity will be placed in the first bucket its value falls into, based on the provided range bounds.
609
- * @maxSize 50
610
- */
611
- buckets?: RangeBucket[];
612
- }
613
- interface ScalarAggregation {
614
- /** Define the operator for the scalar aggregation. */
615
- type?: ScalarTypeWithLiterals;
616
- }
617
- interface DateHistogramAggregation {
618
- /** Interval for date histogram aggregation. */
619
- interval?: IntervalWithLiterals;
620
- }
621
- declare enum Interval {
622
- /** Yearly interval */
623
- YEAR = "YEAR",
624
- /** Monthly interval */
625
- MONTH = "MONTH",
626
- /** Weekly interval */
627
- WEEK = "WEEK",
628
- /** Daily interval */
629
- DAY = "DAY",
630
- /** Hourly interval */
631
- HOUR = "HOUR",
632
- /** Minute interval */
633
- MINUTE = "MINUTE",
634
- /** Second interval */
635
- SECOND = "SECOND"
636
- }
637
- /** @enumType */
638
- type IntervalWithLiterals = Interval | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
639
- interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
640
- /** Value aggregation. */
641
- value?: ValueAggregation;
642
- /** Range aggregation. */
643
- range?: RangeAggregation;
644
- /** Scalar aggregation. */
645
- scalar?: ScalarAggregation;
646
- /** Date histogram aggregation. */
647
- dateHistogram?: DateHistogramAggregation;
648
- /**
649
- * User-defined name of aggregation, should be unique, will appear in aggregation results.
650
- * @maxLength 100
651
- */
652
- name?: string | null;
653
- /** Type of aggregation, client must provide matching aggregation field below. */
654
- type?: NestedAggregationTypeWithLiterals;
655
- /**
656
- * Field to aggregate by, use dot notation to specify json path.
657
- * @maxLength 200
658
- */
659
- fieldPath?: string;
660
- }
661
- /** @oneof */
662
- interface NestedAggregationItemKindOneOf {
663
- /** Value aggregation. */
664
- value?: ValueAggregation;
665
- /** Range aggregation. */
666
- range?: RangeAggregation;
667
- /** Scalar aggregation. */
668
- scalar?: ScalarAggregation;
669
- /** Date histogram aggregation. */
670
- dateHistogram?: DateHistogramAggregation;
671
- }
672
- declare enum AggregationType {
673
- /** An aggregation where result buckets are dynamically built - one per unique value. */
674
- VALUE = "VALUE",
675
- /** An aggregation, where user can define set of ranges - each representing a bucket. */
676
- RANGE = "RANGE",
677
- /** A single-value metric aggregation. For example, min, max, sum, avg. */
678
- SCALAR = "SCALAR",
679
- /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
680
- DATE_HISTOGRAM = "DATE_HISTOGRAM",
681
- /** Multi-level aggregation, where each next aggregation is nested within previous one. */
682
- NESTED = "NESTED"
683
- }
684
- /** @enumType */
685
- type AggregationTypeWithLiterals = AggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
686
- /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
687
- interface NestedAggregation {
688
- /**
689
- * Flattened list of aggregations, where each next aggregation is nested within previous one.
690
- * @minSize 2
691
- * @maxSize 3
692
- */
693
- nestedAggregations?: NestedAggregationItem[];
694
- }
695
- interface SearchDetails {
696
- /** Defines how separate search terms in `expression` are combined. */
697
- mode?: ModeWithLiterals;
698
- /**
699
- * Search term or expression.
700
- * @maxLength 100
701
- */
702
- expression?: string | null;
703
- /**
704
- * Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path.
705
- * @maxLength 200
706
- * @maxSize 20
707
- */
708
- fields?: string[];
709
- /** Whether to use auto fuzzy search (allowing typos by a managed proximity algorithm). */
710
- fuzzy?: boolean;
711
- }
712
- declare enum Mode {
713
- /** Any of the search terms must be present. */
714
- OR = "OR",
715
- /** All search terms must be present. */
716
- AND = "AND"
717
- }
718
- /** @enumType */
719
- type ModeWithLiterals = Mode | 'OR' | 'AND';
720
- /** Name format types for sorting and searching. */
721
- declare enum NameFormat {
722
- /** Names are ordered by first name followed by last name. */
723
- BY_FIRST_NAME = "BY_FIRST_NAME",
724
- /** Names are ordered by last name followed by first name. */
725
- BY_LAST_NAME = "BY_LAST_NAME"
726
- }
727
- /** @enumType */
728
- type NameFormatWithLiterals = NameFormat | 'BY_FIRST_NAME' | 'BY_LAST_NAME';
729
- interface SearchCardsResponse {
730
- /** List of cards. */
731
- cards?: Card[];
732
- /** Paging metadata. */
733
- pagingMetadata?: CursorPagingMetadata;
734
- /** Aggregation data. */
735
- aggregationData?: AggregationData;
736
- }
737
- interface AggregationData {
738
- /**
739
- * key = aggregation name (as derived from search request).
740
- * @maxSize 10000
741
- */
742
- results?: AggregationResults[];
743
- }
744
- interface ValueAggregationResult {
745
- /**
746
- * Value of the field.
747
- * @maxLength 100
748
- */
749
- value?: string;
750
- /** Count of entities with this value. */
751
- count?: number;
752
- }
753
- interface RangeAggregationResult {
754
- /** Inclusive lower bound of the range. */
755
- from?: number | null;
756
- /** Exclusive upper bound of the range. */
757
- to?: number | null;
758
- /** Count of entities in this range. */
759
- count?: number;
760
- }
761
- interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
762
- /** Value aggregation results. */
763
- values?: ValueResults;
764
- /** Range aggregation results. */
765
- ranges?: RangeResults;
766
- /** Scalar aggregation results. */
767
- scalar?: AggregationResultsScalarResult;
768
- /**
769
- * User-defined name of aggregation, matches the one provided in request.
770
- * @maxLength 100
771
- */
772
- name?: string;
773
- /** Type of aggregation that matches result. */
774
- type?: AggregationTypeWithLiterals;
775
- /**
776
- * Field to aggregate by, matches the one provided in request.
777
- * @maxLength 200
778
- */
779
- fieldPath?: string;
780
- }
781
- /** @oneof */
782
- interface NestedAggregationResultsResultOneOf {
783
- /** Value aggregation results. */
784
- values?: ValueResults;
785
- /** Range aggregation results. */
786
- ranges?: RangeResults;
787
- /** Scalar aggregation results. */
788
- scalar?: AggregationResultsScalarResult;
789
- }
790
- interface ValueResults {
791
- /**
792
- * List of value aggregations.
793
- * @maxSize 250
794
- */
795
- results?: ValueAggregationResult[];
796
- }
797
- interface RangeResults {
798
- /**
799
- * List of ranges returned in same order as requested.
800
- * @maxSize 50
801
- */
802
- results?: RangeAggregationResult[];
803
- }
804
- interface AggregationResultsScalarResult {
805
- /** Type of scalar aggregation. */
806
- type?: ScalarTypeWithLiterals;
807
- /** Value of the scalar aggregation. */
808
- value?: number;
809
- }
810
- interface NestedValueAggregationResult {
811
- /**
812
- * Value of the field.
813
- * @maxLength 1000
814
- */
815
- value?: string;
816
- /** Nested aggregations. */
817
- nestedResults?: NestedAggregationResults;
818
- }
819
- interface ValueResult {
820
- /**
821
- * Value of the field.
822
- * @maxLength 1000
823
- */
824
- value?: string;
825
- /** Count of entities with this value. */
826
- count?: number | null;
827
- }
828
- interface RangeResult {
829
- /** Inclusive lower bound of the range. */
830
- from?: number | null;
831
- /** Exclusive upper bound of the range. */
832
- to?: number | null;
833
- /** Count of entities in this range. */
834
- count?: number | null;
835
- }
836
- interface ScalarResult {
837
- /** Value of the scalar aggregation. */
838
- value?: number;
839
- }
840
- interface NestedResultValue extends NestedResultValueResultOneOf {
841
- /** Value aggregation result. */
842
- value?: ValueResult;
843
- /** Range aggregation result. */
844
- range?: RangeResult;
845
- /** Scalar aggregation result. */
846
- scalar?: ScalarResult;
847
- /** Date histogram aggregation result. */
848
- dateHistogram?: ValueResult;
849
- }
850
- /** @oneof */
851
- interface NestedResultValueResultOneOf {
852
- /** Value aggregation result. */
853
- value?: ValueResult;
854
- /** Range aggregation result. */
855
- range?: RangeResult;
856
- /** Scalar aggregation result. */
857
- scalar?: ScalarResult;
858
- /** Date histogram aggregation result. */
859
- dateHistogram?: ValueResult;
860
- }
861
- interface Results {
862
- /** List of nested aggregations. */
863
- results?: Record<string, NestedResultValue>;
864
- }
865
- interface DateHistogramResult {
866
- /**
867
- * Date in ISO 8601 format.
868
- * @maxLength 100
869
- */
870
- value?: string;
871
- /** Count of documents in the bucket. */
872
- count?: number;
873
- }
874
- interface GroupByValueResults {
875
- /**
876
- * List of value aggregations.
877
- * @maxSize 1000
878
- */
879
- results?: NestedValueAggregationResult[];
880
- }
881
- interface DateHistogramResults {
269
+ interface BulkUpdatePipelineTagsRequest {
882
270
  /**
883
- * List of date histogram aggregations.
884
- * @maxSize 200
885
- */
886
- results?: DateHistogramResult[];
887
- }
888
- /**
889
- * Results of `NESTED` aggregation type in a flattened form.
890
- * Aggregations in resulting array are keyed by requested aggregation `name`.
891
- */
892
- interface NestedResults {
893
- /**
894
- * List of nested aggregations.
895
- * @maxSize 1000
896
- */
897
- results?: Results[];
898
- }
899
- interface AggregationResults extends AggregationResultsResultOneOf {
900
- /** Value aggregation results. */
901
- values?: ValueResults;
902
- /** Range aggregation results. */
903
- ranges?: RangeResults;
904
- /** Scalar aggregation results. */
905
- scalar?: AggregationResultsScalarResult;
906
- /** Group by value aggregation results. */
907
- groupedByValue?: GroupByValueResults;
908
- /** Date histogram aggregation results. */
909
- dateHistogram?: DateHistogramResults;
910
- /** Nested aggregation results. */
911
- nested?: NestedResults;
912
- /**
913
- * User-defined name of aggregation as derived from search request.
914
- * @maxLength 100
915
- */
916
- name?: string;
917
- /** Type of aggregation that must match provided kind as derived from search request. */
918
- type?: AggregationTypeWithLiterals;
919
- /**
920
- * Field to aggregate by as derived from search request.
921
- * @maxLength 200
922
- */
923
- fieldPath?: string;
924
- }
925
- /** @oneof */
926
- interface AggregationResultsResultOneOf {
927
- /** Value aggregation results. */
928
- values?: ValueResults;
929
- /** Range aggregation results. */
930
- ranges?: RangeResults;
931
- /** Scalar aggregation results. */
932
- scalar?: AggregationResultsScalarResult;
933
- /** Group by value aggregation results. */
934
- groupedByValue?: GroupByValueResults;
935
- /** Date histogram aggregation results. */
936
- dateHistogram?: DateHistogramResults;
937
- /** Nested aggregation results. */
938
- nested?: NestedResults;
939
- }
940
- interface SearchCardsByStageRequest {
941
- /**
942
- * ID of the pipeline in which to look for cards.
943
- * @format GUID
944
- */
945
- pipelineId: string | null;
946
- /**
947
- * Stage IDs to filter by.
948
- * @format GUID
949
- * @minSize 1
950
- * @maxSize 35
951
- */
952
- stageIds: string[];
953
- /** Search options. `search.cursorPaging.cursor` is not supported in this request and is ignored. */
954
- search?: CursorSearch;
955
- /**
956
- * Specifies how contact names should be formatted and ordered when filtering, sorting, or searching cards by contact names.
957
- * By default, names are ordered by first name followed by last name.
958
- * When set to `"BY_LAST_NAME"`, names are ordered by last name followed by first name.
959
- */
960
- nameFormat?: NameFormatWithLiterals;
961
- }
962
- interface SearchCardsByStageResponse {
963
- /**
964
- * List of card results matching the filter and search.
965
- * @minSize 1
966
- * @maxSize 30
967
- */
968
- results?: BulkSearchCardsResult[];
969
- }
970
- interface BulkSearchCardsResult {
971
- /**
972
- * ID of the pipeline containing the cards.
973
- * @format GUID
974
- */
975
- pipelineId?: string | null;
976
- /**
977
- * ID of the stage containing the cards.
978
- * @format GUID
979
- */
980
- stageId?: string | null;
981
- /** List of cards. */
982
- cards?: Card[];
983
- /** Paging metadata. */
984
- pagingMetadata?: CursorPagingMetadata;
985
- /** Aggregation data. */
986
- aggregationData?: AggregationData;
987
- }
988
- interface BulkCreateCardsRequest {
989
- /**
990
- * List of cards to create.
271
+ * List of pipeline IDs to update.
991
272
  * @minSize 1
992
273
  * @maxSize 100
274
+ * @format GUID
993
275
  */
994
- cards: Card[];
276
+ pipelineIds: string[];
277
+ /** List of tags to assign. */
278
+ assignTags?: PrivateTags;
279
+ /** List of tags to unassign. */
280
+ unassignTags?: PrivateTags;
995
281
  /**
996
- * Whether to return the created cards in the response.
282
+ * Whether to return the updated pipelines in the response.
997
283
  *
998
284
  * Default: `false`
999
285
  */
1000
286
  returnEntity?: boolean;
1001
287
  }
1002
- interface BulkCreateCardsResponse {
288
+ interface BulkUpdatePipelineTagsResponse {
1003
289
  /**
1004
- * List of cards created by the bulk operation.
290
+ * Results for each updated pipeline.
1005
291
  * @minSize 1
1006
292
  * @maxSize 100
1007
293
  */
1008
- results?: BulkCardResult[];
1009
- /** Bulk operation metadata. */
294
+ results?: BulkUpdatePipelineTagsResult[];
295
+ /** Metadata about the bulk update. */
1010
296
  bulkActionMetadata?: BulkActionMetadata;
1011
297
  }
1012
298
  interface ItemMetadata {
@@ -1030,15 +316,9 @@ interface ApplicationError {
1030
316
  /** Data related to the error. */
1031
317
  data?: Record<string, any> | null;
1032
318
  }
1033
- interface BulkCardResult {
1034
- /** Information about the card that was created. */
319
+ interface BulkUpdatePipelineTagsResult {
320
+ /** Metadata about the individual updated pipeline. */
1035
321
  itemMetadata?: ItemMetadata;
1036
- /**
1037
- * Created card.
1038
- *
1039
- * Only returned if `returnEntity` was set to `true` in the request.
1040
- */
1041
- item?: Card;
1042
322
  }
1043
323
  interface BulkActionMetadata {
1044
324
  /** Number of items that were successfully processed. */
@@ -1048,115 +328,23 @@ interface BulkActionMetadata {
1048
328
  /** Number of failures without details because detailed failure threshold was exceeded. */
1049
329
  undetailedFailures?: number;
1050
330
  }
1051
- interface BulkUpdateCardsRequest {
1052
- /**
1053
- * List of cards to update.
1054
- * @minSize 1
1055
- * @maxSize 100
1056
- * @readonly
1057
- */
1058
- cards: MaskedCard[];
1059
- /**
1060
- * Whether to return the updated cards in the response.
1061
- *
1062
- * Default: `false`
1063
- */
1064
- returnEntity?: boolean;
1065
- }
1066
- interface MaskedCard {
1067
- /**
1068
- * Card to update, may be partial.
1069
- * @readonly
1070
- */
1071
- card?: Card;
1072
- }
1073
- interface BulkUpdateCardsResponse {
1074
- /**
1075
- * List of cards updated by the bulk operation.
1076
- * @minSize 1
1077
- * @maxSize 100
1078
- */
1079
- results?: BulkUpdateCardsResponseBulkCardResult[];
1080
- /** Bulk operation metadata. */
1081
- bulkActionMetadata?: BulkActionMetadata;
1082
- }
1083
- interface BulkUpdateCardsResponseBulkCardResult {
1084
- /** Information about the card that was updated. */
1085
- itemMetadata?: ItemMetadata;
1086
- /**
1087
- * Updated card.
1088
- *
1089
- * Only returned if `returnEntity` was set to `true` in the request.
1090
- */
1091
- item?: Card;
1092
- }
1093
- interface BulkDeleteCardsRequest {
1094
- /**
1095
- * Card IDs to delete.
1096
- * @minSize 1
1097
- * @maxSize 100
1098
- * @format GUID
1099
- */
1100
- cardIds: string[];
1101
- }
1102
- interface BulkDeleteCardsResponse {
1103
- /**
1104
- * List of cards deleted by the bulk operation.
1105
- * @minSize 1
1106
- * @maxSize 100
1107
- */
1108
- results?: BulkDeleteCardsResponseBulkCardResult[];
1109
- /** Bulk operation metadata. */
1110
- bulkActionMetadata?: BulkActionMetadata;
1111
- }
1112
- interface BulkDeleteCardsResponseBulkCardResult {
1113
- /** Information about the card that was deleted. */
1114
- itemMetadata?: ItemMetadata;
1115
- }
1116
- interface BulkUpdateCardTagsRequest {
1117
- /**
1118
- * List of card IDs whose tags will be updated.
1119
- * @minSize 1
1120
- * @maxSize 100
1121
- * @format GUID
1122
- */
1123
- cardIds: string[];
331
+ interface BulkUpdatePipelineTagsByFilterRequest {
332
+ /** Filter to select which pipelines to update. */
333
+ filter: Record<string, any> | null;
1124
334
  /** List of tags to assign. */
1125
335
  assignTags?: PrivateTags;
1126
336
  /** List of tags to unassign. */
1127
337
  unassignTags?: PrivateTags;
1128
338
  /**
1129
- * Whether to return the updated cards in the response.
339
+ * Whether to return the updated pipelines in the response.
1130
340
  *
1131
341
  * Default: `false`
1132
342
  */
1133
343
  returnEntity?: boolean;
1134
344
  }
1135
- interface BulkUpdateCardTagsResponse {
345
+ interface BulkUpdatePipelineTagsByFilterResponse {
1136
346
  /**
1137
- * List of cards whose tags were updated.
1138
- * @minSize 1
1139
- * @maxSize 100
1140
- */
1141
- results?: BulkUpdateCardTagsResult[];
1142
- /** Bulk operation metadata. */
1143
- bulkActionMetadata?: BulkActionMetadata;
1144
- }
1145
- interface BulkUpdateCardTagsResult {
1146
- /** Information about the card that was updated. */
1147
- itemMetadata?: ItemMetadata;
1148
- }
1149
- interface BulkUpdateCardTagsByFilterRequest {
1150
- /** Filter object. */
1151
- filter: Record<string, any> | null;
1152
- /** List of tags to assign. */
1153
- assignTags?: PrivateTags;
1154
- /** List of tags to unassign. */
1155
- unassignTags?: PrivateTags;
1156
- }
1157
- interface BulkUpdateCardTagsByFilterResponse {
1158
- /**
1159
- * Job ID.
347
+ * Job ID for tracking the asynchronous tag updates.
1160
348
  * @format GUID
1161
349
  */
1162
350
  jobId?: string;
@@ -1225,8 +413,6 @@ interface EntityDeletedEvent {
1225
413
  interface ActionEvent {
1226
414
  bodyAsJson?: string;
1227
415
  }
1228
- interface Empty {
1229
- }
1230
416
  interface MessageEnvelope {
1231
417
  /**
1232
418
  * App instance ID.
@@ -1319,91 +505,41 @@ interface AccountInfo {
1319
505
  siteId?: string | null;
1320
506
  }
1321
507
  /** @docsIgnore */
1322
- type CreateCardApplicationErrors = {
1323
- code?: 'PIPELINE_NOT_FOUND';
508
+ type UpdatePipelineApplicationErrors = {
509
+ code?: 'CANNOT_CHANGE_DURATION_ON_STAGE_WITH_CARDS';
1324
510
  description?: string;
1325
511
  data?: Record<string, any>;
1326
512
  } | {
1327
- code?: 'STAGE_NOT_FOUND';
513
+ code?: 'CANNOT_DELETE_STAGE_WITH_CARDS';
1328
514
  description?: string;
1329
515
  data?: Record<string, any>;
1330
516
  } | {
1331
- code?: 'ASSIGNEE_NOT_FOUND';
517
+ code?: 'CANNOT_DELETE_PIPELINE_DONE_STAGE';
1332
518
  description?: string;
1333
519
  data?: Record<string, any>;
1334
520
  } | {
1335
- code?: 'CONTACTS_NOT_FOUND';
1336
- description?: string;
1337
- data?: ContactsNotFound;
1338
- } | {
1339
- code?: 'INVALID_OUTCOME';
521
+ code?: 'INSUFFICIENT_PIPELINE_DATA';
1340
522
  description?: string;
1341
523
  data?: Record<string, any>;
1342
524
  } | {
1343
- code?: 'ADDITIONAL_CONTACTS_WITHOUT_MAIN_CONTACT';
525
+ code?: 'STAGE_IDS_MUST_BE_UNIQUE';
1344
526
  description?: string;
1345
527
  data?: Record<string, any>;
1346
528
  };
1347
529
  /** @docsIgnore */
1348
- type UpdateCardApplicationErrors = {
1349
- code?: 'REVISION_MISSING';
1350
- description?: string;
1351
- data?: Record<string, any>;
1352
- } | {
1353
- code?: 'STAGE_NOT_FOUND';
1354
- description?: string;
1355
- data?: Record<string, any>;
1356
- } | {
1357
- code?: 'INVALID_OUTCOME';
1358
- description?: string;
1359
- data?: Record<string, any>;
1360
- } | {
1361
- code?: 'CANNOT_REMOVE_NAME';
1362
- description?: string;
1363
- data?: Record<string, any>;
1364
- } | {
1365
- code?: 'INVALID_ASSIGNEE_ID';
1366
- description?: string;
1367
- data?: Record<string, any>;
1368
- } | {
1369
- code?: 'INVALID_CONTACT_ID';
1370
- description?: string;
1371
- data?: Record<string, any>;
1372
- } | {
1373
- code?: 'CANNOT_CHANGE_CURRENCY';
1374
- description?: string;
1375
- data?: Record<string, any>;
1376
- } | {
1377
- code?: 'INSUFFICIENT_CARD_DATA';
1378
- description?: string;
1379
- data?: Record<string, any>;
1380
- } | {
1381
- code?: 'CONTACTS_NOT_FOUND';
1382
- description?: string;
1383
- data?: ContactsNotFound;
1384
- } | {
1385
- code?: 'ADDITIONAL_CONTACTS_WITHOUT_MAIN_CONTACT';
1386
- description?: string;
1387
- data?: Record<string, any>;
1388
- };
1389
- /** @docsIgnore */
1390
- type MoveCardApplicationErrors = {
1391
- code?: 'STAGE_NOT_FOUND';
1392
- description?: string;
1393
- data?: Record<string, any>;
1394
- } | {
1395
- code?: 'INVALID_OUTCOME';
530
+ type DeletePipelineApplicationErrors = {
531
+ code?: 'CANNOT_DELETE_NON_EMPTY_PIPELINE';
1396
532
  description?: string;
1397
533
  data?: Record<string, any>;
1398
534
  };
1399
535
  /** @docsIgnore */
1400
- type BulkUpdateCardTagsApplicationErrors = {
536
+ type BulkUpdatePipelineTagsApplicationErrors = {
1401
537
  code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
1402
538
  description?: string;
1403
539
  data?: Record<string, any>;
1404
540
  };
1405
541
  /** @docsIgnore */
1406
- type BulkUpdateCardTagsByFilterApplicationErrors = {
542
+ type BulkUpdatePipelineTagsByFilterApplicationErrors = {
1407
543
  code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
1408
544
  description?: string;
1409
545
  data?: Record<string, any>;
@@ -1419,26 +555,18 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
1419
555
  __responseType: Q;
1420
556
  __originalResponseType: R;
1421
557
  };
1422
- declare function createCard(): __PublicMethodMetaInfo<'POST', {}, CreateCardRequest$1, CreateCardRequest, CreateCardResponse$1, CreateCardResponse>;
1423
- declare function getCard(): __PublicMethodMetaInfo<'GET', {
1424
- cardId: string;
1425
- }, GetCardRequest$1, GetCardRequest, GetCardResponse$1, GetCardResponse>;
1426
- declare function updateCard(): __PublicMethodMetaInfo<'PATCH', {
1427
- cardId: string;
1428
- }, UpdateCardRequest$1, UpdateCardRequest, UpdateCardResponse$1, UpdateCardResponse>;
1429
- declare function moveCard(): __PublicMethodMetaInfo<'PATCH', {
1430
- cardId: string;
1431
- }, MoveCardRequest$1, MoveCardRequest, MoveCardResponse$1, MoveCardResponse>;
1432
- declare function deleteCard(): __PublicMethodMetaInfo<'DELETE', {
1433
- cardId: string;
1434
- }, DeleteCardRequest$1, DeleteCardRequest, DeleteCardResponse$1, DeleteCardResponse>;
1435
- declare function queryCards(): __PublicMethodMetaInfo<'GET', {}, QueryCardsRequest$1, QueryCardsRequest, QueryCardsResponse$1, QueryCardsResponse>;
1436
- declare function searchCards(): __PublicMethodMetaInfo<'GET', {}, SearchCardsRequest$1, SearchCardsRequest, SearchCardsResponse$1, SearchCardsResponse>;
1437
- declare function searchCardsByStage(): __PublicMethodMetaInfo<'GET', {}, SearchCardsByStageRequest$1, SearchCardsByStageRequest, SearchCardsByStageResponse$1, SearchCardsByStageResponse>;
1438
- declare function bulkCreateCards(): __PublicMethodMetaInfo<'POST', {}, BulkCreateCardsRequest$1, BulkCreateCardsRequest, BulkCreateCardsResponse$1, BulkCreateCardsResponse>;
1439
- declare function bulkUpdateCards(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateCardsRequest$1, BulkUpdateCardsRequest, BulkUpdateCardsResponse$1, BulkUpdateCardsResponse>;
1440
- declare function bulkDeleteCards(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteCardsRequest$1, BulkDeleteCardsRequest, BulkDeleteCardsResponse$1, BulkDeleteCardsResponse>;
1441
- declare function bulkUpdateCardTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateCardTagsRequest$1, BulkUpdateCardTagsRequest, BulkUpdateCardTagsResponse$1, BulkUpdateCardTagsResponse>;
1442
- declare function bulkUpdateCardTagsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateCardTagsByFilterRequest$1, BulkUpdateCardTagsByFilterRequest, BulkUpdateCardTagsByFilterResponse$1, BulkUpdateCardTagsByFilterResponse>;
558
+ declare function createPipeline(): __PublicMethodMetaInfo<'POST', {}, CreatePipelineRequest$1, CreatePipelineRequest, CreatePipelineResponse$1, CreatePipelineResponse>;
559
+ declare function getPipeline(): __PublicMethodMetaInfo<'GET', {
560
+ pipelineId: string;
561
+ }, GetPipelineRequest$1, GetPipelineRequest, GetPipelineResponse$1, GetPipelineResponse>;
562
+ declare function updatePipeline(): __PublicMethodMetaInfo<'PATCH', {
563
+ pipelineId: string;
564
+ }, UpdatePipelineRequest$1, UpdatePipelineRequest, UpdatePipelineResponse$1, UpdatePipelineResponse>;
565
+ declare function deletePipeline(): __PublicMethodMetaInfo<'DELETE', {
566
+ pipelineId: string;
567
+ }, DeletePipelineRequest$1, DeletePipelineRequest, DeletePipelineResponse$1, DeletePipelineResponse>;
568
+ declare function queryPipelines(): __PublicMethodMetaInfo<'GET', {}, QueryPipelinesRequest$1, QueryPipelinesRequest, QueryPipelinesResponse$1, QueryPipelinesResponse>;
569
+ declare function bulkUpdatePipelineTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdatePipelineTagsRequest$1, BulkUpdatePipelineTagsRequest, BulkUpdatePipelineTagsResponse$1, BulkUpdatePipelineTagsResponse>;
570
+ declare function bulkUpdatePipelineTagsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkUpdatePipelineTagsByFilterRequest$1, BulkUpdatePipelineTagsByFilterRequest, BulkUpdatePipelineTagsByFilterResponse$1, BulkUpdatePipelineTagsByFilterResponse>;
1443
571
 
1444
- export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AggregationData as AggregationDataOriginal, type AggregationKindOneOf as AggregationKindOneOfOriginal, type Aggregation as AggregationOriginal, type AggregationResults as AggregationResultsOriginal, type AggregationResultsResultOneOf as AggregationResultsResultOneOfOriginal, type AggregationResultsScalarResult as AggregationResultsScalarResultOriginal, AggregationType as AggregationTypeOriginal, type AggregationTypeWithLiterals as AggregationTypeWithLiteralsOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCardResult as BulkCardResultOriginal, type BulkCreateCardsRequest as BulkCreateCardsRequestOriginal, type BulkCreateCardsResponse as BulkCreateCardsResponseOriginal, type BulkDeleteCardsRequest as BulkDeleteCardsRequestOriginal, type BulkDeleteCardsResponseBulkCardResult as BulkDeleteCardsResponseBulkCardResultOriginal, type BulkDeleteCardsResponse as BulkDeleteCardsResponseOriginal, type BulkSearchCardsResult as BulkSearchCardsResultOriginal, type BulkUpdateCardTagsApplicationErrors as BulkUpdateCardTagsApplicationErrorsOriginal, type BulkUpdateCardTagsByFilterApplicationErrors as BulkUpdateCardTagsByFilterApplicationErrorsOriginal, type BulkUpdateCardTagsByFilterRequest as BulkUpdateCardTagsByFilterRequestOriginal, type BulkUpdateCardTagsByFilterResponse as BulkUpdateCardTagsByFilterResponseOriginal, type BulkUpdateCardTagsRequest as BulkUpdateCardTagsRequestOriginal, type BulkUpdateCardTagsResponse as BulkUpdateCardTagsResponseOriginal, type BulkUpdateCardTagsResult as BulkUpdateCardTagsResultOriginal, type BulkUpdateCardsRequest as BulkUpdateCardsRequestOriginal, type BulkUpdateCardsResponseBulkCardResult as BulkUpdateCardsResponseBulkCardResultOriginal, type BulkUpdateCardsResponse as BulkUpdateCardsResponseOriginal, type CardAssigned as CardAssignedOriginal, type CardMoved as CardMovedOriginal, type Card as CardOriginal, type CardOverdue as CardOverdueOriginal, type CardSource as CardSourceOriginal, type CardStale as CardStaleOriginal, type ContactInfo as ContactInfoOriginal, type ContactsNotFound as ContactsNotFoundOriginal, type CreateCardApplicationErrors as CreateCardApplicationErrorsOriginal, type CreateCardRequest as CreateCardRequestOriginal, type CreateCardResponse as CreateCardResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type DateHistogramAggregation as DateHistogramAggregationOriginal, type DateHistogramResult as DateHistogramResultOriginal, type DateHistogramResults as DateHistogramResultsOriginal, type DeleteCardRequest as DeleteCardRequestOriginal, type DeleteCardResponse as DeleteCardResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type GetCardRequest as GetCardRequestOriginal, type GetCardResponse as GetCardResponseOriginal, type GroupByValueResults as GroupByValueResultsOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type IncludeMissingValuesOptions as IncludeMissingValuesOptionsOriginal, Interval as IntervalOriginal, type IntervalWithLiterals as IntervalWithLiteralsOriginal, type ItemMetadata as ItemMetadataOriginal, type LinkedEntity as LinkedEntityOriginal, type MaskedCard as MaskedCardOriginal, type MessageEnvelope as MessageEnvelopeOriginal, MissingValues as MissingValuesOriginal, type MissingValuesWithLiterals as MissingValuesWithLiteralsOriginal, Mode as ModeOriginal, type ModeWithLiterals as ModeWithLiteralsOriginal, type Money as MoneyOriginal, type MoveCardApplicationErrors as MoveCardApplicationErrorsOriginal, type MoveCardRequest as MoveCardRequestOriginal, type MoveCardResponse as MoveCardResponseOriginal, NameFormat as NameFormatOriginal, type NameFormatWithLiterals as NameFormatWithLiteralsOriginal, type NestedAggregationItemKindOneOf as NestedAggregationItemKindOneOfOriginal, type NestedAggregationItem as NestedAggregationItemOriginal, type NestedAggregation as NestedAggregationOriginal, type NestedAggregationResults as NestedAggregationResultsOriginal, type NestedAggregationResultsResultOneOf as NestedAggregationResultsResultOneOfOriginal, NestedAggregationType as NestedAggregationTypeOriginal, type NestedAggregationTypeWithLiterals as NestedAggregationTypeWithLiteralsOriginal, type NestedResultValue as NestedResultValueOriginal, type NestedResultValueResultOneOf as NestedResultValueResultOneOfOriginal, type NestedResults as NestedResultsOriginal, type NestedValueAggregationResult as NestedValueAggregationResultOriginal, Outcome as OutcomeOriginal, type OutcomeWithLiterals as OutcomeWithLiteralsOriginal, Priority as PriorityOriginal, type PriorityWithLiterals as PriorityWithLiteralsOriginal, type PrivateTags as PrivateTagsOriginal, type QueryCardsRequest as QueryCardsRequestOriginal, type QueryCardsResponse as QueryCardsResponseOriginal, type RangeAggregation as RangeAggregationOriginal, type RangeAggregationResult as RangeAggregationResultOriginal, type RangeBucket as RangeBucketOriginal, type RangeResult as RangeResultOriginal, type RangeResults as RangeResultsOriginal, type RestoreInfo as RestoreInfoOriginal, type Results as ResultsOriginal, type ScalarAggregation as ScalarAggregationOriginal, type ScalarResult as ScalarResultOriginal, ScalarType as ScalarTypeOriginal, type ScalarTypeWithLiterals as ScalarTypeWithLiteralsOriginal, type SearchCardsByStageRequest as SearchCardsByStageRequestOriginal, type SearchCardsByStageResponse as SearchCardsByStageResponseOriginal, type SearchCardsRequest as SearchCardsRequestOriginal, type SearchCardsResponse as SearchCardsResponseOriginal, type SearchDetails as SearchDetailsOriginal, SortDirection as SortDirectionOriginal, type SortDirectionWithLiterals as SortDirectionWithLiteralsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, SortType as SortTypeOriginal, type SortTypeWithLiterals as SortTypeWithLiteralsOriginal, type Sorting as SortingOriginal, type TagList as TagListOriginal, type UpdateCardApplicationErrors as UpdateCardApplicationErrorsOriginal, type UpdateCardRequest as UpdateCardRequestOriginal, type UpdateCardResponse as UpdateCardResponseOriginal, type ValueAggregationOptionsOneOf as ValueAggregationOptionsOneOfOriginal, type ValueAggregation as ValueAggregationOriginal, type ValueAggregationResult as ValueAggregationResultOriginal, type ValueResult as ValueResultOriginal, type ValueResults as ValueResultsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkCreateCards, bulkDeleteCards, bulkUpdateCardTags, bulkUpdateCardTagsByFilter, bulkUpdateCards, createCard, deleteCard, getCard, moveCard, queryCards, searchCards, searchCardsByStage, updateCard };
572
+ export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkUpdatePipelineTagsApplicationErrors as BulkUpdatePipelineTagsApplicationErrorsOriginal, type BulkUpdatePipelineTagsByFilterApplicationErrors as BulkUpdatePipelineTagsByFilterApplicationErrorsOriginal, type BulkUpdatePipelineTagsByFilterRequest as BulkUpdatePipelineTagsByFilterRequestOriginal, type BulkUpdatePipelineTagsByFilterResponse as BulkUpdatePipelineTagsByFilterResponseOriginal, type BulkUpdatePipelineTagsRequest as BulkUpdatePipelineTagsRequestOriginal, type BulkUpdatePipelineTagsResponse as BulkUpdatePipelineTagsResponseOriginal, type BulkUpdatePipelineTagsResult as BulkUpdatePipelineTagsResultOriginal, type CreatePipelineRequest as CreatePipelineRequestOriginal, type CreatePipelineResponse as CreatePipelineResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type DeletePipelineApplicationErrors as DeletePipelineApplicationErrorsOriginal, type DeletePipelineRequest as DeletePipelineRequestOriginal, type DeletePipelineResponse as DeletePipelineResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DoneStage as DoneStageOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type GetPipelineRequest as GetPipelineRequestOriginal, type GetPipelineResponse as GetPipelineResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ItemMetadata as ItemMetadataOriginal, type MessageEnvelope as MessageEnvelopeOriginal, Outcome as OutcomeOriginal, type OutcomeWithLiterals as OutcomeWithLiteralsOriginal, type Pipeline as PipelineOriginal, type PrivateTags as PrivateTagsOriginal, type QueryPipelinesRequest as QueryPipelinesRequestOriginal, type QueryPipelinesResponse as QueryPipelinesResponseOriginal, type RestoreInfo as RestoreInfoOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type Stage as StageOriginal, type TagList as TagListOriginal, type UpdatePipelineApplicationErrors as UpdatePipelineApplicationErrorsOriginal, type UpdatePipelineRequest as UpdatePipelineRequestOriginal, type UpdatePipelineResponse as UpdatePipelineResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkUpdatePipelineTags, bulkUpdatePipelineTagsByFilter, createPipeline, deletePipeline, getPipeline, queryPipelines, updatePipeline };