@vertexvis/api-client-node 0.24.0 → 0.30.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/dist/cjs/api.d.ts +1308 -111
- package/dist/cjs/api.js +1030 -142
- package/dist/cjs/client/version.d.ts +1 -1
- package/dist/cjs/client/version.js +1 -1
- package/dist/esm/api.d.ts +1308 -111
- package/dist/esm/api.js +1015 -136
- package/dist/esm/client/version.d.ts +1 -1
- package/dist/esm/client/version.js +1 -1
- package/package.json +3 -2
package/dist/esm/api.js
CHANGED
|
@@ -57,6 +57,17 @@ export const ClearRepOpTypeEnum = {
|
|
|
57
57
|
export const ClearTransformOpTypeEnum = {
|
|
58
58
|
ClearTransform: 'clear-transform',
|
|
59
59
|
};
|
|
60
|
+
export const CreateFileCollectionRequestDataTypeEnum = {
|
|
61
|
+
FileCollection: 'file-collection',
|
|
62
|
+
};
|
|
63
|
+
export const CreateFileJobRequestDataTypeEnum = {
|
|
64
|
+
FileJob: 'file-job',
|
|
65
|
+
};
|
|
66
|
+
export const CreateSceneItemRequestDataAttributesResolutionRuleEnum = {
|
|
67
|
+
AsSpecified: 'as-specified',
|
|
68
|
+
LatestIteration: 'latest-iteration',
|
|
69
|
+
LatestRevision: 'latest-revision',
|
|
70
|
+
};
|
|
60
71
|
export const DeselectOperationTypeEnum = {
|
|
61
72
|
Deselect: 'deselect',
|
|
62
73
|
};
|
|
@@ -66,6 +77,12 @@ export const ExportRelationshipDataTypeEnum = {
|
|
|
66
77
|
export const ExportStateRelationshipDataTypeEnum = {
|
|
67
78
|
SceneViewState: 'scene-view-state',
|
|
68
79
|
};
|
|
80
|
+
export const FileCollectionMetadataDataTypeEnum = {
|
|
81
|
+
FileCollection: 'file-collection',
|
|
82
|
+
};
|
|
83
|
+
export const FileJobArchiveOperationTypeEnum = {
|
|
84
|
+
FileArchiveOperation: 'file-archive-operation',
|
|
85
|
+
};
|
|
69
86
|
export const FileRelationshipDataTypeEnum = {
|
|
70
87
|
File: 'file',
|
|
71
88
|
};
|
|
@@ -121,6 +138,9 @@ export const QueryByIdDataAttributesTypeEnum = {
|
|
|
121
138
|
Id: 'id',
|
|
122
139
|
SuppliedId: 'suppliedId',
|
|
123
140
|
};
|
|
141
|
+
export const QueryByMetadataDataTypeEnum = {
|
|
142
|
+
QueryByMetadata: 'query-by-metadata',
|
|
143
|
+
};
|
|
124
144
|
export const SceneItemRelationshipDataTypeEnum = {
|
|
125
145
|
SceneItem: 'scene-item',
|
|
126
146
|
};
|
|
@@ -133,6 +153,12 @@ export const SceneViewRelationshipDataTypeEnum = {
|
|
|
133
153
|
export const SceneViewStateRelationshipDataTypeEnum = {
|
|
134
154
|
SceneViewState: 'scene-view-state',
|
|
135
155
|
};
|
|
156
|
+
export const SelectFileByIdTypeEnum = {
|
|
157
|
+
FileById: 'file-by-id',
|
|
158
|
+
};
|
|
159
|
+
export const SelectFileBySuppliedIdTypeEnum = {
|
|
160
|
+
FileBySuppliedId: 'file-by-supplied-id',
|
|
161
|
+
};
|
|
136
162
|
export const SelectOpTypeEnum = {
|
|
137
163
|
Select: 'select',
|
|
138
164
|
};
|
|
@@ -140,6 +166,9 @@ export const UpdateAccountRequestDataAttributesStatusEnum = {
|
|
|
140
166
|
Active: 'active',
|
|
141
167
|
Disabled: 'disabled',
|
|
142
168
|
};
|
|
169
|
+
export const UpdateFileCollectionRequestDataTypeEnum = {
|
|
170
|
+
FileCollection: 'file-collection',
|
|
171
|
+
};
|
|
143
172
|
export const UpdateItemToDefaultRenditionOperationTypeEnum = {
|
|
144
173
|
UpdateToDefaultRendition: 'update-to-default-rendition',
|
|
145
174
|
};
|
|
@@ -1412,22 +1441,25 @@ export class ExportsApi extends BaseAPI {
|
|
|
1412
1441
|
}
|
|
1413
1442
|
}
|
|
1414
1443
|
/**
|
|
1415
|
-
*
|
|
1444
|
+
* FileCollectionsApi - axios parameter creator
|
|
1416
1445
|
* @export
|
|
1417
1446
|
*/
|
|
1418
|
-
export const
|
|
1447
|
+
export const FileCollectionsApiAxiosParamCreator = function (configuration) {
|
|
1419
1448
|
return {
|
|
1420
1449
|
/**
|
|
1421
|
-
*
|
|
1422
|
-
* @param {
|
|
1450
|
+
* Add files to a `file-collection`.
|
|
1451
|
+
* @param {string} id The `file-collection` ID.
|
|
1452
|
+
* @param {FileIdList} fileIdList
|
|
1423
1453
|
* @param {*} [options] Override http request option.
|
|
1424
1454
|
* @throws {RequiredError}
|
|
1425
1455
|
*/
|
|
1426
|
-
|
|
1456
|
+
addFileCollectionFiles: (id, fileIdList, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1427
1457
|
var _a;
|
|
1428
|
-
// verify required parameter '
|
|
1429
|
-
assertParamExists('
|
|
1430
|
-
|
|
1458
|
+
// verify required parameter 'id' is not null or undefined
|
|
1459
|
+
assertParamExists('addFileCollectionFiles', 'id', id);
|
|
1460
|
+
// verify required parameter 'fileIdList' is not null or undefined
|
|
1461
|
+
assertParamExists('addFileCollectionFiles', 'fileIdList', fileIdList);
|
|
1462
|
+
const localVarPath = `/file-collections/{id}/files`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
1431
1463
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1432
1464
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1433
1465
|
let baseOptions;
|
|
@@ -1444,61 +1476,63 @@ export const FilesApiAxiosParamCreator = function (configuration) {
|
|
|
1444
1476
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1445
1477
|
let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
|
|
1446
1478
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1447
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
1479
|
+
localVarRequestOptions.data = serializeDataIfNeeded(fileIdList, localVarRequestOptions, configuration);
|
|
1448
1480
|
return {
|
|
1449
1481
|
url: toPathString(localVarUrlObj),
|
|
1450
1482
|
options: localVarRequestOptions,
|
|
1451
1483
|
};
|
|
1452
1484
|
}),
|
|
1453
1485
|
/**
|
|
1454
|
-
*
|
|
1455
|
-
* @param {
|
|
1486
|
+
* Create a `file-collection`.
|
|
1487
|
+
* @param {CreateFileCollectionRequest} createFileCollectionRequest
|
|
1456
1488
|
* @param {*} [options] Override http request option.
|
|
1457
1489
|
* @throws {RequiredError}
|
|
1458
1490
|
*/
|
|
1459
|
-
|
|
1491
|
+
createFileCollection: (createFileCollectionRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1460
1492
|
var _b;
|
|
1461
|
-
// verify required parameter '
|
|
1462
|
-
assertParamExists('
|
|
1463
|
-
const localVarPath = `/
|
|
1493
|
+
// verify required parameter 'createFileCollectionRequest' is not null or undefined
|
|
1494
|
+
assertParamExists('createFileCollection', 'createFileCollectionRequest', createFileCollectionRequest);
|
|
1495
|
+
const localVarPath = `/file-collections`;
|
|
1464
1496
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1465
1497
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1466
1498
|
let baseOptions;
|
|
1467
1499
|
if (configuration) {
|
|
1468
1500
|
baseOptions = configuration.baseOptions;
|
|
1469
1501
|
}
|
|
1470
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
1502
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
1471
1503
|
const localVarHeaderParameter = {};
|
|
1472
1504
|
const localVarQueryParameter = {};
|
|
1473
1505
|
// authentication OAuth2 required
|
|
1474
1506
|
// oauth required
|
|
1475
1507
|
yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
1508
|
+
localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
|
|
1476
1509
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1477
1510
|
let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
|
|
1478
1511
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1512
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createFileCollectionRequest, localVarRequestOptions, configuration);
|
|
1479
1513
|
return {
|
|
1480
1514
|
url: toPathString(localVarUrlObj),
|
|
1481
1515
|
options: localVarRequestOptions,
|
|
1482
1516
|
};
|
|
1483
1517
|
}),
|
|
1484
1518
|
/**
|
|
1485
|
-
*
|
|
1486
|
-
* @param {string} id The `file` ID.
|
|
1519
|
+
* Delete a `file-collection`.
|
|
1520
|
+
* @param {string} id The `file-collection` ID.
|
|
1487
1521
|
* @param {*} [options] Override http request option.
|
|
1488
1522
|
* @throws {RequiredError}
|
|
1489
1523
|
*/
|
|
1490
|
-
|
|
1524
|
+
deleteFileCollection: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1491
1525
|
var _c;
|
|
1492
1526
|
// verify required parameter 'id' is not null or undefined
|
|
1493
|
-
assertParamExists('
|
|
1494
|
-
const localVarPath = `/
|
|
1527
|
+
assertParamExists('deleteFileCollection', 'id', id);
|
|
1528
|
+
const localVarPath = `/file-collections/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
1495
1529
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1496
1530
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1497
1531
|
let baseOptions;
|
|
1498
1532
|
if (configuration) {
|
|
1499
1533
|
baseOptions = configuration.baseOptions;
|
|
1500
1534
|
}
|
|
1501
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
1535
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
1502
1536
|
const localVarHeaderParameter = {};
|
|
1503
1537
|
const localVarQueryParameter = {};
|
|
1504
1538
|
// authentication OAuth2 required
|
|
@@ -1513,16 +1547,86 @@ export const FilesApiAxiosParamCreator = function (configuration) {
|
|
|
1513
1547
|
};
|
|
1514
1548
|
}),
|
|
1515
1549
|
/**
|
|
1516
|
-
* Get `
|
|
1550
|
+
* Get a `file-collection` by ID.
|
|
1551
|
+
* @param {string} id The `file-collection` ID.
|
|
1552
|
+
* @param {*} [options] Override http request option.
|
|
1553
|
+
* @throws {RequiredError}
|
|
1554
|
+
*/
|
|
1555
|
+
getFileCollection: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1556
|
+
var _d;
|
|
1557
|
+
// verify required parameter 'id' is not null or undefined
|
|
1558
|
+
assertParamExists('getFileCollection', 'id', id);
|
|
1559
|
+
const localVarPath = `/file-collections/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
1560
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1561
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1562
|
+
let baseOptions;
|
|
1563
|
+
if (configuration) {
|
|
1564
|
+
baseOptions = configuration.baseOptions;
|
|
1565
|
+
}
|
|
1566
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1567
|
+
const localVarHeaderParameter = {};
|
|
1568
|
+
const localVarQueryParameter = {};
|
|
1569
|
+
// authentication OAuth2 required
|
|
1570
|
+
// oauth required
|
|
1571
|
+
yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
1572
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1573
|
+
let headersFromBaseOptions = (_d = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _d !== void 0 ? _d : {};
|
|
1574
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1575
|
+
return {
|
|
1576
|
+
url: toPathString(localVarUrlObj),
|
|
1577
|
+
options: localVarRequestOptions,
|
|
1578
|
+
};
|
|
1579
|
+
}),
|
|
1580
|
+
/**
|
|
1581
|
+
* List the files in a `file-collection`.
|
|
1582
|
+
* @param {string} id The `file-collection` ID.
|
|
1583
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
1584
|
+
* @param {number} [pageSize] The number of items to return.
|
|
1585
|
+
* @param {*} [options] Override http request option.
|
|
1586
|
+
* @throws {RequiredError}
|
|
1587
|
+
*/
|
|
1588
|
+
listFileCollectionFiles: (id, pageCursor, pageSize, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1589
|
+
var _e;
|
|
1590
|
+
// verify required parameter 'id' is not null or undefined
|
|
1591
|
+
assertParamExists('listFileCollectionFiles', 'id', id);
|
|
1592
|
+
const localVarPath = `/file-collections/{id}/files`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
1593
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1594
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1595
|
+
let baseOptions;
|
|
1596
|
+
if (configuration) {
|
|
1597
|
+
baseOptions = configuration.baseOptions;
|
|
1598
|
+
}
|
|
1599
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1600
|
+
const localVarHeaderParameter = {};
|
|
1601
|
+
const localVarQueryParameter = {};
|
|
1602
|
+
// authentication OAuth2 required
|
|
1603
|
+
// oauth required
|
|
1604
|
+
yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
1605
|
+
if (pageCursor !== undefined) {
|
|
1606
|
+
localVarQueryParameter['page[cursor]'] = pageCursor;
|
|
1607
|
+
}
|
|
1608
|
+
if (pageSize !== undefined) {
|
|
1609
|
+
localVarQueryParameter['page[size]'] = pageSize;
|
|
1610
|
+
}
|
|
1611
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1612
|
+
let headersFromBaseOptions = (_e = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _e !== void 0 ? _e : {};
|
|
1613
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1614
|
+
return {
|
|
1615
|
+
url: toPathString(localVarUrlObj),
|
|
1616
|
+
options: localVarRequestOptions,
|
|
1617
|
+
};
|
|
1618
|
+
}),
|
|
1619
|
+
/**
|
|
1620
|
+
* List `file-collection`s by supplied ID.
|
|
1517
1621
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
1518
1622
|
* @param {number} [pageSize] The number of items to return.
|
|
1519
1623
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
1520
1624
|
* @param {*} [options] Override http request option.
|
|
1521
1625
|
* @throws {RequiredError}
|
|
1522
1626
|
*/
|
|
1523
|
-
|
|
1524
|
-
var
|
|
1525
|
-
const localVarPath = `/
|
|
1627
|
+
listFileCollections: (pageCursor, pageSize, filterSuppliedId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1628
|
+
var _f;
|
|
1629
|
+
const localVarPath = `/file-collections`;
|
|
1526
1630
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1527
1631
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1528
1632
|
let baseOptions;
|
|
@@ -1545,7 +1649,7 @@ export const FilesApiAxiosParamCreator = function (configuration) {
|
|
|
1545
1649
|
localVarQueryParameter['filter[suppliedId]'] = filterSuppliedId;
|
|
1546
1650
|
}
|
|
1547
1651
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1548
|
-
let headersFromBaseOptions = (
|
|
1652
|
+
let headersFromBaseOptions = (_f = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _f !== void 0 ? _f : {};
|
|
1549
1653
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1550
1654
|
return {
|
|
1551
1655
|
url: toPathString(localVarUrlObj),
|
|
@@ -1553,72 +1657,71 @@ export const FilesApiAxiosParamCreator = function (configuration) {
|
|
|
1553
1657
|
};
|
|
1554
1658
|
}),
|
|
1555
1659
|
/**
|
|
1556
|
-
*
|
|
1557
|
-
* @param {string} id The `file` ID.
|
|
1558
|
-
* @param {
|
|
1660
|
+
* Remove a file from a `file-collection`.
|
|
1661
|
+
* @param {string} id The `file-collection` ID.
|
|
1662
|
+
* @param {string} [filterFileId] Comma-separated list of file-ids to filter on.
|
|
1559
1663
|
* @param {*} [options] Override http request option.
|
|
1560
1664
|
* @throws {RequiredError}
|
|
1561
1665
|
*/
|
|
1562
|
-
|
|
1563
|
-
var
|
|
1666
|
+
removeFileCollectionFiles: (id, filterFileId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1667
|
+
var _g;
|
|
1564
1668
|
// verify required parameter 'id' is not null or undefined
|
|
1565
|
-
assertParamExists('
|
|
1566
|
-
|
|
1567
|
-
assertParamExists('updateFile', 'updateFileRequest', updateFileRequest);
|
|
1568
|
-
const localVarPath = `/files/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
1669
|
+
assertParamExists('removeFileCollectionFiles', 'id', id);
|
|
1670
|
+
const localVarPath = `/file-collections/{id}/files`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
1569
1671
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1570
1672
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1571
1673
|
let baseOptions;
|
|
1572
1674
|
if (configuration) {
|
|
1573
1675
|
baseOptions = configuration.baseOptions;
|
|
1574
1676
|
}
|
|
1575
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
1677
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
1576
1678
|
const localVarHeaderParameter = {};
|
|
1577
1679
|
const localVarQueryParameter = {};
|
|
1578
1680
|
// authentication OAuth2 required
|
|
1579
1681
|
// oauth required
|
|
1580
1682
|
yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
1581
|
-
|
|
1683
|
+
if (filterFileId !== undefined) {
|
|
1684
|
+
localVarQueryParameter['filter[fileId]'] = filterFileId;
|
|
1685
|
+
}
|
|
1582
1686
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1583
|
-
let headersFromBaseOptions = (
|
|
1687
|
+
let headersFromBaseOptions = (_g = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _g !== void 0 ? _g : {};
|
|
1584
1688
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1585
|
-
localVarRequestOptions.data = serializeDataIfNeeded(updateFileRequest, localVarRequestOptions, configuration);
|
|
1586
1689
|
return {
|
|
1587
1690
|
url: toPathString(localVarUrlObj),
|
|
1588
1691
|
options: localVarRequestOptions,
|
|
1589
1692
|
};
|
|
1590
1693
|
}),
|
|
1591
1694
|
/**
|
|
1592
|
-
*
|
|
1593
|
-
* @param {string} id The `file` ID.
|
|
1594
|
-
* @param {
|
|
1695
|
+
* Update a `file-collection`.
|
|
1696
|
+
* @param {string} id The `file-collection` ID.
|
|
1697
|
+
* @param {UpdateFileCollectionRequest} updateFileCollectionRequest
|
|
1595
1698
|
* @param {*} [options] Override http request option.
|
|
1596
1699
|
* @throws {RequiredError}
|
|
1597
1700
|
*/
|
|
1598
|
-
|
|
1599
|
-
var
|
|
1701
|
+
updateFileCollection: (id, updateFileCollectionRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1702
|
+
var _h;
|
|
1600
1703
|
// verify required parameter 'id' is not null or undefined
|
|
1601
|
-
assertParamExists('
|
|
1602
|
-
// verify required parameter '
|
|
1603
|
-
assertParamExists('
|
|
1604
|
-
const localVarPath = `/
|
|
1704
|
+
assertParamExists('updateFileCollection', 'id', id);
|
|
1705
|
+
// verify required parameter 'updateFileCollectionRequest' is not null or undefined
|
|
1706
|
+
assertParamExists('updateFileCollection', 'updateFileCollectionRequest', updateFileCollectionRequest);
|
|
1707
|
+
const localVarPath = `/file-collections/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
1605
1708
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1606
1709
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1607
1710
|
let baseOptions;
|
|
1608
1711
|
if (configuration) {
|
|
1609
1712
|
baseOptions = configuration.baseOptions;
|
|
1610
1713
|
}
|
|
1611
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
1714
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
1612
1715
|
const localVarHeaderParameter = {};
|
|
1613
1716
|
const localVarQueryParameter = {};
|
|
1614
1717
|
// authentication OAuth2 required
|
|
1615
1718
|
// oauth required
|
|
1616
1719
|
yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
1617
|
-
localVarHeaderParameter['Content-Type'] = 'application/
|
|
1720
|
+
localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
|
|
1618
1721
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1619
|
-
let headersFromBaseOptions = (
|
|
1722
|
+
let headersFromBaseOptions = (_h = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _h !== void 0 ? _h : {};
|
|
1620
1723
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1621
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
1724
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateFileCollectionRequest, localVarRequestOptions, configuration);
|
|
1622
1725
|
return {
|
|
1623
1726
|
url: toPathString(localVarUrlObj),
|
|
1624
1727
|
options: localVarRequestOptions,
|
|
@@ -1627,176 +1730,952 @@ export const FilesApiAxiosParamCreator = function (configuration) {
|
|
|
1627
1730
|
};
|
|
1628
1731
|
};
|
|
1629
1732
|
/**
|
|
1630
|
-
*
|
|
1733
|
+
* FileCollectionsApi - functional programming interface
|
|
1631
1734
|
* @export
|
|
1632
1735
|
*/
|
|
1633
|
-
export const
|
|
1634
|
-
const localVarAxiosParamCreator =
|
|
1736
|
+
export const FileCollectionsApiFp = function (configuration) {
|
|
1737
|
+
const localVarAxiosParamCreator = FileCollectionsApiAxiosParamCreator(configuration);
|
|
1635
1738
|
return {
|
|
1636
1739
|
/**
|
|
1637
|
-
*
|
|
1638
|
-
* @param {
|
|
1740
|
+
* Add files to a `file-collection`.
|
|
1741
|
+
* @param {string} id The `file-collection` ID.
|
|
1742
|
+
* @param {FileIdList} fileIdList
|
|
1639
1743
|
* @param {*} [options] Override http request option.
|
|
1640
1744
|
* @throws {RequiredError}
|
|
1641
1745
|
*/
|
|
1642
|
-
|
|
1746
|
+
addFileCollectionFiles(id, fileIdList, options) {
|
|
1643
1747
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1644
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
1748
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.addFileCollectionFiles(id, fileIdList, options);
|
|
1645
1749
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1646
1750
|
});
|
|
1647
1751
|
},
|
|
1648
1752
|
/**
|
|
1649
|
-
*
|
|
1650
|
-
* @param {
|
|
1753
|
+
* Create a `file-collection`.
|
|
1754
|
+
* @param {CreateFileCollectionRequest} createFileCollectionRequest
|
|
1651
1755
|
* @param {*} [options] Override http request option.
|
|
1652
1756
|
* @throws {RequiredError}
|
|
1653
1757
|
*/
|
|
1654
|
-
|
|
1758
|
+
createFileCollection(createFileCollectionRequest, options) {
|
|
1655
1759
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1656
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
1760
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createFileCollection(createFileCollectionRequest, options);
|
|
1657
1761
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1658
1762
|
});
|
|
1659
1763
|
},
|
|
1660
1764
|
/**
|
|
1661
|
-
*
|
|
1662
|
-
* @param {string} id The `file` ID.
|
|
1765
|
+
* Delete a `file-collection`.
|
|
1766
|
+
* @param {string} id The `file-collection` ID.
|
|
1663
1767
|
* @param {*} [options] Override http request option.
|
|
1664
1768
|
* @throws {RequiredError}
|
|
1665
1769
|
*/
|
|
1666
|
-
|
|
1770
|
+
deleteFileCollection(id, options) {
|
|
1667
1771
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1668
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
1772
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteFileCollection(id, options);
|
|
1669
1773
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1670
1774
|
});
|
|
1671
1775
|
},
|
|
1672
1776
|
/**
|
|
1673
|
-
* Get `
|
|
1777
|
+
* Get a `file-collection` by ID.
|
|
1778
|
+
* @param {string} id The `file-collection` ID.
|
|
1779
|
+
* @param {*} [options] Override http request option.
|
|
1780
|
+
* @throws {RequiredError}
|
|
1781
|
+
*/
|
|
1782
|
+
getFileCollection(id, options) {
|
|
1783
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1784
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getFileCollection(id, options);
|
|
1785
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1786
|
+
});
|
|
1787
|
+
},
|
|
1788
|
+
/**
|
|
1789
|
+
* List the files in a `file-collection`.
|
|
1790
|
+
* @param {string} id The `file-collection` ID.
|
|
1791
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
1792
|
+
* @param {number} [pageSize] The number of items to return.
|
|
1793
|
+
* @param {*} [options] Override http request option.
|
|
1794
|
+
* @throws {RequiredError}
|
|
1795
|
+
*/
|
|
1796
|
+
listFileCollectionFiles(id, pageCursor, pageSize, options) {
|
|
1797
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1798
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listFileCollectionFiles(id, pageCursor, pageSize, options);
|
|
1799
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1800
|
+
});
|
|
1801
|
+
},
|
|
1802
|
+
/**
|
|
1803
|
+
* List `file-collection`s by supplied ID.
|
|
1674
1804
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
1675
1805
|
* @param {number} [pageSize] The number of items to return.
|
|
1676
1806
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
1677
1807
|
* @param {*} [options] Override http request option.
|
|
1678
1808
|
* @throws {RequiredError}
|
|
1679
1809
|
*/
|
|
1680
|
-
|
|
1810
|
+
listFileCollections(pageCursor, pageSize, filterSuppliedId, options) {
|
|
1681
1811
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1682
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
1812
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listFileCollections(pageCursor, pageSize, filterSuppliedId, options);
|
|
1683
1813
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1684
1814
|
});
|
|
1685
1815
|
},
|
|
1686
1816
|
/**
|
|
1687
|
-
*
|
|
1688
|
-
* @param {string} id The `file` ID.
|
|
1689
|
-
* @param {
|
|
1817
|
+
* Remove a file from a `file-collection`.
|
|
1818
|
+
* @param {string} id The `file-collection` ID.
|
|
1819
|
+
* @param {string} [filterFileId] Comma-separated list of file-ids to filter on.
|
|
1690
1820
|
* @param {*} [options] Override http request option.
|
|
1691
1821
|
* @throws {RequiredError}
|
|
1692
1822
|
*/
|
|
1693
|
-
|
|
1823
|
+
removeFileCollectionFiles(id, filterFileId, options) {
|
|
1694
1824
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1695
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
1825
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.removeFileCollectionFiles(id, filterFileId, options);
|
|
1696
1826
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1697
1827
|
});
|
|
1698
1828
|
},
|
|
1699
1829
|
/**
|
|
1700
|
-
*
|
|
1701
|
-
* @param {string} id The `file` ID.
|
|
1702
|
-
* @param {
|
|
1830
|
+
* Update a `file-collection`.
|
|
1831
|
+
* @param {string} id The `file-collection` ID.
|
|
1832
|
+
* @param {UpdateFileCollectionRequest} updateFileCollectionRequest
|
|
1703
1833
|
* @param {*} [options] Override http request option.
|
|
1704
1834
|
* @throws {RequiredError}
|
|
1705
1835
|
*/
|
|
1706
|
-
|
|
1836
|
+
updateFileCollection(id, updateFileCollectionRequest, options) {
|
|
1707
1837
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1708
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
1838
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateFileCollection(id, updateFileCollectionRequest, options);
|
|
1709
1839
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1710
1840
|
});
|
|
1711
1841
|
},
|
|
1712
1842
|
};
|
|
1713
1843
|
};
|
|
1714
1844
|
/**
|
|
1715
|
-
*
|
|
1845
|
+
* FileCollectionsApi - factory interface
|
|
1716
1846
|
* @export
|
|
1717
1847
|
*/
|
|
1718
|
-
export const
|
|
1719
|
-
const localVarFp =
|
|
1848
|
+
export const FileCollectionsApiFactory = function (configuration, basePath, axios) {
|
|
1849
|
+
const localVarFp = FileCollectionsApiFp(configuration);
|
|
1720
1850
|
return {
|
|
1721
1851
|
/**
|
|
1722
|
-
*
|
|
1723
|
-
* @param {
|
|
1852
|
+
* Add files to a `file-collection`.
|
|
1853
|
+
* @param {string} id The `file-collection` ID.
|
|
1854
|
+
* @param {FileIdList} fileIdList
|
|
1724
1855
|
* @param {*} [options] Override http request option.
|
|
1725
1856
|
* @throws {RequiredError}
|
|
1726
1857
|
*/
|
|
1727
|
-
|
|
1858
|
+
addFileCollectionFiles(id, fileIdList, options) {
|
|
1728
1859
|
return localVarFp
|
|
1729
|
-
.
|
|
1860
|
+
.addFileCollectionFiles(id, fileIdList, options)
|
|
1730
1861
|
.then((request) => request(axios, basePath));
|
|
1731
1862
|
},
|
|
1732
1863
|
/**
|
|
1733
|
-
*
|
|
1734
|
-
* @param {
|
|
1864
|
+
* Create a `file-collection`.
|
|
1865
|
+
* @param {CreateFileCollectionRequest} createFileCollectionRequest
|
|
1735
1866
|
* @param {*} [options] Override http request option.
|
|
1736
1867
|
* @throws {RequiredError}
|
|
1737
1868
|
*/
|
|
1738
|
-
|
|
1869
|
+
createFileCollection(createFileCollectionRequest, options) {
|
|
1739
1870
|
return localVarFp
|
|
1740
|
-
.
|
|
1871
|
+
.createFileCollection(createFileCollectionRequest, options)
|
|
1741
1872
|
.then((request) => request(axios, basePath));
|
|
1742
1873
|
},
|
|
1743
1874
|
/**
|
|
1744
|
-
*
|
|
1745
|
-
* @param {string} id The `file` ID.
|
|
1875
|
+
* Delete a `file-collection`.
|
|
1876
|
+
* @param {string} id The `file-collection` ID.
|
|
1746
1877
|
* @param {*} [options] Override http request option.
|
|
1747
1878
|
* @throws {RequiredError}
|
|
1748
1879
|
*/
|
|
1749
|
-
|
|
1880
|
+
deleteFileCollection(id, options) {
|
|
1750
1881
|
return localVarFp
|
|
1751
|
-
.
|
|
1882
|
+
.deleteFileCollection(id, options)
|
|
1752
1883
|
.then((request) => request(axios, basePath));
|
|
1753
1884
|
},
|
|
1754
1885
|
/**
|
|
1755
|
-
* Get `
|
|
1886
|
+
* Get a `file-collection` by ID.
|
|
1887
|
+
* @param {string} id The `file-collection` ID.
|
|
1888
|
+
* @param {*} [options] Override http request option.
|
|
1889
|
+
* @throws {RequiredError}
|
|
1890
|
+
*/
|
|
1891
|
+
getFileCollection(id, options) {
|
|
1892
|
+
return localVarFp
|
|
1893
|
+
.getFileCollection(id, options)
|
|
1894
|
+
.then((request) => request(axios, basePath));
|
|
1895
|
+
},
|
|
1896
|
+
/**
|
|
1897
|
+
* List the files in a `file-collection`.
|
|
1898
|
+
* @param {string} id The `file-collection` ID.
|
|
1899
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
1900
|
+
* @param {number} [pageSize] The number of items to return.
|
|
1901
|
+
* @param {*} [options] Override http request option.
|
|
1902
|
+
* @throws {RequiredError}
|
|
1903
|
+
*/
|
|
1904
|
+
listFileCollectionFiles(id, pageCursor, pageSize, options) {
|
|
1905
|
+
return localVarFp
|
|
1906
|
+
.listFileCollectionFiles(id, pageCursor, pageSize, options)
|
|
1907
|
+
.then((request) => request(axios, basePath));
|
|
1908
|
+
},
|
|
1909
|
+
/**
|
|
1910
|
+
* List `file-collection`s by supplied ID.
|
|
1756
1911
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
1757
1912
|
* @param {number} [pageSize] The number of items to return.
|
|
1758
1913
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
1759
1914
|
* @param {*} [options] Override http request option.
|
|
1760
1915
|
* @throws {RequiredError}
|
|
1761
1916
|
*/
|
|
1762
|
-
|
|
1917
|
+
listFileCollections(pageCursor, pageSize, filterSuppliedId, options) {
|
|
1763
1918
|
return localVarFp
|
|
1764
|
-
.
|
|
1919
|
+
.listFileCollections(pageCursor, pageSize, filterSuppliedId, options)
|
|
1765
1920
|
.then((request) => request(axios, basePath));
|
|
1766
1921
|
},
|
|
1767
1922
|
/**
|
|
1768
|
-
*
|
|
1769
|
-
* @param {string} id The `file` ID.
|
|
1770
|
-
* @param {
|
|
1923
|
+
* Remove a file from a `file-collection`.
|
|
1924
|
+
* @param {string} id The `file-collection` ID.
|
|
1925
|
+
* @param {string} [filterFileId] Comma-separated list of file-ids to filter on.
|
|
1771
1926
|
* @param {*} [options] Override http request option.
|
|
1772
1927
|
* @throws {RequiredError}
|
|
1773
1928
|
*/
|
|
1774
|
-
|
|
1929
|
+
removeFileCollectionFiles(id, filterFileId, options) {
|
|
1775
1930
|
return localVarFp
|
|
1776
|
-
.
|
|
1931
|
+
.removeFileCollectionFiles(id, filterFileId, options)
|
|
1777
1932
|
.then((request) => request(axios, basePath));
|
|
1778
1933
|
},
|
|
1779
1934
|
/**
|
|
1780
|
-
*
|
|
1781
|
-
* @param {string} id The `file` ID.
|
|
1782
|
-
* @param {
|
|
1935
|
+
* Update a `file-collection`.
|
|
1936
|
+
* @param {string} id The `file-collection` ID.
|
|
1937
|
+
* @param {UpdateFileCollectionRequest} updateFileCollectionRequest
|
|
1783
1938
|
* @param {*} [options] Override http request option.
|
|
1784
1939
|
* @throws {RequiredError}
|
|
1785
1940
|
*/
|
|
1786
|
-
|
|
1941
|
+
updateFileCollection(id, updateFileCollectionRequest, options) {
|
|
1787
1942
|
return localVarFp
|
|
1788
|
-
.
|
|
1943
|
+
.updateFileCollection(id, updateFileCollectionRequest, options)
|
|
1789
1944
|
.then((request) => request(axios, basePath));
|
|
1790
1945
|
},
|
|
1791
1946
|
};
|
|
1792
1947
|
};
|
|
1793
1948
|
/**
|
|
1794
|
-
*
|
|
1949
|
+
* FileCollectionsApi - object-oriented interface
|
|
1795
1950
|
* @export
|
|
1796
|
-
* @class
|
|
1951
|
+
* @class FileCollectionsApi
|
|
1797
1952
|
* @extends {BaseAPI}
|
|
1798
1953
|
*/
|
|
1799
|
-
export class
|
|
1954
|
+
export class FileCollectionsApi extends BaseAPI {
|
|
1955
|
+
/**
|
|
1956
|
+
* Add files to a `file-collection`.
|
|
1957
|
+
* @param {FileCollectionsApiAddFileCollectionFilesRequest} requestParameters Request parameters.
|
|
1958
|
+
* @param {*} [options] Override http request option.
|
|
1959
|
+
* @throws {RequiredError}
|
|
1960
|
+
* @memberof FileCollectionsApi
|
|
1961
|
+
*/
|
|
1962
|
+
addFileCollectionFiles(requestParameters, options) {
|
|
1963
|
+
return FileCollectionsApiFp(this.configuration)
|
|
1964
|
+
.addFileCollectionFiles(requestParameters.id, requestParameters.fileIdList, options)
|
|
1965
|
+
.then((request) => request(this.axios, this.basePath));
|
|
1966
|
+
}
|
|
1967
|
+
/**
|
|
1968
|
+
* Create a `file-collection`.
|
|
1969
|
+
* @param {FileCollectionsApiCreateFileCollectionRequest} requestParameters Request parameters.
|
|
1970
|
+
* @param {*} [options] Override http request option.
|
|
1971
|
+
* @throws {RequiredError}
|
|
1972
|
+
* @memberof FileCollectionsApi
|
|
1973
|
+
*/
|
|
1974
|
+
createFileCollection(requestParameters, options) {
|
|
1975
|
+
return FileCollectionsApiFp(this.configuration)
|
|
1976
|
+
.createFileCollection(requestParameters.createFileCollectionRequest, options)
|
|
1977
|
+
.then((request) => request(this.axios, this.basePath));
|
|
1978
|
+
}
|
|
1979
|
+
/**
|
|
1980
|
+
* Delete a `file-collection`.
|
|
1981
|
+
* @param {FileCollectionsApiDeleteFileCollectionRequest} requestParameters Request parameters.
|
|
1982
|
+
* @param {*} [options] Override http request option.
|
|
1983
|
+
* @throws {RequiredError}
|
|
1984
|
+
* @memberof FileCollectionsApi
|
|
1985
|
+
*/
|
|
1986
|
+
deleteFileCollection(requestParameters, options) {
|
|
1987
|
+
return FileCollectionsApiFp(this.configuration)
|
|
1988
|
+
.deleteFileCollection(requestParameters.id, options)
|
|
1989
|
+
.then((request) => request(this.axios, this.basePath));
|
|
1990
|
+
}
|
|
1991
|
+
/**
|
|
1992
|
+
* Get a `file-collection` by ID.
|
|
1993
|
+
* @param {FileCollectionsApiGetFileCollectionRequest} requestParameters Request parameters.
|
|
1994
|
+
* @param {*} [options] Override http request option.
|
|
1995
|
+
* @throws {RequiredError}
|
|
1996
|
+
* @memberof FileCollectionsApi
|
|
1997
|
+
*/
|
|
1998
|
+
getFileCollection(requestParameters, options) {
|
|
1999
|
+
return FileCollectionsApiFp(this.configuration)
|
|
2000
|
+
.getFileCollection(requestParameters.id, options)
|
|
2001
|
+
.then((request) => request(this.axios, this.basePath));
|
|
2002
|
+
}
|
|
2003
|
+
/**
|
|
2004
|
+
* List the files in a `file-collection`.
|
|
2005
|
+
* @param {FileCollectionsApiListFileCollectionFilesRequest} requestParameters Request parameters.
|
|
2006
|
+
* @param {*} [options] Override http request option.
|
|
2007
|
+
* @throws {RequiredError}
|
|
2008
|
+
* @memberof FileCollectionsApi
|
|
2009
|
+
*/
|
|
2010
|
+
listFileCollectionFiles(requestParameters, options) {
|
|
2011
|
+
return FileCollectionsApiFp(this.configuration)
|
|
2012
|
+
.listFileCollectionFiles(requestParameters.id, requestParameters.pageCursor, requestParameters.pageSize, options)
|
|
2013
|
+
.then((request) => request(this.axios, this.basePath));
|
|
2014
|
+
}
|
|
2015
|
+
/**
|
|
2016
|
+
* List `file-collection`s by supplied ID.
|
|
2017
|
+
* @param {FileCollectionsApiListFileCollectionsRequest} requestParameters Request parameters.
|
|
2018
|
+
* @param {*} [options] Override http request option.
|
|
2019
|
+
* @throws {RequiredError}
|
|
2020
|
+
* @memberof FileCollectionsApi
|
|
2021
|
+
*/
|
|
2022
|
+
listFileCollections(requestParameters = {}, options) {
|
|
2023
|
+
return FileCollectionsApiFp(this.configuration)
|
|
2024
|
+
.listFileCollections(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterSuppliedId, options)
|
|
2025
|
+
.then((request) => request(this.axios, this.basePath));
|
|
2026
|
+
}
|
|
2027
|
+
/**
|
|
2028
|
+
* Remove a file from a `file-collection`.
|
|
2029
|
+
* @param {FileCollectionsApiRemoveFileCollectionFilesRequest} requestParameters Request parameters.
|
|
2030
|
+
* @param {*} [options] Override http request option.
|
|
2031
|
+
* @throws {RequiredError}
|
|
2032
|
+
* @memberof FileCollectionsApi
|
|
2033
|
+
*/
|
|
2034
|
+
removeFileCollectionFiles(requestParameters, options) {
|
|
2035
|
+
return FileCollectionsApiFp(this.configuration)
|
|
2036
|
+
.removeFileCollectionFiles(requestParameters.id, requestParameters.filterFileId, options)
|
|
2037
|
+
.then((request) => request(this.axios, this.basePath));
|
|
2038
|
+
}
|
|
2039
|
+
/**
|
|
2040
|
+
* Update a `file-collection`.
|
|
2041
|
+
* @param {FileCollectionsApiUpdateFileCollectionRequest} requestParameters Request parameters.
|
|
2042
|
+
* @param {*} [options] Override http request option.
|
|
2043
|
+
* @throws {RequiredError}
|
|
2044
|
+
* @memberof FileCollectionsApi
|
|
2045
|
+
*/
|
|
2046
|
+
updateFileCollection(requestParameters, options) {
|
|
2047
|
+
return FileCollectionsApiFp(this.configuration)
|
|
2048
|
+
.updateFileCollection(requestParameters.id, requestParameters.updateFileCollectionRequest, options)
|
|
2049
|
+
.then((request) => request(this.axios, this.basePath));
|
|
2050
|
+
}
|
|
2051
|
+
}
|
|
2052
|
+
/**
|
|
2053
|
+
* FileJobsApi - axios parameter creator
|
|
2054
|
+
* @export
|
|
2055
|
+
*/
|
|
2056
|
+
export const FileJobsApiAxiosParamCreator = function (configuration) {
|
|
2057
|
+
return {
|
|
2058
|
+
/**
|
|
2059
|
+
* Create a `file-job`.
|
|
2060
|
+
* @param {CreateFileJobRequest} createFileJobRequest
|
|
2061
|
+
* @param {*} [options] Override http request option.
|
|
2062
|
+
* @throws {RequiredError}
|
|
2063
|
+
*/
|
|
2064
|
+
createFileJob: (createFileJobRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
2065
|
+
var _a;
|
|
2066
|
+
// verify required parameter 'createFileJobRequest' is not null or undefined
|
|
2067
|
+
assertParamExists('createFileJob', 'createFileJobRequest', createFileJobRequest);
|
|
2068
|
+
const localVarPath = `/file-jobs`;
|
|
2069
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2070
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2071
|
+
let baseOptions;
|
|
2072
|
+
if (configuration) {
|
|
2073
|
+
baseOptions = configuration.baseOptions;
|
|
2074
|
+
}
|
|
2075
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
2076
|
+
const localVarHeaderParameter = {};
|
|
2077
|
+
const localVarQueryParameter = {};
|
|
2078
|
+
// authentication OAuth2 required
|
|
2079
|
+
// oauth required
|
|
2080
|
+
yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
2081
|
+
localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
|
|
2082
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2083
|
+
let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
|
|
2084
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2085
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createFileJobRequest, localVarRequestOptions, configuration);
|
|
2086
|
+
return {
|
|
2087
|
+
url: toPathString(localVarUrlObj),
|
|
2088
|
+
options: localVarRequestOptions,
|
|
2089
|
+
};
|
|
2090
|
+
}),
|
|
2091
|
+
/**
|
|
2092
|
+
* Get the status and result of a `file-job`.
|
|
2093
|
+
* @param {string} id The ID of a file job.
|
|
2094
|
+
* @param {*} [options] Override http request option.
|
|
2095
|
+
* @throws {RequiredError}
|
|
2096
|
+
*/
|
|
2097
|
+
getFileJob: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
2098
|
+
var _b;
|
|
2099
|
+
// verify required parameter 'id' is not null or undefined
|
|
2100
|
+
assertParamExists('getFileJob', 'id', id);
|
|
2101
|
+
const localVarPath = `/file-jobs/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
2102
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2103
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2104
|
+
let baseOptions;
|
|
2105
|
+
if (configuration) {
|
|
2106
|
+
baseOptions = configuration.baseOptions;
|
|
2107
|
+
}
|
|
2108
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2109
|
+
const localVarHeaderParameter = {};
|
|
2110
|
+
const localVarQueryParameter = {};
|
|
2111
|
+
// authentication OAuth2 required
|
|
2112
|
+
// oauth required
|
|
2113
|
+
yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
2114
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2115
|
+
let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
|
|
2116
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2117
|
+
return {
|
|
2118
|
+
url: toPathString(localVarUrlObj),
|
|
2119
|
+
options: localVarRequestOptions,
|
|
2120
|
+
};
|
|
2121
|
+
}),
|
|
2122
|
+
};
|
|
2123
|
+
};
|
|
2124
|
+
/**
|
|
2125
|
+
* FileJobsApi - functional programming interface
|
|
2126
|
+
* @export
|
|
2127
|
+
*/
|
|
2128
|
+
export const FileJobsApiFp = function (configuration) {
|
|
2129
|
+
const localVarAxiosParamCreator = FileJobsApiAxiosParamCreator(configuration);
|
|
2130
|
+
return {
|
|
2131
|
+
/**
|
|
2132
|
+
* Create a `file-job`.
|
|
2133
|
+
* @param {CreateFileJobRequest} createFileJobRequest
|
|
2134
|
+
* @param {*} [options] Override http request option.
|
|
2135
|
+
* @throws {RequiredError}
|
|
2136
|
+
*/
|
|
2137
|
+
createFileJob(createFileJobRequest, options) {
|
|
2138
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2139
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createFileJob(createFileJobRequest, options);
|
|
2140
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2141
|
+
});
|
|
2142
|
+
},
|
|
2143
|
+
/**
|
|
2144
|
+
* Get the status and result of a `file-job`.
|
|
2145
|
+
* @param {string} id The ID of a file job.
|
|
2146
|
+
* @param {*} [options] Override http request option.
|
|
2147
|
+
* @throws {RequiredError}
|
|
2148
|
+
*/
|
|
2149
|
+
getFileJob(id, options) {
|
|
2150
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2151
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getFileJob(id, options);
|
|
2152
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2153
|
+
});
|
|
2154
|
+
},
|
|
2155
|
+
};
|
|
2156
|
+
};
|
|
2157
|
+
/**
|
|
2158
|
+
* FileJobsApi - factory interface
|
|
2159
|
+
* @export
|
|
2160
|
+
*/
|
|
2161
|
+
export const FileJobsApiFactory = function (configuration, basePath, axios) {
|
|
2162
|
+
const localVarFp = FileJobsApiFp(configuration);
|
|
2163
|
+
return {
|
|
2164
|
+
/**
|
|
2165
|
+
* Create a `file-job`.
|
|
2166
|
+
* @param {CreateFileJobRequest} createFileJobRequest
|
|
2167
|
+
* @param {*} [options] Override http request option.
|
|
2168
|
+
* @throws {RequiredError}
|
|
2169
|
+
*/
|
|
2170
|
+
createFileJob(createFileJobRequest, options) {
|
|
2171
|
+
return localVarFp
|
|
2172
|
+
.createFileJob(createFileJobRequest, options)
|
|
2173
|
+
.then((request) => request(axios, basePath));
|
|
2174
|
+
},
|
|
2175
|
+
/**
|
|
2176
|
+
* Get the status and result of a `file-job`.
|
|
2177
|
+
* @param {string} id The ID of a file job.
|
|
2178
|
+
* @param {*} [options] Override http request option.
|
|
2179
|
+
* @throws {RequiredError}
|
|
2180
|
+
*/
|
|
2181
|
+
getFileJob(id, options) {
|
|
2182
|
+
return localVarFp
|
|
2183
|
+
.getFileJob(id, options)
|
|
2184
|
+
.then((request) => request(axios, basePath));
|
|
2185
|
+
},
|
|
2186
|
+
};
|
|
2187
|
+
};
|
|
2188
|
+
/**
|
|
2189
|
+
* FileJobsApi - object-oriented interface
|
|
2190
|
+
* @export
|
|
2191
|
+
* @class FileJobsApi
|
|
2192
|
+
* @extends {BaseAPI}
|
|
2193
|
+
*/
|
|
2194
|
+
export class FileJobsApi extends BaseAPI {
|
|
2195
|
+
/**
|
|
2196
|
+
* Create a `file-job`.
|
|
2197
|
+
* @param {FileJobsApiCreateFileJobRequest} requestParameters Request parameters.
|
|
2198
|
+
* @param {*} [options] Override http request option.
|
|
2199
|
+
* @throws {RequiredError}
|
|
2200
|
+
* @memberof FileJobsApi
|
|
2201
|
+
*/
|
|
2202
|
+
createFileJob(requestParameters, options) {
|
|
2203
|
+
return FileJobsApiFp(this.configuration)
|
|
2204
|
+
.createFileJob(requestParameters.createFileJobRequest, options)
|
|
2205
|
+
.then((request) => request(this.axios, this.basePath));
|
|
2206
|
+
}
|
|
2207
|
+
/**
|
|
2208
|
+
* Get the status and result of a `file-job`.
|
|
2209
|
+
* @param {FileJobsApiGetFileJobRequest} requestParameters Request parameters.
|
|
2210
|
+
* @param {*} [options] Override http request option.
|
|
2211
|
+
* @throws {RequiredError}
|
|
2212
|
+
* @memberof FileJobsApi
|
|
2213
|
+
*/
|
|
2214
|
+
getFileJob(requestParameters, options) {
|
|
2215
|
+
return FileJobsApiFp(this.configuration)
|
|
2216
|
+
.getFileJob(requestParameters.id, options)
|
|
2217
|
+
.then((request) => request(this.axios, this.basePath));
|
|
2218
|
+
}
|
|
2219
|
+
}
|
|
2220
|
+
/**
|
|
2221
|
+
* FilesApi - axios parameter creator
|
|
2222
|
+
* @export
|
|
2223
|
+
*/
|
|
2224
|
+
export const FilesApiAxiosParamCreator = function (configuration) {
|
|
2225
|
+
return {
|
|
2226
|
+
/**
|
|
2227
|
+
* Create a download uri for a `file` by ID.
|
|
2228
|
+
* @param {string} id The `file` ID.
|
|
2229
|
+
* @param {CreateDownloadRequest} createDownloadRequest
|
|
2230
|
+
* @param {*} [options] Override http request option.
|
|
2231
|
+
* @throws {RequiredError}
|
|
2232
|
+
*/
|
|
2233
|
+
createDownloadUrl: (id, createDownloadRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
2234
|
+
var _a;
|
|
2235
|
+
// verify required parameter 'id' is not null or undefined
|
|
2236
|
+
assertParamExists('createDownloadUrl', 'id', id);
|
|
2237
|
+
// verify required parameter 'createDownloadRequest' is not null or undefined
|
|
2238
|
+
assertParamExists('createDownloadUrl', 'createDownloadRequest', createDownloadRequest);
|
|
2239
|
+
const localVarPath = `/files/{id}/download-url`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
2240
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2241
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2242
|
+
let baseOptions;
|
|
2243
|
+
if (configuration) {
|
|
2244
|
+
baseOptions = configuration.baseOptions;
|
|
2245
|
+
}
|
|
2246
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
2247
|
+
const localVarHeaderParameter = {};
|
|
2248
|
+
const localVarQueryParameter = {};
|
|
2249
|
+
// authentication OAuth2 required
|
|
2250
|
+
// oauth required
|
|
2251
|
+
yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
2252
|
+
localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
|
|
2253
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2254
|
+
let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
|
|
2255
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2256
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createDownloadRequest, localVarRequestOptions, configuration);
|
|
2257
|
+
return {
|
|
2258
|
+
url: toPathString(localVarUrlObj),
|
|
2259
|
+
options: localVarRequestOptions,
|
|
2260
|
+
};
|
|
2261
|
+
}),
|
|
2262
|
+
/**
|
|
2263
|
+
* Create a `file`. Once created, upload file content via the uploadFile API. For details including supported file formats, see our [Import data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guide.
|
|
2264
|
+
* @param {CreateFileRequest} createFileRequest
|
|
2265
|
+
* @param {*} [options] Override http request option.
|
|
2266
|
+
* @throws {RequiredError}
|
|
2267
|
+
*/
|
|
2268
|
+
createFile: (createFileRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
2269
|
+
var _b;
|
|
2270
|
+
// verify required parameter 'createFileRequest' is not null or undefined
|
|
2271
|
+
assertParamExists('createFile', 'createFileRequest', createFileRequest);
|
|
2272
|
+
const localVarPath = `/files`;
|
|
2273
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2274
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2275
|
+
let baseOptions;
|
|
2276
|
+
if (configuration) {
|
|
2277
|
+
baseOptions = configuration.baseOptions;
|
|
2278
|
+
}
|
|
2279
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
2280
|
+
const localVarHeaderParameter = {};
|
|
2281
|
+
const localVarQueryParameter = {};
|
|
2282
|
+
// authentication OAuth2 required
|
|
2283
|
+
// oauth required
|
|
2284
|
+
yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
2285
|
+
localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
|
|
2286
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2287
|
+
let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
|
|
2288
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2289
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createFileRequest, localVarRequestOptions, configuration);
|
|
2290
|
+
return {
|
|
2291
|
+
url: toPathString(localVarUrlObj),
|
|
2292
|
+
options: localVarRequestOptions,
|
|
2293
|
+
};
|
|
2294
|
+
}),
|
|
2295
|
+
/**
|
|
2296
|
+
* Delete a `file`.
|
|
2297
|
+
* @param {string} id The `file` ID.
|
|
2298
|
+
* @param {*} [options] Override http request option.
|
|
2299
|
+
* @throws {RequiredError}
|
|
2300
|
+
*/
|
|
2301
|
+
deleteFile: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
2302
|
+
var _c;
|
|
2303
|
+
// verify required parameter 'id' is not null or undefined
|
|
2304
|
+
assertParamExists('deleteFile', 'id', id);
|
|
2305
|
+
const localVarPath = `/files/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
2306
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2307
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2308
|
+
let baseOptions;
|
|
2309
|
+
if (configuration) {
|
|
2310
|
+
baseOptions = configuration.baseOptions;
|
|
2311
|
+
}
|
|
2312
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
2313
|
+
const localVarHeaderParameter = {};
|
|
2314
|
+
const localVarQueryParameter = {};
|
|
2315
|
+
// authentication OAuth2 required
|
|
2316
|
+
// oauth required
|
|
2317
|
+
yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
2318
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2319
|
+
let headersFromBaseOptions = (_c = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _c !== void 0 ? _c : {};
|
|
2320
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2321
|
+
return {
|
|
2322
|
+
url: toPathString(localVarUrlObj),
|
|
2323
|
+
options: localVarRequestOptions,
|
|
2324
|
+
};
|
|
2325
|
+
}),
|
|
2326
|
+
/**
|
|
2327
|
+
* Get a `file` by ID.
|
|
2328
|
+
* @param {string} id The `file` ID.
|
|
2329
|
+
* @param {*} [options] Override http request option.
|
|
2330
|
+
* @throws {RequiredError}
|
|
2331
|
+
*/
|
|
2332
|
+
getFile: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
2333
|
+
var _d;
|
|
2334
|
+
// verify required parameter 'id' is not null or undefined
|
|
2335
|
+
assertParamExists('getFile', 'id', id);
|
|
2336
|
+
const localVarPath = `/files/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
2337
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2338
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2339
|
+
let baseOptions;
|
|
2340
|
+
if (configuration) {
|
|
2341
|
+
baseOptions = configuration.baseOptions;
|
|
2342
|
+
}
|
|
2343
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2344
|
+
const localVarHeaderParameter = {};
|
|
2345
|
+
const localVarQueryParameter = {};
|
|
2346
|
+
// authentication OAuth2 required
|
|
2347
|
+
// oauth required
|
|
2348
|
+
yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
2349
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2350
|
+
let headersFromBaseOptions = (_d = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _d !== void 0 ? _d : {};
|
|
2351
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2352
|
+
return {
|
|
2353
|
+
url: toPathString(localVarUrlObj),
|
|
2354
|
+
options: localVarRequestOptions,
|
|
2355
|
+
};
|
|
2356
|
+
}),
|
|
2357
|
+
/**
|
|
2358
|
+
* Get `files`.
|
|
2359
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
2360
|
+
* @param {number} [pageSize] The number of items to return.
|
|
2361
|
+
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
2362
|
+
* @param {*} [options] Override http request option.
|
|
2363
|
+
* @throws {RequiredError}
|
|
2364
|
+
*/
|
|
2365
|
+
getFiles: (pageCursor, pageSize, filterSuppliedId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
2366
|
+
var _e;
|
|
2367
|
+
const localVarPath = `/files`;
|
|
2368
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2369
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2370
|
+
let baseOptions;
|
|
2371
|
+
if (configuration) {
|
|
2372
|
+
baseOptions = configuration.baseOptions;
|
|
2373
|
+
}
|
|
2374
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2375
|
+
const localVarHeaderParameter = {};
|
|
2376
|
+
const localVarQueryParameter = {};
|
|
2377
|
+
// authentication OAuth2 required
|
|
2378
|
+
// oauth required
|
|
2379
|
+
yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
2380
|
+
if (pageCursor !== undefined) {
|
|
2381
|
+
localVarQueryParameter['page[cursor]'] = pageCursor;
|
|
2382
|
+
}
|
|
2383
|
+
if (pageSize !== undefined) {
|
|
2384
|
+
localVarQueryParameter['page[size]'] = pageSize;
|
|
2385
|
+
}
|
|
2386
|
+
if (filterSuppliedId !== undefined) {
|
|
2387
|
+
localVarQueryParameter['filter[suppliedId]'] = filterSuppliedId;
|
|
2388
|
+
}
|
|
2389
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2390
|
+
let headersFromBaseOptions = (_e = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _e !== void 0 ? _e : {};
|
|
2391
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2392
|
+
return {
|
|
2393
|
+
url: toPathString(localVarUrlObj),
|
|
2394
|
+
options: localVarRequestOptions,
|
|
2395
|
+
};
|
|
2396
|
+
}),
|
|
2397
|
+
/**
|
|
2398
|
+
* Update a `file`.
|
|
2399
|
+
* @param {string} id The `file` ID.
|
|
2400
|
+
* @param {UpdateFileRequest} updateFileRequest
|
|
2401
|
+
* @param {*} [options] Override http request option.
|
|
2402
|
+
* @throws {RequiredError}
|
|
2403
|
+
*/
|
|
2404
|
+
updateFile: (id, updateFileRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
2405
|
+
var _f;
|
|
2406
|
+
// verify required parameter 'id' is not null or undefined
|
|
2407
|
+
assertParamExists('updateFile', 'id', id);
|
|
2408
|
+
// verify required parameter 'updateFileRequest' is not null or undefined
|
|
2409
|
+
assertParamExists('updateFile', 'updateFileRequest', updateFileRequest);
|
|
2410
|
+
const localVarPath = `/files/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
2411
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2412
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2413
|
+
let baseOptions;
|
|
2414
|
+
if (configuration) {
|
|
2415
|
+
baseOptions = configuration.baseOptions;
|
|
2416
|
+
}
|
|
2417
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
2418
|
+
const localVarHeaderParameter = {};
|
|
2419
|
+
const localVarQueryParameter = {};
|
|
2420
|
+
// authentication OAuth2 required
|
|
2421
|
+
// oauth required
|
|
2422
|
+
yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
2423
|
+
localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
|
|
2424
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2425
|
+
let headersFromBaseOptions = (_f = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _f !== void 0 ? _f : {};
|
|
2426
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2427
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateFileRequest, localVarRequestOptions, configuration);
|
|
2428
|
+
return {
|
|
2429
|
+
url: toPathString(localVarUrlObj),
|
|
2430
|
+
options: localVarRequestOptions,
|
|
2431
|
+
};
|
|
2432
|
+
}),
|
|
2433
|
+
/**
|
|
2434
|
+
* Upload a `file`. Once uploaded, create either parts or geometry sets via the createPart or createGeometrySet APIs.
|
|
2435
|
+
* @param {string} id The `file` ID.
|
|
2436
|
+
* @param {any} body
|
|
2437
|
+
* @param {*} [options] Override http request option.
|
|
2438
|
+
* @throws {RequiredError}
|
|
2439
|
+
*/
|
|
2440
|
+
uploadFile: (id, body, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
2441
|
+
var _g;
|
|
2442
|
+
// verify required parameter 'id' is not null or undefined
|
|
2443
|
+
assertParamExists('uploadFile', 'id', id);
|
|
2444
|
+
// verify required parameter 'body' is not null or undefined
|
|
2445
|
+
assertParamExists('uploadFile', 'body', body);
|
|
2446
|
+
const localVarPath = `/files/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
2447
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2448
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2449
|
+
let baseOptions;
|
|
2450
|
+
if (configuration) {
|
|
2451
|
+
baseOptions = configuration.baseOptions;
|
|
2452
|
+
}
|
|
2453
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
2454
|
+
const localVarHeaderParameter = {};
|
|
2455
|
+
const localVarQueryParameter = {};
|
|
2456
|
+
// authentication OAuth2 required
|
|
2457
|
+
// oauth required
|
|
2458
|
+
yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
2459
|
+
localVarHeaderParameter['Content-Type'] = 'application/octet-stream';
|
|
2460
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2461
|
+
let headersFromBaseOptions = (_g = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _g !== void 0 ? _g : {};
|
|
2462
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2463
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
2464
|
+
return {
|
|
2465
|
+
url: toPathString(localVarUrlObj),
|
|
2466
|
+
options: localVarRequestOptions,
|
|
2467
|
+
};
|
|
2468
|
+
}),
|
|
2469
|
+
};
|
|
2470
|
+
};
|
|
2471
|
+
/**
|
|
2472
|
+
* FilesApi - functional programming interface
|
|
2473
|
+
* @export
|
|
2474
|
+
*/
|
|
2475
|
+
export const FilesApiFp = function (configuration) {
|
|
2476
|
+
const localVarAxiosParamCreator = FilesApiAxiosParamCreator(configuration);
|
|
2477
|
+
return {
|
|
2478
|
+
/**
|
|
2479
|
+
* Create a download uri for a `file` by ID.
|
|
2480
|
+
* @param {string} id The `file` ID.
|
|
2481
|
+
* @param {CreateDownloadRequest} createDownloadRequest
|
|
2482
|
+
* @param {*} [options] Override http request option.
|
|
2483
|
+
* @throws {RequiredError}
|
|
2484
|
+
*/
|
|
2485
|
+
createDownloadUrl(id, createDownloadRequest, options) {
|
|
2486
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2487
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createDownloadUrl(id, createDownloadRequest, options);
|
|
2488
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2489
|
+
});
|
|
2490
|
+
},
|
|
2491
|
+
/**
|
|
2492
|
+
* Create a `file`. Once created, upload file content via the uploadFile API. For details including supported file formats, see our [Import data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guide.
|
|
2493
|
+
* @param {CreateFileRequest} createFileRequest
|
|
2494
|
+
* @param {*} [options] Override http request option.
|
|
2495
|
+
* @throws {RequiredError}
|
|
2496
|
+
*/
|
|
2497
|
+
createFile(createFileRequest, options) {
|
|
2498
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2499
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createFile(createFileRequest, options);
|
|
2500
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2501
|
+
});
|
|
2502
|
+
},
|
|
2503
|
+
/**
|
|
2504
|
+
* Delete a `file`.
|
|
2505
|
+
* @param {string} id The `file` ID.
|
|
2506
|
+
* @param {*} [options] Override http request option.
|
|
2507
|
+
* @throws {RequiredError}
|
|
2508
|
+
*/
|
|
2509
|
+
deleteFile(id, options) {
|
|
2510
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2511
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteFile(id, options);
|
|
2512
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2513
|
+
});
|
|
2514
|
+
},
|
|
2515
|
+
/**
|
|
2516
|
+
* Get a `file` by ID.
|
|
2517
|
+
* @param {string} id The `file` ID.
|
|
2518
|
+
* @param {*} [options] Override http request option.
|
|
2519
|
+
* @throws {RequiredError}
|
|
2520
|
+
*/
|
|
2521
|
+
getFile(id, options) {
|
|
2522
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2523
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getFile(id, options);
|
|
2524
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2525
|
+
});
|
|
2526
|
+
},
|
|
2527
|
+
/**
|
|
2528
|
+
* Get `files`.
|
|
2529
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
2530
|
+
* @param {number} [pageSize] The number of items to return.
|
|
2531
|
+
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
2532
|
+
* @param {*} [options] Override http request option.
|
|
2533
|
+
* @throws {RequiredError}
|
|
2534
|
+
*/
|
|
2535
|
+
getFiles(pageCursor, pageSize, filterSuppliedId, options) {
|
|
2536
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2537
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getFiles(pageCursor, pageSize, filterSuppliedId, options);
|
|
2538
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2539
|
+
});
|
|
2540
|
+
},
|
|
2541
|
+
/**
|
|
2542
|
+
* Update a `file`.
|
|
2543
|
+
* @param {string} id The `file` ID.
|
|
2544
|
+
* @param {UpdateFileRequest} updateFileRequest
|
|
2545
|
+
* @param {*} [options] Override http request option.
|
|
2546
|
+
* @throws {RequiredError}
|
|
2547
|
+
*/
|
|
2548
|
+
updateFile(id, updateFileRequest, options) {
|
|
2549
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2550
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateFile(id, updateFileRequest, options);
|
|
2551
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2552
|
+
});
|
|
2553
|
+
},
|
|
2554
|
+
/**
|
|
2555
|
+
* Upload a `file`. Once uploaded, create either parts or geometry sets via the createPart or createGeometrySet APIs.
|
|
2556
|
+
* @param {string} id The `file` ID.
|
|
2557
|
+
* @param {any} body
|
|
2558
|
+
* @param {*} [options] Override http request option.
|
|
2559
|
+
* @throws {RequiredError}
|
|
2560
|
+
*/
|
|
2561
|
+
uploadFile(id, body, options) {
|
|
2562
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2563
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.uploadFile(id, body, options);
|
|
2564
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2565
|
+
});
|
|
2566
|
+
},
|
|
2567
|
+
};
|
|
2568
|
+
};
|
|
2569
|
+
/**
|
|
2570
|
+
* FilesApi - factory interface
|
|
2571
|
+
* @export
|
|
2572
|
+
*/
|
|
2573
|
+
export const FilesApiFactory = function (configuration, basePath, axios) {
|
|
2574
|
+
const localVarFp = FilesApiFp(configuration);
|
|
2575
|
+
return {
|
|
2576
|
+
/**
|
|
2577
|
+
* Create a download uri for a `file` by ID.
|
|
2578
|
+
* @param {string} id The `file` ID.
|
|
2579
|
+
* @param {CreateDownloadRequest} createDownloadRequest
|
|
2580
|
+
* @param {*} [options] Override http request option.
|
|
2581
|
+
* @throws {RequiredError}
|
|
2582
|
+
*/
|
|
2583
|
+
createDownloadUrl(id, createDownloadRequest, options) {
|
|
2584
|
+
return localVarFp
|
|
2585
|
+
.createDownloadUrl(id, createDownloadRequest, options)
|
|
2586
|
+
.then((request) => request(axios, basePath));
|
|
2587
|
+
},
|
|
2588
|
+
/**
|
|
2589
|
+
* Create a `file`. Once created, upload file content via the uploadFile API. For details including supported file formats, see our [Import data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guide.
|
|
2590
|
+
* @param {CreateFileRequest} createFileRequest
|
|
2591
|
+
* @param {*} [options] Override http request option.
|
|
2592
|
+
* @throws {RequiredError}
|
|
2593
|
+
*/
|
|
2594
|
+
createFile(createFileRequest, options) {
|
|
2595
|
+
return localVarFp
|
|
2596
|
+
.createFile(createFileRequest, options)
|
|
2597
|
+
.then((request) => request(axios, basePath));
|
|
2598
|
+
},
|
|
2599
|
+
/**
|
|
2600
|
+
* Delete a `file`.
|
|
2601
|
+
* @param {string} id The `file` ID.
|
|
2602
|
+
* @param {*} [options] Override http request option.
|
|
2603
|
+
* @throws {RequiredError}
|
|
2604
|
+
*/
|
|
2605
|
+
deleteFile(id, options) {
|
|
2606
|
+
return localVarFp
|
|
2607
|
+
.deleteFile(id, options)
|
|
2608
|
+
.then((request) => request(axios, basePath));
|
|
2609
|
+
},
|
|
2610
|
+
/**
|
|
2611
|
+
* Get a `file` by ID.
|
|
2612
|
+
* @param {string} id The `file` ID.
|
|
2613
|
+
* @param {*} [options] Override http request option.
|
|
2614
|
+
* @throws {RequiredError}
|
|
2615
|
+
*/
|
|
2616
|
+
getFile(id, options) {
|
|
2617
|
+
return localVarFp
|
|
2618
|
+
.getFile(id, options)
|
|
2619
|
+
.then((request) => request(axios, basePath));
|
|
2620
|
+
},
|
|
2621
|
+
/**
|
|
2622
|
+
* Get `files`.
|
|
2623
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
2624
|
+
* @param {number} [pageSize] The number of items to return.
|
|
2625
|
+
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
2626
|
+
* @param {*} [options] Override http request option.
|
|
2627
|
+
* @throws {RequiredError}
|
|
2628
|
+
*/
|
|
2629
|
+
getFiles(pageCursor, pageSize, filterSuppliedId, options) {
|
|
2630
|
+
return localVarFp
|
|
2631
|
+
.getFiles(pageCursor, pageSize, filterSuppliedId, options)
|
|
2632
|
+
.then((request) => request(axios, basePath));
|
|
2633
|
+
},
|
|
2634
|
+
/**
|
|
2635
|
+
* Update a `file`.
|
|
2636
|
+
* @param {string} id The `file` ID.
|
|
2637
|
+
* @param {UpdateFileRequest} updateFileRequest
|
|
2638
|
+
* @param {*} [options] Override http request option.
|
|
2639
|
+
* @throws {RequiredError}
|
|
2640
|
+
*/
|
|
2641
|
+
updateFile(id, updateFileRequest, options) {
|
|
2642
|
+
return localVarFp
|
|
2643
|
+
.updateFile(id, updateFileRequest, options)
|
|
2644
|
+
.then((request) => request(axios, basePath));
|
|
2645
|
+
},
|
|
2646
|
+
/**
|
|
2647
|
+
* Upload a `file`. Once uploaded, create either parts or geometry sets via the createPart or createGeometrySet APIs.
|
|
2648
|
+
* @param {string} id The `file` ID.
|
|
2649
|
+
* @param {any} body
|
|
2650
|
+
* @param {*} [options] Override http request option.
|
|
2651
|
+
* @throws {RequiredError}
|
|
2652
|
+
*/
|
|
2653
|
+
uploadFile(id, body, options) {
|
|
2654
|
+
return localVarFp
|
|
2655
|
+
.uploadFile(id, body, options)
|
|
2656
|
+
.then((request) => request(axios, basePath));
|
|
2657
|
+
},
|
|
2658
|
+
};
|
|
2659
|
+
};
|
|
2660
|
+
/**
|
|
2661
|
+
* FilesApi - object-oriented interface
|
|
2662
|
+
* @export
|
|
2663
|
+
* @class FilesApi
|
|
2664
|
+
* @extends {BaseAPI}
|
|
2665
|
+
*/
|
|
2666
|
+
export class FilesApi extends BaseAPI {
|
|
2667
|
+
/**
|
|
2668
|
+
* Create a download uri for a `file` by ID.
|
|
2669
|
+
* @param {FilesApiCreateDownloadUrlRequest} requestParameters Request parameters.
|
|
2670
|
+
* @param {*} [options] Override http request option.
|
|
2671
|
+
* @throws {RequiredError}
|
|
2672
|
+
* @memberof FilesApi
|
|
2673
|
+
*/
|
|
2674
|
+
createDownloadUrl(requestParameters, options) {
|
|
2675
|
+
return FilesApiFp(this.configuration)
|
|
2676
|
+
.createDownloadUrl(requestParameters.id, requestParameters.createDownloadRequest, options)
|
|
2677
|
+
.then((request) => request(this.axios, this.basePath));
|
|
2678
|
+
}
|
|
1800
2679
|
/**
|
|
1801
2680
|
* Create a `file`. Once created, upload file content via the uploadFile API. For details including supported file formats, see our [Import data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guide.
|
|
1802
2681
|
* @param {FilesApiCreateFileRequest} requestParameters Request parameters.
|
|
@@ -2939,7 +3818,7 @@ export class Oauth2Api extends BaseAPI {
|
|
|
2939
3818
|
export const PartRenditionsApiAxiosParamCreator = function (configuration) {
|
|
2940
3819
|
return {
|
|
2941
3820
|
/**
|
|
2942
|
-
*
|
|
3821
|
+
* Creates a part-rendition associated with a part-revision
|
|
2943
3822
|
* @param {string} id The `part-revision` ID.
|
|
2944
3823
|
* @param {CreatePartRenditionRequest} createPartRenditionRequest
|
|
2945
3824
|
* @param {*} [options] Override http request option.
|
|
@@ -3059,7 +3938,7 @@ export const PartRenditionsApiFp = function (configuration) {
|
|
|
3059
3938
|
const localVarAxiosParamCreator = PartRenditionsApiAxiosParamCreator(configuration);
|
|
3060
3939
|
return {
|
|
3061
3940
|
/**
|
|
3062
|
-
*
|
|
3941
|
+
* Creates a part-rendition associated with a part-revision
|
|
3063
3942
|
* @param {string} id The `part-revision` ID.
|
|
3064
3943
|
* @param {CreatePartRenditionRequest} createPartRenditionRequest
|
|
3065
3944
|
* @param {*} [options] Override http request option.
|
|
@@ -3108,7 +3987,7 @@ export const PartRenditionsApiFactory = function (configuration, basePath, axios
|
|
|
3108
3987
|
const localVarFp = PartRenditionsApiFp(configuration);
|
|
3109
3988
|
return {
|
|
3110
3989
|
/**
|
|
3111
|
-
*
|
|
3990
|
+
* Creates a part-rendition associated with a part-revision
|
|
3112
3991
|
* @param {string} id The `part-revision` ID.
|
|
3113
3992
|
* @param {CreatePartRenditionRequest} createPartRenditionRequest
|
|
3114
3993
|
* @param {*} [options] Override http request option.
|
|
@@ -3154,7 +4033,7 @@ export const PartRenditionsApiFactory = function (configuration, basePath, axios
|
|
|
3154
4033
|
*/
|
|
3155
4034
|
export class PartRenditionsApi extends BaseAPI {
|
|
3156
4035
|
/**
|
|
3157
|
-
*
|
|
4036
|
+
* Creates a part-rendition associated with a part-revision
|
|
3158
4037
|
* @param {PartRenditionsApiCreatePartRenditionRequest} requestParameters Request parameters.
|
|
3159
4038
|
* @param {*} [options] Override http request option.
|
|
3160
4039
|
* @throws {RequiredError}
|
|
@@ -3197,7 +4076,7 @@ export class PartRenditionsApi extends BaseAPI {
|
|
|
3197
4076
|
export const PartRevisionInstancesApiAxiosParamCreator = function (configuration) {
|
|
3198
4077
|
return {
|
|
3199
4078
|
/**
|
|
3200
|
-
* Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal
|
|
4079
|
+
* Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
|
|
3201
4080
|
* @param {string} [filterParent] Parent ID to filter on.
|
|
3202
4081
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
3203
4082
|
* @param {number} [pageSize] The number of items to return.
|
|
@@ -3246,7 +4125,7 @@ export const PartRevisionInstancesApiFp = function (configuration) {
|
|
|
3246
4125
|
const localVarAxiosParamCreator = PartRevisionInstancesApiAxiosParamCreator(configuration);
|
|
3247
4126
|
return {
|
|
3248
4127
|
/**
|
|
3249
|
-
* Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal
|
|
4128
|
+
* Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
|
|
3250
4129
|
* @param {string} [filterParent] Parent ID to filter on.
|
|
3251
4130
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
3252
4131
|
* @param {number} [pageSize] The number of items to return.
|
|
@@ -3269,7 +4148,7 @@ export const PartRevisionInstancesApiFactory = function (configuration, basePath
|
|
|
3269
4148
|
const localVarFp = PartRevisionInstancesApiFp(configuration);
|
|
3270
4149
|
return {
|
|
3271
4150
|
/**
|
|
3272
|
-
* Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal
|
|
4151
|
+
* Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
|
|
3273
4152
|
* @param {string} [filterParent] Parent ID to filter on.
|
|
3274
4153
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
3275
4154
|
* @param {number} [pageSize] The number of items to return.
|
|
@@ -3291,7 +4170,7 @@ export const PartRevisionInstancesApiFactory = function (configuration, basePath
|
|
|
3291
4170
|
*/
|
|
3292
4171
|
export class PartRevisionInstancesApi extends BaseAPI {
|
|
3293
4172
|
/**
|
|
3294
|
-
* Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal
|
|
4173
|
+
* Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
|
|
3295
4174
|
* @param {PartRevisionInstancesApiGetPartRevisionInstanceListRequest} requestParameters Request parameters.
|
|
3296
4175
|
* @param {*} [options] Override http request option.
|
|
3297
4176
|
* @throws {RequiredError}
|
|
@@ -3535,7 +4414,7 @@ export const PartRevisionsApiAxiosParamCreator = function (configuration) {
|
|
|
3535
4414
|
};
|
|
3536
4415
|
}),
|
|
3537
4416
|
/**
|
|
3538
|
-
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes.
|
|
4417
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
3539
4418
|
* @param {string} id The `part-revision` ID.
|
|
3540
4419
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
3541
4420
|
* @param {*} [options] Override http request option.
|
|
@@ -3656,7 +4535,7 @@ export const PartRevisionsApiFp = function (configuration) {
|
|
|
3656
4535
|
});
|
|
3657
4536
|
},
|
|
3658
4537
|
/**
|
|
3659
|
-
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes.
|
|
4538
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
3660
4539
|
* @param {string} id The `part-revision` ID.
|
|
3661
4540
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
3662
4541
|
* @param {*} [options] Override http request option.
|
|
@@ -3749,7 +4628,7 @@ export const PartRevisionsApiFactory = function (configuration, basePath, axios)
|
|
|
3749
4628
|
.then((request) => request(axios, basePath));
|
|
3750
4629
|
},
|
|
3751
4630
|
/**
|
|
3752
|
-
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes.
|
|
4631
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
3753
4632
|
* @param {string} id The `part-revision` ID.
|
|
3754
4633
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
3755
4634
|
* @param {*} [options] Override http request option.
|
|
@@ -3830,7 +4709,7 @@ export class PartRevisionsApi extends BaseAPI {
|
|
|
3830
4709
|
.then((request) => request(this.axios, this.basePath));
|
|
3831
4710
|
}
|
|
3832
4711
|
/**
|
|
3833
|
-
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes.
|
|
4712
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
3834
4713
|
* @param {PartRevisionsApiUpdatePartRevisionRequest} requestParameters Request parameters.
|
|
3835
4714
|
* @param {*} [options] Override http request option.
|
|
3836
4715
|
* @throws {RequiredError}
|
|
@@ -3849,7 +4728,7 @@ export class PartRevisionsApi extends BaseAPI {
|
|
|
3849
4728
|
export const PartsApiAxiosParamCreator = function (configuration) {
|
|
3850
4729
|
return {
|
|
3851
4730
|
/**
|
|
3852
|
-
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201`
|
|
4731
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
3853
4732
|
* @param {CreatePartRequest} createPartRequest
|
|
3854
4733
|
* @param {*} [options] Override http request option.
|
|
3855
4734
|
* @throws {RequiredError}
|
|
@@ -4028,7 +4907,7 @@ export const PartsApiFp = function (configuration) {
|
|
|
4028
4907
|
const localVarAxiosParamCreator = PartsApiAxiosParamCreator(configuration);
|
|
4029
4908
|
return {
|
|
4030
4909
|
/**
|
|
4031
|
-
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201`
|
|
4910
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
4032
4911
|
* @param {CreatePartRequest} createPartRequest
|
|
4033
4912
|
* @param {*} [options] Override http request option.
|
|
4034
4913
|
* @throws {RequiredError}
|
|
@@ -4100,7 +4979,7 @@ export const PartsApiFactory = function (configuration, basePath, axios) {
|
|
|
4100
4979
|
const localVarFp = PartsApiFp(configuration);
|
|
4101
4980
|
return {
|
|
4102
4981
|
/**
|
|
4103
|
-
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201`
|
|
4982
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
4104
4983
|
* @param {CreatePartRequest} createPartRequest
|
|
4105
4984
|
* @param {*} [options] Override http request option.
|
|
4106
4985
|
* @throws {RequiredError}
|
|
@@ -4167,7 +5046,7 @@ export const PartsApiFactory = function (configuration, basePath, axios) {
|
|
|
4167
5046
|
*/
|
|
4168
5047
|
export class PartsApi extends BaseAPI {
|
|
4169
5048
|
/**
|
|
4170
|
-
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201`
|
|
5049
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
4171
5050
|
* @param {PartsApiCreatePartRequest} requestParameters Request parameters.
|
|
4172
5051
|
* @param {*} [options] Override http request option.
|
|
4173
5052
|
* @throws {RequiredError}
|
|
@@ -4347,7 +5226,7 @@ export class PmiApi extends BaseAPI {
|
|
|
4347
5226
|
export const PropertyEntriesApiAxiosParamCreator = function (configuration) {
|
|
4348
5227
|
return {
|
|
4349
5228
|
/**
|
|
4350
|
-
* Get `property-entries` by a resource ID
|
|
5229
|
+
* Get `property-entries` by a resource ID
|
|
4351
5230
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
4352
5231
|
* @param {number} [pageSize] The number of items to return.
|
|
4353
5232
|
* @param {string} [filterResourceId] A resource ID to filter on
|
|
@@ -4391,7 +5270,7 @@ export const PropertyEntriesApiAxiosParamCreator = function (configuration) {
|
|
|
4391
5270
|
};
|
|
4392
5271
|
}),
|
|
4393
5272
|
/**
|
|
4394
|
-
* Upsert property-entries for a provided resource.
|
|
5273
|
+
* Upsert property-entries for a provided resource.
|
|
4395
5274
|
* @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
|
|
4396
5275
|
* @param {*} [options] Override http request option.
|
|
4397
5276
|
* @throws {RequiredError}
|
|
@@ -4433,7 +5312,7 @@ export const PropertyEntriesApiFp = function (configuration) {
|
|
|
4433
5312
|
const localVarAxiosParamCreator = PropertyEntriesApiAxiosParamCreator(configuration);
|
|
4434
5313
|
return {
|
|
4435
5314
|
/**
|
|
4436
|
-
* Get `property-entries` by a resource ID
|
|
5315
|
+
* Get `property-entries` by a resource ID
|
|
4437
5316
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
4438
5317
|
* @param {number} [pageSize] The number of items to return.
|
|
4439
5318
|
* @param {string} [filterResourceId] A resource ID to filter on
|
|
@@ -4448,7 +5327,7 @@ export const PropertyEntriesApiFp = function (configuration) {
|
|
|
4448
5327
|
});
|
|
4449
5328
|
},
|
|
4450
5329
|
/**
|
|
4451
|
-
* Upsert property-entries for a provided resource.
|
|
5330
|
+
* Upsert property-entries for a provided resource.
|
|
4452
5331
|
* @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
|
|
4453
5332
|
* @param {*} [options] Override http request option.
|
|
4454
5333
|
* @throws {RequiredError}
|
|
@@ -4469,7 +5348,7 @@ export const PropertyEntriesApiFactory = function (configuration, basePath, axio
|
|
|
4469
5348
|
const localVarFp = PropertyEntriesApiFp(configuration);
|
|
4470
5349
|
return {
|
|
4471
5350
|
/**
|
|
4472
|
-
* Get `property-entries` by a resource ID
|
|
5351
|
+
* Get `property-entries` by a resource ID
|
|
4473
5352
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
4474
5353
|
* @param {number} [pageSize] The number of items to return.
|
|
4475
5354
|
* @param {string} [filterResourceId] A resource ID to filter on
|
|
@@ -4483,7 +5362,7 @@ export const PropertyEntriesApiFactory = function (configuration, basePath, axio
|
|
|
4483
5362
|
.then((request) => request(axios, basePath));
|
|
4484
5363
|
},
|
|
4485
5364
|
/**
|
|
4486
|
-
* Upsert property-entries for a provided resource.
|
|
5365
|
+
* Upsert property-entries for a provided resource.
|
|
4487
5366
|
* @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
|
|
4488
5367
|
* @param {*} [options] Override http request option.
|
|
4489
5368
|
* @throws {RequiredError}
|
|
@@ -4503,7 +5382,7 @@ export const PropertyEntriesApiFactory = function (configuration, basePath, axio
|
|
|
4503
5382
|
*/
|
|
4504
5383
|
export class PropertyEntriesApi extends BaseAPI {
|
|
4505
5384
|
/**
|
|
4506
|
-
* Get `property-entries` by a resource ID
|
|
5385
|
+
* Get `property-entries` by a resource ID
|
|
4507
5386
|
* @param {PropertyEntriesApiGetPropertyEntriesRequest} requestParameters Request parameters.
|
|
4508
5387
|
* @param {*} [options] Override http request option.
|
|
4509
5388
|
* @throws {RequiredError}
|
|
@@ -4515,7 +5394,7 @@ export class PropertyEntriesApi extends BaseAPI {
|
|
|
4515
5394
|
.then((request) => request(this.axios, this.basePath));
|
|
4516
5395
|
}
|
|
4517
5396
|
/**
|
|
4518
|
-
* Upsert property-entries for a provided resource.
|
|
5397
|
+
* Upsert property-entries for a provided resource.
|
|
4519
5398
|
* @param {PropertyEntriesApiUpsertPropertyEntriesRequest} requestParameters Request parameters.
|
|
4520
5399
|
* @param {*} [options] Override http request option.
|
|
4521
5400
|
* @throws {RequiredError}
|