quickbase-js 0.1.0-beta.8 → 0.1.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 (52) hide show
  1. package/CHANGELOG.md +29 -0
  2. package/README.md +46 -130
  3. package/dist/esm/quickbase.d.ts +822 -119
  4. package/dist/esm/quickbase.js +373 -236
  5. package/dist/esm/quickbase.js.map +1 -1
  6. package/dist/esm/quickbase.min.js +1 -1
  7. package/dist/esm/quickbase.min.js.map +1 -1
  8. package/dist/umd/quickbase.umd.js +373 -236
  9. package/dist/umd/quickbase.umd.js.map +1 -1
  10. package/dist/umd/quickbase.umd.min.js +1 -1
  11. package/dist/umd/quickbase.umd.min.js.map +1 -1
  12. package/open-api/generate-unified-interface.ts +97 -17
  13. package/open-api/utils/generateJsDoc.ts +96 -0
  14. package/package.json +3 -1
  15. package/src/ThrottleBucket.ts +17 -12
  16. package/src/authorizationStrategy.ts +246 -0
  17. package/src/generated-unified/QuickbaseClient.ts +809 -119
  18. package/src/invokeMethod.ts +150 -265
  19. package/src/quickbaseClient.ts +85 -58
  20. package/src/rateLimiter.ts +25 -0
  21. package/src/tokenCache.ts +10 -26
  22. package/tests/vitest/qb/auth/mockQuickbaseServer.ts +60 -0
  23. package/tests/vitest/qb/auth/retryUserToken401.test.ts +59 -42
  24. package/tests/vitest/qb/auth/ssoTokenIntegrationWithServer.test.ts +65 -0
  25. package/tests/vitest/qb/fields/getFieldUsage.test.ts +58 -150
  26. package/tests/vitest/qb/formulas/runFormula.test.ts +96 -0
  27. package/tests/vitest/qb/tables/createRelationship.test.ts +102 -0
  28. package/tests/vitest/qb/tables/deleteRelationship.test.ts +143 -0
  29. package/tests/vitest/qb/tables/updateRelationship.test.ts +118 -145
  30. package/tests/vitest/unit/ThrottleBucket.test.ts +95 -0
  31. package/tests/vitest/unit/apps/copyApp.test.ts +133 -40
  32. package/tests/vitest/unit/apps/updateApp.test.ts +42 -11
  33. package/tests/vitest/unit/auth/fetchTempToken401.test.ts +3 -2
  34. package/tests/vitest/unit/auth/getTempToken.test.ts +42 -18
  35. package/tests/vitest/unit/auth/retryTempToken401.test.ts +46 -64
  36. package/tests/vitest/unit/auth/retryTempTokenMaxRetries.test.ts +235 -0
  37. package/tests/vitest/unit/auth/retryUserToken401.test.ts +56 -43
  38. package/tests/vitest/unit/auth/ssoTokenRefresh.test.ts +325 -0
  39. package/tests/vitest/unit/fields/createField.test.ts +180 -116
  40. package/tests/vitest/unit/fields/getFieldUsage.test.ts +17 -3
  41. package/tests/vitest/unit/fields/updateField.test.ts +12 -7
  42. package/tests/vitest/unit/formulas/runFormula.test.ts +205 -0
  43. package/tests/vitest/unit/index.ts +2 -1
  44. package/tests/vitest/unit/inferHttpMethod.test.ts +131 -0
  45. package/tests/vitest/unit/rateLimit.test.ts +4 -2
  46. package/tests/vitest/unit/tables/createRelationship.test.ts +212 -0
  47. package/tests/vitest/unit/tables/deleteRelationship.test.ts +97 -0
  48. package/tests/vitest/unit/tables/updateRelationship.test.ts +12 -10
  49. package/tests/vitest/unit/tokenLifespan.test.ts +149 -83
  50. package/tools/log-gen.ts +14 -5
  51. package/tools/log-gen.yaml +710 -268
  52. package/tests/vitest/unit/auth/retryTempTokenTwo401.test.ts +0 -81
@@ -7458,24 +7458,84 @@ declare function UpsertRequestToJSONTyped(value?: UpsertRequest | null, ignoreDi
7458
7458
  interface QuickbaseClient$1 {
7459
7459
  /**
7460
7460
  * Create an app
7461
- * @param params - Parameters for createApp
7462
- * @returns Promise resolving to createApp response
7461
+ *
7462
+ * @param {Object} params _Object containing the parameters for_ createApp
7463
+ * @param {CreateAppRequest} params.body _Optional parameter with properties_
7464
+ * - **name** (`string`, required) _The name of the app._
7465
+ * - **description** (`string`, optional) _A description for the app._
7466
+ * - **assignToken** (`boolean`, required) _Whether to assign the user token._
7467
+ *
7468
+ * @returns {Promise<CreateApp200Response>} _Promise resolving to the createApp response with properties_
7469
+ * - **name** (`string`, required) _The app name. You are allowed to create multiple apps with the same name, in the same realm, because they will have different dbid values. We urge you to be careful about doing this._
7470
+ * - **description** (`string`, optional) _The description for the app. If this property is left out, the app description will be blank._
7471
+ * - **created** (`string`, optional) _The time and date the app was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)._
7472
+ * - **updated** (`string`, optional) _The time and date the app was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)._
7473
+ * - **dateFormat** (`string`, optional) _A description of the format used when displaying date values in this app. Note that this is a browser-only parameter - see the [Field type details](../fieldInfo) page in the API Guide for how time values are returned in API calls. See [About Localizing Dates](https://help.quickbase.com/user-assistance/about_localizing_dates_numbers.html) to set the app’s date format._
7474
+ * - **timeZone** (`string`, optional) _A description of the time zone used when displaying time values in this app. Note that this is a browser-only parameter - see the [Field type details](../fieldInfo) page in the portal for how time values are returned in API calls. See [Set the Time Zone for Both the Application and the Account](https://help.quickbase.com/user-assistance/application_local_timezone.html) to set the application’s time zone._
7475
+ * - **memoryInfo** (`object`, optional) _Application memory info_
7476
+ * - **id** (`string`, optional) _The unique identifier for this application._
7477
+ * - **hasEveryoneOnTheInternet** (`boolean`, optional) _Indicates whether app includes Everyone On The Internet access. See [Sharing apps with Everyone on the Internet (EOTI).](https://help.quickbase.com/user-assistance/share_with_everyone_on_internet.html)_
7478
+ * - **variables** (`{ [key: string]: any; }[]`, optional) _The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)_
7479
+ * - **dataClassification** (`string`, optional) _The Data Classification label assigned to the application. If Data Classification is not turned on, this will not be returned. If Data Classification is turned on, but application is not labeled, we return “None". Data Classification labels can be added in the Admin Console by a Realm Administrator for Platform+ plans._
7480
+ * - **securityProperties** (`{ [key: string]: any; }`, optional) _Security properties of the application_
7481
+ *
7482
+ * @see {@link https://developer.quickbase.com/operation/createApp} Official Quickbase API documentation
7463
7483
  */
7464
7484
  createApp: (params: {
7465
7485
  body?: CreateAppRequest;
7466
7486
  }) => Promise<CreateApp200Response>;
7467
7487
  /**
7468
7488
  * Get an app
7469
- * @param params - Parameters for getApp
7470
- * @returns Promise resolving to getApp response
7489
+ *
7490
+ * @param {Object} params _Object containing the parameters for_ getApp
7491
+ * @param {string} params.appId _Required parameter with properties_
7492
+ *
7493
+ * @returns {Promise<GetApp200Response>} _Promise resolving to the getApp response with properties_
7494
+ * - **ancestorId** (`string`, optional) _The id of the app from which this app was copied_
7495
+ * - **name** (`string`, required) _The app name. You are allowed to create multiple apps with the same name, in the same realm, because they will have different dbid values. We urge you to be careful about doing this._
7496
+ * - **description** (`string`, optional) _The description for the app. If this property is left out, the app description will be blank._
7497
+ * - **created** (`string`, optional) _The time and date the app was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)._
7498
+ * - **updated** (`string`, optional) _The time and date the app was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)._
7499
+ * - **dateFormat** (`string`, optional) _A description of the format used when displaying date values in this app. Note that this is a browser-only parameter - see the [Field type details](../fieldInfo) page in the API Guide for how time values are returned in API calls. See [About Localizing Dates](https://help.quickbase.com/user-assistance/about_localizing_dates_numbers.html) to set the app’s date format._
7500
+ * - **timeZone** (`string`, optional) _A description of the time zone used when displaying time values in this app. Note that this is a browser-only parameter - see the [Field type details](../fieldInfo) page in the portal for how time values are returned in API calls. See [Set the Time Zone for Both the Application and the Account](https://help.quickbase.com/user-assistance/application_local_timezone.html) to set the application’s time zone._
7501
+ * - **memoryInfo** (`object`, optional) _Application memory info_
7502
+ * - **id** (`string`, optional) _The unique identifier for this application._
7503
+ * - **hasEveryoneOnTheInternet** (`boolean`, optional) _Indicates whether app includes Everyone On The Internet access. See [Sharing apps with Everyone on the Internet (EOTI).](https://help.quickbase.com/user-assistance/share_with_everyone_on_internet.html)_
7504
+ * - **variables** (`{ [key: string]: any; }[]`, optional) _The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)_
7505
+ * - **dataClassification** (`string`, optional) _The Data Classification label assigned to the application. If Data Classification is not turned on, this will not be returned. If Data Classification is turned on, but application is not labeled, we return “None". Data Classification labels can be added in the Admin Console by a Realm Administrator for Platform+ plans._
7506
+ * - **securityProperties** (`{ [key: string]: any; }`, optional) _Security properties of the application_
7507
+ *
7508
+ * @see {@link https://developer.quickbase.com/operation/getApp} Official Quickbase API documentation
7471
7509
  */
7472
7510
  getApp: (params: {
7473
7511
  appId: string;
7474
7512
  }) => Promise<GetApp200Response>;
7475
7513
  /**
7476
7514
  * Update an app
7477
- * @param params - Parameters for updateApp
7478
- * @returns Promise resolving to updateApp response
7515
+ *
7516
+ * @param {Object} params _Object containing the parameters for_ updateApp
7517
+ * @param {string} params.appId _Required parameter with properties_
7518
+ * @param {UpdateAppRequest} params.body _Optional parameter with properties_
7519
+ * - **name** (`string`, required) _The name of the app._
7520
+ * - **description** (`string`, optional) _A description for the app._
7521
+ * - **assignToken** (`boolean`, required) _Whether to assign the user token._
7522
+ *
7523
+ * @returns {Promise<UpdateApp200Response>} _Promise resolving to the updateApp response with properties_
7524
+ * - **ancestorId** (`string`, optional) _The id of the app from which this app was copied_
7525
+ * - **name** (`string`, required) _The app name. You are allowed to create multiple apps with the same name, in the same realm, because they will have different dbid values. We urge you to be careful about doing this._
7526
+ * - **description** (`string`, optional) _The description for the app. If this property is left out, the app description will be blank._
7527
+ * - **created** (`string`, optional) _The time and date the app was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)._
7528
+ * - **updated** (`string`, optional) _The time and date the app was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)._
7529
+ * - **dateFormat** (`string`, optional) _A description of the format used when displaying date values in this app. Note that this is a browser-only parameter - see the [Field type details](../fieldInfo) page in the API Guide for how time values are returned in API calls. See [About Localizing Dates](https://help.quickbase.com/user-assistance/about_localizing_dates_numbers.html) to set the app’s date format._
7530
+ * - **timeZone** (`string`, optional) _A description of the time zone used when displaying time values in this app. Note that this is a browser-only parameter - see the [Field type details](../fieldInfo) page in the portal for how time values are returned in API calls. See [Set the Time Zone for Both the Application and the Account](https://help.quickbase.com/user-assistance/application_local_timezone.html) to set the application’s time zone._
7531
+ * - **memoryInfo** (`object`, optional) _Application memory info_
7532
+ * - **id** (`string`, optional) _The unique identifier for this application._
7533
+ * - **hasEveryoneOnTheInternet** (`boolean`, optional) _Indicates whether app includes Everyone On The Internet access. See [Sharing apps with Everyone on the Internet (EOTI).](https://help.quickbase.com/user-assistance/share_with_everyone_on_internet.html)_
7534
+ * - **variables** (`{ [key: string]: any; }[]`, optional) _The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)_
7535
+ * - **dataClassification** (`string`, optional) _The Data Classification label assigned to the application. If Data Classification is not turned on, this will not be returned. If Data Classification is turned on, but application is not labeled, we return “None". Data Classification labels can be added in the Admin Console by a Realm Administrator for Platform+ plans._
7536
+ * - **securityProperties** (`{ [key: string]: any; }`, optional) _Security properties of the application_
7537
+ *
7538
+ * @see {@link https://developer.quickbase.com/operation/updateApp} Official Quickbase API documentation
7479
7539
  */
7480
7540
  updateApp: (params: {
7481
7541
  appId: string;
@@ -7483,8 +7543,18 @@ interface QuickbaseClient$1 {
7483
7543
  }) => Promise<UpdateApp200Response>;
7484
7544
  /**
7485
7545
  * Delete an app
7486
- * @param params - Parameters for deleteApp
7487
- * @returns Promise resolving to deleteApp response
7546
+ *
7547
+ * @param {Object} params _Object containing the parameters for_ deleteApp
7548
+ * @param {string} params.appId _Required parameter with properties_
7549
+ * @param {DeleteAppRequest} params.body _Optional parameter with properties_
7550
+ * - **name** (`string`, required) _The name of the app._
7551
+ * - **description** (`string`, optional) _A description for the app._
7552
+ * - **assignToken** (`boolean`, required) _Whether to assign the user token._
7553
+ *
7554
+ * @returns {Promise<DeleteApp200Response>} _Promise resolving to the deleteApp response with properties_
7555
+ * - **deletedAppId** (`string`, optional) _An ID of deleted application._
7556
+ *
7557
+ * @see {@link https://developer.quickbase.com/operation/deleteApp} Official Quickbase API documentation
7488
7558
  */
7489
7559
  deleteApp: (params: {
7490
7560
  appId: string;
@@ -7492,16 +7562,41 @@ interface QuickbaseClient$1 {
7492
7562
  }) => Promise<DeleteApp200Response>;
7493
7563
  /**
7494
7564
  * Get app events
7495
- * @param params - Parameters for getAppEvents
7496
- * @returns Promise resolving to getAppEvents response
7565
+ *
7566
+ * @param {Object} params _Object containing the parameters for_ getAppEvents
7567
+ * @param {string} params.appId _Required parameter with properties_
7568
+ *
7569
+ * @returns {Promise<GetAppEvents200Response>} _Promise resolving to the getAppEvents response_
7570
+ *
7571
+ * @see {@link https://developer.quickbase.com/operation/getAppEvents} Official Quickbase API documentation
7497
7572
  */
7498
7573
  getAppEvents: (params: {
7499
7574
  appId: string;
7500
7575
  }) => Promise<GetAppEvents200Response>;
7501
7576
  /**
7502
7577
  * Copy an app
7503
- * @param params - Parameters for copyApp
7504
- * @returns Promise resolving to copyApp response
7578
+ *
7579
+ * @param {Object} params _Object containing the parameters for_ copyApp
7580
+ * @param {string} params.appId _Required parameter with properties_
7581
+ * @param {CopyAppRequest} params.body _Optional parameter with properties_
7582
+ * - **name** (`string`, required) _The name of the new app._
7583
+ * - **description** (`string`, optional) _A description for the new app._
7584
+ * - **properties** (`CopyAppRequestProperties`, optional) _Type: CopyAppRequestProperties_
7585
+ *
7586
+ * @returns {Promise<CopyApp200Response>} _Promise resolving to the copyApp response with properties_
7587
+ * - **name** (`string`, required) _The app name. You are allowed to create multiple apps with the same name, in the same realm, because they will have different dbid values. We urge you to be careful about doing this._
7588
+ * - **description** (`string`, optional) _The description for the app_
7589
+ * - **created** (`string`, optional) _The time and date the app was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)._
7590
+ * - **updated** (`string`, optional) _The time and date the app was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)._
7591
+ * - **dateFormat** (`string`, optional) _A description of the format used when displaying date values in this app. Note that this is a browser-only parameter - see the [Field type details](../fieldInfo) page in the API Guide for how time values are returned in API calls. See [About Localizing Dates](https://help.quickbase.com/user-assistance/about_localizing_dates_numbers.html) to set the app’s date format._
7592
+ * - **timeZone** (`string`, optional) _A description of the time zone used when displaying time values in this app. Note that this is a browser-only parameter - see the [Field type details](../fieldInfo) page in the portal for how time values are returned in API calls. See [Set the Time Zone for Both the Application and the Account](https://help.quickbase.com/user-assistance/application_local_timezone.html) to set the application’s time zone._
7593
+ * - **id** (`string`, optional) _The unique identifier for this application._
7594
+ * - **hasEveryoneOnTheInternet** (`boolean`, optional) _Indicates whether app includes Everyone On The Internet access. See [Sharing apps with Everyone on the Internet (EOTI).](https://help.quickbase.com/user-assistance/share_with_everyone_on_internet.html)_
7595
+ * - **variables** (`{ [key: string]: any; }[]`, optional) _The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)_
7596
+ * - **ancestorId** (`string`, optional) _The id of the app from which this app was copied_
7597
+ * - **dataClassification** (`string`, optional) _The Data Classification label assigned to the application. If Data Classification is not turned on, this will not be returned. If Data Classification is turned on, but application is not labeled, we return “None". Data Classification labels can be added in the Admin Console by a Realm Administrator for Platform+ plans._
7598
+ *
7599
+ * @see {@link https://developer.quickbase.com/operation/copyApp} Official Quickbase API documentation
7505
7600
  */
7506
7601
  copyApp: (params: {
7507
7602
  appId: string;
@@ -7509,8 +7604,34 @@ interface QuickbaseClient$1 {
7509
7604
  }) => Promise<CopyApp200Response>;
7510
7605
  /**
7511
7606
  * Create a table
7512
- * @param params - Parameters for createTable
7513
- * @returns Promise resolving to createTable response
7607
+ *
7608
+ * @param {Object} params _Object containing the parameters for_ createTable
7609
+ * @param {string} params.appId _Required parameter with properties_
7610
+ * @param {CreateTableRequest} params.body _Optional parameter with properties_
7611
+ * - **name** (`string`, required) _The name for the table._
7612
+ * - **description** (`string`, optional) _The description for the table..._
7613
+ * - **singleRecordName** (`string`, optional) _The singular noun for records..._
7614
+ * - **pluralRecordName** (`string`, optional) _The plural noun for records..._
7615
+ *
7616
+ * @returns {Promise<CreateTable200Response>} _Promise resolving to the createTable response with properties_
7617
+ * - **name** (`string`, optional) _The name of the table._
7618
+ * - **id** (`string`, optional) _The unique identifier (dbid) of the table._
7619
+ * - **alias** (`string`, optional) _The automatically-created table alias for the table._
7620
+ * - **description** (`string`, optional) _The description of the table, as configured by an application administrator._
7621
+ * - **created** (`string`, optional) _The time and date when the table was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)._
7622
+ * - **updated** (`string`, optional) _The time and date when the table schema or data was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)._
7623
+ * - **nextRecordId** (`number`, optional) _The incremental Record ID that will be used when the next record is created, as determined when the API call was ran._
7624
+ * - **nextFieldId** (`number`, optional) _The incremental Field ID that will be used when the next field is created, as determined when the API call was ran._
7625
+ * - **defaultSortFieldId** (`number`, optional) _The id of the field that is configured for default sorting._
7626
+ * - **defaultSortOrder** (`CreateTable200ResponseDefaultSortOrderEnum`, optional) _The configuration of the default sort order on the table._
7627
+ * - **keyFieldId** (`number`, optional) _The id of the field that is configured to be the key on this table, which is usually the Quickbase Record ID._
7628
+ * - **singleRecordName** (`string`, optional) _The builder-configured singular noun of the table._
7629
+ * - **pluralRecordName** (`string`, optional) _The builder-configured plural noun of the table._
7630
+ * - **sizeLimit** (`string`, optional) _The size limit for the table._
7631
+ * - **spaceUsed** (`string`, optional) _The amount of space currently being used by the table._
7632
+ * - **spaceRemaining** (`string`, optional) _The amount of space remaining for use by the table._
7633
+ *
7634
+ * @see {@link https://developer.quickbase.com/operation/createTable} Official Quickbase API documentation
7514
7635
  */
7515
7636
  createTable: (params: {
7516
7637
  appId: string;
@@ -7518,16 +7639,43 @@ interface QuickbaseClient$1 {
7518
7639
  }) => Promise<CreateTable200Response>;
7519
7640
  /**
7520
7641
  * Get tables for an app
7521
- * @param params - Parameters for getAppTables
7522
- * @returns Promise resolving to getAppTables response
7642
+ *
7643
+ * @param {Object} params _Object containing the parameters for_ getAppTables
7644
+ * @param {string} params.appId _Required parameter with properties_
7645
+ *
7646
+ * @returns {Promise<GetAppTables200Response>} _Promise resolving to the getAppTables response_
7647
+ *
7648
+ * @see {@link https://developer.quickbase.com/operation/getAppTables} Official Quickbase API documentation
7523
7649
  */
7524
7650
  getAppTables: (params: {
7525
7651
  appId: string;
7526
7652
  }) => Promise<GetAppTables200Response>;
7527
7653
  /**
7528
7654
  * Get a table
7529
- * @param params - Parameters for getTable
7530
- * @returns Promise resolving to getTable response
7655
+ *
7656
+ * @param {Object} params _Object containing the parameters for_ getTable
7657
+ * @param {string} params.appId _Required parameter with properties_
7658
+ * @param {string} params.tableId _Required parameter with properties_
7659
+ *
7660
+ * @returns {Promise<GetTable200Response>} _Promise resolving to the getTable response with properties_
7661
+ * - **name** (`string`, optional) _The name of the table._
7662
+ * - **id** (`string`, optional) _The unique identifier (dbid) of the table._
7663
+ * - **alias** (`string`, optional) _The automatically-created table alias for the table._
7664
+ * - **description** (`string`, optional) _The description of the table, as configured by an application administrator._
7665
+ * - **created** (`string`, optional) _The time and date when the table was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)._
7666
+ * - **updated** (`string`, optional) _The time and date when the table schema or data was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)._
7667
+ * - **nextRecordId** (`number`, optional) _The incremental Record ID that will be used when the next record is created, as determined when the API call was ran._
7668
+ * - **nextFieldId** (`number`, optional) _The incremental Field ID that will be used when the next field is created, as determined when the API call was ran._
7669
+ * - **defaultSortFieldId** (`number`, optional) _The id of the field that is configured for default sorting._
7670
+ * - **defaultSortOrder** (`GetTable200ResponseDefaultSortOrderEnum`, optional) _The configuration of the default sort order on the table._
7671
+ * - **keyFieldId** (`number`, optional) _The id of the field that is configured to be the key on this table, which is usually the Quickbase Record ID._
7672
+ * - **singleRecordName** (`string`, optional) _The builder-configured singular noun of the table._
7673
+ * - **pluralRecordName** (`string`, optional) _The builder-configured plural noun of the table._
7674
+ * - **sizeLimit** (`string`, optional) _The size limit for the table._
7675
+ * - **spaceUsed** (`string`, optional) _The amount of space currently being used by the table._
7676
+ * - **spaceRemaining** (`string`, optional) _The amount of space remaining for use by the table._
7677
+ *
7678
+ * @see {@link https://developer.quickbase.com/operation/getTable} Official Quickbase API documentation
7531
7679
  */
7532
7680
  getTable: (params: {
7533
7681
  appId: string;
@@ -7535,8 +7683,33 @@ interface QuickbaseClient$1 {
7535
7683
  }) => Promise<GetTable200Response>;
7536
7684
  /**
7537
7685
  * Update a table
7538
- * @param params - Parameters for updateTable
7539
- * @returns Promise resolving to updateTable response
7686
+ *
7687
+ * @param {Object} params _Object containing the parameters for_ updateTable
7688
+ * @param {string} params.appId _Required parameter with properties_
7689
+ * @param {string} params.tableId _Required parameter with properties_
7690
+ * @param {UpdateTableRequest} params.body _Optional parameter with properties_
7691
+ * - **name** (`string`, optional) _The updated name of the table._
7692
+ * - **description** (`string`, optional) _The updated description for the table._
7693
+ *
7694
+ * @returns {Promise<UpdateTable200Response>} _Promise resolving to the updateTable response with properties_
7695
+ * - **name** (`string`, optional) _The name of the table._
7696
+ * - **id** (`string`, optional) _The unique identifier (dbid) of the table._
7697
+ * - **alias** (`string`, optional) _The automatically-created table alias for the table._
7698
+ * - **description** (`string`, optional) _The description of the table, as configured by an application administrator._
7699
+ * - **created** (`string`, optional) _The time and date when the table was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)._
7700
+ * - **updated** (`string`, optional) _The time and date when the table schema or data was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)._
7701
+ * - **nextRecordId** (`number`, optional) _The incremental Record ID that will be used when the next record is created, as determined when the API call was ran._
7702
+ * - **nextFieldId** (`number`, optional) _The incremental Field ID that will be used when the next field is created, as determined when the API call was ran._
7703
+ * - **defaultSortFieldId** (`number`, optional) _The id of the field that is configured for default sorting._
7704
+ * - **defaultSortOrder** (`UpdateTable200ResponseDefaultSortOrderEnum`, optional) _The configuration of the default sort order on the table._
7705
+ * - **keyFieldId** (`number`, optional) _The id of the field that is configured to be the key on this table, which is usually the Quickbase Record ID._
7706
+ * - **singleRecordName** (`string`, optional) _The builder-configured singular noun of the table._
7707
+ * - **pluralRecordName** (`string`, optional) _The builder-configured plural noun of the table._
7708
+ * - **sizeLimit** (`string`, optional) _The size limit for the table._
7709
+ * - **spaceUsed** (`string`, optional) _The amount of space currently being used by the table._
7710
+ * - **spaceRemaining** (`string`, optional) _The amount of space remaining for use by the table._
7711
+ *
7712
+ * @see {@link https://developer.quickbase.com/operation/updateTable} Official Quickbase API documentation
7540
7713
  */
7541
7714
  updateTable: (params: {
7542
7715
  appId: string;
@@ -7545,8 +7718,15 @@ interface QuickbaseClient$1 {
7545
7718
  }) => Promise<UpdateTable200Response>;
7546
7719
  /**
7547
7720
  * Delete a table
7548
- * @param params - Parameters for deleteTable
7549
- * @returns Promise resolving to deleteTable response
7721
+ *
7722
+ * @param {Object} params _Object containing the parameters for_ deleteTable
7723
+ * @param {string} params.appId _Required parameter with properties_
7724
+ * @param {string} params.tableId _Required parameter with properties_
7725
+ *
7726
+ * @returns {Promise<DeleteTable200Response>} _Promise resolving to the deleteTable response with properties_
7727
+ * - **deletedTableId** (`string`, optional) _The deleted table id._
7728
+ *
7729
+ * @see {@link https://developer.quickbase.com/operation/deleteTable} Official Quickbase API documentation
7550
7730
  */
7551
7731
  deleteTable: (params: {
7552
7732
  appId: string;
@@ -7554,8 +7734,16 @@ interface QuickbaseClient$1 {
7554
7734
  }) => Promise<DeleteTable200Response>;
7555
7735
  /**
7556
7736
  * Get all relationships
7557
- * @param params - Parameters for getRelationships
7558
- * @returns Promise resolving to getRelationships response
7737
+ *
7738
+ * @param {Object} params _Object containing the parameters for_ getRelationships
7739
+ * @param {number} params.skip _Optional parameter with properties_
7740
+ * @param {string} params.tableId _Required parameter with properties_
7741
+ *
7742
+ * @returns {Promise<GetRelationships200Response>} _Promise resolving to the getRelationships response with properties_
7743
+ * - **relationships** (`{ [key: string]: any; }[]`, required) _The relationships in a table._
7744
+ * - **metadata** (`{ [key: string]: any; }`, optional) _Additional information about the results that may be helpful._
7745
+ *
7746
+ * @see {@link https://developer.quickbase.com/operation/getRelationships} Official Quickbase API documentation
7559
7747
  */
7560
7748
  getRelationships: (params: {
7561
7749
  skip?: number;
@@ -7563,8 +7751,25 @@ interface QuickbaseClient$1 {
7563
7751
  }) => Promise<GetRelationships200Response>;
7564
7752
  /**
7565
7753
  * Create a relationship
7566
- * @param params - Parameters for createRelationship
7567
- * @returns Promise resolving to createRelationship response
7754
+ *
7755
+ * @param {Object} params _Object containing the parameters for_ createRelationship
7756
+ * @param {string} params.tableId _Required parameter with properties_
7757
+ * @param {CreateRelationshipRequest} params.body _Optional parameter with properties_
7758
+ * - **parentTableId** (`string`, required) _The parent table id for the relationship._
7759
+ * - **foreignKeyField** (`{ [key: string]: any; }`, optional) _Type: { [key: string]: any; }_
7760
+ * - **lookupFieldIds** (`number[]`, optional) _Array of field ids..._
7761
+ * - **summaryFields** (`{ [key: string]: any; }[]`, optional) _Array of summary field objects..._
7762
+ *
7763
+ * @returns {Promise<CreateRelationship200Response>} _Promise resolving to the createRelationship response with properties_
7764
+ * - **id** (`number`, required) _The relationship id (foreign key field id)._
7765
+ * - **parentTableId** (`string`, required) _The parent table id of the relationship._
7766
+ * - **childTableId** (`string`, required) _The child table id of the relationship._
7767
+ * - **foreignKeyField** (`{ [key: string]: any; }`, optional) _The foreign key field information._
7768
+ * - **isCrossApp** (`boolean`, required) _Whether this is a cross-app relationship._
7769
+ * - **lookupFields** (`{ [key: string]: any; }[]`, optional) _The lookup fields array._
7770
+ * - **summaryFields** (`{ [key: string]: any; }[]`, optional) _The summary fields array._
7771
+ *
7772
+ * @see {@link https://developer.quickbase.com/operation/createRelationship} Official Quickbase API documentation
7568
7773
  */
7569
7774
  createRelationship: (params: {
7570
7775
  tableId: string;
@@ -7572,8 +7777,26 @@ interface QuickbaseClient$1 {
7572
7777
  }) => Promise<CreateRelationship200Response>;
7573
7778
  /**
7574
7779
  * Update a relationship
7575
- * @param params - Parameters for updateRelationship
7576
- * @returns Promise resolving to updateRelationship response
7780
+ *
7781
+ * @param {Object} params _Object containing the parameters for_ updateRelationship
7782
+ * @param {string} params.tableId _Required parameter with properties_
7783
+ * @param {number} params.relationshipId _Required parameter with properties_
7784
+ * @param {UpdateRelationshipRequest} params.body _Optional parameter with properties_
7785
+ * - **parentTableId** (`string`, optional) _The updated parent table id..._
7786
+ * - **foreignKeyField** (`{ [key: string]: any; }`, optional) _Type: { [key: string]: any; }_
7787
+ * - **lookupFieldIds** (`number[]`, optional) _Updated array of field ids..._
7788
+ * - **summaryFields** (`{ [key: string]: any; }[]`, optional) _Type: { [key: string]: any; }[]_
7789
+ *
7790
+ * @returns {Promise<UpdateRelationship200Response>} _Promise resolving to the updateRelationship response with properties_
7791
+ * - **id** (`number`, required) _The relationship id (foreign key field id)._
7792
+ * - **parentTableId** (`string`, required) _The parent table id of the relationship._
7793
+ * - **childTableId** (`string`, required) _The child table id of the relationship._
7794
+ * - **foreignKeyField** (`{ [key: string]: any; }`, optional) _The foreign key field information._
7795
+ * - **isCrossApp** (`boolean`, required) _Whether this is a cross-app relationship._
7796
+ * - **lookupFields** (`{ [key: string]: any; }[]`, optional) _The lookup fields array._
7797
+ * - **summaryFields** (`{ [key: string]: any; }[]`, optional) _The summary fields array._
7798
+ *
7799
+ * @see {@link https://developer.quickbase.com/operation/updateRelationship} Official Quickbase API documentation
7577
7800
  */
7578
7801
  updateRelationship: (params: {
7579
7802
  tableId: string;
@@ -7582,8 +7805,15 @@ interface QuickbaseClient$1 {
7582
7805
  }) => Promise<UpdateRelationship200Response>;
7583
7806
  /**
7584
7807
  * Delete a relationship
7585
- * @param params - Parameters for deleteRelationship
7586
- * @returns Promise resolving to deleteRelationship response
7808
+ *
7809
+ * @param {Object} params _Object containing the parameters for_ deleteRelationship
7810
+ * @param {string} params.tableId _Required parameter with properties_
7811
+ * @param {number} params.relationshipId _Required parameter with properties_
7812
+ *
7813
+ * @returns {Promise<DeleteRelationship200Response>} _Promise resolving to the deleteRelationship response with properties_
7814
+ * - **relationshipId** (`number`, required) _The relationship id._
7815
+ *
7816
+ * @see {@link https://developer.quickbase.com/operation/deleteRelationship} Official Quickbase API documentation
7587
7817
  */
7588
7818
  deleteRelationship: (params: {
7589
7819
  tableId: string;
@@ -7591,16 +7821,36 @@ interface QuickbaseClient$1 {
7591
7821
  }) => Promise<DeleteRelationship200Response>;
7592
7822
  /**
7593
7823
  * Get reports for a table
7594
- * @param params - Parameters for getTableReports
7595
- * @returns Promise resolving to getTableReports response
7824
+ *
7825
+ * @param {Object} params _Object containing the parameters for_ getTableReports
7826
+ * @param {string} params.tableId _Required parameter with properties_
7827
+ *
7828
+ * @returns {Promise<GetTableReports200Response>} _Promise resolving to the getTableReports response_
7829
+ *
7830
+ * @see {@link https://developer.quickbase.com/operation/getTableReports} Official Quickbase API documentation
7596
7831
  */
7597
7832
  getTableReports: (params: {
7598
7833
  tableId: string;
7599
7834
  }) => Promise<GetTableReports200Response>;
7600
7835
  /**
7601
7836
  * Get a report
7602
- * @param params - Parameters for getReport
7603
- * @returns Promise resolving to getReport response
7837
+ *
7838
+ * @param {Object} params _Object containing the parameters for_ getReport
7839
+ * @param {string} params.tableId _Required parameter with properties_
7840
+ * @param {string} params.reportId _Required parameter with properties_
7841
+ *
7842
+ * @returns {Promise<GetReport200Response>} _Promise resolving to the getReport response with properties_
7843
+ * - **id** (`string`, optional) _The identifier of the report, unique to the table._
7844
+ * - **name** (`string`, optional) _The configured name of the report._
7845
+ * - **type** (`string`, optional) _The type of report in Quickbase (e.g., chart)._
7846
+ * - **description** (`string`, optional) _The configured description of a report._
7847
+ * - **ownerId** (`number`, optional) _Optional, showed only for personal reports. The user ID of report owner._
7848
+ * - **query** (`{ [key: string]: any; }`, optional) _The query definition as configured in Quickbase that gets executed when the report is run._
7849
+ * - **properties** (`{ [key: string]: any; }`, optional) _A list of properties specific to the report type. To see a detailed description of the properties for each report type, See [Report Types.](../reportTypes)_
7850
+ * - **usedLast** (`string`, optional) _The instant at which a report was last used._
7851
+ * - **usedCount** (`number`, optional) _The number of times a report has been used._
7852
+ *
7853
+ * @see {@link https://developer.quickbase.com/operation/getReport} Official Quickbase API documentation
7604
7854
  */
7605
7855
  getReport: (params: {
7606
7856
  tableId: string;
@@ -7608,8 +7858,20 @@ interface QuickbaseClient$1 {
7608
7858
  }) => Promise<GetReport200Response>;
7609
7859
  /**
7610
7860
  * Run a report
7611
- * @param params - Parameters for runReport
7612
- * @returns Promise resolving to runReport response
7861
+ *
7862
+ * @param {Object} params _Object containing the parameters for_ runReport
7863
+ * @param {string} params.tableId _Required parameter with properties_
7864
+ * @param {number} params.skip _Optional parameter with properties_
7865
+ * @param {number} params.top _Optional parameter with properties_
7866
+ * @param {string} params.reportId _Required parameter with properties_
7867
+ * @param {any} params.body _Optional parameter with properties_
7868
+ *
7869
+ * @returns {Promise<RunReport200Response>} _Promise resolving to the runReport response with properties_
7870
+ * - **fields** (`{ [key: string]: any; }[]`, optional) _An array of objects that contains limited meta-data of each field displayed in the report. This assists in building logic that depends on field types and IDs._
7871
+ * - **data** (`string[]`, optional) _An array of objects that either represents the record data or summarized values, depending on the report type._
7872
+ * - **metadata** (`{ [key: string]: any; }`, optional) _Additional information about the results that may be helpful. Pagination may be needed if either you specify a smaller number of results to skip than is available, or if the API automatically returns fewer results. numRecords can be compared to totalRecords to determine if further pagination is needed._
7873
+ *
7874
+ * @see {@link https://developer.quickbase.com/operation/runReport} Official Quickbase API documentation
7613
7875
  */
7614
7876
  runReport: (params: {
7615
7877
  tableId: string;
@@ -7620,8 +7882,14 @@ interface QuickbaseClient$1 {
7620
7882
  }) => Promise<RunReport200Response>;
7621
7883
  /**
7622
7884
  * Get fields for a table
7623
- * @param params - Parameters for getFields
7624
- * @returns Promise resolving to getFields response
7885
+ *
7886
+ * @param {Object} params _Object containing the parameters for_ getFields
7887
+ * @param {string} params.tableId _Required parameter with properties_
7888
+ * @param {boolean} params.includeFieldPerms _Optional parameter with properties_
7889
+ *
7890
+ * @returns {Promise<GetFields200Response>} _Promise resolving to the getFields response_
7891
+ *
7892
+ * @see {@link https://developer.quickbase.com/operation/getFields} Official Quickbase API documentation
7625
7893
  */
7626
7894
  getFields: (params: {
7627
7895
  tableId: string;
@@ -7629,8 +7897,43 @@ interface QuickbaseClient$1 {
7629
7897
  }) => Promise<GetFields200Response>;
7630
7898
  /**
7631
7899
  * Create a field
7632
- * @param params - Parameters for createField
7633
- * @returns Promise resolving to createField response
7900
+ *
7901
+ * @param {Object} params _Object containing the parameters for_ createField
7902
+ * @param {string} params.tableId _Required parameter with properties_
7903
+ * @param {CreateFieldRequest} params.body _Optional parameter with properties_
7904
+ * - **label** (`string`, required) _The label of the field_
7905
+ * - **fieldType** (`CreateFieldRequestFieldTypeEnum`, required) _The type of the field_
7906
+ * - **fieldHelp** (`string`, optional) _Help text for the field_
7907
+ * - **addToForms** (`boolean`, optional) _Whether to add the field to forms_
7908
+ * - **permissions** (`object`, optional) _Custom permissions for the field_
7909
+ * - **required** (`boolean`, optional) _Whether the field is required_
7910
+ * - **unique** (`boolean`, optional) _Whether the field must have unique values_
7911
+ * - **noWrap** (`boolean`, optional) _Whether text wrapping is disabled_
7912
+ * - **bold** (`boolean`, optional) _Whether the field is bolded_
7913
+ * - **appearsByDefault** (`boolean`, optional) _Whether the field appears by default in reports_
7914
+ * - **findEnabled** (`boolean`, optional) _Whether the field is searchable_
7915
+ * - **doesDataCopy** (`boolean`, optional) _Whether the field copies data_
7916
+ * - **audited** (`boolean`, optional) _Whether changes to the field are audited_
7917
+ * - **properties** (`CreateFieldRequestProperties`, optional) _Type: CreateFieldRequestProperties_
7918
+ *
7919
+ * @returns {Promise<CreateField200Response>} _Promise resolving to the createField response with properties_
7920
+ * - **id** (`number`, required) _The id of the field, unique to this table._
7921
+ * - **fieldType** (`string`, optional) _The type of field, as described [here](https://help.quickbase.com/user-assistance/field_types.html)._
7922
+ * - **mode** (`string`, optional) _For derived fields, this will be 'lookup', 'summary', or 'formula', to indicate the type of derived field. For non-derived fields, this will be blank._
7923
+ * - **label** (`string`, optional) _The label (name) of the field._
7924
+ * - **noWrap** (`boolean`, optional) _Indicates if the field is configured to not wrap when displayed in the product._
7925
+ * - **bold** (`boolean`, optional) _Indicates if the field is configured to display in bold in the product._
7926
+ * - **required** (`boolean`, optional) _Indicates if the field is marked required._
7927
+ * - **appearsByDefault** (`boolean`, optional) _Indicates if the field is marked as a default in reports._
7928
+ * - **findEnabled** (`boolean`, optional) _Indicates if the field is marked as searchable._
7929
+ * - **unique** (`boolean`, optional) _Indicates if the field is marked unique._
7930
+ * - **doesDataCopy** (`boolean`, optional) _Indicates if the field data will copy when a user copies the record._
7931
+ * - **fieldHelp** (`string`, optional) _The configured help text shown to users within the product._
7932
+ * - **audited** (`boolean`, optional) _Indicates if the field is being tracked as part of Quickbase Audit Logs._
7933
+ * - **properties** (`{ [key: string]: any; }`, optional) _Additional properties for the field. Please see [Field type details](../fieldInfo) page for more details on the properties for each field type._
7934
+ * - **permissions** (`object[]`, optional) _Field Permissions for different roles._
7935
+ *
7936
+ * @see {@link https://developer.quickbase.com/operation/createField} Official Quickbase API documentation
7634
7937
  */
7635
7938
  createField: (params: {
7636
7939
  tableId: string;
@@ -7638,8 +7941,17 @@ interface QuickbaseClient$1 {
7638
7941
  }) => Promise<CreateField200Response>;
7639
7942
  /**
7640
7943
  * Delete field(s)
7641
- * @param params - Parameters for deleteFields
7642
- * @returns Promise resolving to deleteFields response
7944
+ *
7945
+ * @param {Object} params _Object containing the parameters for_ deleteFields
7946
+ * @param {string} params.tableId _Required parameter with properties_
7947
+ * @param {DeleteFieldsRequest} params.body _Optional parameter with properties_
7948
+ * - **fieldIds** (`number[]`, required) _Type: number[]_
7949
+ *
7950
+ * @returns {Promise<DeleteFields200Response>} _Promise resolving to the deleteFields response with properties_
7951
+ * - **deletedFieldIds** (`number[]`, required) _List of field ids to were deleted._
7952
+ * - **errors** (`string[]`, required) _List of errors found._
7953
+ *
7954
+ * @see {@link https://developer.quickbase.com/operation/deleteFields} Official Quickbase API documentation
7643
7955
  */
7644
7956
  deleteFields: (params: {
7645
7957
  tableId: string;
@@ -7647,8 +7959,30 @@ interface QuickbaseClient$1 {
7647
7959
  }) => Promise<DeleteFields200Response>;
7648
7960
  /**
7649
7961
  * Get field
7650
- * @param params - Parameters for getField
7651
- * @returns Promise resolving to getField response
7962
+ *
7963
+ * @param {Object} params _Object containing the parameters for_ getField
7964
+ * @param {string} params.tableId _Required parameter with properties_
7965
+ * @param {boolean} params.includeFieldPerms _Optional parameter with properties_
7966
+ * @param {number} params.fieldId _Required parameter with properties_
7967
+ *
7968
+ * @returns {Promise<GetField200Response>} _Promise resolving to the getField response with properties_
7969
+ * - **id** (`number`, required) _The id of the field, unique to this table._
7970
+ * - **fieldType** (`string`, optional) _The type of field, as described [here](https://help.quickbase.com/user-assistance/field_types.html)._
7971
+ * - **mode** (`string`, optional) _For derived fields, this will be 'lookup', 'summary', or 'formula', to indicate the type of derived field. For non-derived fields, this will be blank._
7972
+ * - **label** (`string`, optional) _The label (name) of the field._
7973
+ * - **noWrap** (`boolean`, optional) _Indicates if the field is configured to not wrap when displayed in the product._
7974
+ * - **bold** (`boolean`, optional) _Indicates if the field is configured to display in bold in the product._
7975
+ * - **required** (`boolean`, optional) _Indicates if the field is marked required._
7976
+ * - **appearsByDefault** (`boolean`, optional) _Indicates if the field is marked as a default in reports._
7977
+ * - **findEnabled** (`boolean`, optional) _Indicates if the field is marked as searchable._
7978
+ * - **unique** (`boolean`, optional) _Indicates if the field is marked unique._
7979
+ * - **doesDataCopy** (`boolean`, optional) _Indicates if the field data will copy when a user copies the record._
7980
+ * - **fieldHelp** (`string`, optional) _The configured help text shown to users within the product._
7981
+ * - **audited** (`boolean`, optional) _Indicates if the field is being tracked as part of Quickbase Audit Logs._
7982
+ * - **properties** (`{ [key: string]: any; }`, optional) _Additional properties for the field. Please see [Field type details](../fieldInfo) page for more details on the properties for each field type._
7983
+ * - **permissions** (`object[]`, optional) _Field Permissions for different roles._
7984
+ *
7985
+ * @see {@link https://developer.quickbase.com/operation/getField} Official Quickbase API documentation
7652
7986
  */
7653
7987
  getField: (params: {
7654
7988
  tableId: string;
@@ -7657,8 +7991,44 @@ interface QuickbaseClient$1 {
7657
7991
  }) => Promise<GetField200Response>;
7658
7992
  /**
7659
7993
  * Update a field
7660
- * @param params - Parameters for updateField
7661
- * @returns Promise resolving to updateField response
7994
+ *
7995
+ * @param {Object} params _Object containing the parameters for_ updateField
7996
+ * @param {string} params.tableId _Required parameter with properties_
7997
+ * @param {number} params.fieldId _Required parameter with properties_
7998
+ * @param {UpdateFieldRequest} params.body _Optional parameter with properties_
7999
+ * - **label** (`string`, required) _The label of the field_
8000
+ * - **fieldType** (`UpdateFieldRequestFieldTypeEnum`, optional) _The type of the field_
8001
+ * - **fieldHelp** (`string`, optional) _Help text for the field_
8002
+ * - **addToForms** (`boolean`, optional) _Whether to add the field to forms_
8003
+ * - **permissions** (`object`, optional) _Custom permissions for the field_
8004
+ * - **required** (`boolean`, optional) _Whether the field is required_
8005
+ * - **unique** (`boolean`, optional) _Whether the field must have unique values_
8006
+ * - **noWrap** (`boolean`, optional) _Whether text wrapping is disabled_
8007
+ * - **bold** (`boolean`, optional) _Whether the field is bolded_
8008
+ * - **appearsByDefault** (`boolean`, optional) _Whether the field appears by default in reports_
8009
+ * - **findEnabled** (`boolean`, optional) _Whether the field is searchable_
8010
+ * - **doesDataCopy** (`boolean`, optional) _Whether the field copies data_
8011
+ * - **audited** (`boolean`, optional) _Whether changes to the field are audited_
8012
+ * - **properties** (`CreateFieldRequestProperties`, optional) _Type: CreateFieldRequestProperties_
8013
+ *
8014
+ * @returns {Promise<UpdateField200Response>} _Promise resolving to the updateField response with properties_
8015
+ * - **id** (`number`, required) _The id of the field, unique to this table._
8016
+ * - **fieldType** (`string`, optional) _The type of field, as described [here](https://help.quickbase.com/user-assistance/field_types.html)._
8017
+ * - **mode** (`string`, optional) _For derived fields, this will be 'lookup', 'summary', or 'formula', to indicate the type of derived field. For non-derived fields, this will be blank._
8018
+ * - **label** (`string`, optional) _The label (name) of the field._
8019
+ * - **noWrap** (`boolean`, optional) _Indicates if the field is configured to not wrap when displayed in the product._
8020
+ * - **bold** (`boolean`, optional) _Indicates if the field is configured to display in bold in the product._
8021
+ * - **required** (`boolean`, optional) _Indicates if the field is marked required._
8022
+ * - **appearsByDefault** (`boolean`, optional) _Indicates if the field is marked as a default in reports._
8023
+ * - **findEnabled** (`boolean`, optional) _Indicates if the field is marked as searchable._
8024
+ * - **unique** (`boolean`, optional) _Indicates if the field is marked unique._
8025
+ * - **doesDataCopy** (`boolean`, optional) _Indicates if the field data will copy when a user copies the record._
8026
+ * - **fieldHelp** (`string`, optional) _The configured help text shown to users within the product._
8027
+ * - **audited** (`boolean`, optional) _Indicates if the field is being tracked as part of Quickbase Audit Logs._
8028
+ * - **properties** (`{ [key: string]: any; }`, optional) _Additional properties for the field. Please see [Field type details](../fieldInfo) page for more details on the properties for each field type._
8029
+ * - **permissions** (`object[]`, optional) _Field Permissions for different roles._
8030
+ *
8031
+ * @see {@link https://developer.quickbase.com/operation/updateField} Official Quickbase API documentation
7662
8032
  */
7663
8033
  updateField: (params: {
7664
8034
  tableId: string;
@@ -7667,8 +8037,15 @@ interface QuickbaseClient$1 {
7667
8037
  }) => Promise<UpdateField200Response>;
7668
8038
  /**
7669
8039
  * Get usage for all fields
7670
- * @param params - Parameters for getFieldsUsage
7671
- * @returns Promise resolving to getFieldsUsage response
8040
+ *
8041
+ * @param {Object} params _Object containing the parameters for_ getFieldsUsage
8042
+ * @param {string} params.tableId _Required parameter with properties_
8043
+ * @param {number} params.skip _Optional parameter with properties_
8044
+ * @param {number} params.top _Optional parameter with properties_
8045
+ *
8046
+ * @returns {Promise<GetFieldsUsage200Response>} _Promise resolving to the getFieldsUsage response_
8047
+ *
8048
+ * @see {@link https://developer.quickbase.com/operation/getFieldsUsage} Official Quickbase API documentation
7672
8049
  */
7673
8050
  getFieldsUsage: (params: {
7674
8051
  tableId: string;
@@ -7677,8 +8054,14 @@ interface QuickbaseClient$1 {
7677
8054
  }) => Promise<GetFieldsUsage200Response>;
7678
8055
  /**
7679
8056
  * Get usage for a field
7680
- * @param params - Parameters for getFieldUsage
7681
- * @returns Promise resolving to getFieldUsage response
8057
+ *
8058
+ * @param {Object} params _Object containing the parameters for_ getFieldUsage
8059
+ * @param {string} params.tableId _Required parameter with properties_
8060
+ * @param {number} params.fieldId _Required parameter with properties_
8061
+ *
8062
+ * @returns {Promise<GetFieldUsage200Response>} _Promise resolving to the getFieldUsage response_
8063
+ *
8064
+ * @see {@link https://developer.quickbase.com/operation/getFieldUsage} Official Quickbase API documentation
7682
8065
  */
7683
8066
  getFieldUsage: (params: {
7684
8067
  tableId: string;
@@ -7686,8 +8069,14 @@ interface QuickbaseClient$1 {
7686
8069
  }) => Promise<GetFieldUsage200Response>;
7687
8070
  /**
7688
8071
  * Run a formula
7689
- * @param params - Parameters for runFormula
7690
- * @returns Promise resolving to runFormula response
8072
+ *
8073
+ * @param {Object} params _Object containing the parameters for_ runFormula
8074
+ * @param {{ formula?: string; rid?: number; from?: string }} params.body _Optional parameter with properties_
8075
+ *
8076
+ * @returns {Promise<RunFormula200Response>} _Promise resolving to the runFormula response with properties_
8077
+ * - **result** (`string`, optional) _The formula execution result._
8078
+ *
8079
+ * @see {@link https://developer.quickbase.com/operation/runFormula} Official Quickbase API documentation
7691
8080
  */
7692
8081
  runFormula: (params: {
7693
8082
  body?: {
@@ -7698,32 +8087,69 @@ interface QuickbaseClient$1 {
7698
8087
  }) => Promise<RunFormula200Response>;
7699
8088
  /**
7700
8089
  * Insert/Update record(s)
7701
- * @param params - Parameters for upsert
7702
- * @returns Promise resolving to upsert response
8090
+ *
8091
+ * @param {Object} params _Object containing the parameters for_ upsert
8092
+ * @param {UpsertRequest} params.body _Optional parameter with properties_
8093
+ * - **data** (`Record[]`, optional) _Type: Record[]_
8094
+ * - **to** (`string`, optional) _Type: string_
8095
+ * - **fieldsToReturn** (`number[]`, optional) _Type: number[]_
8096
+ *
8097
+ * @returns {Promise<Upsert200Response | Upsert207Response>} _Promise resolving to the upsert response_
8098
+ *
8099
+ * @see {@link https://developer.quickbase.com/operation/upsert} Official Quickbase API documentation
7703
8100
  */
7704
8101
  upsert: (params: {
7705
8102
  body?: UpsertRequest;
7706
8103
  }) => Promise<Upsert200Response | Upsert207Response>;
7707
8104
  /**
7708
8105
  * Delete record(s)
7709
- * @param params - Parameters for deleteRecords
7710
- * @returns Promise resolving to deleteRecords response
8106
+ *
8107
+ * @param {Object} params _Object containing the parameters for_ deleteRecords
8108
+ * @param {DeleteRecordsRequest} params.body _Optional parameter with properties_
8109
+ * - **from** (`string`, required) _Type: string_
8110
+ * - **where** (`string`, optional) _Type: string_
8111
+ *
8112
+ * @returns {Promise<DeleteRecords200Response>} _Promise resolving to the deleteRecords response with properties_
8113
+ * - **numberDeleted** (`number`, optional) _The number of records deleted._
8114
+ *
8115
+ * @see {@link https://developer.quickbase.com/operation/deleteRecords} Official Quickbase API documentation
7711
8116
  */
7712
8117
  deleteRecords: (params: {
7713
8118
  body?: DeleteRecordsRequest;
7714
8119
  }) => Promise<DeleteRecords200Response>;
7715
8120
  /**
7716
8121
  * Query for data
7717
- * @param params - Parameters for runQuery
7718
- * @returns Promise resolving to runQuery response
8122
+ *
8123
+ * @param {Object} params _Object containing the parameters for_ runQuery
8124
+ * @param {RunQueryRequest} params.body _Optional parameter with properties_
8125
+ * - **from** (`string`, required) _The table identifier._
8126
+ * - **select** (`number[]`, optional) _An array of field ids..._
8127
+ * - **where** (`string`, optional) _The filter, using the Quickbase query language..._
8128
+ * - **sortBy** (`RunQueryRequestSortByInner[]`, optional) _An array of field IDs and sort directions..._
8129
+ * - **groupBy** (`RunQueryRequestGroupByInner[]`, optional) _An array that contains the fields to group the records by._
8130
+ * - **options** (`RunQueryRequestOptions`, optional) _Type: RunQueryRequestOptions_
8131
+ *
8132
+ * @returns {Promise<RunQuery200Response>} _Promise resolving to the runQuery response with properties_
8133
+ * - **fields** (`{ [key: string]: any; }[]`, optional) _An array of objects that contains limited meta-data of each field displayed in the report. This assists in building logic that depends on field types and IDs._
8134
+ * - **data** (`string[]`, optional) _An array of objects that either represents the record data or summarized values, depending on the report type._
8135
+ * - **metadata** (`{ [key: string]: any; }`, optional) _Additional information about the results that may be helpful. Pagination may be needed if either you specify a smaller number of results to skip than is available, or if the API automatically returns fewer results. numRecords can be compared to totalRecords to determine if further pagination is needed._
8136
+ *
8137
+ * @see {@link https://developer.quickbase.com/operation/runQuery} Official Quickbase API documentation
7719
8138
  */
7720
8139
  runQuery: (params: {
7721
8140
  body?: RunQueryRequest;
7722
8141
  }) => Promise<RunQuery200Response>;
7723
8142
  /**
7724
8143
  * Get a temporary token for a dbid
7725
- * @param params - Parameters for getTempTokenDBID
7726
- * @returns Promise resolving to getTempTokenDBID response
8144
+ *
8145
+ * @param {Object} params _Object containing the parameters for_ getTempTokenDBID
8146
+ * @param {string} params.dbid _Required parameter with properties_
8147
+ * @param {string} params.qBAppToken _Optional parameter with properties_
8148
+ *
8149
+ * @returns {Promise<GetTempTokenDBID200Response>} _Promise resolving to the getTempTokenDBID response with properties_
8150
+ * - **temporaryAuthorization** (`string`, optional) _Temporary authorization token._
8151
+ *
8152
+ * @see {@link https://developer.quickbase.com/operation/getTempTokenDBID} Official Quickbase API documentation
7727
8153
  */
7728
8154
  getTempTokenDBID: (params: {
7729
8155
  dbid: string;
@@ -7731,8 +8157,16 @@ interface QuickbaseClient$1 {
7731
8157
  }) => Promise<GetTempTokenDBID200Response>;
7732
8158
  /**
7733
8159
  * Exchange an SSO token
7734
- * @param params - Parameters for exchangeSsoToken
7735
- * @returns Promise resolving to exchangeSsoToken response
8160
+ *
8161
+ * @param {Object} params _Object containing the parameters for_ exchangeSsoToken
8162
+ * @param {{ grant_type?: string; requested_token_type?: string; subject_token?: string; subject_token_type?: string }} params.body _Optional parameter with properties_
8163
+ *
8164
+ * @returns {Promise<ExchangeSsoToken200Response>} _Promise resolving to the exchangeSsoToken response with properties_
8165
+ * - **accessToken** (`string`, optional) _The security token issued by the authorization server in response to the token exchange request. The identifier `access_token` is used for historical reasons and the issued token need not be an OAuth access token._
8166
+ * - **issuedTokenType** (`ExchangeSsoToken200ResponseIssuedTokenTypeEnum`, optional) _An identifier for the representation of the issued security token._
8167
+ * - **tokenType** (`"N_A"`, optional) _Will always return `N_A`_
8168
+ *
8169
+ * @see {@link https://developer.quickbase.com/operation/exchangeSsoToken} Official Quickbase API documentation
7736
8170
  */
7737
8171
  exchangeSsoToken: (params: {
7738
8172
  body?: {
@@ -7744,8 +8178,20 @@ interface QuickbaseClient$1 {
7744
8178
  }) => Promise<ExchangeSsoToken200Response>;
7745
8179
  /**
7746
8180
  * Clone a user token
7747
- * @param params - Parameters for cloneUserToken
7748
- * @returns Promise resolving to cloneUserToken response
8181
+ *
8182
+ * @param {Object} params _Object containing the parameters for_ cloneUserToken
8183
+ * @param {{ name?: string; description?: string }} params.body _Optional parameter with properties_
8184
+ *
8185
+ * @returns {Promise<CloneUserToken200Response>} _Promise resolving to the cloneUserToken response with properties_
8186
+ * - **active** (`boolean`, optional) _Whether the user token is active._
8187
+ * - **apps** (`{ [key: string]: any; }[]`, optional) _The list of apps this user token is assigned to._
8188
+ * - **lastUsed** (`string`, optional) _The last date this user token was used, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)._
8189
+ * - **description** (`string`, optional) _User Token description._
8190
+ * - **id** (`number`, optional) _User Token id._
8191
+ * - **name** (`string`, optional) _User Token name._
8192
+ * - **token** (`string`, optional) _User Token value._
8193
+ *
8194
+ * @see {@link https://developer.quickbase.com/operation/cloneUserToken} Official Quickbase API documentation
7749
8195
  */
7750
8196
  cloneUserToken: (params: {
7751
8197
  body?: {
@@ -7755,8 +8201,19 @@ interface QuickbaseClient$1 {
7755
8201
  }) => Promise<CloneUserToken200Response>;
7756
8202
  /**
7757
8203
  * Transfer a user token
7758
- * @param params - Parameters for transferUserToken
7759
- * @returns Promise resolving to transferUserToken response
8204
+ *
8205
+ * @param {Object} params _Object containing the parameters for_ transferUserToken
8206
+ * @param {{ id?: number; from?: string; to?: string }} params.body _Optional parameter with properties_
8207
+ *
8208
+ * @returns {Promise<TransferUserToken200Response>} _Promise resolving to the transferUserToken response with properties_
8209
+ * - **active** (`boolean`, optional) _Whether the user token is active._
8210
+ * - **apps** (`{ [key: string]: any; }[]`, optional) _The list of apps this user token is assigned to._
8211
+ * - **lastUsed** (`string`, optional) _The last date this user token was used, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)._
8212
+ * - **description** (`string`, optional) _User Token description._
8213
+ * - **id** (`number`, optional) _User Token id._
8214
+ * - **name** (`string`, optional) _User Token name._
8215
+ *
8216
+ * @see {@link https://developer.quickbase.com/operation/transferUserToken} Official Quickbase API documentation
7760
8217
  */
7761
8218
  transferUserToken: (params: {
7762
8219
  body?: {
@@ -7767,20 +8224,41 @@ interface QuickbaseClient$1 {
7767
8224
  }) => Promise<TransferUserToken200Response>;
7768
8225
  /**
7769
8226
  * Deactivate a user token
7770
- * @param params - Parameters for deactivateUserToken
7771
- * @returns Promise resolving to deactivateUserToken response
8227
+ *
8228
+ * @param {Object} params _Object containing the parameters for_ deactivateUserToken
8229
+ * No parameters
8230
+ *
8231
+ * @returns {Promise<DeactivateUserToken200Response>} _Promise resolving to the deactivateUserToken response with properties_
8232
+ * - **id** (`number`, optional) _The user token id._
8233
+ *
8234
+ * @see {@link https://developer.quickbase.com/operation/deactivateUserToken} Official Quickbase API documentation
7772
8235
  */
7773
8236
  deactivateUserToken: (params: {}) => Promise<DeactivateUserToken200Response>;
7774
8237
  /**
7775
8238
  * Delete a user token
7776
- * @param params - Parameters for deleteUserToken
7777
- * @returns Promise resolving to deleteUserToken response
8239
+ *
8240
+ * @param {Object} params _Object containing the parameters for_ deleteUserToken
8241
+ * No parameters
8242
+ *
8243
+ * @returns {Promise<DeleteUserToken200Response>} _Promise resolving to the deleteUserToken response with properties_
8244
+ * - **id** (`number`, optional) _The user token id._
8245
+ *
8246
+ * @see {@link https://developer.quickbase.com/operation/deleteUserToken} Official Quickbase API documentation
7778
8247
  */
7779
8248
  deleteUserToken: (params: {}) => Promise<DeleteUserToken200Response>;
7780
8249
  /**
7781
8250
  * Download file
7782
- * @param params - Parameters for downloadFile
7783
- * @returns Promise resolving to downloadFile response
8251
+ *
8252
+ * @param {Object} params _Object containing the parameters for_ downloadFile
8253
+ * @param {string} params.tableId _Required parameter with properties_
8254
+ * @param {number} params.recordId _Required parameter with properties_
8255
+ * @param {number} params.fieldId _Required parameter with properties_
8256
+ * @param {number} params.versionNumber _Required parameter with properties_
8257
+ *
8258
+ * @returns {Promise<DownloadFile200Response>} _Promise resolving to the downloadFile response with properties_
8259
+ * - **data** (`Blob`, optional) _Type: Blob_
8260
+ *
8261
+ * @see {@link https://developer.quickbase.com/operation/downloadFile} Official Quickbase API documentation
7784
8262
  */
7785
8263
  downloadFile: (params: {
7786
8264
  tableId: string;
@@ -7790,8 +8268,20 @@ interface QuickbaseClient$1 {
7790
8268
  }) => Promise<DownloadFile200Response>;
7791
8269
  /**
7792
8270
  * Delete file
7793
- * @param params - Parameters for deleteFile
7794
- * @returns Promise resolving to deleteFile response
8271
+ *
8272
+ * @param {Object} params _Object containing the parameters for_ deleteFile
8273
+ * @param {string} params.tableId _Required parameter with properties_
8274
+ * @param {number} params.recordId _Required parameter with properties_
8275
+ * @param {number} params.fieldId _Required parameter with properties_
8276
+ * @param {number} params.versionNumber _Required parameter with properties_
8277
+ *
8278
+ * @returns {Promise<DeleteFile200Response>} _Promise resolving to the deleteFile response with properties_
8279
+ * - **versionNumber** (`number`, optional) _The number of deleted version._
8280
+ * - **fileName** (`string`, optional) _The name of file associated with deleted version._
8281
+ * - **uploaded** (`string`, optional) _The timestamp when the version was originally uploaded._
8282
+ * - **creator** (`{ [key: string]: any; }`, optional) _The user that uploaded version._
8283
+ *
8284
+ * @see {@link https://developer.quickbase.com/operation/deleteFile} Official Quickbase API documentation
7795
8285
  */
7796
8286
  deleteFile: (params: {
7797
8287
  tableId: string;
@@ -7801,8 +8291,17 @@ interface QuickbaseClient$1 {
7801
8291
  }) => Promise<DeleteFile200Response>;
7802
8292
  /**
7803
8293
  * Get users
7804
- * @param params - Parameters for getUsers
7805
- * @returns Promise resolving to getUsers response
8294
+ *
8295
+ * @param {Object} params _Object containing the parameters for_ getUsers
8296
+ * @param {number} params.accountId _Optional parameter with properties_
8297
+ * @param {GetUsersRequest} params.body _Optional parameter with properties_
8298
+ * - **userIds** (`string[]`, required) _Type: string[]_
8299
+ *
8300
+ * @returns {Promise<GetUsers200Response>} _Promise resolving to the getUsers response with properties_
8301
+ * - **users** (`{ [key: string]: any; }[]`, required) _A list of users found in an account with the given criterias_
8302
+ * - **metadata** (`{ [key: string]: any; }`, required) _Additional request information_
8303
+ *
8304
+ * @see {@link https://developer.quickbase.com/operation/getUsers} Official Quickbase API documentation
7806
8305
  */
7807
8306
  getUsers: (params: {
7808
8307
  accountId?: number;
@@ -7810,8 +8309,17 @@ interface QuickbaseClient$1 {
7810
8309
  }) => Promise<GetUsers200Response>;
7811
8310
  /**
7812
8311
  * Deny users
7813
- * @param params - Parameters for denyUsers
7814
- * @returns Promise resolving to denyUsers response
8312
+ *
8313
+ * @param {Object} params _Object containing the parameters for_ denyUsers
8314
+ * @param {number} params.accountId _Optional parameter with properties_
8315
+ * @param {DenyUsersRequest} params.body _Optional parameter with properties_
8316
+ * - **userIds** (`string[]`, required) _Type: string[]_
8317
+ *
8318
+ * @returns {Promise<DenyUsers200Response>} _Promise resolving to the denyUsers response with properties_
8319
+ * - **failure** (`string[]`, required) _A list of users that couldn't be denied. This also includes the ID's of users that are not valid._
8320
+ * - **success** (`string[]`, required) _A list of users that have successfully been denied._
8321
+ *
8322
+ * @see {@link https://developer.quickbase.com/operation/denyUsers} Official Quickbase API documentation
7815
8323
  */
7816
8324
  denyUsers: (params: {
7817
8325
  accountId?: number;
@@ -7819,8 +8327,18 @@ interface QuickbaseClient$1 {
7819
8327
  }) => Promise<DenyUsers200Response>;
7820
8328
  /**
7821
8329
  * Deny and remove users from groups
7822
- * @param params - Parameters for denyUsersAndGroups
7823
- * @returns Promise resolving to denyUsersAndGroups response
8330
+ *
8331
+ * @param {Object} params _Object containing the parameters for_ denyUsersAndGroups
8332
+ * @param {number} params.accountId _Optional parameter with properties_
8333
+ * @param {boolean} params.shouldDeleteFromGroups _Required parameter with properties_
8334
+ * @param {DenyUsersAndGroupsRequest} params.body _Optional parameter with properties_
8335
+ * - **userIds** (`string[]`, required) _Type: string[]_
8336
+ *
8337
+ * @returns {Promise<DenyUsersAndGroups200Response>} _Promise resolving to the denyUsersAndGroups response with properties_
8338
+ * - **failure** (`string[]`, required) _A list of users that couldn't be denied. This also includes the ID's of users that are not valid._
8339
+ * - **success** (`string[]`, required) _A list of users that have successfully been denied._
8340
+ *
8341
+ * @see {@link https://developer.quickbase.com/operation/denyUsersAndGroups} Official Quickbase API documentation
7824
8342
  */
7825
8343
  denyUsersAndGroups: (params: {
7826
8344
  accountId?: number;
@@ -7829,8 +8347,17 @@ interface QuickbaseClient$1 {
7829
8347
  }) => Promise<DenyUsersAndGroups200Response>;
7830
8348
  /**
7831
8349
  * Undeny users
7832
- * @param params - Parameters for undenyUsers
7833
- * @returns Promise resolving to undenyUsers response
8350
+ *
8351
+ * @param {Object} params _Object containing the parameters for_ undenyUsers
8352
+ * @param {number} params.accountId _Optional parameter with properties_
8353
+ * @param {UndenyUsersRequest} params.body _Optional parameter with properties_
8354
+ * - **userIds** (`string[]`, required) _Type: string[]_
8355
+ *
8356
+ * @returns {Promise<UndenyUsers200Response>} _Promise resolving to the undenyUsers response with properties_
8357
+ * - **failure** (`string[]`, required) _A list of users that couldn't be undenied. This also includes the ID's of users that are not valid._
8358
+ * - **success** (`string[]`, required) _A list of users that have successfully been undenied._
8359
+ *
8360
+ * @see {@link https://developer.quickbase.com/operation/undenyUsers} Official Quickbase API documentation
7834
8361
  */
7835
8362
  undenyUsers: (params: {
7836
8363
  accountId?: number;
@@ -7838,8 +8365,17 @@ interface QuickbaseClient$1 {
7838
8365
  }) => Promise<UndenyUsers200Response>;
7839
8366
  /**
7840
8367
  * Add members
7841
- * @param params - Parameters for addMembersToGroup
7842
- * @returns Promise resolving to addMembersToGroup response
8368
+ *
8369
+ * @param {Object} params _Object containing the parameters for_ addMembersToGroup
8370
+ * @param {number} params.gid _Required parameter with properties_
8371
+ * @param {AddMembersToGroupRequest} params.body _Optional parameter with properties_
8372
+ * - **userIds** (`string[]`, required) _Type: string[]_
8373
+ *
8374
+ * @returns {Promise<AddMembersToGroup200Response>} _Promise resolving to the addMembersToGroup response with properties_
8375
+ * - **failure** (`string[]`, required) _A list of users that couldn’t be added to the group. This includes a list of IDs that represent invalid users and users who have already been added to the group._
8376
+ * - **success** (`string[]`, required) _A list of users that have been added to the group successfully._
8377
+ *
8378
+ * @see {@link https://developer.quickbase.com/operation/addMembersToGroup} Official Quickbase API documentation
7843
8379
  */
7844
8380
  addMembersToGroup: (params: {
7845
8381
  gid: number;
@@ -7847,8 +8383,17 @@ interface QuickbaseClient$1 {
7847
8383
  }) => Promise<AddMembersToGroup200Response>;
7848
8384
  /**
7849
8385
  * Remove members
7850
- * @param params - Parameters for removeMembersFromGroup
7851
- * @returns Promise resolving to removeMembersFromGroup response
8386
+ *
8387
+ * @param {Object} params _Object containing the parameters for_ removeMembersFromGroup
8388
+ * @param {number} params.gid _Required parameter with properties_
8389
+ * @param {RemoveMembersFromGroupRequest} params.body _Optional parameter with properties_
8390
+ * - **userIds** (`string[]`, required) _Type: string[]_
8391
+ *
8392
+ * @returns {Promise<RemoveMembersFromGroup200Response>} _Promise resolving to the removeMembersFromGroup response with properties_
8393
+ * - **failure** (`string[]`, required) _A list of users that couldn’t be removed from the group. This includes a list of IDs that represent invalid users._
8394
+ * - **success** (`string[]`, required) _A list of users that have been removed from the group successfully._
8395
+ *
8396
+ * @see {@link https://developer.quickbase.com/operation/removeMembersFromGroup} Official Quickbase API documentation
7852
8397
  */
7853
8398
  removeMembersFromGroup: (params: {
7854
8399
  gid: number;
@@ -7856,8 +8401,17 @@ interface QuickbaseClient$1 {
7856
8401
  }) => Promise<RemoveMembersFromGroup200Response>;
7857
8402
  /**
7858
8403
  * Add managers
7859
- * @param params - Parameters for addManagersToGroup
7860
- * @returns Promise resolving to addManagersToGroup response
8404
+ *
8405
+ * @param {Object} params _Object containing the parameters for_ addManagersToGroup
8406
+ * @param {number} params.gid _Required parameter with properties_
8407
+ * @param {AddManagersToGroupRequest} params.body _Optional parameter with properties_
8408
+ * - **userIds** (`string[]`, required) _Type: string[]_
8409
+ *
8410
+ * @returns {Promise<AddManagersToGroup200Response>} _Promise resolving to the addManagersToGroup response with properties_
8411
+ * - **failure** (`string[]`, required) _A list of users that couldn’t be added to the group. This includes a list of IDs that represent invalid users and users who have already been added to the group._
8412
+ * - **success** (`string[]`, required) _A list of users that have been added to the group successfully._
8413
+ *
8414
+ * @see {@link https://developer.quickbase.com/operation/addManagersToGroup} Official Quickbase API documentation
7861
8415
  */
7862
8416
  addManagersToGroup: (params: {
7863
8417
  gid: number;
@@ -7865,8 +8419,17 @@ interface QuickbaseClient$1 {
7865
8419
  }) => Promise<AddManagersToGroup200Response>;
7866
8420
  /**
7867
8421
  * Remove managers
7868
- * @param params - Parameters for removeManagersFromGroup
7869
- * @returns Promise resolving to removeManagersFromGroup response
8422
+ *
8423
+ * @param {Object} params _Object containing the parameters for_ removeManagersFromGroup
8424
+ * @param {number} params.gid _Required parameter with properties_
8425
+ * @param {RemoveManagersFromGroupRequest} params.body _Optional parameter with properties_
8426
+ * - **userIds** (`string[]`, required) _Type: string[]_
8427
+ *
8428
+ * @returns {Promise<RemoveManagersFromGroup200Response>} _Promise resolving to the removeManagersFromGroup response with properties_
8429
+ * - **failure** (`string[]`, required) _A list of users that couldn’t be removed from the group. This includes a list of IDs that represent invalid users._
8430
+ * - **success** (`string[]`, required) _A list of users that have been removed from the group successfully._
8431
+ *
8432
+ * @see {@link https://developer.quickbase.com/operation/removeManagersFromGroup} Official Quickbase API documentation
7870
8433
  */
7871
8434
  removeManagersFromGroup: (params: {
7872
8435
  gid: number;
@@ -7874,8 +8437,17 @@ interface QuickbaseClient$1 {
7874
8437
  }) => Promise<RemoveManagersFromGroup200Response>;
7875
8438
  /**
7876
8439
  * Add child groups
7877
- * @param params - Parameters for addSubgroupsToGroup
7878
- * @returns Promise resolving to addSubgroupsToGroup response
8440
+ *
8441
+ * @param {Object} params _Object containing the parameters for_ addSubgroupsToGroup
8442
+ * @param {number} params.gid _Required parameter with properties_
8443
+ * @param {AddSubgroupsToGroupRequest} params.body _Optional parameter with properties_
8444
+ * - **userIds** (`string[]`, required) _Type: string[]_
8445
+ *
8446
+ * @returns {Promise<AddSubgroupsToGroup200Response>} _Promise resolving to the addSubgroupsToGroup response with properties_
8447
+ * - **failure** (`string[]`, required) _A list of child groups that couldn’t be added to the group. This includes a list of IDs that represent invalid groups and groups that have already been added to the group._
8448
+ * - **success** (`string[]`, required) _A list of child groups that have been added to the group successfully._
8449
+ *
8450
+ * @see {@link https://developer.quickbase.com/operation/addSubgroupsToGroup} Official Quickbase API documentation
7879
8451
  */
7880
8452
  addSubgroupsToGroup: (params: {
7881
8453
  gid: number;
@@ -7883,8 +8455,17 @@ interface QuickbaseClient$1 {
7883
8455
  }) => Promise<AddSubgroupsToGroup200Response>;
7884
8456
  /**
7885
8457
  * Remove child groups
7886
- * @param params - Parameters for removeSubgroupsFromGroup
7887
- * @returns Promise resolving to removeSubgroupsFromGroup response
8458
+ *
8459
+ * @param {Object} params _Object containing the parameters for_ removeSubgroupsFromGroup
8460
+ * @param {number} params.gid _Required parameter with properties_
8461
+ * @param {RemoveSubgroupsFromGroupRequest} params.body _Optional parameter with properties_
8462
+ * - **userIds** (`string[]`, required) _Type: string[]_
8463
+ *
8464
+ * @returns {Promise<RemoveSubgroupsFromGroup200Response>} _Promise resolving to the removeSubgroupsFromGroup response with properties_
8465
+ * - **failure** (`string[]`, required) _A list of child groups that couldn’t be removed from the group. This includes a list of IDs that represent invalid groups._
8466
+ * - **success** (`string[]`, required) _A list of child groups that have been removed from the group successfully._
8467
+ *
8468
+ * @see {@link https://developer.quickbase.com/operation/removeSubgroupsFromGroup} Official Quickbase API documentation
7888
8469
  */
7889
8470
  removeSubgroupsFromGroup: (params: {
7890
8471
  gid: number;
@@ -7892,8 +8473,16 @@ interface QuickbaseClient$1 {
7892
8473
  }) => Promise<RemoveSubgroupsFromGroup200Response>;
7893
8474
  /**
7894
8475
  * Get audit logs
7895
- * @param params - Parameters for audit
7896
- * @returns Promise resolving to audit response
8476
+ *
8477
+ * @param {Object} params _Object containing the parameters for_ audit
8478
+ * @param {{ nextToken?: string; numRows?: number; queryId?: string; date?: string; topics?: string[] }} params.body _Optional parameter with properties_
8479
+ *
8480
+ * @returns {Promise<Audit200Response>} _Promise resolving to the audit response with properties_
8481
+ * - **queryId** (`string`, required) _Query id of the requested audit log._
8482
+ * - **events** (`{ [key: string]: any; }[]`, optional) _All events of the audit log._
8483
+ * - **nextToken** (`string`, optional) _Token to fetch the next 1000 logs._
8484
+ *
8485
+ * @see {@link https://developer.quickbase.com/operation/audit} Official Quickbase API documentation
7897
8486
  */
7898
8487
  audit: (params: {
7899
8488
  body?: {
@@ -7906,16 +8495,37 @@ interface QuickbaseClient$1 {
7906
8495
  }) => Promise<Audit200Response>;
7907
8496
  /**
7908
8497
  * Get read summaries
7909
- * @param params - Parameters for platformAnalyticReads
7910
- * @returns Promise resolving to platformAnalyticReads response
8498
+ *
8499
+ * @param {Object} params _Object containing the parameters for_ platformAnalyticReads
8500
+ * @param {string} params.day _Optional parameter with properties_
8501
+ *
8502
+ * @returns {Promise<PlatformAnalyticReads200Response>} _Promise resolving to the platformAnalyticReads response with properties_
8503
+ * - **date** (`Date`, required) _The date of the requested summary._
8504
+ * - **reads** (`{ [key: string]: any; }`, required) _Total reads for the specified date._
8505
+ *
8506
+ * @see {@link https://developer.quickbase.com/operation/platformAnalyticReads} Official Quickbase API documentation
7911
8507
  */
7912
8508
  platformAnalyticReads: (params: {
7913
8509
  day?: string;
7914
8510
  }) => Promise<PlatformAnalyticReads200Response>;
7915
8511
  /**
7916
8512
  * Get event summaries
7917
- * @param params - Parameters for platformAnalyticEventSummaries
7918
- * @returns Promise resolving to platformAnalyticEventSummaries response
8513
+ *
8514
+ * @param {Object} params _Object containing the parameters for_ platformAnalyticEventSummaries
8515
+ * @param {number} params.accountId _Optional parameter with properties_
8516
+ * @param {{ start?: string; end?: string; groupBy?: string; nextToken?: string; where?: { id?: string; type?: string }[] }} params.body _Optional parameter with properties_
8517
+ *
8518
+ * @returns {Promise<PlatformAnalyticEventSummaries200Response>} _Promise resolving to the platformAnalyticEventSummaries response with properties_
8519
+ * - **accountId** (`string`, required) _The ID of the account the events are associated with._
8520
+ * - **start** (`Date`, required) _The start date and time of the requested summaries in ISO 8601 time format._
8521
+ * - **end** (`Date`, required) _The end date and time of the requested summaries in ISO 8601 time format._
8522
+ * - **groupBy** (`PlatformAnalyticEventSummaries200ResponseGroupByEnum`, required) _How the events should be grouped._
8523
+ * - **where** (`PlatformAnalyticEventSummaries200ResponseWhereInner[]`, required) _Type: PlatformAnalyticEventSummaries200ResponseWhereInner[]_
8524
+ * - **results** (`PlatformAnalyticEventSummaries200ResponseResultsInner[]`, required) _An array of objects that contains Application/User information and an events object with summaries by event type._
8525
+ * - **metadata** (`PlatformAnalyticEventSummaries200ResponseMetadata`, optional) _Type: PlatformAnalyticEventSummaries200ResponseMetadata_
8526
+ * - **totals** (`PlatformAnalyticEventSummaries200ResponseTotals`, optional) _Type: PlatformAnalyticEventSummaries200ResponseTotals_
8527
+ *
8528
+ * @see {@link https://developer.quickbase.com/operation/platformAnalyticEventSummaries} Official Quickbase API documentation
7919
8529
  */
7920
8530
  platformAnalyticEventSummaries: (params: {
7921
8531
  accountId?: number;
@@ -7932,8 +8542,15 @@ interface QuickbaseClient$1 {
7932
8542
  }) => Promise<PlatformAnalyticEventSummaries200Response>;
7933
8543
  /**
7934
8544
  * Export a solution
7935
- * @param params - Parameters for exportSolution
7936
- * @returns Promise resolving to exportSolution response
8545
+ *
8546
+ * @param {Object} params _Object containing the parameters for_ exportSolution
8547
+ * @param {string} params.solutionId _Required parameter with properties_
8548
+ * @param {string} params.qBLVersion _Optional parameter with properties_
8549
+ *
8550
+ * @returns {Promise<ExportSolution200Response>} _Promise resolving to the exportSolution response with properties_
8551
+ * - **content** (`string`, optional) _Type: string_
8552
+ *
8553
+ * @see {@link https://developer.quickbase.com/operation/exportSolution} Official Quickbase API documentation
7937
8554
  */
7938
8555
  exportSolution: (params: {
7939
8556
  solutionId: string;
@@ -7941,8 +8558,15 @@ interface QuickbaseClient$1 {
7941
8558
  }) => Promise<ExportSolution200Response>;
7942
8559
  /**
7943
8560
  * Update a solution
7944
- * @param params - Parameters for updateSolution
7945
- * @returns Promise resolving to updateSolution response
8561
+ *
8562
+ * @param {Object} params _Object containing the parameters for_ updateSolution
8563
+ * @param {string} params.solutionId _Required parameter with properties_
8564
+ * @param {any} params.body _Optional parameter with properties_
8565
+ * @param {boolean} params.xQBLErrorsAsSuccess _Optional parameter with properties_
8566
+ *
8567
+ * @returns {Promise<UpdateSolution200Response>} _Promise resolving to the updateSolution response_
8568
+ *
8569
+ * @see {@link https://developer.quickbase.com/operation/updateSolution} Official Quickbase API documentation
7946
8570
  */
7947
8571
  updateSolution: (params: {
7948
8572
  solutionId: string;
@@ -7951,8 +8575,14 @@ interface QuickbaseClient$1 {
7951
8575
  }) => Promise<UpdateSolution200Response>;
7952
8576
  /**
7953
8577
  * Create a solution
7954
- * @param params - Parameters for createSolution
7955
- * @returns Promise resolving to createSolution response
8578
+ *
8579
+ * @param {Object} params _Object containing the parameters for_ createSolution
8580
+ * @param {any} params.body _Optional parameter with properties_
8581
+ * @param {boolean} params.xQBLErrorsAsSuccess _Optional parameter with properties_
8582
+ *
8583
+ * @returns {Promise<CreateSolution200Response>} _Promise resolving to the createSolution response_
8584
+ *
8585
+ * @see {@link https://developer.quickbase.com/operation/createSolution} Official Quickbase API documentation
7956
8586
  */
7957
8587
  createSolution: (params: {
7958
8588
  body?: any;
@@ -7960,8 +8590,17 @@ interface QuickbaseClient$1 {
7960
8590
  }) => Promise<CreateSolution200Response>;
7961
8591
  /**
7962
8592
  * Export solution to record
7963
- * @param params - Parameters for exportSolutionToRecord
7964
- * @returns Promise resolving to exportSolutionToRecord response
8593
+ *
8594
+ * @param {Object} params _Object containing the parameters for_ exportSolutionToRecord
8595
+ * @param {string} params.solutionId _Required parameter with properties_
8596
+ * @param {string} params.tableId _Required parameter with properties_
8597
+ * @param {number} params.fieldId _Required parameter with properties_
8598
+ * @param {boolean} params.xQBLErrorsAsSuccess _Optional parameter with properties_
8599
+ * @param {string} params.qBLVersion _Optional parameter with properties_
8600
+ *
8601
+ * @returns {Promise<ExportSolutionToRecord200Response>} _Promise resolving to the exportSolutionToRecord response_
8602
+ *
8603
+ * @see {@link https://developer.quickbase.com/operation/exportSolutionToRecord} Official Quickbase API documentation
7965
8604
  */
7966
8605
  exportSolutionToRecord: (params: {
7967
8606
  solutionId: string;
@@ -7972,8 +8611,16 @@ interface QuickbaseClient$1 {
7972
8611
  }) => Promise<ExportSolutionToRecord200Response>;
7973
8612
  /**
7974
8613
  * Create solution from record
7975
- * @param params - Parameters for createSolutionFromRecord
7976
- * @returns Promise resolving to createSolutionFromRecord response
8614
+ *
8615
+ * @param {Object} params _Object containing the parameters for_ createSolutionFromRecord
8616
+ * @param {string} params.tableId _Required parameter with properties_
8617
+ * @param {number} params.fieldId _Required parameter with properties_
8618
+ * @param {number} params.recordId _Required parameter with properties_
8619
+ * @param {boolean} params.xQBLErrorsAsSuccess _Optional parameter with properties_
8620
+ *
8621
+ * @returns {Promise<CreateSolutionFromRecord200Response>} _Promise resolving to the createSolutionFromRecord response_
8622
+ *
8623
+ * @see {@link https://developer.quickbase.com/operation/createSolutionFromRecord} Official Quickbase API documentation
7977
8624
  */
7978
8625
  createSolutionFromRecord: (params: {
7979
8626
  tableId: string;
@@ -7983,8 +8630,17 @@ interface QuickbaseClient$1 {
7983
8630
  }) => Promise<CreateSolutionFromRecord200Response>;
7984
8631
  /**
7985
8632
  * Update solution from record
7986
- * @param params - Parameters for updateSolutionToRecord
7987
- * @returns Promise resolving to updateSolutionToRecord response
8633
+ *
8634
+ * @param {Object} params _Object containing the parameters for_ updateSolutionToRecord
8635
+ * @param {string} params.solutionId _Required parameter with properties_
8636
+ * @param {string} params.tableId _Required parameter with properties_
8637
+ * @param {number} params.fieldId _Required parameter with properties_
8638
+ * @param {number} params.recordId _Required parameter with properties_
8639
+ * @param {boolean} params.xQBLErrorsAsSuccess _Optional parameter with properties_
8640
+ *
8641
+ * @returns {Promise<UpdateSolutionToRecord200Response>} _Promise resolving to the updateSolutionToRecord response_
8642
+ *
8643
+ * @see {@link https://developer.quickbase.com/operation/updateSolutionToRecord} Official Quickbase API documentation
7988
8644
  */
7989
8645
  updateSolutionToRecord: (params: {
7990
8646
  solutionId: string;
@@ -7995,8 +8651,15 @@ interface QuickbaseClient$1 {
7995
8651
  }) => Promise<UpdateSolutionToRecord200Response>;
7996
8652
  /**
7997
8653
  * List solution changes
7998
- * @param params - Parameters for changesetSolution
7999
- * @returns Promise resolving to changesetSolution response
8654
+ *
8655
+ * @param {Object} params _Object containing the parameters for_ changesetSolution
8656
+ * @param {string} params.solutionId _Required parameter with properties_
8657
+ * @param {any} params.body _Optional parameter with properties_
8658
+ * @param {boolean} params.xQBLErrorsAsSuccess _Optional parameter with properties_
8659
+ *
8660
+ * @returns {Promise<ChangesetSolution200Response>} _Promise resolving to the changesetSolution response_
8661
+ *
8662
+ * @see {@link https://developer.quickbase.com/operation/changesetSolution} Official Quickbase API documentation
8000
8663
  */
8001
8664
  changesetSolution: (params: {
8002
8665
  solutionId: string;
@@ -8005,8 +8668,17 @@ interface QuickbaseClient$1 {
8005
8668
  }) => Promise<ChangesetSolution200Response>;
8006
8669
  /**
8007
8670
  * List solution changes from record
8008
- * @param params - Parameters for changesetSolutionFromRecord
8009
- * @returns Promise resolving to changesetSolutionFromRecord response
8671
+ *
8672
+ * @param {Object} params _Object containing the parameters for_ changesetSolutionFromRecord
8673
+ * @param {string} params.solutionId _Required parameter with properties_
8674
+ * @param {string} params.tableId _Required parameter with properties_
8675
+ * @param {number} params.fieldId _Required parameter with properties_
8676
+ * @param {number} params.recordId _Required parameter with properties_
8677
+ * @param {boolean} params.xQBLErrorsAsSuccess _Optional parameter with properties_
8678
+ *
8679
+ * @returns {Promise<ChangesetSolutionFromRecord200Response>} _Promise resolving to the changesetSolutionFromRecord response_
8680
+ *
8681
+ * @see {@link https://developer.quickbase.com/operation/changesetSolutionFromRecord} Official Quickbase API documentation
8010
8682
  */
8011
8683
  changesetSolutionFromRecord: (params: {
8012
8684
  solutionId: string;
@@ -8017,8 +8689,26 @@ interface QuickbaseClient$1 {
8017
8689
  }) => Promise<ChangesetSolutionFromRecord200Response>;
8018
8690
  /**
8019
8691
  * Generate a document
8020
- * @param params - Parameters for generateDocument
8021
- * @returns Promise resolving to generateDocument response
8692
+ *
8693
+ * @param {Object} params _Object containing the parameters for_ generateDocument
8694
+ * @param {number} params.templateId _Required parameter with properties_
8695
+ * @param {string} params.tableId _Required parameter with properties_
8696
+ * @param {number} params.recordId _Optional parameter with properties_
8697
+ * @param {string} params.filename _Required parameter with properties_
8698
+ * @param {string} params.accept _Optional parameter with properties_
8699
+ * @param {string} params.format _Optional parameter with properties_
8700
+ * @param {string} params.margin _Optional parameter with properties_
8701
+ * @param {string} params.unit _Optional parameter with properties_
8702
+ * @param {string} params.pageSize _Optional parameter with properties_
8703
+ * @param {string} params.orientation _Optional parameter with properties_
8704
+ * @param {string} params.realm _Optional parameter with properties_
8705
+ *
8706
+ * @returns {Promise<GenerateDocument200Response>} _Promise resolving to the generateDocument response with properties_
8707
+ * - **fileName** (`string`, optional) _The file name._
8708
+ * - **data** (`string`, optional) _Base64 encoded file content._
8709
+ * - **contentType** (`string`, optional) _The document content type._
8710
+ *
8711
+ * @see {@link https://developer.quickbase.com/operation/generateDocument} Official Quickbase API documentation
8022
8712
  */
8023
8713
  generateDocument: (params: {
8024
8714
  templateId: number;
@@ -8035,6 +8725,15 @@ interface QuickbaseClient$1 {
8035
8725
  }) => Promise<GenerateDocument200Response>;
8036
8726
  }
8037
8727
 
8728
+ declare class TokenCache {
8729
+ private cache;
8730
+ private readonly tempTokenLifespan;
8731
+ constructor(tempTokenLifespan?: number);
8732
+ get(dbid: string): string | undefined;
8733
+ set(dbid: string, token: string, lifespan?: number): void;
8734
+ clear(): void;
8735
+ }
8736
+
8038
8737
  interface QuickbaseClient extends QuickbaseClient$1 {
8039
8738
  }
8040
8739
  interface QuickbaseConfig {
@@ -8042,16 +8741,20 @@ interface QuickbaseConfig {
8042
8741
  userToken?: string;
8043
8742
  tempToken?: string;
8044
8743
  useTempTokens?: boolean;
8744
+ useSso?: boolean;
8745
+ samlToken?: string;
8045
8746
  debug?: boolean;
8046
8747
  fetchApi?: typeof fetch;
8047
8748
  convertDates?: boolean;
8048
- tokenLifespan?: number;
8749
+ tempTokenLifespan?: number;
8049
8750
  throttle?: {
8050
8751
  rate: number;
8051
8752
  burst: number;
8052
8753
  };
8053
8754
  maxRetries?: number;
8054
8755
  retryDelay?: number;
8756
+ tokenCache?: TokenCache;
8757
+ baseUrl?: string;
8055
8758
  }
8056
8759
  declare function quickbase(config: QuickbaseConfig): QuickbaseClient;
8057
8760