@pitcher/js-api 1.26.0-beta.8 → 1.26.0-beta.9

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 (31) hide show
  1. package/impact-js-api.spec.json +3 -0
  2. package/js-api.esm.js +32 -0
  3. package/js-api.esm.js.map +1 -1
  4. package/js-api.umd.min.js +9 -9
  5. package/js-api.umd.min.js.map +1 -1
  6. package/lib/apps/browser/stores/api.d.ts +6 -0
  7. package/lib/apps/canvas-builder/composables/useCanvas.d.ts +12 -2
  8. package/lib/apps/canvas-builder/composables/useCanvasBlocks.d.ts +4 -2
  9. package/lib/apps/canvas-builder/composables/useCanvasHistory.d.ts +2 -0
  10. package/lib/apps/canvas-builder/composables/useCanvasTheme.d.ts +18 -18
  11. package/lib/apps/canvas-builder/types/canvas.d.ts +1 -0
  12. package/lib/apps/canvas-selector/stores/app.d.ts +14 -14
  13. package/lib/components/canvas-templates/CTemplateManagement.vue.d.ts +2 -0
  14. package/lib/components/savedCanvases/smartFolders/SmartFolders.use.d.ts +4 -4
  15. package/lib/sdk/api/HighLevelApi.d.ts +1 -0
  16. package/lib/sdk/api/modules/query.d.ts +26 -1
  17. package/lib/sdk/main.d.ts +3 -0
  18. package/lib/sdk/payload.types.d.ts +22 -0
  19. package/lib/types/canvases.d.ts +1 -0
  20. package/package.json +1 -1
  21. package/types/openapi/models/Account.d.ts +1 -1
  22. package/types/openapi/models/AccountRequest.d.ts +1 -1
  23. package/types/openapi/models/DeletedFolder.d.ts +1 -0
  24. package/types/openapi/models/Folder.d.ts +1 -0
  25. package/types/openapi/models/FolderCreate.d.ts +3 -0
  26. package/types/openapi/models/FolderFile.d.ts +2 -0
  27. package/types/openapi/models/FolderRetrieve.d.ts +4 -0
  28. package/types/openapi/models/FolderUpdate.d.ts +3 -0
  29. package/types/openapi/models/InstanceMembershipUser.d.ts +1 -0
  30. package/types/openapi/models/OfflineSyncFolder.d.ts +1 -0
  31. package/types/openapi/models/User.d.ts +4 -1
@@ -276,6 +276,7 @@ declare const _default: () => {
276
276
  readonly canvases_count: number;
277
277
  readonly canvas_thumbnail_urls: readonly string[];
278
278
  }[];
279
+ readonly parent_folder_id: string | null;
279
280
  readonly folders: readonly {
280
281
  readonly id: string;
281
282
  readonly name: string;
@@ -293,6 +294,7 @@ declare const _default: () => {
293
294
  readonly name: string;
294
295
  readonly status: FileStatusEnum;
295
296
  readonly content_type: import('../../../../types/openapi').FileContentTypeEnum;
297
+ readonly access_type?: import('../../../../types/openapi').AccessTypeEnum | undefined;
296
298
  readonly thumbnail_url: string;
297
299
  readonly original_url: string | null;
298
300
  readonly original_extension: string | null;
@@ -414,6 +416,7 @@ declare const _default: () => {
414
416
  readonly name: string;
415
417
  readonly status: FileStatusEnum;
416
418
  readonly content_type: import('../../../../types/openapi').FileContentTypeEnum;
419
+ readonly access_type?: import('../../../../types/openapi').AccessTypeEnum | undefined;
417
420
  readonly thumbnail_url: string;
418
421
  readonly original_url: string | null;
419
422
  readonly original_extension: string | null;
@@ -714,6 +717,7 @@ declare const _default: () => {
714
717
  readonly canvases_count: number;
715
718
  readonly canvas_thumbnail_urls: Array<string>;
716
719
  }[];
720
+ readonly parent_folder_id: string | null;
717
721
  readonly folders: {
718
722
  readonly id: string;
719
723
  name: string;
@@ -731,6 +735,7 @@ declare const _default: () => {
731
735
  readonly name: string;
732
736
  readonly status: FileStatusEnum;
733
737
  readonly content_type: import('../../../../types/openapi').FileContentTypeEnum;
738
+ access_type?: import('../../../../types/openapi').AccessTypeEnum | undefined;
734
739
  readonly thumbnail_url: string;
735
740
  readonly original_url: string | null;
736
741
  readonly original_extension: string | null;
@@ -806,6 +811,7 @@ declare const _default: () => {
806
811
  readonly name: string;
807
812
  readonly status: FileStatusEnum;
808
813
  readonly content_type: import('../../../../types/openapi').FileContentTypeEnum;
814
+ access_type?: import('../../../../types/openapi').AccessTypeEnum | undefined;
809
815
  readonly thumbnail_url: string;
810
816
  readonly original_url: string | null;
811
817
  readonly original_extension: string | null;
@@ -479,6 +479,7 @@ declare const componentNodesById: import('vue').ComputedRef<{
479
479
  readonly bg_color_palette_index?: number | undefined;
480
480
  } | undefined;
481
481
  readonly height?: string | undefined;
482
+ readonly is_sharebox_target?: boolean | undefined;
482
483
  };
483
484
  }>;
484
485
  export type SectionComponentNodesBySectionId = typeof sectionComponentNodesBySectionId;
@@ -952,6 +953,7 @@ declare const sectionComponentNodesBySectionId: import('vue').ComputedRef<{
952
953
  readonly bg_color_palette_index?: number | undefined;
953
954
  } | undefined;
954
955
  readonly height?: string | undefined;
956
+ readonly is_sharebox_target?: boolean | undefined;
955
957
  };
956
958
  };
957
959
  }>;
@@ -1011,7 +1013,7 @@ export default function useCanvas(): {
1011
1013
  short_url?: string | null | undefined;
1012
1014
  };
1013
1015
  account?: {
1014
- id: string;
1016
+ id?: string | undefined;
1015
1017
  name?: string | undefined;
1016
1018
  } | null | undefined;
1017
1019
  readonly events: {
@@ -1074,7 +1076,7 @@ export default function useCanvas(): {
1074
1076
  short_url?: string | null | undefined;
1075
1077
  };
1076
1078
  account?: {
1077
- id: string;
1079
+ id?: string | undefined;
1078
1080
  name?: string | undefined;
1079
1081
  } | null | undefined;
1080
1082
  readonly events: {
@@ -1577,6 +1579,7 @@ export default function useCanvas(): {
1577
1579
  readonly bg_color_palette_index?: number | undefined;
1578
1580
  } | undefined;
1579
1581
  readonly height?: string | undefined;
1582
+ readonly is_sharebox_target?: boolean | undefined;
1580
1583
  } | null>;
1581
1584
  activeNavigationItems: Ref<{
1582
1585
  id: string;
@@ -2062,6 +2065,7 @@ export default function useCanvas(): {
2062
2065
  readonly bg_color_palette_index?: number | undefined;
2063
2066
  } | undefined;
2064
2067
  readonly height?: string | undefined;
2068
+ readonly is_sharebox_target?: boolean | undefined;
2065
2069
  } | null>;
2066
2070
  addMode: Ref<false | {
2067
2071
  type: ComponentTypes;
@@ -2507,6 +2511,7 @@ export default function useCanvas(): {
2507
2511
  bg_color_palette_index?: number | undefined;
2508
2512
  } | undefined;
2509
2513
  height?: string | undefined;
2514
+ is_sharebox_target?: boolean | undefined;
2510
2515
  }[], ComponentNode<import('../../collection-player/export').CollectionPlayer | import('../types/canvas').GridProps | import('../types/canvas').GridItemProps | import('../types/canvas').TextProps | import('../types/canvas').CarouselProps | MultimediaProps | import('../types/canvas').EmbeddableProps | ContentGridProps | SectionListProps | ContentListProps | import('../types/canvas').HtmlProps | import('../types/canvas').IFrameProps | import('../types/canvas').LinkProps | import('../types/canvas').PageBreakProps | import('../types/canvas').PageProps | import('../types/canvas').TimelineProps | import('../types/canvas').DynamicDataTableProps | import('../types/canvas').CustomDataTableProps>[] | {
2511
2516
  id: string;
2512
2517
  type: ComponentTypes;
@@ -2935,6 +2940,7 @@ export default function useCanvas(): {
2935
2940
  bg_color_palette_index?: number | undefined;
2936
2941
  } | undefined;
2937
2942
  height?: string | undefined;
2943
+ is_sharebox_target?: boolean | undefined;
2938
2944
  }[]>;
2939
2945
  canvasHomePage: Ref<{
2940
2946
  component_id: ComponentNode["id"];
@@ -3441,6 +3447,7 @@ export default function useCanvas(): {
3441
3447
  readonly bg_color_palette_index?: number | undefined;
3442
3448
  } | undefined;
3443
3449
  readonly height?: string | undefined;
3450
+ readonly is_sharebox_target?: boolean | undefined;
3444
3451
  };
3445
3452
  }>;
3446
3453
  componentSelectedMode: Ref<false | {
@@ -4091,6 +4098,7 @@ export default function useCanvas(): {
4091
4098
  readonly bg_color_palette_index?: number | undefined;
4092
4099
  } | undefined;
4093
4100
  readonly height?: string | undefined;
4101
+ readonly is_sharebox_target?: boolean | undefined;
4094
4102
  };
4095
4103
  };
4096
4104
  }>;
@@ -4526,6 +4534,7 @@ export default function useCanvas(): {
4526
4534
  bg_color_palette_index?: number | undefined;
4527
4535
  } | undefined;
4528
4536
  height?: string | undefined;
4537
+ is_sharebox_target?: boolean | undefined;
4529
4538
  } | null>;
4530
4539
  share: Ref<((canvasId: CanvasRetrieve["id"]) => Promise<import('../../../../types/openapi').SharedLink>) | undefined, ((canvasId: CanvasRetrieve["id"]) => Promise<import('../../../../types/openapi').SharedLink>) | undefined>;
4531
4540
  singletonsInCanvasMap: import('vue').ComputedRef<Record<ComponentTypes, boolean>>;
@@ -5965,5 +5974,6 @@ export default function useCanvas(): {
5965
5974
  } | null>;
5966
5975
  getSafeContext: (context?: any, _temporaryContextKeys?: string[]) => any;
5967
5976
  watchCanvas: () => import('vue').WatchHandle;
5977
+ mergeWithArrayReplacement: (...sources: any[]) => any;
5968
5978
  };
5969
5979
  export {};
@@ -53,7 +53,7 @@ export default function useCanvasBlocks(): {
53
53
  readonly short_url?: string | null | undefined;
54
54
  };
55
55
  readonly account?: {
56
- readonly id: string;
56
+ readonly id?: string | undefined;
57
57
  readonly name?: string | undefined;
58
58
  } | null | undefined;
59
59
  readonly events: readonly {
@@ -130,7 +130,7 @@ export default function useCanvasBlocks(): {
130
130
  readonly short_url?: string | null | undefined;
131
131
  };
132
132
  readonly account?: {
133
- readonly id: string;
133
+ readonly id?: string | undefined;
134
134
  readonly name?: string | undefined;
135
135
  } | null | undefined;
136
136
  readonly events: readonly {
@@ -627,6 +627,7 @@ export default function useCanvasBlocks(): {
627
627
  readonly bg_color_palette_index?: number | undefined;
628
628
  } | undefined;
629
629
  readonly height?: string | undefined;
630
+ readonly is_sharebox_target?: boolean | undefined;
630
631
  }[];
631
632
  }, {
632
633
  readonly [x: string]: readonly {
@@ -1097,6 +1098,7 @@ export default function useCanvasBlocks(): {
1097
1098
  readonly bg_color_palette_index?: number | undefined;
1098
1099
  } | undefined;
1099
1100
  readonly height?: string | undefined;
1101
+ readonly is_sharebox_target?: boolean | undefined;
1100
1102
  }[];
1101
1103
  }>>;
1102
1104
  fetchBlock: (blockId: string) => Promise<CanvasRetrieve>;
@@ -435,6 +435,7 @@ export default function useCanvasHistory(): {
435
435
  bg_color_palette_index?: number | undefined;
436
436
  } | undefined;
437
437
  height?: string | undefined;
438
+ is_sharebox_target?: boolean | undefined;
438
439
  }[];
439
440
  timestamp: string;
440
441
  }[], CanvasHistoryItem[] | {
@@ -871,6 +872,7 @@ export default function useCanvasHistory(): {
871
872
  bg_color_palette_index?: number | undefined;
872
873
  } | undefined;
873
874
  height?: string | undefined;
875
+ is_sharebox_target?: boolean | undefined;
874
876
  }[];
875
877
  timestamp: string;
876
878
  }[]>;
@@ -106,7 +106,7 @@ export default function useCanvasTheme(): {
106
106
  readonly picture: string | null;
107
107
  timezone?: string | undefined;
108
108
  tags?: (Array<string> | null) | undefined;
109
- readonly connection?: string | null | undefined;
109
+ readonly connection: string | null;
110
110
  };
111
111
  created_by: {
112
112
  readonly id: number;
@@ -134,7 +134,7 @@ export default function useCanvasTheme(): {
134
134
  readonly picture: string | null;
135
135
  timezone?: string | undefined;
136
136
  tags?: (Array<string> | null) | undefined;
137
- readonly connection?: string | null | undefined;
137
+ readonly connection: string | null;
138
138
  };
139
139
  modified_by?: {
140
140
  readonly id: number;
@@ -162,7 +162,7 @@ export default function useCanvasTheme(): {
162
162
  readonly picture: string | null;
163
163
  timezone?: string | undefined;
164
164
  tags?: (Array<string> | null) | undefined;
165
- readonly connection?: string | null | undefined;
165
+ readonly connection: string | null;
166
166
  } | undefined;
167
167
  logo?: {
168
168
  id: string;
@@ -220,7 +220,7 @@ export default function useCanvasTheme(): {
220
220
  readonly picture: string | null;
221
221
  timezone?: string | undefined;
222
222
  tags?: (Array<string> | null) | undefined;
223
- readonly connection?: string | null | undefined;
223
+ readonly connection: string | null;
224
224
  };
225
225
  created_by: {
226
226
  readonly id: number;
@@ -248,7 +248,7 @@ export default function useCanvasTheme(): {
248
248
  readonly picture: string | null;
249
249
  timezone?: string | undefined;
250
250
  tags?: (Array<string> | null) | undefined;
251
- readonly connection?: string | null | undefined;
251
+ readonly connection: string | null;
252
252
  };
253
253
  modified_by?: {
254
254
  readonly id: number;
@@ -276,7 +276,7 @@ export default function useCanvasTheme(): {
276
276
  readonly picture: string | null;
277
277
  timezone?: string | undefined;
278
278
  tags?: (Array<string> | null) | undefined;
279
- readonly connection?: string | null | undefined;
279
+ readonly connection: string | null;
280
280
  } | undefined;
281
281
  logo?: {
282
282
  id: string;
@@ -491,7 +491,7 @@ export default function useCanvasTheme(): {
491
491
  readonly picture: string | null;
492
492
  timezone?: string | undefined;
493
493
  tags?: (Array<string> | null) | undefined;
494
- readonly connection?: string | null | undefined;
494
+ readonly connection: string | null;
495
495
  };
496
496
  created_by: {
497
497
  readonly id: number;
@@ -519,7 +519,7 @@ export default function useCanvasTheme(): {
519
519
  readonly picture: string | null;
520
520
  timezone?: string | undefined;
521
521
  tags?: (Array<string> | null) | undefined;
522
- readonly connection?: string | null | undefined;
522
+ readonly connection: string | null;
523
523
  };
524
524
  modified_by?: {
525
525
  readonly id: number;
@@ -547,7 +547,7 @@ export default function useCanvasTheme(): {
547
547
  readonly picture: string | null;
548
548
  timezone?: string | undefined;
549
549
  tags?: (Array<string> | null) | undefined;
550
- readonly connection?: string | null | undefined;
550
+ readonly connection: string | null;
551
551
  } | undefined;
552
552
  logo?: {
553
553
  id: string;
@@ -605,7 +605,7 @@ export default function useCanvasTheme(): {
605
605
  readonly picture: string | null;
606
606
  timezone?: string | undefined;
607
607
  tags?: (Array<string> | null) | undefined;
608
- readonly connection?: string | null | undefined;
608
+ readonly connection: string | null;
609
609
  };
610
610
  created_by: {
611
611
  readonly id: number;
@@ -633,7 +633,7 @@ export default function useCanvasTheme(): {
633
633
  readonly picture: string | null;
634
634
  timezone?: string | undefined;
635
635
  tags?: (Array<string> | null) | undefined;
636
- readonly connection?: string | null | undefined;
636
+ readonly connection: string | null;
637
637
  };
638
638
  modified_by?: {
639
639
  readonly id: number;
@@ -661,7 +661,7 @@ export default function useCanvasTheme(): {
661
661
  readonly picture: string | null;
662
662
  timezone?: string | undefined;
663
663
  tags?: (Array<string> | null) | undefined;
664
- readonly connection?: string | null | undefined;
664
+ readonly connection: string | null;
665
665
  } | undefined;
666
666
  logo?: {
667
667
  id: string;
@@ -727,7 +727,7 @@ export default function useCanvasTheme(): {
727
727
  readonly picture: string | null;
728
728
  timezone?: string | undefined;
729
729
  tags?: (Array<string> | null) | undefined;
730
- readonly connection?: string | null | undefined;
730
+ readonly connection: string | null;
731
731
  };
732
732
  created_by: {
733
733
  readonly id: number;
@@ -755,7 +755,7 @@ export default function useCanvasTheme(): {
755
755
  readonly picture: string | null;
756
756
  timezone?: string | undefined;
757
757
  tags?: (Array<string> | null) | undefined;
758
- readonly connection?: string | null | undefined;
758
+ readonly connection: string | null;
759
759
  };
760
760
  modified_by?: {
761
761
  readonly id: number;
@@ -783,7 +783,7 @@ export default function useCanvasTheme(): {
783
783
  readonly picture: string | null;
784
784
  timezone?: string | undefined;
785
785
  tags?: (Array<string> | null) | undefined;
786
- readonly connection?: string | null | undefined;
786
+ readonly connection: string | null;
787
787
  } | undefined;
788
788
  logo?: {
789
789
  id: string;
@@ -841,7 +841,7 @@ export default function useCanvasTheme(): {
841
841
  readonly picture: string | null;
842
842
  timezone?: string | undefined;
843
843
  tags?: (Array<string> | null) | undefined;
844
- readonly connection?: string | null | undefined;
844
+ readonly connection: string | null;
845
845
  };
846
846
  created_by: {
847
847
  readonly id: number;
@@ -869,7 +869,7 @@ export default function useCanvasTheme(): {
869
869
  readonly picture: string | null;
870
870
  timezone?: string | undefined;
871
871
  tags?: (Array<string> | null) | undefined;
872
- readonly connection?: string | null | undefined;
872
+ readonly connection: string | null;
873
873
  };
874
874
  modified_by?: {
875
875
  readonly id: number;
@@ -897,7 +897,7 @@ export default function useCanvasTheme(): {
897
897
  readonly picture: string | null;
898
898
  timezone?: string | undefined;
899
899
  tags?: (Array<string> | null) | undefined;
900
- readonly connection?: string | null | undefined;
900
+ readonly connection: string | null;
901
901
  } | undefined;
902
902
  logo?: {
903
903
  id: string;
@@ -376,6 +376,7 @@ export interface ComponentNode<T = AvailableComponentProps> {
376
376
  tags?: string[];
377
377
  theme_meta?: ComponentNodeThemeMeta;
378
378
  height?: string;
379
+ is_sharebox_target?: boolean;
379
380
  }
380
381
  export interface HomePageConfig {
381
382
  component_id: string;
@@ -29,7 +29,7 @@ export default function useApp(): {
29
29
  short_url?: string | null | undefined;
30
30
  };
31
31
  account?: {
32
- id: string;
32
+ id?: string | undefined;
33
33
  name?: string | undefined;
34
34
  } | null | undefined;
35
35
  folder_id?: string | null | undefined;
@@ -76,7 +76,7 @@ export default function useApp(): {
76
76
  short_url?: string | null | undefined;
77
77
  };
78
78
  account?: {
79
- id: string;
79
+ id?: string | undefined;
80
80
  name?: string | undefined;
81
81
  } | null | undefined;
82
82
  folder_id?: string | null | undefined;
@@ -123,7 +123,7 @@ export default function useApp(): {
123
123
  short_url?: string | null | undefined;
124
124
  };
125
125
  account?: {
126
- id: string;
126
+ id?: string | undefined;
127
127
  name?: string | undefined;
128
128
  } | null | undefined;
129
129
  folder_id?: string | null | undefined;
@@ -170,7 +170,7 @@ export default function useApp(): {
170
170
  short_url?: string | null | undefined;
171
171
  };
172
172
  account?: {
173
- id: string;
173
+ id?: string | undefined;
174
174
  name?: string | undefined;
175
175
  } | null | undefined;
176
176
  folder_id?: string | null | undefined;
@@ -223,7 +223,7 @@ export default function useApp(): {
223
223
  short_url?: string | null | undefined;
224
224
  };
225
225
  account?: {
226
- id: string;
226
+ id?: string | undefined;
227
227
  name?: string | undefined;
228
228
  } | null | undefined;
229
229
  folder_id?: string | null | undefined;
@@ -270,7 +270,7 @@ export default function useApp(): {
270
270
  short_url?: string | null | undefined;
271
271
  };
272
272
  account?: {
273
- id: string;
273
+ id?: string | undefined;
274
274
  name?: string | undefined;
275
275
  } | null | undefined;
276
276
  folder_id?: string | null | undefined;
@@ -317,7 +317,7 @@ export default function useApp(): {
317
317
  short_url?: string | null | undefined;
318
318
  };
319
319
  account?: {
320
- id: string;
320
+ id?: string | undefined;
321
321
  name?: string | undefined;
322
322
  } | null | undefined;
323
323
  folder_id?: string | null | undefined;
@@ -364,7 +364,7 @@ export default function useApp(): {
364
364
  short_url?: string | null | undefined;
365
365
  };
366
366
  account?: {
367
- id: string;
367
+ id?: string | undefined;
368
368
  name?: string | undefined;
369
369
  } | null | undefined;
370
370
  folder_id?: string | null | undefined;
@@ -412,7 +412,7 @@ export default function useApp(): {
412
412
  short_url?: string | null | undefined;
413
413
  };
414
414
  account?: {
415
- id: string;
415
+ id?: string | undefined;
416
416
  name?: string | undefined;
417
417
  } | null | undefined;
418
418
  folder_id?: string | null | undefined;
@@ -458,7 +458,7 @@ export default function useApp(): {
458
458
  short_url?: string | null | undefined;
459
459
  };
460
460
  account?: {
461
- id: string;
461
+ id?: string | undefined;
462
462
  name?: string | undefined;
463
463
  } | null | undefined;
464
464
  folder_id?: string | null | undefined;
@@ -505,7 +505,7 @@ export default function useApp(): {
505
505
  short_url?: string | null | undefined;
506
506
  };
507
507
  account?: {
508
- id: string;
508
+ id?: string | undefined;
509
509
  name?: string | undefined;
510
510
  } | null | undefined;
511
511
  folder_id?: string | null | undefined;
@@ -552,7 +552,7 @@ export default function useApp(): {
552
552
  short_url?: string | null | undefined;
553
553
  };
554
554
  account?: {
555
- id: string;
555
+ id?: string | undefined;
556
556
  name?: string | undefined;
557
557
  } | null | undefined;
558
558
  folder_id?: string | null | undefined;
@@ -599,7 +599,7 @@ export default function useApp(): {
599
599
  short_url?: string | null | undefined;
600
600
  };
601
601
  account?: {
602
- id: string;
602
+ id?: string | undefined;
603
603
  name?: string | undefined;
604
604
  } | null | undefined;
605
605
  folder_id?: string | null | undefined;
@@ -646,7 +646,7 @@ export default function useApp(): {
646
646
  short_url?: string | null | undefined;
647
647
  };
648
648
  account?: {
649
- id: string;
649
+ id?: string | undefined;
650
650
  name?: string | undefined;
651
651
  } | null | undefined;
652
652
  folder_id?: string | null | undefined;
@@ -39,6 +39,7 @@ type __VLS_Props = {
39
39
  folderFetcher?: (params: {
40
40
  folder_id?: string | null;
41
41
  entity: CoreFolderEntityType;
42
+ tags__not_in?: string;
42
43
  }) => Promise<any>;
43
44
  onItemsMove?: (params: {
44
45
  target_folder_id: string;
@@ -47,6 +48,7 @@ type __VLS_Props = {
47
48
  }) => Promise<void>;
48
49
  hideConvert?: boolean;
49
50
  isAnyTypeOfAdmin?: boolean;
51
+ excludedTags?: string[];
50
52
  };
51
53
  declare function __VLS_template(): {
52
54
  attrs: Partial<{}>;
@@ -91,7 +91,7 @@ export default function useSmartFolders(emit?: (event: 'open', ...args: any[]) =
91
91
  short_url?: string | null | undefined;
92
92
  };
93
93
  account?: {
94
- id: string;
94
+ id?: string | undefined;
95
95
  name?: string | undefined;
96
96
  } | null | undefined;
97
97
  readonly events: {
@@ -174,7 +174,7 @@ export default function useSmartFolders(emit?: (event: 'open', ...args: any[]) =
174
174
  short_url?: string | null | undefined;
175
175
  };
176
176
  account?: {
177
- id: string;
177
+ id?: string | undefined;
178
178
  name?: string | undefined;
179
179
  } | null | undefined;
180
180
  readonly events: {
@@ -237,7 +237,7 @@ export default function useSmartFolders(emit?: (event: 'open', ...args: any[]) =
237
237
  short_url?: string | null | undefined;
238
238
  };
239
239
  account?: {
240
- id: string;
240
+ id?: string | undefined;
241
241
  name?: string | undefined;
242
242
  } | null | undefined;
243
243
  readonly events: {
@@ -301,7 +301,7 @@ export default function useSmartFolders(emit?: (event: 'open', ...args: any[]) =
301
301
  short_url?: string | null | undefined;
302
302
  };
303
303
  account?: {
304
- id: string;
304
+ id?: string | undefined;
305
305
  name?: string | undefined;
306
306
  } | null | undefined;
307
307
  readonly events: {
@@ -237,6 +237,7 @@ export declare function createHighLevelApi(options?: ApiOptions): {
237
237
  crmSmartObjectMetadata(payload: import('../payload.types').CRMSmartObjectMetadataPayload): Promise<any>;
238
238
  crmSmartUpsertObjects(payload: import('../payload.types').UpsertCRMObjectsPayload): Promise<any>;
239
239
  crmSmartObjectValidationRules(payload: import('../payload.types').CRMSmartObjectValidationRulesPayload): Promise<any>;
240
+ crmSmartDeleteObjects(payload: import('../payload.types').CRMSmartDeleteObjectsPayload): Promise<any>;
240
241
  getFolders(payload: import('../payload.types').FolderListRequest): Promise<import('../../main.lib').PaginatedFolderList>;
241
242
  getFolder(payload?: {
242
243
  id: import('../../main.lib').FolderRetrieve["id"];
@@ -1,4 +1,4 @@
1
- import { QueryPayload, CRMQueryPayload, UpsertCRMObjectsPayload, CRMSmartObjectValidationRulesPayload, CRMSmartObjectMetadataPayload } from '../../payload.types';
1
+ import { QueryPayload, CRMQueryPayload, UpsertCRMObjectsPayload, CRMSmartObjectValidationRulesPayload, CRMSmartObjectMetadataPayload, CRMSmartDeleteObjectsPayload } from '../../payload.types';
2
2
  export declare function query(payload: QueryPayload): Promise<any>;
3
3
  export declare function crmQuery(payload: CRMQueryPayload): Promise<any>;
4
4
  /**
@@ -88,3 +88,28 @@ export declare function crmSmartUpsertObjects(payload: UpsertCRMObjectsPayload):
88
88
  * api.crmSmartObjectValidationRules({ object: 'Contact' })
89
89
  */
90
90
  export declare function crmSmartObjectValidationRules(payload: CRMSmartObjectValidationRulesPayload): Promise<any>;
91
+ /**
92
+ * Deletes CRM objects from local CRM data (iOS only).
93
+ * Uses Salesforce Mobile SDK SmartStore to delete records.
94
+ * Each object in the payload specifies a table name and an array of IDs to delete.
95
+ *
96
+ * @param {CRMSmartDeleteObjectsPayload} payload - The delete payload containing an array of CRMDeleteObject items.
97
+ * @returns {Promise<any>} - Promise resolving with the result of the delete operation.
98
+ * @throws {Error} - Throws an error if the payload is invalid.
99
+ *
100
+ * @example
101
+ * // iOS only method to delete CRM objects.
102
+ * api.crmSmartDeleteObjects({
103
+ * objects: [
104
+ * {
105
+ * table_name: 'Account',
106
+ * ids: ['001xx000003DGbQAAW', '001xx000003DGbRABW']
107
+ * },
108
+ * {
109
+ * table_name: 'Contact',
110
+ * ids: ['003xx000004TmiQAAS']
111
+ * }
112
+ * ]
113
+ * })
114
+ */
115
+ export declare function crmSmartDeleteObjects(payload: CRMSmartDeleteObjectsPayload): Promise<any>;
package/lib/sdk/main.d.ts CHANGED
@@ -306,6 +306,7 @@ export declare function useApi(options?: ApiOptions): {
306
306
  crmSmartObjectMetadata(payload: import('./payload.types').CRMSmartObjectMetadataPayload): Promise<any>;
307
307
  crmSmartUpsertObjects(payload: import('./payload.types').UpsertCRMObjectsPayload): Promise<any>;
308
308
  crmSmartObjectValidationRules(payload: import('./payload.types').CRMSmartObjectValidationRulesPayload): Promise<any>;
309
+ crmSmartDeleteObjects(payload: import('./payload.types').CRMSmartDeleteObjectsPayload): Promise<any>;
309
310
  getFolders(payload: import('./payload.types').FolderListRequest): Promise<import('../main.lib').PaginatedFolderList>;
310
311
  getFolder(payload?: {
311
312
  id: import('../main.lib').FolderRetrieve["id"];
@@ -586,6 +587,7 @@ export declare function useApi(options?: ApiOptions): {
586
587
  crmSmartObjectMetadata(payload: import('./payload.types').CRMSmartObjectMetadataPayload): Promise<any>;
587
588
  crmSmartUpsertObjects(payload: import('./payload.types').UpsertCRMObjectsPayload): Promise<any>;
588
589
  crmSmartObjectValidationRules(payload: import('./payload.types').CRMSmartObjectValidationRulesPayload): Promise<any>;
590
+ crmSmartDeleteObjects(payload: import('./payload.types').CRMSmartDeleteObjectsPayload): Promise<any>;
589
591
  getFolders(payload: import('./payload.types').FolderListRequest): Promise<import('../main.lib').PaginatedFolderList>;
590
592
  getFolder(payload?: {
591
593
  id: import('../main.lib').FolderRetrieve["id"];
@@ -802,6 +804,7 @@ export declare function useApi(options?: ApiOptions): {
802
804
  crmSmartObjectMetadata(payload: import('./payload.types').CRMSmartObjectMetadataPayload): Promise<any>;
803
805
  crmSmartUpsertObjects(payload: import('./payload.types').UpsertCRMObjectsPayload): Promise<any>;
804
806
  crmSmartObjectValidationRules(payload: import('./payload.types').CRMSmartObjectValidationRulesPayload): Promise<any>;
807
+ crmSmartDeleteObjects(payload: import('./payload.types').CRMSmartDeleteObjectsPayload): Promise<any>;
805
808
  getFolders(payload: import('./payload.types').FolderListRequest): Promise<import('../main.lib').PaginatedFolderList>;
806
809
  getFolder(payload?: {
807
810
  id: import('../main.lib').FolderRetrieve["id"];
@@ -339,3 +339,25 @@ export interface CRMSmartObjectValidationRulesPayload {
339
339
  */
340
340
  object: string;
341
341
  }
342
+ /**
343
+ * Represents a single CRM object to be deleted.
344
+ */
345
+ export interface CRMDeleteObject {
346
+ /**
347
+ * Array of IDs of the records to delete.
348
+ */
349
+ ids: string[];
350
+ /**
351
+ * The name of the CRM table/object to delete from.
352
+ */
353
+ table_name: string;
354
+ }
355
+ /**
356
+ * Payload for deleting CRM objects (iOS only).
357
+ */
358
+ export interface CRMSmartDeleteObjectsPayload {
359
+ /**
360
+ * Array of CRM objects to be deleted.
361
+ */
362
+ objects: CRMDeleteObject[];
363
+ }
@@ -13,6 +13,7 @@ export interface GetCanvasesParams {
13
13
  page_size?: number;
14
14
  section_ids?: string[];
15
15
  tags__in?: string[];
16
+ tags__not_in?: string;
16
17
  id__in?: string;
17
18
  access_type?: string;
18
19
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pitcher/js-api",
3
- "version": "1.26.0-beta.8",
3
+ "version": "1.26.0-beta.9",
4
4
  "type": "module",
5
5
  "main": "js-api.umd.min.js",
6
6
  "module": "js-api.esm.js",
@@ -1,4 +1,4 @@
1
1
  export type Account = {
2
- id: string;
2
+ id?: string;
3
3
  name?: string;
4
4
  };
@@ -1,4 +1,4 @@
1
1
  export type AccountRequest = {
2
- id: string;
2
+ id?: string;
3
3
  name?: string;
4
4
  };