quickbase-js 2.4.0 → 2.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (46) hide show
  1. package/README.md +144 -76
  2. package/dist/quickbase.esm.js +3 -3
  3. package/dist/quickbase.min.js +3 -3
  4. package/dist/quickbase.min.js.map +1 -1
  5. package/package.json +13 -9
  6. package/src/auth/index.ts +55 -0
  7. package/src/auth/sso-token.ts +143 -0
  8. package/src/auth/temp-token.ts +160 -0
  9. package/src/auth/ticket.ts +329 -0
  10. package/src/auth/token-cache.ts +97 -0
  11. package/src/auth/types.ts +50 -0
  12. package/src/auth/user-token.ts +38 -0
  13. package/src/cli/schema.ts +512 -0
  14. package/src/client/index.ts +36 -0
  15. package/src/client/pagination.ts +337 -0
  16. package/src/client/request.ts +544 -0
  17. package/src/client/retry.ts +169 -0
  18. package/src/client/throttle.ts +105 -0
  19. package/src/core/config.ts +160 -0
  20. package/src/core/dates.ts +63 -0
  21. package/src/core/errors.ts +349 -0
  22. package/src/core/index.ts +50 -0
  23. package/src/core/logger.ts +113 -0
  24. package/src/core/schema.ts +213 -0
  25. package/src/core/transform.ts +295 -0
  26. package/src/core/types.ts +337 -0
  27. package/src/generated/client.ts +1785 -0
  28. package/src/generated/operations.json +672 -0
  29. package/src/generated/types.ts +4884 -0
  30. package/src/index.ts +259 -0
  31. package/src/xml/codepages.ts +119 -0
  32. package/src/xml/dbvars.ts +75 -0
  33. package/src/xml/errors.ts +133 -0
  34. package/src/xml/fields.ts +121 -0
  35. package/src/xml/groups.ts +560 -0
  36. package/src/xml/html.ts +152 -0
  37. package/src/xml/index.ts +1196 -0
  38. package/src/xml/metadata.ts +111 -0
  39. package/src/xml/records.ts +301 -0
  40. package/src/xml/request.ts +238 -0
  41. package/src/xml/roles.ts +321 -0
  42. package/src/xml/schema.ts +436 -0
  43. package/src/xml/transform.ts +381 -0
  44. package/src/xml/types.ts +602 -0
  45. package/src/xml/users.ts +221 -0
  46. package/src/xml/webhooks.ts +260 -0
package/src/generated/operations.json ADDED
@@ -0,0 +1,672 @@
1
+ [
2
+ {
3
+ "operationId": "createApp",
4
+ "method": "POST",
5
+ "path": "/apps",
6
+ "hasParams": false,
7
+ "hasBody": true,
8
+ "tags": [
9
+ "Apps"
10
+ ]
11
+ },
12
+ {
13
+ "operationId": "getApp",
14
+ "method": "GET",
15
+ "path": "/apps/{appId}",
16
+ "hasParams": true,
17
+ "hasBody": false,
18
+ "tags": [
19
+ "Apps"
20
+ ]
21
+ },
22
+ {
23
+ "operationId": "updateApp",
24
+ "method": "POST",
25
+ "path": "/apps/{appId}",
26
+ "hasParams": true,
27
+ "hasBody": true,
28
+ "tags": [
29
+ "Apps"
30
+ ]
31
+ },
32
+ {
33
+ "operationId": "deleteApp",
34
+ "method": "DELETE",
35
+ "path": "/apps/{appId}",
36
+ "hasParams": true,
37
+ "hasBody": true,
38
+ "tags": [
39
+ "Apps"
40
+ ]
41
+ },
42
+ {
43
+ "operationId": "getAppEvents",
44
+ "method": "GET",
45
+ "path": "/apps/{appId}/events",
46
+ "hasParams": true,
47
+ "hasBody": false,
48
+ "tags": [
49
+ "Apps"
50
+ ]
51
+ },
52
+ {
53
+ "operationId": "copyApp",
54
+ "method": "POST",
55
+ "path": "/apps/{appId}/copy",
56
+ "hasParams": true,
57
+ "hasBody": true,
58
+ "tags": [
59
+ "Apps"
60
+ ]
61
+ },
62
+ {
63
+ "operationId": "getRoles",
64
+ "method": "GET",
65
+ "path": "/apps/{appId}/roles",
66
+ "hasParams": true,
67
+ "hasBody": false,
68
+ "tags": [
69
+ "Apps"
70
+ ]
71
+ },
72
+ {
73
+ "operationId": "getAppTables",
74
+ "method": "GET",
75
+ "path": "/tables",
76
+ "hasParams": true,
77
+ "hasBody": false,
78
+ "tags": [
79
+ "Tables"
80
+ ]
81
+ },
82
+ {
83
+ "operationId": "createTable",
84
+ "method": "POST",
85
+ "path": "/tables",
86
+ "hasParams": true,
87
+ "hasBody": true,
88
+ "tags": [
89
+ "Tables"
90
+ ]
91
+ },
92
+ {
93
+ "operationId": "getTable",
94
+ "method": "GET",
95
+ "path": "/tables/{tableId}",
96
+ "hasParams": true,
97
+ "hasBody": false,
98
+ "tags": [
99
+ "Tables"
100
+ ]
101
+ },
102
+ {
103
+ "operationId": "updateTable",
104
+ "method": "POST",
105
+ "path": "/tables/{tableId}",
106
+ "hasParams": true,
107
+ "hasBody": true,
108
+ "tags": [
109
+ "Tables"
110
+ ]
111
+ },
112
+ {
113
+ "operationId": "deleteTable",
114
+ "method": "DELETE",
115
+ "path": "/tables/{tableId}",
116
+ "hasParams": true,
117
+ "hasBody": false,
118
+ "tags": [
119
+ "Tables"
120
+ ]
121
+ },
122
+ {
123
+ "operationId": "getRelationships",
124
+ "method": "GET",
125
+ "path": "/tables/{tableId}/relationships",
126
+ "hasParams": true,
127
+ "hasBody": false,
128
+ "tags": [
129
+ "Tables"
130
+ ]
131
+ },
132
+ {
133
+ "operationId": "createRelationship",
134
+ "method": "POST",
135
+ "path": "/tables/{tableId}/relationship",
136
+ "hasParams": true,
137
+ "hasBody": true,
138
+ "tags": [
139
+ "Tables"
140
+ ]
141
+ },
142
+ {
143
+ "operationId": "updateRelationship",
144
+ "method": "POST",
145
+ "path": "/tables/{tableId}/relationship/{relationshipId}",
146
+ "hasParams": true,
147
+ "hasBody": true,
148
+ "tags": [
149
+ "Tables"
150
+ ]
151
+ },
152
+ {
153
+ "operationId": "deleteRelationship",
154
+ "method": "DELETE",
155
+ "path": "/tables/{tableId}/relationship/{relationshipId}",
156
+ "hasParams": true,
157
+ "hasBody": false,
158
+ "tags": [
159
+ "Tables"
160
+ ]
161
+ },
162
+ {
163
+ "operationId": "getTableReports",
164
+ "method": "GET",
165
+ "path": "/reports",
166
+ "hasParams": true,
167
+ "hasBody": false,
168
+ "tags": [
169
+ "Reports"
170
+ ]
171
+ },
172
+ {
173
+ "operationId": "getReport",
174
+ "method": "GET",
175
+ "path": "/reports/{reportId}",
176
+ "hasParams": true,
177
+ "hasBody": false,
178
+ "tags": [
179
+ "Reports"
180
+ ]
181
+ },
182
+ {
183
+ "operationId": "runReport",
184
+ "method": "POST",
185
+ "path": "/reports/{reportId}/run",
186
+ "hasParams": true,
187
+ "hasBody": false,
188
+ "tags": [
189
+ "Reports"
190
+ ]
191
+ },
192
+ {
193
+ "operationId": "getFields",
194
+ "method": "GET",
195
+ "path": "/fields",
196
+ "hasParams": true,
197
+ "hasBody": false,
198
+ "tags": [
199
+ "Fields"
200
+ ]
201
+ },
202
+ {
203
+ "operationId": "createField",
204
+ "method": "POST",
205
+ "path": "/fields",
206
+ "hasParams": true,
207
+ "hasBody": true,
208
+ "tags": [
209
+ "Fields"
210
+ ]
211
+ },
212
+ {
213
+ "operationId": "deleteFields",
214
+ "method": "DELETE",
215
+ "path": "/fields",
216
+ "hasParams": true,
217
+ "hasBody": true,
218
+ "tags": [
219
+ "Fields"
220
+ ]
221
+ },
222
+ {
223
+ "operationId": "getField",
224
+ "method": "GET",
225
+ "path": "/fields/{fieldId}",
226
+ "hasParams": true,
227
+ "hasBody": false,
228
+ "tags": [
229
+ "Fields"
230
+ ]
231
+ },
232
+ {
233
+ "operationId": "updateField",
234
+ "method": "POST",
235
+ "path": "/fields/{fieldId}",
236
+ "hasParams": true,
237
+ "hasBody": true,
238
+ "tags": [
239
+ "Fields"
240
+ ]
241
+ },
242
+ {
243
+ "operationId": "getFieldsUsage",
244
+ "method": "GET",
245
+ "path": "/fields/usage",
246
+ "hasParams": true,
247
+ "hasBody": false,
248
+ "tags": [
249
+ "Fields"
250
+ ]
251
+ },
252
+ {
253
+ "operationId": "getFieldUsage",
254
+ "method": "GET",
255
+ "path": "/fields/usage/{fieldId}",
256
+ "hasParams": true,
257
+ "hasBody": false,
258
+ "tags": [
259
+ "Fields"
260
+ ]
261
+ },
262
+ {
263
+ "operationId": "runFormula",
264
+ "method": "POST",
265
+ "path": "/formula/run",
266
+ "hasParams": false,
267
+ "hasBody": true,
268
+ "tags": [
269
+ "Formulas"
270
+ ]
271
+ },
272
+ {
273
+ "operationId": "upsert",
274
+ "method": "POST",
275
+ "path": "/records",
276
+ "hasParams": false,
277
+ "hasBody": true,
278
+ "tags": [
279
+ "Records"
280
+ ]
281
+ },
282
+ {
283
+ "operationId": "deleteRecords",
284
+ "method": "DELETE",
285
+ "path": "/records",
286
+ "hasParams": false,
287
+ "hasBody": true,
288
+ "tags": [
289
+ "Records"
290
+ ]
291
+ },
292
+ {
293
+ "operationId": "runQuery",
294
+ "method": "POST",
295
+ "path": "/records/query",
296
+ "hasParams": false,
297
+ "hasBody": true,
298
+ "tags": [
299
+ "Records"
300
+ ]
301
+ },
302
+ {
303
+ "operationId": "recordsModifiedSince",
304
+ "method": "POST",
305
+ "path": "/records/modifiedSince",
306
+ "hasParams": false,
307
+ "hasBody": true,
308
+ "tags": [
309
+ "Records"
310
+ ]
311
+ },
312
+ {
313
+ "operationId": "getTempTokenDBID",
314
+ "method": "GET",
315
+ "path": "/auth/temporary/{dbid}",
316
+ "hasParams": true,
317
+ "hasBody": false,
318
+ "tags": [
319
+ "Auth"
320
+ ]
321
+ },
322
+ {
323
+ "operationId": "exchangeSsoToken",
324
+ "method": "POST",
325
+ "path": "/auth/oauth/token",
326
+ "hasParams": false,
327
+ "hasBody": true,
328
+ "tags": [
329
+ "Auth"
330
+ ]
331
+ },
332
+ {
333
+ "operationId": "cloneUserToken",
334
+ "method": "POST",
335
+ "path": "/usertoken/clone",
336
+ "hasParams": false,
337
+ "hasBody": true,
338
+ "tags": [
339
+ "UserToken"
340
+ ]
341
+ },
342
+ {
343
+ "operationId": "transferUserToken",
344
+ "method": "POST",
345
+ "path": "/usertoken/transfer",
346
+ "hasParams": false,
347
+ "hasBody": true,
348
+ "tags": [
349
+ "UserToken"
350
+ ]
351
+ },
352
+ {
353
+ "operationId": "deactivateUserToken",
354
+ "method": "POST",
355
+ "path": "/usertoken/deactivate",
356
+ "hasParams": false,
357
+ "hasBody": false,
358
+ "tags": [
359
+ "UserToken"
360
+ ]
361
+ },
362
+ {
363
+ "operationId": "deleteUserToken",
364
+ "method": "DELETE",
365
+ "path": "/usertoken",
366
+ "hasParams": false,
367
+ "hasBody": false,
368
+ "tags": [
369
+ "UserToken"
370
+ ]
371
+ },
372
+ {
373
+ "operationId": "downloadFile",
374
+ "method": "GET",
375
+ "path": "/files/{tableId}/{recordId}/{fieldId}/{versionNumber}",
376
+ "hasParams": true,
377
+ "hasBody": false,
378
+ "tags": [
379
+ "Files"
380
+ ]
381
+ },
382
+ {
383
+ "operationId": "deleteFile",
384
+ "method": "DELETE",
385
+ "path": "/files/{tableId}/{recordId}/{fieldId}/{versionNumber}",
386
+ "hasParams": true,
387
+ "hasBody": false,
388
+ "tags": [
389
+ "Files"
390
+ ]
391
+ },
392
+ {
393
+ "operationId": "getUsers",
394
+ "method": "POST",
395
+ "path": "/users",
396
+ "hasParams": true,
397
+ "hasBody": true,
398
+ "tags": [
399
+ "Users"
400
+ ]
401
+ },
402
+ {
403
+ "operationId": "denyUsers",
404
+ "method": "PUT",
405
+ "path": "/users/deny",
406
+ "hasParams": true,
407
+ "hasBody": true,
408
+ "tags": [
409
+ "Users"
410
+ ]
411
+ },
412
+ {
413
+ "operationId": "denyUsersAndGroups",
414
+ "method": "PUT",
415
+ "path": "/users/deny/{shouldDeleteFromGroups}",
416
+ "hasParams": true,
417
+ "hasBody": true,
418
+ "tags": [
419
+ "Users"
420
+ ]
421
+ },
422
+ {
423
+ "operationId": "undenyUsers",
424
+ "method": "PUT",
425
+ "path": "/users/undeny",
426
+ "hasParams": true,
427
+ "hasBody": true,
428
+ "tags": [
429
+ "Users"
430
+ ]
431
+ },
432
+ {
433
+ "operationId": "getUserApps",
434
+ "method": "GET",
435
+ "path": "/users/{userId}/apps",
436
+ "hasParams": true,
437
+ "hasBody": false,
438
+ "tags": [
439
+ "Users"
440
+ ]
441
+ },
442
+ {
443
+ "operationId": "addMembersToGroup",
444
+ "method": "POST",
445
+ "path": "/groups/{gid}/members",
446
+ "hasParams": true,
447
+ "hasBody": true,
448
+ "tags": [
449
+ "Groups"
450
+ ]
451
+ },
452
+ {
453
+ "operationId": "removeMembersFromGroup",
454
+ "method": "DELETE",
455
+ "path": "/groups/{gid}/members",
456
+ "hasParams": true,
457
+ "hasBody": true,
458
+ "tags": [
459
+ "Groups"
460
+ ]
461
+ },
462
+ {
463
+ "operationId": "addManagersToGroup",
464
+ "method": "POST",
465
+ "path": "/groups/{gid}/managers",
466
+ "hasParams": true,
467
+ "hasBody": true,
468
+ "tags": [
469
+ "Groups"
470
+ ]
471
+ },
472
+ {
473
+ "operationId": "removeManagersFromGroup",
474
+ "method": "DELETE",
475
+ "path": "/groups/{gid}/managers",
476
+ "hasParams": true,
477
+ "hasBody": true,
478
+ "tags": [
479
+ "Groups"
480
+ ]
481
+ },
482
+ {
483
+ "operationId": "addSubgroupsToGroup",
484
+ "method": "POST",
485
+ "path": "/groups/{gid}/subgroups",
486
+ "hasParams": true,
487
+ "hasBody": true,
488
+ "tags": [
489
+ "Groups"
490
+ ]
491
+ },
492
+ {
493
+ "operationId": "removeSubgroupsFromGroup",
494
+ "method": "DELETE",
495
+ "path": "/groups/{gid}/subgroups",
496
+ "hasParams": true,
497
+ "hasBody": true,
498
+ "tags": [
499
+ "Groups"
500
+ ]
501
+ },
502
+ {
503
+ "operationId": "audit",
504
+ "method": "POST",
505
+ "path": "/audit",
506
+ "hasParams": false,
507
+ "hasBody": true,
508
+ "tags": [
509
+ "Audit"
510
+ ]
511
+ },
512
+ {
513
+ "operationId": "platformAnalyticReads",
514
+ "method": "GET",
515
+ "path": "/analytics/reads",
516
+ "hasParams": true,
517
+ "hasBody": false,
518
+ "tags": [
519
+ "Platform Analytics"
520
+ ]
521
+ },
522
+ {
523
+ "operationId": "platformAnalyticEventSummaries",
524
+ "method": "POST",
525
+ "path": "/analytics/events/summaries",
526
+ "hasParams": true,
527
+ "hasBody": true,
528
+ "tags": [
529
+ "Platform Analytics"
530
+ ]
531
+ },
532
+ {
533
+ "operationId": "generateDocument",
534
+ "method": "GET",
535
+ "path": "/docTemplates/{templateId}/generate",
536
+ "hasParams": true,
537
+ "hasBody": false,
538
+ "tags": [
539
+ "Document Templates"
540
+ ]
541
+ },
542
+ {
543
+ "operationId": "exportSolution",
544
+ "method": "GET",
545
+ "path": "/solutions/{solutionId}",
546
+ "hasParams": true,
547
+ "hasBody": false,
548
+ "tags": [
549
+ "Solutions"
550
+ ]
551
+ },
552
+ {
553
+ "operationId": "updateSolution",
554
+ "method": "PUT",
555
+ "path": "/solutions/{solutionId}",
556
+ "hasParams": true,
557
+ "hasBody": true,
558
+ "tags": [
559
+ "Solutions"
560
+ ]
561
+ },
562
+ {
563
+ "operationId": "createSolution",
564
+ "method": "POST",
565
+ "path": "/solutions",
566
+ "hasParams": true,
567
+ "hasBody": true,
568
+ "tags": [
569
+ "Solutions"
570
+ ]
571
+ },
572
+ {
573
+ "operationId": "exportSolutionToRecord",
574
+ "method": "GET",
575
+ "path": "/solutions/{solutionId}/torecord",
576
+ "hasParams": true,
577
+ "hasBody": false,
578
+ "tags": [
579
+ "Solutions"
580
+ ]
581
+ },
582
+ {
583
+ "operationId": "createSolutionFromRecord",
584
+ "method": "GET",
585
+ "path": "/solutions/fromrecord",
586
+ "hasParams": true,
587
+ "hasBody": false,
588
+ "tags": [
589
+ "Solutions"
590
+ ]
591
+ },
592
+ {
593
+ "operationId": "updateSolutionToRecord",
594
+ "method": "GET",
595
+ "path": "/solutions/{solutionId}/fromrecord",
596
+ "hasParams": true,
597
+ "hasBody": false,
598
+ "tags": [
599
+ "Solutions"
600
+ ]
601
+ },
602
+ {
603
+ "operationId": "changesetSolution",
604
+ "method": "PUT",
605
+ "path": "/solutions/{solutionId}/changeset",
606
+ "hasParams": true,
607
+ "hasBody": true,
608
+ "tags": [
609
+ "Solutions"
610
+ ]
611
+ },
612
+ {
613
+ "operationId": "changesetSolutionFromRecord",
614
+ "method": "GET",
615
+ "path": "/solutions/{solutionId}/changeset/fromrecord",
616
+ "hasParams": true,
617
+ "hasBody": false,
618
+ "tags": [
619
+ "Solutions"
620
+ ]
621
+ },
622
+ {
623
+ "operationId": "getSolutionPublic",
624
+ "method": "GET",
625
+ "path": "/solutions/{solutionId}/resources",
626
+ "hasParams": true,
627
+ "hasBody": false,
628
+ "tags": [
629
+ "Solutions"
630
+ ]
631
+ },
632
+ {
633
+ "operationId": "getTrustees",
634
+ "method": "GET",
635
+ "path": "/app/{appId}/trustees",
636
+ "hasParams": true,
637
+ "hasBody": false,
638
+ "tags": [
639
+ "Trustees"
640
+ ]
641
+ },
642
+ {
643
+ "operationId": "addTrustees",
644
+ "method": "POST",
645
+ "path": "/app/{appId}/trustees",
646
+ "hasParams": true,
647
+ "hasBody": true,
648
+ "tags": [
649
+ "Trustees"
650
+ ]
651
+ },
652
+ {
653
+ "operationId": "removeTrustees",
654
+ "method": "DELETE",
655
+ "path": "/app/{appId}/trustees",
656
+ "hasParams": true,
657
+ "hasBody": true,
658
+ "tags": [
659
+ "Trustees"
660
+ ]
661
+ },
662
+ {
663
+ "operationId": "updateTrustees",
664
+ "method": "PATCH",
665
+ "path": "/app/{appId}/trustees",
666
+ "hasParams": true,
667
+ "hasBody": true,
668
+ "tags": [
669
+ "Trustees"
670
+ ]
671
+ }
672
+ ]