quickbase-js 1.0.1-beta.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/CHANGELOG.md +7 -0
- package/LICENSE +21 -0
- package/README.md +102 -0
- package/build.js +66 -0
- package/dist/quickbaseClient.d.ts +3888 -0
- package/dist/quickbaseClient.js +5812 -0
- package/dist/quickbaseClient.js.map +1 -0
- package/examples/react.js +22 -0
- package/examples/vanillajs.html +23 -0
- package/logGen.yaml +1820 -0
- package/package.json +72 -0
- package/playwright.config.ts +37 -0
- package/rollup.config.js +70 -0
- package/src/code-generation/fix-spec-definitions.ts +136 -0
- package/src/code-generation/fix-spec-main.ts +176 -0
- package/src/code-generation/fix-spec-paths.ts +163 -0
- package/src/code-generation/generate-unified-interface.ts +152 -0
- package/src/code-generation/output/quickbase-fixed.json +8435 -0
- package/src/code-generation/regenerate-client.ts +110 -0
- package/src/generated-unified/QuickbaseClient.ts +59 -0
- package/src/index.ts +1 -0
- package/src/log-gen.ts +122 -0
- package/src/quickbaseClient.ts +320 -0
- package/src/specs/QuickBase_RESTful_API_2025-03-04T06_22_39.725Z.json +46878 -0
- package/src/tokenCache.ts +51 -0
- package/src/utils.ts +5 -0
- package/test-artifacts/.last-run.json +4 -0
- package/test-artifacts/test-results.json +1801 -0
- package/test-results.json +2050 -0
- package/tests/playwright/qb/auth/cacheSwitching.test.ts +189 -0
- package/tests/playwright/qb/auth/fetchTempToken401.test.ts +217 -0
- package/tests/playwright/qb/auth/getAppWithUserToken.test.ts +151 -0
- package/tests/playwright/qb/auth/getTempToken.test.ts +180 -0
- package/tests/playwright/qb/auth/tokenPrefetch.test.ts +192 -0
- package/tests/playwright/qb/auth/tokenRenewal.test.ts +110 -0
- package/tests/setup.ts +19 -0
- package/tests/vitest/qb/apps/getApp.test.ts +46 -0
- package/tests/vitest/qb/fields/getFields.test.ts +234 -0
- package/tests/vitest/qb/index.ts +4 -0
- package/tests/vitest/qb/tables/getAppTables.test.ts +67 -0
- package/tests/vitest/unit/apps/getApp.test.ts +81 -0
- package/tests/vitest/unit/auth/fetchTempToken401.test.ts +59 -0
- package/tests/vitest/unit/auth/getTempToken.test.ts +83 -0
- package/tests/vitest/unit/auth/retryOn401.test.ts +72 -0
- package/tests/vitest/unit/auth/two401s.test.ts +77 -0
- package/tests/vitest/unit/fields/getFields.test.ts +115 -0
- package/tests/vitest/unit/index.ts +4 -0
- package/tests/vitest/unit/tables/getAppTables.test.ts +72 -0
- package/text.txt +104 -0
- package/tsconfig.json +28 -0
- package/versionrc.json +9 -0
- package/vitest.config.ts +21 -0
|
@@ -0,0 +1,3888 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Quick Base API
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface AddMembersToGroup200Response
|
|
16
|
+
*/
|
|
17
|
+
interface AddMembersToGroup200Response {
|
|
18
|
+
[key: string]: any | any;
|
|
19
|
+
/**
|
|
20
|
+
* 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.
|
|
21
|
+
* @type {Array<string>}
|
|
22
|
+
* @memberof AddMembersToGroup200Response
|
|
23
|
+
*/
|
|
24
|
+
failure: Array<string>;
|
|
25
|
+
/**
|
|
26
|
+
* A list of users that have been added to the group successfully.
|
|
27
|
+
* @type {Array<string>}
|
|
28
|
+
* @memberof AddMembersToGroup200Response
|
|
29
|
+
*/
|
|
30
|
+
success: Array<string>;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Check if a given object implements the AddMembersToGroup200Response interface.
|
|
34
|
+
*/
|
|
35
|
+
declare function instanceOfAddMembersToGroup200Response(value: object): value is AddMembersToGroup200Response;
|
|
36
|
+
declare function AddMembersToGroup200ResponseFromJSON(json: any): AddMembersToGroup200Response;
|
|
37
|
+
declare function AddMembersToGroup200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddMembersToGroup200Response;
|
|
38
|
+
declare function AddMembersToGroup200ResponseToJSON(json: any): AddMembersToGroup200Response;
|
|
39
|
+
declare function AddMembersToGroup200ResponseToJSONTyped(value?: AddMembersToGroup200Response | null, ignoreDiscriminator?: boolean): any;
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
* Quick Base API
|
|
43
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
44
|
+
*
|
|
45
|
+
* The version of the OpenAPI document: 1.0.0
|
|
46
|
+
*
|
|
47
|
+
*
|
|
48
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
49
|
+
* https://openapi-generator.tech
|
|
50
|
+
* Do not edit the class manually.
|
|
51
|
+
*/
|
|
52
|
+
/**
|
|
53
|
+
*
|
|
54
|
+
* @export
|
|
55
|
+
* @interface AddSubgroupsToGroup200Response
|
|
56
|
+
*/
|
|
57
|
+
interface AddSubgroupsToGroup200Response {
|
|
58
|
+
[key: string]: any | any;
|
|
59
|
+
/**
|
|
60
|
+
* 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.
|
|
61
|
+
* @type {Array<string>}
|
|
62
|
+
* @memberof AddSubgroupsToGroup200Response
|
|
63
|
+
*/
|
|
64
|
+
failure: Array<string>;
|
|
65
|
+
/**
|
|
66
|
+
* A list of child groups that have been added to the group successfully.
|
|
67
|
+
* @type {Array<string>}
|
|
68
|
+
* @memberof AddSubgroupsToGroup200Response
|
|
69
|
+
*/
|
|
70
|
+
success: Array<string>;
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Check if a given object implements the AddSubgroupsToGroup200Response interface.
|
|
74
|
+
*/
|
|
75
|
+
declare function instanceOfAddSubgroupsToGroup200Response(value: object): value is AddSubgroupsToGroup200Response;
|
|
76
|
+
declare function AddSubgroupsToGroup200ResponseFromJSON(json: any): AddSubgroupsToGroup200Response;
|
|
77
|
+
declare function AddSubgroupsToGroup200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddSubgroupsToGroup200Response;
|
|
78
|
+
declare function AddSubgroupsToGroup200ResponseToJSON(json: any): AddSubgroupsToGroup200Response;
|
|
79
|
+
declare function AddSubgroupsToGroup200ResponseToJSONTyped(value?: AddSubgroupsToGroup200Response | null, ignoreDiscriminator?: boolean): any;
|
|
80
|
+
|
|
81
|
+
/**
|
|
82
|
+
* Quick Base API
|
|
83
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
84
|
+
*
|
|
85
|
+
* The version of the OpenAPI document: 1.0.0
|
|
86
|
+
*
|
|
87
|
+
*
|
|
88
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
89
|
+
* https://openapi-generator.tech
|
|
90
|
+
* Do not edit the class manually.
|
|
91
|
+
*/
|
|
92
|
+
/**
|
|
93
|
+
*
|
|
94
|
+
* @export
|
|
95
|
+
* @interface AppMemoryInfo
|
|
96
|
+
*/
|
|
97
|
+
interface AppMemoryInfo {
|
|
98
|
+
/**
|
|
99
|
+
*
|
|
100
|
+
* @type {number}
|
|
101
|
+
* @memberof AppMemoryInfo
|
|
102
|
+
*/
|
|
103
|
+
estMemory?: number;
|
|
104
|
+
/**
|
|
105
|
+
*
|
|
106
|
+
* @type {number}
|
|
107
|
+
* @memberof AppMemoryInfo
|
|
108
|
+
*/
|
|
109
|
+
estMemoryInclDependentApps?: number;
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* Check if a given object implements the AppMemoryInfo interface.
|
|
113
|
+
*/
|
|
114
|
+
declare function instanceOfAppMemoryInfo(value: object): value is AppMemoryInfo;
|
|
115
|
+
declare function AppMemoryInfoFromJSON(json: any): AppMemoryInfo;
|
|
116
|
+
declare function AppMemoryInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): AppMemoryInfo;
|
|
117
|
+
declare function AppMemoryInfoToJSON(json: any): AppMemoryInfo;
|
|
118
|
+
declare function AppMemoryInfoToJSONTyped(value?: AppMemoryInfo | null, ignoreDiscriminator?: boolean): any;
|
|
119
|
+
|
|
120
|
+
/**
|
|
121
|
+
* Quick Base API
|
|
122
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
123
|
+
*
|
|
124
|
+
* The version of the OpenAPI document: 1.0.0
|
|
125
|
+
*
|
|
126
|
+
*
|
|
127
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
128
|
+
* https://openapi-generator.tech
|
|
129
|
+
* Do not edit the class manually.
|
|
130
|
+
*/
|
|
131
|
+
/**
|
|
132
|
+
*
|
|
133
|
+
* @export
|
|
134
|
+
* @interface AppSecurityProperties
|
|
135
|
+
*/
|
|
136
|
+
interface AppSecurityProperties {
|
|
137
|
+
/**
|
|
138
|
+
*
|
|
139
|
+
* @type {boolean}
|
|
140
|
+
* @memberof AppSecurityProperties
|
|
141
|
+
*/
|
|
142
|
+
allowClone?: boolean;
|
|
143
|
+
/**
|
|
144
|
+
*
|
|
145
|
+
* @type {boolean}
|
|
146
|
+
* @memberof AppSecurityProperties
|
|
147
|
+
*/
|
|
148
|
+
allowExport?: boolean;
|
|
149
|
+
/**
|
|
150
|
+
*
|
|
151
|
+
* @type {boolean}
|
|
152
|
+
* @memberof AppSecurityProperties
|
|
153
|
+
*/
|
|
154
|
+
enableAppTokens?: boolean;
|
|
155
|
+
/**
|
|
156
|
+
*
|
|
157
|
+
* @type {boolean}
|
|
158
|
+
* @memberof AppSecurityProperties
|
|
159
|
+
*/
|
|
160
|
+
hideFromPublic?: boolean;
|
|
161
|
+
/**
|
|
162
|
+
*
|
|
163
|
+
* @type {boolean}
|
|
164
|
+
* @memberof AppSecurityProperties
|
|
165
|
+
*/
|
|
166
|
+
mustBeRealmApproved?: boolean;
|
|
167
|
+
/**
|
|
168
|
+
*
|
|
169
|
+
* @type {boolean}
|
|
170
|
+
* @memberof AppSecurityProperties
|
|
171
|
+
*/
|
|
172
|
+
useIPFilter?: boolean;
|
|
173
|
+
}
|
|
174
|
+
/**
|
|
175
|
+
* Check if a given object implements the AppSecurityProperties interface.
|
|
176
|
+
*/
|
|
177
|
+
declare function instanceOfAppSecurityProperties(value: object): value is AppSecurityProperties;
|
|
178
|
+
declare function AppSecurityPropertiesFromJSON(json: any): AppSecurityProperties;
|
|
179
|
+
declare function AppSecurityPropertiesFromJSONTyped(json: any, ignoreDiscriminator: boolean): AppSecurityProperties;
|
|
180
|
+
declare function AppSecurityPropertiesToJSON(json: any): AppSecurityProperties;
|
|
181
|
+
declare function AppSecurityPropertiesToJSONTyped(value?: AppSecurityProperties | null, ignoreDiscriminator?: boolean): any;
|
|
182
|
+
|
|
183
|
+
/**
|
|
184
|
+
* Quick Base API
|
|
185
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
186
|
+
*
|
|
187
|
+
* The version of the OpenAPI document: 1.0.0
|
|
188
|
+
*
|
|
189
|
+
*
|
|
190
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
191
|
+
* https://openapi-generator.tech
|
|
192
|
+
* Do not edit the class manually.
|
|
193
|
+
*/
|
|
194
|
+
|
|
195
|
+
/**
|
|
196
|
+
*
|
|
197
|
+
* @export
|
|
198
|
+
* @interface App
|
|
199
|
+
*/
|
|
200
|
+
interface App {
|
|
201
|
+
/**
|
|
202
|
+
*
|
|
203
|
+
* @type {string}
|
|
204
|
+
* @memberof App
|
|
205
|
+
*/
|
|
206
|
+
id: string;
|
|
207
|
+
/**
|
|
208
|
+
*
|
|
209
|
+
* @type {string}
|
|
210
|
+
* @memberof App
|
|
211
|
+
*/
|
|
212
|
+
name: string;
|
|
213
|
+
/**
|
|
214
|
+
*
|
|
215
|
+
* @type {Date}
|
|
216
|
+
* @memberof App
|
|
217
|
+
*/
|
|
218
|
+
created?: Date;
|
|
219
|
+
/**
|
|
220
|
+
*
|
|
221
|
+
* @type {Date}
|
|
222
|
+
* @memberof App
|
|
223
|
+
*/
|
|
224
|
+
updated?: Date;
|
|
225
|
+
/**
|
|
226
|
+
*
|
|
227
|
+
* @type {string}
|
|
228
|
+
* @memberof App
|
|
229
|
+
*/
|
|
230
|
+
description?: string;
|
|
231
|
+
/**
|
|
232
|
+
*
|
|
233
|
+
* @type {string}
|
|
234
|
+
* @memberof App
|
|
235
|
+
*/
|
|
236
|
+
timeZone?: string;
|
|
237
|
+
/**
|
|
238
|
+
*
|
|
239
|
+
* @type {string}
|
|
240
|
+
* @memberof App
|
|
241
|
+
*/
|
|
242
|
+
dateFormat?: string;
|
|
243
|
+
/**
|
|
244
|
+
*
|
|
245
|
+
* @type {boolean}
|
|
246
|
+
* @memberof App
|
|
247
|
+
*/
|
|
248
|
+
hasEveryoneOnTheInternet?: boolean;
|
|
249
|
+
/**
|
|
250
|
+
*
|
|
251
|
+
* @type {AppMemoryInfo}
|
|
252
|
+
* @memberof App
|
|
253
|
+
*/
|
|
254
|
+
memoryInfo?: AppMemoryInfo;
|
|
255
|
+
/**
|
|
256
|
+
*
|
|
257
|
+
* @type {AppSecurityProperties}
|
|
258
|
+
* @memberof App
|
|
259
|
+
*/
|
|
260
|
+
securityProperties?: AppSecurityProperties;
|
|
261
|
+
}
|
|
262
|
+
/**
|
|
263
|
+
* Check if a given object implements the App interface.
|
|
264
|
+
*/
|
|
265
|
+
declare function instanceOfApp(value: object): value is App;
|
|
266
|
+
declare function AppFromJSON(json: any): App;
|
|
267
|
+
declare function AppFromJSONTyped(json: any, ignoreDiscriminator: boolean): App;
|
|
268
|
+
declare function AppToJSON(json: any): App;
|
|
269
|
+
declare function AppToJSONTyped(value?: App | null, ignoreDiscriminator?: boolean): any;
|
|
270
|
+
|
|
271
|
+
/**
|
|
272
|
+
* Quick Base API
|
|
273
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
274
|
+
*
|
|
275
|
+
* The version of the OpenAPI document: 1.0.0
|
|
276
|
+
*
|
|
277
|
+
*
|
|
278
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
279
|
+
* https://openapi-generator.tech
|
|
280
|
+
* Do not edit the class manually.
|
|
281
|
+
*/
|
|
282
|
+
/**
|
|
283
|
+
*
|
|
284
|
+
* @export
|
|
285
|
+
* @interface Audit200Response
|
|
286
|
+
*/
|
|
287
|
+
interface Audit200Response {
|
|
288
|
+
[key: string]: any | any;
|
|
289
|
+
/**
|
|
290
|
+
* Query id of the requested audit log.
|
|
291
|
+
* @type {string}
|
|
292
|
+
* @memberof Audit200Response
|
|
293
|
+
*/
|
|
294
|
+
queryId: string;
|
|
295
|
+
/**
|
|
296
|
+
* All events of the audit log.
|
|
297
|
+
* @type {Array<{ [key: string]: any; }>}
|
|
298
|
+
* @memberof Audit200Response
|
|
299
|
+
*/
|
|
300
|
+
events?: Array<{
|
|
301
|
+
[key: string]: any;
|
|
302
|
+
}>;
|
|
303
|
+
/**
|
|
304
|
+
* Token to fetch the next 1000 logs.
|
|
305
|
+
* @type {string}
|
|
306
|
+
* @memberof Audit200Response
|
|
307
|
+
*/
|
|
308
|
+
nextToken?: string;
|
|
309
|
+
}
|
|
310
|
+
/**
|
|
311
|
+
* Check if a given object implements the Audit200Response interface.
|
|
312
|
+
*/
|
|
313
|
+
declare function instanceOfAudit200Response(value: object): value is Audit200Response;
|
|
314
|
+
declare function Audit200ResponseFromJSON(json: any): Audit200Response;
|
|
315
|
+
declare function Audit200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): Audit200Response;
|
|
316
|
+
declare function Audit200ResponseToJSON(json: any): Audit200Response;
|
|
317
|
+
declare function Audit200ResponseToJSONTyped(value?: Audit200Response | null, ignoreDiscriminator?: boolean): any;
|
|
318
|
+
|
|
319
|
+
/**
|
|
320
|
+
* Quick Base API
|
|
321
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
322
|
+
*
|
|
323
|
+
* The version of the OpenAPI document: 1.0.0
|
|
324
|
+
*
|
|
325
|
+
*
|
|
326
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
327
|
+
* https://openapi-generator.tech
|
|
328
|
+
* Do not edit the class manually.
|
|
329
|
+
*/
|
|
330
|
+
/**
|
|
331
|
+
*
|
|
332
|
+
* @export
|
|
333
|
+
* @interface Audit202Response
|
|
334
|
+
*/
|
|
335
|
+
interface Audit202Response {
|
|
336
|
+
[key: string]: any | any;
|
|
337
|
+
/**
|
|
338
|
+
* Query id of the requested audit log.
|
|
339
|
+
* @type {string}
|
|
340
|
+
* @memberof Audit202Response
|
|
341
|
+
*/
|
|
342
|
+
queryId: string;
|
|
343
|
+
}
|
|
344
|
+
/**
|
|
345
|
+
* Check if a given object implements the Audit202Response interface.
|
|
346
|
+
*/
|
|
347
|
+
declare function instanceOfAudit202Response(value: object): value is Audit202Response;
|
|
348
|
+
declare function Audit202ResponseFromJSON(json: any): Audit202Response;
|
|
349
|
+
declare function Audit202ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): Audit202Response;
|
|
350
|
+
declare function Audit202ResponseToJSON(json: any): Audit202Response;
|
|
351
|
+
declare function Audit202ResponseToJSONTyped(value?: Audit202Response | null, ignoreDiscriminator?: boolean): any;
|
|
352
|
+
|
|
353
|
+
/**
|
|
354
|
+
* Quick Base API
|
|
355
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
356
|
+
*
|
|
357
|
+
* The version of the OpenAPI document: 1.0.0
|
|
358
|
+
*
|
|
359
|
+
*
|
|
360
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
361
|
+
* https://openapi-generator.tech
|
|
362
|
+
* Do not edit the class manually.
|
|
363
|
+
*/
|
|
364
|
+
/**
|
|
365
|
+
*
|
|
366
|
+
* @export
|
|
367
|
+
* @interface AuditRequest
|
|
368
|
+
*/
|
|
369
|
+
interface AuditRequest {
|
|
370
|
+
/**
|
|
371
|
+
* Token specifying start of page. For first page don't supply this.
|
|
372
|
+
* @type {string}
|
|
373
|
+
* @memberof AuditRequest
|
|
374
|
+
*/
|
|
375
|
+
nextToken?: string;
|
|
376
|
+
/**
|
|
377
|
+
* Number of logs to return per page, default is 10000, minimum is 1000, max is 50000.
|
|
378
|
+
* @type {number}
|
|
379
|
+
* @memberof AuditRequest
|
|
380
|
+
*/
|
|
381
|
+
numRows?: number;
|
|
382
|
+
/**
|
|
383
|
+
* The query id of an audit log request. This id is needed to fetch subsequent paged results of a single query.
|
|
384
|
+
* @type {string}
|
|
385
|
+
* @memberof AuditRequest
|
|
386
|
+
*/
|
|
387
|
+
queryId?: string;
|
|
388
|
+
/**
|
|
389
|
+
* The date for which audit logs need to be fetched. This must be date-time only, as YYYY-MM-DD, and a valid date in the past.
|
|
390
|
+
* @type {Date}
|
|
391
|
+
* @memberof AuditRequest
|
|
392
|
+
*/
|
|
393
|
+
date?: Date;
|
|
394
|
+
/**
|
|
395
|
+
* An array that may contain up to 20 [topics](https://resources.quickbase.com/nav/app/budurkasx/action/showpage/2b2941e4-f34d-4d41-9b0e-db790d20e9ab?pageIdV2=quickbase.com-DashboardGroup-15760d74-2243-4ce9-9495-7cc8790f12e7) to filter by. If empty, all topics are returned.
|
|
396
|
+
* @type {Array<string>}
|
|
397
|
+
* @memberof AuditRequest
|
|
398
|
+
*/
|
|
399
|
+
topics?: Array<string>;
|
|
400
|
+
}
|
|
401
|
+
/**
|
|
402
|
+
* Check if a given object implements the AuditRequest interface.
|
|
403
|
+
*/
|
|
404
|
+
declare function instanceOfAuditRequest(value: object): value is AuditRequest;
|
|
405
|
+
declare function AuditRequestFromJSON(json: any): AuditRequest;
|
|
406
|
+
declare function AuditRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuditRequest;
|
|
407
|
+
declare function AuditRequestToJSON(json: any): AuditRequest;
|
|
408
|
+
declare function AuditRequestToJSONTyped(value?: AuditRequest | null, ignoreDiscriminator?: boolean): any;
|
|
409
|
+
|
|
410
|
+
/**
|
|
411
|
+
* Quick Base API
|
|
412
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
413
|
+
*
|
|
414
|
+
* The version of the OpenAPI document: 1.0.0
|
|
415
|
+
*
|
|
416
|
+
*
|
|
417
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
418
|
+
* https://openapi-generator.tech
|
|
419
|
+
* Do not edit the class manually.
|
|
420
|
+
*/
|
|
421
|
+
/**
|
|
422
|
+
*
|
|
423
|
+
* @export
|
|
424
|
+
* @interface CloneUserToken200Response
|
|
425
|
+
*/
|
|
426
|
+
interface CloneUserToken200Response {
|
|
427
|
+
[key: string]: any | any;
|
|
428
|
+
/**
|
|
429
|
+
* Whether the user token is active.
|
|
430
|
+
* @type {boolean}
|
|
431
|
+
* @memberof CloneUserToken200Response
|
|
432
|
+
*/
|
|
433
|
+
active?: boolean;
|
|
434
|
+
/**
|
|
435
|
+
* The list of apps this user token is assigned to.
|
|
436
|
+
* @type {Array<{ [key: string]: any; }>}
|
|
437
|
+
* @memberof CloneUserToken200Response
|
|
438
|
+
*/
|
|
439
|
+
apps?: Array<{
|
|
440
|
+
[key: string]: any;
|
|
441
|
+
}>;
|
|
442
|
+
/**
|
|
443
|
+
* The last date this user token was used, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
|
|
444
|
+
* @type {string}
|
|
445
|
+
* @memberof CloneUserToken200Response
|
|
446
|
+
*/
|
|
447
|
+
lastUsed?: string;
|
|
448
|
+
/**
|
|
449
|
+
* User Token description.
|
|
450
|
+
* @type {string}
|
|
451
|
+
* @memberof CloneUserToken200Response
|
|
452
|
+
*/
|
|
453
|
+
description?: string;
|
|
454
|
+
/**
|
|
455
|
+
* User Token id.
|
|
456
|
+
* @type {number}
|
|
457
|
+
* @memberof CloneUserToken200Response
|
|
458
|
+
*/
|
|
459
|
+
id?: number;
|
|
460
|
+
/**
|
|
461
|
+
* User Token name.
|
|
462
|
+
* @type {string}
|
|
463
|
+
* @memberof CloneUserToken200Response
|
|
464
|
+
*/
|
|
465
|
+
name?: string;
|
|
466
|
+
/**
|
|
467
|
+
* User Token value.
|
|
468
|
+
* @type {string}
|
|
469
|
+
* @memberof CloneUserToken200Response
|
|
470
|
+
*/
|
|
471
|
+
token?: string;
|
|
472
|
+
}
|
|
473
|
+
/**
|
|
474
|
+
* Check if a given object implements the CloneUserToken200Response interface.
|
|
475
|
+
*/
|
|
476
|
+
declare function instanceOfCloneUserToken200Response(value: object): value is CloneUserToken200Response;
|
|
477
|
+
declare function CloneUserToken200ResponseFromJSON(json: any): CloneUserToken200Response;
|
|
478
|
+
declare function CloneUserToken200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CloneUserToken200Response;
|
|
479
|
+
declare function CloneUserToken200ResponseToJSON(json: any): CloneUserToken200Response;
|
|
480
|
+
declare function CloneUserToken200ResponseToJSONTyped(value?: CloneUserToken200Response | null, ignoreDiscriminator?: boolean): any;
|
|
481
|
+
|
|
482
|
+
/**
|
|
483
|
+
* Quick Base API
|
|
484
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
485
|
+
*
|
|
486
|
+
* The version of the OpenAPI document: 1.0.0
|
|
487
|
+
*
|
|
488
|
+
*
|
|
489
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
490
|
+
* https://openapi-generator.tech
|
|
491
|
+
* Do not edit the class manually.
|
|
492
|
+
*/
|
|
493
|
+
/**
|
|
494
|
+
*
|
|
495
|
+
* @export
|
|
496
|
+
* @interface CloneUserTokenRequest
|
|
497
|
+
*/
|
|
498
|
+
interface CloneUserTokenRequest {
|
|
499
|
+
/**
|
|
500
|
+
* The new name for the cloned user token.
|
|
501
|
+
* @type {string}
|
|
502
|
+
* @memberof CloneUserTokenRequest
|
|
503
|
+
*/
|
|
504
|
+
name?: string;
|
|
505
|
+
/**
|
|
506
|
+
* The description for the cloned user token.
|
|
507
|
+
* @type {string}
|
|
508
|
+
* @memberof CloneUserTokenRequest
|
|
509
|
+
*/
|
|
510
|
+
description?: string;
|
|
511
|
+
}
|
|
512
|
+
/**
|
|
513
|
+
* Check if a given object implements the CloneUserTokenRequest interface.
|
|
514
|
+
*/
|
|
515
|
+
declare function instanceOfCloneUserTokenRequest(value: object): value is CloneUserTokenRequest;
|
|
516
|
+
declare function CloneUserTokenRequestFromJSON(json: any): CloneUserTokenRequest;
|
|
517
|
+
declare function CloneUserTokenRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CloneUserTokenRequest;
|
|
518
|
+
declare function CloneUserTokenRequestToJSON(json: any): CloneUserTokenRequest;
|
|
519
|
+
declare function CloneUserTokenRequestToJSONTyped(value?: CloneUserTokenRequest | null, ignoreDiscriminator?: boolean): any;
|
|
520
|
+
|
|
521
|
+
/**
|
|
522
|
+
* Quick Base API
|
|
523
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
524
|
+
*
|
|
525
|
+
* The version of the OpenAPI document: 1.0.0
|
|
526
|
+
*
|
|
527
|
+
*
|
|
528
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
529
|
+
* https://openapi-generator.tech
|
|
530
|
+
* Do not edit the class manually.
|
|
531
|
+
*/
|
|
532
|
+
/**
|
|
533
|
+
*
|
|
534
|
+
* @export
|
|
535
|
+
* @interface CopyApp200Response
|
|
536
|
+
*/
|
|
537
|
+
interface CopyApp200Response {
|
|
538
|
+
[key: string]: any | any;
|
|
539
|
+
/**
|
|
540
|
+
* 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.
|
|
541
|
+
* @type {string}
|
|
542
|
+
* @memberof CopyApp200Response
|
|
543
|
+
*/
|
|
544
|
+
name: string;
|
|
545
|
+
/**
|
|
546
|
+
* The description for the app
|
|
547
|
+
* @type {string}
|
|
548
|
+
* @memberof CopyApp200Response
|
|
549
|
+
*/
|
|
550
|
+
description?: string;
|
|
551
|
+
/**
|
|
552
|
+
* The time and date the app was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
|
|
553
|
+
* @type {string}
|
|
554
|
+
* @memberof CopyApp200Response
|
|
555
|
+
*/
|
|
556
|
+
created?: string;
|
|
557
|
+
/**
|
|
558
|
+
* 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).
|
|
559
|
+
* @type {string}
|
|
560
|
+
* @memberof CopyApp200Response
|
|
561
|
+
*/
|
|
562
|
+
updated?: string;
|
|
563
|
+
/**
|
|
564
|
+
* 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.
|
|
565
|
+
* @type {string}
|
|
566
|
+
* @memberof CopyApp200Response
|
|
567
|
+
*/
|
|
568
|
+
dateFormat?: string;
|
|
569
|
+
/**
|
|
570
|
+
* 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.
|
|
571
|
+
* @type {string}
|
|
572
|
+
* @memberof CopyApp200Response
|
|
573
|
+
*/
|
|
574
|
+
timeZone?: string;
|
|
575
|
+
/**
|
|
576
|
+
* The unique identifier for this application.
|
|
577
|
+
* @type {string}
|
|
578
|
+
* @memberof CopyApp200Response
|
|
579
|
+
*/
|
|
580
|
+
id?: string;
|
|
581
|
+
/**
|
|
582
|
+
* 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)
|
|
583
|
+
* @type {boolean}
|
|
584
|
+
* @memberof CopyApp200Response
|
|
585
|
+
*/
|
|
586
|
+
hasEveryoneOnTheInternet?: boolean;
|
|
587
|
+
/**
|
|
588
|
+
* The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)
|
|
589
|
+
* @type {Array<{ [key: string]: any; }>}
|
|
590
|
+
* @memberof CopyApp200Response
|
|
591
|
+
*/
|
|
592
|
+
variables?: Array<{
|
|
593
|
+
[key: string]: any;
|
|
594
|
+
}>;
|
|
595
|
+
/**
|
|
596
|
+
* The id of the app from which this app was copied
|
|
597
|
+
* @type {string}
|
|
598
|
+
* @memberof CopyApp200Response
|
|
599
|
+
*/
|
|
600
|
+
ancestorId?: string;
|
|
601
|
+
/**
|
|
602
|
+
* 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.
|
|
603
|
+
* @type {string}
|
|
604
|
+
* @memberof CopyApp200Response
|
|
605
|
+
*/
|
|
606
|
+
dataClassification?: string;
|
|
607
|
+
}
|
|
608
|
+
/**
|
|
609
|
+
* Check if a given object implements the CopyApp200Response interface.
|
|
610
|
+
*/
|
|
611
|
+
declare function instanceOfCopyApp200Response(value: object): value is CopyApp200Response;
|
|
612
|
+
declare function CopyApp200ResponseFromJSON(json: any): CopyApp200Response;
|
|
613
|
+
declare function CopyApp200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CopyApp200Response;
|
|
614
|
+
declare function CopyApp200ResponseToJSON(json: any): CopyApp200Response;
|
|
615
|
+
declare function CopyApp200ResponseToJSONTyped(value?: CopyApp200Response | null, ignoreDiscriminator?: boolean): any;
|
|
616
|
+
|
|
617
|
+
/**
|
|
618
|
+
* Quick Base API
|
|
619
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
620
|
+
*
|
|
621
|
+
* The version of the OpenAPI document: 1.0.0
|
|
622
|
+
*
|
|
623
|
+
*
|
|
624
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
625
|
+
* https://openapi-generator.tech
|
|
626
|
+
* Do not edit the class manually.
|
|
627
|
+
*/
|
|
628
|
+
/**
|
|
629
|
+
*
|
|
630
|
+
* @export
|
|
631
|
+
* @interface CopyAppRequest
|
|
632
|
+
*/
|
|
633
|
+
interface CopyAppRequest {
|
|
634
|
+
/**
|
|
635
|
+
* The name of the newly copied app
|
|
636
|
+
* @type {string}
|
|
637
|
+
* @memberof CopyAppRequest
|
|
638
|
+
*/
|
|
639
|
+
name: string;
|
|
640
|
+
/**
|
|
641
|
+
* The description of the newly copied app
|
|
642
|
+
* @type {string}
|
|
643
|
+
* @memberof CopyAppRequest
|
|
644
|
+
*/
|
|
645
|
+
description?: string;
|
|
646
|
+
/**
|
|
647
|
+
* The configuration properties for performing the app copy
|
|
648
|
+
* @type {object}
|
|
649
|
+
* @memberof CopyAppRequest
|
|
650
|
+
*/
|
|
651
|
+
properties?: object;
|
|
652
|
+
}
|
|
653
|
+
/**
|
|
654
|
+
* Check if a given object implements the CopyAppRequest interface.
|
|
655
|
+
*/
|
|
656
|
+
declare function instanceOfCopyAppRequest(value: object): value is CopyAppRequest;
|
|
657
|
+
declare function CopyAppRequestFromJSON(json: any): CopyAppRequest;
|
|
658
|
+
declare function CopyAppRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CopyAppRequest;
|
|
659
|
+
declare function CopyAppRequestToJSON(json: any): CopyAppRequest;
|
|
660
|
+
declare function CopyAppRequestToJSONTyped(value?: CopyAppRequest | null, ignoreDiscriminator?: boolean): any;
|
|
661
|
+
|
|
662
|
+
/**
|
|
663
|
+
* Quick Base API
|
|
664
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
665
|
+
*
|
|
666
|
+
* The version of the OpenAPI document: 1.0.0
|
|
667
|
+
*
|
|
668
|
+
*
|
|
669
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
670
|
+
* https://openapi-generator.tech
|
|
671
|
+
* Do not edit the class manually.
|
|
672
|
+
*/
|
|
673
|
+
/**
|
|
674
|
+
*
|
|
675
|
+
* @export
|
|
676
|
+
* @interface CreateApp200Response
|
|
677
|
+
*/
|
|
678
|
+
interface CreateApp200Response {
|
|
679
|
+
[key: string]: any | any;
|
|
680
|
+
/**
|
|
681
|
+
* 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.
|
|
682
|
+
* @type {string}
|
|
683
|
+
* @memberof CreateApp200Response
|
|
684
|
+
*/
|
|
685
|
+
name: string;
|
|
686
|
+
/**
|
|
687
|
+
* The description for the app. If this property is left out, the app description will be blank.
|
|
688
|
+
* @type {string}
|
|
689
|
+
* @memberof CreateApp200Response
|
|
690
|
+
*/
|
|
691
|
+
description?: string;
|
|
692
|
+
/**
|
|
693
|
+
* The time and date the app was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
|
|
694
|
+
* @type {string}
|
|
695
|
+
* @memberof CreateApp200Response
|
|
696
|
+
*/
|
|
697
|
+
created?: string;
|
|
698
|
+
/**
|
|
699
|
+
* 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).
|
|
700
|
+
* @type {string}
|
|
701
|
+
* @memberof CreateApp200Response
|
|
702
|
+
*/
|
|
703
|
+
updated?: string;
|
|
704
|
+
/**
|
|
705
|
+
* 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.
|
|
706
|
+
* @type {string}
|
|
707
|
+
* @memberof CreateApp200Response
|
|
708
|
+
*/
|
|
709
|
+
dateFormat?: string;
|
|
710
|
+
/**
|
|
711
|
+
* 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.
|
|
712
|
+
* @type {string}
|
|
713
|
+
* @memberof CreateApp200Response
|
|
714
|
+
*/
|
|
715
|
+
timeZone?: string;
|
|
716
|
+
/**
|
|
717
|
+
* Application memory info
|
|
718
|
+
* @type {object}
|
|
719
|
+
* @memberof CreateApp200Response
|
|
720
|
+
*/
|
|
721
|
+
memoryInfo?: object;
|
|
722
|
+
/**
|
|
723
|
+
* The unique identifier for this application.
|
|
724
|
+
* @type {string}
|
|
725
|
+
* @memberof CreateApp200Response
|
|
726
|
+
*/
|
|
727
|
+
id?: string;
|
|
728
|
+
/**
|
|
729
|
+
* 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)
|
|
730
|
+
* @type {boolean}
|
|
731
|
+
* @memberof CreateApp200Response
|
|
732
|
+
*/
|
|
733
|
+
hasEveryoneOnTheInternet?: boolean;
|
|
734
|
+
/**
|
|
735
|
+
* The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)
|
|
736
|
+
* @type {Array<{ [key: string]: any; }>}
|
|
737
|
+
* @memberof CreateApp200Response
|
|
738
|
+
*/
|
|
739
|
+
variables?: Array<{
|
|
740
|
+
[key: string]: any;
|
|
741
|
+
}>;
|
|
742
|
+
/**
|
|
743
|
+
* 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.
|
|
744
|
+
* @type {string}
|
|
745
|
+
* @memberof CreateApp200Response
|
|
746
|
+
*/
|
|
747
|
+
dataClassification?: string;
|
|
748
|
+
/**
|
|
749
|
+
* Security properties of the application
|
|
750
|
+
* @type {{ [key: string]: any; }}
|
|
751
|
+
* @memberof CreateApp200Response
|
|
752
|
+
*/
|
|
753
|
+
securityProperties?: {
|
|
754
|
+
[key: string]: any;
|
|
755
|
+
};
|
|
756
|
+
}
|
|
757
|
+
/**
|
|
758
|
+
* Check if a given object implements the CreateApp200Response interface.
|
|
759
|
+
*/
|
|
760
|
+
declare function instanceOfCreateApp200Response(value: object): value is CreateApp200Response;
|
|
761
|
+
declare function CreateApp200ResponseFromJSON(json: any): CreateApp200Response;
|
|
762
|
+
declare function CreateApp200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateApp200Response;
|
|
763
|
+
declare function CreateApp200ResponseToJSON(json: any): CreateApp200Response;
|
|
764
|
+
declare function CreateApp200ResponseToJSONTyped(value?: CreateApp200Response | null, ignoreDiscriminator?: boolean): any;
|
|
765
|
+
|
|
766
|
+
/**
|
|
767
|
+
* Quick Base API
|
|
768
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
769
|
+
*
|
|
770
|
+
* The version of the OpenAPI document: 1.0.0
|
|
771
|
+
*
|
|
772
|
+
*
|
|
773
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
774
|
+
* https://openapi-generator.tech
|
|
775
|
+
* Do not edit the class manually.
|
|
776
|
+
*/
|
|
777
|
+
/**
|
|
778
|
+
* The example below shows all the properties that can be set with this request. Additional properties that you can see, with the corresponding GET request, cannot be set through this API. See individual property descriptions below for details on how to set or change each.
|
|
779
|
+
* @export
|
|
780
|
+
* @interface CreateAppRequest
|
|
781
|
+
*/
|
|
782
|
+
interface CreateAppRequest {
|
|
783
|
+
/**
|
|
784
|
+
* Set to true if you would like to assign the app to the user token you used to create the application. The default is false.
|
|
785
|
+
* @type {boolean}
|
|
786
|
+
* @memberof CreateAppRequest
|
|
787
|
+
*/
|
|
788
|
+
assignToken?: boolean;
|
|
789
|
+
/**
|
|
790
|
+
* The app variables. A maximum of 10 variables can be inserted at a time. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)
|
|
791
|
+
* @type {Array<object>}
|
|
792
|
+
* @memberof CreateAppRequest
|
|
793
|
+
*/
|
|
794
|
+
variables?: Array<object>;
|
|
795
|
+
/**
|
|
796
|
+
* 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.
|
|
797
|
+
* @type {string}
|
|
798
|
+
* @memberof CreateAppRequest
|
|
799
|
+
*/
|
|
800
|
+
name: string;
|
|
801
|
+
/**
|
|
802
|
+
* Application security properties.
|
|
803
|
+
* @type {object}
|
|
804
|
+
* @memberof CreateAppRequest
|
|
805
|
+
*/
|
|
806
|
+
securityProperties?: object;
|
|
807
|
+
/**
|
|
808
|
+
* The description for the app. If this property is left out, the app description will be blank.
|
|
809
|
+
* @type {string}
|
|
810
|
+
* @memberof CreateAppRequest
|
|
811
|
+
*/
|
|
812
|
+
description?: string;
|
|
813
|
+
}
|
|
814
|
+
/**
|
|
815
|
+
* Check if a given object implements the CreateAppRequest interface.
|
|
816
|
+
*/
|
|
817
|
+
declare function instanceOfCreateAppRequest(value: object): value is CreateAppRequest;
|
|
818
|
+
declare function CreateAppRequestFromJSON(json: any): CreateAppRequest;
|
|
819
|
+
declare function CreateAppRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateAppRequest;
|
|
820
|
+
declare function CreateAppRequestToJSON(json: any): CreateAppRequest;
|
|
821
|
+
declare function CreateAppRequestToJSONTyped(value?: CreateAppRequest | null, ignoreDiscriminator?: boolean): any;
|
|
822
|
+
|
|
823
|
+
/**
|
|
824
|
+
* Quick Base API
|
|
825
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
826
|
+
*
|
|
827
|
+
* The version of the OpenAPI document: 1.0.0
|
|
828
|
+
*
|
|
829
|
+
*
|
|
830
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
831
|
+
* https://openapi-generator.tech
|
|
832
|
+
* Do not edit the class manually.
|
|
833
|
+
*/
|
|
834
|
+
/**
|
|
835
|
+
*
|
|
836
|
+
* @export
|
|
837
|
+
* @interface CreateRelationship200Response
|
|
838
|
+
*/
|
|
839
|
+
interface CreateRelationship200Response {
|
|
840
|
+
[key: string]: any | any;
|
|
841
|
+
/**
|
|
842
|
+
* The relationship id (foreign key field id).
|
|
843
|
+
* @type {number}
|
|
844
|
+
* @memberof CreateRelationship200Response
|
|
845
|
+
*/
|
|
846
|
+
id: number;
|
|
847
|
+
/**
|
|
848
|
+
* The parent table id of the relationship.
|
|
849
|
+
* @type {string}
|
|
850
|
+
* @memberof CreateRelationship200Response
|
|
851
|
+
*/
|
|
852
|
+
parentTableId: string;
|
|
853
|
+
/**
|
|
854
|
+
* The child table id of the relationship.
|
|
855
|
+
* @type {string}
|
|
856
|
+
* @memberof CreateRelationship200Response
|
|
857
|
+
*/
|
|
858
|
+
childTableId: string;
|
|
859
|
+
/**
|
|
860
|
+
* The foreign key field information.
|
|
861
|
+
* @type {{ [key: string]: any; }}
|
|
862
|
+
* @memberof CreateRelationship200Response
|
|
863
|
+
*/
|
|
864
|
+
foreignKeyField?: {
|
|
865
|
+
[key: string]: any;
|
|
866
|
+
};
|
|
867
|
+
/**
|
|
868
|
+
* Whether this is a cross-app relationship.
|
|
869
|
+
* @type {boolean}
|
|
870
|
+
* @memberof CreateRelationship200Response
|
|
871
|
+
*/
|
|
872
|
+
isCrossApp: boolean;
|
|
873
|
+
/**
|
|
874
|
+
* The lookup fields array.
|
|
875
|
+
* @type {Array<{ [key: string]: any; }>}
|
|
876
|
+
* @memberof CreateRelationship200Response
|
|
877
|
+
*/
|
|
878
|
+
lookupFields?: Array<{
|
|
879
|
+
[key: string]: any;
|
|
880
|
+
}>;
|
|
881
|
+
/**
|
|
882
|
+
* The summary fields array.
|
|
883
|
+
* @type {Array<{ [key: string]: any; }>}
|
|
884
|
+
* @memberof CreateRelationship200Response
|
|
885
|
+
*/
|
|
886
|
+
summaryFields?: Array<{
|
|
887
|
+
[key: string]: any;
|
|
888
|
+
}>;
|
|
889
|
+
}
|
|
890
|
+
/**
|
|
891
|
+
* Check if a given object implements the CreateRelationship200Response interface.
|
|
892
|
+
*/
|
|
893
|
+
declare function instanceOfCreateRelationship200Response(value: object): value is CreateRelationship200Response;
|
|
894
|
+
declare function CreateRelationship200ResponseFromJSON(json: any): CreateRelationship200Response;
|
|
895
|
+
declare function CreateRelationship200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateRelationship200Response;
|
|
896
|
+
declare function CreateRelationship200ResponseToJSON(json: any): CreateRelationship200Response;
|
|
897
|
+
declare function CreateRelationship200ResponseToJSONTyped(value?: CreateRelationship200Response | null, ignoreDiscriminator?: boolean): any;
|
|
898
|
+
|
|
899
|
+
/**
|
|
900
|
+
* Quick Base API
|
|
901
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
902
|
+
*
|
|
903
|
+
* The version of the OpenAPI document: 1.0.0
|
|
904
|
+
*
|
|
905
|
+
*
|
|
906
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
907
|
+
* https://openapi-generator.tech
|
|
908
|
+
* Do not edit the class manually.
|
|
909
|
+
*/
|
|
910
|
+
/**
|
|
911
|
+
*
|
|
912
|
+
* @export
|
|
913
|
+
* @interface CreateRelationshipRequest
|
|
914
|
+
*/
|
|
915
|
+
interface CreateRelationshipRequest {
|
|
916
|
+
/**
|
|
917
|
+
* Array of summary field objects which will turn into summary fields in the parent table. When you specify the 'COUNT' accumulation type, you have to specify 0 as the summaryFid (or not set it in the request). 'DISTINCT-COUNT' requires that summaryFid be set to an actual fid.
|
|
918
|
+
* @type {Array<{ [key: string]: any; }>}
|
|
919
|
+
* @memberof CreateRelationshipRequest
|
|
920
|
+
*/
|
|
921
|
+
summaryFields?: Array<{
|
|
922
|
+
[key: string]: any;
|
|
923
|
+
}>;
|
|
924
|
+
/**
|
|
925
|
+
* Array of field ids in the parent table that will become lookup fields in the child table.
|
|
926
|
+
* @type {Array<number>}
|
|
927
|
+
* @memberof CreateRelationshipRequest
|
|
928
|
+
*/
|
|
929
|
+
lookupFieldIds?: Array<number>;
|
|
930
|
+
/**
|
|
931
|
+
* The parent table id for the relationship.
|
|
932
|
+
* @type {string}
|
|
933
|
+
* @memberof CreateRelationshipRequest
|
|
934
|
+
*/
|
|
935
|
+
parentTableId: string;
|
|
936
|
+
/**
|
|
937
|
+
* This property is optional. If it is not provided, the foreign key field will be created with the label ‘Related <record>’, where <record> is the name of a record in the parent table.
|
|
938
|
+
* @type {{ [key: string]: any; }}
|
|
939
|
+
* @memberof CreateRelationshipRequest
|
|
940
|
+
*/
|
|
941
|
+
foreignKeyField?: {
|
|
942
|
+
[key: string]: any;
|
|
943
|
+
};
|
|
944
|
+
}
|
|
945
|
+
/**
|
|
946
|
+
* Check if a given object implements the CreateRelationshipRequest interface.
|
|
947
|
+
*/
|
|
948
|
+
declare function instanceOfCreateRelationshipRequest(value: object): value is CreateRelationshipRequest;
|
|
949
|
+
declare function CreateRelationshipRequestFromJSON(json: any): CreateRelationshipRequest;
|
|
950
|
+
declare function CreateRelationshipRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateRelationshipRequest;
|
|
951
|
+
declare function CreateRelationshipRequestToJSON(json: any): CreateRelationshipRequest;
|
|
952
|
+
declare function CreateRelationshipRequestToJSONTyped(value?: CreateRelationshipRequest | null, ignoreDiscriminator?: boolean): any;
|
|
953
|
+
|
|
954
|
+
/**
|
|
955
|
+
* Quick Base API
|
|
956
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
957
|
+
*
|
|
958
|
+
* The version of the OpenAPI document: 1.0.0
|
|
959
|
+
*
|
|
960
|
+
*
|
|
961
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
962
|
+
* https://openapi-generator.tech
|
|
963
|
+
* Do not edit the class manually.
|
|
964
|
+
*/
|
|
965
|
+
/**
|
|
966
|
+
*
|
|
967
|
+
* @export
|
|
968
|
+
* @interface DeactivateUserToken200Response
|
|
969
|
+
*/
|
|
970
|
+
interface DeactivateUserToken200Response {
|
|
971
|
+
[key: string]: any | any;
|
|
972
|
+
/**
|
|
973
|
+
* The user token id.
|
|
974
|
+
* @type {number}
|
|
975
|
+
* @memberof DeactivateUserToken200Response
|
|
976
|
+
*/
|
|
977
|
+
id?: number;
|
|
978
|
+
}
|
|
979
|
+
/**
|
|
980
|
+
* Check if a given object implements the DeactivateUserToken200Response interface.
|
|
981
|
+
*/
|
|
982
|
+
declare function instanceOfDeactivateUserToken200Response(value: object): value is DeactivateUserToken200Response;
|
|
983
|
+
declare function DeactivateUserToken200ResponseFromJSON(json: any): DeactivateUserToken200Response;
|
|
984
|
+
declare function DeactivateUserToken200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeactivateUserToken200Response;
|
|
985
|
+
declare function DeactivateUserToken200ResponseToJSON(json: any): DeactivateUserToken200Response;
|
|
986
|
+
declare function DeactivateUserToken200ResponseToJSONTyped(value?: DeactivateUserToken200Response | null, ignoreDiscriminator?: boolean): any;
|
|
987
|
+
|
|
988
|
+
/**
|
|
989
|
+
* Quick Base API
|
|
990
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
991
|
+
*
|
|
992
|
+
* The version of the OpenAPI document: 1.0.0
|
|
993
|
+
*
|
|
994
|
+
*
|
|
995
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
996
|
+
* https://openapi-generator.tech
|
|
997
|
+
* Do not edit the class manually.
|
|
998
|
+
*/
|
|
999
|
+
/**
|
|
1000
|
+
*
|
|
1001
|
+
* @export
|
|
1002
|
+
* @interface DeleteFile200Response
|
|
1003
|
+
*/
|
|
1004
|
+
interface DeleteFile200Response {
|
|
1005
|
+
[key: string]: any | any;
|
|
1006
|
+
/**
|
|
1007
|
+
* The number of deleted version.
|
|
1008
|
+
* @type {number}
|
|
1009
|
+
* @memberof DeleteFile200Response
|
|
1010
|
+
*/
|
|
1011
|
+
versionNumber?: number;
|
|
1012
|
+
/**
|
|
1013
|
+
* The name of file associated with deleted version.
|
|
1014
|
+
* @type {string}
|
|
1015
|
+
* @memberof DeleteFile200Response
|
|
1016
|
+
*/
|
|
1017
|
+
fileName?: string;
|
|
1018
|
+
/**
|
|
1019
|
+
* The timestamp when the version was originally uploaded.
|
|
1020
|
+
* @type {string}
|
|
1021
|
+
* @memberof DeleteFile200Response
|
|
1022
|
+
*/
|
|
1023
|
+
uploaded?: string;
|
|
1024
|
+
/**
|
|
1025
|
+
* The user that uploaded version.
|
|
1026
|
+
* @type {{ [key: string]: any; }}
|
|
1027
|
+
* @memberof DeleteFile200Response
|
|
1028
|
+
*/
|
|
1029
|
+
creator?: {
|
|
1030
|
+
[key: string]: any;
|
|
1031
|
+
};
|
|
1032
|
+
}
|
|
1033
|
+
/**
|
|
1034
|
+
* Check if a given object implements the DeleteFile200Response interface.
|
|
1035
|
+
*/
|
|
1036
|
+
declare function instanceOfDeleteFile200Response(value: object): value is DeleteFile200Response;
|
|
1037
|
+
declare function DeleteFile200ResponseFromJSON(json: any): DeleteFile200Response;
|
|
1038
|
+
declare function DeleteFile200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeleteFile200Response;
|
|
1039
|
+
declare function DeleteFile200ResponseToJSON(json: any): DeleteFile200Response;
|
|
1040
|
+
declare function DeleteFile200ResponseToJSONTyped(value?: DeleteFile200Response | null, ignoreDiscriminator?: boolean): any;
|
|
1041
|
+
|
|
1042
|
+
/**
|
|
1043
|
+
* Quick Base API
|
|
1044
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1045
|
+
*
|
|
1046
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1047
|
+
*
|
|
1048
|
+
*
|
|
1049
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1050
|
+
* https://openapi-generator.tech
|
|
1051
|
+
* Do not edit the class manually.
|
|
1052
|
+
*/
|
|
1053
|
+
/**
|
|
1054
|
+
*
|
|
1055
|
+
* @export
|
|
1056
|
+
* @interface DeleteRecords200Response
|
|
1057
|
+
*/
|
|
1058
|
+
interface DeleteRecords200Response {
|
|
1059
|
+
[key: string]: any | any;
|
|
1060
|
+
/**
|
|
1061
|
+
* The number of records deleted.
|
|
1062
|
+
* @type {number}
|
|
1063
|
+
* @memberof DeleteRecords200Response
|
|
1064
|
+
*/
|
|
1065
|
+
numberDeleted?: number;
|
|
1066
|
+
}
|
|
1067
|
+
/**
|
|
1068
|
+
* Check if a given object implements the DeleteRecords200Response interface.
|
|
1069
|
+
*/
|
|
1070
|
+
declare function instanceOfDeleteRecords200Response(value: object): value is DeleteRecords200Response;
|
|
1071
|
+
declare function DeleteRecords200ResponseFromJSON(json: any): DeleteRecords200Response;
|
|
1072
|
+
declare function DeleteRecords200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeleteRecords200Response;
|
|
1073
|
+
declare function DeleteRecords200ResponseToJSON(json: any): DeleteRecords200Response;
|
|
1074
|
+
declare function DeleteRecords200ResponseToJSONTyped(value?: DeleteRecords200Response | null, ignoreDiscriminator?: boolean): any;
|
|
1075
|
+
|
|
1076
|
+
/**
|
|
1077
|
+
* Quick Base API
|
|
1078
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1079
|
+
*
|
|
1080
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1081
|
+
*
|
|
1082
|
+
*
|
|
1083
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1084
|
+
* https://openapi-generator.tech
|
|
1085
|
+
* Do not edit the class manually.
|
|
1086
|
+
*/
|
|
1087
|
+
/**
|
|
1088
|
+
*
|
|
1089
|
+
* @export
|
|
1090
|
+
* @interface DeleteRecordsRequest
|
|
1091
|
+
*/
|
|
1092
|
+
interface DeleteRecordsRequest {
|
|
1093
|
+
[key: string]: any | any;
|
|
1094
|
+
/**
|
|
1095
|
+
* The unique identifier of the table.
|
|
1096
|
+
* @type {string}
|
|
1097
|
+
* @memberof DeleteRecordsRequest
|
|
1098
|
+
*/
|
|
1099
|
+
from: string;
|
|
1100
|
+
/**
|
|
1101
|
+
* The filter to delete records. To delete all records specify a filter that will include all records, for example {3.GT.0} where 3 is the ID of the Record ID field.
|
|
1102
|
+
* @type {string}
|
|
1103
|
+
* @memberof DeleteRecordsRequest
|
|
1104
|
+
*/
|
|
1105
|
+
where: string;
|
|
1106
|
+
}
|
|
1107
|
+
/**
|
|
1108
|
+
* Check if a given object implements the DeleteRecordsRequest interface.
|
|
1109
|
+
*/
|
|
1110
|
+
declare function instanceOfDeleteRecordsRequest(value: object): value is DeleteRecordsRequest;
|
|
1111
|
+
declare function DeleteRecordsRequestFromJSON(json: any): DeleteRecordsRequest;
|
|
1112
|
+
declare function DeleteRecordsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeleteRecordsRequest;
|
|
1113
|
+
declare function DeleteRecordsRequestToJSON(json: any): DeleteRecordsRequest;
|
|
1114
|
+
declare function DeleteRecordsRequestToJSONTyped(value?: DeleteRecordsRequest | null, ignoreDiscriminator?: boolean): any;
|
|
1115
|
+
|
|
1116
|
+
/**
|
|
1117
|
+
* Quick Base API
|
|
1118
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1119
|
+
*
|
|
1120
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1121
|
+
*
|
|
1122
|
+
*
|
|
1123
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1124
|
+
* https://openapi-generator.tech
|
|
1125
|
+
* Do not edit the class manually.
|
|
1126
|
+
*/
|
|
1127
|
+
/**
|
|
1128
|
+
*
|
|
1129
|
+
* @export
|
|
1130
|
+
* @interface DeleteRelationship200Response
|
|
1131
|
+
*/
|
|
1132
|
+
interface DeleteRelationship200Response {
|
|
1133
|
+
[key: string]: any | any;
|
|
1134
|
+
/**
|
|
1135
|
+
* The relationship id.
|
|
1136
|
+
* @type {number}
|
|
1137
|
+
* @memberof DeleteRelationship200Response
|
|
1138
|
+
*/
|
|
1139
|
+
relationshipId: number;
|
|
1140
|
+
}
|
|
1141
|
+
/**
|
|
1142
|
+
* Check if a given object implements the DeleteRelationship200Response interface.
|
|
1143
|
+
*/
|
|
1144
|
+
declare function instanceOfDeleteRelationship200Response(value: object): value is DeleteRelationship200Response;
|
|
1145
|
+
declare function DeleteRelationship200ResponseFromJSON(json: any): DeleteRelationship200Response;
|
|
1146
|
+
declare function DeleteRelationship200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeleteRelationship200Response;
|
|
1147
|
+
declare function DeleteRelationship200ResponseToJSON(json: any): DeleteRelationship200Response;
|
|
1148
|
+
declare function DeleteRelationship200ResponseToJSONTyped(value?: DeleteRelationship200Response | null, ignoreDiscriminator?: boolean): any;
|
|
1149
|
+
|
|
1150
|
+
/**
|
|
1151
|
+
* Quick Base API
|
|
1152
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1153
|
+
*
|
|
1154
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1155
|
+
*
|
|
1156
|
+
*
|
|
1157
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1158
|
+
* https://openapi-generator.tech
|
|
1159
|
+
* Do not edit the class manually.
|
|
1160
|
+
*/
|
|
1161
|
+
/**
|
|
1162
|
+
*
|
|
1163
|
+
* @export
|
|
1164
|
+
* @interface DeleteTable200Response
|
|
1165
|
+
*/
|
|
1166
|
+
interface DeleteTable200Response {
|
|
1167
|
+
[key: string]: any | any;
|
|
1168
|
+
/**
|
|
1169
|
+
* The deleted table id.
|
|
1170
|
+
* @type {string}
|
|
1171
|
+
* @memberof DeleteTable200Response
|
|
1172
|
+
*/
|
|
1173
|
+
deletedTableId?: string;
|
|
1174
|
+
}
|
|
1175
|
+
/**
|
|
1176
|
+
* Check if a given object implements the DeleteTable200Response interface.
|
|
1177
|
+
*/
|
|
1178
|
+
declare function instanceOfDeleteTable200Response(value: object): value is DeleteTable200Response;
|
|
1179
|
+
declare function DeleteTable200ResponseFromJSON(json: any): DeleteTable200Response;
|
|
1180
|
+
declare function DeleteTable200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeleteTable200Response;
|
|
1181
|
+
declare function DeleteTable200ResponseToJSON(json: any): DeleteTable200Response;
|
|
1182
|
+
declare function DeleteTable200ResponseToJSONTyped(value?: DeleteTable200Response | null, ignoreDiscriminator?: boolean): any;
|
|
1183
|
+
|
|
1184
|
+
/**
|
|
1185
|
+
* Quick Base API
|
|
1186
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1187
|
+
*
|
|
1188
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1189
|
+
*
|
|
1190
|
+
*
|
|
1191
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1192
|
+
* https://openapi-generator.tech
|
|
1193
|
+
* Do not edit the class manually.
|
|
1194
|
+
*/
|
|
1195
|
+
/**
|
|
1196
|
+
*
|
|
1197
|
+
* @export
|
|
1198
|
+
* @interface DenyUsers200Response
|
|
1199
|
+
*/
|
|
1200
|
+
interface DenyUsers200Response {
|
|
1201
|
+
[key: string]: any | any;
|
|
1202
|
+
/**
|
|
1203
|
+
* A list of users that couldn't be denied. This also includes the ID's of users that are not valid.
|
|
1204
|
+
* @type {Array<string>}
|
|
1205
|
+
* @memberof DenyUsers200Response
|
|
1206
|
+
*/
|
|
1207
|
+
failure: Array<string>;
|
|
1208
|
+
/**
|
|
1209
|
+
* A list of users that have successfully been denied.
|
|
1210
|
+
* @type {Array<string>}
|
|
1211
|
+
* @memberof DenyUsers200Response
|
|
1212
|
+
*/
|
|
1213
|
+
success: Array<string>;
|
|
1214
|
+
}
|
|
1215
|
+
/**
|
|
1216
|
+
* Check if a given object implements the DenyUsers200Response interface.
|
|
1217
|
+
*/
|
|
1218
|
+
declare function instanceOfDenyUsers200Response(value: object): value is DenyUsers200Response;
|
|
1219
|
+
declare function DenyUsers200ResponseFromJSON(json: any): DenyUsers200Response;
|
|
1220
|
+
declare function DenyUsers200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DenyUsers200Response;
|
|
1221
|
+
declare function DenyUsers200ResponseToJSON(json: any): DenyUsers200Response;
|
|
1222
|
+
declare function DenyUsers200ResponseToJSONTyped(value?: DenyUsers200Response | null, ignoreDiscriminator?: boolean): any;
|
|
1223
|
+
|
|
1224
|
+
/**
|
|
1225
|
+
* Quick Base API
|
|
1226
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1227
|
+
*
|
|
1228
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1229
|
+
*
|
|
1230
|
+
*
|
|
1231
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1232
|
+
* https://openapi-generator.tech
|
|
1233
|
+
* Do not edit the class manually.
|
|
1234
|
+
*/
|
|
1235
|
+
/**
|
|
1236
|
+
*
|
|
1237
|
+
* @export
|
|
1238
|
+
* @interface ExchangeSsoToken200Response
|
|
1239
|
+
*/
|
|
1240
|
+
interface ExchangeSsoToken200Response {
|
|
1241
|
+
[key: string]: any | any;
|
|
1242
|
+
/**
|
|
1243
|
+
* 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.
|
|
1244
|
+
* @type {string}
|
|
1245
|
+
* @memberof ExchangeSsoToken200Response
|
|
1246
|
+
*/
|
|
1247
|
+
accessToken?: string;
|
|
1248
|
+
/**
|
|
1249
|
+
* An identifier for the representation of the issued security token.
|
|
1250
|
+
* @type {string}
|
|
1251
|
+
* @memberof ExchangeSsoToken200Response
|
|
1252
|
+
*/
|
|
1253
|
+
issuedTokenType?: ExchangeSsoToken200ResponseIssuedTokenTypeEnum;
|
|
1254
|
+
/**
|
|
1255
|
+
* Will always return `N_A`
|
|
1256
|
+
* @type {string}
|
|
1257
|
+
* @memberof ExchangeSsoToken200Response
|
|
1258
|
+
*/
|
|
1259
|
+
tokenType?: ExchangeSsoToken200ResponseTokenTypeEnum;
|
|
1260
|
+
}
|
|
1261
|
+
/**
|
|
1262
|
+
* @export
|
|
1263
|
+
*/
|
|
1264
|
+
declare const ExchangeSsoToken200ResponseIssuedTokenTypeEnum: {
|
|
1265
|
+
readonly UrnQuickbaseParamsOauthTokenTypeTempTicket: "urn:quickbase:params:oauth:token-type:temp_ticket";
|
|
1266
|
+
readonly UrnQuickbaseParamsOauthTokenTypeTempToken: "urn:quickbase:params:oauth:token-type:temp_token";
|
|
1267
|
+
};
|
|
1268
|
+
type ExchangeSsoToken200ResponseIssuedTokenTypeEnum = typeof ExchangeSsoToken200ResponseIssuedTokenTypeEnum[keyof typeof ExchangeSsoToken200ResponseIssuedTokenTypeEnum];
|
|
1269
|
+
/**
|
|
1270
|
+
* @export
|
|
1271
|
+
*/
|
|
1272
|
+
declare const ExchangeSsoToken200ResponseTokenTypeEnum: {
|
|
1273
|
+
readonly NA: "N_A";
|
|
1274
|
+
};
|
|
1275
|
+
type ExchangeSsoToken200ResponseTokenTypeEnum = typeof ExchangeSsoToken200ResponseTokenTypeEnum[keyof typeof ExchangeSsoToken200ResponseTokenTypeEnum];
|
|
1276
|
+
/**
|
|
1277
|
+
* Check if a given object implements the ExchangeSsoToken200Response interface.
|
|
1278
|
+
*/
|
|
1279
|
+
declare function instanceOfExchangeSsoToken200Response(value: object): value is ExchangeSsoToken200Response;
|
|
1280
|
+
declare function ExchangeSsoToken200ResponseFromJSON(json: any): ExchangeSsoToken200Response;
|
|
1281
|
+
declare function ExchangeSsoToken200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExchangeSsoToken200Response;
|
|
1282
|
+
declare function ExchangeSsoToken200ResponseToJSON(json: any): ExchangeSsoToken200Response;
|
|
1283
|
+
declare function ExchangeSsoToken200ResponseToJSONTyped(value?: ExchangeSsoToken200Response | null, ignoreDiscriminator?: boolean): any;
|
|
1284
|
+
|
|
1285
|
+
/**
|
|
1286
|
+
* Quick Base API
|
|
1287
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1288
|
+
*
|
|
1289
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1290
|
+
*
|
|
1291
|
+
*
|
|
1292
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1293
|
+
* https://openapi-generator.tech
|
|
1294
|
+
* Do not edit the class manually.
|
|
1295
|
+
*/
|
|
1296
|
+
/**
|
|
1297
|
+
*
|
|
1298
|
+
* @export
|
|
1299
|
+
* @interface ExchangeSsoTokenRequest
|
|
1300
|
+
*/
|
|
1301
|
+
interface ExchangeSsoTokenRequest {
|
|
1302
|
+
/**
|
|
1303
|
+
* The value `urn:ietf:params:oauth:grant-type:token-exchange` indicates that a token exchange is being performed.
|
|
1304
|
+
* @type {string}
|
|
1305
|
+
* @memberof ExchangeSsoTokenRequest
|
|
1306
|
+
*/
|
|
1307
|
+
grantType: ExchangeSsoTokenRequestGrantTypeEnum;
|
|
1308
|
+
/**
|
|
1309
|
+
* An identifier for the type of the requested security token. For the RESTful API, use `urn:quickbase:params:oauth:token-type:temp_token`. For the XML or SCIM APIs use `urn:quickbase:params:oauth:token-type:temp_ticket`.
|
|
1310
|
+
* @type {string}
|
|
1311
|
+
* @memberof ExchangeSsoTokenRequest
|
|
1312
|
+
*/
|
|
1313
|
+
requestedTokenType: ExchangeSsoTokenRequestRequestedTokenTypeEnum;
|
|
1314
|
+
/**
|
|
1315
|
+
* A security token that represents the identity of the party on behalf of whom the request is being made. For SAML 2.0, the value should be a base64url-encoded SAML 2.0 assertion.
|
|
1316
|
+
* @type {string}
|
|
1317
|
+
* @memberof ExchangeSsoTokenRequest
|
|
1318
|
+
*/
|
|
1319
|
+
subjectToken: string;
|
|
1320
|
+
/**
|
|
1321
|
+
* An identifier that indicates the type of the security token in the `subject_token` parameter.
|
|
1322
|
+
* @type {string}
|
|
1323
|
+
* @memberof ExchangeSsoTokenRequest
|
|
1324
|
+
*/
|
|
1325
|
+
subjectTokenType: ExchangeSsoTokenRequestSubjectTokenTypeEnum;
|
|
1326
|
+
}
|
|
1327
|
+
/**
|
|
1328
|
+
* @export
|
|
1329
|
+
*/
|
|
1330
|
+
declare const ExchangeSsoTokenRequestGrantTypeEnum: {
|
|
1331
|
+
readonly UrnIetfParamsOauthGrantTypeTokenExchange: "urn:ietf:params:oauth:grant-type:token-exchange";
|
|
1332
|
+
};
|
|
1333
|
+
type ExchangeSsoTokenRequestGrantTypeEnum = typeof ExchangeSsoTokenRequestGrantTypeEnum[keyof typeof ExchangeSsoTokenRequestGrantTypeEnum];
|
|
1334
|
+
/**
|
|
1335
|
+
* @export
|
|
1336
|
+
*/
|
|
1337
|
+
declare const ExchangeSsoTokenRequestRequestedTokenTypeEnum: {
|
|
1338
|
+
readonly UrnQuickbaseParamsOauthTokenTypeTempTicket: "urn:quickbase:params:oauth:token-type:temp_ticket";
|
|
1339
|
+
readonly UrnQuickbaseParamsOauthTokenTypeTempToken: "urn:quickbase:params:oauth:token-type:temp_token";
|
|
1340
|
+
};
|
|
1341
|
+
type ExchangeSsoTokenRequestRequestedTokenTypeEnum = typeof ExchangeSsoTokenRequestRequestedTokenTypeEnum[keyof typeof ExchangeSsoTokenRequestRequestedTokenTypeEnum];
|
|
1342
|
+
/**
|
|
1343
|
+
* @export
|
|
1344
|
+
*/
|
|
1345
|
+
declare const ExchangeSsoTokenRequestSubjectTokenTypeEnum: {
|
|
1346
|
+
readonly UrnIetfParamsOauthTokenTypeSaml2: "urn:ietf:params:oauth:token-type:saml2";
|
|
1347
|
+
};
|
|
1348
|
+
type ExchangeSsoTokenRequestSubjectTokenTypeEnum = typeof ExchangeSsoTokenRequestSubjectTokenTypeEnum[keyof typeof ExchangeSsoTokenRequestSubjectTokenTypeEnum];
|
|
1349
|
+
/**
|
|
1350
|
+
* Check if a given object implements the ExchangeSsoTokenRequest interface.
|
|
1351
|
+
*/
|
|
1352
|
+
declare function instanceOfExchangeSsoTokenRequest(value: object): value is ExchangeSsoTokenRequest;
|
|
1353
|
+
declare function ExchangeSsoTokenRequestFromJSON(json: any): ExchangeSsoTokenRequest;
|
|
1354
|
+
declare function ExchangeSsoTokenRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExchangeSsoTokenRequest;
|
|
1355
|
+
declare function ExchangeSsoTokenRequestToJSON(json: any): ExchangeSsoTokenRequest;
|
|
1356
|
+
declare function ExchangeSsoTokenRequestToJSONTyped(value?: ExchangeSsoTokenRequest | null, ignoreDiscriminator?: boolean): any;
|
|
1357
|
+
|
|
1358
|
+
/**
|
|
1359
|
+
* Quick Base API
|
|
1360
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1361
|
+
*
|
|
1362
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1363
|
+
*
|
|
1364
|
+
*
|
|
1365
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1366
|
+
* https://openapi-generator.tech
|
|
1367
|
+
* Do not edit the class manually.
|
|
1368
|
+
*/
|
|
1369
|
+
/**
|
|
1370
|
+
*
|
|
1371
|
+
* @export
|
|
1372
|
+
* @interface FieldProperties
|
|
1373
|
+
*/
|
|
1374
|
+
interface FieldProperties {
|
|
1375
|
+
/**
|
|
1376
|
+
*
|
|
1377
|
+
* @type {boolean}
|
|
1378
|
+
* @memberof FieldProperties
|
|
1379
|
+
*/
|
|
1380
|
+
primaryKey?: boolean;
|
|
1381
|
+
/**
|
|
1382
|
+
*
|
|
1383
|
+
* @type {boolean}
|
|
1384
|
+
* @memberof FieldProperties
|
|
1385
|
+
*/
|
|
1386
|
+
foreignKey?: boolean;
|
|
1387
|
+
/**
|
|
1388
|
+
*
|
|
1389
|
+
* @type {number}
|
|
1390
|
+
* @memberof FieldProperties
|
|
1391
|
+
*/
|
|
1392
|
+
numLines?: number;
|
|
1393
|
+
/**
|
|
1394
|
+
*
|
|
1395
|
+
* @type {number}
|
|
1396
|
+
* @memberof FieldProperties
|
|
1397
|
+
*/
|
|
1398
|
+
maxLength?: number;
|
|
1399
|
+
/**
|
|
1400
|
+
*
|
|
1401
|
+
* @type {boolean}
|
|
1402
|
+
* @memberof FieldProperties
|
|
1403
|
+
*/
|
|
1404
|
+
appendOnly?: boolean;
|
|
1405
|
+
/**
|
|
1406
|
+
*
|
|
1407
|
+
* @type {boolean}
|
|
1408
|
+
* @memberof FieldProperties
|
|
1409
|
+
*/
|
|
1410
|
+
allowHTML?: boolean;
|
|
1411
|
+
/**
|
|
1412
|
+
*
|
|
1413
|
+
* @type {boolean}
|
|
1414
|
+
* @memberof FieldProperties
|
|
1415
|
+
*/
|
|
1416
|
+
allowMentions?: boolean;
|
|
1417
|
+
/**
|
|
1418
|
+
*
|
|
1419
|
+
* @type {boolean}
|
|
1420
|
+
* @memberof FieldProperties
|
|
1421
|
+
*/
|
|
1422
|
+
sortAsGiven?: boolean;
|
|
1423
|
+
/**
|
|
1424
|
+
*
|
|
1425
|
+
* @type {boolean}
|
|
1426
|
+
* @memberof FieldProperties
|
|
1427
|
+
*/
|
|
1428
|
+
carryChoices?: boolean;
|
|
1429
|
+
/**
|
|
1430
|
+
*
|
|
1431
|
+
* @type {boolean}
|
|
1432
|
+
* @memberof FieldProperties
|
|
1433
|
+
*/
|
|
1434
|
+
allowNewChoices?: boolean;
|
|
1435
|
+
/**
|
|
1436
|
+
*
|
|
1437
|
+
* @type {string}
|
|
1438
|
+
* @memberof FieldProperties
|
|
1439
|
+
*/
|
|
1440
|
+
formula?: string;
|
|
1441
|
+
/**
|
|
1442
|
+
*
|
|
1443
|
+
* @type {string}
|
|
1444
|
+
* @memberof FieldProperties
|
|
1445
|
+
*/
|
|
1446
|
+
defaultValue?: string;
|
|
1447
|
+
}
|
|
1448
|
+
/**
|
|
1449
|
+
* Check if a given object implements the FieldProperties interface.
|
|
1450
|
+
*/
|
|
1451
|
+
declare function instanceOfFieldProperties(value: object): value is FieldProperties;
|
|
1452
|
+
declare function FieldPropertiesFromJSON(json: any): FieldProperties;
|
|
1453
|
+
declare function FieldPropertiesFromJSONTyped(json: any, ignoreDiscriminator: boolean): FieldProperties;
|
|
1454
|
+
declare function FieldPropertiesToJSON(json: any): FieldProperties;
|
|
1455
|
+
declare function FieldPropertiesToJSONTyped(value?: FieldProperties | null, ignoreDiscriminator?: boolean): any;
|
|
1456
|
+
|
|
1457
|
+
/**
|
|
1458
|
+
* Quick Base API
|
|
1459
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1460
|
+
*
|
|
1461
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1462
|
+
*
|
|
1463
|
+
*
|
|
1464
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1465
|
+
* https://openapi-generator.tech
|
|
1466
|
+
* Do not edit the class manually.
|
|
1467
|
+
*/
|
|
1468
|
+
/**
|
|
1469
|
+
*
|
|
1470
|
+
* @export
|
|
1471
|
+
* @interface FieldPermissionsInner
|
|
1472
|
+
*/
|
|
1473
|
+
interface FieldPermissionsInner {
|
|
1474
|
+
/**
|
|
1475
|
+
*
|
|
1476
|
+
* @type {string}
|
|
1477
|
+
* @memberof FieldPermissionsInner
|
|
1478
|
+
*/
|
|
1479
|
+
permissionType?: string;
|
|
1480
|
+
/**
|
|
1481
|
+
*
|
|
1482
|
+
* @type {string}
|
|
1483
|
+
* @memberof FieldPermissionsInner
|
|
1484
|
+
*/
|
|
1485
|
+
role?: string;
|
|
1486
|
+
/**
|
|
1487
|
+
*
|
|
1488
|
+
* @type {number}
|
|
1489
|
+
* @memberof FieldPermissionsInner
|
|
1490
|
+
*/
|
|
1491
|
+
roleId?: number;
|
|
1492
|
+
}
|
|
1493
|
+
/**
|
|
1494
|
+
* Check if a given object implements the FieldPermissionsInner interface.
|
|
1495
|
+
*/
|
|
1496
|
+
declare function instanceOfFieldPermissionsInner(value: object): value is FieldPermissionsInner;
|
|
1497
|
+
declare function FieldPermissionsInnerFromJSON(json: any): FieldPermissionsInner;
|
|
1498
|
+
declare function FieldPermissionsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): FieldPermissionsInner;
|
|
1499
|
+
declare function FieldPermissionsInnerToJSON(json: any): FieldPermissionsInner;
|
|
1500
|
+
declare function FieldPermissionsInnerToJSONTyped(value?: FieldPermissionsInner | null, ignoreDiscriminator?: boolean): any;
|
|
1501
|
+
|
|
1502
|
+
/**
|
|
1503
|
+
* Quick Base API
|
|
1504
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1505
|
+
*
|
|
1506
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1507
|
+
*
|
|
1508
|
+
*
|
|
1509
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1510
|
+
* https://openapi-generator.tech
|
|
1511
|
+
* Do not edit the class manually.
|
|
1512
|
+
*/
|
|
1513
|
+
|
|
1514
|
+
/**
|
|
1515
|
+
*
|
|
1516
|
+
* @export
|
|
1517
|
+
* @interface Field
|
|
1518
|
+
*/
|
|
1519
|
+
interface Field {
|
|
1520
|
+
/**
|
|
1521
|
+
*
|
|
1522
|
+
* @type {number}
|
|
1523
|
+
* @memberof Field
|
|
1524
|
+
*/
|
|
1525
|
+
id: number;
|
|
1526
|
+
/**
|
|
1527
|
+
*
|
|
1528
|
+
* @type {string}
|
|
1529
|
+
* @memberof Field
|
|
1530
|
+
*/
|
|
1531
|
+
label: string;
|
|
1532
|
+
/**
|
|
1533
|
+
*
|
|
1534
|
+
* @type {string}
|
|
1535
|
+
* @memberof Field
|
|
1536
|
+
*/
|
|
1537
|
+
fieldType: string;
|
|
1538
|
+
/**
|
|
1539
|
+
*
|
|
1540
|
+
* @type {boolean}
|
|
1541
|
+
* @memberof Field
|
|
1542
|
+
*/
|
|
1543
|
+
noWrap?: boolean;
|
|
1544
|
+
/**
|
|
1545
|
+
*
|
|
1546
|
+
* @type {boolean}
|
|
1547
|
+
* @memberof Field
|
|
1548
|
+
*/
|
|
1549
|
+
bold?: boolean;
|
|
1550
|
+
/**
|
|
1551
|
+
*
|
|
1552
|
+
* @type {boolean}
|
|
1553
|
+
* @memberof Field
|
|
1554
|
+
*/
|
|
1555
|
+
required?: boolean;
|
|
1556
|
+
/**
|
|
1557
|
+
*
|
|
1558
|
+
* @type {boolean}
|
|
1559
|
+
* @memberof Field
|
|
1560
|
+
*/
|
|
1561
|
+
appearsByDefault?: boolean;
|
|
1562
|
+
/**
|
|
1563
|
+
*
|
|
1564
|
+
* @type {boolean}
|
|
1565
|
+
* @memberof Field
|
|
1566
|
+
*/
|
|
1567
|
+
findEnabled?: boolean;
|
|
1568
|
+
/**
|
|
1569
|
+
*
|
|
1570
|
+
* @type {boolean}
|
|
1571
|
+
* @memberof Field
|
|
1572
|
+
*/
|
|
1573
|
+
unique?: boolean;
|
|
1574
|
+
/**
|
|
1575
|
+
*
|
|
1576
|
+
* @type {boolean}
|
|
1577
|
+
* @memberof Field
|
|
1578
|
+
*/
|
|
1579
|
+
doesDataCopy?: boolean;
|
|
1580
|
+
/**
|
|
1581
|
+
*
|
|
1582
|
+
* @type {string}
|
|
1583
|
+
* @memberof Field
|
|
1584
|
+
*/
|
|
1585
|
+
fieldHelp?: string;
|
|
1586
|
+
/**
|
|
1587
|
+
*
|
|
1588
|
+
* @type {boolean}
|
|
1589
|
+
* @memberof Field
|
|
1590
|
+
*/
|
|
1591
|
+
audited?: boolean;
|
|
1592
|
+
/**
|
|
1593
|
+
*
|
|
1594
|
+
* @type {FieldProperties}
|
|
1595
|
+
* @memberof Field
|
|
1596
|
+
*/
|
|
1597
|
+
properties?: FieldProperties;
|
|
1598
|
+
/**
|
|
1599
|
+
*
|
|
1600
|
+
* @type {Array<FieldPermissionsInner>}
|
|
1601
|
+
* @memberof Field
|
|
1602
|
+
*/
|
|
1603
|
+
permissions?: Array<FieldPermissionsInner>;
|
|
1604
|
+
}
|
|
1605
|
+
/**
|
|
1606
|
+
* Check if a given object implements the Field interface.
|
|
1607
|
+
*/
|
|
1608
|
+
declare function instanceOfField(value: object): value is Field;
|
|
1609
|
+
declare function FieldFromJSON(json: any): Field;
|
|
1610
|
+
declare function FieldFromJSONTyped(json: any, ignoreDiscriminator: boolean): Field;
|
|
1611
|
+
declare function FieldToJSON(json: any): Field;
|
|
1612
|
+
declare function FieldToJSONTyped(value?: Field | null, ignoreDiscriminator?: boolean): any;
|
|
1613
|
+
|
|
1614
|
+
/**
|
|
1615
|
+
* Quick Base API
|
|
1616
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1617
|
+
*
|
|
1618
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1619
|
+
*
|
|
1620
|
+
*
|
|
1621
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1622
|
+
* https://openapi-generator.tech
|
|
1623
|
+
* Do not edit the class manually.
|
|
1624
|
+
*/
|
|
1625
|
+
/**
|
|
1626
|
+
*
|
|
1627
|
+
* @export
|
|
1628
|
+
* @interface GenerateDocument200Response
|
|
1629
|
+
*/
|
|
1630
|
+
interface GenerateDocument200Response {
|
|
1631
|
+
[key: string]: any | any;
|
|
1632
|
+
/**
|
|
1633
|
+
* The file name.
|
|
1634
|
+
* @type {string}
|
|
1635
|
+
* @memberof GenerateDocument200Response
|
|
1636
|
+
*/
|
|
1637
|
+
fileName?: string;
|
|
1638
|
+
/**
|
|
1639
|
+
* Base64 encoded file content.
|
|
1640
|
+
* @type {string}
|
|
1641
|
+
* @memberof GenerateDocument200Response
|
|
1642
|
+
*/
|
|
1643
|
+
data?: string;
|
|
1644
|
+
/**
|
|
1645
|
+
* The document content type.
|
|
1646
|
+
* @type {string}
|
|
1647
|
+
* @memberof GenerateDocument200Response
|
|
1648
|
+
*/
|
|
1649
|
+
contentType?: string;
|
|
1650
|
+
}
|
|
1651
|
+
/**
|
|
1652
|
+
* Check if a given object implements the GenerateDocument200Response interface.
|
|
1653
|
+
*/
|
|
1654
|
+
declare function instanceOfGenerateDocument200Response(value: object): value is GenerateDocument200Response;
|
|
1655
|
+
declare function GenerateDocument200ResponseFromJSON(json: any): GenerateDocument200Response;
|
|
1656
|
+
declare function GenerateDocument200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GenerateDocument200Response;
|
|
1657
|
+
declare function GenerateDocument200ResponseToJSON(json: any): GenerateDocument200Response;
|
|
1658
|
+
declare function GenerateDocument200ResponseToJSONTyped(value?: GenerateDocument200Response | null, ignoreDiscriminator?: boolean): any;
|
|
1659
|
+
|
|
1660
|
+
/**
|
|
1661
|
+
* Quick Base API
|
|
1662
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1663
|
+
*
|
|
1664
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1665
|
+
*
|
|
1666
|
+
*
|
|
1667
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1668
|
+
* https://openapi-generator.tech
|
|
1669
|
+
* Do not edit the class manually.
|
|
1670
|
+
*/
|
|
1671
|
+
/**
|
|
1672
|
+
*
|
|
1673
|
+
* @export
|
|
1674
|
+
* @interface GetField200Response
|
|
1675
|
+
*/
|
|
1676
|
+
interface GetField200Response {
|
|
1677
|
+
[key: string]: any | any;
|
|
1678
|
+
/**
|
|
1679
|
+
* The id of the field, unique to this table.
|
|
1680
|
+
* @type {number}
|
|
1681
|
+
* @memberof GetField200Response
|
|
1682
|
+
*/
|
|
1683
|
+
id: number;
|
|
1684
|
+
/**
|
|
1685
|
+
* The type of field, as described [here](https://help.quickbase.com/user-assistance/field_types.html).
|
|
1686
|
+
* @type {string}
|
|
1687
|
+
* @memberof GetField200Response
|
|
1688
|
+
*/
|
|
1689
|
+
fieldType?: string;
|
|
1690
|
+
/**
|
|
1691
|
+
* 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.
|
|
1692
|
+
* @type {string}
|
|
1693
|
+
* @memberof GetField200Response
|
|
1694
|
+
*/
|
|
1695
|
+
mode?: string;
|
|
1696
|
+
/**
|
|
1697
|
+
* The label (name) of the field.
|
|
1698
|
+
* @type {string}
|
|
1699
|
+
* @memberof GetField200Response
|
|
1700
|
+
*/
|
|
1701
|
+
label?: string;
|
|
1702
|
+
/**
|
|
1703
|
+
* Indicates if the field is configured to not wrap when displayed in the product.
|
|
1704
|
+
* @type {boolean}
|
|
1705
|
+
* @memberof GetField200Response
|
|
1706
|
+
*/
|
|
1707
|
+
noWrap?: boolean;
|
|
1708
|
+
/**
|
|
1709
|
+
* Indicates if the field is configured to display in bold in the product.
|
|
1710
|
+
* @type {boolean}
|
|
1711
|
+
* @memberof GetField200Response
|
|
1712
|
+
*/
|
|
1713
|
+
bold?: boolean;
|
|
1714
|
+
/**
|
|
1715
|
+
* Indicates if the field is marked required.
|
|
1716
|
+
* @type {boolean}
|
|
1717
|
+
* @memberof GetField200Response
|
|
1718
|
+
*/
|
|
1719
|
+
required?: boolean;
|
|
1720
|
+
/**
|
|
1721
|
+
* Indicates if the field is marked as a default in reports.
|
|
1722
|
+
* @type {boolean}
|
|
1723
|
+
* @memberof GetField200Response
|
|
1724
|
+
*/
|
|
1725
|
+
appearsByDefault?: boolean;
|
|
1726
|
+
/**
|
|
1727
|
+
* Indicates if the field is marked as searchable.
|
|
1728
|
+
* @type {boolean}
|
|
1729
|
+
* @memberof GetField200Response
|
|
1730
|
+
*/
|
|
1731
|
+
findEnabled?: boolean;
|
|
1732
|
+
/**
|
|
1733
|
+
* Indicates if the field is marked unique.
|
|
1734
|
+
* @type {boolean}
|
|
1735
|
+
* @memberof GetField200Response
|
|
1736
|
+
*/
|
|
1737
|
+
unique?: boolean;
|
|
1738
|
+
/**
|
|
1739
|
+
* Indicates if the field data will copy when a user copies the record.
|
|
1740
|
+
* @type {boolean}
|
|
1741
|
+
* @memberof GetField200Response
|
|
1742
|
+
*/
|
|
1743
|
+
doesDataCopy?: boolean;
|
|
1744
|
+
/**
|
|
1745
|
+
* The configured help text shown to users within the product.
|
|
1746
|
+
* @type {string}
|
|
1747
|
+
* @memberof GetField200Response
|
|
1748
|
+
*/
|
|
1749
|
+
fieldHelp?: string;
|
|
1750
|
+
/**
|
|
1751
|
+
* Indicates if the field is being tracked as part of Quickbase Audit Logs.
|
|
1752
|
+
* @type {boolean}
|
|
1753
|
+
* @memberof GetField200Response
|
|
1754
|
+
*/
|
|
1755
|
+
audited?: boolean;
|
|
1756
|
+
/**
|
|
1757
|
+
* Additional properties for the field. Please see [Field type details](../fieldInfo) page for more details on the properties for each field type.
|
|
1758
|
+
* @type {{ [key: string]: any; }}
|
|
1759
|
+
* @memberof GetField200Response
|
|
1760
|
+
*/
|
|
1761
|
+
properties?: {
|
|
1762
|
+
[key: string]: any;
|
|
1763
|
+
};
|
|
1764
|
+
/**
|
|
1765
|
+
* Field Permissions for different roles.
|
|
1766
|
+
* @type {Array<object>}
|
|
1767
|
+
* @memberof GetField200Response
|
|
1768
|
+
*/
|
|
1769
|
+
permissions?: Array<object>;
|
|
1770
|
+
}
|
|
1771
|
+
/**
|
|
1772
|
+
* Check if a given object implements the GetField200Response interface.
|
|
1773
|
+
*/
|
|
1774
|
+
declare function instanceOfGetField200Response(value: object): value is GetField200Response;
|
|
1775
|
+
declare function GetField200ResponseFromJSON(json: any): GetField200Response;
|
|
1776
|
+
declare function GetField200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetField200Response;
|
|
1777
|
+
declare function GetField200ResponseToJSON(json: any): GetField200Response;
|
|
1778
|
+
declare function GetField200ResponseToJSONTyped(value?: GetField200Response | null, ignoreDiscriminator?: boolean): any;
|
|
1779
|
+
|
|
1780
|
+
/**
|
|
1781
|
+
* Quick Base API
|
|
1782
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1783
|
+
*
|
|
1784
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1785
|
+
*
|
|
1786
|
+
*
|
|
1787
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1788
|
+
* https://openapi-generator.tech
|
|
1789
|
+
* Do not edit the class manually.
|
|
1790
|
+
*/
|
|
1791
|
+
/**
|
|
1792
|
+
*
|
|
1793
|
+
* @export
|
|
1794
|
+
* @interface GetRelationships200Response
|
|
1795
|
+
*/
|
|
1796
|
+
interface GetRelationships200Response {
|
|
1797
|
+
[key: string]: any | any;
|
|
1798
|
+
/**
|
|
1799
|
+
* The relationships in a table.
|
|
1800
|
+
* @type {Array<{ [key: string]: any; }>}
|
|
1801
|
+
* @memberof GetRelationships200Response
|
|
1802
|
+
*/
|
|
1803
|
+
relationships: Array<{
|
|
1804
|
+
[key: string]: any;
|
|
1805
|
+
}>;
|
|
1806
|
+
/**
|
|
1807
|
+
* Additional information about the results that may be helpful.
|
|
1808
|
+
* @type {{ [key: string]: any; }}
|
|
1809
|
+
* @memberof GetRelationships200Response
|
|
1810
|
+
*/
|
|
1811
|
+
metadata?: {
|
|
1812
|
+
[key: string]: any;
|
|
1813
|
+
};
|
|
1814
|
+
}
|
|
1815
|
+
/**
|
|
1816
|
+
* Check if a given object implements the GetRelationships200Response interface.
|
|
1817
|
+
*/
|
|
1818
|
+
declare function instanceOfGetRelationships200Response(value: object): value is GetRelationships200Response;
|
|
1819
|
+
declare function GetRelationships200ResponseFromJSON(json: any): GetRelationships200Response;
|
|
1820
|
+
declare function GetRelationships200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetRelationships200Response;
|
|
1821
|
+
declare function GetRelationships200ResponseToJSON(json: any): GetRelationships200Response;
|
|
1822
|
+
declare function GetRelationships200ResponseToJSONTyped(value?: GetRelationships200Response | null, ignoreDiscriminator?: boolean): any;
|
|
1823
|
+
|
|
1824
|
+
/**
|
|
1825
|
+
* Quick Base API
|
|
1826
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1827
|
+
*
|
|
1828
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1829
|
+
*
|
|
1830
|
+
*
|
|
1831
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1832
|
+
* https://openapi-generator.tech
|
|
1833
|
+
* Do not edit the class manually.
|
|
1834
|
+
*/
|
|
1835
|
+
/**
|
|
1836
|
+
*
|
|
1837
|
+
* @export
|
|
1838
|
+
* @interface GetReport200Response
|
|
1839
|
+
*/
|
|
1840
|
+
interface GetReport200Response {
|
|
1841
|
+
[key: string]: any | any;
|
|
1842
|
+
/**
|
|
1843
|
+
* The identifier of the report, unique to the table.
|
|
1844
|
+
* @type {string}
|
|
1845
|
+
* @memberof GetReport200Response
|
|
1846
|
+
*/
|
|
1847
|
+
id?: string;
|
|
1848
|
+
/**
|
|
1849
|
+
* The configured name of the report.
|
|
1850
|
+
* @type {string}
|
|
1851
|
+
* @memberof GetReport200Response
|
|
1852
|
+
*/
|
|
1853
|
+
name?: string;
|
|
1854
|
+
/**
|
|
1855
|
+
* The type of report in Quickbase (e.g., chart).
|
|
1856
|
+
* @type {string}
|
|
1857
|
+
* @memberof GetReport200Response
|
|
1858
|
+
*/
|
|
1859
|
+
type?: string;
|
|
1860
|
+
/**
|
|
1861
|
+
* The configured description of a report.
|
|
1862
|
+
* @type {string}
|
|
1863
|
+
* @memberof GetReport200Response
|
|
1864
|
+
*/
|
|
1865
|
+
description?: string;
|
|
1866
|
+
/**
|
|
1867
|
+
* Optional, showed only for personal reports. The user ID of report owner.
|
|
1868
|
+
* @type {number}
|
|
1869
|
+
* @memberof GetReport200Response
|
|
1870
|
+
*/
|
|
1871
|
+
ownerId?: number;
|
|
1872
|
+
/**
|
|
1873
|
+
* The query definition as configured in Quickbase that gets executed when the report is run.
|
|
1874
|
+
* @type {{ [key: string]: any; }}
|
|
1875
|
+
* @memberof GetReport200Response
|
|
1876
|
+
*/
|
|
1877
|
+
query?: {
|
|
1878
|
+
[key: string]: any;
|
|
1879
|
+
};
|
|
1880
|
+
/**
|
|
1881
|
+
* 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)
|
|
1882
|
+
* @type {{ [key: string]: any; }}
|
|
1883
|
+
* @memberof GetReport200Response
|
|
1884
|
+
*/
|
|
1885
|
+
properties?: {
|
|
1886
|
+
[key: string]: any;
|
|
1887
|
+
};
|
|
1888
|
+
/**
|
|
1889
|
+
* The instant at which a report was last used.
|
|
1890
|
+
* @type {string}
|
|
1891
|
+
* @memberof GetReport200Response
|
|
1892
|
+
*/
|
|
1893
|
+
usedLast?: string;
|
|
1894
|
+
/**
|
|
1895
|
+
* The number of times a report has been used.
|
|
1896
|
+
* @type {number}
|
|
1897
|
+
* @memberof GetReport200Response
|
|
1898
|
+
*/
|
|
1899
|
+
usedCount?: number;
|
|
1900
|
+
}
|
|
1901
|
+
/**
|
|
1902
|
+
* Check if a given object implements the GetReport200Response interface.
|
|
1903
|
+
*/
|
|
1904
|
+
declare function instanceOfGetReport200Response(value: object): value is GetReport200Response;
|
|
1905
|
+
declare function GetReport200ResponseFromJSON(json: any): GetReport200Response;
|
|
1906
|
+
declare function GetReport200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetReport200Response;
|
|
1907
|
+
declare function GetReport200ResponseToJSON(json: any): GetReport200Response;
|
|
1908
|
+
declare function GetReport200ResponseToJSONTyped(value?: GetReport200Response | null, ignoreDiscriminator?: boolean): any;
|
|
1909
|
+
|
|
1910
|
+
/**
|
|
1911
|
+
* Quick Base API
|
|
1912
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1913
|
+
*
|
|
1914
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1915
|
+
*
|
|
1916
|
+
*
|
|
1917
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1918
|
+
* https://openapi-generator.tech
|
|
1919
|
+
* Do not edit the class manually.
|
|
1920
|
+
*/
|
|
1921
|
+
/**
|
|
1922
|
+
*
|
|
1923
|
+
* @export
|
|
1924
|
+
* @interface GetTable200Response
|
|
1925
|
+
*/
|
|
1926
|
+
interface GetTable200Response {
|
|
1927
|
+
[key: string]: any | any;
|
|
1928
|
+
/**
|
|
1929
|
+
* The name of the table.
|
|
1930
|
+
* @type {string}
|
|
1931
|
+
* @memberof GetTable200Response
|
|
1932
|
+
*/
|
|
1933
|
+
name?: string;
|
|
1934
|
+
/**
|
|
1935
|
+
* The unique identifier (dbid) of the table.
|
|
1936
|
+
* @type {string}
|
|
1937
|
+
* @memberof GetTable200Response
|
|
1938
|
+
*/
|
|
1939
|
+
id?: string;
|
|
1940
|
+
/**
|
|
1941
|
+
* The automatically-created table alias for the table.
|
|
1942
|
+
* @type {string}
|
|
1943
|
+
* @memberof GetTable200Response
|
|
1944
|
+
*/
|
|
1945
|
+
alias?: string;
|
|
1946
|
+
/**
|
|
1947
|
+
* The description of the table, as configured by an application administrator.
|
|
1948
|
+
* @type {string}
|
|
1949
|
+
* @memberof GetTable200Response
|
|
1950
|
+
*/
|
|
1951
|
+
description?: string;
|
|
1952
|
+
/**
|
|
1953
|
+
* 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).
|
|
1954
|
+
* @type {string}
|
|
1955
|
+
* @memberof GetTable200Response
|
|
1956
|
+
*/
|
|
1957
|
+
created?: string;
|
|
1958
|
+
/**
|
|
1959
|
+
* 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).
|
|
1960
|
+
* @type {string}
|
|
1961
|
+
* @memberof GetTable200Response
|
|
1962
|
+
*/
|
|
1963
|
+
updated?: string;
|
|
1964
|
+
/**
|
|
1965
|
+
* The incremental Record ID that will be used when the next record is created, as determined when the API call was ran.
|
|
1966
|
+
* @type {number}
|
|
1967
|
+
* @memberof GetTable200Response
|
|
1968
|
+
*/
|
|
1969
|
+
nextRecordId?: number;
|
|
1970
|
+
/**
|
|
1971
|
+
* The incremental Field ID that will be used when the next field is created, as determined when the API call was ran.
|
|
1972
|
+
* @type {number}
|
|
1973
|
+
* @memberof GetTable200Response
|
|
1974
|
+
*/
|
|
1975
|
+
nextFieldId?: number;
|
|
1976
|
+
/**
|
|
1977
|
+
* The id of the field that is configured for default sorting.
|
|
1978
|
+
* @type {number}
|
|
1979
|
+
* @memberof GetTable200Response
|
|
1980
|
+
*/
|
|
1981
|
+
defaultSortFieldId?: number;
|
|
1982
|
+
/**
|
|
1983
|
+
* The configuration of the default sort order on the table.
|
|
1984
|
+
* @type {string}
|
|
1985
|
+
* @memberof GetTable200Response
|
|
1986
|
+
*/
|
|
1987
|
+
defaultSortOrder?: GetTable200ResponseDefaultSortOrderEnum;
|
|
1988
|
+
/**
|
|
1989
|
+
* The id of the field that is configured to be the key on this table, which is usually the Quickbase Record ID.
|
|
1990
|
+
* @type {number}
|
|
1991
|
+
* @memberof GetTable200Response
|
|
1992
|
+
*/
|
|
1993
|
+
keyFieldId?: number;
|
|
1994
|
+
/**
|
|
1995
|
+
* The builder-configured singular noun of the table.
|
|
1996
|
+
* @type {string}
|
|
1997
|
+
* @memberof GetTable200Response
|
|
1998
|
+
*/
|
|
1999
|
+
singleRecordName?: string;
|
|
2000
|
+
/**
|
|
2001
|
+
* The builder-configured plural noun of the table.
|
|
2002
|
+
* @type {string}
|
|
2003
|
+
* @memberof GetTable200Response
|
|
2004
|
+
*/
|
|
2005
|
+
pluralRecordName?: string;
|
|
2006
|
+
/**
|
|
2007
|
+
* The size limit for the table.
|
|
2008
|
+
* @type {string}
|
|
2009
|
+
* @memberof GetTable200Response
|
|
2010
|
+
*/
|
|
2011
|
+
sizeLimit?: string;
|
|
2012
|
+
/**
|
|
2013
|
+
* The amount of space currently being used by the table.
|
|
2014
|
+
* @type {string}
|
|
2015
|
+
* @memberof GetTable200Response
|
|
2016
|
+
*/
|
|
2017
|
+
spaceUsed?: string;
|
|
2018
|
+
/**
|
|
2019
|
+
* The amount of space remaining for use by the table.
|
|
2020
|
+
* @type {string}
|
|
2021
|
+
* @memberof GetTable200Response
|
|
2022
|
+
*/
|
|
2023
|
+
spaceRemaining?: string;
|
|
2024
|
+
}
|
|
2025
|
+
/**
|
|
2026
|
+
* @export
|
|
2027
|
+
*/
|
|
2028
|
+
declare const GetTable200ResponseDefaultSortOrderEnum: {
|
|
2029
|
+
readonly Asc: "ASC";
|
|
2030
|
+
readonly Desc: "DESC";
|
|
2031
|
+
};
|
|
2032
|
+
type GetTable200ResponseDefaultSortOrderEnum = typeof GetTable200ResponseDefaultSortOrderEnum[keyof typeof GetTable200ResponseDefaultSortOrderEnum];
|
|
2033
|
+
/**
|
|
2034
|
+
* Check if a given object implements the GetTable200Response interface.
|
|
2035
|
+
*/
|
|
2036
|
+
declare function instanceOfGetTable200Response(value: object): value is GetTable200Response;
|
|
2037
|
+
declare function GetTable200ResponseFromJSON(json: any): GetTable200Response;
|
|
2038
|
+
declare function GetTable200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetTable200Response;
|
|
2039
|
+
declare function GetTable200ResponseToJSON(json: any): GetTable200Response;
|
|
2040
|
+
declare function GetTable200ResponseToJSONTyped(value?: GetTable200Response | null, ignoreDiscriminator?: boolean): any;
|
|
2041
|
+
|
|
2042
|
+
/**
|
|
2043
|
+
* Quick Base API
|
|
2044
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2045
|
+
*
|
|
2046
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2047
|
+
*
|
|
2048
|
+
*
|
|
2049
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2050
|
+
* https://openapi-generator.tech
|
|
2051
|
+
* Do not edit the class manually.
|
|
2052
|
+
*/
|
|
2053
|
+
/**
|
|
2054
|
+
*
|
|
2055
|
+
* @export
|
|
2056
|
+
* @interface GetTempTokenDBID200Response
|
|
2057
|
+
*/
|
|
2058
|
+
interface GetTempTokenDBID200Response {
|
|
2059
|
+
/**
|
|
2060
|
+
*
|
|
2061
|
+
* @type {string}
|
|
2062
|
+
* @memberof GetTempTokenDBID200Response
|
|
2063
|
+
*/
|
|
2064
|
+
temporaryAuthorization: string;
|
|
2065
|
+
}
|
|
2066
|
+
/**
|
|
2067
|
+
* Check if a given object implements the GetTempTokenDBID200Response interface.
|
|
2068
|
+
*/
|
|
2069
|
+
declare function instanceOfGetTempTokenDBID200Response(value: object): value is GetTempTokenDBID200Response;
|
|
2070
|
+
declare function GetTempTokenDBID200ResponseFromJSON(json: any): GetTempTokenDBID200Response;
|
|
2071
|
+
declare function GetTempTokenDBID200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetTempTokenDBID200Response;
|
|
2072
|
+
declare function GetTempTokenDBID200ResponseToJSON(json: any): GetTempTokenDBID200Response;
|
|
2073
|
+
declare function GetTempTokenDBID200ResponseToJSONTyped(value?: GetTempTokenDBID200Response | null, ignoreDiscriminator?: boolean): any;
|
|
2074
|
+
|
|
2075
|
+
/**
|
|
2076
|
+
* Quick Base API
|
|
2077
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2078
|
+
*
|
|
2079
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2080
|
+
*
|
|
2081
|
+
*
|
|
2082
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2083
|
+
* https://openapi-generator.tech
|
|
2084
|
+
* Do not edit the class manually.
|
|
2085
|
+
*/
|
|
2086
|
+
/**
|
|
2087
|
+
*
|
|
2088
|
+
* @export
|
|
2089
|
+
* @interface GetUsers200Response
|
|
2090
|
+
*/
|
|
2091
|
+
interface GetUsers200Response {
|
|
2092
|
+
[key: string]: any | any;
|
|
2093
|
+
/**
|
|
2094
|
+
* A list of users found in an account with the given criterias
|
|
2095
|
+
* @type {Array<{ [key: string]: any; }>}
|
|
2096
|
+
* @memberof GetUsers200Response
|
|
2097
|
+
*/
|
|
2098
|
+
users: Array<{
|
|
2099
|
+
[key: string]: any;
|
|
2100
|
+
}>;
|
|
2101
|
+
/**
|
|
2102
|
+
* Additional request information
|
|
2103
|
+
* @type {{ [key: string]: any; }}
|
|
2104
|
+
* @memberof GetUsers200Response
|
|
2105
|
+
*/
|
|
2106
|
+
metadata: {
|
|
2107
|
+
[key: string]: any;
|
|
2108
|
+
};
|
|
2109
|
+
}
|
|
2110
|
+
/**
|
|
2111
|
+
* Check if a given object implements the GetUsers200Response interface.
|
|
2112
|
+
*/
|
|
2113
|
+
declare function instanceOfGetUsers200Response(value: object): value is GetUsers200Response;
|
|
2114
|
+
declare function GetUsers200ResponseFromJSON(json: any): GetUsers200Response;
|
|
2115
|
+
declare function GetUsers200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUsers200Response;
|
|
2116
|
+
declare function GetUsers200ResponseToJSON(json: any): GetUsers200Response;
|
|
2117
|
+
declare function GetUsers200ResponseToJSONTyped(value?: GetUsers200Response | null, ignoreDiscriminator?: boolean): any;
|
|
2118
|
+
|
|
2119
|
+
/**
|
|
2120
|
+
* Quick Base API
|
|
2121
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2122
|
+
*
|
|
2123
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2124
|
+
*
|
|
2125
|
+
*
|
|
2126
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2127
|
+
* https://openapi-generator.tech
|
|
2128
|
+
* Do not edit the class manually.
|
|
2129
|
+
*/
|
|
2130
|
+
/**
|
|
2131
|
+
*
|
|
2132
|
+
* @export
|
|
2133
|
+
* @interface GetUsersRequest
|
|
2134
|
+
*/
|
|
2135
|
+
interface GetUsersRequest {
|
|
2136
|
+
[key: string]: any | any;
|
|
2137
|
+
/**
|
|
2138
|
+
* When provided, the returned users will be narrowed down only to the users included in this list.
|
|
2139
|
+
* @type {Set<string>}
|
|
2140
|
+
* @memberof GetUsersRequest
|
|
2141
|
+
*/
|
|
2142
|
+
emails?: Set<string>;
|
|
2143
|
+
/**
|
|
2144
|
+
* When provided, the returned users will be narrowed down only to the users assigned to the app id's provided in this list. The provided app id's should belong to the same account.
|
|
2145
|
+
* @type {Set<string>}
|
|
2146
|
+
* @memberof GetUsersRequest
|
|
2147
|
+
*/
|
|
2148
|
+
appIds?: Set<string>;
|
|
2149
|
+
/**
|
|
2150
|
+
* Next page token used to get the next 'page' of results when available. When this field is empty, the first page is returned.
|
|
2151
|
+
* @type {string}
|
|
2152
|
+
* @memberof GetUsersRequest
|
|
2153
|
+
*/
|
|
2154
|
+
nextPageToken?: string;
|
|
2155
|
+
}
|
|
2156
|
+
/**
|
|
2157
|
+
* Check if a given object implements the GetUsersRequest interface.
|
|
2158
|
+
*/
|
|
2159
|
+
declare function instanceOfGetUsersRequest(value: object): value is GetUsersRequest;
|
|
2160
|
+
declare function GetUsersRequestFromJSON(json: any): GetUsersRequest;
|
|
2161
|
+
declare function GetUsersRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUsersRequest;
|
|
2162
|
+
declare function GetUsersRequestToJSON(json: any): GetUsersRequest;
|
|
2163
|
+
declare function GetUsersRequestToJSONTyped(value?: GetUsersRequest | null, ignoreDiscriminator?: boolean): any;
|
|
2164
|
+
|
|
2165
|
+
/**
|
|
2166
|
+
* Quick Base API
|
|
2167
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2168
|
+
*
|
|
2169
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2170
|
+
*
|
|
2171
|
+
*
|
|
2172
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2173
|
+
* https://openapi-generator.tech
|
|
2174
|
+
* Do not edit the class manually.
|
|
2175
|
+
*/
|
|
2176
|
+
/**
|
|
2177
|
+
*
|
|
2178
|
+
* @export
|
|
2179
|
+
* @interface PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInner
|
|
2180
|
+
*/
|
|
2181
|
+
interface PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInner {
|
|
2182
|
+
/**
|
|
2183
|
+
* Billing category of the event type.
|
|
2184
|
+
* @type {string}
|
|
2185
|
+
* @memberof PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInner
|
|
2186
|
+
*/
|
|
2187
|
+
billingCategory?: PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInnerBillingCategoryEnum;
|
|
2188
|
+
/**
|
|
2189
|
+
* Count of events associated with that event type and Application/User.
|
|
2190
|
+
* @type {number}
|
|
2191
|
+
* @memberof PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInner
|
|
2192
|
+
*/
|
|
2193
|
+
count?: number;
|
|
2194
|
+
/**
|
|
2195
|
+
* Event type
|
|
2196
|
+
* @type {string}
|
|
2197
|
+
* @memberof PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInner
|
|
2198
|
+
*/
|
|
2199
|
+
eventType?: string;
|
|
2200
|
+
}
|
|
2201
|
+
/**
|
|
2202
|
+
* @export
|
|
2203
|
+
*/
|
|
2204
|
+
declare const PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInnerBillingCategoryEnum: {
|
|
2205
|
+
readonly User: "user";
|
|
2206
|
+
readonly Integration: "integration";
|
|
2207
|
+
};
|
|
2208
|
+
type PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInnerBillingCategoryEnum = typeof PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInnerBillingCategoryEnum[keyof typeof PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInnerBillingCategoryEnum];
|
|
2209
|
+
/**
|
|
2210
|
+
* Check if a given object implements the PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInner interface.
|
|
2211
|
+
*/
|
|
2212
|
+
declare function instanceOfPlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInner(value: object): value is PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInner;
|
|
2213
|
+
declare function PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInnerFromJSON(json: any): PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInner;
|
|
2214
|
+
declare function PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInner;
|
|
2215
|
+
declare function PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInnerToJSON(json: any): PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInner;
|
|
2216
|
+
declare function PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInnerToJSONTyped(value?: PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInner | null, ignoreDiscriminator?: boolean): any;
|
|
2217
|
+
|
|
2218
|
+
/**
|
|
2219
|
+
* Quick Base API
|
|
2220
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2221
|
+
*
|
|
2222
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2223
|
+
*
|
|
2224
|
+
*
|
|
2225
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2226
|
+
* https://openapi-generator.tech
|
|
2227
|
+
* Do not edit the class manually.
|
|
2228
|
+
*/
|
|
2229
|
+
/**
|
|
2230
|
+
* Totals by billing category for the event grouping.
|
|
2231
|
+
* @export
|
|
2232
|
+
* @interface PlatformAnalyticEventSummaries200ResponseResultsInnerTotals
|
|
2233
|
+
*/
|
|
2234
|
+
interface PlatformAnalyticEventSummaries200ResponseResultsInnerTotals {
|
|
2235
|
+
/**
|
|
2236
|
+
*
|
|
2237
|
+
* @type {number}
|
|
2238
|
+
* @memberof PlatformAnalyticEventSummaries200ResponseResultsInnerTotals
|
|
2239
|
+
*/
|
|
2240
|
+
all?: number;
|
|
2241
|
+
/**
|
|
2242
|
+
*
|
|
2243
|
+
* @type {number}
|
|
2244
|
+
* @memberof PlatformAnalyticEventSummaries200ResponseResultsInnerTotals
|
|
2245
|
+
*/
|
|
2246
|
+
integration?: number;
|
|
2247
|
+
/**
|
|
2248
|
+
*
|
|
2249
|
+
* @type {number}
|
|
2250
|
+
* @memberof PlatformAnalyticEventSummaries200ResponseResultsInnerTotals
|
|
2251
|
+
*/
|
|
2252
|
+
user?: number;
|
|
2253
|
+
}
|
|
2254
|
+
/**
|
|
2255
|
+
* Check if a given object implements the PlatformAnalyticEventSummaries200ResponseResultsInnerTotals interface.
|
|
2256
|
+
*/
|
|
2257
|
+
declare function instanceOfPlatformAnalyticEventSummaries200ResponseResultsInnerTotals(value: object): value is PlatformAnalyticEventSummaries200ResponseResultsInnerTotals;
|
|
2258
|
+
declare function PlatformAnalyticEventSummaries200ResponseResultsInnerTotalsFromJSON(json: any): PlatformAnalyticEventSummaries200ResponseResultsInnerTotals;
|
|
2259
|
+
declare function PlatformAnalyticEventSummaries200ResponseResultsInnerTotalsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PlatformAnalyticEventSummaries200ResponseResultsInnerTotals;
|
|
2260
|
+
declare function PlatformAnalyticEventSummaries200ResponseResultsInnerTotalsToJSON(json: any): PlatformAnalyticEventSummaries200ResponseResultsInnerTotals;
|
|
2261
|
+
declare function PlatformAnalyticEventSummaries200ResponseResultsInnerTotalsToJSONTyped(value?: PlatformAnalyticEventSummaries200ResponseResultsInnerTotals | null, ignoreDiscriminator?: boolean): any;
|
|
2262
|
+
|
|
2263
|
+
/**
|
|
2264
|
+
* Quick Base API
|
|
2265
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2266
|
+
*
|
|
2267
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2268
|
+
*
|
|
2269
|
+
*
|
|
2270
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2271
|
+
* https://openapi-generator.tech
|
|
2272
|
+
* Do not edit the class manually.
|
|
2273
|
+
*/
|
|
2274
|
+
|
|
2275
|
+
/**
|
|
2276
|
+
*
|
|
2277
|
+
* @export
|
|
2278
|
+
* @interface PlatformAnalyticEventSummaries200ResponseResultsInner
|
|
2279
|
+
*/
|
|
2280
|
+
interface PlatformAnalyticEventSummaries200ResponseResultsInner {
|
|
2281
|
+
/**
|
|
2282
|
+
* An array of events that contains specific information associated with an Application/User broken down by event type.
|
|
2283
|
+
* @type {Array<PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInner>}
|
|
2284
|
+
* @memberof PlatformAnalyticEventSummaries200ResponseResultsInner
|
|
2285
|
+
*/
|
|
2286
|
+
eventTypes: Array<PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInner>;
|
|
2287
|
+
/**
|
|
2288
|
+
* Id of the Application/User.
|
|
2289
|
+
* @type {string}
|
|
2290
|
+
* @memberof PlatformAnalyticEventSummaries200ResponseResultsInner
|
|
2291
|
+
*/
|
|
2292
|
+
id: string;
|
|
2293
|
+
/**
|
|
2294
|
+
* Name of the Application/User.
|
|
2295
|
+
* @type {string}
|
|
2296
|
+
* @memberof PlatformAnalyticEventSummaries200ResponseResultsInner
|
|
2297
|
+
*/
|
|
2298
|
+
name: string;
|
|
2299
|
+
/**
|
|
2300
|
+
*
|
|
2301
|
+
* @type {PlatformAnalyticEventSummaries200ResponseResultsInnerTotals}
|
|
2302
|
+
* @memberof PlatformAnalyticEventSummaries200ResponseResultsInner
|
|
2303
|
+
*/
|
|
2304
|
+
totals: PlatformAnalyticEventSummaries200ResponseResultsInnerTotals;
|
|
2305
|
+
}
|
|
2306
|
+
/**
|
|
2307
|
+
* Check if a given object implements the PlatformAnalyticEventSummaries200ResponseResultsInner interface.
|
|
2308
|
+
*/
|
|
2309
|
+
declare function instanceOfPlatformAnalyticEventSummaries200ResponseResultsInner(value: object): value is PlatformAnalyticEventSummaries200ResponseResultsInner;
|
|
2310
|
+
declare function PlatformAnalyticEventSummaries200ResponseResultsInnerFromJSON(json: any): PlatformAnalyticEventSummaries200ResponseResultsInner;
|
|
2311
|
+
declare function PlatformAnalyticEventSummaries200ResponseResultsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): PlatformAnalyticEventSummaries200ResponseResultsInner;
|
|
2312
|
+
declare function PlatformAnalyticEventSummaries200ResponseResultsInnerToJSON(json: any): PlatformAnalyticEventSummaries200ResponseResultsInner;
|
|
2313
|
+
declare function PlatformAnalyticEventSummaries200ResponseResultsInnerToJSONTyped(value?: PlatformAnalyticEventSummaries200ResponseResultsInner | null, ignoreDiscriminator?: boolean): any;
|
|
2314
|
+
|
|
2315
|
+
/**
|
|
2316
|
+
* Quick Base API
|
|
2317
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2318
|
+
*
|
|
2319
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2320
|
+
*
|
|
2321
|
+
*
|
|
2322
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2323
|
+
* https://openapi-generator.tech
|
|
2324
|
+
* Do not edit the class manually.
|
|
2325
|
+
*/
|
|
2326
|
+
/**
|
|
2327
|
+
* Additional information about the results that may be helpful.
|
|
2328
|
+
* @export
|
|
2329
|
+
* @interface PlatformAnalyticEventSummaries200ResponseMetadata
|
|
2330
|
+
*/
|
|
2331
|
+
interface PlatformAnalyticEventSummaries200ResponseMetadata {
|
|
2332
|
+
/**
|
|
2333
|
+
* Supply this token in a subsequent request to fetch the next page of results.
|
|
2334
|
+
* @type {string}
|
|
2335
|
+
* @memberof PlatformAnalyticEventSummaries200ResponseMetadata
|
|
2336
|
+
*/
|
|
2337
|
+
nextToken: string;
|
|
2338
|
+
}
|
|
2339
|
+
/**
|
|
2340
|
+
* Check if a given object implements the PlatformAnalyticEventSummaries200ResponseMetadata interface.
|
|
2341
|
+
*/
|
|
2342
|
+
declare function instanceOfPlatformAnalyticEventSummaries200ResponseMetadata(value: object): value is PlatformAnalyticEventSummaries200ResponseMetadata;
|
|
2343
|
+
declare function PlatformAnalyticEventSummaries200ResponseMetadataFromJSON(json: any): PlatformAnalyticEventSummaries200ResponseMetadata;
|
|
2344
|
+
declare function PlatformAnalyticEventSummaries200ResponseMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): PlatformAnalyticEventSummaries200ResponseMetadata;
|
|
2345
|
+
declare function PlatformAnalyticEventSummaries200ResponseMetadataToJSON(json: any): PlatformAnalyticEventSummaries200ResponseMetadata;
|
|
2346
|
+
declare function PlatformAnalyticEventSummaries200ResponseMetadataToJSONTyped(value?: PlatformAnalyticEventSummaries200ResponseMetadata | null, ignoreDiscriminator?: boolean): any;
|
|
2347
|
+
|
|
2348
|
+
/**
|
|
2349
|
+
* Quick Base API
|
|
2350
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2351
|
+
*
|
|
2352
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2353
|
+
*
|
|
2354
|
+
*
|
|
2355
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2356
|
+
* https://openapi-generator.tech
|
|
2357
|
+
* Do not edit the class manually.
|
|
2358
|
+
*/
|
|
2359
|
+
/**
|
|
2360
|
+
*
|
|
2361
|
+
* @export
|
|
2362
|
+
* @interface PlatformAnalyticEventSummaries200ResponseWhereInner
|
|
2363
|
+
*/
|
|
2364
|
+
interface PlatformAnalyticEventSummaries200ResponseWhereInner {
|
|
2365
|
+
/**
|
|
2366
|
+
* Id of the item to filter by.
|
|
2367
|
+
* @type {string}
|
|
2368
|
+
* @memberof PlatformAnalyticEventSummaries200ResponseWhereInner
|
|
2369
|
+
*/
|
|
2370
|
+
id: string;
|
|
2371
|
+
/**
|
|
2372
|
+
* The type of item to filter by.
|
|
2373
|
+
* @type {string}
|
|
2374
|
+
* @memberof PlatformAnalyticEventSummaries200ResponseWhereInner
|
|
2375
|
+
*/
|
|
2376
|
+
type: PlatformAnalyticEventSummaries200ResponseWhereInnerTypeEnum;
|
|
2377
|
+
}
|
|
2378
|
+
/**
|
|
2379
|
+
* @export
|
|
2380
|
+
*/
|
|
2381
|
+
declare const PlatformAnalyticEventSummaries200ResponseWhereInnerTypeEnum: {
|
|
2382
|
+
readonly App: "app";
|
|
2383
|
+
readonly User: "user";
|
|
2384
|
+
};
|
|
2385
|
+
type PlatformAnalyticEventSummaries200ResponseWhereInnerTypeEnum = typeof PlatformAnalyticEventSummaries200ResponseWhereInnerTypeEnum[keyof typeof PlatformAnalyticEventSummaries200ResponseWhereInnerTypeEnum];
|
|
2386
|
+
/**
|
|
2387
|
+
* Check if a given object implements the PlatformAnalyticEventSummaries200ResponseWhereInner interface.
|
|
2388
|
+
*/
|
|
2389
|
+
declare function instanceOfPlatformAnalyticEventSummaries200ResponseWhereInner(value: object): value is PlatformAnalyticEventSummaries200ResponseWhereInner;
|
|
2390
|
+
declare function PlatformAnalyticEventSummaries200ResponseWhereInnerFromJSON(json: any): PlatformAnalyticEventSummaries200ResponseWhereInner;
|
|
2391
|
+
declare function PlatformAnalyticEventSummaries200ResponseWhereInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): PlatformAnalyticEventSummaries200ResponseWhereInner;
|
|
2392
|
+
declare function PlatformAnalyticEventSummaries200ResponseWhereInnerToJSON(json: any): PlatformAnalyticEventSummaries200ResponseWhereInner;
|
|
2393
|
+
declare function PlatformAnalyticEventSummaries200ResponseWhereInnerToJSONTyped(value?: PlatformAnalyticEventSummaries200ResponseWhereInner | null, ignoreDiscriminator?: boolean): any;
|
|
2394
|
+
|
|
2395
|
+
/**
|
|
2396
|
+
* Quick Base API
|
|
2397
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2398
|
+
*
|
|
2399
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2400
|
+
*
|
|
2401
|
+
*
|
|
2402
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2403
|
+
* https://openapi-generator.tech
|
|
2404
|
+
* Do not edit the class manually.
|
|
2405
|
+
*/
|
|
2406
|
+
/**
|
|
2407
|
+
* Totals by billing category for all queried events.
|
|
2408
|
+
* @export
|
|
2409
|
+
* @interface PlatformAnalyticEventSummaries200ResponseTotals
|
|
2410
|
+
*/
|
|
2411
|
+
interface PlatformAnalyticEventSummaries200ResponseTotals {
|
|
2412
|
+
/**
|
|
2413
|
+
*
|
|
2414
|
+
* @type {number}
|
|
2415
|
+
* @memberof PlatformAnalyticEventSummaries200ResponseTotals
|
|
2416
|
+
*/
|
|
2417
|
+
all?: number;
|
|
2418
|
+
/**
|
|
2419
|
+
*
|
|
2420
|
+
* @type {number}
|
|
2421
|
+
* @memberof PlatformAnalyticEventSummaries200ResponseTotals
|
|
2422
|
+
*/
|
|
2423
|
+
integration?: number;
|
|
2424
|
+
/**
|
|
2425
|
+
*
|
|
2426
|
+
* @type {number}
|
|
2427
|
+
* @memberof PlatformAnalyticEventSummaries200ResponseTotals
|
|
2428
|
+
*/
|
|
2429
|
+
user?: number;
|
|
2430
|
+
}
|
|
2431
|
+
/**
|
|
2432
|
+
* Check if a given object implements the PlatformAnalyticEventSummaries200ResponseTotals interface.
|
|
2433
|
+
*/
|
|
2434
|
+
declare function instanceOfPlatformAnalyticEventSummaries200ResponseTotals(value: object): value is PlatformAnalyticEventSummaries200ResponseTotals;
|
|
2435
|
+
declare function PlatformAnalyticEventSummaries200ResponseTotalsFromJSON(json: any): PlatformAnalyticEventSummaries200ResponseTotals;
|
|
2436
|
+
declare function PlatformAnalyticEventSummaries200ResponseTotalsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PlatformAnalyticEventSummaries200ResponseTotals;
|
|
2437
|
+
declare function PlatformAnalyticEventSummaries200ResponseTotalsToJSON(json: any): PlatformAnalyticEventSummaries200ResponseTotals;
|
|
2438
|
+
declare function PlatformAnalyticEventSummaries200ResponseTotalsToJSONTyped(value?: PlatformAnalyticEventSummaries200ResponseTotals | null, ignoreDiscriminator?: boolean): any;
|
|
2439
|
+
|
|
2440
|
+
/**
|
|
2441
|
+
* Quick Base API
|
|
2442
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2443
|
+
*
|
|
2444
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2445
|
+
*
|
|
2446
|
+
*
|
|
2447
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2448
|
+
* https://openapi-generator.tech
|
|
2449
|
+
* Do not edit the class manually.
|
|
2450
|
+
*/
|
|
2451
|
+
|
|
2452
|
+
/**
|
|
2453
|
+
*
|
|
2454
|
+
* @export
|
|
2455
|
+
* @interface PlatformAnalyticEventSummaries200Response
|
|
2456
|
+
*/
|
|
2457
|
+
interface PlatformAnalyticEventSummaries200Response {
|
|
2458
|
+
/**
|
|
2459
|
+
* The ID of the account the events are associated with.
|
|
2460
|
+
* @type {string}
|
|
2461
|
+
* @memberof PlatformAnalyticEventSummaries200Response
|
|
2462
|
+
*/
|
|
2463
|
+
accountId: string;
|
|
2464
|
+
/**
|
|
2465
|
+
* The start date and time of the requested summaries in ISO 8601 time format.
|
|
2466
|
+
* @type {Date}
|
|
2467
|
+
* @memberof PlatformAnalyticEventSummaries200Response
|
|
2468
|
+
*/
|
|
2469
|
+
start: Date;
|
|
2470
|
+
/**
|
|
2471
|
+
* The end date and time of the requested summaries in ISO 8601 time format.
|
|
2472
|
+
* @type {Date}
|
|
2473
|
+
* @memberof PlatformAnalyticEventSummaries200Response
|
|
2474
|
+
*/
|
|
2475
|
+
end: Date;
|
|
2476
|
+
/**
|
|
2477
|
+
* How the events should be grouped.
|
|
2478
|
+
* @type {string}
|
|
2479
|
+
* @memberof PlatformAnalyticEventSummaries200Response
|
|
2480
|
+
*/
|
|
2481
|
+
groupBy: PlatformAnalyticEventSummaries200ResponseGroupByEnum;
|
|
2482
|
+
/**
|
|
2483
|
+
*
|
|
2484
|
+
* @type {Array<PlatformAnalyticEventSummaries200ResponseWhereInner>}
|
|
2485
|
+
* @memberof PlatformAnalyticEventSummaries200Response
|
|
2486
|
+
*/
|
|
2487
|
+
where: Array<PlatformAnalyticEventSummaries200ResponseWhereInner>;
|
|
2488
|
+
/**
|
|
2489
|
+
* An array of objects that contains Application/User information and an events object with summaries by event type.
|
|
2490
|
+
* @type {Array<PlatformAnalyticEventSummaries200ResponseResultsInner>}
|
|
2491
|
+
* @memberof PlatformAnalyticEventSummaries200Response
|
|
2492
|
+
*/
|
|
2493
|
+
results: Array<PlatformAnalyticEventSummaries200ResponseResultsInner>;
|
|
2494
|
+
/**
|
|
2495
|
+
*
|
|
2496
|
+
* @type {PlatformAnalyticEventSummaries200ResponseMetadata}
|
|
2497
|
+
* @memberof PlatformAnalyticEventSummaries200Response
|
|
2498
|
+
*/
|
|
2499
|
+
metadata?: PlatformAnalyticEventSummaries200ResponseMetadata;
|
|
2500
|
+
/**
|
|
2501
|
+
*
|
|
2502
|
+
* @type {PlatformAnalyticEventSummaries200ResponseTotals}
|
|
2503
|
+
* @memberof PlatformAnalyticEventSummaries200Response
|
|
2504
|
+
*/
|
|
2505
|
+
totals?: PlatformAnalyticEventSummaries200ResponseTotals;
|
|
2506
|
+
}
|
|
2507
|
+
/**
|
|
2508
|
+
* @export
|
|
2509
|
+
*/
|
|
2510
|
+
declare const PlatformAnalyticEventSummaries200ResponseGroupByEnum: {
|
|
2511
|
+
readonly App: "app";
|
|
2512
|
+
readonly User: "user";
|
|
2513
|
+
};
|
|
2514
|
+
type PlatformAnalyticEventSummaries200ResponseGroupByEnum = typeof PlatformAnalyticEventSummaries200ResponseGroupByEnum[keyof typeof PlatformAnalyticEventSummaries200ResponseGroupByEnum];
|
|
2515
|
+
/**
|
|
2516
|
+
* Check if a given object implements the PlatformAnalyticEventSummaries200Response interface.
|
|
2517
|
+
*/
|
|
2518
|
+
declare function instanceOfPlatformAnalyticEventSummaries200Response(value: object): value is PlatformAnalyticEventSummaries200Response;
|
|
2519
|
+
declare function PlatformAnalyticEventSummaries200ResponseFromJSON(json: any): PlatformAnalyticEventSummaries200Response;
|
|
2520
|
+
declare function PlatformAnalyticEventSummaries200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PlatformAnalyticEventSummaries200Response;
|
|
2521
|
+
declare function PlatformAnalyticEventSummaries200ResponseToJSON(json: any): PlatformAnalyticEventSummaries200Response;
|
|
2522
|
+
declare function PlatformAnalyticEventSummaries200ResponseToJSONTyped(value?: PlatformAnalyticEventSummaries200Response | null, ignoreDiscriminator?: boolean): any;
|
|
2523
|
+
|
|
2524
|
+
/**
|
|
2525
|
+
* Quick Base API
|
|
2526
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2527
|
+
*
|
|
2528
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2529
|
+
*
|
|
2530
|
+
*
|
|
2531
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2532
|
+
* https://openapi-generator.tech
|
|
2533
|
+
* Do not edit the class manually.
|
|
2534
|
+
*/
|
|
2535
|
+
/**
|
|
2536
|
+
*
|
|
2537
|
+
* @export
|
|
2538
|
+
* @interface PlatformAnalyticEventSummariesRequestWhereInner
|
|
2539
|
+
*/
|
|
2540
|
+
interface PlatformAnalyticEventSummariesRequestWhereInner {
|
|
2541
|
+
/**
|
|
2542
|
+
* Id of the item to filter by - the hash uid if filtering a user, or the app id if filtering an app.
|
|
2543
|
+
* @type {string}
|
|
2544
|
+
* @memberof PlatformAnalyticEventSummariesRequestWhereInner
|
|
2545
|
+
*/
|
|
2546
|
+
id: string;
|
|
2547
|
+
/**
|
|
2548
|
+
* The type of item to filter by.
|
|
2549
|
+
* @type {string}
|
|
2550
|
+
* @memberof PlatformAnalyticEventSummariesRequestWhereInner
|
|
2551
|
+
*/
|
|
2552
|
+
type: PlatformAnalyticEventSummariesRequestWhereInnerTypeEnum;
|
|
2553
|
+
}
|
|
2554
|
+
/**
|
|
2555
|
+
* @export
|
|
2556
|
+
*/
|
|
2557
|
+
declare const PlatformAnalyticEventSummariesRequestWhereInnerTypeEnum: {
|
|
2558
|
+
readonly App: "app";
|
|
2559
|
+
readonly User: "user";
|
|
2560
|
+
};
|
|
2561
|
+
type PlatformAnalyticEventSummariesRequestWhereInnerTypeEnum = typeof PlatformAnalyticEventSummariesRequestWhereInnerTypeEnum[keyof typeof PlatformAnalyticEventSummariesRequestWhereInnerTypeEnum];
|
|
2562
|
+
/**
|
|
2563
|
+
* Check if a given object implements the PlatformAnalyticEventSummariesRequestWhereInner interface.
|
|
2564
|
+
*/
|
|
2565
|
+
declare function instanceOfPlatformAnalyticEventSummariesRequestWhereInner(value: object): value is PlatformAnalyticEventSummariesRequestWhereInner;
|
|
2566
|
+
declare function PlatformAnalyticEventSummariesRequestWhereInnerFromJSON(json: any): PlatformAnalyticEventSummariesRequestWhereInner;
|
|
2567
|
+
declare function PlatformAnalyticEventSummariesRequestWhereInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): PlatformAnalyticEventSummariesRequestWhereInner;
|
|
2568
|
+
declare function PlatformAnalyticEventSummariesRequestWhereInnerToJSON(json: any): PlatformAnalyticEventSummariesRequestWhereInner;
|
|
2569
|
+
declare function PlatformAnalyticEventSummariesRequestWhereInnerToJSONTyped(value?: PlatformAnalyticEventSummariesRequestWhereInner | null, ignoreDiscriminator?: boolean): any;
|
|
2570
|
+
|
|
2571
|
+
/**
|
|
2572
|
+
* Quick Base API
|
|
2573
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2574
|
+
*
|
|
2575
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2576
|
+
*
|
|
2577
|
+
*
|
|
2578
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2579
|
+
* https://openapi-generator.tech
|
|
2580
|
+
* Do not edit the class manually.
|
|
2581
|
+
*/
|
|
2582
|
+
|
|
2583
|
+
/**
|
|
2584
|
+
*
|
|
2585
|
+
* @export
|
|
2586
|
+
* @interface PlatformAnalyticEventSummariesRequest
|
|
2587
|
+
*/
|
|
2588
|
+
interface PlatformAnalyticEventSummariesRequest {
|
|
2589
|
+
/**
|
|
2590
|
+
* The start date and time of the requested summaries in ISO 8601 time format.
|
|
2591
|
+
* @type {Date}
|
|
2592
|
+
* @memberof PlatformAnalyticEventSummariesRequest
|
|
2593
|
+
*/
|
|
2594
|
+
start: Date;
|
|
2595
|
+
/**
|
|
2596
|
+
* The end date and time of the requested summaries in ISO 8601 time format.
|
|
2597
|
+
* @type {Date}
|
|
2598
|
+
* @memberof PlatformAnalyticEventSummariesRequest
|
|
2599
|
+
*/
|
|
2600
|
+
end: Date;
|
|
2601
|
+
/**
|
|
2602
|
+
* How the events should be grouped.
|
|
2603
|
+
* @type {string}
|
|
2604
|
+
* @memberof PlatformAnalyticEventSummariesRequest
|
|
2605
|
+
*/
|
|
2606
|
+
groupBy: PlatformAnalyticEventSummariesRequestGroupByEnum;
|
|
2607
|
+
/**
|
|
2608
|
+
* A pagination token from a previous response. Used to fetch the next page.
|
|
2609
|
+
* @type {string}
|
|
2610
|
+
* @memberof PlatformAnalyticEventSummariesRequest
|
|
2611
|
+
*/
|
|
2612
|
+
nextToken?: string;
|
|
2613
|
+
/**
|
|
2614
|
+
* A list of items to filter events by. Only events which match ALL criteria will be included in the results.
|
|
2615
|
+
* @type {Array<PlatformAnalyticEventSummariesRequestWhereInner>}
|
|
2616
|
+
* @memberof PlatformAnalyticEventSummariesRequest
|
|
2617
|
+
*/
|
|
2618
|
+
where?: Array<PlatformAnalyticEventSummariesRequestWhereInner>;
|
|
2619
|
+
}
|
|
2620
|
+
/**
|
|
2621
|
+
* @export
|
|
2622
|
+
*/
|
|
2623
|
+
declare const PlatformAnalyticEventSummariesRequestGroupByEnum: {
|
|
2624
|
+
readonly App: "app";
|
|
2625
|
+
readonly User: "user";
|
|
2626
|
+
};
|
|
2627
|
+
type PlatformAnalyticEventSummariesRequestGroupByEnum = typeof PlatformAnalyticEventSummariesRequestGroupByEnum[keyof typeof PlatformAnalyticEventSummariesRequestGroupByEnum];
|
|
2628
|
+
/**
|
|
2629
|
+
* Check if a given object implements the PlatformAnalyticEventSummariesRequest interface.
|
|
2630
|
+
*/
|
|
2631
|
+
declare function instanceOfPlatformAnalyticEventSummariesRequest(value: object): value is PlatformAnalyticEventSummariesRequest;
|
|
2632
|
+
declare function PlatformAnalyticEventSummariesRequestFromJSON(json: any): PlatformAnalyticEventSummariesRequest;
|
|
2633
|
+
declare function PlatformAnalyticEventSummariesRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PlatformAnalyticEventSummariesRequest;
|
|
2634
|
+
declare function PlatformAnalyticEventSummariesRequestToJSON(json: any): PlatformAnalyticEventSummariesRequest;
|
|
2635
|
+
declare function PlatformAnalyticEventSummariesRequestToJSONTyped(value?: PlatformAnalyticEventSummariesRequest | null, ignoreDiscriminator?: boolean): any;
|
|
2636
|
+
|
|
2637
|
+
/**
|
|
2638
|
+
* Quick Base API
|
|
2639
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2640
|
+
*
|
|
2641
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2642
|
+
*
|
|
2643
|
+
*
|
|
2644
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2645
|
+
* https://openapi-generator.tech
|
|
2646
|
+
* Do not edit the class manually.
|
|
2647
|
+
*/
|
|
2648
|
+
/**
|
|
2649
|
+
*
|
|
2650
|
+
* @export
|
|
2651
|
+
* @interface PlatformAnalyticReads200Response
|
|
2652
|
+
*/
|
|
2653
|
+
interface PlatformAnalyticReads200Response {
|
|
2654
|
+
[key: string]: any | any;
|
|
2655
|
+
/**
|
|
2656
|
+
* The date of the requested summary.
|
|
2657
|
+
* @type {Date}
|
|
2658
|
+
* @memberof PlatformAnalyticReads200Response
|
|
2659
|
+
*/
|
|
2660
|
+
date: Date;
|
|
2661
|
+
/**
|
|
2662
|
+
* Total reads for the specified date.
|
|
2663
|
+
* @type {{ [key: string]: any; }}
|
|
2664
|
+
* @memberof PlatformAnalyticReads200Response
|
|
2665
|
+
*/
|
|
2666
|
+
reads: {
|
|
2667
|
+
[key: string]: any;
|
|
2668
|
+
};
|
|
2669
|
+
}
|
|
2670
|
+
/**
|
|
2671
|
+
* Check if a given object implements the PlatformAnalyticReads200Response interface.
|
|
2672
|
+
*/
|
|
2673
|
+
declare function instanceOfPlatformAnalyticReads200Response(value: object): value is PlatformAnalyticReads200Response;
|
|
2674
|
+
declare function PlatformAnalyticReads200ResponseFromJSON(json: any): PlatformAnalyticReads200Response;
|
|
2675
|
+
declare function PlatformAnalyticReads200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PlatformAnalyticReads200Response;
|
|
2676
|
+
declare function PlatformAnalyticReads200ResponseToJSON(json: any): PlatformAnalyticReads200Response;
|
|
2677
|
+
declare function PlatformAnalyticReads200ResponseToJSONTyped(value?: PlatformAnalyticReads200Response | null, ignoreDiscriminator?: boolean): any;
|
|
2678
|
+
|
|
2679
|
+
/**
|
|
2680
|
+
* Quick Base API
|
|
2681
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2682
|
+
*
|
|
2683
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2684
|
+
*
|
|
2685
|
+
*
|
|
2686
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2687
|
+
* https://openapi-generator.tech
|
|
2688
|
+
* Do not edit the class manually.
|
|
2689
|
+
*/
|
|
2690
|
+
/**
|
|
2691
|
+
*
|
|
2692
|
+
* @export
|
|
2693
|
+
* @interface Record
|
|
2694
|
+
*/
|
|
2695
|
+
interface Record {
|
|
2696
|
+
/**
|
|
2697
|
+
*
|
|
2698
|
+
* @type {number}
|
|
2699
|
+
* @memberof Record
|
|
2700
|
+
*/
|
|
2701
|
+
id: number;
|
|
2702
|
+
/**
|
|
2703
|
+
*
|
|
2704
|
+
* @type {{ [key: string]: string; }}
|
|
2705
|
+
* @memberof Record
|
|
2706
|
+
*/
|
|
2707
|
+
fields?: {
|
|
2708
|
+
[key: string]: string;
|
|
2709
|
+
};
|
|
2710
|
+
}
|
|
2711
|
+
/**
|
|
2712
|
+
* Check if a given object implements the Record interface.
|
|
2713
|
+
*/
|
|
2714
|
+
declare function instanceOfRecord(value: object): value is Record;
|
|
2715
|
+
declare function RecordFromJSON(json: any): Record;
|
|
2716
|
+
declare function RecordFromJSONTyped(json: any, ignoreDiscriminator: boolean): Record;
|
|
2717
|
+
declare function RecordToJSON(json: any): Record;
|
|
2718
|
+
declare function RecordToJSONTyped(value?: Record | null, ignoreDiscriminator?: boolean): any;
|
|
2719
|
+
|
|
2720
|
+
/**
|
|
2721
|
+
* Quick Base API
|
|
2722
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2723
|
+
*
|
|
2724
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2725
|
+
*
|
|
2726
|
+
*
|
|
2727
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2728
|
+
* https://openapi-generator.tech
|
|
2729
|
+
* Do not edit the class manually.
|
|
2730
|
+
*/
|
|
2731
|
+
/**
|
|
2732
|
+
*
|
|
2733
|
+
* @export
|
|
2734
|
+
* @interface RemoveMembersFromGroup200Response
|
|
2735
|
+
*/
|
|
2736
|
+
interface RemoveMembersFromGroup200Response {
|
|
2737
|
+
[key: string]: any | any;
|
|
2738
|
+
/**
|
|
2739
|
+
* A list of users that couldn’t be removed from the group. This includes a list of IDs that represent invalid users.
|
|
2740
|
+
* @type {Array<string>}
|
|
2741
|
+
* @memberof RemoveMembersFromGroup200Response
|
|
2742
|
+
*/
|
|
2743
|
+
failure: Array<string>;
|
|
2744
|
+
/**
|
|
2745
|
+
* A list of users that have been removed from the group successfully.
|
|
2746
|
+
* @type {Array<string>}
|
|
2747
|
+
* @memberof RemoveMembersFromGroup200Response
|
|
2748
|
+
*/
|
|
2749
|
+
success: Array<string>;
|
|
2750
|
+
}
|
|
2751
|
+
/**
|
|
2752
|
+
* Check if a given object implements the RemoveMembersFromGroup200Response interface.
|
|
2753
|
+
*/
|
|
2754
|
+
declare function instanceOfRemoveMembersFromGroup200Response(value: object): value is RemoveMembersFromGroup200Response;
|
|
2755
|
+
declare function RemoveMembersFromGroup200ResponseFromJSON(json: any): RemoveMembersFromGroup200Response;
|
|
2756
|
+
declare function RemoveMembersFromGroup200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RemoveMembersFromGroup200Response;
|
|
2757
|
+
declare function RemoveMembersFromGroup200ResponseToJSON(json: any): RemoveMembersFromGroup200Response;
|
|
2758
|
+
declare function RemoveMembersFromGroup200ResponseToJSONTyped(value?: RemoveMembersFromGroup200Response | null, ignoreDiscriminator?: boolean): any;
|
|
2759
|
+
|
|
2760
|
+
/**
|
|
2761
|
+
* Quick Base API
|
|
2762
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2763
|
+
*
|
|
2764
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2765
|
+
*
|
|
2766
|
+
*
|
|
2767
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2768
|
+
* https://openapi-generator.tech
|
|
2769
|
+
* Do not edit the class manually.
|
|
2770
|
+
*/
|
|
2771
|
+
/**
|
|
2772
|
+
*
|
|
2773
|
+
* @export
|
|
2774
|
+
* @interface RemoveSubgroupsFromGroup200Response
|
|
2775
|
+
*/
|
|
2776
|
+
interface RemoveSubgroupsFromGroup200Response {
|
|
2777
|
+
[key: string]: any | any;
|
|
2778
|
+
/**
|
|
2779
|
+
* A list of child groups that couldn’t be removed from the group. This includes a list of IDs that represent invalid groups.
|
|
2780
|
+
* @type {Array<string>}
|
|
2781
|
+
* @memberof RemoveSubgroupsFromGroup200Response
|
|
2782
|
+
*/
|
|
2783
|
+
failure: Array<string>;
|
|
2784
|
+
/**
|
|
2785
|
+
* A list of child groups that have been removed from the group successfully.
|
|
2786
|
+
* @type {Array<string>}
|
|
2787
|
+
* @memberof RemoveSubgroupsFromGroup200Response
|
|
2788
|
+
*/
|
|
2789
|
+
success: Array<string>;
|
|
2790
|
+
}
|
|
2791
|
+
/**
|
|
2792
|
+
* Check if a given object implements the RemoveSubgroupsFromGroup200Response interface.
|
|
2793
|
+
*/
|
|
2794
|
+
declare function instanceOfRemoveSubgroupsFromGroup200Response(value: object): value is RemoveSubgroupsFromGroup200Response;
|
|
2795
|
+
declare function RemoveSubgroupsFromGroup200ResponseFromJSON(json: any): RemoveSubgroupsFromGroup200Response;
|
|
2796
|
+
declare function RemoveSubgroupsFromGroup200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RemoveSubgroupsFromGroup200Response;
|
|
2797
|
+
declare function RemoveSubgroupsFromGroup200ResponseToJSON(json: any): RemoveSubgroupsFromGroup200Response;
|
|
2798
|
+
declare function RemoveSubgroupsFromGroup200ResponseToJSONTyped(value?: RemoveSubgroupsFromGroup200Response | null, ignoreDiscriminator?: boolean): any;
|
|
2799
|
+
|
|
2800
|
+
/**
|
|
2801
|
+
* Quick Base API
|
|
2802
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2803
|
+
*
|
|
2804
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2805
|
+
*
|
|
2806
|
+
*
|
|
2807
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2808
|
+
* https://openapi-generator.tech
|
|
2809
|
+
* Do not edit the class manually.
|
|
2810
|
+
*/
|
|
2811
|
+
/**
|
|
2812
|
+
*
|
|
2813
|
+
* @export
|
|
2814
|
+
* @interface ReportRunResponse
|
|
2815
|
+
*/
|
|
2816
|
+
interface ReportRunResponse {
|
|
2817
|
+
/**
|
|
2818
|
+
*
|
|
2819
|
+
* @type {string}
|
|
2820
|
+
* @memberof ReportRunResponse
|
|
2821
|
+
*/
|
|
2822
|
+
id: string;
|
|
2823
|
+
/**
|
|
2824
|
+
*
|
|
2825
|
+
* @type {object}
|
|
2826
|
+
* @memberof ReportRunResponse
|
|
2827
|
+
*/
|
|
2828
|
+
data?: object;
|
|
2829
|
+
}
|
|
2830
|
+
/**
|
|
2831
|
+
* Check if a given object implements the ReportRunResponse interface.
|
|
2832
|
+
*/
|
|
2833
|
+
declare function instanceOfReportRunResponse(value: object): value is ReportRunResponse;
|
|
2834
|
+
declare function ReportRunResponseFromJSON(json: any): ReportRunResponse;
|
|
2835
|
+
declare function ReportRunResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportRunResponse;
|
|
2836
|
+
declare function ReportRunResponseToJSON(json: any): ReportRunResponse;
|
|
2837
|
+
declare function ReportRunResponseToJSONTyped(value?: ReportRunResponse | null, ignoreDiscriminator?: boolean): any;
|
|
2838
|
+
|
|
2839
|
+
/**
|
|
2840
|
+
* Quick Base API
|
|
2841
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2842
|
+
*
|
|
2843
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2844
|
+
*
|
|
2845
|
+
*
|
|
2846
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2847
|
+
* https://openapi-generator.tech
|
|
2848
|
+
* Do not edit the class manually.
|
|
2849
|
+
*/
|
|
2850
|
+
/**
|
|
2851
|
+
*
|
|
2852
|
+
* @export
|
|
2853
|
+
* @interface RunFormula200Response
|
|
2854
|
+
*/
|
|
2855
|
+
interface RunFormula200Response {
|
|
2856
|
+
[key: string]: any | any;
|
|
2857
|
+
/**
|
|
2858
|
+
* The formula execution result.
|
|
2859
|
+
* @type {string}
|
|
2860
|
+
* @memberof RunFormula200Response
|
|
2861
|
+
*/
|
|
2862
|
+
result?: string;
|
|
2863
|
+
}
|
|
2864
|
+
/**
|
|
2865
|
+
* Check if a given object implements the RunFormula200Response interface.
|
|
2866
|
+
*/
|
|
2867
|
+
declare function instanceOfRunFormula200Response(value: object): value is RunFormula200Response;
|
|
2868
|
+
declare function RunFormula200ResponseFromJSON(json: any): RunFormula200Response;
|
|
2869
|
+
declare function RunFormula200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RunFormula200Response;
|
|
2870
|
+
declare function RunFormula200ResponseToJSON(json: any): RunFormula200Response;
|
|
2871
|
+
declare function RunFormula200ResponseToJSONTyped(value?: RunFormula200Response | null, ignoreDiscriminator?: boolean): any;
|
|
2872
|
+
|
|
2873
|
+
/**
|
|
2874
|
+
* Quick Base API
|
|
2875
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2876
|
+
*
|
|
2877
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2878
|
+
*
|
|
2879
|
+
*
|
|
2880
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2881
|
+
* https://openapi-generator.tech
|
|
2882
|
+
* Do not edit the class manually.
|
|
2883
|
+
*/
|
|
2884
|
+
/**
|
|
2885
|
+
* The following example will execute a Sum() for '20' and the value in a record with id 1 for the field with label 'NumericField'. Since this API is able to run any type of formula, all results will be returned as a string.
|
|
2886
|
+
* @export
|
|
2887
|
+
* @interface RunFormulaRequest
|
|
2888
|
+
*/
|
|
2889
|
+
interface RunFormulaRequest {
|
|
2890
|
+
/**
|
|
2891
|
+
* The formula to run. This must be a valid Quickbase formula.
|
|
2892
|
+
* @type {string}
|
|
2893
|
+
* @memberof RunFormulaRequest
|
|
2894
|
+
*/
|
|
2895
|
+
formula: string;
|
|
2896
|
+
/**
|
|
2897
|
+
* The record ID to run the formula against. Only necessary for formulas that are run in the context of a record. For example, the formula User() does not need a record ID.
|
|
2898
|
+
* @type {number}
|
|
2899
|
+
* @memberof RunFormulaRequest
|
|
2900
|
+
*/
|
|
2901
|
+
rid?: number;
|
|
2902
|
+
/**
|
|
2903
|
+
* The unique identifier (dbid) of the table.
|
|
2904
|
+
* @type {string}
|
|
2905
|
+
* @memberof RunFormulaRequest
|
|
2906
|
+
*/
|
|
2907
|
+
from: string;
|
|
2908
|
+
}
|
|
2909
|
+
/**
|
|
2910
|
+
* Check if a given object implements the RunFormulaRequest interface.
|
|
2911
|
+
*/
|
|
2912
|
+
declare function instanceOfRunFormulaRequest(value: object): value is RunFormulaRequest;
|
|
2913
|
+
declare function RunFormulaRequestFromJSON(json: any): RunFormulaRequest;
|
|
2914
|
+
declare function RunFormulaRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RunFormulaRequest;
|
|
2915
|
+
declare function RunFormulaRequestToJSON(json: any): RunFormulaRequest;
|
|
2916
|
+
declare function RunFormulaRequestToJSONTyped(value?: RunFormulaRequest | null, ignoreDiscriminator?: boolean): any;
|
|
2917
|
+
|
|
2918
|
+
/**
|
|
2919
|
+
* Quick Base API
|
|
2920
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2921
|
+
*
|
|
2922
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2923
|
+
*
|
|
2924
|
+
*
|
|
2925
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2926
|
+
* https://openapi-generator.tech
|
|
2927
|
+
* Do not edit the class manually.
|
|
2928
|
+
*/
|
|
2929
|
+
/**
|
|
2930
|
+
*
|
|
2931
|
+
* @export
|
|
2932
|
+
* @interface Table
|
|
2933
|
+
*/
|
|
2934
|
+
interface Table {
|
|
2935
|
+
/**
|
|
2936
|
+
*
|
|
2937
|
+
* @type {string}
|
|
2938
|
+
* @memberof Table
|
|
2939
|
+
*/
|
|
2940
|
+
id: string;
|
|
2941
|
+
/**
|
|
2942
|
+
*
|
|
2943
|
+
* @type {string}
|
|
2944
|
+
* @memberof Table
|
|
2945
|
+
*/
|
|
2946
|
+
name: string;
|
|
2947
|
+
/**
|
|
2948
|
+
*
|
|
2949
|
+
* @type {string}
|
|
2950
|
+
* @memberof Table
|
|
2951
|
+
*/
|
|
2952
|
+
alias?: string;
|
|
2953
|
+
/**
|
|
2954
|
+
*
|
|
2955
|
+
* @type {Date}
|
|
2956
|
+
* @memberof Table
|
|
2957
|
+
*/
|
|
2958
|
+
created?: Date;
|
|
2959
|
+
/**
|
|
2960
|
+
*
|
|
2961
|
+
* @type {number}
|
|
2962
|
+
* @memberof Table
|
|
2963
|
+
*/
|
|
2964
|
+
defaultSortFieldId?: number;
|
|
2965
|
+
/**
|
|
2966
|
+
*
|
|
2967
|
+
* @type {string}
|
|
2968
|
+
* @memberof Table
|
|
2969
|
+
*/
|
|
2970
|
+
defaultSortOrder?: string;
|
|
2971
|
+
/**
|
|
2972
|
+
*
|
|
2973
|
+
* @type {string}
|
|
2974
|
+
* @memberof Table
|
|
2975
|
+
*/
|
|
2976
|
+
description?: string;
|
|
2977
|
+
/**
|
|
2978
|
+
*
|
|
2979
|
+
* @type {number}
|
|
2980
|
+
* @memberof Table
|
|
2981
|
+
*/
|
|
2982
|
+
keyFieldId?: number;
|
|
2983
|
+
/**
|
|
2984
|
+
*
|
|
2985
|
+
* @type {number}
|
|
2986
|
+
* @memberof Table
|
|
2987
|
+
*/
|
|
2988
|
+
nextFieldId?: number;
|
|
2989
|
+
/**
|
|
2990
|
+
*
|
|
2991
|
+
* @type {number}
|
|
2992
|
+
* @memberof Table
|
|
2993
|
+
*/
|
|
2994
|
+
nextRecordId?: number;
|
|
2995
|
+
/**
|
|
2996
|
+
*
|
|
2997
|
+
* @type {string}
|
|
2998
|
+
* @memberof Table
|
|
2999
|
+
*/
|
|
3000
|
+
pluralRecordName?: string;
|
|
3001
|
+
/**
|
|
3002
|
+
*
|
|
3003
|
+
* @type {string}
|
|
3004
|
+
* @memberof Table
|
|
3005
|
+
*/
|
|
3006
|
+
singleRecordName?: string;
|
|
3007
|
+
/**
|
|
3008
|
+
*
|
|
3009
|
+
* @type {string}
|
|
3010
|
+
* @memberof Table
|
|
3011
|
+
*/
|
|
3012
|
+
sizeLimit?: string;
|
|
3013
|
+
/**
|
|
3014
|
+
*
|
|
3015
|
+
* @type {string}
|
|
3016
|
+
* @memberof Table
|
|
3017
|
+
*/
|
|
3018
|
+
spaceRemaining?: string;
|
|
3019
|
+
/**
|
|
3020
|
+
*
|
|
3021
|
+
* @type {string}
|
|
3022
|
+
* @memberof Table
|
|
3023
|
+
*/
|
|
3024
|
+
spaceUsed?: string;
|
|
3025
|
+
/**
|
|
3026
|
+
*
|
|
3027
|
+
* @type {Date}
|
|
3028
|
+
* @memberof Table
|
|
3029
|
+
*/
|
|
3030
|
+
updated?: Date;
|
|
3031
|
+
}
|
|
3032
|
+
/**
|
|
3033
|
+
* Check if a given object implements the Table interface.
|
|
3034
|
+
*/
|
|
3035
|
+
declare function instanceOfTable(value: object): value is Table;
|
|
3036
|
+
declare function TableFromJSON(json: any): Table;
|
|
3037
|
+
declare function TableFromJSONTyped(json: any, ignoreDiscriminator: boolean): Table;
|
|
3038
|
+
declare function TableToJSON(json: any): Table;
|
|
3039
|
+
declare function TableToJSONTyped(value?: Table | null, ignoreDiscriminator?: boolean): any;
|
|
3040
|
+
|
|
3041
|
+
/**
|
|
3042
|
+
* Quick Base API
|
|
3043
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3044
|
+
*
|
|
3045
|
+
* The version of the OpenAPI document: 1.0.0
|
|
3046
|
+
*
|
|
3047
|
+
*
|
|
3048
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3049
|
+
* https://openapi-generator.tech
|
|
3050
|
+
* Do not edit the class manually.
|
|
3051
|
+
*/
|
|
3052
|
+
/**
|
|
3053
|
+
*
|
|
3054
|
+
* @export
|
|
3055
|
+
* @interface TransferUserToken200Response
|
|
3056
|
+
*/
|
|
3057
|
+
interface TransferUserToken200Response {
|
|
3058
|
+
[key: string]: any | any;
|
|
3059
|
+
/**
|
|
3060
|
+
* Whether the user token is active.
|
|
3061
|
+
* @type {boolean}
|
|
3062
|
+
* @memberof TransferUserToken200Response
|
|
3063
|
+
*/
|
|
3064
|
+
active?: boolean;
|
|
3065
|
+
/**
|
|
3066
|
+
* The list of apps this user token is assigned to.
|
|
3067
|
+
* @type {Array<{ [key: string]: any; }>}
|
|
3068
|
+
* @memberof TransferUserToken200Response
|
|
3069
|
+
*/
|
|
3070
|
+
apps?: Array<{
|
|
3071
|
+
[key: string]: any;
|
|
3072
|
+
}>;
|
|
3073
|
+
/**
|
|
3074
|
+
* The last date this user token was used, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
|
|
3075
|
+
* @type {string}
|
|
3076
|
+
* @memberof TransferUserToken200Response
|
|
3077
|
+
*/
|
|
3078
|
+
lastUsed?: string;
|
|
3079
|
+
/**
|
|
3080
|
+
* User Token description.
|
|
3081
|
+
* @type {string}
|
|
3082
|
+
* @memberof TransferUserToken200Response
|
|
3083
|
+
*/
|
|
3084
|
+
description?: string;
|
|
3085
|
+
/**
|
|
3086
|
+
* User Token id.
|
|
3087
|
+
* @type {number}
|
|
3088
|
+
* @memberof TransferUserToken200Response
|
|
3089
|
+
*/
|
|
3090
|
+
id?: number;
|
|
3091
|
+
/**
|
|
3092
|
+
* User Token name.
|
|
3093
|
+
* @type {string}
|
|
3094
|
+
* @memberof TransferUserToken200Response
|
|
3095
|
+
*/
|
|
3096
|
+
name?: string;
|
|
3097
|
+
}
|
|
3098
|
+
/**
|
|
3099
|
+
* Check if a given object implements the TransferUserToken200Response interface.
|
|
3100
|
+
*/
|
|
3101
|
+
declare function instanceOfTransferUserToken200Response(value: object): value is TransferUserToken200Response;
|
|
3102
|
+
declare function TransferUserToken200ResponseFromJSON(json: any): TransferUserToken200Response;
|
|
3103
|
+
declare function TransferUserToken200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransferUserToken200Response;
|
|
3104
|
+
declare function TransferUserToken200ResponseToJSON(json: any): TransferUserToken200Response;
|
|
3105
|
+
declare function TransferUserToken200ResponseToJSONTyped(value?: TransferUserToken200Response | null, ignoreDiscriminator?: boolean): any;
|
|
3106
|
+
|
|
3107
|
+
/**
|
|
3108
|
+
* Quick Base API
|
|
3109
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3110
|
+
*
|
|
3111
|
+
* The version of the OpenAPI document: 1.0.0
|
|
3112
|
+
*
|
|
3113
|
+
*
|
|
3114
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3115
|
+
* https://openapi-generator.tech
|
|
3116
|
+
* Do not edit the class manually.
|
|
3117
|
+
*/
|
|
3118
|
+
/**
|
|
3119
|
+
*
|
|
3120
|
+
* @export
|
|
3121
|
+
* @interface TransferUserTokenRequest
|
|
3122
|
+
*/
|
|
3123
|
+
interface TransferUserTokenRequest {
|
|
3124
|
+
/**
|
|
3125
|
+
* The id of the user token to transfer
|
|
3126
|
+
* @type {number}
|
|
3127
|
+
* @memberof TransferUserTokenRequest
|
|
3128
|
+
*/
|
|
3129
|
+
id?: number;
|
|
3130
|
+
/**
|
|
3131
|
+
* The id of the user to transfer the user token from
|
|
3132
|
+
* @type {string}
|
|
3133
|
+
* @memberof TransferUserTokenRequest
|
|
3134
|
+
*/
|
|
3135
|
+
from?: string;
|
|
3136
|
+
/**
|
|
3137
|
+
* The id of the user to transfer the user token to
|
|
3138
|
+
* @type {string}
|
|
3139
|
+
* @memberof TransferUserTokenRequest
|
|
3140
|
+
*/
|
|
3141
|
+
to?: string;
|
|
3142
|
+
}
|
|
3143
|
+
/**
|
|
3144
|
+
* Check if a given object implements the TransferUserTokenRequest interface.
|
|
3145
|
+
*/
|
|
3146
|
+
declare function instanceOfTransferUserTokenRequest(value: object): value is TransferUserTokenRequest;
|
|
3147
|
+
declare function TransferUserTokenRequestFromJSON(json: any): TransferUserTokenRequest;
|
|
3148
|
+
declare function TransferUserTokenRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransferUserTokenRequest;
|
|
3149
|
+
declare function TransferUserTokenRequestToJSON(json: any): TransferUserTokenRequest;
|
|
3150
|
+
declare function TransferUserTokenRequestToJSONTyped(value?: TransferUserTokenRequest | null, ignoreDiscriminator?: boolean): any;
|
|
3151
|
+
|
|
3152
|
+
/**
|
|
3153
|
+
* Quick Base API
|
|
3154
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3155
|
+
*
|
|
3156
|
+
* The version of the OpenAPI document: 1.0.0
|
|
3157
|
+
*
|
|
3158
|
+
*
|
|
3159
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3160
|
+
* https://openapi-generator.tech
|
|
3161
|
+
* Do not edit the class manually.
|
|
3162
|
+
*/
|
|
3163
|
+
/**
|
|
3164
|
+
*
|
|
3165
|
+
* @export
|
|
3166
|
+
* @interface UndenyUsers200Response
|
|
3167
|
+
*/
|
|
3168
|
+
interface UndenyUsers200Response {
|
|
3169
|
+
[key: string]: any | any;
|
|
3170
|
+
/**
|
|
3171
|
+
* A list of users that couldn't be undenied. This also includes the ID's of users that are not valid.
|
|
3172
|
+
* @type {Array<string>}
|
|
3173
|
+
* @memberof UndenyUsers200Response
|
|
3174
|
+
*/
|
|
3175
|
+
failure: Array<string>;
|
|
3176
|
+
/**
|
|
3177
|
+
* A list of users that have successfully been undenied.
|
|
3178
|
+
* @type {Array<string>}
|
|
3179
|
+
* @memberof UndenyUsers200Response
|
|
3180
|
+
*/
|
|
3181
|
+
success: Array<string>;
|
|
3182
|
+
}
|
|
3183
|
+
/**
|
|
3184
|
+
* Check if a given object implements the UndenyUsers200Response interface.
|
|
3185
|
+
*/
|
|
3186
|
+
declare function instanceOfUndenyUsers200Response(value: object): value is UndenyUsers200Response;
|
|
3187
|
+
declare function UndenyUsers200ResponseFromJSON(json: any): UndenyUsers200Response;
|
|
3188
|
+
declare function UndenyUsers200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UndenyUsers200Response;
|
|
3189
|
+
declare function UndenyUsers200ResponseToJSON(json: any): UndenyUsers200Response;
|
|
3190
|
+
declare function UndenyUsers200ResponseToJSONTyped(value?: UndenyUsers200Response | null, ignoreDiscriminator?: boolean): any;
|
|
3191
|
+
|
|
3192
|
+
/**
|
|
3193
|
+
* Quick Base API
|
|
3194
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3195
|
+
*
|
|
3196
|
+
* The version of the OpenAPI document: 1.0.0
|
|
3197
|
+
*
|
|
3198
|
+
*
|
|
3199
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3200
|
+
* https://openapi-generator.tech
|
|
3201
|
+
* Do not edit the class manually.
|
|
3202
|
+
*/
|
|
3203
|
+
/**
|
|
3204
|
+
* The example below shows all the properties that can be changed with this request. Additional properties that you can see with the corresponding GET request cannot be set through this API.
|
|
3205
|
+
* @export
|
|
3206
|
+
* @interface UpdateFieldRequest
|
|
3207
|
+
*/
|
|
3208
|
+
interface UpdateFieldRequest {
|
|
3209
|
+
/**
|
|
3210
|
+
* Indicates if the field is being tracked as part of Quickbase Audit Logs. You can only set this property to "true" if the app has audit logs enabled. See Enable data change logs under [Quickbase Audit Logs](https://help.quickbase.com/user-assistance/audit_logs.html).
|
|
3211
|
+
* @type {boolean}
|
|
3212
|
+
* @memberof UpdateFieldRequest
|
|
3213
|
+
*/
|
|
3214
|
+
audited?: boolean;
|
|
3215
|
+
/**
|
|
3216
|
+
* The configured help text shown to users within the product.
|
|
3217
|
+
* @type {string}
|
|
3218
|
+
* @memberof UpdateFieldRequest
|
|
3219
|
+
*/
|
|
3220
|
+
fieldHelp?: string;
|
|
3221
|
+
/**
|
|
3222
|
+
* Indicates if the field is configured to display in bold in the product.
|
|
3223
|
+
* @type {boolean}
|
|
3224
|
+
* @memberof UpdateFieldRequest
|
|
3225
|
+
*/
|
|
3226
|
+
bold?: boolean;
|
|
3227
|
+
/**
|
|
3228
|
+
* Indicates if the field is required (i.e. if every record must have a non-null value in this field). If you attempt to change a field from not-required to required, and the table currently contains records that have null values in that field, you will get an error indicating that there are null values of the field. In this case you need to find and update those records with null values of the field before changing the field to required.
|
|
3229
|
+
* @type {boolean}
|
|
3230
|
+
* @memberof UpdateFieldRequest
|
|
3231
|
+
*/
|
|
3232
|
+
required?: boolean;
|
|
3233
|
+
/**
|
|
3234
|
+
* Specific field properties.
|
|
3235
|
+
* @type {object}
|
|
3236
|
+
* @memberof UpdateFieldRequest
|
|
3237
|
+
*/
|
|
3238
|
+
properties?: object;
|
|
3239
|
+
/**
|
|
3240
|
+
* Indicates if the field is marked as a default in reports.
|
|
3241
|
+
* @type {boolean}
|
|
3242
|
+
* @memberof UpdateFieldRequest
|
|
3243
|
+
*/
|
|
3244
|
+
appearsByDefault?: boolean;
|
|
3245
|
+
/**
|
|
3246
|
+
* Indicates if every record in the table must contain a unique value of this field. If you attempt to change a field from not-unique to unique, and the table currently contains records with the same value of this field, you will get an error. In this case you need to find and update those records with duplicate values of the field before changing the field to unique.
|
|
3247
|
+
* @type {boolean}
|
|
3248
|
+
* @memberof UpdateFieldRequest
|
|
3249
|
+
*/
|
|
3250
|
+
unique?: boolean;
|
|
3251
|
+
/**
|
|
3252
|
+
* Field Permissions for different roles.
|
|
3253
|
+
* @type {Array<object>}
|
|
3254
|
+
* @memberof UpdateFieldRequest
|
|
3255
|
+
*/
|
|
3256
|
+
permissions?: Array<object>;
|
|
3257
|
+
/**
|
|
3258
|
+
* Whether the field you are adding should appear on forms.
|
|
3259
|
+
* @type {boolean}
|
|
3260
|
+
* @memberof UpdateFieldRequest
|
|
3261
|
+
*/
|
|
3262
|
+
addToForms?: boolean;
|
|
3263
|
+
/**
|
|
3264
|
+
* The label (name) of the field.
|
|
3265
|
+
* @type {string}
|
|
3266
|
+
* @memberof UpdateFieldRequest
|
|
3267
|
+
*/
|
|
3268
|
+
label?: string;
|
|
3269
|
+
/**
|
|
3270
|
+
* Indicates if the field is marked as searchable.
|
|
3271
|
+
* @type {boolean}
|
|
3272
|
+
* @memberof UpdateFieldRequest
|
|
3273
|
+
*/
|
|
3274
|
+
findEnabled?: boolean;
|
|
3275
|
+
/**
|
|
3276
|
+
* Indicates if the field is configured to not wrap when displayed in the product.
|
|
3277
|
+
* @type {boolean}
|
|
3278
|
+
* @memberof UpdateFieldRequest
|
|
3279
|
+
*/
|
|
3280
|
+
noWrap?: boolean;
|
|
3281
|
+
}
|
|
3282
|
+
/**
|
|
3283
|
+
* Check if a given object implements the UpdateFieldRequest interface.
|
|
3284
|
+
*/
|
|
3285
|
+
declare function instanceOfUpdateFieldRequest(value: object): value is UpdateFieldRequest;
|
|
3286
|
+
declare function UpdateFieldRequestFromJSON(json: any): UpdateFieldRequest;
|
|
3287
|
+
declare function UpdateFieldRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateFieldRequest;
|
|
3288
|
+
declare function UpdateFieldRequestToJSON(json: any): UpdateFieldRequest;
|
|
3289
|
+
declare function UpdateFieldRequestToJSONTyped(value?: UpdateFieldRequest | null, ignoreDiscriminator?: boolean): any;
|
|
3290
|
+
|
|
3291
|
+
/**
|
|
3292
|
+
* Quick Base API
|
|
3293
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3294
|
+
*
|
|
3295
|
+
* The version of the OpenAPI document: 1.0.0
|
|
3296
|
+
*
|
|
3297
|
+
*
|
|
3298
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3299
|
+
* https://openapi-generator.tech
|
|
3300
|
+
* Do not edit the class manually.
|
|
3301
|
+
*/
|
|
3302
|
+
/**
|
|
3303
|
+
*
|
|
3304
|
+
* @export
|
|
3305
|
+
* @interface UpdateRelationshipRequest
|
|
3306
|
+
*/
|
|
3307
|
+
interface UpdateRelationshipRequest {
|
|
3308
|
+
/**
|
|
3309
|
+
* An array of objects, each representing a configuration of one field from the child table, that will become summary fields on the parent table. When you specify the 'COUNT' accumulation type, you have to specify 0 as the summaryFid (or not set it in the request). 'DISTINCT-COUNT' requires that summaryFid be set to an actual fid.
|
|
3310
|
+
* @type {Array<{ [key: string]: any; }>}
|
|
3311
|
+
* @memberof UpdateRelationshipRequest
|
|
3312
|
+
*/
|
|
3313
|
+
summaryFields?: Array<{
|
|
3314
|
+
[key: string]: any;
|
|
3315
|
+
}>;
|
|
3316
|
+
/**
|
|
3317
|
+
* An array of field ids on the parent table that will become lookup fields on the child table.
|
|
3318
|
+
* @type {Array<number>}
|
|
3319
|
+
* @memberof UpdateRelationshipRequest
|
|
3320
|
+
*/
|
|
3321
|
+
lookupFieldIds?: Array<number>;
|
|
3322
|
+
}
|
|
3323
|
+
/**
|
|
3324
|
+
* Check if a given object implements the UpdateRelationshipRequest interface.
|
|
3325
|
+
*/
|
|
3326
|
+
declare function instanceOfUpdateRelationshipRequest(value: object): value is UpdateRelationshipRequest;
|
|
3327
|
+
declare function UpdateRelationshipRequestFromJSON(json: any): UpdateRelationshipRequest;
|
|
3328
|
+
declare function UpdateRelationshipRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateRelationshipRequest;
|
|
3329
|
+
declare function UpdateRelationshipRequestToJSON(json: any): UpdateRelationshipRequest;
|
|
3330
|
+
declare function UpdateRelationshipRequestToJSONTyped(value?: UpdateRelationshipRequest | null, ignoreDiscriminator?: boolean): any;
|
|
3331
|
+
|
|
3332
|
+
/**
|
|
3333
|
+
* Quick Base API
|
|
3334
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3335
|
+
*
|
|
3336
|
+
* The version of the OpenAPI document: 1.0.0
|
|
3337
|
+
*
|
|
3338
|
+
*
|
|
3339
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3340
|
+
* https://openapi-generator.tech
|
|
3341
|
+
* Do not edit the class manually.
|
|
3342
|
+
*/
|
|
3343
|
+
/**
|
|
3344
|
+
* The example below shows all the properties that can be changed with this request. Additional properties that you can see with the corresponding GET request cannot be set through this API.
|
|
3345
|
+
* @export
|
|
3346
|
+
* @interface UpdateTableRequest
|
|
3347
|
+
*/
|
|
3348
|
+
interface UpdateTableRequest {
|
|
3349
|
+
[key: string]: any | any;
|
|
3350
|
+
/**
|
|
3351
|
+
* The name for the table.
|
|
3352
|
+
* @type {string}
|
|
3353
|
+
* @memberof UpdateTableRequest
|
|
3354
|
+
*/
|
|
3355
|
+
name?: string;
|
|
3356
|
+
/**
|
|
3357
|
+
* The plural noun for records in the table. If this value is not passed the default value is 'Records'.
|
|
3358
|
+
* @type {string}
|
|
3359
|
+
* @memberof UpdateTableRequest
|
|
3360
|
+
*/
|
|
3361
|
+
pluralRecordName?: string;
|
|
3362
|
+
/**
|
|
3363
|
+
* The singular noun for records in the table. If this value is not passed the default value is 'Record'.
|
|
3364
|
+
* @type {string}
|
|
3365
|
+
* @memberof UpdateTableRequest
|
|
3366
|
+
*/
|
|
3367
|
+
singleRecordName?: string;
|
|
3368
|
+
/**
|
|
3369
|
+
* The description for the table. If this value is not passed the default value is blank.
|
|
3370
|
+
* @type {string}
|
|
3371
|
+
* @memberof UpdateTableRequest
|
|
3372
|
+
*/
|
|
3373
|
+
description?: string;
|
|
3374
|
+
}
|
|
3375
|
+
/**
|
|
3376
|
+
* Check if a given object implements the UpdateTableRequest interface.
|
|
3377
|
+
*/
|
|
3378
|
+
declare function instanceOfUpdateTableRequest(value: object): value is UpdateTableRequest;
|
|
3379
|
+
declare function UpdateTableRequestFromJSON(json: any): UpdateTableRequest;
|
|
3380
|
+
declare function UpdateTableRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateTableRequest;
|
|
3381
|
+
declare function UpdateTableRequestToJSON(json: any): UpdateTableRequest;
|
|
3382
|
+
declare function UpdateTableRequestToJSONTyped(value?: UpdateTableRequest | null, ignoreDiscriminator?: boolean): any;
|
|
3383
|
+
|
|
3384
|
+
/**
|
|
3385
|
+
* Quick Base API
|
|
3386
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3387
|
+
*
|
|
3388
|
+
* The version of the OpenAPI document: 1.0.0
|
|
3389
|
+
*
|
|
3390
|
+
*
|
|
3391
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3392
|
+
* https://openapi-generator.tech
|
|
3393
|
+
* Do not edit the class manually.
|
|
3394
|
+
*/
|
|
3395
|
+
/**
|
|
3396
|
+
* A successful response that includes details on the records added, updated or unchanged. In the example below, the table previously had ten records with IDs from 1 through 10. The user posts an upsert that updates the value of record 1 and adds two new records, all successfully.
|
|
3397
|
+
* @export
|
|
3398
|
+
* @interface Upsert200Response
|
|
3399
|
+
*/
|
|
3400
|
+
interface Upsert200Response {
|
|
3401
|
+
[key: string]: any | any;
|
|
3402
|
+
/**
|
|
3403
|
+
* Information about created records, updated records, referenced but unchanged records, and records having any errors while being processed.
|
|
3404
|
+
* @type {{ [key: string]: any; }}
|
|
3405
|
+
* @memberof Upsert200Response
|
|
3406
|
+
*/
|
|
3407
|
+
metadata?: {
|
|
3408
|
+
[key: string]: any;
|
|
3409
|
+
};
|
|
3410
|
+
/**
|
|
3411
|
+
* The data that is expected to be returned.
|
|
3412
|
+
* @type {Array<Upsert200Response>}
|
|
3413
|
+
* @memberof Upsert200Response
|
|
3414
|
+
*/
|
|
3415
|
+
data?: Array<Upsert200Response>;
|
|
3416
|
+
}
|
|
3417
|
+
/**
|
|
3418
|
+
* Check if a given object implements the Upsert200Response interface.
|
|
3419
|
+
*/
|
|
3420
|
+
declare function instanceOfUpsert200Response(value: object): value is Upsert200Response;
|
|
3421
|
+
declare function Upsert200ResponseFromJSON(json: any): Upsert200Response;
|
|
3422
|
+
declare function Upsert200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): Upsert200Response;
|
|
3423
|
+
declare function Upsert200ResponseToJSON(json: any): Upsert200Response;
|
|
3424
|
+
declare function Upsert200ResponseToJSONTyped(value?: Upsert200Response | null, ignoreDiscriminator?: boolean): any;
|
|
3425
|
+
|
|
3426
|
+
/**
|
|
3427
|
+
* Quick Base API
|
|
3428
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3429
|
+
*
|
|
3430
|
+
* The version of the OpenAPI document: 1.0.0
|
|
3431
|
+
*
|
|
3432
|
+
*
|
|
3433
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3434
|
+
* https://openapi-generator.tech
|
|
3435
|
+
* Do not edit the class manually.
|
|
3436
|
+
*/
|
|
3437
|
+
|
|
3438
|
+
/**
|
|
3439
|
+
* Receiving this status code indicates that some (or all) of the individual records being handled had problems and were not processed successfully. The response will be reported under the 'lineErrors' element and indicate the total number of records processed and the errors that occurred with each record. The record IDs of records created, updated, and referenced but unchanged, will be returned in the 'createdRecordIds', 'updatedRecordIds', and 'unchangedRecordIds' elements respectively.
|
|
3440
|
+
* In the example below, a user tries to add three records to a table that previously had ten records with IDs from 1 through 10. The first and third records of the request are valid and create the 11th and 12th records in the table; the second record has a problem that prevents it from being processed.
|
|
3441
|
+
* @export
|
|
3442
|
+
* @interface Upsert207Response
|
|
3443
|
+
*/
|
|
3444
|
+
interface Upsert207Response {
|
|
3445
|
+
[key: string]: any | any;
|
|
3446
|
+
/**
|
|
3447
|
+
* Information about created records, updated records, referenced but unchanged records, and records having any errors while being processed.
|
|
3448
|
+
* @type {{ [key: string]: any; }}
|
|
3449
|
+
* @memberof Upsert207Response
|
|
3450
|
+
*/
|
|
3451
|
+
metadata?: {
|
|
3452
|
+
[key: string]: any;
|
|
3453
|
+
};
|
|
3454
|
+
/**
|
|
3455
|
+
* The data that is expected to be returned.
|
|
3456
|
+
* @type {Array<Upsert200Response>}
|
|
3457
|
+
* @memberof Upsert207Response
|
|
3458
|
+
*/
|
|
3459
|
+
data?: Array<Upsert200Response>;
|
|
3460
|
+
}
|
|
3461
|
+
/**
|
|
3462
|
+
* Check if a given object implements the Upsert207Response interface.
|
|
3463
|
+
*/
|
|
3464
|
+
declare function instanceOfUpsert207Response(value: object): value is Upsert207Response;
|
|
3465
|
+
declare function Upsert207ResponseFromJSON(json: any): Upsert207Response;
|
|
3466
|
+
declare function Upsert207ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): Upsert207Response;
|
|
3467
|
+
declare function Upsert207ResponseToJSON(json: any): Upsert207Response;
|
|
3468
|
+
declare function Upsert207ResponseToJSONTyped(value?: Upsert207Response | null, ignoreDiscriminator?: boolean): any;
|
|
3469
|
+
|
|
3470
|
+
/**
|
|
3471
|
+
* Quick Base API
|
|
3472
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3473
|
+
*
|
|
3474
|
+
* The version of the OpenAPI document: 1.0.0
|
|
3475
|
+
*
|
|
3476
|
+
*
|
|
3477
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3478
|
+
* https://openapi-generator.tech
|
|
3479
|
+
* Do not edit the class manually.
|
|
3480
|
+
*/
|
|
3481
|
+
/**
|
|
3482
|
+
* There was problem in the format of the request. This prevented the entire request from processing any records. The error response will be in the [standard format](../errors).
|
|
3483
|
+
* @export
|
|
3484
|
+
* @interface Upsert400Response
|
|
3485
|
+
*/
|
|
3486
|
+
interface Upsert400Response {
|
|
3487
|
+
[key: string]: any | any;
|
|
3488
|
+
/**
|
|
3489
|
+
* The type of error found.
|
|
3490
|
+
* @type {string}
|
|
3491
|
+
* @memberof Upsert400Response
|
|
3492
|
+
*/
|
|
3493
|
+
message?: string;
|
|
3494
|
+
/**
|
|
3495
|
+
* The description for the occurence of the error.
|
|
3496
|
+
* @type {string}
|
|
3497
|
+
* @memberof Upsert400Response
|
|
3498
|
+
*/
|
|
3499
|
+
description?: string;
|
|
3500
|
+
}
|
|
3501
|
+
/**
|
|
3502
|
+
* Check if a given object implements the Upsert400Response interface.
|
|
3503
|
+
*/
|
|
3504
|
+
declare function instanceOfUpsert400Response(value: object): value is Upsert400Response;
|
|
3505
|
+
declare function Upsert400ResponseFromJSON(json: any): Upsert400Response;
|
|
3506
|
+
declare function Upsert400ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): Upsert400Response;
|
|
3507
|
+
declare function Upsert400ResponseToJSON(json: any): Upsert400Response;
|
|
3508
|
+
declare function Upsert400ResponseToJSONTyped(value?: Upsert400Response | null, ignoreDiscriminator?: boolean): any;
|
|
3509
|
+
|
|
3510
|
+
/**
|
|
3511
|
+
* Quick Base API
|
|
3512
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3513
|
+
*
|
|
3514
|
+
* The version of the OpenAPI document: 1.0.0
|
|
3515
|
+
*
|
|
3516
|
+
*
|
|
3517
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3518
|
+
* https://openapi-generator.tech
|
|
3519
|
+
* Do not edit the class manually.
|
|
3520
|
+
*/
|
|
3521
|
+
|
|
3522
|
+
/**
|
|
3523
|
+
*
|
|
3524
|
+
* @export
|
|
3525
|
+
* @interface UpsertRequest
|
|
3526
|
+
*/
|
|
3527
|
+
interface UpsertRequest {
|
|
3528
|
+
[key: string]: any | any;
|
|
3529
|
+
/**
|
|
3530
|
+
* The table identifier.
|
|
3531
|
+
* @type {string}
|
|
3532
|
+
* @memberof UpsertRequest
|
|
3533
|
+
*/
|
|
3534
|
+
to: string;
|
|
3535
|
+
/**
|
|
3536
|
+
* Record data array, where each record contains key-value mappings of fields to be defined/updated and their values.
|
|
3537
|
+
* @type {Array<Record>}
|
|
3538
|
+
* @memberof UpsertRequest
|
|
3539
|
+
*/
|
|
3540
|
+
data?: Array<Record>;
|
|
3541
|
+
/**
|
|
3542
|
+
* The merge field id.
|
|
3543
|
+
* @type {number}
|
|
3544
|
+
* @memberof UpsertRequest
|
|
3545
|
+
*/
|
|
3546
|
+
mergeFieldId?: number;
|
|
3547
|
+
/**
|
|
3548
|
+
* Specify an array of field ids that will return data for any updates or added record. Record ID (FID 3) is always returned if any field ID is requested.
|
|
3549
|
+
* @type {Array<number>}
|
|
3550
|
+
* @memberof UpsertRequest
|
|
3551
|
+
*/
|
|
3552
|
+
fieldsToReturn?: Array<number>;
|
|
3553
|
+
}
|
|
3554
|
+
/**
|
|
3555
|
+
* Check if a given object implements the UpsertRequest interface.
|
|
3556
|
+
*/
|
|
3557
|
+
declare function instanceOfUpsertRequest(value: object): value is UpsertRequest;
|
|
3558
|
+
declare function UpsertRequestFromJSON(json: any): UpsertRequest;
|
|
3559
|
+
declare function UpsertRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpsertRequest;
|
|
3560
|
+
declare function UpsertRequestToJSON(json: any): UpsertRequest;
|
|
3561
|
+
declare function UpsertRequestToJSONTyped(value?: UpsertRequest | null, ignoreDiscriminator?: boolean): any;
|
|
3562
|
+
|
|
3563
|
+
interface QuickbaseClient$1 {
|
|
3564
|
+
createApp: (params: {
|
|
3565
|
+
generated?: any;
|
|
3566
|
+
}) => Promise<{
|
|
3567
|
+
[key: string]: any;
|
|
3568
|
+
}>;
|
|
3569
|
+
getApp: (params: {
|
|
3570
|
+
appId: string;
|
|
3571
|
+
}) => Promise<App>;
|
|
3572
|
+
getAppEvents: (params: {
|
|
3573
|
+
appId: string;
|
|
3574
|
+
}) => Promise<any[]>;
|
|
3575
|
+
copyApp: (params: {
|
|
3576
|
+
appId: string;
|
|
3577
|
+
generated?: any;
|
|
3578
|
+
}) => Promise<{
|
|
3579
|
+
[key: string]: any;
|
|
3580
|
+
}>;
|
|
3581
|
+
getAppTables: (params: {
|
|
3582
|
+
appId: string;
|
|
3583
|
+
}) => Promise<Table[]>;
|
|
3584
|
+
getTable: (params: {
|
|
3585
|
+
appId: string;
|
|
3586
|
+
tableId: string;
|
|
3587
|
+
}) => Promise<{
|
|
3588
|
+
[key: string]: any;
|
|
3589
|
+
}>;
|
|
3590
|
+
updateTable: (params: {
|
|
3591
|
+
appId: string;
|
|
3592
|
+
tableId: string;
|
|
3593
|
+
generated?: {
|
|
3594
|
+
[key: string]: any;
|
|
3595
|
+
};
|
|
3596
|
+
}) => Promise<{
|
|
3597
|
+
[key: string]: any;
|
|
3598
|
+
}>;
|
|
3599
|
+
deleteTable: (params: {
|
|
3600
|
+
appId: string;
|
|
3601
|
+
tableId: string;
|
|
3602
|
+
}) => Promise<{
|
|
3603
|
+
[key: string]: any;
|
|
3604
|
+
}>;
|
|
3605
|
+
getRelationships: (params: {
|
|
3606
|
+
skip?: number;
|
|
3607
|
+
tableId: string;
|
|
3608
|
+
}) => Promise<{
|
|
3609
|
+
[key: string]: any;
|
|
3610
|
+
}>;
|
|
3611
|
+
createRelationship: (params: {
|
|
3612
|
+
tableId: string;
|
|
3613
|
+
generated?: any;
|
|
3614
|
+
}) => Promise<{
|
|
3615
|
+
[key: string]: any;
|
|
3616
|
+
}>;
|
|
3617
|
+
updateRelationship: (params: {
|
|
3618
|
+
tableId: string;
|
|
3619
|
+
relationshipId: any;
|
|
3620
|
+
generated?: any;
|
|
3621
|
+
}) => Promise<{
|
|
3622
|
+
[key: string]: any;
|
|
3623
|
+
}>;
|
|
3624
|
+
deleteRelationship: (params: {
|
|
3625
|
+
tableId: string;
|
|
3626
|
+
relationshipId: any;
|
|
3627
|
+
}) => Promise<{
|
|
3628
|
+
[key: string]: any;
|
|
3629
|
+
}>;
|
|
3630
|
+
getTableReports: (params: {
|
|
3631
|
+
tableId: string;
|
|
3632
|
+
}) => Promise<any[]>;
|
|
3633
|
+
getReport: (params: {
|
|
3634
|
+
tableId: string;
|
|
3635
|
+
reportId: string;
|
|
3636
|
+
}) => Promise<{
|
|
3637
|
+
[key: string]: any;
|
|
3638
|
+
}>;
|
|
3639
|
+
runReport: (params: {
|
|
3640
|
+
reportId: string;
|
|
3641
|
+
generated: any;
|
|
3642
|
+
}) => Promise<ReportRunResponse[]>;
|
|
3643
|
+
getFields: (params: {
|
|
3644
|
+
tableId: string;
|
|
3645
|
+
includeFieldPerms?: boolean;
|
|
3646
|
+
}) => Promise<Field[]>;
|
|
3647
|
+
getField: (params: {
|
|
3648
|
+
tableId: string;
|
|
3649
|
+
includeFieldPerms?: boolean;
|
|
3650
|
+
fieldId: number;
|
|
3651
|
+
}) => Promise<{
|
|
3652
|
+
[key: string]: any;
|
|
3653
|
+
}>;
|
|
3654
|
+
updateField: (params: {
|
|
3655
|
+
tableId: string;
|
|
3656
|
+
fieldId: number;
|
|
3657
|
+
generated?: any;
|
|
3658
|
+
}) => Promise<{
|
|
3659
|
+
[key: string]: any;
|
|
3660
|
+
}>;
|
|
3661
|
+
getFieldsUsage: (params: {
|
|
3662
|
+
tableId: string;
|
|
3663
|
+
skip?: number;
|
|
3664
|
+
top?: number;
|
|
3665
|
+
}) => Promise<any[]>;
|
|
3666
|
+
getFieldUsage: (params: {
|
|
3667
|
+
tableId: string;
|
|
3668
|
+
fieldId: number;
|
|
3669
|
+
}) => Promise<any[]>;
|
|
3670
|
+
runFormula: (params: {
|
|
3671
|
+
generated?: any;
|
|
3672
|
+
}) => Promise<{
|
|
3673
|
+
[key: string]: any;
|
|
3674
|
+
}>;
|
|
3675
|
+
upsert: (params: {
|
|
3676
|
+
generated?: {
|
|
3677
|
+
[key: string]: any;
|
|
3678
|
+
};
|
|
3679
|
+
}) => Promise<{
|
|
3680
|
+
[key: string]: any;
|
|
3681
|
+
}>;
|
|
3682
|
+
deleteRecords: (params: {
|
|
3683
|
+
generated?: {
|
|
3684
|
+
[key: string]: any;
|
|
3685
|
+
};
|
|
3686
|
+
}) => Promise<{
|
|
3687
|
+
[key: string]: any;
|
|
3688
|
+
}>;
|
|
3689
|
+
upsertRecords: (params: {
|
|
3690
|
+
generated: {
|
|
3691
|
+
[key: string]: string;
|
|
3692
|
+
}[];
|
|
3693
|
+
}) => Promise<Upsert200Response[] | Upsert207Response[]>;
|
|
3694
|
+
getTempTokenDBID: (params: {
|
|
3695
|
+
dbid: string;
|
|
3696
|
+
}) => Promise<GetTempTokenDBID200Response>;
|
|
3697
|
+
exchangeSsoToken: (params: {
|
|
3698
|
+
generated?: any;
|
|
3699
|
+
}) => Promise<{
|
|
3700
|
+
[key: string]: any;
|
|
3701
|
+
}>;
|
|
3702
|
+
cloneUserToken: (params: {
|
|
3703
|
+
generated?: any;
|
|
3704
|
+
}) => Promise<{
|
|
3705
|
+
[key: string]: any;
|
|
3706
|
+
}>;
|
|
3707
|
+
transferUserToken: (params: {
|
|
3708
|
+
generated?: any;
|
|
3709
|
+
}) => Promise<{
|
|
3710
|
+
[key: string]: any;
|
|
3711
|
+
}>;
|
|
3712
|
+
deactivateUserToken: (params: {}) => Promise<{
|
|
3713
|
+
[key: string]: any;
|
|
3714
|
+
}>;
|
|
3715
|
+
deleteUserToken: (params: {}) => Promise<{
|
|
3716
|
+
[key: string]: any;
|
|
3717
|
+
}>;
|
|
3718
|
+
downloadFile: (params: {
|
|
3719
|
+
tableId: string;
|
|
3720
|
+
recordId: number;
|
|
3721
|
+
fieldId: number;
|
|
3722
|
+
versionNumber: number;
|
|
3723
|
+
}) => Promise<any>;
|
|
3724
|
+
deleteFile: (params: {
|
|
3725
|
+
tableId: string;
|
|
3726
|
+
recordId: number;
|
|
3727
|
+
fieldId: number;
|
|
3728
|
+
versionNumber: number;
|
|
3729
|
+
}) => Promise<{
|
|
3730
|
+
[key: string]: any;
|
|
3731
|
+
}>;
|
|
3732
|
+
getUsers: (params: {
|
|
3733
|
+
accountId?: any;
|
|
3734
|
+
generated?: {
|
|
3735
|
+
[key: string]: any;
|
|
3736
|
+
};
|
|
3737
|
+
}) => Promise<{
|
|
3738
|
+
[key: string]: any;
|
|
3739
|
+
}>;
|
|
3740
|
+
denyUsers: (params: {
|
|
3741
|
+
accountId?: any;
|
|
3742
|
+
generated?: string[];
|
|
3743
|
+
}) => Promise<{
|
|
3744
|
+
[key: string]: any;
|
|
3745
|
+
}>;
|
|
3746
|
+
denyUsersAndGroups: (params: {
|
|
3747
|
+
accountId?: any;
|
|
3748
|
+
shouldDeleteFromGroups: boolean;
|
|
3749
|
+
generated?: string[];
|
|
3750
|
+
}) => Promise<{
|
|
3751
|
+
[key: string]: any;
|
|
3752
|
+
}>;
|
|
3753
|
+
undenyUsers: (params: {
|
|
3754
|
+
accountId?: any;
|
|
3755
|
+
generated?: string[];
|
|
3756
|
+
}) => Promise<{
|
|
3757
|
+
[key: string]: any;
|
|
3758
|
+
}>;
|
|
3759
|
+
addMembersToGroup: (params: {
|
|
3760
|
+
gid: any;
|
|
3761
|
+
generated?: string[];
|
|
3762
|
+
}) => Promise<{
|
|
3763
|
+
[key: string]: any;
|
|
3764
|
+
}>;
|
|
3765
|
+
removeMembersFromGroup: (params: {
|
|
3766
|
+
gid: any;
|
|
3767
|
+
generated?: string[];
|
|
3768
|
+
}) => Promise<{
|
|
3769
|
+
[key: string]: any;
|
|
3770
|
+
}>;
|
|
3771
|
+
addManagersToGroup: (params: {
|
|
3772
|
+
gid: any;
|
|
3773
|
+
generated?: string[];
|
|
3774
|
+
}) => Promise<{
|
|
3775
|
+
[key: string]: any;
|
|
3776
|
+
}>;
|
|
3777
|
+
removeManagersFromGroup: (params: {
|
|
3778
|
+
gid: any;
|
|
3779
|
+
generated?: string[];
|
|
3780
|
+
}) => Promise<{
|
|
3781
|
+
[key: string]: any;
|
|
3782
|
+
}>;
|
|
3783
|
+
addSubgroupsToGroup: (params: {
|
|
3784
|
+
gid: any;
|
|
3785
|
+
generated?: string[];
|
|
3786
|
+
}) => Promise<{
|
|
3787
|
+
[key: string]: any;
|
|
3788
|
+
}>;
|
|
3789
|
+
removeSubgroupsFromGroup: (params: {
|
|
3790
|
+
gid: any;
|
|
3791
|
+
generated?: string[];
|
|
3792
|
+
}) => Promise<{
|
|
3793
|
+
[key: string]: any;
|
|
3794
|
+
}>;
|
|
3795
|
+
audit: (params: {
|
|
3796
|
+
generated?: any;
|
|
3797
|
+
}) => Promise<{
|
|
3798
|
+
[key: string]: any;
|
|
3799
|
+
}>;
|
|
3800
|
+
platformAnalyticReads: (params: {
|
|
3801
|
+
day?: string;
|
|
3802
|
+
}) => Promise<{
|
|
3803
|
+
[key: string]: any;
|
|
3804
|
+
}>;
|
|
3805
|
+
platformAnalyticEventSummaries: (params: {
|
|
3806
|
+
accountId?: any;
|
|
3807
|
+
generated?: any;
|
|
3808
|
+
}) => Promise<any>;
|
|
3809
|
+
exportSolution: (params: {
|
|
3810
|
+
solutionId: string;
|
|
3811
|
+
qBLVersion?: string;
|
|
3812
|
+
}) => Promise<any>;
|
|
3813
|
+
updateSolution: (params: {
|
|
3814
|
+
solutionId: string;
|
|
3815
|
+
generated?: any;
|
|
3816
|
+
xQBLErrorsAsSuccess?: boolean;
|
|
3817
|
+
}) => Promise<any>;
|
|
3818
|
+
createSolution: (params: {
|
|
3819
|
+
generated?: any;
|
|
3820
|
+
xQBLErrorsAsSuccess?: boolean;
|
|
3821
|
+
}) => Promise<any>;
|
|
3822
|
+
exportSolutionToRecord: (params: {
|
|
3823
|
+
solutionId: string;
|
|
3824
|
+
tableId: string;
|
|
3825
|
+
fieldId: number;
|
|
3826
|
+
xQBLErrorsAsSuccess?: boolean;
|
|
3827
|
+
qBLVersion?: string;
|
|
3828
|
+
}) => Promise<any>;
|
|
3829
|
+
createSolutionFromRecord: (params: {
|
|
3830
|
+
tableId: string;
|
|
3831
|
+
fieldId: number;
|
|
3832
|
+
recordId: number;
|
|
3833
|
+
xQBLErrorsAsSuccess?: boolean;
|
|
3834
|
+
}) => Promise<any>;
|
|
3835
|
+
updateSolutionToRecord: (params: {
|
|
3836
|
+
solutionId: string;
|
|
3837
|
+
tableId: string;
|
|
3838
|
+
fieldId: number;
|
|
3839
|
+
recordId: number;
|
|
3840
|
+
xQBLErrorsAsSuccess?: boolean;
|
|
3841
|
+
}) => Promise<any>;
|
|
3842
|
+
changesetSolution: (params: {
|
|
3843
|
+
solutionId: string;
|
|
3844
|
+
generated?: any;
|
|
3845
|
+
xQBLErrorsAsSuccess?: boolean;
|
|
3846
|
+
}) => Promise<any>;
|
|
3847
|
+
changesetSolutionFromRecord: (params: {
|
|
3848
|
+
solutionId: string;
|
|
3849
|
+
tableId: string;
|
|
3850
|
+
fieldId: number;
|
|
3851
|
+
recordId: number;
|
|
3852
|
+
xQBLErrorsAsSuccess?: boolean;
|
|
3853
|
+
}) => Promise<any>;
|
|
3854
|
+
generateDocument: (params: {
|
|
3855
|
+
templateId: any;
|
|
3856
|
+
tableId: string;
|
|
3857
|
+
recordId?: any;
|
|
3858
|
+
filename: string;
|
|
3859
|
+
accept?: string;
|
|
3860
|
+
format?: string;
|
|
3861
|
+
margin?: string;
|
|
3862
|
+
unit?: string;
|
|
3863
|
+
pageSize?: string;
|
|
3864
|
+
orientation?: string;
|
|
3865
|
+
realm?: string;
|
|
3866
|
+
}) => Promise<{
|
|
3867
|
+
[key: string]: any;
|
|
3868
|
+
}>;
|
|
3869
|
+
}
|
|
3870
|
+
|
|
3871
|
+
interface QuickbaseClient extends QuickbaseClient$1 {
|
|
3872
|
+
}
|
|
3873
|
+
interface QuickbaseConfig {
|
|
3874
|
+
realm: string;
|
|
3875
|
+
userToken?: string;
|
|
3876
|
+
tempToken?: string;
|
|
3877
|
+
useTempTokens?: boolean;
|
|
3878
|
+
debug?: boolean;
|
|
3879
|
+
fetchApi?: typeof fetch;
|
|
3880
|
+
}
|
|
3881
|
+
interface TempTokenParams {
|
|
3882
|
+
appId?: string;
|
|
3883
|
+
tableId?: string;
|
|
3884
|
+
dbid?: string;
|
|
3885
|
+
}
|
|
3886
|
+
declare function quickbaseClient(config: QuickbaseConfig): QuickbaseClient;
|
|
3887
|
+
|
|
3888
|
+
export { type AddMembersToGroup200Response, AddMembersToGroup200ResponseFromJSON, AddMembersToGroup200ResponseFromJSONTyped, AddMembersToGroup200ResponseToJSON, AddMembersToGroup200ResponseToJSONTyped, type AddSubgroupsToGroup200Response, AddSubgroupsToGroup200ResponseFromJSON, AddSubgroupsToGroup200ResponseFromJSONTyped, AddSubgroupsToGroup200ResponseToJSON, AddSubgroupsToGroup200ResponseToJSONTyped, type App, AppFromJSON, AppFromJSONTyped, type AppMemoryInfo, AppMemoryInfoFromJSON, AppMemoryInfoFromJSONTyped, AppMemoryInfoToJSON, AppMemoryInfoToJSONTyped, type AppSecurityProperties, AppSecurityPropertiesFromJSON, AppSecurityPropertiesFromJSONTyped, AppSecurityPropertiesToJSON, AppSecurityPropertiesToJSONTyped, AppToJSON, AppToJSONTyped, type Audit200Response, Audit200ResponseFromJSON, Audit200ResponseFromJSONTyped, Audit200ResponseToJSON, Audit200ResponseToJSONTyped, type Audit202Response, Audit202ResponseFromJSON, Audit202ResponseFromJSONTyped, Audit202ResponseToJSON, Audit202ResponseToJSONTyped, type AuditRequest, AuditRequestFromJSON, AuditRequestFromJSONTyped, AuditRequestToJSON, AuditRequestToJSONTyped, type CloneUserToken200Response, CloneUserToken200ResponseFromJSON, CloneUserToken200ResponseFromJSONTyped, CloneUserToken200ResponseToJSON, CloneUserToken200ResponseToJSONTyped, type CloneUserTokenRequest, CloneUserTokenRequestFromJSON, CloneUserTokenRequestFromJSONTyped, CloneUserTokenRequestToJSON, CloneUserTokenRequestToJSONTyped, type CopyApp200Response, CopyApp200ResponseFromJSON, CopyApp200ResponseFromJSONTyped, CopyApp200ResponseToJSON, CopyApp200ResponseToJSONTyped, type CopyAppRequest, CopyAppRequestFromJSON, CopyAppRequestFromJSONTyped, CopyAppRequestToJSON, CopyAppRequestToJSONTyped, type CreateApp200Response, CreateApp200ResponseFromJSON, CreateApp200ResponseFromJSONTyped, CreateApp200ResponseToJSON, CreateApp200ResponseToJSONTyped, type CreateAppRequest, CreateAppRequestFromJSON, CreateAppRequestFromJSONTyped, CreateAppRequestToJSON, CreateAppRequestToJSONTyped, type CreateRelationship200Response, CreateRelationship200ResponseFromJSON, CreateRelationship200ResponseFromJSONTyped, CreateRelationship200ResponseToJSON, CreateRelationship200ResponseToJSONTyped, type CreateRelationshipRequest, CreateRelationshipRequestFromJSON, CreateRelationshipRequestFromJSONTyped, CreateRelationshipRequestToJSON, CreateRelationshipRequestToJSONTyped, type DeactivateUserToken200Response, DeactivateUserToken200ResponseFromJSON, DeactivateUserToken200ResponseFromJSONTyped, DeactivateUserToken200ResponseToJSON, DeactivateUserToken200ResponseToJSONTyped, type DeleteFile200Response, DeleteFile200ResponseFromJSON, DeleteFile200ResponseFromJSONTyped, DeleteFile200ResponseToJSON, DeleteFile200ResponseToJSONTyped, type DeleteRecords200Response, DeleteRecords200ResponseFromJSON, DeleteRecords200ResponseFromJSONTyped, DeleteRecords200ResponseToJSON, DeleteRecords200ResponseToJSONTyped, type DeleteRecordsRequest, DeleteRecordsRequestFromJSON, DeleteRecordsRequestFromJSONTyped, DeleteRecordsRequestToJSON, DeleteRecordsRequestToJSONTyped, type DeleteRelationship200Response, DeleteRelationship200ResponseFromJSON, DeleteRelationship200ResponseFromJSONTyped, DeleteRelationship200ResponseToJSON, DeleteRelationship200ResponseToJSONTyped, type DeleteTable200Response, DeleteTable200ResponseFromJSON, DeleteTable200ResponseFromJSONTyped, DeleteTable200ResponseToJSON, DeleteTable200ResponseToJSONTyped, type DenyUsers200Response, DenyUsers200ResponseFromJSON, DenyUsers200ResponseFromJSONTyped, DenyUsers200ResponseToJSON, DenyUsers200ResponseToJSONTyped, type ExchangeSsoToken200Response, ExchangeSsoToken200ResponseFromJSON, ExchangeSsoToken200ResponseFromJSONTyped, ExchangeSsoToken200ResponseIssuedTokenTypeEnum, ExchangeSsoToken200ResponseToJSON, ExchangeSsoToken200ResponseToJSONTyped, ExchangeSsoToken200ResponseTokenTypeEnum, type ExchangeSsoTokenRequest, ExchangeSsoTokenRequestFromJSON, ExchangeSsoTokenRequestFromJSONTyped, ExchangeSsoTokenRequestGrantTypeEnum, ExchangeSsoTokenRequestRequestedTokenTypeEnum, ExchangeSsoTokenRequestSubjectTokenTypeEnum, ExchangeSsoTokenRequestToJSON, ExchangeSsoTokenRequestToJSONTyped, type Field, FieldFromJSON, FieldFromJSONTyped, type FieldPermissionsInner, FieldPermissionsInnerFromJSON, FieldPermissionsInnerFromJSONTyped, FieldPermissionsInnerToJSON, FieldPermissionsInnerToJSONTyped, type FieldProperties, FieldPropertiesFromJSON, FieldPropertiesFromJSONTyped, FieldPropertiesToJSON, FieldPropertiesToJSONTyped, FieldToJSON, FieldToJSONTyped, type GenerateDocument200Response, GenerateDocument200ResponseFromJSON, GenerateDocument200ResponseFromJSONTyped, GenerateDocument200ResponseToJSON, GenerateDocument200ResponseToJSONTyped, type GetField200Response, GetField200ResponseFromJSON, GetField200ResponseFromJSONTyped, GetField200ResponseToJSON, GetField200ResponseToJSONTyped, type GetRelationships200Response, GetRelationships200ResponseFromJSON, GetRelationships200ResponseFromJSONTyped, GetRelationships200ResponseToJSON, GetRelationships200ResponseToJSONTyped, type GetReport200Response, GetReport200ResponseFromJSON, GetReport200ResponseFromJSONTyped, GetReport200ResponseToJSON, GetReport200ResponseToJSONTyped, type GetTable200Response, GetTable200ResponseDefaultSortOrderEnum, GetTable200ResponseFromJSON, GetTable200ResponseFromJSONTyped, GetTable200ResponseToJSON, GetTable200ResponseToJSONTyped, type GetTempTokenDBID200Response, GetTempTokenDBID200ResponseFromJSON, GetTempTokenDBID200ResponseFromJSONTyped, GetTempTokenDBID200ResponseToJSON, GetTempTokenDBID200ResponseToJSONTyped, type GetUsers200Response, GetUsers200ResponseFromJSON, GetUsers200ResponseFromJSONTyped, GetUsers200ResponseToJSON, GetUsers200ResponseToJSONTyped, type GetUsersRequest, GetUsersRequestFromJSON, GetUsersRequestFromJSONTyped, GetUsersRequestToJSON, GetUsersRequestToJSONTyped, type PlatformAnalyticEventSummaries200Response, PlatformAnalyticEventSummaries200ResponseFromJSON, PlatformAnalyticEventSummaries200ResponseFromJSONTyped, PlatformAnalyticEventSummaries200ResponseGroupByEnum, type PlatformAnalyticEventSummaries200ResponseMetadata, PlatformAnalyticEventSummaries200ResponseMetadataFromJSON, PlatformAnalyticEventSummaries200ResponseMetadataFromJSONTyped, PlatformAnalyticEventSummaries200ResponseMetadataToJSON, PlatformAnalyticEventSummaries200ResponseMetadataToJSONTyped, type PlatformAnalyticEventSummaries200ResponseResultsInner, type PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInner, PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInnerBillingCategoryEnum, PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInnerFromJSON, PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInnerFromJSONTyped, PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInnerToJSON, PlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInnerToJSONTyped, PlatformAnalyticEventSummaries200ResponseResultsInnerFromJSON, PlatformAnalyticEventSummaries200ResponseResultsInnerFromJSONTyped, PlatformAnalyticEventSummaries200ResponseResultsInnerToJSON, PlatformAnalyticEventSummaries200ResponseResultsInnerToJSONTyped, type PlatformAnalyticEventSummaries200ResponseResultsInnerTotals, PlatformAnalyticEventSummaries200ResponseResultsInnerTotalsFromJSON, PlatformAnalyticEventSummaries200ResponseResultsInnerTotalsFromJSONTyped, PlatformAnalyticEventSummaries200ResponseResultsInnerTotalsToJSON, PlatformAnalyticEventSummaries200ResponseResultsInnerTotalsToJSONTyped, PlatformAnalyticEventSummaries200ResponseToJSON, PlatformAnalyticEventSummaries200ResponseToJSONTyped, type PlatformAnalyticEventSummaries200ResponseTotals, PlatformAnalyticEventSummaries200ResponseTotalsFromJSON, PlatformAnalyticEventSummaries200ResponseTotalsFromJSONTyped, PlatformAnalyticEventSummaries200ResponseTotalsToJSON, PlatformAnalyticEventSummaries200ResponseTotalsToJSONTyped, type PlatformAnalyticEventSummaries200ResponseWhereInner, PlatformAnalyticEventSummaries200ResponseWhereInnerFromJSON, PlatformAnalyticEventSummaries200ResponseWhereInnerFromJSONTyped, PlatformAnalyticEventSummaries200ResponseWhereInnerToJSON, PlatformAnalyticEventSummaries200ResponseWhereInnerToJSONTyped, PlatformAnalyticEventSummaries200ResponseWhereInnerTypeEnum, type PlatformAnalyticEventSummariesRequest, PlatformAnalyticEventSummariesRequestFromJSON, PlatformAnalyticEventSummariesRequestFromJSONTyped, PlatformAnalyticEventSummariesRequestGroupByEnum, PlatformAnalyticEventSummariesRequestToJSON, PlatformAnalyticEventSummariesRequestToJSONTyped, type PlatformAnalyticEventSummariesRequestWhereInner, PlatformAnalyticEventSummariesRequestWhereInnerFromJSON, PlatformAnalyticEventSummariesRequestWhereInnerFromJSONTyped, PlatformAnalyticEventSummariesRequestWhereInnerToJSON, PlatformAnalyticEventSummariesRequestWhereInnerToJSONTyped, PlatformAnalyticEventSummariesRequestWhereInnerTypeEnum, type PlatformAnalyticReads200Response, PlatformAnalyticReads200ResponseFromJSON, PlatformAnalyticReads200ResponseFromJSONTyped, PlatformAnalyticReads200ResponseToJSON, PlatformAnalyticReads200ResponseToJSONTyped, type QuickbaseClient, type QuickbaseConfig, type Record, RecordFromJSON, RecordFromJSONTyped, RecordToJSON, RecordToJSONTyped, type RemoveMembersFromGroup200Response, RemoveMembersFromGroup200ResponseFromJSON, RemoveMembersFromGroup200ResponseFromJSONTyped, RemoveMembersFromGroup200ResponseToJSON, RemoveMembersFromGroup200ResponseToJSONTyped, type RemoveSubgroupsFromGroup200Response, RemoveSubgroupsFromGroup200ResponseFromJSON, RemoveSubgroupsFromGroup200ResponseFromJSONTyped, RemoveSubgroupsFromGroup200ResponseToJSON, RemoveSubgroupsFromGroup200ResponseToJSONTyped, type ReportRunResponse, ReportRunResponseFromJSON, ReportRunResponseFromJSONTyped, ReportRunResponseToJSON, ReportRunResponseToJSONTyped, type RunFormula200Response, RunFormula200ResponseFromJSON, RunFormula200ResponseFromJSONTyped, RunFormula200ResponseToJSON, RunFormula200ResponseToJSONTyped, type RunFormulaRequest, RunFormulaRequestFromJSON, RunFormulaRequestFromJSONTyped, RunFormulaRequestToJSON, RunFormulaRequestToJSONTyped, type Table, TableFromJSON, TableFromJSONTyped, TableToJSON, TableToJSONTyped, type TempTokenParams, type TransferUserToken200Response, TransferUserToken200ResponseFromJSON, TransferUserToken200ResponseFromJSONTyped, TransferUserToken200ResponseToJSON, TransferUserToken200ResponseToJSONTyped, type TransferUserTokenRequest, TransferUserTokenRequestFromJSON, TransferUserTokenRequestFromJSONTyped, TransferUserTokenRequestToJSON, TransferUserTokenRequestToJSONTyped, type UndenyUsers200Response, UndenyUsers200ResponseFromJSON, UndenyUsers200ResponseFromJSONTyped, UndenyUsers200ResponseToJSON, UndenyUsers200ResponseToJSONTyped, type UpdateFieldRequest, UpdateFieldRequestFromJSON, UpdateFieldRequestFromJSONTyped, UpdateFieldRequestToJSON, UpdateFieldRequestToJSONTyped, type UpdateRelationshipRequest, UpdateRelationshipRequestFromJSON, UpdateRelationshipRequestFromJSONTyped, UpdateRelationshipRequestToJSON, UpdateRelationshipRequestToJSONTyped, type UpdateTableRequest, UpdateTableRequestFromJSON, UpdateTableRequestFromJSONTyped, UpdateTableRequestToJSON, UpdateTableRequestToJSONTyped, type Upsert200Response, Upsert200ResponseFromJSON, Upsert200ResponseFromJSONTyped, Upsert200ResponseToJSON, Upsert200ResponseToJSONTyped, type Upsert207Response, Upsert207ResponseFromJSON, Upsert207ResponseFromJSONTyped, Upsert207ResponseToJSON, Upsert207ResponseToJSONTyped, type Upsert400Response, Upsert400ResponseFromJSON, Upsert400ResponseFromJSONTyped, Upsert400ResponseToJSON, Upsert400ResponseToJSONTyped, type UpsertRequest, UpsertRequestFromJSON, UpsertRequestFromJSONTyped, UpsertRequestToJSON, UpsertRequestToJSONTyped, instanceOfAddMembersToGroup200Response, instanceOfAddSubgroupsToGroup200Response, instanceOfApp, instanceOfAppMemoryInfo, instanceOfAppSecurityProperties, instanceOfAudit200Response, instanceOfAudit202Response, instanceOfAuditRequest, instanceOfCloneUserToken200Response, instanceOfCloneUserTokenRequest, instanceOfCopyApp200Response, instanceOfCopyAppRequest, instanceOfCreateApp200Response, instanceOfCreateAppRequest, instanceOfCreateRelationship200Response, instanceOfCreateRelationshipRequest, instanceOfDeactivateUserToken200Response, instanceOfDeleteFile200Response, instanceOfDeleteRecords200Response, instanceOfDeleteRecordsRequest, instanceOfDeleteRelationship200Response, instanceOfDeleteTable200Response, instanceOfDenyUsers200Response, instanceOfExchangeSsoToken200Response, instanceOfExchangeSsoTokenRequest, instanceOfField, instanceOfFieldPermissionsInner, instanceOfFieldProperties, instanceOfGenerateDocument200Response, instanceOfGetField200Response, instanceOfGetRelationships200Response, instanceOfGetReport200Response, instanceOfGetTable200Response, instanceOfGetTempTokenDBID200Response, instanceOfGetUsers200Response, instanceOfGetUsersRequest, instanceOfPlatformAnalyticEventSummaries200Response, instanceOfPlatformAnalyticEventSummaries200ResponseMetadata, instanceOfPlatformAnalyticEventSummaries200ResponseResultsInner, instanceOfPlatformAnalyticEventSummaries200ResponseResultsInnerEventTypesInner, instanceOfPlatformAnalyticEventSummaries200ResponseResultsInnerTotals, instanceOfPlatformAnalyticEventSummaries200ResponseTotals, instanceOfPlatformAnalyticEventSummaries200ResponseWhereInner, instanceOfPlatformAnalyticEventSummariesRequest, instanceOfPlatformAnalyticEventSummariesRequestWhereInner, instanceOfPlatformAnalyticReads200Response, instanceOfRecord, instanceOfRemoveMembersFromGroup200Response, instanceOfRemoveSubgroupsFromGroup200Response, instanceOfReportRunResponse, instanceOfRunFormula200Response, instanceOfRunFormulaRequest, instanceOfTable, instanceOfTransferUserToken200Response, instanceOfTransferUserTokenRequest, instanceOfUndenyUsers200Response, instanceOfUpdateFieldRequest, instanceOfUpdateRelationshipRequest, instanceOfUpdateTableRequest, instanceOfUpsert200Response, instanceOfUpsert207Response, instanceOfUpsert400Response, instanceOfUpsertRequest, quickbaseClient };
|