@wix/workflows 1.0.26 → 1.0.28

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.
@@ -0,0 +1,1617 @@
1
+ interface Card$5 {
2
+ /** Card details. */
3
+ info?: CardInfo$5;
4
+ }
5
+ /** entity representing a card-info */
6
+ interface CardInfo$5 {
7
+ /**
8
+ * Card ID.
9
+ * @readonly
10
+ */
11
+ id?: string | null;
12
+ /** Display name shown at the top of the card. */
13
+ name?: string | null;
14
+ /** Card description. */
15
+ description?: string | null;
16
+ /** Details about the contact attached to the card. */
17
+ primaryAttachment?: Attachment$5;
18
+ /** Due date. */
19
+ dueDate?: Date;
20
+ /** Name of the app or service that created the contact. */
21
+ source?: string | null;
22
+ /**
23
+ * Deprecated. Use `createdDate` instead.
24
+ * @readonly
25
+ * @deprecated
26
+ */
27
+ createdAt?: Date;
28
+ /**
29
+ * Deprecated. Use `updatedDate` instead.
30
+ * @readonly
31
+ * @deprecated
32
+ */
33
+ updatedAt?: Date;
34
+ /**
35
+ * ID of the phase that currently holds the card.
36
+ * @readonly
37
+ */
38
+ phaseId?: string | null;
39
+ /**
40
+ * Date and time the card was created.
41
+ * @readonly
42
+ */
43
+ createdDate?: Date;
44
+ /**
45
+ * Date and time the card was updated.
46
+ * @readonly
47
+ */
48
+ updatedDate?: Date;
49
+ }
50
+ interface Attachment$5 {
51
+ /**
52
+ * Attachment ID. For internal use.
53
+ * @readonly
54
+ */
55
+ attachmentId?: string;
56
+ /**
57
+ * Deprecated. Use `contactId` instead.
58
+ * @deprecated
59
+ */
60
+ value?: string;
61
+ /**
62
+ * Deprecated. For internal use.
63
+ * @deprecated
64
+ */
65
+ attachmentType?: AttachmentType$5;
66
+ /** ID of the contact attached to the card. */
67
+ contactId?: string;
68
+ }
69
+ /** describes the supported types of attachments (currently only supports Contact which is the default type) */
70
+ declare enum AttachmentType$5 {
71
+ ContactType = "ContactType"
72
+ }
73
+ interface PaginationResponse$5 {
74
+ /** Number of items that were skipped in the current sort order. */
75
+ offset?: number;
76
+ /** Total number of items that matched the filter. */
77
+ total?: number;
78
+ /** Number of returned items. */
79
+ count?: number;
80
+ }
81
+ interface ListCardsRequest$1 {
82
+ /** ID of the workflow whose cards will be listed. */
83
+ workflowId: string;
84
+ /** Filters for cards in the specified phase. */
85
+ phaseId?: string | null;
86
+ /**
87
+ * Number of items to return.
88
+ *
89
+ * Defaults to `50`.
90
+ */
91
+ limit?: number | null;
92
+ /**
93
+ * Number of items to skip in the current sort order.
94
+ *
95
+ * Defaults to `0`.
96
+ */
97
+ offset?: number | null;
98
+ /** Filters for cards with the specified contact ID. */
99
+ attachmentValue?: string | null;
100
+ /**
101
+ * Filters for archived cards.
102
+ * If set to `true`,
103
+ * only archived cards are returned.
104
+ * If set to `false`,
105
+ * only cards that are not archived are returned.
106
+ *
107
+ * Defaults to `false`.
108
+ */
109
+ fetchArchived?: boolean | null;
110
+ /**
111
+ * Supported fields:
112
+ * `id`, `name`, `createdDate`, `updatedDate`, `phaseId`
113
+ *
114
+ * List of fields to sort by.
115
+ * Formatted as `field:direction`,
116
+ * where field is the field name
117
+ * and direction is `asc` (ascending) or `desc` (descending).
118
+ *
119
+ * Sorting is applied lexicographically, so `"abc"` comes after `"XYZ"`.
120
+ */
121
+ sort?: string[];
122
+ }
123
+ interface ListCardsResponse$1 {
124
+ /** List of cards. */
125
+ cards?: Card$5[];
126
+ /** Metadata for the page of results. */
127
+ pagination?: PaginationResponse$5;
128
+ }
129
+ interface GetCardRequest$1 {
130
+ /** ID of the card to retrieve. */
131
+ id: string;
132
+ }
133
+ interface GetCardResponse$1 {
134
+ /** Requested card. */
135
+ card?: Card$5;
136
+ }
137
+ interface UpdateCardRequest$1 {
138
+ /** ID of the card to update. */
139
+ id: string;
140
+ /** Card details. */
141
+ cardInfo?: CardInfo$5;
142
+ }
143
+ interface UpdateCardResponse$1 {
144
+ }
145
+ interface CreateCardRequest$1 {
146
+ /** ID of the workflow to create the card in. */
147
+ workflowId: string;
148
+ /** ID of the phase to create the card in. */
149
+ phaseId: string;
150
+ /** Card details. */
151
+ card?: CardInfo$5;
152
+ /**
153
+ * Card position, where the first card is `0`.
154
+ *
155
+ * If a card already occupies the specified position,
156
+ * that card and any subsequent cards are shifted to the right by 1.
157
+ *
158
+ * Defaults to the last position.
159
+ */
160
+ position?: number | null;
161
+ }
162
+ interface CreateCardResponse$1 {
163
+ /** ID of the newly created card. */
164
+ id?: string | null;
165
+ }
166
+ interface DeleteCardRequest$1 {
167
+ /** ID of the card to delete. */
168
+ id: string;
169
+ }
170
+ interface DeleteCardResponse$1 {
171
+ }
172
+ interface MoveCardRequest$1 {
173
+ /** ID of the card to move. */
174
+ id: string;
175
+ /** ID of the phase to move the card to. */
176
+ newPhaseId?: string | null;
177
+ /** Position of the card in the phase, where the first card is `0`. */
178
+ newPosition?: number | null;
179
+ }
180
+ interface MoveCardResponse$1 {
181
+ }
182
+ interface RestoreCardRequest$1 {
183
+ /** ID of the card to restore. */
184
+ id: string;
185
+ /** ID of the phase to restore the card to. */
186
+ newPhaseId: string;
187
+ /**
188
+ * Position of the restored card in the phase,
189
+ * where the first card is `0`.
190
+ */
191
+ newPosition?: number | null;
192
+ }
193
+ interface RestoreCardResponse$1 {
194
+ }
195
+ interface ArchiveCardRequest$1 {
196
+ /** ID of the card to archive. */
197
+ id: string;
198
+ }
199
+ interface ArchiveCardResponse$1 {
200
+ }
201
+ interface ListCardsResponseNonNullableFields$1 {
202
+ cards: {
203
+ info?: {
204
+ primaryAttachment?: {
205
+ attachmentId: string;
206
+ value: string;
207
+ attachmentType: AttachmentType$5;
208
+ contactId: string;
209
+ };
210
+ };
211
+ }[];
212
+ pagination?: {
213
+ offset: number;
214
+ limit: number;
215
+ total: number;
216
+ count: number;
217
+ };
218
+ }
219
+ interface GetCardResponseNonNullableFields$1 {
220
+ card?: {
221
+ info?: {
222
+ primaryAttachment?: {
223
+ attachmentId: string;
224
+ value: string;
225
+ attachmentType: AttachmentType$5;
226
+ contactId: string;
227
+ };
228
+ };
229
+ };
230
+ }
231
+
232
+ interface Card$4 {
233
+ /** Card details. */
234
+ info?: CardInfo$4;
235
+ }
236
+ /** entity representing a card-info */
237
+ interface CardInfo$4 {
238
+ /**
239
+ * Card ID.
240
+ * @readonly
241
+ */
242
+ _id?: string | null;
243
+ /** Display name shown at the top of the card. */
244
+ name?: string | null;
245
+ /** Card description. */
246
+ description?: string | null;
247
+ /** Details about the contact attached to the card. */
248
+ primaryAttachment?: Attachment$4;
249
+ /** Due date. */
250
+ dueDate?: Date;
251
+ /** Name of the app or service that created the contact. */
252
+ source?: string | null;
253
+ /**
254
+ * @internal
255
+ * @internal
256
+ * @readonly
257
+ * @deprecated
258
+ */
259
+ createdAt?: Date;
260
+ /**
261
+ * @internal
262
+ * @internal
263
+ * @readonly
264
+ * @deprecated
265
+ */
266
+ updatedAt?: Date;
267
+ /**
268
+ * ID of the phase that currently holds the card.
269
+ * @readonly
270
+ */
271
+ phaseId?: string | null;
272
+ /**
273
+ * Date and time the card was created.
274
+ * @readonly
275
+ */
276
+ _createdDate?: Date;
277
+ /**
278
+ * Date and time the card was updated.
279
+ * @readonly
280
+ */
281
+ _updatedDate?: Date;
282
+ }
283
+ interface Attachment$4 {
284
+ /**
285
+ * Attachment ID. For internal use.
286
+ * @readonly
287
+ */
288
+ attachmentId?: string;
289
+ /**
290
+ * @internal
291
+ * @internal
292
+ * @deprecated
293
+ */
294
+ value?: string;
295
+ /**
296
+ * @internal
297
+ * @internal
298
+ * @deprecated
299
+ */
300
+ attachmentType?: AttachmentType$4;
301
+ /** ID of the contact attached to the card. */
302
+ contactId?: string;
303
+ }
304
+ /** describes the supported types of attachments (currently only supports Contact which is the default type) */
305
+ declare enum AttachmentType$4 {
306
+ ContactType = "ContactType"
307
+ }
308
+ interface PaginationResponse$4 {
309
+ /** Number of items that were skipped in the current sort order. */
310
+ offset?: number;
311
+ /** Total number of items that matched the filter. */
312
+ total?: number;
313
+ /** Number of returned items. */
314
+ count?: number;
315
+ }
316
+ interface ListCardsRequest {
317
+ /** ID of the workflow whose cards will be listed. */
318
+ workflowId: string;
319
+ /** Filters for cards in the specified phase. */
320
+ phaseId?: string | null;
321
+ /**
322
+ * Number of items to return.
323
+ *
324
+ * Defaults to `50`.
325
+ */
326
+ limit?: number | null;
327
+ /**
328
+ * Number of items to skip in the current sort order.
329
+ *
330
+ * Defaults to `0`.
331
+ */
332
+ offset?: number | null;
333
+ /** Filters for cards with the specified contact ID. */
334
+ attachmentValue?: string | null;
335
+ /**
336
+ * Filters for archived cards.
337
+ * If set to `true`,
338
+ * only archived cards are returned.
339
+ * If set to `false`,
340
+ * only cards that are not archived are returned.
341
+ *
342
+ * Defaults to `false`.
343
+ */
344
+ fetchArchived?: boolean | null;
345
+ /**
346
+ * Supported fields:
347
+ * `id`, `name`, `createdDate`, `updatedDate`, `phaseId`
348
+ *
349
+ * List of fields to sort by.
350
+ * Formatted as `field:direction`,
351
+ * where field is the field name
352
+ * and direction is `asc` (ascending) or `desc` (descending).
353
+ *
354
+ * Sorting is applied lexicographically, so `"abc"` comes after `"XYZ"`.
355
+ */
356
+ sort?: string[];
357
+ }
358
+ interface ListCardsResponse {
359
+ /** List of cards. */
360
+ cards?: Card$4[];
361
+ /** Metadata for the page of results. */
362
+ pagination?: PaginationResponse$4;
363
+ }
364
+ interface GetCardRequest {
365
+ /** ID of the card to retrieve. */
366
+ _id: string;
367
+ }
368
+ interface GetCardResponse {
369
+ /** Requested card. */
370
+ card?: Card$4;
371
+ }
372
+ interface UpdateCardRequest {
373
+ /** ID of the card to update. */
374
+ _id: string;
375
+ /** Card details. */
376
+ cardInfo?: CardInfo$4;
377
+ }
378
+ interface UpdateCardResponse {
379
+ }
380
+ interface CreateCardRequest {
381
+ /** ID of the workflow to create the card in. */
382
+ workflowId: string;
383
+ /** ID of the phase to create the card in. */
384
+ phaseId: string;
385
+ /** Card details. */
386
+ card?: CardInfo$4;
387
+ /**
388
+ * Card position, where the first card is `0`.
389
+ *
390
+ * If a card already occupies the specified position,
391
+ * that card and any subsequent cards are shifted to the right by 1.
392
+ *
393
+ * Defaults to the last position.
394
+ */
395
+ position?: number | null;
396
+ }
397
+ interface CreateCardResponse {
398
+ /** ID of the newly created card. */
399
+ _id?: string | null;
400
+ }
401
+ interface DeleteCardRequest {
402
+ /** ID of the card to delete. */
403
+ _id: string;
404
+ }
405
+ interface DeleteCardResponse {
406
+ }
407
+ interface MoveCardRequest {
408
+ /** ID of the card to move. */
409
+ _id: string;
410
+ /** ID of the phase to move the card to. */
411
+ newPhaseId?: string | null;
412
+ /** Position of the card in the phase, where the first card is `0`. */
413
+ newPosition?: number | null;
414
+ }
415
+ interface MoveCardResponse {
416
+ }
417
+ interface RestoreCardRequest {
418
+ /** ID of the card to restore. */
419
+ _id: string;
420
+ /** ID of the phase to restore the card to. */
421
+ newPhaseId: string;
422
+ /**
423
+ * Position of the restored card in the phase,
424
+ * where the first card is `0`.
425
+ */
426
+ newPosition?: number | null;
427
+ }
428
+ interface RestoreCardResponse {
429
+ }
430
+ interface ArchiveCardRequest {
431
+ /** ID of the card to archive. */
432
+ _id: string;
433
+ }
434
+ interface ArchiveCardResponse {
435
+ }
436
+ interface ListCardsResponseNonNullableFields {
437
+ cards: {
438
+ info?: {
439
+ primaryAttachment?: {
440
+ attachmentId: string;
441
+ value: string;
442
+ attachmentType: AttachmentType$4;
443
+ contactId: string;
444
+ };
445
+ };
446
+ }[];
447
+ pagination?: {
448
+ offset: number;
449
+ total: number;
450
+ count: number;
451
+ };
452
+ }
453
+ interface GetCardResponseNonNullableFields {
454
+ card?: {
455
+ info?: {
456
+ primaryAttachment?: {
457
+ attachmentId: string;
458
+ value: string;
459
+ attachmentType: AttachmentType$4;
460
+ contactId: string;
461
+ };
462
+ };
463
+ };
464
+ }
465
+
466
+ type __PublicMethodMetaInfo$2<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
467
+ getUrl: (context: any) => string;
468
+ httpMethod: K;
469
+ path: string;
470
+ pathParams: M;
471
+ __requestType: T;
472
+ __originalRequestType: S;
473
+ __responseType: Q;
474
+ __originalResponseType: R;
475
+ };
476
+ declare function listCards(): __PublicMethodMetaInfo$2<'GET', {
477
+ workflowId: string;
478
+ }, ListCardsRequest, ListCardsRequest$1, ListCardsResponse & ListCardsResponseNonNullableFields, ListCardsResponse$1 & ListCardsResponseNonNullableFields$1>;
479
+ declare function getCard(): __PublicMethodMetaInfo$2<'GET', {
480
+ id: string;
481
+ }, GetCardRequest, GetCardRequest$1, GetCardResponse & GetCardResponseNonNullableFields, GetCardResponse$1 & GetCardResponseNonNullableFields$1>;
482
+ declare function updateCard(): __PublicMethodMetaInfo$2<'PATCH', {
483
+ id: string;
484
+ }, UpdateCardRequest, UpdateCardRequest$1, UpdateCardResponse, UpdateCardResponse$1>;
485
+ declare function createCard(): __PublicMethodMetaInfo$2<'POST', {
486
+ workflowId: string;
487
+ phaseId: string;
488
+ }, CreateCardRequest, CreateCardRequest$1, CreateCardResponse, CreateCardResponse$1>;
489
+ declare function deleteCard(): __PublicMethodMetaInfo$2<'DELETE', {
490
+ id: string;
491
+ }, DeleteCardRequest, DeleteCardRequest$1, DeleteCardResponse, DeleteCardResponse$1>;
492
+ declare function moveCard(): __PublicMethodMetaInfo$2<'POST', {
493
+ id: string;
494
+ }, MoveCardRequest, MoveCardRequest$1, MoveCardResponse, MoveCardResponse$1>;
495
+ declare function restoreCard(): __PublicMethodMetaInfo$2<'POST', {
496
+ id: string;
497
+ }, RestoreCardRequest, RestoreCardRequest$1, RestoreCardResponse, RestoreCardResponse$1>;
498
+ declare function archiveCard(): __PublicMethodMetaInfo$2<'POST', {
499
+ id: string;
500
+ }, ArchiveCardRequest, ArchiveCardRequest$1, ArchiveCardResponse, ArchiveCardResponse$1>;
501
+
502
+ declare const meta$2_archiveCard: typeof archiveCard;
503
+ declare const meta$2_createCard: typeof createCard;
504
+ declare const meta$2_deleteCard: typeof deleteCard;
505
+ declare const meta$2_getCard: typeof getCard;
506
+ declare const meta$2_listCards: typeof listCards;
507
+ declare const meta$2_moveCard: typeof moveCard;
508
+ declare const meta$2_restoreCard: typeof restoreCard;
509
+ declare const meta$2_updateCard: typeof updateCard;
510
+ declare namespace meta$2 {
511
+ export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$2_archiveCard as archiveCard, meta$2_createCard as createCard, meta$2_deleteCard as deleteCard, meta$2_getCard as getCard, meta$2_listCards as listCards, meta$2_moveCard as moveCard, meta$2_restoreCard as restoreCard, meta$2_updateCard as updateCard };
512
+ }
513
+
514
+ interface Phase$3 {
515
+ /** Phase information. */
516
+ info?: PhaseInfo$3;
517
+ /** Cards contained in the phase. */
518
+ cardsList?: CardsList$3;
519
+ }
520
+ interface PhaseInfo$3 {
521
+ /**
522
+ * Phase ID.
523
+ * @readonly
524
+ */
525
+ id?: string | null;
526
+ /** Display name shown at the top of the phase. */
527
+ name?: string | null;
528
+ }
529
+ /** a list of cards (a page) along with the total number */
530
+ interface CardsList$3 {
531
+ /** Total number of cards in the phase. */
532
+ total?: number;
533
+ /**
534
+ * List of cards in the phase.
535
+ * Sorted according to the card display order, from top to bottom.
536
+ */
537
+ cards?: Card$3[];
538
+ }
539
+ interface Card$3 {
540
+ /** Card details. */
541
+ info?: CardInfo$3;
542
+ }
543
+ /** entity representing a card-info */
544
+ interface CardInfo$3 {
545
+ /**
546
+ * Card ID.
547
+ * @readonly
548
+ */
549
+ id?: string | null;
550
+ /** Display name shown at the top of the card. */
551
+ name?: string | null;
552
+ /** Card description. */
553
+ description?: string | null;
554
+ /** Details about the contact attached to the card. */
555
+ primaryAttachment?: Attachment$3;
556
+ /** Due date. */
557
+ dueDate?: Date;
558
+ /** Name of the app or service that created the contact. */
559
+ source?: string | null;
560
+ /**
561
+ * Deprecated. Use `createdDate` instead.
562
+ * @readonly
563
+ * @deprecated
564
+ */
565
+ createdAt?: Date;
566
+ /**
567
+ * Deprecated. Use `updatedDate` instead.
568
+ * @readonly
569
+ * @deprecated
570
+ */
571
+ updatedAt?: Date;
572
+ /**
573
+ * ID of the phase that currently holds the card.
574
+ * @readonly
575
+ */
576
+ phaseId?: string | null;
577
+ /**
578
+ * Date and time the card was created.
579
+ * @readonly
580
+ */
581
+ createdDate?: Date;
582
+ /**
583
+ * Date and time the card was updated.
584
+ * @readonly
585
+ */
586
+ updatedDate?: Date;
587
+ }
588
+ interface Attachment$3 {
589
+ /**
590
+ * Attachment ID. For internal use.
591
+ * @readonly
592
+ */
593
+ attachmentId?: string;
594
+ /**
595
+ * Deprecated. Use `contactId` instead.
596
+ * @deprecated
597
+ */
598
+ value?: string;
599
+ /**
600
+ * Deprecated. For internal use.
601
+ * @deprecated
602
+ */
603
+ attachmentType?: AttachmentType$3;
604
+ /** ID of the contact attached to the card. */
605
+ contactId?: string;
606
+ }
607
+ /** describes the supported types of attachments (currently only supports Contact which is the default type) */
608
+ declare enum AttachmentType$3 {
609
+ ContactType = "ContactType"
610
+ }
611
+ interface PaginationResponse$3 {
612
+ /** Number of items that were skipped in the current sort order. */
613
+ offset?: number;
614
+ /** Total number of items that matched the filter. */
615
+ total?: number;
616
+ /** Number of returned items. */
617
+ count?: number;
618
+ }
619
+ interface ListPhasesRequest$1 {
620
+ /** ID of the workflow whose phases will be listed. */
621
+ workflowId: string;
622
+ /** Number of items to return. */
623
+ limit?: number | null;
624
+ /**
625
+ * Number of items to skip in the current sort order.
626
+ *
627
+ * Defaults to `0`.
628
+ */
629
+ offset?: number | null;
630
+ /**
631
+ * Supported fields:
632
+ * `id`, `name`
633
+ *
634
+ * List of fields to sort by.
635
+ * Formatted as `field:direction`,
636
+ * where field is the field name
637
+ * and direction is `asc` (ascending) or `desc` (descending).
638
+ *
639
+ * Sorting is applied lexicographically, so `"abc"` comes after `"XYZ"`.
640
+ */
641
+ sort?: string[];
642
+ }
643
+ interface ListPhasesResponse$1 {
644
+ /** List of phases. */
645
+ phases?: Phase$3[];
646
+ /** Metadata for the page of results. */
647
+ pagination?: PaginationResponse$3;
648
+ }
649
+ interface GetPhaseRequest$1 {
650
+ /** ID of the phase to retrieve. */
651
+ id: string;
652
+ }
653
+ interface GetPhaseResponse$1 {
654
+ /** Requested phase. */
655
+ phase?: Phase$3;
656
+ }
657
+ interface UpdatePhaseRequest$1 {
658
+ /** ID of the phase to update. */
659
+ id: string;
660
+ /** Phase details to update. */
661
+ phase?: PhaseInfo$3;
662
+ }
663
+ interface UpdatePhaseResponse$1 {
664
+ }
665
+ interface CreatePhaseRequest$1 {
666
+ /** ID of the workflow to create the phase in. */
667
+ workflowId: string;
668
+ /** Phase details. */
669
+ phase?: PhaseInfo$3;
670
+ /**
671
+ * Phase position, where the first phase is `0`.
672
+ *
673
+ * If a phase already occupies the specified position,
674
+ * that phase and any subsequent phases
675
+ * are shifted to the right by 1.
676
+ *
677
+ * Defaults to the last position,
678
+ * which is displayed before the win phase.
679
+ */
680
+ position?: number | null;
681
+ }
682
+ interface CreatePhaseResponse$1 {
683
+ /** ID of the newly created phase. */
684
+ id?: string | null;
685
+ }
686
+ interface DeletePhaseRequest$1 {
687
+ /** ID of the phase to delete. */
688
+ id: string;
689
+ }
690
+ interface DeletePhaseResponse$1 {
691
+ }
692
+ interface MovePhaseRequest$1 {
693
+ /** ID of the workflow that contains the phase to move. */
694
+ workflowId: string;
695
+ /** ID of the phase to move. */
696
+ id: string;
697
+ /**
698
+ * New phase position, where the first phase is `0`.
699
+ *
700
+ * If a phase already occupies the specified position,
701
+ * that phase and any subsequent phases
702
+ * are shifted to the right by 1.
703
+ */
704
+ newPosition: number | null;
705
+ }
706
+ interface MovePhaseResponse$1 {
707
+ }
708
+ interface ListPhasesResponseNonNullableFields$1 {
709
+ phases: {
710
+ cardsList?: {
711
+ total: number;
712
+ cards: {
713
+ info?: {
714
+ primaryAttachment?: {
715
+ attachmentId: string;
716
+ value: string;
717
+ attachmentType: AttachmentType$3;
718
+ contactId: string;
719
+ };
720
+ };
721
+ }[];
722
+ };
723
+ }[];
724
+ pagination?: {
725
+ offset: number;
726
+ limit: number;
727
+ total: number;
728
+ count: number;
729
+ };
730
+ }
731
+ interface GetPhaseResponseNonNullableFields$1 {
732
+ phase?: {
733
+ cardsList?: {
734
+ total: number;
735
+ cards: {
736
+ info?: {
737
+ primaryAttachment?: {
738
+ attachmentId: string;
739
+ value: string;
740
+ attachmentType: AttachmentType$3;
741
+ contactId: string;
742
+ };
743
+ };
744
+ }[];
745
+ };
746
+ };
747
+ }
748
+
749
+ interface Phase$2 {
750
+ /** Phase information. */
751
+ info?: PhaseInfo$2;
752
+ /** Cards contained in the phase. */
753
+ cardsList?: CardsList$2;
754
+ }
755
+ interface PhaseInfo$2 {
756
+ /**
757
+ * Phase ID.
758
+ * @readonly
759
+ */
760
+ _id?: string | null;
761
+ /** Display name shown at the top of the phase. */
762
+ name?: string | null;
763
+ }
764
+ /** a list of cards (a page) along with the total number */
765
+ interface CardsList$2 {
766
+ /** Total number of cards in the phase. */
767
+ total?: number;
768
+ /**
769
+ * List of cards in the phase.
770
+ * Sorted according to the card display order, from top to bottom.
771
+ */
772
+ cards?: Card$2[];
773
+ }
774
+ interface Card$2 {
775
+ /** Card details. */
776
+ info?: CardInfo$2;
777
+ }
778
+ /** entity representing a card-info */
779
+ interface CardInfo$2 {
780
+ /**
781
+ * Card ID.
782
+ * @readonly
783
+ */
784
+ _id?: string | null;
785
+ /** Display name shown at the top of the card. */
786
+ name?: string | null;
787
+ /** Card description. */
788
+ description?: string | null;
789
+ /** Details about the contact attached to the card. */
790
+ primaryAttachment?: Attachment$2;
791
+ /** Due date. */
792
+ dueDate?: Date;
793
+ /** Name of the app or service that created the contact. */
794
+ source?: string | null;
795
+ /**
796
+ * @internal
797
+ * @internal
798
+ * @readonly
799
+ * @deprecated
800
+ */
801
+ createdAt?: Date;
802
+ /**
803
+ * @internal
804
+ * @internal
805
+ * @readonly
806
+ * @deprecated
807
+ */
808
+ updatedAt?: Date;
809
+ /**
810
+ * ID of the phase that currently holds the card.
811
+ * @readonly
812
+ */
813
+ phaseId?: string | null;
814
+ /**
815
+ * Date and time the card was created.
816
+ * @readonly
817
+ */
818
+ _createdDate?: Date;
819
+ /**
820
+ * Date and time the card was updated.
821
+ * @readonly
822
+ */
823
+ _updatedDate?: Date;
824
+ }
825
+ interface Attachment$2 {
826
+ /**
827
+ * Attachment ID. For internal use.
828
+ * @readonly
829
+ */
830
+ attachmentId?: string;
831
+ /**
832
+ * @internal
833
+ * @internal
834
+ * @deprecated
835
+ */
836
+ value?: string;
837
+ /**
838
+ * @internal
839
+ * @internal
840
+ * @deprecated
841
+ */
842
+ attachmentType?: AttachmentType$2;
843
+ /** ID of the contact attached to the card. */
844
+ contactId?: string;
845
+ }
846
+ /** describes the supported types of attachments (currently only supports Contact which is the default type) */
847
+ declare enum AttachmentType$2 {
848
+ ContactType = "ContactType"
849
+ }
850
+ interface PaginationResponse$2 {
851
+ /** Number of items that were skipped in the current sort order. */
852
+ offset?: number;
853
+ /** Total number of items that matched the filter. */
854
+ total?: number;
855
+ /** Number of returned items. */
856
+ count?: number;
857
+ }
858
+ interface ListPhasesRequest {
859
+ /** ID of the workflow whose phases will be listed. */
860
+ workflowId: string;
861
+ /** Number of items to return. */
862
+ limit?: number | null;
863
+ /**
864
+ * Number of items to skip in the current sort order.
865
+ *
866
+ * Defaults to `0`.
867
+ */
868
+ offset?: number | null;
869
+ /**
870
+ * Supported fields:
871
+ * `id`, `name`
872
+ *
873
+ * List of fields to sort by.
874
+ * Formatted as `field:direction`,
875
+ * where field is the field name
876
+ * and direction is `asc` (ascending) or `desc` (descending).
877
+ *
878
+ * Sorting is applied lexicographically, so `"abc"` comes after `"XYZ"`.
879
+ */
880
+ sort?: string[];
881
+ }
882
+ interface ListPhasesResponse {
883
+ /** List of phases. */
884
+ phases?: Phase$2[];
885
+ /** Metadata for the page of results. */
886
+ pagination?: PaginationResponse$2;
887
+ }
888
+ interface GetPhaseRequest {
889
+ /** ID of the phase to retrieve. */
890
+ _id: string;
891
+ }
892
+ interface GetPhaseResponse {
893
+ /** Requested phase. */
894
+ phase?: Phase$2;
895
+ }
896
+ interface UpdatePhaseRequest {
897
+ /** ID of the phase to update. */
898
+ _id: string;
899
+ /** Phase details to update. */
900
+ phase?: PhaseInfo$2;
901
+ }
902
+ interface UpdatePhaseResponse {
903
+ }
904
+ interface CreatePhaseRequest {
905
+ /** ID of the workflow to create the phase in. */
906
+ workflowId: string;
907
+ /** Phase details. */
908
+ phase?: PhaseInfo$2;
909
+ /**
910
+ * Phase position, where the first phase is `0`.
911
+ *
912
+ * If a phase already occupies the specified position,
913
+ * that phase and any subsequent phases
914
+ * are shifted to the right by 1.
915
+ *
916
+ * Defaults to the last position,
917
+ * which is displayed before the win phase.
918
+ */
919
+ position?: number | null;
920
+ }
921
+ interface CreatePhaseResponse {
922
+ /** ID of the newly created phase. */
923
+ _id?: string | null;
924
+ }
925
+ interface DeletePhaseRequest {
926
+ /** ID of the phase to delete. */
927
+ _id: string;
928
+ }
929
+ interface DeletePhaseResponse {
930
+ }
931
+ interface MovePhaseRequest {
932
+ /** ID of the workflow that contains the phase to move. */
933
+ workflowId: string;
934
+ /** ID of the phase to move. */
935
+ _id: string;
936
+ /**
937
+ * New phase position, where the first phase is `0`.
938
+ *
939
+ * If a phase already occupies the specified position,
940
+ * that phase and any subsequent phases
941
+ * are shifted to the right by 1.
942
+ */
943
+ newPosition: number | null;
944
+ }
945
+ interface MovePhaseResponse {
946
+ }
947
+ interface ListPhasesResponseNonNullableFields {
948
+ phases: {
949
+ cardsList?: {
950
+ total: number;
951
+ cards: {
952
+ info?: {
953
+ primaryAttachment?: {
954
+ attachmentId: string;
955
+ value: string;
956
+ attachmentType: AttachmentType$2;
957
+ contactId: string;
958
+ };
959
+ };
960
+ }[];
961
+ };
962
+ }[];
963
+ pagination?: {
964
+ offset: number;
965
+ total: number;
966
+ count: number;
967
+ };
968
+ }
969
+ interface GetPhaseResponseNonNullableFields {
970
+ phase?: {
971
+ cardsList?: {
972
+ total: number;
973
+ cards: {
974
+ info?: {
975
+ primaryAttachment?: {
976
+ attachmentId: string;
977
+ value: string;
978
+ attachmentType: AttachmentType$2;
979
+ contactId: string;
980
+ };
981
+ };
982
+ }[];
983
+ };
984
+ };
985
+ }
986
+
987
+ type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
988
+ getUrl: (context: any) => string;
989
+ httpMethod: K;
990
+ path: string;
991
+ pathParams: M;
992
+ __requestType: T;
993
+ __originalRequestType: S;
994
+ __responseType: Q;
995
+ __originalResponseType: R;
996
+ };
997
+ declare function listPhases(): __PublicMethodMetaInfo$1<'GET', {
998
+ workflowId: string;
999
+ }, ListPhasesRequest, ListPhasesRequest$1, ListPhasesResponse & ListPhasesResponseNonNullableFields, ListPhasesResponse$1 & ListPhasesResponseNonNullableFields$1>;
1000
+ declare function getPhase(): __PublicMethodMetaInfo$1<'GET', {
1001
+ id: string;
1002
+ }, GetPhaseRequest, GetPhaseRequest$1, GetPhaseResponse & GetPhaseResponseNonNullableFields, GetPhaseResponse$1 & GetPhaseResponseNonNullableFields$1>;
1003
+ declare function updatePhase(): __PublicMethodMetaInfo$1<'PATCH', {
1004
+ id: string;
1005
+ }, UpdatePhaseRequest, UpdatePhaseRequest$1, UpdatePhaseResponse, UpdatePhaseResponse$1>;
1006
+ declare function createPhase(): __PublicMethodMetaInfo$1<'POST', {
1007
+ workflowId: string;
1008
+ }, CreatePhaseRequest, CreatePhaseRequest$1, CreatePhaseResponse, CreatePhaseResponse$1>;
1009
+ declare function deletePhase(): __PublicMethodMetaInfo$1<'DELETE', {
1010
+ id: string;
1011
+ }, DeletePhaseRequest, DeletePhaseRequest$1, DeletePhaseResponse, DeletePhaseResponse$1>;
1012
+ declare function movePhase(): __PublicMethodMetaInfo$1<'POST', {
1013
+ workflowId: string;
1014
+ id: string;
1015
+ }, MovePhaseRequest, MovePhaseRequest$1, MovePhaseResponse, MovePhaseResponse$1>;
1016
+
1017
+ declare const meta$1_createPhase: typeof createPhase;
1018
+ declare const meta$1_deletePhase: typeof deletePhase;
1019
+ declare const meta$1_getPhase: typeof getPhase;
1020
+ declare const meta$1_listPhases: typeof listPhases;
1021
+ declare const meta$1_movePhase: typeof movePhase;
1022
+ declare const meta$1_updatePhase: typeof updatePhase;
1023
+ declare namespace meta$1 {
1024
+ export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$1_createPhase as createPhase, meta$1_deletePhase as deletePhase, meta$1_getPhase as getPhase, meta$1_listPhases as listPhases, meta$1_movePhase as movePhase, meta$1_updatePhase as updatePhase };
1025
+ }
1026
+
1027
+ interface Workflow$1 {
1028
+ /** Workflow information and metadata. */
1029
+ info?: WorkflowInfo$1;
1030
+ /**
1031
+ * Final phase of the workflow.
1032
+ * Cards in `winPhase` are treated as if they are not part of the workflow.
1033
+ *
1034
+ * Normally, a contact can be attached to only 1 card in the workflow.
1035
+ * Moving a contact's card to `winPhase`
1036
+ * frees up the contact to be attached to another card in the workflow.
1037
+ */
1038
+ winPhase?: Phase$1;
1039
+ /** Phases that make up the workflow. */
1040
+ phasesList?: PhasesList$1;
1041
+ }
1042
+ interface WorkflowInfo$1 {
1043
+ /**
1044
+ * Workflow ID.
1045
+ * @readonly
1046
+ */
1047
+ id?: string | null;
1048
+ /** Display name for the workflow. */
1049
+ name?: string | null;
1050
+ /**
1051
+ * Workflow description,
1052
+ * shown below the workflow's display name in the dashboard.
1053
+ */
1054
+ description?: string | null;
1055
+ /**
1056
+ * Deprecated. Use `createdDate` instead.
1057
+ * @readonly
1058
+ * @deprecated
1059
+ */
1060
+ createdAt?: Date;
1061
+ /**
1062
+ * Indicates whether the workflow can be deleted.
1063
+ * @readonly
1064
+ * @deprecated
1065
+ */
1066
+ isDeletable?: boolean | null;
1067
+ /**
1068
+ * Date and time the workflow was created.
1069
+ * @readonly
1070
+ */
1071
+ createdDate?: Date;
1072
+ }
1073
+ interface Phase$1 {
1074
+ /** Phase information. */
1075
+ info?: PhaseInfo$1;
1076
+ /** Cards contained in the phase. */
1077
+ cardsList?: CardsList$1;
1078
+ }
1079
+ interface PhaseInfo$1 {
1080
+ /**
1081
+ * Phase ID.
1082
+ * @readonly
1083
+ */
1084
+ id?: string | null;
1085
+ /** Display name shown at the top of the phase. */
1086
+ name?: string | null;
1087
+ }
1088
+ /** a list of cards (a page) along with the total number */
1089
+ interface CardsList$1 {
1090
+ /** Total number of cards in the phase. */
1091
+ total?: number;
1092
+ /**
1093
+ * List of cards in the phase.
1094
+ * Sorted according to the card display order, from top to bottom.
1095
+ */
1096
+ cards?: Card$1[];
1097
+ }
1098
+ interface Card$1 {
1099
+ /** Card details. */
1100
+ info?: CardInfo$1;
1101
+ }
1102
+ /** entity representing a card-info */
1103
+ interface CardInfo$1 {
1104
+ /**
1105
+ * Card ID.
1106
+ * @readonly
1107
+ */
1108
+ id?: string | null;
1109
+ /** Display name shown at the top of the card. */
1110
+ name?: string | null;
1111
+ /** Card description. */
1112
+ description?: string | null;
1113
+ /** Details about the contact attached to the card. */
1114
+ primaryAttachment?: Attachment$1;
1115
+ /** Due date. */
1116
+ dueDate?: Date;
1117
+ /** Name of the app or service that created the contact. */
1118
+ source?: string | null;
1119
+ /**
1120
+ * Deprecated. Use `createdDate` instead.
1121
+ * @readonly
1122
+ * @deprecated
1123
+ */
1124
+ createdAt?: Date;
1125
+ /**
1126
+ * Deprecated. Use `updatedDate` instead.
1127
+ * @readonly
1128
+ * @deprecated
1129
+ */
1130
+ updatedAt?: Date;
1131
+ /**
1132
+ * ID of the phase that currently holds the card.
1133
+ * @readonly
1134
+ */
1135
+ phaseId?: string | null;
1136
+ /**
1137
+ * Date and time the card was created.
1138
+ * @readonly
1139
+ */
1140
+ createdDate?: Date;
1141
+ /**
1142
+ * Date and time the card was updated.
1143
+ * @readonly
1144
+ */
1145
+ updatedDate?: Date;
1146
+ }
1147
+ interface Attachment$1 {
1148
+ /**
1149
+ * Attachment ID. For internal use.
1150
+ * @readonly
1151
+ */
1152
+ attachmentId?: string;
1153
+ /**
1154
+ * Deprecated. Use `contactId` instead.
1155
+ * @deprecated
1156
+ */
1157
+ value?: string;
1158
+ /**
1159
+ * Deprecated. For internal use.
1160
+ * @deprecated
1161
+ */
1162
+ attachmentType?: AttachmentType$1;
1163
+ /** ID of the contact attached to the card. */
1164
+ contactId?: string;
1165
+ }
1166
+ /** describes the supported types of attachments (currently only supports Contact which is the default type) */
1167
+ declare enum AttachmentType$1 {
1168
+ ContactType = "ContactType"
1169
+ }
1170
+ /** a list of phases (a page) along with the total number */
1171
+ interface PhasesList$1 {
1172
+ /** Total number of phases in the workflow, excluding `winPhase`. */
1173
+ total?: number;
1174
+ /**
1175
+ * List of phases in the workflow.
1176
+ * Sorted according to the phase display order, from left to right.
1177
+ */
1178
+ phases?: Phase$1[];
1179
+ }
1180
+ interface ListWorkflowsRequest$1 {
1181
+ /**
1182
+ * Number of workflows to return.
1183
+ * If omitted, all results are returned.
1184
+ */
1185
+ limit?: number | null;
1186
+ /**
1187
+ * Number of items to skip in the current sort order.
1188
+ *
1189
+ * Defaults to `0`.
1190
+ */
1191
+ offset?: number | null;
1192
+ /**
1193
+ * Supported fields:
1194
+ * `id`, `name`, `description`, `createdDate`
1195
+ *
1196
+ * List of fields to sort by.
1197
+ * Formatted as `field:direction`,
1198
+ * where field is the field name
1199
+ * and direction is `asc` (ascending) or `desc` (descending).
1200
+ *
1201
+ * Sorting is applied lexicographically, so `"abc"` comes after `"XYZ"`.
1202
+ */
1203
+ sort?: string[];
1204
+ }
1205
+ interface ListWorkflowsResponse$1 {
1206
+ /** Retrieved list of workflows. */
1207
+ workflows?: WorkflowInfo$1[];
1208
+ /** Metadata for the page of results. */
1209
+ pagination?: PaginationResponse$1;
1210
+ }
1211
+ interface PaginationResponse$1 {
1212
+ /** Number of items that were skipped in the current sort order. */
1213
+ offset?: number;
1214
+ /** Total number of items that matched the filter. */
1215
+ total?: number;
1216
+ /** Number of returned items. */
1217
+ count?: number;
1218
+ }
1219
+ interface GetWorkflowRequest$1 {
1220
+ /** ID of the workflow to retrieve. */
1221
+ id: string;
1222
+ /**
1223
+ * Maximum number of cards to return per phase.
1224
+ * To retrieve additional pages of cards, use
1225
+ * [List Cards](https://dev.wix.com/api/rest/workflows/workflows/cards/list-cards)
1226
+ * (in the Cards API).
1227
+ *
1228
+ * Defaults to `10`.
1229
+ */
1230
+ cardsPerPhase?: number | null;
1231
+ }
1232
+ interface GetWorkflowResponse$1 {
1233
+ /** Requested workflow. */
1234
+ workflow?: Workflow$1;
1235
+ }
1236
+ interface UpdateWorkflowRequest$1 {
1237
+ /** ID of the workflow to update. */
1238
+ id: string;
1239
+ /** Workflow info. */
1240
+ workflow?: WorkflowInfo$1;
1241
+ }
1242
+ interface UpdateWorkflowResponse$1 {
1243
+ }
1244
+ interface CreateWorkflowRequest$1 {
1245
+ /** Workflow details. */
1246
+ workflow?: WorkflowInfo$1;
1247
+ }
1248
+ interface CreateWorkflowResponse$1 {
1249
+ /** ID of the new workflow. */
1250
+ id?: string | null;
1251
+ }
1252
+ interface DeleteWorkflowRequest$1 {
1253
+ /** ID of the workflow to delete. */
1254
+ id: string;
1255
+ }
1256
+ interface DeleteWorkflowResponse$1 {
1257
+ }
1258
+ interface ListWorkflowsResponseNonNullableFields$1 {
1259
+ workflows: WorkflowInfo$1[];
1260
+ pagination?: {
1261
+ offset: number;
1262
+ limit: number;
1263
+ total: number;
1264
+ count: number;
1265
+ };
1266
+ }
1267
+ interface GetWorkflowResponseNonNullableFields$1 {
1268
+ workflow?: {
1269
+ winPhase?: {
1270
+ cardsList?: {
1271
+ total: number;
1272
+ cards: {
1273
+ info?: {
1274
+ primaryAttachment?: {
1275
+ attachmentId: string;
1276
+ value: string;
1277
+ attachmentType: AttachmentType$1;
1278
+ contactId: string;
1279
+ };
1280
+ };
1281
+ }[];
1282
+ };
1283
+ };
1284
+ phasesList?: {
1285
+ total: number;
1286
+ phases: {
1287
+ cardsList?: {
1288
+ total: number;
1289
+ cards: {
1290
+ info?: {
1291
+ primaryAttachment?: {
1292
+ attachmentId: string;
1293
+ value: string;
1294
+ attachmentType: AttachmentType$1;
1295
+ contactId: string;
1296
+ };
1297
+ };
1298
+ }[];
1299
+ };
1300
+ }[];
1301
+ };
1302
+ };
1303
+ }
1304
+
1305
+ interface Workflow {
1306
+ /** Workflow information and metadata. */
1307
+ info?: WorkflowInfo;
1308
+ /**
1309
+ * Final phase of the workflow.
1310
+ * Cards in `winPhase` are treated as if they are not part of the workflow.
1311
+ *
1312
+ * Normally, a contact can be attached to only 1 card in the workflow.
1313
+ * Moving a contact's card to `winPhase`
1314
+ * frees up the contact to be attached to another card in the workflow.
1315
+ */
1316
+ winPhase?: Phase;
1317
+ /** Phases that make up the workflow. */
1318
+ phasesList?: PhasesList;
1319
+ }
1320
+ interface WorkflowInfo {
1321
+ /**
1322
+ * Workflow ID.
1323
+ * @readonly
1324
+ */
1325
+ _id?: string | null;
1326
+ /** Display name for the workflow. */
1327
+ name?: string | null;
1328
+ /**
1329
+ * Workflow description,
1330
+ * shown below the workflow's display name in the dashboard.
1331
+ */
1332
+ description?: string | null;
1333
+ /**
1334
+ * @internal
1335
+ * @internal
1336
+ * @readonly
1337
+ * @deprecated
1338
+ */
1339
+ createdAt?: Date;
1340
+ /**
1341
+ * Indicates whether the workflow can be deleted.
1342
+ * @readonly
1343
+ * @deprecated
1344
+ */
1345
+ isDeletable?: boolean | null;
1346
+ /**
1347
+ * Date and time the workflow was created.
1348
+ * @readonly
1349
+ */
1350
+ _createdDate?: Date;
1351
+ }
1352
+ interface Phase {
1353
+ /** Phase information. */
1354
+ info?: PhaseInfo;
1355
+ /** Cards contained in the phase. */
1356
+ cardsList?: CardsList;
1357
+ }
1358
+ interface PhaseInfo {
1359
+ /**
1360
+ * Phase ID.
1361
+ * @readonly
1362
+ */
1363
+ _id?: string | null;
1364
+ /** Display name shown at the top of the phase. */
1365
+ name?: string | null;
1366
+ }
1367
+ /** a list of cards (a page) along with the total number */
1368
+ interface CardsList {
1369
+ /** Total number of cards in the phase. */
1370
+ total?: number;
1371
+ /**
1372
+ * List of cards in the phase.
1373
+ * Sorted according to the card display order, from top to bottom.
1374
+ */
1375
+ cards?: Card[];
1376
+ }
1377
+ interface Card {
1378
+ /** Card details. */
1379
+ info?: CardInfo;
1380
+ }
1381
+ /** entity representing a card-info */
1382
+ interface CardInfo {
1383
+ /**
1384
+ * Card ID.
1385
+ * @readonly
1386
+ */
1387
+ _id?: string | null;
1388
+ /** Display name shown at the top of the card. */
1389
+ name?: string | null;
1390
+ /** Card description. */
1391
+ description?: string | null;
1392
+ /** Details about the contact attached to the card. */
1393
+ primaryAttachment?: Attachment;
1394
+ /** Due date. */
1395
+ dueDate?: Date;
1396
+ /** Name of the app or service that created the contact. */
1397
+ source?: string | null;
1398
+ /**
1399
+ * @internal
1400
+ * @internal
1401
+ * @readonly
1402
+ * @deprecated
1403
+ */
1404
+ createdAt?: Date;
1405
+ /**
1406
+ * @internal
1407
+ * @internal
1408
+ * @readonly
1409
+ * @deprecated
1410
+ */
1411
+ updatedAt?: Date;
1412
+ /**
1413
+ * ID of the phase that currently holds the card.
1414
+ * @readonly
1415
+ */
1416
+ phaseId?: string | null;
1417
+ /**
1418
+ * Date and time the card was created.
1419
+ * @readonly
1420
+ */
1421
+ _createdDate?: Date;
1422
+ /**
1423
+ * Date and time the card was updated.
1424
+ * @readonly
1425
+ */
1426
+ _updatedDate?: Date;
1427
+ }
1428
+ interface Attachment {
1429
+ /**
1430
+ * Attachment ID. For internal use.
1431
+ * @readonly
1432
+ */
1433
+ attachmentId?: string;
1434
+ /**
1435
+ * @internal
1436
+ * @internal
1437
+ * @deprecated
1438
+ */
1439
+ value?: string;
1440
+ /**
1441
+ * @internal
1442
+ * @internal
1443
+ * @deprecated
1444
+ */
1445
+ attachmentType?: AttachmentType;
1446
+ /** ID of the contact attached to the card. */
1447
+ contactId?: string;
1448
+ }
1449
+ /** describes the supported types of attachments (currently only supports Contact which is the default type) */
1450
+ declare enum AttachmentType {
1451
+ ContactType = "ContactType"
1452
+ }
1453
+ /** a list of phases (a page) along with the total number */
1454
+ interface PhasesList {
1455
+ /** Total number of phases in the workflow, excluding `winPhase`. */
1456
+ total?: number;
1457
+ /**
1458
+ * List of phases in the workflow.
1459
+ * Sorted according to the phase display order, from left to right.
1460
+ */
1461
+ phases?: Phase[];
1462
+ }
1463
+ interface ListWorkflowsRequest {
1464
+ /**
1465
+ * Number of workflows to return.
1466
+ * If omitted, all results are returned.
1467
+ */
1468
+ limit?: number | null;
1469
+ /**
1470
+ * Number of items to skip in the current sort order.
1471
+ *
1472
+ * Defaults to `0`.
1473
+ */
1474
+ offset?: number | null;
1475
+ /**
1476
+ * Supported fields:
1477
+ * `id`, `name`, `description`, `createdDate`
1478
+ *
1479
+ * List of fields to sort by.
1480
+ * Formatted as `field:direction`,
1481
+ * where field is the field name
1482
+ * and direction is `asc` (ascending) or `desc` (descending).
1483
+ *
1484
+ * Sorting is applied lexicographically, so `"abc"` comes after `"XYZ"`.
1485
+ */
1486
+ sort?: string[];
1487
+ }
1488
+ interface ListWorkflowsResponse {
1489
+ /** Retrieved list of workflows. */
1490
+ workflows?: WorkflowInfo[];
1491
+ /** Metadata for the page of results. */
1492
+ pagination?: PaginationResponse;
1493
+ }
1494
+ interface PaginationResponse {
1495
+ /** Number of items that were skipped in the current sort order. */
1496
+ offset?: number;
1497
+ /** Total number of items that matched the filter. */
1498
+ total?: number;
1499
+ /** Number of returned items. */
1500
+ count?: number;
1501
+ }
1502
+ interface GetWorkflowRequest {
1503
+ /** ID of the workflow to retrieve. */
1504
+ _id: string;
1505
+ /**
1506
+ * Maximum number of cards to return per phase.
1507
+ * To retrieve additional pages of cards, use
1508
+ * [List Cards](../cards/listCards)
1509
+ * (in the Cards API).
1510
+ */
1511
+ cardsPerPhase?: number | null;
1512
+ }
1513
+ interface GetWorkflowResponse {
1514
+ /** Requested workflow. */
1515
+ workflow?: Workflow;
1516
+ }
1517
+ interface UpdateWorkflowRequest {
1518
+ /** ID of the workflow to update. */
1519
+ _id: string;
1520
+ /** Workflow info. */
1521
+ workflow?: WorkflowInfo;
1522
+ }
1523
+ interface UpdateWorkflowResponse {
1524
+ }
1525
+ interface CreateWorkflowRequest {
1526
+ /** Workflow details. */
1527
+ workflow?: WorkflowInfo;
1528
+ }
1529
+ interface CreateWorkflowResponse {
1530
+ /** ID of the new workflow. */
1531
+ _id?: string | null;
1532
+ }
1533
+ interface DeleteWorkflowRequest {
1534
+ /** ID of the workflow to delete. */
1535
+ _id: string;
1536
+ }
1537
+ interface DeleteWorkflowResponse {
1538
+ }
1539
+ interface ListWorkflowsResponseNonNullableFields {
1540
+ workflows: WorkflowInfo[];
1541
+ pagination?: {
1542
+ offset: number;
1543
+ total: number;
1544
+ count: number;
1545
+ };
1546
+ }
1547
+ interface GetWorkflowResponseNonNullableFields {
1548
+ workflow?: {
1549
+ winPhase?: {
1550
+ cardsList?: {
1551
+ total: number;
1552
+ cards: {
1553
+ info?: {
1554
+ primaryAttachment?: {
1555
+ attachmentId: string;
1556
+ value: string;
1557
+ attachmentType: AttachmentType;
1558
+ contactId: string;
1559
+ };
1560
+ };
1561
+ }[];
1562
+ };
1563
+ };
1564
+ phasesList?: {
1565
+ total: number;
1566
+ phases: {
1567
+ cardsList?: {
1568
+ total: number;
1569
+ cards: {
1570
+ info?: {
1571
+ primaryAttachment?: {
1572
+ attachmentId: string;
1573
+ value: string;
1574
+ attachmentType: AttachmentType;
1575
+ contactId: string;
1576
+ };
1577
+ };
1578
+ }[];
1579
+ };
1580
+ }[];
1581
+ };
1582
+ };
1583
+ }
1584
+
1585
+ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1586
+ getUrl: (context: any) => string;
1587
+ httpMethod: K;
1588
+ path: string;
1589
+ pathParams: M;
1590
+ __requestType: T;
1591
+ __originalRequestType: S;
1592
+ __responseType: Q;
1593
+ __originalResponseType: R;
1594
+ };
1595
+ declare function listWorkflows(): __PublicMethodMetaInfo<'GET', {}, ListWorkflowsRequest, ListWorkflowsRequest$1, ListWorkflowsResponse & ListWorkflowsResponseNonNullableFields, ListWorkflowsResponse$1 & ListWorkflowsResponseNonNullableFields$1>;
1596
+ declare function getWorkflow(): __PublicMethodMetaInfo<'GET', {
1597
+ id: string;
1598
+ }, GetWorkflowRequest, GetWorkflowRequest$1, GetWorkflowResponse & GetWorkflowResponseNonNullableFields, GetWorkflowResponse$1 & GetWorkflowResponseNonNullableFields$1>;
1599
+ declare function updateWorkflow(): __PublicMethodMetaInfo<'PATCH', {
1600
+ id: string;
1601
+ }, UpdateWorkflowRequest, UpdateWorkflowRequest$1, UpdateWorkflowResponse, UpdateWorkflowResponse$1>;
1602
+ declare function createWorkflow(): __PublicMethodMetaInfo<'POST', {}, CreateWorkflowRequest, CreateWorkflowRequest$1, CreateWorkflowResponse, CreateWorkflowResponse$1>;
1603
+ declare function deleteWorkflow(): __PublicMethodMetaInfo<'DELETE', {
1604
+ id: string;
1605
+ }, DeleteWorkflowRequest, DeleteWorkflowRequest$1, DeleteWorkflowResponse, DeleteWorkflowResponse$1>;
1606
+
1607
+ type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
1608
+ declare const meta_createWorkflow: typeof createWorkflow;
1609
+ declare const meta_deleteWorkflow: typeof deleteWorkflow;
1610
+ declare const meta_getWorkflow: typeof getWorkflow;
1611
+ declare const meta_listWorkflows: typeof listWorkflows;
1612
+ declare const meta_updateWorkflow: typeof updateWorkflow;
1613
+ declare namespace meta {
1614
+ export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_createWorkflow as createWorkflow, meta_deleteWorkflow as deleteWorkflow, meta_getWorkflow as getWorkflow, meta_listWorkflows as listWorkflows, meta_updateWorkflow as updateWorkflow };
1615
+ }
1616
+
1617
+ export { meta$2 as cards, meta$1 as phases, meta as workflows };