quickbase-js 0.1.0-beta.9 → 1.0.0

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 (146) hide show
  1. package/README.md +270 -60
  2. package/dist/esm/quickbase.d.ts +2553 -3220
  3. package/dist/esm/quickbase.js +1545 -3443
  4. package/dist/esm/quickbase.js.map +1 -1
  5. package/dist/esm/quickbase.min.js +1 -1
  6. package/dist/esm/quickbase.min.js.map +1 -1
  7. package/dist/umd/quickbase.umd.js +1544 -3625
  8. package/dist/umd/quickbase.umd.js.map +1 -1
  9. package/dist/umd/quickbase.umd.min.js +1 -1
  10. package/dist/umd/quickbase.umd.min.js.map +1 -1
  11. package/package.json +25 -12
  12. package/CHANGELOG.md +0 -184
  13. package/build-common.js +0 -131
  14. package/build-esm.js +0 -71
  15. package/build-umd.js +0 -69
  16. package/examples/quicbase-jsCDN.html +0 -36
  17. package/examples/react.js +0 -48
  18. package/examples/vanillajs.html +0 -47
  19. package/open-api/fix-spec-main.ts +0 -97
  20. package/open-api/generate-override-report.ts +0 -214
  21. package/open-api/generate-unified-interface.ts +0 -336
  22. package/open-api/output/override-report.html +0 -11
  23. package/open-api/output/override-report.json +0 -14395
  24. package/open-api/output/quickbase-fixed.json +0 -11191
  25. package/open-api/regenerate-client.ts +0 -116
  26. package/open-api/schema/enhance-general.ts +0 -100
  27. package/open-api/schema/fix-arrays.ts +0 -69
  28. package/open-api/schema/tags/apps.ts +0 -90
  29. package/open-api/schema/tags/fields.ts +0 -471
  30. package/open-api/schema/tags/groups.ts +0 -51
  31. package/open-api/schema/tags/index.ts +0 -66
  32. package/open-api/schema/tags/records.ts +0 -115
  33. package/open-api/schema/tags/tables.ts +0 -211
  34. package/open-api/schema/tags/users.ts +0 -47
  35. package/open-api/types/spec.ts +0 -42
  36. package/open-api/utils/generateJsDoc.ts +0 -96
  37. package/open-api/utils/infer-schema.ts +0 -40
  38. package/open-api/utils/naming.ts +0 -10
  39. package/playwright.config.ts +0 -37
  40. package/rollup.config.js +0 -114
  41. package/specs/QuickBase_RESTful_API_2025-03-04T06_22_39.725Z.json +0 -46878
  42. package/specs/split/apps.json +0 -1315
  43. package/specs/split/auth.json +0 -191
  44. package/specs/split/fields.json +0 -3869
  45. package/specs/split/records.json +0 -754
  46. package/specs/split/reports.json +0 -619
  47. package/specs/split/tables.json +0 -1605
  48. package/src/RateLimitError.ts +0 -12
  49. package/src/ThrottleBucket.ts +0 -41
  50. package/src/authorizationStrategy.ts +0 -246
  51. package/src/generated-unified/QuickbaseClient.ts +0 -1049
  52. package/src/generated-unified/missing-types-report.json +0 -3
  53. package/src/index.ts +0 -1
  54. package/src/invokeMethod.ts +0 -242
  55. package/src/quickbaseClient.ts +0 -271
  56. package/src/rateLimiter.ts +0 -25
  57. package/src/tokenCache.ts +0 -35
  58. package/src/utils.ts +0 -7
  59. package/test-esm.js +0 -1
  60. package/test-results.json +0 -2050
  61. package/test-umd.js +0 -1
  62. package/test.ts +0 -1
  63. package/tests/playwright/qb/auth/cacheSwitching.test.ts +0 -159
  64. package/tests/playwright/qb/auth/fetchTempToken401.test.ts +0 -219
  65. package/tests/playwright/qb/auth/getAppWithTempToken.test.ts +0 -162
  66. package/tests/playwright/qb/auth/getAppWithUserToken.test.ts +0 -153
  67. package/tests/playwright/qb/auth/getTempToken.test.ts +0 -152
  68. package/tests/playwright/qb/auth/tempTokenPrefetch.test.ts +0 -179
  69. package/tests/playwright/qb/auth/tempTokenRenewal.test.ts +0 -133
  70. package/tests/setup.ts +0 -53
  71. package/tests/vitest/qb/apps/copyApp.test.ts +0 -76
  72. package/tests/vitest/qb/apps/createApp.test.ts +0 -64
  73. package/tests/vitest/qb/apps/deleteApp.test.ts +0 -76
  74. package/tests/vitest/qb/apps/getApp.test.ts +0 -44
  75. package/tests/vitest/qb/apps/getAppEvents.test.ts +0 -67
  76. package/tests/vitest/qb/apps/updateApp.test.ts +0 -58
  77. package/tests/vitest/qb/auth/mockQuickbaseServer.ts +0 -60
  78. package/tests/vitest/qb/auth/retryUserToken401.test.ts +0 -73
  79. package/tests/vitest/qb/auth/ssoTokenIntegrationWithServer.test.ts +0 -65
  80. package/tests/vitest/qb/fields/createField.test.ts +0 -77
  81. package/tests/vitest/qb/fields/deleteFields.test.ts +0 -83
  82. package/tests/vitest/qb/fields/getField.test.ts +0 -85
  83. package/tests/vitest/qb/fields/getFieldUsage.test.ts +0 -82
  84. package/tests/vitest/qb/fields/getFields.test.ts +0 -232
  85. package/tests/vitest/qb/fields/getFieldsUsage.test.ts +0 -77
  86. package/tests/vitest/qb/fields/updateField.test.ts +0 -93
  87. package/tests/vitest/qb/formulas/runFormula.test.ts +0 -96
  88. package/tests/vitest/qb/index.ts +0 -29
  89. package/tests/vitest/qb/records/deleteRecords.test.ts +0 -110
  90. package/tests/vitest/qb/records/runQuery.test.ts +0 -146
  91. package/tests/vitest/qb/records/upsert.test.ts +0 -102
  92. package/tests/vitest/qb/tables/createRelationship.test.ts +0 -102
  93. package/tests/vitest/qb/tables/createTable.test.ts +0 -55
  94. package/tests/vitest/qb/tables/deleteRelationship.test.ts +0 -143
  95. package/tests/vitest/qb/tables/deleteTable.test.ts +0 -50
  96. package/tests/vitest/qb/tables/getAppTables.test.ts +0 -46
  97. package/tests/vitest/qb/tables/getRelationships.test.ts +0 -80
  98. package/tests/vitest/qb/tables/getTable.test.ts +0 -26
  99. package/tests/vitest/qb/tables/updateRelationship.test.ts +0 -250
  100. package/tests/vitest/qb/tables/updateTable.test.ts +0 -48
  101. package/tests/vitest/unit/ThrottleBucket.test.ts +0 -95
  102. package/tests/vitest/unit/apps/copyApp.test.ts +0 -581
  103. package/tests/vitest/unit/apps/createApp.test.ts +0 -186
  104. package/tests/vitest/unit/apps/deleteApp.test.ts +0 -216
  105. package/tests/vitest/unit/apps/getApp.test.ts +0 -128
  106. package/tests/vitest/unit/apps/getAppEvents.test.ts +0 -193
  107. package/tests/vitest/unit/apps/updateApp.test.ts +0 -412
  108. package/tests/vitest/unit/auth/fetchTempToken401.test.ts +0 -63
  109. package/tests/vitest/unit/auth/getTempToken.test.ts +0 -119
  110. package/tests/vitest/unit/auth/retryTempToken401.test.ts +0 -95
  111. package/tests/vitest/unit/auth/retryTempTokenMaxRetries.test.ts +0 -235
  112. package/tests/vitest/unit/auth/retryUserToken401.test.ts +0 -69
  113. package/tests/vitest/unit/auth/ssoTokenRefresh.test.ts +0 -325
  114. package/tests/vitest/unit/fields/createField.test.ts +0 -451
  115. package/tests/vitest/unit/fields/deleteFields.test.ts +0 -141
  116. package/tests/vitest/unit/fields/getField.test.ts +0 -189
  117. package/tests/vitest/unit/fields/getFieldUsage.test.ts +0 -180
  118. package/tests/vitest/unit/fields/getFields.test.ts +0 -122
  119. package/tests/vitest/unit/fields/getFieldsUsage.test.ts +0 -160
  120. package/tests/vitest/unit/fields/updateField.test.ts +0 -285
  121. package/tests/vitest/unit/formulas/runFormula.test.ts +0 -205
  122. package/tests/vitest/unit/index.ts +0 -34
  123. package/tests/vitest/unit/inferHttpMethod.test.ts +0 -131
  124. package/tests/vitest/unit/rateLimit.test.ts +0 -191
  125. package/tests/vitest/unit/records/deleteRecords.test.ts +0 -112
  126. package/tests/vitest/unit/records/runQuery.test.ts +0 -102
  127. package/tests/vitest/unit/records/upsert.test.ts +0 -234
  128. package/tests/vitest/unit/tables/createRelationship.test.ts +0 -212
  129. package/tests/vitest/unit/tables/createTable.test.ts +0 -70
  130. package/tests/vitest/unit/tables/deleteRelationship.test.ts +0 -97
  131. package/tests/vitest/unit/tables/deleteTable.test.ts +0 -77
  132. package/tests/vitest/unit/tables/getAppTables.test.ts +0 -85
  133. package/tests/vitest/unit/tables/getRelationships.test.ts +0 -259
  134. package/tests/vitest/unit/tables/getTable.test.ts +0 -233
  135. package/tests/vitest/unit/tables/updateRelationship.test.ts +0 -307
  136. package/tests/vitest/unit/tables/updateTable.test.ts +0 -80
  137. package/tests/vitest/unit/tokenLifespan.test.ts +0 -204
  138. package/tests/vitest/unit/umd.test.ts +0 -8
  139. package/text.txt +0 -104
  140. package/tools/log-gen.ts +0 -244
  141. package/tools/log-gen.yaml +0 -5424
  142. package/tools/openapi-jars/openapi-generator-cli-7.12.0.jar +0 -0
  143. package/tsconfig.build.json +0 -17
  144. package/tsconfig.json +0 -32
  145. package/versionrc.json +0 -9
  146. package/vitest.config.ts +0 -27
@@ -1,1049 +0,0 @@
1
- // Generated on 2025-03-20T04:14:08.516Z
2
- import { AddManagersToGroup200Response, AddManagersToGroupRequest, AddMembersToGroup200Response, AddMembersToGroupRequest, AddSubgroupsToGroup200Response, AddSubgroupsToGroupRequest, Audit200Response, ChangesetSolution200Response, ChangesetSolutionFromRecord200Response, CloneUserToken200Response, CopyApp200Response, CopyAppRequest, CreateApp200Response, CreateAppRequest, CreateField200Response, CreateFieldRequest, CreateRelationship200Response, CreateRelationshipRequest, CreateSolution200Response, CreateSolutionFromRecord200Response, CreateTable200Response, CreateTableRequest, DeactivateUserToken200Response, DeleteApp200Response, DeleteAppRequest, DeleteFields200Response, DeleteFieldsRequest, DeleteFile200Response, DeleteRecords200Response, DeleteRecordsRequest, DeleteRelationship200Response, DeleteTable200Response, DeleteUserToken200Response, DenyUsers200Response, DenyUsersAndGroups200Response, DenyUsersAndGroupsRequest, DenyUsersRequest, DownloadFile200Response, ExchangeSsoToken200Response, ExportSolution200Response, ExportSolutionToRecord200Response, GenerateDocument200Response, GetApp200Response, GetAppEvents200Response, GetAppTables200Response, GetField200Response, GetFieldUsage200Response, GetFields200Response, GetFieldsUsage200Response, GetRelationships200Response, GetReport200Response, GetTable200Response, GetTableReports200Response, GetTempTokenDBID200Response, GetUsers200Response, GetUsersRequest, PlatformAnalyticEventSummaries200Response, PlatformAnalyticReads200Response, RemoveManagersFromGroup200Response, RemoveManagersFromGroupRequest, RemoveMembersFromGroup200Response, RemoveMembersFromGroupRequest, RemoveSubgroupsFromGroup200Response, RemoveSubgroupsFromGroupRequest, RunFormula200Response, RunQuery200Response, RunQueryRequest, RunReport200Response, TransferUserToken200Response, UndenyUsers200Response, UndenyUsersRequest, UpdateApp200Response, UpdateAppRequest, UpdateField200Response, UpdateFieldRequest, UpdateRelationship200Response, UpdateRelationshipRequest, UpdateSolution200Response, UpdateSolutionToRecord200Response, UpdateTable200Response, UpdateTableRequest, Upsert200Response, Upsert207Response, UpsertRequest } from "../generated/models";
3
-
4
- export interface QuickbaseClient {
5
- /**
6
- * Create an app
7
- *
8
- * @param {Object} params _Object containing the parameters for_ createApp
9
- * @param {CreateAppRequest} params.body _Optional parameter with properties_
10
- * - **name** (`string`, required) _The name of the app._
11
- * - **description** (`string`, optional) _A description for the app._
12
- * - **assignToken** (`boolean`, required) _Whether to assign the user token._
13
- *
14
- * @returns {Promise<CreateApp200Response>} _Promise resolving to the createApp response with properties_
15
- * - **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._
16
- * - **description** (`string`, optional) _The description for the app. If this property is left out, the app description will be blank._
17
- * - **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)._
18
- * - **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)._
19
- * - **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._
20
- * - **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._
21
- * - **memoryInfo** (`object`, optional) _Application memory info_
22
- * - **id** (`string`, optional) _The unique identifier for this application._
23
- * - **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)_
24
- * - **variables** (`{ [key: string]: any; }[]`, optional) _The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)_
25
- * - **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._
26
- * - **securityProperties** (`{ [key: string]: any; }`, optional) _Security properties of the application_
27
- *
28
- * @see {@link https://developer.quickbase.com/operation/createApp} Official Quickbase API documentation
29
- */
30
- createApp: (params: { body?: CreateAppRequest }) => Promise<CreateApp200Response>;
31
- /**
32
- * Get an app
33
- *
34
- * @param {Object} params _Object containing the parameters for_ getApp
35
- * @param {string} params.appId _Required parameter with properties_
36
- *
37
- * @returns {Promise<GetApp200Response>} _Promise resolving to the getApp response with properties_
38
- * - **ancestorId** (`string`, optional) _The id of the app from which this app was copied_
39
- * - **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._
40
- * - **description** (`string`, optional) _The description for the app. If this property is left out, the app description will be blank._
41
- * - **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)._
42
- * - **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)._
43
- * - **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._
44
- * - **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._
45
- * - **memoryInfo** (`object`, optional) _Application memory info_
46
- * - **id** (`string`, optional) _The unique identifier for this application._
47
- * - **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)_
48
- * - **variables** (`{ [key: string]: any; }[]`, optional) _The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)_
49
- * - **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._
50
- * - **securityProperties** (`{ [key: string]: any; }`, optional) _Security properties of the application_
51
- *
52
- * @see {@link https://developer.quickbase.com/operation/getApp} Official Quickbase API documentation
53
- */
54
- getApp: (params: { appId: string }) => Promise<GetApp200Response>;
55
- /**
56
- * Update an app
57
- *
58
- * @param {Object} params _Object containing the parameters for_ updateApp
59
- * @param {string} params.appId _Required parameter with properties_
60
- * @param {UpdateAppRequest} params.body _Optional parameter with properties_
61
- * - **name** (`string`, required) _The name of the app._
62
- * - **description** (`string`, optional) _A description for the app._
63
- * - **assignToken** (`boolean`, required) _Whether to assign the user token._
64
- *
65
- * @returns {Promise<UpdateApp200Response>} _Promise resolving to the updateApp response with properties_
66
- * - **ancestorId** (`string`, optional) _The id of the app from which this app was copied_
67
- * - **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._
68
- * - **description** (`string`, optional) _The description for the app. If this property is left out, the app description will be blank._
69
- * - **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)._
70
- * - **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)._
71
- * - **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._
72
- * - **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._
73
- * - **memoryInfo** (`object`, optional) _Application memory info_
74
- * - **id** (`string`, optional) _The unique identifier for this application._
75
- * - **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)_
76
- * - **variables** (`{ [key: string]: any; }[]`, optional) _The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)_
77
- * - **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._
78
- * - **securityProperties** (`{ [key: string]: any; }`, optional) _Security properties of the application_
79
- *
80
- * @see {@link https://developer.quickbase.com/operation/updateApp} Official Quickbase API documentation
81
- */
82
- updateApp: (params: { appId: string; body?: UpdateAppRequest }) => Promise<UpdateApp200Response>;
83
- /**
84
- * Delete an app
85
- *
86
- * @param {Object} params _Object containing the parameters for_ deleteApp
87
- * @param {string} params.appId _Required parameter with properties_
88
- * @param {DeleteAppRequest} params.body _Optional parameter with properties_
89
- * - **name** (`string`, required) _The name of the app._
90
- * - **description** (`string`, optional) _A description for the app._
91
- * - **assignToken** (`boolean`, required) _Whether to assign the user token._
92
- *
93
- * @returns {Promise<DeleteApp200Response>} _Promise resolving to the deleteApp response with properties_
94
- * - **deletedAppId** (`string`, optional) _An ID of deleted application._
95
- *
96
- * @see {@link https://developer.quickbase.com/operation/deleteApp} Official Quickbase API documentation
97
- */
98
- deleteApp: (params: { appId: string; body?: DeleteAppRequest }) => Promise<DeleteApp200Response>;
99
- /**
100
- * Get app events
101
- *
102
- * @param {Object} params _Object containing the parameters for_ getAppEvents
103
- * @param {string} params.appId _Required parameter with properties_
104
- *
105
- * @returns {Promise<GetAppEvents200Response>} _Promise resolving to the getAppEvents response_
106
- *
107
- * @see {@link https://developer.quickbase.com/operation/getAppEvents} Official Quickbase API documentation
108
- */
109
- getAppEvents: (params: { appId: string }) => Promise<GetAppEvents200Response>;
110
- /**
111
- * Copy an app
112
- *
113
- * @param {Object} params _Object containing the parameters for_ copyApp
114
- * @param {string} params.appId _Required parameter with properties_
115
- * @param {CopyAppRequest} params.body _Optional parameter with properties_
116
- * - **name** (`string`, required) _The name of the new app._
117
- * - **description** (`string`, optional) _A description for the new app._
118
- * - **properties** (`CopyAppRequestProperties`, optional) _Type: CopyAppRequestProperties_
119
- *
120
- * @returns {Promise<CopyApp200Response>} _Promise resolving to the copyApp response with properties_
121
- * - **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._
122
- * - **description** (`string`, optional) _The description for the app_
123
- * - **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)._
124
- * - **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)._
125
- * - **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._
126
- * - **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._
127
- * - **id** (`string`, optional) _The unique identifier for this application._
128
- * - **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)_
129
- * - **variables** (`{ [key: string]: any; }[]`, optional) _The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)_
130
- * - **ancestorId** (`string`, optional) _The id of the app from which this app was copied_
131
- * - **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._
132
- *
133
- * @see {@link https://developer.quickbase.com/operation/copyApp} Official Quickbase API documentation
134
- */
135
- copyApp: (params: { appId: string; body?: CopyAppRequest }) => Promise<CopyApp200Response>;
136
- /**
137
- * Create a table
138
- *
139
- * @param {Object} params _Object containing the parameters for_ createTable
140
- * @param {string} params.appId _Required parameter with properties_
141
- * @param {CreateTableRequest} params.body _Optional parameter with properties_
142
- * - **name** (`string`, required) _The name for the table._
143
- * - **description** (`string`, optional) _The description for the table..._
144
- * - **singleRecordName** (`string`, optional) _The singular noun for records..._
145
- * - **pluralRecordName** (`string`, optional) _The plural noun for records..._
146
- *
147
- * @returns {Promise<CreateTable200Response>} _Promise resolving to the createTable response with properties_
148
- * - **name** (`string`, optional) _The name of the table._
149
- * - **id** (`string`, optional) _The unique identifier (dbid) of the table._
150
- * - **alias** (`string`, optional) _The automatically-created table alias for the table._
151
- * - **description** (`string`, optional) _The description of the table, as configured by an application administrator._
152
- * - **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)._
153
- * - **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)._
154
- * - **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._
155
- * - **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._
156
- * - **defaultSortFieldId** (`number`, optional) _The id of the field that is configured for default sorting._
157
- * - **defaultSortOrder** (`CreateTable200ResponseDefaultSortOrderEnum`, optional) _The configuration of the default sort order on the table._
158
- * - **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._
159
- * - **singleRecordName** (`string`, optional) _The builder-configured singular noun of the table._
160
- * - **pluralRecordName** (`string`, optional) _The builder-configured plural noun of the table._
161
- * - **sizeLimit** (`string`, optional) _The size limit for the table._
162
- * - **spaceUsed** (`string`, optional) _The amount of space currently being used by the table._
163
- * - **spaceRemaining** (`string`, optional) _The amount of space remaining for use by the table._
164
- *
165
- * @see {@link https://developer.quickbase.com/operation/createTable} Official Quickbase API documentation
166
- */
167
- createTable: (params: { appId: string; body?: CreateTableRequest }) => Promise<CreateTable200Response>;
168
- /**
169
- * Get tables for an app
170
- *
171
- * @param {Object} params _Object containing the parameters for_ getAppTables
172
- * @param {string} params.appId _Required parameter with properties_
173
- *
174
- * @returns {Promise<GetAppTables200Response>} _Promise resolving to the getAppTables response_
175
- *
176
- * @see {@link https://developer.quickbase.com/operation/getAppTables} Official Quickbase API documentation
177
- */
178
- getAppTables: (params: { appId: string }) => Promise<GetAppTables200Response>;
179
- /**
180
- * Get a table
181
- *
182
- * @param {Object} params _Object containing the parameters for_ getTable
183
- * @param {string} params.appId _Required parameter with properties_
184
- * @param {string} params.tableId _Required parameter with properties_
185
- *
186
- * @returns {Promise<GetTable200Response>} _Promise resolving to the getTable response with properties_
187
- * - **name** (`string`, optional) _The name of the table._
188
- * - **id** (`string`, optional) _The unique identifier (dbid) of the table._
189
- * - **alias** (`string`, optional) _The automatically-created table alias for the table._
190
- * - **description** (`string`, optional) _The description of the table, as configured by an application administrator._
191
- * - **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)._
192
- * - **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)._
193
- * - **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._
194
- * - **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._
195
- * - **defaultSortFieldId** (`number`, optional) _The id of the field that is configured for default sorting._
196
- * - **defaultSortOrder** (`GetTable200ResponseDefaultSortOrderEnum`, optional) _The configuration of the default sort order on the table._
197
- * - **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._
198
- * - **singleRecordName** (`string`, optional) _The builder-configured singular noun of the table._
199
- * - **pluralRecordName** (`string`, optional) _The builder-configured plural noun of the table._
200
- * - **sizeLimit** (`string`, optional) _The size limit for the table._
201
- * - **spaceUsed** (`string`, optional) _The amount of space currently being used by the table._
202
- * - **spaceRemaining** (`string`, optional) _The amount of space remaining for use by the table._
203
- *
204
- * @see {@link https://developer.quickbase.com/operation/getTable} Official Quickbase API documentation
205
- */
206
- getTable: (params: { appId: string; tableId: string }) => Promise<GetTable200Response>;
207
- /**
208
- * Update a table
209
- *
210
- * @param {Object} params _Object containing the parameters for_ updateTable
211
- * @param {string} params.appId _Required parameter with properties_
212
- * @param {string} params.tableId _Required parameter with properties_
213
- * @param {UpdateTableRequest} params.body _Optional parameter with properties_
214
- * - **name** (`string`, optional) _The updated name of the table._
215
- * - **description** (`string`, optional) _The updated description for the table._
216
- *
217
- * @returns {Promise<UpdateTable200Response>} _Promise resolving to the updateTable response with properties_
218
- * - **name** (`string`, optional) _The name of the table._
219
- * - **id** (`string`, optional) _The unique identifier (dbid) of the table._
220
- * - **alias** (`string`, optional) _The automatically-created table alias for the table._
221
- * - **description** (`string`, optional) _The description of the table, as configured by an application administrator._
222
- * - **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)._
223
- * - **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)._
224
- * - **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._
225
- * - **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._
226
- * - **defaultSortFieldId** (`number`, optional) _The id of the field that is configured for default sorting._
227
- * - **defaultSortOrder** (`UpdateTable200ResponseDefaultSortOrderEnum`, optional) _The configuration of the default sort order on the table._
228
- * - **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._
229
- * - **singleRecordName** (`string`, optional) _The builder-configured singular noun of the table._
230
- * - **pluralRecordName** (`string`, optional) _The builder-configured plural noun of the table._
231
- * - **sizeLimit** (`string`, optional) _The size limit for the table._
232
- * - **spaceUsed** (`string`, optional) _The amount of space currently being used by the table._
233
- * - **spaceRemaining** (`string`, optional) _The amount of space remaining for use by the table._
234
- *
235
- * @see {@link https://developer.quickbase.com/operation/updateTable} Official Quickbase API documentation
236
- */
237
- updateTable: (params: { appId: string; tableId: string; body?: UpdateTableRequest }) => Promise<UpdateTable200Response>;
238
- /**
239
- * Delete a table
240
- *
241
- * @param {Object} params _Object containing the parameters for_ deleteTable
242
- * @param {string} params.appId _Required parameter with properties_
243
- * @param {string} params.tableId _Required parameter with properties_
244
- *
245
- * @returns {Promise<DeleteTable200Response>} _Promise resolving to the deleteTable response with properties_
246
- * - **deletedTableId** (`string`, optional) _The deleted table id._
247
- *
248
- * @see {@link https://developer.quickbase.com/operation/deleteTable} Official Quickbase API documentation
249
- */
250
- deleteTable: (params: { appId: string; tableId: string }) => Promise<DeleteTable200Response>;
251
- /**
252
- * Get all relationships
253
- *
254
- * @param {Object} params _Object containing the parameters for_ getRelationships
255
- * @param {number} params.skip _Optional parameter with properties_
256
- * @param {string} params.tableId _Required parameter with properties_
257
- *
258
- * @returns {Promise<GetRelationships200Response>} _Promise resolving to the getRelationships response with properties_
259
- * - **relationships** (`{ [key: string]: any; }[]`, required) _The relationships in a table._
260
- * - **metadata** (`{ [key: string]: any; }`, optional) _Additional information about the results that may be helpful._
261
- *
262
- * @see {@link https://developer.quickbase.com/operation/getRelationships} Official Quickbase API documentation
263
- */
264
- getRelationships: (params: { skip?: number; tableId: string }) => Promise<GetRelationships200Response>;
265
- /**
266
- * Create a relationship
267
- *
268
- * @param {Object} params _Object containing the parameters for_ createRelationship
269
- * @param {string} params.tableId _Required parameter with properties_
270
- * @param {CreateRelationshipRequest} params.body _Optional parameter with properties_
271
- * - **parentTableId** (`string`, required) _The parent table id for the relationship._
272
- * - **foreignKeyField** (`{ [key: string]: any; }`, optional) _Type: { [key: string]: any; }_
273
- * - **lookupFieldIds** (`number[]`, optional) _Array of field ids..._
274
- * - **summaryFields** (`{ [key: string]: any; }[]`, optional) _Array of summary field objects..._
275
- *
276
- * @returns {Promise<CreateRelationship200Response>} _Promise resolving to the createRelationship response with properties_
277
- * - **id** (`number`, required) _The relationship id (foreign key field id)._
278
- * - **parentTableId** (`string`, required) _The parent table id of the relationship._
279
- * - **childTableId** (`string`, required) _The child table id of the relationship._
280
- * - **foreignKeyField** (`{ [key: string]: any; }`, optional) _The foreign key field information._
281
- * - **isCrossApp** (`boolean`, required) _Whether this is a cross-app relationship._
282
- * - **lookupFields** (`{ [key: string]: any; }[]`, optional) _The lookup fields array._
283
- * - **summaryFields** (`{ [key: string]: any; }[]`, optional) _The summary fields array._
284
- *
285
- * @see {@link https://developer.quickbase.com/operation/createRelationship} Official Quickbase API documentation
286
- */
287
- createRelationship: (params: { tableId: string; body?: CreateRelationshipRequest }) => Promise<CreateRelationship200Response>;
288
- /**
289
- * Update a relationship
290
- *
291
- * @param {Object} params _Object containing the parameters for_ updateRelationship
292
- * @param {string} params.tableId _Required parameter with properties_
293
- * @param {number} params.relationshipId _Required parameter with properties_
294
- * @param {UpdateRelationshipRequest} params.body _Optional parameter with properties_
295
- * - **parentTableId** (`string`, optional) _The updated parent table id..._
296
- * - **foreignKeyField** (`{ [key: string]: any; }`, optional) _Type: { [key: string]: any; }_
297
- * - **lookupFieldIds** (`number[]`, optional) _Updated array of field ids..._
298
- * - **summaryFields** (`{ [key: string]: any; }[]`, optional) _Type: { [key: string]: any; }[]_
299
- *
300
- * @returns {Promise<UpdateRelationship200Response>} _Promise resolving to the updateRelationship response with properties_
301
- * - **id** (`number`, required) _The relationship id (foreign key field id)._
302
- * - **parentTableId** (`string`, required) _The parent table id of the relationship._
303
- * - **childTableId** (`string`, required) _The child table id of the relationship._
304
- * - **foreignKeyField** (`{ [key: string]: any; }`, optional) _The foreign key field information._
305
- * - **isCrossApp** (`boolean`, required) _Whether this is a cross-app relationship._
306
- * - **lookupFields** (`{ [key: string]: any; }[]`, optional) _The lookup fields array._
307
- * - **summaryFields** (`{ [key: string]: any; }[]`, optional) _The summary fields array._
308
- *
309
- * @see {@link https://developer.quickbase.com/operation/updateRelationship} Official Quickbase API documentation
310
- */
311
- updateRelationship: (params: { tableId: string; relationshipId: number; body?: UpdateRelationshipRequest }) => Promise<UpdateRelationship200Response>;
312
- /**
313
- * Delete a relationship
314
- *
315
- * @param {Object} params _Object containing the parameters for_ deleteRelationship
316
- * @param {string} params.tableId _Required parameter with properties_
317
- * @param {number} params.relationshipId _Required parameter with properties_
318
- *
319
- * @returns {Promise<DeleteRelationship200Response>} _Promise resolving to the deleteRelationship response with properties_
320
- * - **relationshipId** (`number`, required) _The relationship id._
321
- *
322
- * @see {@link https://developer.quickbase.com/operation/deleteRelationship} Official Quickbase API documentation
323
- */
324
- deleteRelationship: (params: { tableId: string; relationshipId: number }) => Promise<DeleteRelationship200Response>;
325
- /**
326
- * Get reports for a table
327
- *
328
- * @param {Object} params _Object containing the parameters for_ getTableReports
329
- * @param {string} params.tableId _Required parameter with properties_
330
- *
331
- * @returns {Promise<GetTableReports200Response>} _Promise resolving to the getTableReports response_
332
- *
333
- * @see {@link https://developer.quickbase.com/operation/getTableReports} Official Quickbase API documentation
334
- */
335
- getTableReports: (params: { tableId: string }) => Promise<GetTableReports200Response>;
336
- /**
337
- * Get a report
338
- *
339
- * @param {Object} params _Object containing the parameters for_ getReport
340
- * @param {string} params.tableId _Required parameter with properties_
341
- * @param {string} params.reportId _Required parameter with properties_
342
- *
343
- * @returns {Promise<GetReport200Response>} _Promise resolving to the getReport response with properties_
344
- * - **id** (`string`, optional) _The identifier of the report, unique to the table._
345
- * - **name** (`string`, optional) _The configured name of the report._
346
- * - **type** (`string`, optional) _The type of report in Quickbase (e.g., chart)._
347
- * - **description** (`string`, optional) _The configured description of a report._
348
- * - **ownerId** (`number`, optional) _Optional, showed only for personal reports. The user ID of report owner._
349
- * - **query** (`{ [key: string]: any; }`, optional) _The query definition as configured in Quickbase that gets executed when the report is run._
350
- * - **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)_
351
- * - **usedLast** (`string`, optional) _The instant at which a report was last used._
352
- * - **usedCount** (`number`, optional) _The number of times a report has been used._
353
- *
354
- * @see {@link https://developer.quickbase.com/operation/getReport} Official Quickbase API documentation
355
- */
356
- getReport: (params: { tableId: string; reportId: string }) => Promise<GetReport200Response>;
357
- /**
358
- * Run a report
359
- *
360
- * @param {Object} params _Object containing the parameters for_ runReport
361
- * @param {string} params.tableId _Required parameter with properties_
362
- * @param {number} params.skip _Optional parameter with properties_
363
- * @param {number} params.top _Optional parameter with properties_
364
- * @param {string} params.reportId _Required parameter with properties_
365
- * @param {any} params.body _Optional parameter with properties_
366
- *
367
- * @returns {Promise<RunReport200Response>} _Promise resolving to the runReport response with properties_
368
- * - **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._
369
- * - **data** (`string[]`, optional) _An array of objects that either represents the record data or summarized values, depending on the report type._
370
- * - **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._
371
- *
372
- * @see {@link https://developer.quickbase.com/operation/runReport} Official Quickbase API documentation
373
- */
374
- runReport: (params: { tableId: string; skip?: number; top?: number; reportId: string; body?: any }) => Promise<RunReport200Response>;
375
- /**
376
- * Get fields for a table
377
- *
378
- * @param {Object} params _Object containing the parameters for_ getFields
379
- * @param {string} params.tableId _Required parameter with properties_
380
- * @param {boolean} params.includeFieldPerms _Optional parameter with properties_
381
- *
382
- * @returns {Promise<GetFields200Response>} _Promise resolving to the getFields response_
383
- *
384
- * @see {@link https://developer.quickbase.com/operation/getFields} Official Quickbase API documentation
385
- */
386
- getFields: (params: { tableId: string; includeFieldPerms?: boolean }) => Promise<GetFields200Response>;
387
- /**
388
- * Create a field
389
- *
390
- * @param {Object} params _Object containing the parameters for_ createField
391
- * @param {string} params.tableId _Required parameter with properties_
392
- * @param {CreateFieldRequest} params.body _Optional parameter with properties_
393
- * - **label** (`string`, required) _The label of the field_
394
- * - **fieldType** (`CreateFieldRequestFieldTypeEnum`, required) _The type of the field_
395
- * - **fieldHelp** (`string`, optional) _Help text for the field_
396
- * - **addToForms** (`boolean`, optional) _Whether to add the field to forms_
397
- * - **permissions** (`object`, optional) _Custom permissions for the field_
398
- * - **required** (`boolean`, optional) _Whether the field is required_
399
- * - **unique** (`boolean`, optional) _Whether the field must have unique values_
400
- * - **noWrap** (`boolean`, optional) _Whether text wrapping is disabled_
401
- * - **bold** (`boolean`, optional) _Whether the field is bolded_
402
- * - **appearsByDefault** (`boolean`, optional) _Whether the field appears by default in reports_
403
- * - **findEnabled** (`boolean`, optional) _Whether the field is searchable_
404
- * - **doesDataCopy** (`boolean`, optional) _Whether the field copies data_
405
- * - **audited** (`boolean`, optional) _Whether changes to the field are audited_
406
- * - **properties** (`CreateFieldRequestProperties`, optional) _Type: CreateFieldRequestProperties_
407
- *
408
- * @returns {Promise<CreateField200Response>} _Promise resolving to the createField response with properties_
409
- * - **id** (`number`, required) _The id of the field, unique to this table._
410
- * - **fieldType** (`string`, optional) _The type of field, as described [here](https://help.quickbase.com/user-assistance/field_types.html)._
411
- * - **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._
412
- * - **label** (`string`, optional) _The label (name) of the field._
413
- * - **noWrap** (`boolean`, optional) _Indicates if the field is configured to not wrap when displayed in the product._
414
- * - **bold** (`boolean`, optional) _Indicates if the field is configured to display in bold in the product._
415
- * - **required** (`boolean`, optional) _Indicates if the field is marked required._
416
- * - **appearsByDefault** (`boolean`, optional) _Indicates if the field is marked as a default in reports._
417
- * - **findEnabled** (`boolean`, optional) _Indicates if the field is marked as searchable._
418
- * - **unique** (`boolean`, optional) _Indicates if the field is marked unique._
419
- * - **doesDataCopy** (`boolean`, optional) _Indicates if the field data will copy when a user copies the record._
420
- * - **fieldHelp** (`string`, optional) _The configured help text shown to users within the product._
421
- * - **audited** (`boolean`, optional) _Indicates if the field is being tracked as part of Quickbase Audit Logs._
422
- * - **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._
423
- * - **permissions** (`object[]`, optional) _Field Permissions for different roles._
424
- *
425
- * @see {@link https://developer.quickbase.com/operation/createField} Official Quickbase API documentation
426
- */
427
- createField: (params: { tableId: string; body?: CreateFieldRequest }) => Promise<CreateField200Response>;
428
- /**
429
- * Delete field(s)
430
- *
431
- * @param {Object} params _Object containing the parameters for_ deleteFields
432
- * @param {string} params.tableId _Required parameter with properties_
433
- * @param {DeleteFieldsRequest} params.body _Optional parameter with properties_
434
- * - **fieldIds** (`number[]`, required) _Type: number[]_
435
- *
436
- * @returns {Promise<DeleteFields200Response>} _Promise resolving to the deleteFields response with properties_
437
- * - **deletedFieldIds** (`number[]`, required) _List of field ids to were deleted._
438
- * - **errors** (`string[]`, required) _List of errors found._
439
- *
440
- * @see {@link https://developer.quickbase.com/operation/deleteFields} Official Quickbase API documentation
441
- */
442
- deleteFields: (params: { tableId: string; body?: DeleteFieldsRequest }) => Promise<DeleteFields200Response>;
443
- /**
444
- * Get field
445
- *
446
- * @param {Object} params _Object containing the parameters for_ getField
447
- * @param {string} params.tableId _Required parameter with properties_
448
- * @param {boolean} params.includeFieldPerms _Optional parameter with properties_
449
- * @param {number} params.fieldId _Required parameter with properties_
450
- *
451
- * @returns {Promise<GetField200Response>} _Promise resolving to the getField response with properties_
452
- * - **id** (`number`, required) _The id of the field, unique to this table._
453
- * - **fieldType** (`string`, optional) _The type of field, as described [here](https://help.quickbase.com/user-assistance/field_types.html)._
454
- * - **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._
455
- * - **label** (`string`, optional) _The label (name) of the field._
456
- * - **noWrap** (`boolean`, optional) _Indicates if the field is configured to not wrap when displayed in the product._
457
- * - **bold** (`boolean`, optional) _Indicates if the field is configured to display in bold in the product._
458
- * - **required** (`boolean`, optional) _Indicates if the field is marked required._
459
- * - **appearsByDefault** (`boolean`, optional) _Indicates if the field is marked as a default in reports._
460
- * - **findEnabled** (`boolean`, optional) _Indicates if the field is marked as searchable._
461
- * - **unique** (`boolean`, optional) _Indicates if the field is marked unique._
462
- * - **doesDataCopy** (`boolean`, optional) _Indicates if the field data will copy when a user copies the record._
463
- * - **fieldHelp** (`string`, optional) _The configured help text shown to users within the product._
464
- * - **audited** (`boolean`, optional) _Indicates if the field is being tracked as part of Quickbase Audit Logs._
465
- * - **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._
466
- * - **permissions** (`object[]`, optional) _Field Permissions for different roles._
467
- *
468
- * @see {@link https://developer.quickbase.com/operation/getField} Official Quickbase API documentation
469
- */
470
- getField: (params: { tableId: string; includeFieldPerms?: boolean; fieldId: number }) => Promise<GetField200Response>;
471
- /**
472
- * Update a field
473
- *
474
- * @param {Object} params _Object containing the parameters for_ updateField
475
- * @param {string} params.tableId _Required parameter with properties_
476
- * @param {number} params.fieldId _Required parameter with properties_
477
- * @param {UpdateFieldRequest} params.body _Optional parameter with properties_
478
- * - **label** (`string`, required) _The label of the field_
479
- * - **fieldType** (`UpdateFieldRequestFieldTypeEnum`, optional) _The type of the field_
480
- * - **fieldHelp** (`string`, optional) _Help text for the field_
481
- * - **addToForms** (`boolean`, optional) _Whether to add the field to forms_
482
- * - **permissions** (`object`, optional) _Custom permissions for the field_
483
- * - **required** (`boolean`, optional) _Whether the field is required_
484
- * - **unique** (`boolean`, optional) _Whether the field must have unique values_
485
- * - **noWrap** (`boolean`, optional) _Whether text wrapping is disabled_
486
- * - **bold** (`boolean`, optional) _Whether the field is bolded_
487
- * - **appearsByDefault** (`boolean`, optional) _Whether the field appears by default in reports_
488
- * - **findEnabled** (`boolean`, optional) _Whether the field is searchable_
489
- * - **doesDataCopy** (`boolean`, optional) _Whether the field copies data_
490
- * - **audited** (`boolean`, optional) _Whether changes to the field are audited_
491
- * - **properties** (`CreateFieldRequestProperties`, optional) _Type: CreateFieldRequestProperties_
492
- *
493
- * @returns {Promise<UpdateField200Response>} _Promise resolving to the updateField response with properties_
494
- * - **id** (`number`, required) _The id of the field, unique to this table._
495
- * - **fieldType** (`string`, optional) _The type of field, as described [here](https://help.quickbase.com/user-assistance/field_types.html)._
496
- * - **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._
497
- * - **label** (`string`, optional) _The label (name) of the field._
498
- * - **noWrap** (`boolean`, optional) _Indicates if the field is configured to not wrap when displayed in the product._
499
- * - **bold** (`boolean`, optional) _Indicates if the field is configured to display in bold in the product._
500
- * - **required** (`boolean`, optional) _Indicates if the field is marked required._
501
- * - **appearsByDefault** (`boolean`, optional) _Indicates if the field is marked as a default in reports._
502
- * - **findEnabled** (`boolean`, optional) _Indicates if the field is marked as searchable._
503
- * - **unique** (`boolean`, optional) _Indicates if the field is marked unique._
504
- * - **doesDataCopy** (`boolean`, optional) _Indicates if the field data will copy when a user copies the record._
505
- * - **fieldHelp** (`string`, optional) _The configured help text shown to users within the product._
506
- * - **audited** (`boolean`, optional) _Indicates if the field is being tracked as part of Quickbase Audit Logs._
507
- * - **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._
508
- * - **permissions** (`object[]`, optional) _Field Permissions for different roles._
509
- *
510
- * @see {@link https://developer.quickbase.com/operation/updateField} Official Quickbase API documentation
511
- */
512
- updateField: (params: { tableId: string; fieldId: number; body?: UpdateFieldRequest }) => Promise<UpdateField200Response>;
513
- /**
514
- * Get usage for all fields
515
- *
516
- * @param {Object} params _Object containing the parameters for_ getFieldsUsage
517
- * @param {string} params.tableId _Required parameter with properties_
518
- * @param {number} params.skip _Optional parameter with properties_
519
- * @param {number} params.top _Optional parameter with properties_
520
- *
521
- * @returns {Promise<GetFieldsUsage200Response>} _Promise resolving to the getFieldsUsage response_
522
- *
523
- * @see {@link https://developer.quickbase.com/operation/getFieldsUsage} Official Quickbase API documentation
524
- */
525
- getFieldsUsage: (params: { tableId: string; skip?: number; top?: number }) => Promise<GetFieldsUsage200Response>;
526
- /**
527
- * Get usage for a field
528
- *
529
- * @param {Object} params _Object containing the parameters for_ getFieldUsage
530
- * @param {string} params.tableId _Required parameter with properties_
531
- * @param {number} params.fieldId _Required parameter with properties_
532
- *
533
- * @returns {Promise<GetFieldUsage200Response>} _Promise resolving to the getFieldUsage response_
534
- *
535
- * @see {@link https://developer.quickbase.com/operation/getFieldUsage} Official Quickbase API documentation
536
- */
537
- getFieldUsage: (params: { tableId: string; fieldId: number }) => Promise<GetFieldUsage200Response>;
538
- /**
539
- * Run a formula
540
- *
541
- * @param {Object} params _Object containing the parameters for_ runFormula
542
- * @param {{ formula?: string; rid?: number; from?: string }} params.body _Optional parameter with properties_
543
- *
544
- * @returns {Promise<RunFormula200Response>} _Promise resolving to the runFormula response with properties_
545
- * - **result** (`string`, optional) _The formula execution result._
546
- *
547
- * @see {@link https://developer.quickbase.com/operation/runFormula} Official Quickbase API documentation
548
- */
549
- runFormula: (params: { body?: { formula?: string; rid?: number; from?: string } }) => Promise<RunFormula200Response>;
550
- /**
551
- * Insert/Update record(s)
552
- *
553
- * @param {Object} params _Object containing the parameters for_ upsert
554
- * @param {UpsertRequest} params.body _Optional parameter with properties_
555
- * - **data** (`Record[]`, optional) _Type: Record[]_
556
- * - **to** (`string`, optional) _Type: string_
557
- * - **fieldsToReturn** (`number[]`, optional) _Type: number[]_
558
- *
559
- * @returns {Promise<Upsert200Response | Upsert207Response>} _Promise resolving to the upsert response_
560
- *
561
- * @see {@link https://developer.quickbase.com/operation/upsert} Official Quickbase API documentation
562
- */
563
- upsert: (params: { body?: UpsertRequest }) => Promise<Upsert200Response | Upsert207Response>;
564
- /**
565
- * Delete record(s)
566
- *
567
- * @param {Object} params _Object containing the parameters for_ deleteRecords
568
- * @param {DeleteRecordsRequest} params.body _Optional parameter with properties_
569
- * - **from** (`string`, required) _Type: string_
570
- * - **where** (`string`, optional) _Type: string_
571
- *
572
- * @returns {Promise<DeleteRecords200Response>} _Promise resolving to the deleteRecords response with properties_
573
- * - **numberDeleted** (`number`, optional) _The number of records deleted._
574
- *
575
- * @see {@link https://developer.quickbase.com/operation/deleteRecords} Official Quickbase API documentation
576
- */
577
- deleteRecords: (params: { body?: DeleteRecordsRequest }) => Promise<DeleteRecords200Response>;
578
- /**
579
- * Query for data
580
- *
581
- * @param {Object} params _Object containing the parameters for_ runQuery
582
- * @param {RunQueryRequest} params.body _Optional parameter with properties_
583
- * - **from** (`string`, required) _The table identifier._
584
- * - **select** (`number[]`, optional) _An array of field ids..._
585
- * - **where** (`string`, optional) _The filter, using the Quickbase query language..._
586
- * - **sortBy** (`RunQueryRequestSortByInner[]`, optional) _An array of field IDs and sort directions..._
587
- * - **groupBy** (`RunQueryRequestGroupByInner[]`, optional) _An array that contains the fields to group the records by._
588
- * - **options** (`RunQueryRequestOptions`, optional) _Type: RunQueryRequestOptions_
589
- *
590
- * @returns {Promise<RunQuery200Response>} _Promise resolving to the runQuery response with properties_
591
- * - **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._
592
- * - **data** (`string[]`, optional) _An array of objects that either represents the record data or summarized values, depending on the report type._
593
- * - **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._
594
- *
595
- * @see {@link https://developer.quickbase.com/operation/runQuery} Official Quickbase API documentation
596
- */
597
- runQuery: (params: { body?: RunQueryRequest }) => Promise<RunQuery200Response>;
598
- /**
599
- * Get a temporary token for a dbid
600
- *
601
- * @param {Object} params _Object containing the parameters for_ getTempTokenDBID
602
- * @param {string} params.dbid _Required parameter with properties_
603
- * @param {string} params.qBAppToken _Optional parameter with properties_
604
- *
605
- * @returns {Promise<GetTempTokenDBID200Response>} _Promise resolving to the getTempTokenDBID response with properties_
606
- * - **temporaryAuthorization** (`string`, optional) _Temporary authorization token._
607
- *
608
- * @see {@link https://developer.quickbase.com/operation/getTempTokenDBID} Official Quickbase API documentation
609
- */
610
- getTempTokenDBID: (params: { dbid: string; qBAppToken?: string }) => Promise<GetTempTokenDBID200Response>;
611
- /**
612
- * Exchange an SSO token
613
- *
614
- * @param {Object} params _Object containing the parameters for_ exchangeSsoToken
615
- * @param {{ grant_type?: string; requested_token_type?: string; subject_token?: string; subject_token_type?: string }} params.body _Optional parameter with properties_
616
- *
617
- * @returns {Promise<ExchangeSsoToken200Response>} _Promise resolving to the exchangeSsoToken response with properties_
618
- * - **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._
619
- * - **issuedTokenType** (`ExchangeSsoToken200ResponseIssuedTokenTypeEnum`, optional) _An identifier for the representation of the issued security token._
620
- * - **tokenType** (`"N_A"`, optional) _Will always return `N_A`_
621
- *
622
- * @see {@link https://developer.quickbase.com/operation/exchangeSsoToken} Official Quickbase API documentation
623
- */
624
- exchangeSsoToken: (params: { body?: { grant_type?: string; requested_token_type?: string; subject_token?: string; subject_token_type?: string } }) => Promise<ExchangeSsoToken200Response>;
625
- /**
626
- * Clone a user token
627
- *
628
- * @param {Object} params _Object containing the parameters for_ cloneUserToken
629
- * @param {{ name?: string; description?: string }} params.body _Optional parameter with properties_
630
- *
631
- * @returns {Promise<CloneUserToken200Response>} _Promise resolving to the cloneUserToken response with properties_
632
- * - **active** (`boolean`, optional) _Whether the user token is active._
633
- * - **apps** (`{ [key: string]: any; }[]`, optional) _The list of apps this user token is assigned to._
634
- * - **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)._
635
- * - **description** (`string`, optional) _User Token description._
636
- * - **id** (`number`, optional) _User Token id._
637
- * - **name** (`string`, optional) _User Token name._
638
- * - **token** (`string`, optional) _User Token value._
639
- *
640
- * @see {@link https://developer.quickbase.com/operation/cloneUserToken} Official Quickbase API documentation
641
- */
642
- cloneUserToken: (params: { body?: { name?: string; description?: string } }) => Promise<CloneUserToken200Response>;
643
- /**
644
- * Transfer a user token
645
- *
646
- * @param {Object} params _Object containing the parameters for_ transferUserToken
647
- * @param {{ id?: number; from?: string; to?: string }} params.body _Optional parameter with properties_
648
- *
649
- * @returns {Promise<TransferUserToken200Response>} _Promise resolving to the transferUserToken response with properties_
650
- * - **active** (`boolean`, optional) _Whether the user token is active._
651
- * - **apps** (`{ [key: string]: any; }[]`, optional) _The list of apps this user token is assigned to._
652
- * - **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)._
653
- * - **description** (`string`, optional) _User Token description._
654
- * - **id** (`number`, optional) _User Token id._
655
- * - **name** (`string`, optional) _User Token name._
656
- *
657
- * @see {@link https://developer.quickbase.com/operation/transferUserToken} Official Quickbase API documentation
658
- */
659
- transferUserToken: (params: { body?: { id?: number; from?: string; to?: string } }) => Promise<TransferUserToken200Response>;
660
- /**
661
- * Deactivate a user token
662
- *
663
- * @param {Object} params _Object containing the parameters for_ deactivateUserToken
664
- * No parameters
665
- *
666
- * @returns {Promise<DeactivateUserToken200Response>} _Promise resolving to the deactivateUserToken response with properties_
667
- * - **id** (`number`, optional) _The user token id._
668
- *
669
- * @see {@link https://developer.quickbase.com/operation/deactivateUserToken} Official Quickbase API documentation
670
- */
671
- deactivateUserToken: (params: { }) => Promise<DeactivateUserToken200Response>;
672
- /**
673
- * Delete a user token
674
- *
675
- * @param {Object} params _Object containing the parameters for_ deleteUserToken
676
- * No parameters
677
- *
678
- * @returns {Promise<DeleteUserToken200Response>} _Promise resolving to the deleteUserToken response with properties_
679
- * - **id** (`number`, optional) _The user token id._
680
- *
681
- * @see {@link https://developer.quickbase.com/operation/deleteUserToken} Official Quickbase API documentation
682
- */
683
- deleteUserToken: (params: { }) => Promise<DeleteUserToken200Response>;
684
- /**
685
- * Download file
686
- *
687
- * @param {Object} params _Object containing the parameters for_ downloadFile
688
- * @param {string} params.tableId _Required parameter with properties_
689
- * @param {number} params.recordId _Required parameter with properties_
690
- * @param {number} params.fieldId _Required parameter with properties_
691
- * @param {number} params.versionNumber _Required parameter with properties_
692
- *
693
- * @returns {Promise<DownloadFile200Response>} _Promise resolving to the downloadFile response with properties_
694
- * - **data** (`Blob`, optional) _Type: Blob_
695
- *
696
- * @see {@link https://developer.quickbase.com/operation/downloadFile} Official Quickbase API documentation
697
- */
698
- downloadFile: (params: { tableId: string; recordId: number; fieldId: number; versionNumber: number }) => Promise<DownloadFile200Response>;
699
- /**
700
- * Delete file
701
- *
702
- * @param {Object} params _Object containing the parameters for_ deleteFile
703
- * @param {string} params.tableId _Required parameter with properties_
704
- * @param {number} params.recordId _Required parameter with properties_
705
- * @param {number} params.fieldId _Required parameter with properties_
706
- * @param {number} params.versionNumber _Required parameter with properties_
707
- *
708
- * @returns {Promise<DeleteFile200Response>} _Promise resolving to the deleteFile response with properties_
709
- * - **versionNumber** (`number`, optional) _The number of deleted version._
710
- * - **fileName** (`string`, optional) _The name of file associated with deleted version._
711
- * - **uploaded** (`string`, optional) _The timestamp when the version was originally uploaded._
712
- * - **creator** (`{ [key: string]: any; }`, optional) _The user that uploaded version._
713
- *
714
- * @see {@link https://developer.quickbase.com/operation/deleteFile} Official Quickbase API documentation
715
- */
716
- deleteFile: (params: { tableId: string; recordId: number; fieldId: number; versionNumber: number }) => Promise<DeleteFile200Response>;
717
- /**
718
- * Get users
719
- *
720
- * @param {Object} params _Object containing the parameters for_ getUsers
721
- * @param {number} params.accountId _Optional parameter with properties_
722
- * @param {GetUsersRequest} params.body _Optional parameter with properties_
723
- * - **userIds** (`string[]`, required) _Type: string[]_
724
- *
725
- * @returns {Promise<GetUsers200Response>} _Promise resolving to the getUsers response with properties_
726
- * - **users** (`{ [key: string]: any; }[]`, required) _A list of users found in an account with the given criterias_
727
- * - **metadata** (`{ [key: string]: any; }`, required) _Additional request information_
728
- *
729
- * @see {@link https://developer.quickbase.com/operation/getUsers} Official Quickbase API documentation
730
- */
731
- getUsers: (params: { accountId?: number; body?: GetUsersRequest }) => Promise<GetUsers200Response>;
732
- /**
733
- * Deny users
734
- *
735
- * @param {Object} params _Object containing the parameters for_ denyUsers
736
- * @param {number} params.accountId _Optional parameter with properties_
737
- * @param {DenyUsersRequest} params.body _Optional parameter with properties_
738
- * - **userIds** (`string[]`, required) _Type: string[]_
739
- *
740
- * @returns {Promise<DenyUsers200Response>} _Promise resolving to the denyUsers response with properties_
741
- * - **failure** (`string[]`, required) _A list of users that couldn't be denied. This also includes the ID's of users that are not valid._
742
- * - **success** (`string[]`, required) _A list of users that have successfully been denied._
743
- *
744
- * @see {@link https://developer.quickbase.com/operation/denyUsers} Official Quickbase API documentation
745
- */
746
- denyUsers: (params: { accountId?: number; body?: DenyUsersRequest }) => Promise<DenyUsers200Response>;
747
- /**
748
- * Deny and remove users from groups
749
- *
750
- * @param {Object} params _Object containing the parameters for_ denyUsersAndGroups
751
- * @param {number} params.accountId _Optional parameter with properties_
752
- * @param {boolean} params.shouldDeleteFromGroups _Required parameter with properties_
753
- * @param {DenyUsersAndGroupsRequest} params.body _Optional parameter with properties_
754
- * - **userIds** (`string[]`, required) _Type: string[]_
755
- *
756
- * @returns {Promise<DenyUsersAndGroups200Response>} _Promise resolving to the denyUsersAndGroups response with properties_
757
- * - **failure** (`string[]`, required) _A list of users that couldn't be denied. This also includes the ID's of users that are not valid._
758
- * - **success** (`string[]`, required) _A list of users that have successfully been denied._
759
- *
760
- * @see {@link https://developer.quickbase.com/operation/denyUsersAndGroups} Official Quickbase API documentation
761
- */
762
- denyUsersAndGroups: (params: { accountId?: number; shouldDeleteFromGroups: boolean; body?: DenyUsersAndGroupsRequest }) => Promise<DenyUsersAndGroups200Response>;
763
- /**
764
- * Undeny users
765
- *
766
- * @param {Object} params _Object containing the parameters for_ undenyUsers
767
- * @param {number} params.accountId _Optional parameter with properties_
768
- * @param {UndenyUsersRequest} params.body _Optional parameter with properties_
769
- * - **userIds** (`string[]`, required) _Type: string[]_
770
- *
771
- * @returns {Promise<UndenyUsers200Response>} _Promise resolving to the undenyUsers response with properties_
772
- * - **failure** (`string[]`, required) _A list of users that couldn't be undenied. This also includes the ID's of users that are not valid._
773
- * - **success** (`string[]`, required) _A list of users that have successfully been undenied._
774
- *
775
- * @see {@link https://developer.quickbase.com/operation/undenyUsers} Official Quickbase API documentation
776
- */
777
- undenyUsers: (params: { accountId?: number; body?: UndenyUsersRequest }) => Promise<UndenyUsers200Response>;
778
- /**
779
- * Add members
780
- *
781
- * @param {Object} params _Object containing the parameters for_ addMembersToGroup
782
- * @param {number} params.gid _Required parameter with properties_
783
- * @param {AddMembersToGroupRequest} params.body _Optional parameter with properties_
784
- * - **userIds** (`string[]`, required) _Type: string[]_
785
- *
786
- * @returns {Promise<AddMembersToGroup200Response>} _Promise resolving to the addMembersToGroup response with properties_
787
- * - **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._
788
- * - **success** (`string[]`, required) _A list of users that have been added to the group successfully._
789
- *
790
- * @see {@link https://developer.quickbase.com/operation/addMembersToGroup} Official Quickbase API documentation
791
- */
792
- addMembersToGroup: (params: { gid: number; body?: AddMembersToGroupRequest }) => Promise<AddMembersToGroup200Response>;
793
- /**
794
- * Remove members
795
- *
796
- * @param {Object} params _Object containing the parameters for_ removeMembersFromGroup
797
- * @param {number} params.gid _Required parameter with properties_
798
- * @param {RemoveMembersFromGroupRequest} params.body _Optional parameter with properties_
799
- * - **userIds** (`string[]`, required) _Type: string[]_
800
- *
801
- * @returns {Promise<RemoveMembersFromGroup200Response>} _Promise resolving to the removeMembersFromGroup response with properties_
802
- * - **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._
803
- * - **success** (`string[]`, required) _A list of users that have been removed from the group successfully._
804
- *
805
- * @see {@link https://developer.quickbase.com/operation/removeMembersFromGroup} Official Quickbase API documentation
806
- */
807
- removeMembersFromGroup: (params: { gid: number; body?: RemoveMembersFromGroupRequest }) => Promise<RemoveMembersFromGroup200Response>;
808
- /**
809
- * Add managers
810
- *
811
- * @param {Object} params _Object containing the parameters for_ addManagersToGroup
812
- * @param {number} params.gid _Required parameter with properties_
813
- * @param {AddManagersToGroupRequest} params.body _Optional parameter with properties_
814
- * - **userIds** (`string[]`, required) _Type: string[]_
815
- *
816
- * @returns {Promise<AddManagersToGroup200Response>} _Promise resolving to the addManagersToGroup response with properties_
817
- * - **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._
818
- * - **success** (`string[]`, required) _A list of users that have been added to the group successfully._
819
- *
820
- * @see {@link https://developer.quickbase.com/operation/addManagersToGroup} Official Quickbase API documentation
821
- */
822
- addManagersToGroup: (params: { gid: number; body?: AddManagersToGroupRequest }) => Promise<AddManagersToGroup200Response>;
823
- /**
824
- * Remove managers
825
- *
826
- * @param {Object} params _Object containing the parameters for_ removeManagersFromGroup
827
- * @param {number} params.gid _Required parameter with properties_
828
- * @param {RemoveManagersFromGroupRequest} params.body _Optional parameter with properties_
829
- * - **userIds** (`string[]`, required) _Type: string[]_
830
- *
831
- * @returns {Promise<RemoveManagersFromGroup200Response>} _Promise resolving to the removeManagersFromGroup response with properties_
832
- * - **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._
833
- * - **success** (`string[]`, required) _A list of users that have been removed from the group successfully._
834
- *
835
- * @see {@link https://developer.quickbase.com/operation/removeManagersFromGroup} Official Quickbase API documentation
836
- */
837
- removeManagersFromGroup: (params: { gid: number; body?: RemoveManagersFromGroupRequest }) => Promise<RemoveManagersFromGroup200Response>;
838
- /**
839
- * Add child groups
840
- *
841
- * @param {Object} params _Object containing the parameters for_ addSubgroupsToGroup
842
- * @param {number} params.gid _Required parameter with properties_
843
- * @param {AddSubgroupsToGroupRequest} params.body _Optional parameter with properties_
844
- * - **userIds** (`string[]`, required) _Type: string[]_
845
- *
846
- * @returns {Promise<AddSubgroupsToGroup200Response>} _Promise resolving to the addSubgroupsToGroup response with properties_
847
- * - **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._
848
- * - **success** (`string[]`, required) _A list of child groups that have been added to the group successfully._
849
- *
850
- * @see {@link https://developer.quickbase.com/operation/addSubgroupsToGroup} Official Quickbase API documentation
851
- */
852
- addSubgroupsToGroup: (params: { gid: number; body?: AddSubgroupsToGroupRequest }) => Promise<AddSubgroupsToGroup200Response>;
853
- /**
854
- * Remove child groups
855
- *
856
- * @param {Object} params _Object containing the parameters for_ removeSubgroupsFromGroup
857
- * @param {number} params.gid _Required parameter with properties_
858
- * @param {RemoveSubgroupsFromGroupRequest} params.body _Optional parameter with properties_
859
- * - **userIds** (`string[]`, required) _Type: string[]_
860
- *
861
- * @returns {Promise<RemoveSubgroupsFromGroup200Response>} _Promise resolving to the removeSubgroupsFromGroup response with properties_
862
- * - **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._
863
- * - **success** (`string[]`, required) _A list of child groups that have been removed from the group successfully._
864
- *
865
- * @see {@link https://developer.quickbase.com/operation/removeSubgroupsFromGroup} Official Quickbase API documentation
866
- */
867
- removeSubgroupsFromGroup: (params: { gid: number; body?: RemoveSubgroupsFromGroupRequest }) => Promise<RemoveSubgroupsFromGroup200Response>;
868
- /**
869
- * Get audit logs
870
- *
871
- * @param {Object} params _Object containing the parameters for_ audit
872
- * @param {{ nextToken?: string; numRows?: number; queryId?: string; date?: string; topics?: string[] }} params.body _Optional parameter with properties_
873
- *
874
- * @returns {Promise<Audit200Response>} _Promise resolving to the audit response with properties_
875
- * - **queryId** (`string`, required) _Query id of the requested audit log._
876
- * - **events** (`{ [key: string]: any; }[]`, optional) _All events of the audit log._
877
- * - **nextToken** (`string`, optional) _Token to fetch the next 1000 logs._
878
- *
879
- * @see {@link https://developer.quickbase.com/operation/audit} Official Quickbase API documentation
880
- */
881
- audit: (params: { body?: { nextToken?: string; numRows?: number; queryId?: string; date?: string; topics?: string[] } }) => Promise<Audit200Response>;
882
- /**
883
- * Get read summaries
884
- *
885
- * @param {Object} params _Object containing the parameters for_ platformAnalyticReads
886
- * @param {string} params.day _Optional parameter with properties_
887
- *
888
- * @returns {Promise<PlatformAnalyticReads200Response>} _Promise resolving to the platformAnalyticReads response with properties_
889
- * - **date** (`Date`, required) _The date of the requested summary._
890
- * - **reads** (`{ [key: string]: any; }`, required) _Total reads for the specified date._
891
- *
892
- * @see {@link https://developer.quickbase.com/operation/platformAnalyticReads} Official Quickbase API documentation
893
- */
894
- platformAnalyticReads: (params: { day?: string }) => Promise<PlatformAnalyticReads200Response>;
895
- /**
896
- * Get event summaries
897
- *
898
- * @param {Object} params _Object containing the parameters for_ platformAnalyticEventSummaries
899
- * @param {number} params.accountId _Optional parameter with properties_
900
- * @param {{ start?: string; end?: string; groupBy?: string; nextToken?: string; where?: { id?: string; type?: string }[] }} params.body _Optional parameter with properties_
901
- *
902
- * @returns {Promise<PlatformAnalyticEventSummaries200Response>} _Promise resolving to the platformAnalyticEventSummaries response with properties_
903
- * - **accountId** (`string`, required) _The ID of the account the events are associated with._
904
- * - **start** (`Date`, required) _The start date and time of the requested summaries in ISO 8601 time format._
905
- * - **end** (`Date`, required) _The end date and time of the requested summaries in ISO 8601 time format._
906
- * - **groupBy** (`PlatformAnalyticEventSummaries200ResponseGroupByEnum`, required) _How the events should be grouped._
907
- * - **where** (`PlatformAnalyticEventSummaries200ResponseWhereInner[]`, required) _Type: PlatformAnalyticEventSummaries200ResponseWhereInner[]_
908
- * - **results** (`PlatformAnalyticEventSummaries200ResponseResultsInner[]`, required) _An array of objects that contains Application/User information and an events object with summaries by event type._
909
- * - **metadata** (`PlatformAnalyticEventSummaries200ResponseMetadata`, optional) _Type: PlatformAnalyticEventSummaries200ResponseMetadata_
910
- * - **totals** (`PlatformAnalyticEventSummaries200ResponseTotals`, optional) _Type: PlatformAnalyticEventSummaries200ResponseTotals_
911
- *
912
- * @see {@link https://developer.quickbase.com/operation/platformAnalyticEventSummaries} Official Quickbase API documentation
913
- */
914
- platformAnalyticEventSummaries: (params: { accountId?: number; body?: { start?: string; end?: string; groupBy?: string; nextToken?: string; where?: { id?: string; type?: string }[] } }) => Promise<PlatformAnalyticEventSummaries200Response>;
915
- /**
916
- * Export a solution
917
- *
918
- * @param {Object} params _Object containing the parameters for_ exportSolution
919
- * @param {string} params.solutionId _Required parameter with properties_
920
- * @param {string} params.qBLVersion _Optional parameter with properties_
921
- *
922
- * @returns {Promise<ExportSolution200Response>} _Promise resolving to the exportSolution response with properties_
923
- * - **content** (`string`, optional) _Type: string_
924
- *
925
- * @see {@link https://developer.quickbase.com/operation/exportSolution} Official Quickbase API documentation
926
- */
927
- exportSolution: (params: { solutionId: string; qBLVersion?: string }) => Promise<ExportSolution200Response>;
928
- /**
929
- * Update a solution
930
- *
931
- * @param {Object} params _Object containing the parameters for_ updateSolution
932
- * @param {string} params.solutionId _Required parameter with properties_
933
- * @param {any} params.body _Optional parameter with properties_
934
- * @param {boolean} params.xQBLErrorsAsSuccess _Optional parameter with properties_
935
- *
936
- * @returns {Promise<UpdateSolution200Response>} _Promise resolving to the updateSolution response_
937
- *
938
- * @see {@link https://developer.quickbase.com/operation/updateSolution} Official Quickbase API documentation
939
- */
940
- updateSolution: (params: { solutionId: string; body?: any; xQBLErrorsAsSuccess?: boolean }) => Promise<UpdateSolution200Response>;
941
- /**
942
- * Create a solution
943
- *
944
- * @param {Object} params _Object containing the parameters for_ createSolution
945
- * @param {any} params.body _Optional parameter with properties_
946
- * @param {boolean} params.xQBLErrorsAsSuccess _Optional parameter with properties_
947
- *
948
- * @returns {Promise<CreateSolution200Response>} _Promise resolving to the createSolution response_
949
- *
950
- * @see {@link https://developer.quickbase.com/operation/createSolution} Official Quickbase API documentation
951
- */
952
- createSolution: (params: { body?: any; xQBLErrorsAsSuccess?: boolean }) => Promise<CreateSolution200Response>;
953
- /**
954
- * Export solution to record
955
- *
956
- * @param {Object} params _Object containing the parameters for_ exportSolutionToRecord
957
- * @param {string} params.solutionId _Required parameter with properties_
958
- * @param {string} params.tableId _Required parameter with properties_
959
- * @param {number} params.fieldId _Required parameter with properties_
960
- * @param {boolean} params.xQBLErrorsAsSuccess _Optional parameter with properties_
961
- * @param {string} params.qBLVersion _Optional parameter with properties_
962
- *
963
- * @returns {Promise<ExportSolutionToRecord200Response>} _Promise resolving to the exportSolutionToRecord response_
964
- *
965
- * @see {@link https://developer.quickbase.com/operation/exportSolutionToRecord} Official Quickbase API documentation
966
- */
967
- exportSolutionToRecord: (params: { solutionId: string; tableId: string; fieldId: number; xQBLErrorsAsSuccess?: boolean; qBLVersion?: string }) => Promise<ExportSolutionToRecord200Response>;
968
- /**
969
- * Create solution from record
970
- *
971
- * @param {Object} params _Object containing the parameters for_ createSolutionFromRecord
972
- * @param {string} params.tableId _Required parameter with properties_
973
- * @param {number} params.fieldId _Required parameter with properties_
974
- * @param {number} params.recordId _Required parameter with properties_
975
- * @param {boolean} params.xQBLErrorsAsSuccess _Optional parameter with properties_
976
- *
977
- * @returns {Promise<CreateSolutionFromRecord200Response>} _Promise resolving to the createSolutionFromRecord response_
978
- *
979
- * @see {@link https://developer.quickbase.com/operation/createSolutionFromRecord} Official Quickbase API documentation
980
- */
981
- createSolutionFromRecord: (params: { tableId: string; fieldId: number; recordId: number; xQBLErrorsAsSuccess?: boolean }) => Promise<CreateSolutionFromRecord200Response>;
982
- /**
983
- * Update solution from record
984
- *
985
- * @param {Object} params _Object containing the parameters for_ updateSolutionToRecord
986
- * @param {string} params.solutionId _Required parameter with properties_
987
- * @param {string} params.tableId _Required parameter with properties_
988
- * @param {number} params.fieldId _Required parameter with properties_
989
- * @param {number} params.recordId _Required parameter with properties_
990
- * @param {boolean} params.xQBLErrorsAsSuccess _Optional parameter with properties_
991
- *
992
- * @returns {Promise<UpdateSolutionToRecord200Response>} _Promise resolving to the updateSolutionToRecord response_
993
- *
994
- * @see {@link https://developer.quickbase.com/operation/updateSolutionToRecord} Official Quickbase API documentation
995
- */
996
- updateSolutionToRecord: (params: { solutionId: string; tableId: string; fieldId: number; recordId: number; xQBLErrorsAsSuccess?: boolean }) => Promise<UpdateSolutionToRecord200Response>;
997
- /**
998
- * List solution changes
999
- *
1000
- * @param {Object} params _Object containing the parameters for_ changesetSolution
1001
- * @param {string} params.solutionId _Required parameter with properties_
1002
- * @param {any} params.body _Optional parameter with properties_
1003
- * @param {boolean} params.xQBLErrorsAsSuccess _Optional parameter with properties_
1004
- *
1005
- * @returns {Promise<ChangesetSolution200Response>} _Promise resolving to the changesetSolution response_
1006
- *
1007
- * @see {@link https://developer.quickbase.com/operation/changesetSolution} Official Quickbase API documentation
1008
- */
1009
- changesetSolution: (params: { solutionId: string; body?: any; xQBLErrorsAsSuccess?: boolean }) => Promise<ChangesetSolution200Response>;
1010
- /**
1011
- * List solution changes from record
1012
- *
1013
- * @param {Object} params _Object containing the parameters for_ changesetSolutionFromRecord
1014
- * @param {string} params.solutionId _Required parameter with properties_
1015
- * @param {string} params.tableId _Required parameter with properties_
1016
- * @param {number} params.fieldId _Required parameter with properties_
1017
- * @param {number} params.recordId _Required parameter with properties_
1018
- * @param {boolean} params.xQBLErrorsAsSuccess _Optional parameter with properties_
1019
- *
1020
- * @returns {Promise<ChangesetSolutionFromRecord200Response>} _Promise resolving to the changesetSolutionFromRecord response_
1021
- *
1022
- * @see {@link https://developer.quickbase.com/operation/changesetSolutionFromRecord} Official Quickbase API documentation
1023
- */
1024
- changesetSolutionFromRecord: (params: { solutionId: string; tableId: string; fieldId: number; recordId: number; xQBLErrorsAsSuccess?: boolean }) => Promise<ChangesetSolutionFromRecord200Response>;
1025
- /**
1026
- * Generate a document
1027
- *
1028
- * @param {Object} params _Object containing the parameters for_ generateDocument
1029
- * @param {number} params.templateId _Required parameter with properties_
1030
- * @param {string} params.tableId _Required parameter with properties_
1031
- * @param {number} params.recordId _Optional parameter with properties_
1032
- * @param {string} params.filename _Required parameter with properties_
1033
- * @param {string} params.accept _Optional parameter with properties_
1034
- * @param {string} params.format _Optional parameter with properties_
1035
- * @param {string} params.margin _Optional parameter with properties_
1036
- * @param {string} params.unit _Optional parameter with properties_
1037
- * @param {string} params.pageSize _Optional parameter with properties_
1038
- * @param {string} params.orientation _Optional parameter with properties_
1039
- * @param {string} params.realm _Optional parameter with properties_
1040
- *
1041
- * @returns {Promise<GenerateDocument200Response>} _Promise resolving to the generateDocument response with properties_
1042
- * - **fileName** (`string`, optional) _The file name._
1043
- * - **data** (`string`, optional) _Base64 encoded file content._
1044
- * - **contentType** (`string`, optional) _The document content type._
1045
- *
1046
- * @see {@link https://developer.quickbase.com/operation/generateDocument} Official Quickbase API documentation
1047
- */
1048
- generateDocument: (params: { templateId: number; tableId: string; recordId?: number; filename: string; accept?: string; format?: string; margin?: string; unit?: string; pageSize?: string; orientation?: string; realm?: string }) => Promise<GenerateDocument200Response>;
1049
- }