quickbase-js 0.1.0-beta.8 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +252 -126
- package/dist/esm/quickbase.d.ts +2725 -2689
- package/dist/esm/quickbase.js +1763 -3524
- package/dist/esm/quickbase.js.map +1 -1
- package/dist/esm/quickbase.min.js +1 -1
- package/dist/esm/quickbase.min.js.map +1 -1
- package/dist/umd/quickbase.umd.js +1762 -3706
- package/dist/umd/quickbase.umd.js.map +1 -1
- package/dist/umd/quickbase.umd.min.js +1 -1
- package/dist/umd/quickbase.umd.min.js.map +1 -1
- package/package.json +27 -12
- package/CHANGELOG.md +0 -155
- package/build-common.js +0 -131
- package/build-esm.js +0 -71
- package/build-umd.js +0 -69
- package/examples/quicbase-jsCDN.html +0 -36
- package/examples/react.js +0 -48
- package/examples/vanillajs.html +0 -47
- package/open-api/fix-spec-main.ts +0 -97
- package/open-api/generate-override-report.ts +0 -214
- package/open-api/generate-unified-interface.ts +0 -256
- package/open-api/output/override-report.html +0 -11
- package/open-api/output/override-report.json +0 -14395
- package/open-api/output/quickbase-fixed.json +0 -11191
- package/open-api/regenerate-client.ts +0 -116
- package/open-api/schema/enhance-general.ts +0 -100
- package/open-api/schema/fix-arrays.ts +0 -69
- package/open-api/schema/tags/apps.ts +0 -90
- package/open-api/schema/tags/fields.ts +0 -471
- package/open-api/schema/tags/groups.ts +0 -51
- package/open-api/schema/tags/index.ts +0 -66
- package/open-api/schema/tags/records.ts +0 -115
- package/open-api/schema/tags/tables.ts +0 -211
- package/open-api/schema/tags/users.ts +0 -47
- package/open-api/types/spec.ts +0 -42
- package/open-api/utils/infer-schema.ts +0 -40
- package/open-api/utils/naming.ts +0 -10
- package/playwright.config.ts +0 -37
- package/rollup.config.js +0 -114
- package/specs/QuickBase_RESTful_API_2025-03-04T06_22_39.725Z.json +0 -46878
- package/specs/split/apps.json +0 -1315
- package/specs/split/auth.json +0 -191
- package/specs/split/fields.json +0 -3869
- package/specs/split/records.json +0 -754
- package/specs/split/reports.json +0 -619
- package/specs/split/tables.json +0 -1605
- package/src/RateLimitError.ts +0 -12
- package/src/ThrottleBucket.ts +0 -36
- package/src/generated-unified/QuickbaseClient.ts +0 -359
- package/src/generated-unified/missing-types-report.json +0 -3
- package/src/index.ts +0 -1
- package/src/invokeMethod.ts +0 -357
- package/src/quickbaseClient.ts +0 -244
- package/src/tokenCache.ts +0 -51
- package/src/utils.ts +0 -7
- package/test-esm.js +0 -1
- package/test-results.json +0 -2050
- package/test-umd.js +0 -1
- package/test.ts +0 -1
- package/tests/playwright/qb/auth/cacheSwitching.test.ts +0 -159
- package/tests/playwright/qb/auth/fetchTempToken401.test.ts +0 -219
- package/tests/playwright/qb/auth/getAppWithTempToken.test.ts +0 -162
- package/tests/playwright/qb/auth/getAppWithUserToken.test.ts +0 -153
- package/tests/playwright/qb/auth/getTempToken.test.ts +0 -152
- package/tests/playwright/qb/auth/tempTokenPrefetch.test.ts +0 -179
- package/tests/playwright/qb/auth/tempTokenRenewal.test.ts +0 -133
- package/tests/setup.ts +0 -53
- package/tests/vitest/qb/apps/copyApp.test.ts +0 -76
- package/tests/vitest/qb/apps/createApp.test.ts +0 -64
- package/tests/vitest/qb/apps/deleteApp.test.ts +0 -76
- package/tests/vitest/qb/apps/getApp.test.ts +0 -44
- package/tests/vitest/qb/apps/getAppEvents.test.ts +0 -67
- package/tests/vitest/qb/apps/updateApp.test.ts +0 -58
- package/tests/vitest/qb/auth/retryUserToken401.test.ts +0 -56
- package/tests/vitest/qb/fields/createField.test.ts +0 -77
- package/tests/vitest/qb/fields/deleteFields.test.ts +0 -83
- package/tests/vitest/qb/fields/getField.test.ts +0 -85
- package/tests/vitest/qb/fields/getFieldUsage.test.ts +0 -174
- package/tests/vitest/qb/fields/getFields.test.ts +0 -232
- package/tests/vitest/qb/fields/getFieldsUsage.test.ts +0 -77
- package/tests/vitest/qb/fields/updateField.test.ts +0 -93
- package/tests/vitest/qb/index.ts +0 -29
- package/tests/vitest/qb/records/deleteRecords.test.ts +0 -110
- package/tests/vitest/qb/records/runQuery.test.ts +0 -146
- package/tests/vitest/qb/records/upsert.test.ts +0 -102
- package/tests/vitest/qb/tables/createTable.test.ts +0 -55
- package/tests/vitest/qb/tables/deleteTable.test.ts +0 -50
- package/tests/vitest/qb/tables/getAppTables.test.ts +0 -46
- package/tests/vitest/qb/tables/getRelationships.test.ts +0 -80
- package/tests/vitest/qb/tables/getTable.test.ts +0 -26
- package/tests/vitest/qb/tables/updateRelationship.test.ts +0 -277
- package/tests/vitest/qb/tables/updateTable.test.ts +0 -48
- package/tests/vitest/unit/apps/copyApp.test.ts +0 -488
- package/tests/vitest/unit/apps/createApp.test.ts +0 -186
- package/tests/vitest/unit/apps/deleteApp.test.ts +0 -216
- package/tests/vitest/unit/apps/getApp.test.ts +0 -128
- package/tests/vitest/unit/apps/getAppEvents.test.ts +0 -193
- package/tests/vitest/unit/apps/updateApp.test.ts +0 -381
- package/tests/vitest/unit/auth/fetchTempToken401.test.ts +0 -62
- package/tests/vitest/unit/auth/getTempToken.test.ts +0 -95
- package/tests/vitest/unit/auth/retryTempToken401.test.ts +0 -113
- package/tests/vitest/unit/auth/retryTempTokenTwo401.test.ts +0 -81
- package/tests/vitest/unit/auth/retryUserToken401.test.ts +0 -56
- package/tests/vitest/unit/fields/createField.test.ts +0 -387
- package/tests/vitest/unit/fields/deleteFields.test.ts +0 -141
- package/tests/vitest/unit/fields/getField.test.ts +0 -189
- package/tests/vitest/unit/fields/getFieldUsage.test.ts +0 -166
- package/tests/vitest/unit/fields/getFields.test.ts +0 -122
- package/tests/vitest/unit/fields/getFieldsUsage.test.ts +0 -160
- package/tests/vitest/unit/fields/updateField.test.ts +0 -280
- package/tests/vitest/unit/index.ts +0 -33
- package/tests/vitest/unit/rateLimit.test.ts +0 -189
- package/tests/vitest/unit/records/deleteRecords.test.ts +0 -112
- package/tests/vitest/unit/records/runQuery.test.ts +0 -102
- package/tests/vitest/unit/records/upsert.test.ts +0 -234
- package/tests/vitest/unit/tables/createTable.test.ts +0 -70
- package/tests/vitest/unit/tables/deleteTable.test.ts +0 -77
- package/tests/vitest/unit/tables/getAppTables.test.ts +0 -85
- package/tests/vitest/unit/tables/getRelationships.test.ts +0 -259
- package/tests/vitest/unit/tables/getTable.test.ts +0 -233
- package/tests/vitest/unit/tables/updateRelationship.test.ts +0 -305
- package/tests/vitest/unit/tables/updateTable.test.ts +0 -80
- package/tests/vitest/unit/tokenLifespan.test.ts +0 -138
- package/tests/vitest/unit/umd.test.ts +0 -8
- package/text.txt +0 -104
- package/tools/log-gen.ts +0 -235
- package/tools/log-gen.yaml +0 -4982
- package/tools/openapi-jars/openapi-generator-cli-7.12.0.jar +0 -0
- package/tsconfig.build.json +0 -17
- package/tsconfig.json +0 -32
- package/versionrc.json +0 -9
- package/vitest.config.ts +0 -27
package/src/RateLimitError.ts
DELETED
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
// src/RateLimitError.ts
|
|
2
|
-
export class RateLimitError extends Error {
|
|
3
|
-
public readonly status: number;
|
|
4
|
-
public readonly retryAfter?: number;
|
|
5
|
-
|
|
6
|
-
constructor(message: string, status: number, retryAfter?: number) {
|
|
7
|
-
super(message);
|
|
8
|
-
this.name = "RateLimitError";
|
|
9
|
-
this.status = status;
|
|
10
|
-
this.retryAfter = retryAfter; // Seconds from Retry-After header, if present
|
|
11
|
-
}
|
|
12
|
-
}
|
package/src/ThrottleBucket.ts
DELETED
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
// src/TokenBucket.ts
|
|
2
|
-
export class ThrottleBucket {
|
|
3
|
-
private tokens: number;
|
|
4
|
-
private maxTokens: number;
|
|
5
|
-
private refillRate: number; // Tokens per second
|
|
6
|
-
private lastRefill: number;
|
|
7
|
-
|
|
8
|
-
constructor(rate: number, burst: number) {
|
|
9
|
-
this.tokens = burst; // Start with full burst capacity
|
|
10
|
-
this.maxTokens = burst;
|
|
11
|
-
this.refillRate = rate;
|
|
12
|
-
this.lastRefill = Date.now();
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
// Refill tokens based on elapsed time
|
|
16
|
-
private refill(): void {
|
|
17
|
-
const now = Date.now();
|
|
18
|
-
const elapsed = (now - this.lastRefill) / 1000; // Seconds elapsed
|
|
19
|
-
const newTokens = elapsed * this.refillRate;
|
|
20
|
-
this.tokens = Math.min(this.maxTokens, this.tokens + newTokens);
|
|
21
|
-
this.lastRefill = now;
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
// Acquire a token, waiting if necessary
|
|
25
|
-
async acquire(): Promise<void> {
|
|
26
|
-
this.refill();
|
|
27
|
-
if (this.tokens >= 1) {
|
|
28
|
-
this.tokens -= 1;
|
|
29
|
-
return;
|
|
30
|
-
}
|
|
31
|
-
const waitTime = ((1 - this.tokens) / this.refillRate) * 1000; // ms until next token
|
|
32
|
-
await new Promise((resolve) => setTimeout(resolve, waitTime));
|
|
33
|
-
this.refill();
|
|
34
|
-
this.tokens -= 1;
|
|
35
|
-
}
|
|
36
|
-
}
|
|
@@ -1,359 +0,0 @@
|
|
|
1
|
-
// Generated on 2025-03-18T03:01:28.172Z
|
|
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
|
-
* @param params - Parameters for createApp
|
|
8
|
-
* @returns Promise resolving to createApp response
|
|
9
|
-
*/
|
|
10
|
-
createApp: (params: { body?: CreateAppRequest }) => Promise<CreateApp200Response>;
|
|
11
|
-
/**
|
|
12
|
-
* Get an app
|
|
13
|
-
* @param params - Parameters for getApp
|
|
14
|
-
* @returns Promise resolving to getApp response
|
|
15
|
-
*/
|
|
16
|
-
getApp: (params: { appId: string }) => Promise<GetApp200Response>;
|
|
17
|
-
/**
|
|
18
|
-
* Update an app
|
|
19
|
-
* @param params - Parameters for updateApp
|
|
20
|
-
* @returns Promise resolving to updateApp response
|
|
21
|
-
*/
|
|
22
|
-
updateApp: (params: { appId: string; body?: UpdateAppRequest }) => Promise<UpdateApp200Response>;
|
|
23
|
-
/**
|
|
24
|
-
* Delete an app
|
|
25
|
-
* @param params - Parameters for deleteApp
|
|
26
|
-
* @returns Promise resolving to deleteApp response
|
|
27
|
-
*/
|
|
28
|
-
deleteApp: (params: { appId: string; body?: DeleteAppRequest }) => Promise<DeleteApp200Response>;
|
|
29
|
-
/**
|
|
30
|
-
* Get app events
|
|
31
|
-
* @param params - Parameters for getAppEvents
|
|
32
|
-
* @returns Promise resolving to getAppEvents response
|
|
33
|
-
*/
|
|
34
|
-
getAppEvents: (params: { appId: string }) => Promise<GetAppEvents200Response>;
|
|
35
|
-
/**
|
|
36
|
-
* Copy an app
|
|
37
|
-
* @param params - Parameters for copyApp
|
|
38
|
-
* @returns Promise resolving to copyApp response
|
|
39
|
-
*/
|
|
40
|
-
copyApp: (params: { appId: string; body?: CopyAppRequest }) => Promise<CopyApp200Response>;
|
|
41
|
-
/**
|
|
42
|
-
* Create a table
|
|
43
|
-
* @param params - Parameters for createTable
|
|
44
|
-
* @returns Promise resolving to createTable response
|
|
45
|
-
*/
|
|
46
|
-
createTable: (params: { appId: string; body?: CreateTableRequest }) => Promise<CreateTable200Response>;
|
|
47
|
-
/**
|
|
48
|
-
* Get tables for an app
|
|
49
|
-
* @param params - Parameters for getAppTables
|
|
50
|
-
* @returns Promise resolving to getAppTables response
|
|
51
|
-
*/
|
|
52
|
-
getAppTables: (params: { appId: string }) => Promise<GetAppTables200Response>;
|
|
53
|
-
/**
|
|
54
|
-
* Get a table
|
|
55
|
-
* @param params - Parameters for getTable
|
|
56
|
-
* @returns Promise resolving to getTable response
|
|
57
|
-
*/
|
|
58
|
-
getTable: (params: { appId: string; tableId: string }) => Promise<GetTable200Response>;
|
|
59
|
-
/**
|
|
60
|
-
* Update a table
|
|
61
|
-
* @param params - Parameters for updateTable
|
|
62
|
-
* @returns Promise resolving to updateTable response
|
|
63
|
-
*/
|
|
64
|
-
updateTable: (params: { appId: string; tableId: string; body?: UpdateTableRequest }) => Promise<UpdateTable200Response>;
|
|
65
|
-
/**
|
|
66
|
-
* Delete a table
|
|
67
|
-
* @param params - Parameters for deleteTable
|
|
68
|
-
* @returns Promise resolving to deleteTable response
|
|
69
|
-
*/
|
|
70
|
-
deleteTable: (params: { appId: string; tableId: string }) => Promise<DeleteTable200Response>;
|
|
71
|
-
/**
|
|
72
|
-
* Get all relationships
|
|
73
|
-
* @param params - Parameters for getRelationships
|
|
74
|
-
* @returns Promise resolving to getRelationships response
|
|
75
|
-
*/
|
|
76
|
-
getRelationships: (params: { skip?: number; tableId: string }) => Promise<GetRelationships200Response>;
|
|
77
|
-
/**
|
|
78
|
-
* Create a relationship
|
|
79
|
-
* @param params - Parameters for createRelationship
|
|
80
|
-
* @returns Promise resolving to createRelationship response
|
|
81
|
-
*/
|
|
82
|
-
createRelationship: (params: { tableId: string; body?: CreateRelationshipRequest }) => Promise<CreateRelationship200Response>;
|
|
83
|
-
/**
|
|
84
|
-
* Update a relationship
|
|
85
|
-
* @param params - Parameters for updateRelationship
|
|
86
|
-
* @returns Promise resolving to updateRelationship response
|
|
87
|
-
*/
|
|
88
|
-
updateRelationship: (params: { tableId: string; relationshipId: number; body?: UpdateRelationshipRequest }) => Promise<UpdateRelationship200Response>;
|
|
89
|
-
/**
|
|
90
|
-
* Delete a relationship
|
|
91
|
-
* @param params - Parameters for deleteRelationship
|
|
92
|
-
* @returns Promise resolving to deleteRelationship response
|
|
93
|
-
*/
|
|
94
|
-
deleteRelationship: (params: { tableId: string; relationshipId: number }) => Promise<DeleteRelationship200Response>;
|
|
95
|
-
/**
|
|
96
|
-
* Get reports for a table
|
|
97
|
-
* @param params - Parameters for getTableReports
|
|
98
|
-
* @returns Promise resolving to getTableReports response
|
|
99
|
-
*/
|
|
100
|
-
getTableReports: (params: { tableId: string }) => Promise<GetTableReports200Response>;
|
|
101
|
-
/**
|
|
102
|
-
* Get a report
|
|
103
|
-
* @param params - Parameters for getReport
|
|
104
|
-
* @returns Promise resolving to getReport response
|
|
105
|
-
*/
|
|
106
|
-
getReport: (params: { tableId: string; reportId: string }) => Promise<GetReport200Response>;
|
|
107
|
-
/**
|
|
108
|
-
* Run a report
|
|
109
|
-
* @param params - Parameters for runReport
|
|
110
|
-
* @returns Promise resolving to runReport response
|
|
111
|
-
*/
|
|
112
|
-
runReport: (params: { tableId: string; skip?: number; top?: number; reportId: string; body?: any }) => Promise<RunReport200Response>;
|
|
113
|
-
/**
|
|
114
|
-
* Get fields for a table
|
|
115
|
-
* @param params - Parameters for getFields
|
|
116
|
-
* @returns Promise resolving to getFields response
|
|
117
|
-
*/
|
|
118
|
-
getFields: (params: { tableId: string; includeFieldPerms?: boolean }) => Promise<GetFields200Response>;
|
|
119
|
-
/**
|
|
120
|
-
* Create a field
|
|
121
|
-
* @param params - Parameters for createField
|
|
122
|
-
* @returns Promise resolving to createField response
|
|
123
|
-
*/
|
|
124
|
-
createField: (params: { tableId: string; body?: CreateFieldRequest }) => Promise<CreateField200Response>;
|
|
125
|
-
/**
|
|
126
|
-
* Delete field(s)
|
|
127
|
-
* @param params - Parameters for deleteFields
|
|
128
|
-
* @returns Promise resolving to deleteFields response
|
|
129
|
-
*/
|
|
130
|
-
deleteFields: (params: { tableId: string; body?: DeleteFieldsRequest }) => Promise<DeleteFields200Response>;
|
|
131
|
-
/**
|
|
132
|
-
* Get field
|
|
133
|
-
* @param params - Parameters for getField
|
|
134
|
-
* @returns Promise resolving to getField response
|
|
135
|
-
*/
|
|
136
|
-
getField: (params: { tableId: string; includeFieldPerms?: boolean; fieldId: number }) => Promise<GetField200Response>;
|
|
137
|
-
/**
|
|
138
|
-
* Update a field
|
|
139
|
-
* @param params - Parameters for updateField
|
|
140
|
-
* @returns Promise resolving to updateField response
|
|
141
|
-
*/
|
|
142
|
-
updateField: (params: { tableId: string; fieldId: number; body?: UpdateFieldRequest }) => Promise<UpdateField200Response>;
|
|
143
|
-
/**
|
|
144
|
-
* Get usage for all fields
|
|
145
|
-
* @param params - Parameters for getFieldsUsage
|
|
146
|
-
* @returns Promise resolving to getFieldsUsage response
|
|
147
|
-
*/
|
|
148
|
-
getFieldsUsage: (params: { tableId: string; skip?: number; top?: number }) => Promise<GetFieldsUsage200Response>;
|
|
149
|
-
/**
|
|
150
|
-
* Get usage for a field
|
|
151
|
-
* @param params - Parameters for getFieldUsage
|
|
152
|
-
* @returns Promise resolving to getFieldUsage response
|
|
153
|
-
*/
|
|
154
|
-
getFieldUsage: (params: { tableId: string; fieldId: number }) => Promise<GetFieldUsage200Response>;
|
|
155
|
-
/**
|
|
156
|
-
* Run a formula
|
|
157
|
-
* @param params - Parameters for runFormula
|
|
158
|
-
* @returns Promise resolving to runFormula response
|
|
159
|
-
*/
|
|
160
|
-
runFormula: (params: { body?: { formula?: string; rid?: number; from?: string } }) => Promise<RunFormula200Response>;
|
|
161
|
-
/**
|
|
162
|
-
* Insert/Update record(s)
|
|
163
|
-
* @param params - Parameters for upsert
|
|
164
|
-
* @returns Promise resolving to upsert response
|
|
165
|
-
*/
|
|
166
|
-
upsert: (params: { body?: UpsertRequest }) => Promise<Upsert200Response | Upsert207Response>;
|
|
167
|
-
/**
|
|
168
|
-
* Delete record(s)
|
|
169
|
-
* @param params - Parameters for deleteRecords
|
|
170
|
-
* @returns Promise resolving to deleteRecords response
|
|
171
|
-
*/
|
|
172
|
-
deleteRecords: (params: { body?: DeleteRecordsRequest }) => Promise<DeleteRecords200Response>;
|
|
173
|
-
/**
|
|
174
|
-
* Query for data
|
|
175
|
-
* @param params - Parameters for runQuery
|
|
176
|
-
* @returns Promise resolving to runQuery response
|
|
177
|
-
*/
|
|
178
|
-
runQuery: (params: { body?: RunQueryRequest }) => Promise<RunQuery200Response>;
|
|
179
|
-
/**
|
|
180
|
-
* Get a temporary token for a dbid
|
|
181
|
-
* @param params - Parameters for getTempTokenDBID
|
|
182
|
-
* @returns Promise resolving to getTempTokenDBID response
|
|
183
|
-
*/
|
|
184
|
-
getTempTokenDBID: (params: { dbid: string; qBAppToken?: string }) => Promise<GetTempTokenDBID200Response>;
|
|
185
|
-
/**
|
|
186
|
-
* Exchange an SSO token
|
|
187
|
-
* @param params - Parameters for exchangeSsoToken
|
|
188
|
-
* @returns Promise resolving to exchangeSsoToken response
|
|
189
|
-
*/
|
|
190
|
-
exchangeSsoToken: (params: { body?: { grant_type?: string; requested_token_type?: string; subject_token?: string; subject_token_type?: string } }) => Promise<ExchangeSsoToken200Response>;
|
|
191
|
-
/**
|
|
192
|
-
* Clone a user token
|
|
193
|
-
* @param params - Parameters for cloneUserToken
|
|
194
|
-
* @returns Promise resolving to cloneUserToken response
|
|
195
|
-
*/
|
|
196
|
-
cloneUserToken: (params: { body?: { name?: string; description?: string } }) => Promise<CloneUserToken200Response>;
|
|
197
|
-
/**
|
|
198
|
-
* Transfer a user token
|
|
199
|
-
* @param params - Parameters for transferUserToken
|
|
200
|
-
* @returns Promise resolving to transferUserToken response
|
|
201
|
-
*/
|
|
202
|
-
transferUserToken: (params: { body?: { id?: number; from?: string; to?: string } }) => Promise<TransferUserToken200Response>;
|
|
203
|
-
/**
|
|
204
|
-
* Deactivate a user token
|
|
205
|
-
* @param params - Parameters for deactivateUserToken
|
|
206
|
-
* @returns Promise resolving to deactivateUserToken response
|
|
207
|
-
*/
|
|
208
|
-
deactivateUserToken: (params: { }) => Promise<DeactivateUserToken200Response>;
|
|
209
|
-
/**
|
|
210
|
-
* Delete a user token
|
|
211
|
-
* @param params - Parameters for deleteUserToken
|
|
212
|
-
* @returns Promise resolving to deleteUserToken response
|
|
213
|
-
*/
|
|
214
|
-
deleteUserToken: (params: { }) => Promise<DeleteUserToken200Response>;
|
|
215
|
-
/**
|
|
216
|
-
* Download file
|
|
217
|
-
* @param params - Parameters for downloadFile
|
|
218
|
-
* @returns Promise resolving to downloadFile response
|
|
219
|
-
*/
|
|
220
|
-
downloadFile: (params: { tableId: string; recordId: number; fieldId: number; versionNumber: number }) => Promise<DownloadFile200Response>;
|
|
221
|
-
/**
|
|
222
|
-
* Delete file
|
|
223
|
-
* @param params - Parameters for deleteFile
|
|
224
|
-
* @returns Promise resolving to deleteFile response
|
|
225
|
-
*/
|
|
226
|
-
deleteFile: (params: { tableId: string; recordId: number; fieldId: number; versionNumber: number }) => Promise<DeleteFile200Response>;
|
|
227
|
-
/**
|
|
228
|
-
* Get users
|
|
229
|
-
* @param params - Parameters for getUsers
|
|
230
|
-
* @returns Promise resolving to getUsers response
|
|
231
|
-
*/
|
|
232
|
-
getUsers: (params: { accountId?: number; body?: GetUsersRequest }) => Promise<GetUsers200Response>;
|
|
233
|
-
/**
|
|
234
|
-
* Deny users
|
|
235
|
-
* @param params - Parameters for denyUsers
|
|
236
|
-
* @returns Promise resolving to denyUsers response
|
|
237
|
-
*/
|
|
238
|
-
denyUsers: (params: { accountId?: number; body?: DenyUsersRequest }) => Promise<DenyUsers200Response>;
|
|
239
|
-
/**
|
|
240
|
-
* Deny and remove users from groups
|
|
241
|
-
* @param params - Parameters for denyUsersAndGroups
|
|
242
|
-
* @returns Promise resolving to denyUsersAndGroups response
|
|
243
|
-
*/
|
|
244
|
-
denyUsersAndGroups: (params: { accountId?: number; shouldDeleteFromGroups: boolean; body?: DenyUsersAndGroupsRequest }) => Promise<DenyUsersAndGroups200Response>;
|
|
245
|
-
/**
|
|
246
|
-
* Undeny users
|
|
247
|
-
* @param params - Parameters for undenyUsers
|
|
248
|
-
* @returns Promise resolving to undenyUsers response
|
|
249
|
-
*/
|
|
250
|
-
undenyUsers: (params: { accountId?: number; body?: UndenyUsersRequest }) => Promise<UndenyUsers200Response>;
|
|
251
|
-
/**
|
|
252
|
-
* Add members
|
|
253
|
-
* @param params - Parameters for addMembersToGroup
|
|
254
|
-
* @returns Promise resolving to addMembersToGroup response
|
|
255
|
-
*/
|
|
256
|
-
addMembersToGroup: (params: { gid: number; body?: AddMembersToGroupRequest }) => Promise<AddMembersToGroup200Response>;
|
|
257
|
-
/**
|
|
258
|
-
* Remove members
|
|
259
|
-
* @param params - Parameters for removeMembersFromGroup
|
|
260
|
-
* @returns Promise resolving to removeMembersFromGroup response
|
|
261
|
-
*/
|
|
262
|
-
removeMembersFromGroup: (params: { gid: number; body?: RemoveMembersFromGroupRequest }) => Promise<RemoveMembersFromGroup200Response>;
|
|
263
|
-
/**
|
|
264
|
-
* Add managers
|
|
265
|
-
* @param params - Parameters for addManagersToGroup
|
|
266
|
-
* @returns Promise resolving to addManagersToGroup response
|
|
267
|
-
*/
|
|
268
|
-
addManagersToGroup: (params: { gid: number; body?: AddManagersToGroupRequest }) => Promise<AddManagersToGroup200Response>;
|
|
269
|
-
/**
|
|
270
|
-
* Remove managers
|
|
271
|
-
* @param params - Parameters for removeManagersFromGroup
|
|
272
|
-
* @returns Promise resolving to removeManagersFromGroup response
|
|
273
|
-
*/
|
|
274
|
-
removeManagersFromGroup: (params: { gid: number; body?: RemoveManagersFromGroupRequest }) => Promise<RemoveManagersFromGroup200Response>;
|
|
275
|
-
/**
|
|
276
|
-
* Add child groups
|
|
277
|
-
* @param params - Parameters for addSubgroupsToGroup
|
|
278
|
-
* @returns Promise resolving to addSubgroupsToGroup response
|
|
279
|
-
*/
|
|
280
|
-
addSubgroupsToGroup: (params: { gid: number; body?: AddSubgroupsToGroupRequest }) => Promise<AddSubgroupsToGroup200Response>;
|
|
281
|
-
/**
|
|
282
|
-
* Remove child groups
|
|
283
|
-
* @param params - Parameters for removeSubgroupsFromGroup
|
|
284
|
-
* @returns Promise resolving to removeSubgroupsFromGroup response
|
|
285
|
-
*/
|
|
286
|
-
removeSubgroupsFromGroup: (params: { gid: number; body?: RemoveSubgroupsFromGroupRequest }) => Promise<RemoveSubgroupsFromGroup200Response>;
|
|
287
|
-
/**
|
|
288
|
-
* Get audit logs
|
|
289
|
-
* @param params - Parameters for audit
|
|
290
|
-
* @returns Promise resolving to audit response
|
|
291
|
-
*/
|
|
292
|
-
audit: (params: { body?: { nextToken?: string; numRows?: number; queryId?: string; date?: string; topics?: string[] } }) => Promise<Audit200Response>;
|
|
293
|
-
/**
|
|
294
|
-
* Get read summaries
|
|
295
|
-
* @param params - Parameters for platformAnalyticReads
|
|
296
|
-
* @returns Promise resolving to platformAnalyticReads response
|
|
297
|
-
*/
|
|
298
|
-
platformAnalyticReads: (params: { day?: string }) => Promise<PlatformAnalyticReads200Response>;
|
|
299
|
-
/**
|
|
300
|
-
* Get event summaries
|
|
301
|
-
* @param params - Parameters for platformAnalyticEventSummaries
|
|
302
|
-
* @returns Promise resolving to platformAnalyticEventSummaries response
|
|
303
|
-
*/
|
|
304
|
-
platformAnalyticEventSummaries: (params: { accountId?: number; body?: { start?: string; end?: string; groupBy?: string; nextToken?: string; where?: { id?: string; type?: string }[] } }) => Promise<PlatformAnalyticEventSummaries200Response>;
|
|
305
|
-
/**
|
|
306
|
-
* Export a solution
|
|
307
|
-
* @param params - Parameters for exportSolution
|
|
308
|
-
* @returns Promise resolving to exportSolution response
|
|
309
|
-
*/
|
|
310
|
-
exportSolution: (params: { solutionId: string; qBLVersion?: string }) => Promise<ExportSolution200Response>;
|
|
311
|
-
/**
|
|
312
|
-
* Update a solution
|
|
313
|
-
* @param params - Parameters for updateSolution
|
|
314
|
-
* @returns Promise resolving to updateSolution response
|
|
315
|
-
*/
|
|
316
|
-
updateSolution: (params: { solutionId: string; body?: any; xQBLErrorsAsSuccess?: boolean }) => Promise<UpdateSolution200Response>;
|
|
317
|
-
/**
|
|
318
|
-
* Create a solution
|
|
319
|
-
* @param params - Parameters for createSolution
|
|
320
|
-
* @returns Promise resolving to createSolution response
|
|
321
|
-
*/
|
|
322
|
-
createSolution: (params: { body?: any; xQBLErrorsAsSuccess?: boolean }) => Promise<CreateSolution200Response>;
|
|
323
|
-
/**
|
|
324
|
-
* Export solution to record
|
|
325
|
-
* @param params - Parameters for exportSolutionToRecord
|
|
326
|
-
* @returns Promise resolving to exportSolutionToRecord response
|
|
327
|
-
*/
|
|
328
|
-
exportSolutionToRecord: (params: { solutionId: string; tableId: string; fieldId: number; xQBLErrorsAsSuccess?: boolean; qBLVersion?: string }) => Promise<ExportSolutionToRecord200Response>;
|
|
329
|
-
/**
|
|
330
|
-
* Create solution from record
|
|
331
|
-
* @param params - Parameters for createSolutionFromRecord
|
|
332
|
-
* @returns Promise resolving to createSolutionFromRecord response
|
|
333
|
-
*/
|
|
334
|
-
createSolutionFromRecord: (params: { tableId: string; fieldId: number; recordId: number; xQBLErrorsAsSuccess?: boolean }) => Promise<CreateSolutionFromRecord200Response>;
|
|
335
|
-
/**
|
|
336
|
-
* Update solution from record
|
|
337
|
-
* @param params - Parameters for updateSolutionToRecord
|
|
338
|
-
* @returns Promise resolving to updateSolutionToRecord response
|
|
339
|
-
*/
|
|
340
|
-
updateSolutionToRecord: (params: { solutionId: string; tableId: string; fieldId: number; recordId: number; xQBLErrorsAsSuccess?: boolean }) => Promise<UpdateSolutionToRecord200Response>;
|
|
341
|
-
/**
|
|
342
|
-
* List solution changes
|
|
343
|
-
* @param params - Parameters for changesetSolution
|
|
344
|
-
* @returns Promise resolving to changesetSolution response
|
|
345
|
-
*/
|
|
346
|
-
changesetSolution: (params: { solutionId: string; body?: any; xQBLErrorsAsSuccess?: boolean }) => Promise<ChangesetSolution200Response>;
|
|
347
|
-
/**
|
|
348
|
-
* List solution changes from record
|
|
349
|
-
* @param params - Parameters for changesetSolutionFromRecord
|
|
350
|
-
* @returns Promise resolving to changesetSolutionFromRecord response
|
|
351
|
-
*/
|
|
352
|
-
changesetSolutionFromRecord: (params: { solutionId: string; tableId: string; fieldId: number; recordId: number; xQBLErrorsAsSuccess?: boolean }) => Promise<ChangesetSolutionFromRecord200Response>;
|
|
353
|
-
/**
|
|
354
|
-
* Generate a document
|
|
355
|
-
* @param params - Parameters for generateDocument
|
|
356
|
-
* @returns Promise resolving to generateDocument response
|
|
357
|
-
*/
|
|
358
|
-
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>;
|
|
359
|
-
}
|
package/src/index.ts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "./quickbaseClient.ts";
|