quickbase-js 0.1.0-beta.12 → 0.1.0-beta.14

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