@pitcher/js-api 1.22.0-alpha.3 → 1.22.0-alpha.5

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 (47) hide show
  1. package/js-api.esm.js +139 -43
  2. package/js-api.esm.js.map +1 -1
  3. package/js-api.umd.min.js +10 -10
  4. package/js-api.umd.min.js.map +1 -1
  5. package/lib/api/canvases/canvases.queries.d.ts +1 -1
  6. package/lib/apps/browser/stores/api.d.ts +53 -53
  7. package/lib/apps/browser/stores/app.d.ts +18 -17
  8. package/lib/apps/browser/stores/upload.d.ts +29 -29
  9. package/lib/apps/canvas-builder/composables/useCanvas.d.ts +607 -621
  10. package/lib/apps/canvas-builder/composables/useCanvasDnd.d.ts +12 -0
  11. package/lib/apps/canvas-builder/composables/useCanvasHistory.d.ts +93 -95
  12. package/lib/apps/canvas-builder/composables/useCanvasPages.d.ts +1 -0
  13. package/lib/apps/canvas-builder/composables/useCanvasSectionOverrides.d.ts +8 -7
  14. package/lib/apps/canvas-builder/composables/useCanvasTheme.d.ts +11 -11
  15. package/lib/apps/canvas-builder/composables/useCanvasVisibility.d.ts +5 -4
  16. package/lib/apps/canvas-builder/composables/useCollapsibles.d.ts +2 -2
  17. package/lib/apps/canvas-builder/composables/useContentSelector.d.ts +9 -9
  18. package/lib/apps/canvas-builder/composables/useRecommendations.d.ts +12 -10
  19. package/lib/apps/canvas-builder/types/canvas.d.ts +4 -3
  20. package/lib/apps/canvas-builder/util/tree.d.ts +1 -0
  21. package/lib/apps/content-selector/stores/app.d.ts +16 -15
  22. package/lib/components/CFileViewer/CFileViewer.use.d.ts +1 -1
  23. package/lib/composables/bulkActions.use.d.ts +4 -4
  24. package/lib/composables/recentFiles.use.d.ts +1 -1
  25. package/lib/composables/useDetailsView.d.ts +1 -1
  26. package/lib/composables/useLocation.d.ts +1 -1
  27. package/lib/composables/useLocationAPI.d.ts +2 -2
  28. package/lib/composables/useLocationManipulation.d.ts +1 -1
  29. package/lib/composables/useToast.d.ts +2 -2
  30. package/lib/custom-naive-locales/el.d.ts +1 -1
  31. package/lib/main.lib.d.ts +1 -1
  32. package/lib/sdk/api/HighLevelApi.d.ts +31 -31
  33. package/lib/sdk/api/modules/ui/canvas.ui.d.ts +6 -1
  34. package/lib/sdk/api/modules/ui/content.ui.d.ts +5 -5
  35. package/lib/sdk/api/modules/ui/index.d.ts +9 -2
  36. package/lib/sdk/api/modules/ui/post-call.ui.d.ts +6 -0
  37. package/lib/sdk/api/modules/ui/types.ui.d.ts +74 -10
  38. package/lib/sdk/interfaces.d.ts +3 -5
  39. package/lib/sdk/main.d.ts +140 -95
  40. package/lib/theme/light.d.ts +5 -315
  41. package/lib/types/instanceSettings.d.ts +1 -0
  42. package/lib/types/launchDarkly.types.d.ts +1 -1
  43. package/lib/types/organization.types.d.ts +14 -0
  44. package/lib/types/organizationSettings.types.d.ts +3 -0
  45. package/lib/util/network.d.ts +1 -1
  46. package/package.json +1 -1
  47. /package/lib/types/{organization.d.ts → organizationMetadata.types.d.ts} +0 -0
package/lib/sdk/main.d.ts CHANGED
@@ -13,6 +13,12 @@ export declare let highLevelApi: ReturnType<typeof createHighLevelApi>;
13
13
  export declare function usePitcherApi(options?: ApiOptions): ReturnType<typeof createHighLevelApi>;
14
14
  export declare function useUi(): {
15
15
  on: typeof ui.on;
16
+ on_meeting_canceled: typeof ui.on_meeting_canceled;
17
+ on_canvas_updated: typeof ui.on_canvas_updated;
18
+ on_section_list_updated: typeof ui.on_section_list_updated;
19
+ on_app_set_data: typeof ui.on_app_set_data;
20
+ on_app_update_data: typeof ui.on_app_update_data;
21
+ ui_broadcast: typeof ui.ui_broadcast;
16
22
  ui_select_content: typeof ui.ui_select_content;
17
23
  select_content: typeof ui.select_content;
18
24
  open: typeof ui.open;
@@ -22,7 +28,16 @@ export declare function useUi(): {
22
28
  update_location: typeof ui.update_location;
23
29
  capture_app_error: typeof ui.capture_app_error;
24
30
  update_canvas: typeof ui.update_canvas;
25
- } & Record<string, typeof ui.on | typeof ui.open | typeof ui.ui_select_content | typeof ui.toast | typeof ui.update_location | typeof ui.update_canvas | typeof ui.select_content | typeof ui.preselect_sfdc_meeting_id | typeof ui.embeddable_ready | typeof ui.capture_app_error>;
31
+ app_loaded: typeof ui.app_loaded;
32
+ app_resize: typeof ui.app_resize;
33
+ canvas_navigate_next_page: typeof ui.canvas_navigate_next_page;
34
+ canvas_navigate_previous_page: typeof ui.canvas_navigate_previous_page;
35
+ canvas_navigate_page: typeof ui.canvas_navigate_page;
36
+ complete_postcall: typeof ui.complete_postcall;
37
+ enable_postcall_submit: typeof ui.enable_postcall_submit;
38
+ disable_postcall_submit: typeof ui.disable_postcall_submit;
39
+ set_postcall_style: typeof ui.set_postcall_style;
40
+ } & Record<string, typeof ui.on | typeof ui.open | typeof ui.ui_broadcast | typeof ui.ui_select_content | typeof ui.toast | typeof ui.update_location | typeof ui.update_canvas | typeof ui.on_meeting_canceled | typeof ui.on_canvas_updated | typeof ui.on_section_list_updated | typeof ui.on_app_set_data | typeof ui.on_app_update_data | typeof ui.select_content | typeof ui.preselect_sfdc_meeting_id | typeof ui.embeddable_ready | typeof ui.capture_app_error | typeof ui.app_loaded | typeof ui.app_resize | typeof ui.canvas_navigate_next_page | typeof ui.canvas_navigate_previous_page | typeof ui.canvas_navigate_page | typeof ui.complete_postcall | typeof ui.enable_postcall_submit | typeof ui.disable_postcall_submit | typeof ui.set_postcall_style>;
26
41
  export declare function useAdmin(): {
27
42
  on: typeof admin.on;
28
43
  getEnv: typeof admin.getEnv;
@@ -54,8 +69,8 @@ export declare function useApi(): {
54
69
  openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
55
70
  getEnv(): Promise<import('./interfaces').PitcherEnv>;
56
71
  updateMyUser(payload: {
57
- language?: import('../main.lib').LanguageEnum | undefined;
58
- dark_mode?: boolean | undefined;
72
+ language?: import('../main.lib').LanguageEnum;
73
+ dark_mode?: boolean;
59
74
  }): Promise<import('../main.lib').User>;
60
75
  getLanguages(): Promise<import('./api/modules').Language[]>;
61
76
  getEvents(payload: Partial<import('../main.lib').EventRequest>): Promise<import('../main.lib').PaginatedData<import('../main.lib').Event>>;
@@ -63,58 +78,58 @@ export declare function useApi(): {
63
78
  updateEvent(payload: import('../main.lib').PatchedEventRequest): Promise<import('../main.lib').Event>;
64
79
  deleteEvent(payload: Partial<import('../main.lib').Event>): Promise<void>;
65
80
  getCanvases(payload: import('../main.lib').GetCanvasesParams & {
66
- filters?: Record<string, any> | undefined;
67
- fields?: string | undefined;
81
+ filters?: Record<string, any>;
82
+ fields?: string;
68
83
  }): Promise<import('../main.lib').PaginatedData<import('../main.lib').Canvas>>;
69
84
  createCanvas(payload: Omit<import('../main.lib').CanvasCreateRequest, "instance_id">): Promise<import('../main.lib').Canvas>;
70
85
  deleteCanvas(payload: {
71
- id: string;
86
+ id: import('../main.lib').Canvas["id"];
72
87
  }): Promise<import('../main.lib').Canvas>;
73
88
  updateCanvas(payload: import('../main.lib').PatchedCanvasUpdateRequest & {
74
- id: string;
75
- instance_id?: string | undefined;
76
- fields?: string | undefined;
89
+ id: import('../main.lib').Canvas["id"];
90
+ instance_id?: import('../main.lib').Instance["id"];
91
+ fields?: string;
77
92
  }): Promise<import('../main.lib').Canvas>;
78
93
  getCanvas(payload: {
79
- id: string;
80
- fields?: string | undefined;
94
+ id: import('../main.lib').Canvas["id"];
95
+ fields?: string;
81
96
  }): Promise<import('../main.lib').Canvas>;
82
97
  shareCanvas(payload: {
83
- id: string;
98
+ id: import('../main.lib').Canvas["id"];
84
99
  }): Promise<import('../main.lib').SharedLink>;
85
100
  getFiles(payload: import('./payload.types').ListFilesPayload): Promise<import('../main.lib').PaginatedFileList>;
86
- getRecentFiles(payload?: import('./payload.types').GetRecentFilesPayload | undefined): Promise<import('../main.lib').File[]>;
101
+ getRecentFiles(payload?: import('./payload.types').GetRecentFilesPayload): Promise<import('../main.lib').File[]>;
87
102
  downloadFile(payload: {
88
- file_id: string;
103
+ file_id: import('../main.lib').File["id"];
89
104
  }): Promise<null>;
90
105
  getAppConfig(payload: {
91
106
  app_name: string;
92
107
  }): Promise<Record<string, any>>;
93
108
  getFile(payload: {
94
- file_id: string;
109
+ file_id: import('../main.lib').FileRetrieve["id"];
95
110
  }): Promise<import('../main.lib').FileRetrieve>;
96
111
  updateFile(payload: import('../main.lib').FileUpdateRequest & {
97
- id: string;
112
+ id: import('../main.lib').File["id"];
98
113
  }): Promise<import('../main.lib').FileRetrieve>;
99
114
  deleteFile(payload: {
100
- file_id: string;
101
- }): Promise<string>;
115
+ file_id: import('../main.lib').File["id"];
116
+ }): Promise<import('../main.lib').File["id"]>;
102
117
  createFile(payload: Omit<import('../main.lib').AllFileCreateRequest, "instance_id">): Promise<import('../main.lib').FileRetrieve>;
103
118
  selectDeviceFile(): Promise<import('../main.lib').DeviceFile>;
104
119
  search(payload: {
105
120
  query: string;
106
- includeExpired?: boolean | undefined;
121
+ includeExpired?: boolean;
107
122
  }): Promise<any>;
108
- getUsers(payload?: import('../main.lib').GetUsersParams | undefined): Promise<import('../main.lib').PaginatedData<import('../main.lib').User>>;
123
+ getUsers(payload?: import('../main.lib').GetUsersParams): Promise<import('../main.lib').PaginatedData<import('../main.lib').User>>;
109
124
  refreshServiceToken(payload: import('../main.lib').RefreshServiceTokenRequest): Promise<import('../main.lib').RefreshServiceTokenResponse>;
110
125
  fetchDocumentInfo(payload: {
111
- fileId: string;
126
+ fileId: import('../main.lib').File["id"];
112
127
  }): Promise<{
113
- [key: string]: unknown;
114
128
  pageCount: number;
129
+ [key: string]: unknown;
115
130
  }>;
116
131
  renderPageAsImage(payload: {
117
- fileId: string;
132
+ fileId: import('../main.lib').File["id"];
118
133
  pageNumber: number;
119
134
  params: {
120
135
  width: number;
@@ -128,33 +143,33 @@ export declare function useApi(): {
128
143
  }): Promise<void>;
129
144
  query(payload: import('./payload.types').QueryPayload): Promise<any>;
130
145
  getFolder(payload?: {
131
- id: string;
146
+ id: import('../main.lib').FolderRetrieve["id"];
132
147
  }): Promise<import('../main.lib').FolderRetrieve>;
133
148
  createFolder(payload: Omit<import('../main.lib').FolderCreateRequest, "instance_id">): Promise<import('../main.lib').FolderRetrieve>;
134
149
  updateFolder(payload: import('../main.lib').FolderUpdateRequest & {
135
- id: string;
150
+ id: import('../main.lib').Folder["id"];
136
151
  }): Promise<import('../main.lib').FolderRetrieve>;
137
152
  deleteFolder(payload: {
138
- folder_id: string;
153
+ folder_id: import('../main.lib').FolderRetrieve["id"];
139
154
  }): Promise<void>;
140
155
  moveFolderItems(payload: {
141
- target_folder_id: string;
156
+ target_folder_id: import('../main.lib').Folder["id"];
142
157
  items: {
143
- id: string;
144
- type: "file" | "folder";
158
+ id: import('../main.lib').File["id"] | import('../main.lib').Folder["id"];
159
+ type: "folder" | "file";
145
160
  }[];
146
161
  }): Promise<import('../main.lib').FolderRetrieve>;
147
- getFavorites(payload?: import('../main.lib').GetFavoritesParams | undefined): Promise<import('../main.lib').PaginatedFavoriteList>;
162
+ getFavorites(payload?: import('../main.lib').GetFavoritesParams): Promise<import('../main.lib').PaginatedFavoriteList>;
148
163
  createFavorite(payload: import('../main.lib').FavoriteCreateRequest): Promise<import('../main.lib').Favorite>;
149
164
  deleteFavorite(payload: {
150
- favorite_id: string;
165
+ favorite_id: import('../main.lib').Favorite["id"];
151
166
  }): Promise<void>;
152
167
  notify(payload: import('./payload.types').NotificationPayload): Promise<void>;
153
168
  track(payload: {
154
169
  event_name: string;
155
170
  payload: any;
156
171
  }): Promise<any>;
157
- getInstanceMetadataTemplates(payload?: import('./payload.types').GetInstanceMetadataTemplatesPayload | undefined): Promise<import('../main.lib').PaginatedMetadataTemplateList>;
172
+ getInstanceMetadataTemplates(payload?: import('./payload.types').GetInstanceMetadataTemplatesPayload): Promise<import('../main.lib').PaginatedMetadataTemplateList>;
158
173
  triggerNonFilesSync(): Promise<void>;
159
174
  submitUserFeedback(payload: import('./payload.types').SubmitUserFeedbackPayload): Promise<any>;
160
175
  close(): Promise<any>;
@@ -175,6 +190,12 @@ export declare function useApi(): {
175
190
  } & Record<string, typeof dsr.on | typeof dsr.getEnv | typeof dsr.embeddable_ready>) | {
176
191
  ui: {
177
192
  on: typeof ui.on;
193
+ on_meeting_canceled: typeof ui.on_meeting_canceled;
194
+ on_canvas_updated: typeof ui.on_canvas_updated;
195
+ on_section_list_updated: typeof ui.on_section_list_updated;
196
+ on_app_set_data: typeof ui.on_app_set_data;
197
+ on_app_update_data: typeof ui.on_app_update_data;
198
+ ui_broadcast: typeof ui.ui_broadcast;
178
199
  ui_select_content: typeof ui.ui_select_content;
179
200
  select_content: typeof ui.select_content;
180
201
  open: typeof ui.open;
@@ -184,7 +205,16 @@ export declare function useApi(): {
184
205
  update_location: typeof ui.update_location;
185
206
  capture_app_error: typeof ui.capture_app_error;
186
207
  update_canvas: typeof ui.update_canvas;
187
- } & Record<string, typeof ui.on | typeof ui.open | typeof ui.ui_select_content | typeof ui.toast | typeof ui.update_location | typeof ui.update_canvas | typeof ui.select_content | typeof ui.preselect_sfdc_meeting_id | typeof ui.embeddable_ready | typeof ui.capture_app_error>;
208
+ app_loaded: typeof ui.app_loaded;
209
+ app_resize: typeof ui.app_resize;
210
+ canvas_navigate_next_page: typeof ui.canvas_navigate_next_page;
211
+ canvas_navigate_previous_page: typeof ui.canvas_navigate_previous_page;
212
+ canvas_navigate_page: typeof ui.canvas_navigate_page;
213
+ complete_postcall: typeof ui.complete_postcall;
214
+ enable_postcall_submit: typeof ui.enable_postcall_submit;
215
+ disable_postcall_submit: typeof ui.disable_postcall_submit;
216
+ set_postcall_style: typeof ui.set_postcall_style;
217
+ } & Record<string, typeof ui.on | typeof ui.open | typeof ui.ui_broadcast | typeof ui.ui_select_content | typeof ui.toast | typeof ui.update_location | typeof ui.update_canvas | typeof ui.on_meeting_canceled | typeof ui.on_canvas_updated | typeof ui.on_section_list_updated | typeof ui.on_app_set_data | typeof ui.on_app_update_data | typeof ui.select_content | typeof ui.preselect_sfdc_meeting_id | typeof ui.embeddable_ready | typeof ui.capture_app_error | typeof ui.app_loaded | typeof ui.app_resize | typeof ui.canvas_navigate_next_page | typeof ui.canvas_navigate_previous_page | typeof ui.canvas_navigate_page | typeof ui.complete_postcall | typeof ui.enable_postcall_submit | typeof ui.disable_postcall_submit | typeof ui.set_postcall_style>;
188
218
  impact: {
189
219
  on: (type: string, callback: (payload: import('./interfaces').PitcherEvent) => void) => void;
190
220
  off: (type: string, callback: (payload: import('./interfaces').PitcherEvent) => void) => void;
@@ -200,8 +230,8 @@ export declare function useApi(): {
200
230
  openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
201
231
  getEnv(): Promise<import('./interfaces').PitcherEnv>;
202
232
  updateMyUser(payload: {
203
- language?: import('../main.lib').LanguageEnum | undefined;
204
- dark_mode?: boolean | undefined;
233
+ language?: import('../main.lib').LanguageEnum;
234
+ dark_mode?: boolean;
205
235
  }): Promise<import('../main.lib').User>;
206
236
  getLanguages(): Promise<import('./api/modules').Language[]>;
207
237
  getEvents(payload: Partial<import('../main.lib').EventRequest>): Promise<import('../main.lib').PaginatedData<import('../main.lib').Event>>;
@@ -209,58 +239,58 @@ export declare function useApi(): {
209
239
  updateEvent(payload: import('../main.lib').PatchedEventRequest): Promise<import('../main.lib').Event>;
210
240
  deleteEvent(payload: Partial<import('../main.lib').Event>): Promise<void>;
211
241
  getCanvases(payload: import('../main.lib').GetCanvasesParams & {
212
- filters?: Record<string, any> | undefined;
213
- fields?: string | undefined;
242
+ filters?: Record<string, any>;
243
+ fields?: string;
214
244
  }): Promise<import('../main.lib').PaginatedData<import('../main.lib').Canvas>>;
215
245
  createCanvas(payload: Omit<import('../main.lib').CanvasCreateRequest, "instance_id">): Promise<import('../main.lib').Canvas>;
216
246
  deleteCanvas(payload: {
217
- id: string;
247
+ id: import('../main.lib').Canvas["id"];
218
248
  }): Promise<import('../main.lib').Canvas>;
219
249
  updateCanvas(payload: import('../main.lib').PatchedCanvasUpdateRequest & {
220
- id: string;
221
- instance_id?: string | undefined;
222
- fields?: string | undefined;
250
+ id: import('../main.lib').Canvas["id"];
251
+ instance_id?: import('../main.lib').Instance["id"];
252
+ fields?: string;
223
253
  }): Promise<import('../main.lib').Canvas>;
224
254
  getCanvas(payload: {
225
- id: string;
226
- fields?: string | undefined;
255
+ id: import('../main.lib').Canvas["id"];
256
+ fields?: string;
227
257
  }): Promise<import('../main.lib').Canvas>;
228
258
  shareCanvas(payload: {
229
- id: string;
259
+ id: import('../main.lib').Canvas["id"];
230
260
  }): Promise<import('../main.lib').SharedLink>;
231
261
  getFiles(payload: import('./payload.types').ListFilesPayload): Promise<import('../main.lib').PaginatedFileList>;
232
- getRecentFiles(payload?: import('./payload.types').GetRecentFilesPayload | undefined): Promise<import('../main.lib').File[]>;
262
+ getRecentFiles(payload?: import('./payload.types').GetRecentFilesPayload): Promise<import('../main.lib').File[]>;
233
263
  downloadFile(payload: {
234
- file_id: string;
264
+ file_id: import('../main.lib').File["id"];
235
265
  }): Promise<null>;
236
266
  getAppConfig(payload: {
237
267
  app_name: string;
238
268
  }): Promise<Record<string, any>>;
239
269
  getFile(payload: {
240
- file_id: string;
270
+ file_id: import('../main.lib').FileRetrieve["id"];
241
271
  }): Promise<import('../main.lib').FileRetrieve>;
242
272
  updateFile(payload: import('../main.lib').FileUpdateRequest & {
243
- id: string;
273
+ id: import('../main.lib').File["id"];
244
274
  }): Promise<import('../main.lib').FileRetrieve>;
245
275
  deleteFile(payload: {
246
- file_id: string;
247
- }): Promise<string>;
276
+ file_id: import('../main.lib').File["id"];
277
+ }): Promise<import('../main.lib').File["id"]>;
248
278
  createFile(payload: Omit<import('../main.lib').AllFileCreateRequest, "instance_id">): Promise<import('../main.lib').FileRetrieve>;
249
279
  selectDeviceFile(): Promise<import('../main.lib').DeviceFile>;
250
280
  search(payload: {
251
281
  query: string;
252
- includeExpired?: boolean | undefined;
282
+ includeExpired?: boolean;
253
283
  }): Promise<any>;
254
- getUsers(payload?: import('../main.lib').GetUsersParams | undefined): Promise<import('../main.lib').PaginatedData<import('../main.lib').User>>;
284
+ getUsers(payload?: import('../main.lib').GetUsersParams): Promise<import('../main.lib').PaginatedData<import('../main.lib').User>>;
255
285
  refreshServiceToken(payload: import('../main.lib').RefreshServiceTokenRequest): Promise<import('../main.lib').RefreshServiceTokenResponse>;
256
286
  fetchDocumentInfo(payload: {
257
- fileId: string;
287
+ fileId: import('../main.lib').File["id"];
258
288
  }): Promise<{
259
- [key: string]: unknown;
260
289
  pageCount: number;
290
+ [key: string]: unknown;
261
291
  }>;
262
292
  renderPageAsImage(payload: {
263
- fileId: string;
293
+ fileId: import('../main.lib').File["id"];
264
294
  pageNumber: number;
265
295
  params: {
266
296
  width: number;
@@ -274,33 +304,33 @@ export declare function useApi(): {
274
304
  }): Promise<void>;
275
305
  query(payload: import('./payload.types').QueryPayload): Promise<any>;
276
306
  getFolder(payload?: {
277
- id: string;
307
+ id: import('../main.lib').FolderRetrieve["id"];
278
308
  }): Promise<import('../main.lib').FolderRetrieve>;
279
309
  createFolder(payload: Omit<import('../main.lib').FolderCreateRequest, "instance_id">): Promise<import('../main.lib').FolderRetrieve>;
280
310
  updateFolder(payload: import('../main.lib').FolderUpdateRequest & {
281
- id: string;
311
+ id: import('../main.lib').Folder["id"];
282
312
  }): Promise<import('../main.lib').FolderRetrieve>;
283
313
  deleteFolder(payload: {
284
- folder_id: string;
314
+ folder_id: import('../main.lib').FolderRetrieve["id"];
285
315
  }): Promise<void>;
286
316
  moveFolderItems(payload: {
287
- target_folder_id: string;
317
+ target_folder_id: import('../main.lib').Folder["id"];
288
318
  items: {
289
- id: string;
290
- type: "file" | "folder";
319
+ id: import('../main.lib').File["id"] | import('../main.lib').Folder["id"];
320
+ type: "folder" | "file";
291
321
  }[];
292
322
  }): Promise<import('../main.lib').FolderRetrieve>;
293
- getFavorites(payload?: import('../main.lib').GetFavoritesParams | undefined): Promise<import('../main.lib').PaginatedFavoriteList>;
323
+ getFavorites(payload?: import('../main.lib').GetFavoritesParams): Promise<import('../main.lib').PaginatedFavoriteList>;
294
324
  createFavorite(payload: import('../main.lib').FavoriteCreateRequest): Promise<import('../main.lib').Favorite>;
295
325
  deleteFavorite(payload: {
296
- favorite_id: string;
326
+ favorite_id: import('../main.lib').Favorite["id"];
297
327
  }): Promise<void>;
298
328
  notify(payload: import('./payload.types').NotificationPayload): Promise<void>;
299
329
  track(payload: {
300
330
  event_name: string;
301
331
  payload: any;
302
332
  }): Promise<any>;
303
- getInstanceMetadataTemplates(payload?: import('./payload.types').GetInstanceMetadataTemplatesPayload | undefined): Promise<import('../main.lib').PaginatedMetadataTemplateList>;
333
+ getInstanceMetadataTemplates(payload?: import('./payload.types').GetInstanceMetadataTemplatesPayload): Promise<import('../main.lib').PaginatedMetadataTemplateList>;
304
334
  triggerNonFilesSync(): Promise<void>;
305
335
  submitUserFeedback(payload: import('./payload.types').SubmitUserFeedbackPayload): Promise<any>;
306
336
  close(): Promise<any>;
@@ -308,6 +338,12 @@ export declare function useApi(): {
308
338
  API: import('./api/LowLevelApi').LowLevelApi;
309
339
  };
310
340
  on: typeof ui.on;
341
+ on_meeting_canceled: typeof ui.on_meeting_canceled;
342
+ on_canvas_updated: typeof ui.on_canvas_updated;
343
+ on_section_list_updated: typeof ui.on_section_list_updated;
344
+ on_app_set_data: typeof ui.on_app_set_data;
345
+ on_app_update_data: typeof ui.on_app_update_data;
346
+ ui_broadcast: typeof ui.ui_broadcast;
311
347
  ui_select_content: typeof ui.ui_select_content;
312
348
  select_content: typeof ui.select_content;
313
349
  open: typeof ui.open;
@@ -317,6 +353,15 @@ export declare function useApi(): {
317
353
  update_location: typeof ui.update_location;
318
354
  capture_app_error: typeof ui.capture_app_error;
319
355
  update_canvas: typeof ui.update_canvas;
356
+ app_loaded: typeof ui.app_loaded;
357
+ app_resize: typeof ui.app_resize;
358
+ canvas_navigate_next_page: typeof ui.canvas_navigate_next_page;
359
+ canvas_navigate_previous_page: typeof ui.canvas_navigate_previous_page;
360
+ canvas_navigate_page: typeof ui.canvas_navigate_page;
361
+ complete_postcall: typeof ui.complete_postcall;
362
+ enable_postcall_submit: typeof ui.enable_postcall_submit;
363
+ disable_postcall_submit: typeof ui.disable_postcall_submit;
364
+ set_postcall_style: typeof ui.set_postcall_style;
320
365
  off: (type: string, callback: (payload: import('./interfaces').PitcherEvent) => void) => void;
321
366
  enterFullscreen: () => Promise<any>;
322
367
  exitFullscreen: () => Promise<any>;
@@ -329,8 +374,8 @@ export declare function useApi(): {
329
374
  openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
330
375
  getEnv(): Promise<import('./interfaces').PitcherEnv>;
331
376
  updateMyUser(payload: {
332
- language?: import('../main.lib').LanguageEnum | undefined;
333
- dark_mode?: boolean | undefined;
377
+ language?: import('../main.lib').LanguageEnum;
378
+ dark_mode?: boolean;
334
379
  }): Promise<import('../main.lib').User>;
335
380
  getLanguages(): Promise<import('./api/modules').Language[]>;
336
381
  getEvents(payload: Partial<import('../main.lib').EventRequest>): Promise<import('../main.lib').PaginatedData<import('../main.lib').Event>>;
@@ -338,58 +383,58 @@ export declare function useApi(): {
338
383
  updateEvent(payload: import('../main.lib').PatchedEventRequest): Promise<import('../main.lib').Event>;
339
384
  deleteEvent(payload: Partial<import('../main.lib').Event>): Promise<void>;
340
385
  getCanvases(payload: import('../main.lib').GetCanvasesParams & {
341
- filters?: Record<string, any> | undefined;
342
- fields?: string | undefined;
386
+ filters?: Record<string, any>;
387
+ fields?: string;
343
388
  }): Promise<import('../main.lib').PaginatedData<import('../main.lib').Canvas>>;
344
389
  createCanvas(payload: Omit<import('../main.lib').CanvasCreateRequest, "instance_id">): Promise<import('../main.lib').Canvas>;
345
390
  deleteCanvas(payload: {
346
- id: string;
391
+ id: import('../main.lib').Canvas["id"];
347
392
  }): Promise<import('../main.lib').Canvas>;
348
393
  updateCanvas(payload: import('../main.lib').PatchedCanvasUpdateRequest & {
349
- id: string;
350
- instance_id?: string | undefined;
351
- fields?: string | undefined;
394
+ id: import('../main.lib').Canvas["id"];
395
+ instance_id?: import('../main.lib').Instance["id"];
396
+ fields?: string;
352
397
  }): Promise<import('../main.lib').Canvas>;
353
398
  getCanvas(payload: {
354
- id: string;
355
- fields?: string | undefined;
399
+ id: import('../main.lib').Canvas["id"];
400
+ fields?: string;
356
401
  }): Promise<import('../main.lib').Canvas>;
357
402
  shareCanvas(payload: {
358
- id: string;
403
+ id: import('../main.lib').Canvas["id"];
359
404
  }): Promise<import('../main.lib').SharedLink>;
360
405
  getFiles(payload: import('./payload.types').ListFilesPayload): Promise<import('../main.lib').PaginatedFileList>;
361
- getRecentFiles(payload?: import('./payload.types').GetRecentFilesPayload | undefined): Promise<import('../main.lib').File[]>;
406
+ getRecentFiles(payload?: import('./payload.types').GetRecentFilesPayload): Promise<import('../main.lib').File[]>;
362
407
  downloadFile(payload: {
363
- file_id: string;
408
+ file_id: import('../main.lib').File["id"];
364
409
  }): Promise<null>;
365
410
  getAppConfig(payload: {
366
411
  app_name: string;
367
412
  }): Promise<Record<string, any>>;
368
413
  getFile(payload: {
369
- file_id: string;
414
+ file_id: import('../main.lib').FileRetrieve["id"];
370
415
  }): Promise<import('../main.lib').FileRetrieve>;
371
416
  updateFile(payload: import('../main.lib').FileUpdateRequest & {
372
- id: string;
417
+ id: import('../main.lib').File["id"];
373
418
  }): Promise<import('../main.lib').FileRetrieve>;
374
419
  deleteFile(payload: {
375
- file_id: string;
376
- }): Promise<string>;
420
+ file_id: import('../main.lib').File["id"];
421
+ }): Promise<import('../main.lib').File["id"]>;
377
422
  createFile(payload: Omit<import('../main.lib').AllFileCreateRequest, "instance_id">): Promise<import('../main.lib').FileRetrieve>;
378
423
  selectDeviceFile(): Promise<import('../main.lib').DeviceFile>;
379
424
  search(payload: {
380
425
  query: string;
381
- includeExpired?: boolean | undefined;
426
+ includeExpired?: boolean;
382
427
  }): Promise<any>;
383
- getUsers(payload?: import('../main.lib').GetUsersParams | undefined): Promise<import('../main.lib').PaginatedData<import('../main.lib').User>>;
428
+ getUsers(payload?: import('../main.lib').GetUsersParams): Promise<import('../main.lib').PaginatedData<import('../main.lib').User>>;
384
429
  refreshServiceToken(payload: import('../main.lib').RefreshServiceTokenRequest): Promise<import('../main.lib').RefreshServiceTokenResponse>;
385
430
  fetchDocumentInfo(payload: {
386
- fileId: string;
431
+ fileId: import('../main.lib').File["id"];
387
432
  }): Promise<{
388
- [key: string]: unknown;
389
433
  pageCount: number;
434
+ [key: string]: unknown;
390
435
  }>;
391
436
  renderPageAsImage(payload: {
392
- fileId: string;
437
+ fileId: import('../main.lib').File["id"];
393
438
  pageNumber: number;
394
439
  params: {
395
440
  width: number;
@@ -399,33 +444,33 @@ export declare function useApi(): {
399
444
  }): Promise<ArrayBuffer>;
400
445
  query(payload: import('./payload.types').QueryPayload): Promise<any>;
401
446
  getFolder(payload?: {
402
- id: string;
447
+ id: import('../main.lib').FolderRetrieve["id"];
403
448
  }): Promise<import('../main.lib').FolderRetrieve>;
404
449
  createFolder(payload: Omit<import('../main.lib').FolderCreateRequest, "instance_id">): Promise<import('../main.lib').FolderRetrieve>;
405
450
  updateFolder(payload: import('../main.lib').FolderUpdateRequest & {
406
- id: string;
451
+ id: import('../main.lib').Folder["id"];
407
452
  }): Promise<import('../main.lib').FolderRetrieve>;
408
453
  deleteFolder(payload: {
409
- folder_id: string;
454
+ folder_id: import('../main.lib').FolderRetrieve["id"];
410
455
  }): Promise<void>;
411
456
  moveFolderItems(payload: {
412
- target_folder_id: string;
457
+ target_folder_id: import('../main.lib').Folder["id"];
413
458
  items: {
414
- id: string;
415
- type: "file" | "folder";
459
+ id: import('../main.lib').File["id"] | import('../main.lib').Folder["id"];
460
+ type: "folder" | "file";
416
461
  }[];
417
462
  }): Promise<import('../main.lib').FolderRetrieve>;
418
- getFavorites(payload?: import('../main.lib').GetFavoritesParams | undefined): Promise<import('../main.lib').PaginatedFavoriteList>;
463
+ getFavorites(payload?: import('../main.lib').GetFavoritesParams): Promise<import('../main.lib').PaginatedFavoriteList>;
419
464
  createFavorite(payload: import('../main.lib').FavoriteCreateRequest): Promise<import('../main.lib').Favorite>;
420
465
  deleteFavorite(payload: {
421
- favorite_id: string;
466
+ favorite_id: import('../main.lib').Favorite["id"];
422
467
  }): Promise<void>;
423
468
  notify(payload: import('./payload.types').NotificationPayload): Promise<void>;
424
469
  track(payload: {
425
470
  event_name: string;
426
471
  payload: any;
427
472
  }): Promise<any>;
428
- getInstanceMetadataTemplates(payload?: import('./payload.types').GetInstanceMetadataTemplatesPayload | undefined): Promise<import('../main.lib').PaginatedMetadataTemplateList>;
473
+ getInstanceMetadataTemplates(payload?: import('./payload.types').GetInstanceMetadataTemplatesPayload): Promise<import('../main.lib').PaginatedMetadataTemplateList>;
429
474
  triggerNonFilesSync(): Promise<void>;
430
475
  submitUserFeedback(payload: import('./payload.types').SubmitUserFeedbackPayload): Promise<any>;
431
476
  close(): Promise<any>;