@cirrobio/api-client 0.12.22 → 0.12.24
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/apis/SheetsApi.d.ts +102 -0
- package/dist/apis/SheetsApi.js +276 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/SheetsApi.d.ts +102 -0
- package/dist/esm/apis/SheetsApi.js +272 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/ColumnDataType.d.ts +30 -0
- package/dist/esm/models/ColumnDataType.js +39 -0
- package/dist/esm/models/ColumnDef.d.ts +51 -0
- package/dist/esm/models/ColumnDef.js +54 -0
- package/dist/esm/models/CreateSheetRequest.d.ts +70 -0
- package/dist/esm/models/CreateSheetRequest.js +63 -0
- package/dist/esm/models/CreateSheetRequestFileDef.d.ts +38 -0
- package/dist/esm/models/CreateSheetRequestFileDef.js +47 -0
- package/dist/esm/models/DatasetDetail.d.ts +6 -0
- package/dist/esm/models/DatasetDetail.js +2 -0
- package/dist/esm/models/FeatureFlags.d.ts +6 -0
- package/dist/esm/models/FeatureFlags.js +3 -0
- package/dist/esm/models/FileDef.d.ts +38 -0
- package/dist/esm/models/FileDef.js +47 -0
- package/dist/esm/models/FileType.d.ts +24 -0
- package/dist/esm/models/FileType.js +33 -0
- package/dist/esm/models/ForeignKeyRef.d.ts +37 -0
- package/dist/esm/models/ForeignKeyRef.js +46 -0
- package/dist/esm/models/Permission.d.ts +4 -0
- package/dist/esm/models/Permission.js +4 -0
- package/dist/esm/models/ProjectSettings.d.ts +6 -0
- package/dist/esm/models/ProjectSettings.js +2 -0
- package/dist/esm/models/Sheet.d.ts +88 -0
- package/dist/esm/models/Sheet.js +73 -0
- package/dist/esm/models/SheetDetail.d.ts +107 -0
- package/dist/esm/models/SheetDetail.js +83 -0
- package/dist/esm/models/SheetJob.d.ts +93 -0
- package/dist/esm/models/SheetJob.js +71 -0
- package/dist/esm/models/SheetJobType.d.ts +25 -0
- package/dist/esm/models/SheetJobType.js +34 -0
- package/dist/esm/models/SheetTableType.d.ts +25 -0
- package/dist/esm/models/SheetTableType.js +34 -0
- package/dist/esm/models/SheetType.d.ts +23 -0
- package/dist/esm/models/SheetType.js +32 -0
- package/dist/esm/models/TriggerIngestRequest.d.ts +32 -0
- package/dist/esm/models/TriggerIngestRequest.js +44 -0
- package/dist/esm/models/index.d.ts +14 -0
- package/dist/esm/models/index.js +14 -0
- package/dist/models/ColumnDataType.d.ts +30 -0
- package/dist/models/ColumnDataType.js +45 -0
- package/dist/models/ColumnDef.d.ts +51 -0
- package/dist/models/ColumnDef.js +61 -0
- package/dist/models/CreateSheetRequest.d.ts +70 -0
- package/dist/models/CreateSheetRequest.js +70 -0
- package/dist/models/CreateSheetRequestFileDef.d.ts +38 -0
- package/dist/models/CreateSheetRequestFileDef.js +54 -0
- package/dist/models/DatasetDetail.d.ts +6 -0
- package/dist/models/DatasetDetail.js +2 -0
- package/dist/models/FeatureFlags.d.ts +6 -0
- package/dist/models/FeatureFlags.js +3 -0
- package/dist/models/FileDef.d.ts +38 -0
- package/dist/models/FileDef.js +54 -0
- package/dist/models/FileType.d.ts +24 -0
- package/dist/models/FileType.js +39 -0
- package/dist/models/ForeignKeyRef.d.ts +37 -0
- package/dist/models/ForeignKeyRef.js +53 -0
- package/dist/models/Permission.d.ts +4 -0
- package/dist/models/Permission.js +4 -0
- package/dist/models/ProjectSettings.d.ts +6 -0
- package/dist/models/ProjectSettings.js +2 -0
- package/dist/models/Sheet.d.ts +88 -0
- package/dist/models/Sheet.js +80 -0
- package/dist/models/SheetDetail.d.ts +107 -0
- package/dist/models/SheetDetail.js +90 -0
- package/dist/models/SheetJob.d.ts +93 -0
- package/dist/models/SheetJob.js +78 -0
- package/dist/models/SheetJobType.d.ts +25 -0
- package/dist/models/SheetJobType.js +40 -0
- package/dist/models/SheetTableType.d.ts +25 -0
- package/dist/models/SheetTableType.js +40 -0
- package/dist/models/SheetType.d.ts +23 -0
- package/dist/models/SheetType.js +38 -0
- package/dist/models/TriggerIngestRequest.d.ts +32 -0
- package/dist/models/TriggerIngestRequest.js +51 -0
- package/dist/models/index.d.ts +14 -0
- package/dist/models/index.js +14 -0
- package/package.json +1 -1
|
@@ -0,0 +1,272 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Cirro Data
|
|
5
|
+
* Cirro Data Platform service API
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: latest
|
|
8
|
+
* Contact: support@cirro.bio
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
15
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
16
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
17
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
18
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
19
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
20
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
21
|
+
});
|
|
22
|
+
};
|
|
23
|
+
import * as runtime from '../runtime';
|
|
24
|
+
import { CreateResponseFromJSON, CreateSheetRequestToJSON, SheetFromJSON, SheetDetailFromJSON, SheetJobFromJSON, TriggerIngestRequestToJSON, } from '../models/index';
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
*/
|
|
28
|
+
export class SheetsApi extends runtime.BaseAPI {
|
|
29
|
+
/**
|
|
30
|
+
* Creates a sheet
|
|
31
|
+
* Create sheet
|
|
32
|
+
*/
|
|
33
|
+
createSheetRaw(requestParameters, initOverrides) {
|
|
34
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
35
|
+
if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
|
|
36
|
+
throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling createSheet.');
|
|
37
|
+
}
|
|
38
|
+
if (requestParameters.createSheetRequest === null || requestParameters.createSheetRequest === undefined) {
|
|
39
|
+
throw new runtime.RequiredError('createSheetRequest', 'Required parameter requestParameters.createSheetRequest was null or undefined when calling createSheet.');
|
|
40
|
+
}
|
|
41
|
+
const queryParameters = {};
|
|
42
|
+
const headerParameters = {};
|
|
43
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
44
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
45
|
+
const token = this.configuration.accessToken;
|
|
46
|
+
const tokenString = yield token("accessToken", []);
|
|
47
|
+
if (tokenString) {
|
|
48
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
const response = yield this.request({
|
|
52
|
+
path: `/projects/{projectId}/sheets`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
|
|
53
|
+
method: 'POST',
|
|
54
|
+
headers: headerParameters,
|
|
55
|
+
query: queryParameters,
|
|
56
|
+
body: CreateSheetRequestToJSON(requestParameters.createSheetRequest),
|
|
57
|
+
}, initOverrides);
|
|
58
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CreateResponseFromJSON(jsonValue));
|
|
59
|
+
});
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Creates a sheet
|
|
63
|
+
* Create sheet
|
|
64
|
+
*/
|
|
65
|
+
createSheet(requestParameters, initOverrides) {
|
|
66
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
67
|
+
const response = yield this.createSheetRaw(requestParameters, initOverrides);
|
|
68
|
+
return yield response.value();
|
|
69
|
+
});
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* Deletes a sheet
|
|
73
|
+
* Delete sheet
|
|
74
|
+
*/
|
|
75
|
+
deleteSheetRaw(requestParameters, initOverrides) {
|
|
76
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
77
|
+
if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
|
|
78
|
+
throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling deleteSheet.');
|
|
79
|
+
}
|
|
80
|
+
if (requestParameters.sheetId === null || requestParameters.sheetId === undefined) {
|
|
81
|
+
throw new runtime.RequiredError('sheetId', 'Required parameter requestParameters.sheetId was null or undefined when calling deleteSheet.');
|
|
82
|
+
}
|
|
83
|
+
const queryParameters = {};
|
|
84
|
+
const headerParameters = {};
|
|
85
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
86
|
+
const token = this.configuration.accessToken;
|
|
87
|
+
const tokenString = yield token("accessToken", []);
|
|
88
|
+
if (tokenString) {
|
|
89
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
const response = yield this.request({
|
|
93
|
+
path: `/projects/{projectId}/sheets/{sheetId}`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"sheetId"}}`, encodeURIComponent(String(requestParameters.sheetId))),
|
|
94
|
+
method: 'DELETE',
|
|
95
|
+
headers: headerParameters,
|
|
96
|
+
query: queryParameters,
|
|
97
|
+
}, initOverrides);
|
|
98
|
+
return new runtime.VoidApiResponse(response);
|
|
99
|
+
});
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* Deletes a sheet
|
|
103
|
+
* Delete sheet
|
|
104
|
+
*/
|
|
105
|
+
deleteSheet(requestParameters, initOverrides) {
|
|
106
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
107
|
+
yield this.deleteSheetRaw(requestParameters, initOverrides);
|
|
108
|
+
});
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* Retrieves ingest jobs for a sheet
|
|
112
|
+
* List jobs
|
|
113
|
+
*/
|
|
114
|
+
getJobsRaw(requestParameters, initOverrides) {
|
|
115
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
116
|
+
if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
|
|
117
|
+
throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling getJobs.');
|
|
118
|
+
}
|
|
119
|
+
if (requestParameters.sheetId === null || requestParameters.sheetId === undefined) {
|
|
120
|
+
throw new runtime.RequiredError('sheetId', 'Required parameter requestParameters.sheetId was null or undefined when calling getJobs.');
|
|
121
|
+
}
|
|
122
|
+
const queryParameters = {};
|
|
123
|
+
const headerParameters = {};
|
|
124
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
125
|
+
const token = this.configuration.accessToken;
|
|
126
|
+
const tokenString = yield token("accessToken", []);
|
|
127
|
+
if (tokenString) {
|
|
128
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
const response = yield this.request({
|
|
132
|
+
path: `/projects/{projectId}/sheets/{sheetId}/jobs`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"sheetId"}}`, encodeURIComponent(String(requestParameters.sheetId))),
|
|
133
|
+
method: 'GET',
|
|
134
|
+
headers: headerParameters,
|
|
135
|
+
query: queryParameters,
|
|
136
|
+
}, initOverrides);
|
|
137
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(SheetJobFromJSON));
|
|
138
|
+
});
|
|
139
|
+
}
|
|
140
|
+
/**
|
|
141
|
+
* Retrieves ingest jobs for a sheet
|
|
142
|
+
* List jobs
|
|
143
|
+
*/
|
|
144
|
+
getJobs(requestParameters, initOverrides) {
|
|
145
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
146
|
+
const response = yield this.getJobsRaw(requestParameters, initOverrides);
|
|
147
|
+
return yield response.value();
|
|
148
|
+
});
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* Retrieves a sheet
|
|
152
|
+
* Get sheet
|
|
153
|
+
*/
|
|
154
|
+
getSheetRaw(requestParameters, initOverrides) {
|
|
155
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
156
|
+
if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
|
|
157
|
+
throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling getSheet.');
|
|
158
|
+
}
|
|
159
|
+
if (requestParameters.sheetId === null || requestParameters.sheetId === undefined) {
|
|
160
|
+
throw new runtime.RequiredError('sheetId', 'Required parameter requestParameters.sheetId was null or undefined when calling getSheet.');
|
|
161
|
+
}
|
|
162
|
+
const queryParameters = {};
|
|
163
|
+
const headerParameters = {};
|
|
164
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
165
|
+
const token = this.configuration.accessToken;
|
|
166
|
+
const tokenString = yield token("accessToken", []);
|
|
167
|
+
if (tokenString) {
|
|
168
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
const response = yield this.request({
|
|
172
|
+
path: `/projects/{projectId}/sheets/{sheetId}`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"sheetId"}}`, encodeURIComponent(String(requestParameters.sheetId))),
|
|
173
|
+
method: 'GET',
|
|
174
|
+
headers: headerParameters,
|
|
175
|
+
query: queryParameters,
|
|
176
|
+
}, initOverrides);
|
|
177
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => SheetDetailFromJSON(jsonValue));
|
|
178
|
+
});
|
|
179
|
+
}
|
|
180
|
+
/**
|
|
181
|
+
* Retrieves a sheet
|
|
182
|
+
* Get sheet
|
|
183
|
+
*/
|
|
184
|
+
getSheet(requestParameters, initOverrides) {
|
|
185
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
186
|
+
const response = yield this.getSheetRaw(requestParameters, initOverrides);
|
|
187
|
+
return yield response.value();
|
|
188
|
+
});
|
|
189
|
+
}
|
|
190
|
+
/**
|
|
191
|
+
* Retrieves sheets for a project
|
|
192
|
+
* List sheets
|
|
193
|
+
*/
|
|
194
|
+
getSheetsRaw(requestParameters, initOverrides) {
|
|
195
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
196
|
+
if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
|
|
197
|
+
throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling getSheets.');
|
|
198
|
+
}
|
|
199
|
+
const queryParameters = {};
|
|
200
|
+
const headerParameters = {};
|
|
201
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
202
|
+
const token = this.configuration.accessToken;
|
|
203
|
+
const tokenString = yield token("accessToken", []);
|
|
204
|
+
if (tokenString) {
|
|
205
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
206
|
+
}
|
|
207
|
+
}
|
|
208
|
+
const response = yield this.request({
|
|
209
|
+
path: `/projects/{projectId}/sheets`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
|
|
210
|
+
method: 'GET',
|
|
211
|
+
headers: headerParameters,
|
|
212
|
+
query: queryParameters,
|
|
213
|
+
}, initOverrides);
|
|
214
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(SheetFromJSON));
|
|
215
|
+
});
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
* Retrieves sheets for a project
|
|
219
|
+
* List sheets
|
|
220
|
+
*/
|
|
221
|
+
getSheets(requestParameters, initOverrides) {
|
|
222
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
223
|
+
const response = yield this.getSheetsRaw(requestParameters, initOverrides);
|
|
224
|
+
return yield response.value();
|
|
225
|
+
});
|
|
226
|
+
}
|
|
227
|
+
/**
|
|
228
|
+
* Triggers an async file ingest into the sheet
|
|
229
|
+
* Trigger ingest
|
|
230
|
+
*/
|
|
231
|
+
triggerIngestRaw(requestParameters, initOverrides) {
|
|
232
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
233
|
+
if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
|
|
234
|
+
throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling triggerIngest.');
|
|
235
|
+
}
|
|
236
|
+
if (requestParameters.sheetId === null || requestParameters.sheetId === undefined) {
|
|
237
|
+
throw new runtime.RequiredError('sheetId', 'Required parameter requestParameters.sheetId was null or undefined when calling triggerIngest.');
|
|
238
|
+
}
|
|
239
|
+
if (requestParameters.triggerIngestRequest === null || requestParameters.triggerIngestRequest === undefined) {
|
|
240
|
+
throw new runtime.RequiredError('triggerIngestRequest', 'Required parameter requestParameters.triggerIngestRequest was null or undefined when calling triggerIngest.');
|
|
241
|
+
}
|
|
242
|
+
const queryParameters = {};
|
|
243
|
+
const headerParameters = {};
|
|
244
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
245
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
246
|
+
const token = this.configuration.accessToken;
|
|
247
|
+
const tokenString = yield token("accessToken", []);
|
|
248
|
+
if (tokenString) {
|
|
249
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
250
|
+
}
|
|
251
|
+
}
|
|
252
|
+
const response = yield this.request({
|
|
253
|
+
path: `/projects/{projectId}/sheets/{sheetId}/ingest`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"sheetId"}}`, encodeURIComponent(String(requestParameters.sheetId))),
|
|
254
|
+
method: 'POST',
|
|
255
|
+
headers: headerParameters,
|
|
256
|
+
query: queryParameters,
|
|
257
|
+
body: TriggerIngestRequestToJSON(requestParameters.triggerIngestRequest),
|
|
258
|
+
}, initOverrides);
|
|
259
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CreateResponseFromJSON(jsonValue));
|
|
260
|
+
});
|
|
261
|
+
}
|
|
262
|
+
/**
|
|
263
|
+
* Triggers an async file ingest into the sheet
|
|
264
|
+
* Trigger ingest
|
|
265
|
+
*/
|
|
266
|
+
triggerIngest(requestParameters, initOverrides) {
|
|
267
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
268
|
+
const response = yield this.triggerIngestRaw(requestParameters, initOverrides);
|
|
269
|
+
return yield response.value();
|
|
270
|
+
});
|
|
271
|
+
}
|
|
272
|
+
}
|
package/dist/esm/apis/index.d.ts
CHANGED
|
@@ -16,6 +16,7 @@ export * from './ProjectRequestsApi';
|
|
|
16
16
|
export * from './ProjectsApi';
|
|
17
17
|
export * from './ReferencesApi';
|
|
18
18
|
export * from './SharingApi';
|
|
19
|
+
export * from './SheetsApi';
|
|
19
20
|
export * from './SystemApi';
|
|
20
21
|
export * from './ToolsApi';
|
|
21
22
|
export * from './UsersApi';
|
package/dist/esm/apis/index.js
CHANGED
|
@@ -18,6 +18,7 @@ export * from './ProjectRequestsApi';
|
|
|
18
18
|
export * from './ProjectsApi';
|
|
19
19
|
export * from './ReferencesApi';
|
|
20
20
|
export * from './SharingApi';
|
|
21
|
+
export * from './SheetsApi';
|
|
21
22
|
export * from './SystemApi';
|
|
22
23
|
export * from './ToolsApi';
|
|
23
24
|
export * from './UsersApi';
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Cirro Data
|
|
3
|
+
* Cirro Data Platform service API
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: latest
|
|
6
|
+
* Contact: support@cirro.bio
|
|
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
|
+
* @enum {string}
|
|
16
|
+
*/
|
|
17
|
+
export declare enum ColumnDataType {
|
|
18
|
+
String = "STRING",
|
|
19
|
+
Integer = "INTEGER",
|
|
20
|
+
Bigint = "BIGINT",
|
|
21
|
+
Float = "FLOAT",
|
|
22
|
+
Double = "DOUBLE",
|
|
23
|
+
Boolean = "BOOLEAN",
|
|
24
|
+
Date = "DATE",
|
|
25
|
+
Timestamp = "TIMESTAMP",
|
|
26
|
+
Blob = "BLOB"
|
|
27
|
+
}
|
|
28
|
+
export declare function ColumnDataTypeFromJSON(json: any): ColumnDataType;
|
|
29
|
+
export declare function ColumnDataTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ColumnDataType;
|
|
30
|
+
export declare function ColumnDataTypeToJSON(value?: ColumnDataType | null): any;
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Cirro Data
|
|
5
|
+
* Cirro Data Platform service API
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: latest
|
|
8
|
+
* Contact: support@cirro.bio
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
*
|
|
16
|
+
* @export
|
|
17
|
+
* @enum {string}
|
|
18
|
+
*/
|
|
19
|
+
export var ColumnDataType;
|
|
20
|
+
(function (ColumnDataType) {
|
|
21
|
+
ColumnDataType["String"] = "STRING";
|
|
22
|
+
ColumnDataType["Integer"] = "INTEGER";
|
|
23
|
+
ColumnDataType["Bigint"] = "BIGINT";
|
|
24
|
+
ColumnDataType["Float"] = "FLOAT";
|
|
25
|
+
ColumnDataType["Double"] = "DOUBLE";
|
|
26
|
+
ColumnDataType["Boolean"] = "BOOLEAN";
|
|
27
|
+
ColumnDataType["Date"] = "DATE";
|
|
28
|
+
ColumnDataType["Timestamp"] = "TIMESTAMP";
|
|
29
|
+
ColumnDataType["Blob"] = "BLOB";
|
|
30
|
+
})(ColumnDataType || (ColumnDataType = {}));
|
|
31
|
+
export function ColumnDataTypeFromJSON(json) {
|
|
32
|
+
return ColumnDataTypeFromJSONTyped(json, false);
|
|
33
|
+
}
|
|
34
|
+
export function ColumnDataTypeFromJSONTyped(json, ignoreDiscriminator) {
|
|
35
|
+
return json;
|
|
36
|
+
}
|
|
37
|
+
export function ColumnDataTypeToJSON(value) {
|
|
38
|
+
return value;
|
|
39
|
+
}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Cirro Data
|
|
3
|
+
* Cirro Data Platform service API
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: latest
|
|
6
|
+
* Contact: support@cirro.bio
|
|
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
|
+
import type { ColumnDataType } from './ColumnDataType';
|
|
13
|
+
import type { ForeignKeyRef } from './ForeignKeyRef';
|
|
14
|
+
/**
|
|
15
|
+
*
|
|
16
|
+
* @export
|
|
17
|
+
* @interface ColumnDef
|
|
18
|
+
*/
|
|
19
|
+
export interface ColumnDef {
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @type {string}
|
|
23
|
+
* @memberof ColumnDef
|
|
24
|
+
*/
|
|
25
|
+
name: string;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {ColumnDataType}
|
|
29
|
+
* @memberof ColumnDef
|
|
30
|
+
*/
|
|
31
|
+
dataType: ColumnDataType;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof ColumnDef
|
|
36
|
+
*/
|
|
37
|
+
description: string;
|
|
38
|
+
/**
|
|
39
|
+
*
|
|
40
|
+
* @type {ForeignKeyRef}
|
|
41
|
+
* @memberof ColumnDef
|
|
42
|
+
*/
|
|
43
|
+
foreignKey?: ForeignKeyRef | null;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Check if a given object implements the ColumnDef interface.
|
|
47
|
+
*/
|
|
48
|
+
export declare function instanceOfColumnDef(value: object): boolean;
|
|
49
|
+
export declare function ColumnDefFromJSON(json: any): ColumnDef;
|
|
50
|
+
export declare function ColumnDefFromJSONTyped(json: any, ignoreDiscriminator: boolean): ColumnDef;
|
|
51
|
+
export declare function ColumnDefToJSON(value?: ColumnDef | null): any;
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Cirro Data
|
|
5
|
+
* Cirro Data Platform service API
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: latest
|
|
8
|
+
* Contact: support@cirro.bio
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { exists } from '../runtime';
|
|
15
|
+
import { ColumnDataTypeFromJSON, ColumnDataTypeToJSON, } from './ColumnDataType';
|
|
16
|
+
import { ForeignKeyRefFromJSON, ForeignKeyRefToJSON, } from './ForeignKeyRef';
|
|
17
|
+
/**
|
|
18
|
+
* Check if a given object implements the ColumnDef interface.
|
|
19
|
+
*/
|
|
20
|
+
export function instanceOfColumnDef(value) {
|
|
21
|
+
let isInstance = true;
|
|
22
|
+
isInstance = isInstance && "name" in value;
|
|
23
|
+
isInstance = isInstance && "dataType" in value;
|
|
24
|
+
isInstance = isInstance && "description" in value;
|
|
25
|
+
return isInstance;
|
|
26
|
+
}
|
|
27
|
+
export function ColumnDefFromJSON(json) {
|
|
28
|
+
return ColumnDefFromJSONTyped(json, false);
|
|
29
|
+
}
|
|
30
|
+
export function ColumnDefFromJSONTyped(json, ignoreDiscriminator) {
|
|
31
|
+
if ((json === undefined) || (json === null)) {
|
|
32
|
+
return json;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
'name': json['name'],
|
|
36
|
+
'dataType': ColumnDataTypeFromJSON(json['dataType']),
|
|
37
|
+
'description': json['description'],
|
|
38
|
+
'foreignKey': !exists(json, 'foreignKey') ? undefined : ForeignKeyRefFromJSON(json['foreignKey']),
|
|
39
|
+
};
|
|
40
|
+
}
|
|
41
|
+
export function ColumnDefToJSON(value) {
|
|
42
|
+
if (value === undefined) {
|
|
43
|
+
return undefined;
|
|
44
|
+
}
|
|
45
|
+
if (value === null) {
|
|
46
|
+
return null;
|
|
47
|
+
}
|
|
48
|
+
return {
|
|
49
|
+
'name': value.name,
|
|
50
|
+
'dataType': ColumnDataTypeToJSON(value.dataType),
|
|
51
|
+
'description': value.description,
|
|
52
|
+
'foreignKey': ForeignKeyRefToJSON(value.foreignKey),
|
|
53
|
+
};
|
|
54
|
+
}
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Cirro Data
|
|
3
|
+
* Cirro Data Platform service API
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: latest
|
|
6
|
+
* Contact: support@cirro.bio
|
|
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
|
+
import type { ColumnDef } from './ColumnDef';
|
|
13
|
+
import type { CreateSheetRequestFileDef } from './CreateSheetRequestFileDef';
|
|
14
|
+
import type { SheetTableType } from './SheetTableType';
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
* @interface CreateSheetRequest
|
|
19
|
+
*/
|
|
20
|
+
export interface CreateSheetRequest {
|
|
21
|
+
/**
|
|
22
|
+
* Display name for the sheet
|
|
23
|
+
* @type {string}
|
|
24
|
+
* @memberof CreateSheetRequest
|
|
25
|
+
*/
|
|
26
|
+
name: string;
|
|
27
|
+
/**
|
|
28
|
+
* Optional description of the sheet's purpose or contents
|
|
29
|
+
* @type {string}
|
|
30
|
+
* @memberof CreateSheetRequest
|
|
31
|
+
*/
|
|
32
|
+
description?: string;
|
|
33
|
+
/**
|
|
34
|
+
* S3 Tables namespace for the Iceberg table
|
|
35
|
+
* @type {string}
|
|
36
|
+
* @memberof CreateSheetRequest
|
|
37
|
+
*/
|
|
38
|
+
namespaceName: string;
|
|
39
|
+
/**
|
|
40
|
+
* Name of the Iceberg table within the namespace
|
|
41
|
+
* @type {string}
|
|
42
|
+
* @memberof CreateSheetRequest
|
|
43
|
+
*/
|
|
44
|
+
tableName: string;
|
|
45
|
+
/**
|
|
46
|
+
*
|
|
47
|
+
* @type {SheetTableType}
|
|
48
|
+
* @memberof CreateSheetRequest
|
|
49
|
+
*/
|
|
50
|
+
tableType: SheetTableType;
|
|
51
|
+
/**
|
|
52
|
+
* Column definitions for the table schema
|
|
53
|
+
* @type {Array<ColumnDef>}
|
|
54
|
+
* @memberof CreateSheetRequest
|
|
55
|
+
*/
|
|
56
|
+
columns: Array<ColumnDef>;
|
|
57
|
+
/**
|
|
58
|
+
*
|
|
59
|
+
* @type {CreateSheetRequestFileDef}
|
|
60
|
+
* @memberof CreateSheetRequest
|
|
61
|
+
*/
|
|
62
|
+
fileDef?: CreateSheetRequestFileDef | null;
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* Check if a given object implements the CreateSheetRequest interface.
|
|
66
|
+
*/
|
|
67
|
+
export declare function instanceOfCreateSheetRequest(value: object): boolean;
|
|
68
|
+
export declare function CreateSheetRequestFromJSON(json: any): CreateSheetRequest;
|
|
69
|
+
export declare function CreateSheetRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSheetRequest;
|
|
70
|
+
export declare function CreateSheetRequestToJSON(value?: CreateSheetRequest | null): any;
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Cirro Data
|
|
5
|
+
* Cirro Data Platform service API
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: latest
|
|
8
|
+
* Contact: support@cirro.bio
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { exists } from '../runtime';
|
|
15
|
+
import { ColumnDefFromJSON, ColumnDefToJSON, } from './ColumnDef';
|
|
16
|
+
import { CreateSheetRequestFileDefFromJSON, CreateSheetRequestFileDefToJSON, } from './CreateSheetRequestFileDef';
|
|
17
|
+
import { SheetTableTypeFromJSON, SheetTableTypeToJSON, } from './SheetTableType';
|
|
18
|
+
/**
|
|
19
|
+
* Check if a given object implements the CreateSheetRequest interface.
|
|
20
|
+
*/
|
|
21
|
+
export function instanceOfCreateSheetRequest(value) {
|
|
22
|
+
let isInstance = true;
|
|
23
|
+
isInstance = isInstance && "name" in value;
|
|
24
|
+
isInstance = isInstance && "namespaceName" in value;
|
|
25
|
+
isInstance = isInstance && "tableName" in value;
|
|
26
|
+
isInstance = isInstance && "tableType" in value;
|
|
27
|
+
isInstance = isInstance && "columns" in value;
|
|
28
|
+
return isInstance;
|
|
29
|
+
}
|
|
30
|
+
export function CreateSheetRequestFromJSON(json) {
|
|
31
|
+
return CreateSheetRequestFromJSONTyped(json, false);
|
|
32
|
+
}
|
|
33
|
+
export function CreateSheetRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
34
|
+
if ((json === undefined) || (json === null)) {
|
|
35
|
+
return json;
|
|
36
|
+
}
|
|
37
|
+
return {
|
|
38
|
+
'name': json['name'],
|
|
39
|
+
'description': !exists(json, 'description') ? undefined : json['description'],
|
|
40
|
+
'namespaceName': json['namespaceName'],
|
|
41
|
+
'tableName': json['tableName'],
|
|
42
|
+
'tableType': SheetTableTypeFromJSON(json['tableType']),
|
|
43
|
+
'columns': (json['columns'].map(ColumnDefFromJSON)),
|
|
44
|
+
'fileDef': !exists(json, 'fileDef') ? undefined : CreateSheetRequestFileDefFromJSON(json['fileDef']),
|
|
45
|
+
};
|
|
46
|
+
}
|
|
47
|
+
export function CreateSheetRequestToJSON(value) {
|
|
48
|
+
if (value === undefined) {
|
|
49
|
+
return undefined;
|
|
50
|
+
}
|
|
51
|
+
if (value === null) {
|
|
52
|
+
return null;
|
|
53
|
+
}
|
|
54
|
+
return {
|
|
55
|
+
'name': value.name,
|
|
56
|
+
'description': value.description,
|
|
57
|
+
'namespaceName': value.namespaceName,
|
|
58
|
+
'tableName': value.tableName,
|
|
59
|
+
'tableType': SheetTableTypeToJSON(value.tableType),
|
|
60
|
+
'columns': (value.columns.map(ColumnDefToJSON)),
|
|
61
|
+
'fileDef': CreateSheetRequestFileDefToJSON(value.fileDef),
|
|
62
|
+
};
|
|
63
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Cirro Data
|
|
3
|
+
* Cirro Data Platform service API
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: latest
|
|
6
|
+
* Contact: support@cirro.bio
|
|
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
|
+
import type { FileType } from './FileType';
|
|
13
|
+
/**
|
|
14
|
+
* If provided, an ingest job is triggered immediately after table creation
|
|
15
|
+
* @export
|
|
16
|
+
* @interface CreateSheetRequestFileDef
|
|
17
|
+
*/
|
|
18
|
+
export interface CreateSheetRequestFileDef {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {FileType}
|
|
22
|
+
* @memberof CreateSheetRequestFileDef
|
|
23
|
+
*/
|
|
24
|
+
fileType: FileType;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof CreateSheetRequestFileDef
|
|
29
|
+
*/
|
|
30
|
+
storageUri: string;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Check if a given object implements the CreateSheetRequestFileDef interface.
|
|
34
|
+
*/
|
|
35
|
+
export declare function instanceOfCreateSheetRequestFileDef(value: object): boolean;
|
|
36
|
+
export declare function CreateSheetRequestFileDefFromJSON(json: any): CreateSheetRequestFileDef;
|
|
37
|
+
export declare function CreateSheetRequestFileDefFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSheetRequestFileDef;
|
|
38
|
+
export declare function CreateSheetRequestFileDefToJSON(value?: CreateSheetRequestFileDef | null): any;
|