@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/cjs/api.js
CHANGED
|
@@ -25,9 +25,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
25
25
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
26
26
|
};
|
|
27
27
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
28
|
-
exports.
|
|
29
|
-
exports.
|
|
30
|
-
exports.
|
|
28
|
+
exports.ViewRenBySuppliedIdOpTypeEnum = exports.ViewRenByIdOpTypeEnum = exports.ViewDefaultRenOpTypeEnum = exports.UpdateWebhookSubscriptionRequestDataAttributesStatusEnum = exports.UpdateSceneRequestDataAttributesStateEnum = exports.UpdateItemToDefaultRenditionOperationTypeEnum = exports.UpdateFileCollectionRequestDataTypeEnum = exports.UpdateAccountRequestDataAttributesStatusEnum = exports.SelectOpTypeEnum = exports.SelectFileBySuppliedIdTypeEnum = exports.SelectFileByIdTypeEnum = exports.SceneViewStateRelationshipDataTypeEnum = exports.SceneViewRelationshipDataTypeEnum = exports.SceneRelationshipDataTypeEnum = exports.SceneItemRelationshipDataTypeEnum = exports.QueryByMetadataDataTypeEnum = exports.QueryByIdDataAttributesTypeEnum = exports.QueryByIdDataTypeEnum = exports.QueryByCollectionDataAttributesTypeEnum = exports.QueryByCollectionDataTypeEnum = exports.QueryAll = exports.PropertyStringTypeTypeEnum = exports.PropertySetRelationshipDataTypeEnum = exports.PropertyLongTypeTypeEnum = exports.PropertyDoubleTypeTypeEnum = exports.PropertyDateTypeTypeEnum = exports.PartRenditionRelationshipDataTypeEnum = exports.PartRelationshipDataTypeEnum = exports.PartInstanceRelationshipDataTypeEnum = exports.PartDataRelationshipsPartRevisionsTypeEnum = exports.GeometrySetRelationshipDataTypeEnum = exports.FileRelationshipDataTypeEnum = exports.FileJobArchiveOperationTypeEnum = exports.FileCollectionMetadataDataTypeEnum = exports.ExportStateRelationshipDataTypeEnum = exports.ExportRelationshipDataTypeEnum = exports.DeselectOperationTypeEnum = exports.CreateSceneItemRequestDataAttributesResolutionRuleEnum = exports.CreateFileJobRequestDataTypeEnum = exports.CreateFileCollectionRequestDataTypeEnum = exports.ClearTransformOpTypeEnum = exports.ClearRepOpTypeEnum = exports.ClearRenOpTypeEnum = exports.ClearMaterialOpTypeEnum = exports.ChangeVisibilityOpTypeEnum = exports.ChangeTransformOpTypeEnum = exports.ChangeMaterialOpTypeEnum = exports.CameraFitTypeEnum = exports.BatchOperationRefTypeEnum = exports.BatchOperationOpEnum = void 0;
|
|
29
|
+
exports.PartRenditionsApiAxiosParamCreator = exports.Oauth2Api = exports.Oauth2ApiFactory = exports.Oauth2ApiFp = exports.Oauth2ApiAxiosParamCreator = exports.ModelViewsApi = exports.ModelViewsApiFactory = exports.ModelViewsApiFp = exports.ModelViewsApiAxiosParamCreator = exports.HitsApi = exports.HitsApiFactory = exports.HitsApiFp = exports.HitsApiAxiosParamCreator = exports.GeometrySetsApi = exports.GeometrySetsApiFactory = exports.GeometrySetsApiFp = exports.GeometrySetsApiAxiosParamCreator = exports.FilesApi = exports.FilesApiFactory = exports.FilesApiFp = exports.FilesApiAxiosParamCreator = exports.FileJobsApi = exports.FileJobsApiFactory = exports.FileJobsApiFp = exports.FileJobsApiAxiosParamCreator = exports.FileCollectionsApi = exports.FileCollectionsApiFactory = exports.FileCollectionsApiFp = exports.FileCollectionsApiAxiosParamCreator = exports.ExportsApi = exports.ExportsApiFactory = exports.ExportsApiFp = exports.ExportsApiAxiosParamCreator = exports.BatchesApi = exports.BatchesApiFactory = exports.BatchesApiFp = exports.BatchesApiAxiosParamCreator = exports.ApplicationsApi = exports.ApplicationsApiFactory = exports.ApplicationsApiFp = exports.ApplicationsApiAxiosParamCreator = exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.WebhookSubscriptionDataAttributesStatusEnum = exports.WebhookEventDataRelationshipsOwnerDataTypeEnum = exports.ViewRepByPredefinedIdOpIdEnum = exports.ViewRepByPredefinedIdOpTypeEnum = exports.ViewRepByIdOpTypeEnum = void 0;
|
|
30
|
+
exports.SceneViewsApiFactory = exports.SceneViewsApiFp = exports.SceneViewsApiAxiosParamCreator = exports.SceneViewStatesApi = exports.SceneViewStatesApiFactory = exports.SceneViewStatesApiFp = exports.SceneViewStatesApiAxiosParamCreator = exports.SceneSynchronizationsApi = exports.SceneSynchronizationsApiFactory = exports.SceneSynchronizationsApiFp = exports.SceneSynchronizationsApiAxiosParamCreator = exports.SceneItemsApi = exports.SceneItemsApiFactory = exports.SceneItemsApiFp = exports.SceneItemsApiAxiosParamCreator = exports.SceneItemOverridesApi = exports.SceneItemOverridesApiFactory = exports.SceneItemOverridesApiFp = exports.SceneItemOverridesApiAxiosParamCreator = exports.SceneAnnotationsApi = exports.SceneAnnotationsApiFactory = exports.SceneAnnotationsApiFp = exports.SceneAnnotationsApiAxiosParamCreator = exports.SceneAlterationsApi = exports.SceneAlterationsApiFactory = exports.SceneAlterationsApiFp = exports.SceneAlterationsApiAxiosParamCreator = exports.PropertyEntriesApi = exports.PropertyEntriesApiFactory = exports.PropertyEntriesApiFp = exports.PropertyEntriesApiAxiosParamCreator = exports.PmiApi = exports.PmiApiFactory = exports.PmiApiFp = exports.PmiApiAxiosParamCreator = exports.PartsApi = exports.PartsApiFactory = exports.PartsApiFp = exports.PartsApiAxiosParamCreator = exports.PartRevisionsApi = exports.PartRevisionsApiFactory = exports.PartRevisionsApiFp = exports.PartRevisionsApiAxiosParamCreator = exports.PartRevisionInstancesApi = exports.PartRevisionInstancesApiFactory = exports.PartRevisionInstancesApiFp = exports.PartRevisionInstancesApiAxiosParamCreator = exports.PartRenditionsApi = exports.PartRenditionsApiFactory = exports.PartRenditionsApiFp = void 0;
|
|
31
|
+
exports.WebhookSubscriptionsApi = exports.WebhookSubscriptionsApiFactory = exports.WebhookSubscriptionsApiFp = exports.WebhookSubscriptionsApiAxiosParamCreator = exports.TranslationInspectionsApi = exports.TranslationInspectionsApiFactory = exports.TranslationInspectionsApiFp = exports.TranslationInspectionsApiAxiosParamCreator = exports.StreamKeysApi = exports.StreamKeysApiFactory = exports.StreamKeysApiFp = exports.StreamKeysApiAxiosParamCreator = exports.ScenesApi = exports.ScenesApiFactory = exports.ScenesApiFp = exports.ScenesApiAxiosParamCreator = exports.SceneViewsApi = void 0;
|
|
31
32
|
const axios_1 = __importDefault(require("axios"));
|
|
32
33
|
// Some imports not used depending on template conditions
|
|
33
34
|
// @ts-ignore
|
|
@@ -65,6 +66,17 @@ exports.ClearRepOpTypeEnum = {
|
|
|
65
66
|
exports.ClearTransformOpTypeEnum = {
|
|
66
67
|
ClearTransform: 'clear-transform',
|
|
67
68
|
};
|
|
69
|
+
exports.CreateFileCollectionRequestDataTypeEnum = {
|
|
70
|
+
FileCollection: 'file-collection',
|
|
71
|
+
};
|
|
72
|
+
exports.CreateFileJobRequestDataTypeEnum = {
|
|
73
|
+
FileJob: 'file-job',
|
|
74
|
+
};
|
|
75
|
+
exports.CreateSceneItemRequestDataAttributesResolutionRuleEnum = {
|
|
76
|
+
AsSpecified: 'as-specified',
|
|
77
|
+
LatestIteration: 'latest-iteration',
|
|
78
|
+
LatestRevision: 'latest-revision',
|
|
79
|
+
};
|
|
68
80
|
exports.DeselectOperationTypeEnum = {
|
|
69
81
|
Deselect: 'deselect',
|
|
70
82
|
};
|
|
@@ -74,6 +86,12 @@ exports.ExportRelationshipDataTypeEnum = {
|
|
|
74
86
|
exports.ExportStateRelationshipDataTypeEnum = {
|
|
75
87
|
SceneViewState: 'scene-view-state',
|
|
76
88
|
};
|
|
89
|
+
exports.FileCollectionMetadataDataTypeEnum = {
|
|
90
|
+
FileCollection: 'file-collection',
|
|
91
|
+
};
|
|
92
|
+
exports.FileJobArchiveOperationTypeEnum = {
|
|
93
|
+
FileArchiveOperation: 'file-archive-operation',
|
|
94
|
+
};
|
|
77
95
|
exports.FileRelationshipDataTypeEnum = {
|
|
78
96
|
File: 'file',
|
|
79
97
|
};
|
|
@@ -129,6 +147,9 @@ exports.QueryByIdDataAttributesTypeEnum = {
|
|
|
129
147
|
Id: 'id',
|
|
130
148
|
SuppliedId: 'suppliedId',
|
|
131
149
|
};
|
|
150
|
+
exports.QueryByMetadataDataTypeEnum = {
|
|
151
|
+
QueryByMetadata: 'query-by-metadata',
|
|
152
|
+
};
|
|
132
153
|
exports.SceneItemRelationshipDataTypeEnum = {
|
|
133
154
|
SceneItem: 'scene-item',
|
|
134
155
|
};
|
|
@@ -141,6 +162,12 @@ exports.SceneViewRelationshipDataTypeEnum = {
|
|
|
141
162
|
exports.SceneViewStateRelationshipDataTypeEnum = {
|
|
142
163
|
SceneViewState: 'scene-view-state',
|
|
143
164
|
};
|
|
165
|
+
exports.SelectFileByIdTypeEnum = {
|
|
166
|
+
FileById: 'file-by-id',
|
|
167
|
+
};
|
|
168
|
+
exports.SelectFileBySuppliedIdTypeEnum = {
|
|
169
|
+
FileBySuppliedId: 'file-by-supplied-id',
|
|
170
|
+
};
|
|
144
171
|
exports.SelectOpTypeEnum = {
|
|
145
172
|
Select: 'select',
|
|
146
173
|
};
|
|
@@ -148,6 +175,9 @@ exports.UpdateAccountRequestDataAttributesStatusEnum = {
|
|
|
148
175
|
Active: 'active',
|
|
149
176
|
Disabled: 'disabled',
|
|
150
177
|
};
|
|
178
|
+
exports.UpdateFileCollectionRequestDataTypeEnum = {
|
|
179
|
+
FileCollection: 'file-collection',
|
|
180
|
+
};
|
|
151
181
|
exports.UpdateItemToDefaultRenditionOperationTypeEnum = {
|
|
152
182
|
UpdateToDefaultRendition: 'update-to-default-rendition',
|
|
153
183
|
};
|
|
@@ -1436,22 +1466,25 @@ class ExportsApi extends base_1.BaseAPI {
|
|
|
1436
1466
|
}
|
|
1437
1467
|
exports.ExportsApi = ExportsApi;
|
|
1438
1468
|
/**
|
|
1439
|
-
*
|
|
1469
|
+
* FileCollectionsApi - axios parameter creator
|
|
1440
1470
|
* @export
|
|
1441
1471
|
*/
|
|
1442
|
-
const
|
|
1472
|
+
const FileCollectionsApiAxiosParamCreator = function (configuration) {
|
|
1443
1473
|
return {
|
|
1444
1474
|
/**
|
|
1445
|
-
*
|
|
1446
|
-
* @param {
|
|
1475
|
+
* Add files to a `file-collection`.
|
|
1476
|
+
* @param {string} id The `file-collection` ID.
|
|
1477
|
+
* @param {FileIdList} fileIdList
|
|
1447
1478
|
* @param {*} [options] Override http request option.
|
|
1448
1479
|
* @throws {RequiredError}
|
|
1449
1480
|
*/
|
|
1450
|
-
|
|
1481
|
+
addFileCollectionFiles: (id, fileIdList, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1451
1482
|
var _a;
|
|
1452
|
-
// verify required parameter '
|
|
1453
|
-
(0, common_1.assertParamExists)('
|
|
1454
|
-
|
|
1483
|
+
// verify required parameter 'id' is not null or undefined
|
|
1484
|
+
(0, common_1.assertParamExists)('addFileCollectionFiles', 'id', id);
|
|
1485
|
+
// verify required parameter 'fileIdList' is not null or undefined
|
|
1486
|
+
(0, common_1.assertParamExists)('addFileCollectionFiles', 'fileIdList', fileIdList);
|
|
1487
|
+
const localVarPath = `/file-collections/{id}/files`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
1455
1488
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1456
1489
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1457
1490
|
let baseOptions;
|
|
@@ -1468,61 +1501,63 @@ const FilesApiAxiosParamCreator = function (configuration) {
|
|
|
1468
1501
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1469
1502
|
let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
|
|
1470
1503
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1471
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(
|
|
1504
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(fileIdList, localVarRequestOptions, configuration);
|
|
1472
1505
|
return {
|
|
1473
1506
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1474
1507
|
options: localVarRequestOptions,
|
|
1475
1508
|
};
|
|
1476
1509
|
}),
|
|
1477
1510
|
/**
|
|
1478
|
-
*
|
|
1479
|
-
* @param {
|
|
1511
|
+
* Create a `file-collection`.
|
|
1512
|
+
* @param {CreateFileCollectionRequest} createFileCollectionRequest
|
|
1480
1513
|
* @param {*} [options] Override http request option.
|
|
1481
1514
|
* @throws {RequiredError}
|
|
1482
1515
|
*/
|
|
1483
|
-
|
|
1516
|
+
createFileCollection: (createFileCollectionRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1484
1517
|
var _b;
|
|
1485
|
-
// verify required parameter '
|
|
1486
|
-
(0, common_1.assertParamExists)('
|
|
1487
|
-
const localVarPath = `/
|
|
1518
|
+
// verify required parameter 'createFileCollectionRequest' is not null or undefined
|
|
1519
|
+
(0, common_1.assertParamExists)('createFileCollection', 'createFileCollectionRequest', createFileCollectionRequest);
|
|
1520
|
+
const localVarPath = `/file-collections`;
|
|
1488
1521
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1489
1522
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1490
1523
|
let baseOptions;
|
|
1491
1524
|
if (configuration) {
|
|
1492
1525
|
baseOptions = configuration.baseOptions;
|
|
1493
1526
|
}
|
|
1494
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
1527
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
1495
1528
|
const localVarHeaderParameter = {};
|
|
1496
1529
|
const localVarQueryParameter = {};
|
|
1497
1530
|
// authentication OAuth2 required
|
|
1498
1531
|
// oauth required
|
|
1499
1532
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
1533
|
+
localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
|
|
1500
1534
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1501
1535
|
let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
|
|
1502
1536
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1537
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createFileCollectionRequest, localVarRequestOptions, configuration);
|
|
1503
1538
|
return {
|
|
1504
1539
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1505
1540
|
options: localVarRequestOptions,
|
|
1506
1541
|
};
|
|
1507
1542
|
}),
|
|
1508
1543
|
/**
|
|
1509
|
-
*
|
|
1510
|
-
* @param {string} id The `file` ID.
|
|
1544
|
+
* Delete a `file-collection`.
|
|
1545
|
+
* @param {string} id The `file-collection` ID.
|
|
1511
1546
|
* @param {*} [options] Override http request option.
|
|
1512
1547
|
* @throws {RequiredError}
|
|
1513
1548
|
*/
|
|
1514
|
-
|
|
1549
|
+
deleteFileCollection: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1515
1550
|
var _c;
|
|
1516
1551
|
// verify required parameter 'id' is not null or undefined
|
|
1517
|
-
(0, common_1.assertParamExists)('
|
|
1518
|
-
const localVarPath = `/
|
|
1552
|
+
(0, common_1.assertParamExists)('deleteFileCollection', 'id', id);
|
|
1553
|
+
const localVarPath = `/file-collections/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
1519
1554
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1520
1555
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1521
1556
|
let baseOptions;
|
|
1522
1557
|
if (configuration) {
|
|
1523
1558
|
baseOptions = configuration.baseOptions;
|
|
1524
1559
|
}
|
|
1525
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
1560
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
1526
1561
|
const localVarHeaderParameter = {};
|
|
1527
1562
|
const localVarQueryParameter = {};
|
|
1528
1563
|
// authentication OAuth2 required
|
|
@@ -1537,16 +1572,86 @@ const FilesApiAxiosParamCreator = function (configuration) {
|
|
|
1537
1572
|
};
|
|
1538
1573
|
}),
|
|
1539
1574
|
/**
|
|
1540
|
-
* Get `
|
|
1575
|
+
* Get a `file-collection` by ID.
|
|
1576
|
+
* @param {string} id The `file-collection` ID.
|
|
1577
|
+
* @param {*} [options] Override http request option.
|
|
1578
|
+
* @throws {RequiredError}
|
|
1579
|
+
*/
|
|
1580
|
+
getFileCollection: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1581
|
+
var _d;
|
|
1582
|
+
// verify required parameter 'id' is not null or undefined
|
|
1583
|
+
(0, common_1.assertParamExists)('getFileCollection', 'id', id);
|
|
1584
|
+
const localVarPath = `/file-collections/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
1585
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1586
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1587
|
+
let baseOptions;
|
|
1588
|
+
if (configuration) {
|
|
1589
|
+
baseOptions = configuration.baseOptions;
|
|
1590
|
+
}
|
|
1591
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1592
|
+
const localVarHeaderParameter = {};
|
|
1593
|
+
const localVarQueryParameter = {};
|
|
1594
|
+
// authentication OAuth2 required
|
|
1595
|
+
// oauth required
|
|
1596
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
1597
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1598
|
+
let headersFromBaseOptions = (_d = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _d !== void 0 ? _d : {};
|
|
1599
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1600
|
+
return {
|
|
1601
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1602
|
+
options: localVarRequestOptions,
|
|
1603
|
+
};
|
|
1604
|
+
}),
|
|
1605
|
+
/**
|
|
1606
|
+
* List the files in a `file-collection`.
|
|
1607
|
+
* @param {string} id The `file-collection` ID.
|
|
1608
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
1609
|
+
* @param {number} [pageSize] The number of items to return.
|
|
1610
|
+
* @param {*} [options] Override http request option.
|
|
1611
|
+
* @throws {RequiredError}
|
|
1612
|
+
*/
|
|
1613
|
+
listFileCollectionFiles: (id, pageCursor, pageSize, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1614
|
+
var _e;
|
|
1615
|
+
// verify required parameter 'id' is not null or undefined
|
|
1616
|
+
(0, common_1.assertParamExists)('listFileCollectionFiles', 'id', id);
|
|
1617
|
+
const localVarPath = `/file-collections/{id}/files`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
1618
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1619
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1620
|
+
let baseOptions;
|
|
1621
|
+
if (configuration) {
|
|
1622
|
+
baseOptions = configuration.baseOptions;
|
|
1623
|
+
}
|
|
1624
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1625
|
+
const localVarHeaderParameter = {};
|
|
1626
|
+
const localVarQueryParameter = {};
|
|
1627
|
+
// authentication OAuth2 required
|
|
1628
|
+
// oauth required
|
|
1629
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
1630
|
+
if (pageCursor !== undefined) {
|
|
1631
|
+
localVarQueryParameter['page[cursor]'] = pageCursor;
|
|
1632
|
+
}
|
|
1633
|
+
if (pageSize !== undefined) {
|
|
1634
|
+
localVarQueryParameter['page[size]'] = pageSize;
|
|
1635
|
+
}
|
|
1636
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1637
|
+
let headersFromBaseOptions = (_e = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _e !== void 0 ? _e : {};
|
|
1638
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1639
|
+
return {
|
|
1640
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1641
|
+
options: localVarRequestOptions,
|
|
1642
|
+
};
|
|
1643
|
+
}),
|
|
1644
|
+
/**
|
|
1645
|
+
* List `file-collection`s by supplied ID.
|
|
1541
1646
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
1542
1647
|
* @param {number} [pageSize] The number of items to return.
|
|
1543
1648
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
1544
1649
|
* @param {*} [options] Override http request option.
|
|
1545
1650
|
* @throws {RequiredError}
|
|
1546
1651
|
*/
|
|
1547
|
-
|
|
1548
|
-
var
|
|
1549
|
-
const localVarPath = `/
|
|
1652
|
+
listFileCollections: (pageCursor, pageSize, filterSuppliedId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1653
|
+
var _f;
|
|
1654
|
+
const localVarPath = `/file-collections`;
|
|
1550
1655
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1551
1656
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1552
1657
|
let baseOptions;
|
|
@@ -1569,7 +1674,7 @@ const FilesApiAxiosParamCreator = function (configuration) {
|
|
|
1569
1674
|
localVarQueryParameter['filter[suppliedId]'] = filterSuppliedId;
|
|
1570
1675
|
}
|
|
1571
1676
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1572
|
-
let headersFromBaseOptions = (
|
|
1677
|
+
let headersFromBaseOptions = (_f = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _f !== void 0 ? _f : {};
|
|
1573
1678
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1574
1679
|
return {
|
|
1575
1680
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
@@ -1577,72 +1682,71 @@ const FilesApiAxiosParamCreator = function (configuration) {
|
|
|
1577
1682
|
};
|
|
1578
1683
|
}),
|
|
1579
1684
|
/**
|
|
1580
|
-
*
|
|
1581
|
-
* @param {string} id The `file` ID.
|
|
1582
|
-
* @param {
|
|
1685
|
+
* Remove a file from a `file-collection`.
|
|
1686
|
+
* @param {string} id The `file-collection` ID.
|
|
1687
|
+
* @param {string} [filterFileId] Comma-separated list of file-ids to filter on.
|
|
1583
1688
|
* @param {*} [options] Override http request option.
|
|
1584
1689
|
* @throws {RequiredError}
|
|
1585
1690
|
*/
|
|
1586
|
-
|
|
1587
|
-
var
|
|
1691
|
+
removeFileCollectionFiles: (id, filterFileId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1692
|
+
var _g;
|
|
1588
1693
|
// verify required parameter 'id' is not null or undefined
|
|
1589
|
-
(0, common_1.assertParamExists)('
|
|
1590
|
-
|
|
1591
|
-
(0, common_1.assertParamExists)('updateFile', 'updateFileRequest', updateFileRequest);
|
|
1592
|
-
const localVarPath = `/files/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
1694
|
+
(0, common_1.assertParamExists)('removeFileCollectionFiles', 'id', id);
|
|
1695
|
+
const localVarPath = `/file-collections/{id}/files`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
1593
1696
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1594
1697
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1595
1698
|
let baseOptions;
|
|
1596
1699
|
if (configuration) {
|
|
1597
1700
|
baseOptions = configuration.baseOptions;
|
|
1598
1701
|
}
|
|
1599
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
1702
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
1600
1703
|
const localVarHeaderParameter = {};
|
|
1601
1704
|
const localVarQueryParameter = {};
|
|
1602
1705
|
// authentication OAuth2 required
|
|
1603
1706
|
// oauth required
|
|
1604
1707
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
1605
|
-
|
|
1708
|
+
if (filterFileId !== undefined) {
|
|
1709
|
+
localVarQueryParameter['filter[fileId]'] = filterFileId;
|
|
1710
|
+
}
|
|
1606
1711
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1607
|
-
let headersFromBaseOptions = (
|
|
1712
|
+
let headersFromBaseOptions = (_g = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _g !== void 0 ? _g : {};
|
|
1608
1713
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1609
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateFileRequest, localVarRequestOptions, configuration);
|
|
1610
1714
|
return {
|
|
1611
1715
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1612
1716
|
options: localVarRequestOptions,
|
|
1613
1717
|
};
|
|
1614
1718
|
}),
|
|
1615
1719
|
/**
|
|
1616
|
-
*
|
|
1617
|
-
* @param {string} id The `file` ID.
|
|
1618
|
-
* @param {
|
|
1720
|
+
* Update a `file-collection`.
|
|
1721
|
+
* @param {string} id The `file-collection` ID.
|
|
1722
|
+
* @param {UpdateFileCollectionRequest} updateFileCollectionRequest
|
|
1619
1723
|
* @param {*} [options] Override http request option.
|
|
1620
1724
|
* @throws {RequiredError}
|
|
1621
1725
|
*/
|
|
1622
|
-
|
|
1623
|
-
var
|
|
1726
|
+
updateFileCollection: (id, updateFileCollectionRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1727
|
+
var _h;
|
|
1624
1728
|
// verify required parameter 'id' is not null or undefined
|
|
1625
|
-
(0, common_1.assertParamExists)('
|
|
1626
|
-
// verify required parameter '
|
|
1627
|
-
(0, common_1.assertParamExists)('
|
|
1628
|
-
const localVarPath = `/
|
|
1729
|
+
(0, common_1.assertParamExists)('updateFileCollection', 'id', id);
|
|
1730
|
+
// verify required parameter 'updateFileCollectionRequest' is not null or undefined
|
|
1731
|
+
(0, common_1.assertParamExists)('updateFileCollection', 'updateFileCollectionRequest', updateFileCollectionRequest);
|
|
1732
|
+
const localVarPath = `/file-collections/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
1629
1733
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1630
1734
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1631
1735
|
let baseOptions;
|
|
1632
1736
|
if (configuration) {
|
|
1633
1737
|
baseOptions = configuration.baseOptions;
|
|
1634
1738
|
}
|
|
1635
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
1739
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
1636
1740
|
const localVarHeaderParameter = {};
|
|
1637
1741
|
const localVarQueryParameter = {};
|
|
1638
1742
|
// authentication OAuth2 required
|
|
1639
1743
|
// oauth required
|
|
1640
1744
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
1641
|
-
localVarHeaderParameter['Content-Type'] = 'application/
|
|
1745
|
+
localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
|
|
1642
1746
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1643
|
-
let headersFromBaseOptions = (
|
|
1747
|
+
let headersFromBaseOptions = (_h = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _h !== void 0 ? _h : {};
|
|
1644
1748
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1645
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(
|
|
1749
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateFileCollectionRequest, localVarRequestOptions, configuration);
|
|
1646
1750
|
return {
|
|
1647
1751
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1648
1752
|
options: localVarRequestOptions,
|
|
@@ -1650,180 +1754,964 @@ const FilesApiAxiosParamCreator = function (configuration) {
|
|
|
1650
1754
|
}),
|
|
1651
1755
|
};
|
|
1652
1756
|
};
|
|
1653
|
-
exports.
|
|
1757
|
+
exports.FileCollectionsApiAxiosParamCreator = FileCollectionsApiAxiosParamCreator;
|
|
1654
1758
|
/**
|
|
1655
|
-
*
|
|
1759
|
+
* FileCollectionsApi - functional programming interface
|
|
1656
1760
|
* @export
|
|
1657
1761
|
*/
|
|
1658
|
-
const
|
|
1659
|
-
const localVarAxiosParamCreator = (0, exports.
|
|
1762
|
+
const FileCollectionsApiFp = function (configuration) {
|
|
1763
|
+
const localVarAxiosParamCreator = (0, exports.FileCollectionsApiAxiosParamCreator)(configuration);
|
|
1660
1764
|
return {
|
|
1661
1765
|
/**
|
|
1662
|
-
*
|
|
1663
|
-
* @param {
|
|
1766
|
+
* Add files to a `file-collection`.
|
|
1767
|
+
* @param {string} id The `file-collection` ID.
|
|
1768
|
+
* @param {FileIdList} fileIdList
|
|
1664
1769
|
* @param {*} [options] Override http request option.
|
|
1665
1770
|
* @throws {RequiredError}
|
|
1666
1771
|
*/
|
|
1667
|
-
|
|
1772
|
+
addFileCollectionFiles(id, fileIdList, options) {
|
|
1668
1773
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1669
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
1774
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.addFileCollectionFiles(id, fileIdList, options);
|
|
1670
1775
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1671
1776
|
});
|
|
1672
1777
|
},
|
|
1673
1778
|
/**
|
|
1674
|
-
*
|
|
1675
|
-
* @param {
|
|
1779
|
+
* Create a `file-collection`.
|
|
1780
|
+
* @param {CreateFileCollectionRequest} createFileCollectionRequest
|
|
1676
1781
|
* @param {*} [options] Override http request option.
|
|
1677
1782
|
* @throws {RequiredError}
|
|
1678
1783
|
*/
|
|
1679
|
-
|
|
1784
|
+
createFileCollection(createFileCollectionRequest, options) {
|
|
1680
1785
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1681
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
1786
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createFileCollection(createFileCollectionRequest, options);
|
|
1682
1787
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1683
1788
|
});
|
|
1684
1789
|
},
|
|
1685
1790
|
/**
|
|
1686
|
-
*
|
|
1687
|
-
* @param {string} id The `file` ID.
|
|
1791
|
+
* Delete a `file-collection`.
|
|
1792
|
+
* @param {string} id The `file-collection` ID.
|
|
1688
1793
|
* @param {*} [options] Override http request option.
|
|
1689
1794
|
* @throws {RequiredError}
|
|
1690
1795
|
*/
|
|
1691
|
-
|
|
1796
|
+
deleteFileCollection(id, options) {
|
|
1692
1797
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1693
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
1798
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteFileCollection(id, options);
|
|
1694
1799
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1695
1800
|
});
|
|
1696
1801
|
},
|
|
1697
1802
|
/**
|
|
1698
|
-
* Get `
|
|
1803
|
+
* Get a `file-collection` by ID.
|
|
1804
|
+
* @param {string} id The `file-collection` ID.
|
|
1805
|
+
* @param {*} [options] Override http request option.
|
|
1806
|
+
* @throws {RequiredError}
|
|
1807
|
+
*/
|
|
1808
|
+
getFileCollection(id, options) {
|
|
1809
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1810
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getFileCollection(id, options);
|
|
1811
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1812
|
+
});
|
|
1813
|
+
},
|
|
1814
|
+
/**
|
|
1815
|
+
* List the files in a `file-collection`.
|
|
1816
|
+
* @param {string} id The `file-collection` ID.
|
|
1817
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
1818
|
+
* @param {number} [pageSize] The number of items to return.
|
|
1819
|
+
* @param {*} [options] Override http request option.
|
|
1820
|
+
* @throws {RequiredError}
|
|
1821
|
+
*/
|
|
1822
|
+
listFileCollectionFiles(id, pageCursor, pageSize, options) {
|
|
1823
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1824
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listFileCollectionFiles(id, pageCursor, pageSize, options);
|
|
1825
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1826
|
+
});
|
|
1827
|
+
},
|
|
1828
|
+
/**
|
|
1829
|
+
* List `file-collection`s by supplied ID.
|
|
1699
1830
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
1700
1831
|
* @param {number} [pageSize] The number of items to return.
|
|
1701
1832
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
1702
1833
|
* @param {*} [options] Override http request option.
|
|
1703
1834
|
* @throws {RequiredError}
|
|
1704
1835
|
*/
|
|
1705
|
-
|
|
1836
|
+
listFileCollections(pageCursor, pageSize, filterSuppliedId, options) {
|
|
1706
1837
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1707
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
1838
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listFileCollections(pageCursor, pageSize, filterSuppliedId, options);
|
|
1708
1839
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1709
1840
|
});
|
|
1710
1841
|
},
|
|
1711
1842
|
/**
|
|
1712
|
-
*
|
|
1713
|
-
* @param {string} id The `file` ID.
|
|
1714
|
-
* @param {
|
|
1843
|
+
* Remove a file from a `file-collection`.
|
|
1844
|
+
* @param {string} id The `file-collection` ID.
|
|
1845
|
+
* @param {string} [filterFileId] Comma-separated list of file-ids to filter on.
|
|
1715
1846
|
* @param {*} [options] Override http request option.
|
|
1716
1847
|
* @throws {RequiredError}
|
|
1717
1848
|
*/
|
|
1718
|
-
|
|
1849
|
+
removeFileCollectionFiles(id, filterFileId, options) {
|
|
1719
1850
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1720
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
1851
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.removeFileCollectionFiles(id, filterFileId, options);
|
|
1721
1852
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1722
1853
|
});
|
|
1723
1854
|
},
|
|
1724
1855
|
/**
|
|
1725
|
-
*
|
|
1726
|
-
* @param {string} id The `file` ID.
|
|
1727
|
-
* @param {
|
|
1856
|
+
* Update a `file-collection`.
|
|
1857
|
+
* @param {string} id The `file-collection` ID.
|
|
1858
|
+
* @param {UpdateFileCollectionRequest} updateFileCollectionRequest
|
|
1728
1859
|
* @param {*} [options] Override http request option.
|
|
1729
1860
|
* @throws {RequiredError}
|
|
1730
1861
|
*/
|
|
1731
|
-
|
|
1862
|
+
updateFileCollection(id, updateFileCollectionRequest, options) {
|
|
1732
1863
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1733
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
1864
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateFileCollection(id, updateFileCollectionRequest, options);
|
|
1734
1865
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1735
1866
|
});
|
|
1736
1867
|
},
|
|
1737
1868
|
};
|
|
1738
1869
|
};
|
|
1739
|
-
exports.
|
|
1870
|
+
exports.FileCollectionsApiFp = FileCollectionsApiFp;
|
|
1740
1871
|
/**
|
|
1741
|
-
*
|
|
1872
|
+
* FileCollectionsApi - factory interface
|
|
1742
1873
|
* @export
|
|
1743
1874
|
*/
|
|
1744
|
-
const
|
|
1745
|
-
const localVarFp = (0, exports.
|
|
1875
|
+
const FileCollectionsApiFactory = function (configuration, basePath, axios) {
|
|
1876
|
+
const localVarFp = (0, exports.FileCollectionsApiFp)(configuration);
|
|
1746
1877
|
return {
|
|
1747
1878
|
/**
|
|
1748
|
-
*
|
|
1749
|
-
* @param {
|
|
1879
|
+
* Add files to a `file-collection`.
|
|
1880
|
+
* @param {string} id The `file-collection` ID.
|
|
1881
|
+
* @param {FileIdList} fileIdList
|
|
1750
1882
|
* @param {*} [options] Override http request option.
|
|
1751
1883
|
* @throws {RequiredError}
|
|
1752
1884
|
*/
|
|
1753
|
-
|
|
1885
|
+
addFileCollectionFiles(id, fileIdList, options) {
|
|
1754
1886
|
return localVarFp
|
|
1755
|
-
.
|
|
1887
|
+
.addFileCollectionFiles(id, fileIdList, options)
|
|
1756
1888
|
.then((request) => request(axios, basePath));
|
|
1757
1889
|
},
|
|
1758
1890
|
/**
|
|
1759
|
-
*
|
|
1760
|
-
* @param {
|
|
1891
|
+
* Create a `file-collection`.
|
|
1892
|
+
* @param {CreateFileCollectionRequest} createFileCollectionRequest
|
|
1761
1893
|
* @param {*} [options] Override http request option.
|
|
1762
1894
|
* @throws {RequiredError}
|
|
1763
1895
|
*/
|
|
1764
|
-
|
|
1896
|
+
createFileCollection(createFileCollectionRequest, options) {
|
|
1765
1897
|
return localVarFp
|
|
1766
|
-
.
|
|
1898
|
+
.createFileCollection(createFileCollectionRequest, options)
|
|
1767
1899
|
.then((request) => request(axios, basePath));
|
|
1768
1900
|
},
|
|
1769
1901
|
/**
|
|
1770
|
-
*
|
|
1771
|
-
* @param {string} id The `file` ID.
|
|
1902
|
+
* Delete a `file-collection`.
|
|
1903
|
+
* @param {string} id The `file-collection` ID.
|
|
1772
1904
|
* @param {*} [options] Override http request option.
|
|
1773
1905
|
* @throws {RequiredError}
|
|
1774
1906
|
*/
|
|
1775
|
-
|
|
1907
|
+
deleteFileCollection(id, options) {
|
|
1776
1908
|
return localVarFp
|
|
1777
|
-
.
|
|
1909
|
+
.deleteFileCollection(id, options)
|
|
1778
1910
|
.then((request) => request(axios, basePath));
|
|
1779
1911
|
},
|
|
1780
1912
|
/**
|
|
1781
|
-
* Get `
|
|
1913
|
+
* Get a `file-collection` by ID.
|
|
1914
|
+
* @param {string} id The `file-collection` ID.
|
|
1915
|
+
* @param {*} [options] Override http request option.
|
|
1916
|
+
* @throws {RequiredError}
|
|
1917
|
+
*/
|
|
1918
|
+
getFileCollection(id, options) {
|
|
1919
|
+
return localVarFp
|
|
1920
|
+
.getFileCollection(id, options)
|
|
1921
|
+
.then((request) => request(axios, basePath));
|
|
1922
|
+
},
|
|
1923
|
+
/**
|
|
1924
|
+
* List the files in a `file-collection`.
|
|
1925
|
+
* @param {string} id The `file-collection` ID.
|
|
1926
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
1927
|
+
* @param {number} [pageSize] The number of items to return.
|
|
1928
|
+
* @param {*} [options] Override http request option.
|
|
1929
|
+
* @throws {RequiredError}
|
|
1930
|
+
*/
|
|
1931
|
+
listFileCollectionFiles(id, pageCursor, pageSize, options) {
|
|
1932
|
+
return localVarFp
|
|
1933
|
+
.listFileCollectionFiles(id, pageCursor, pageSize, options)
|
|
1934
|
+
.then((request) => request(axios, basePath));
|
|
1935
|
+
},
|
|
1936
|
+
/**
|
|
1937
|
+
* List `file-collection`s by supplied ID.
|
|
1782
1938
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
1783
1939
|
* @param {number} [pageSize] The number of items to return.
|
|
1784
1940
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
1785
1941
|
* @param {*} [options] Override http request option.
|
|
1786
1942
|
* @throws {RequiredError}
|
|
1787
1943
|
*/
|
|
1788
|
-
|
|
1944
|
+
listFileCollections(pageCursor, pageSize, filterSuppliedId, options) {
|
|
1789
1945
|
return localVarFp
|
|
1790
|
-
.
|
|
1946
|
+
.listFileCollections(pageCursor, pageSize, filterSuppliedId, options)
|
|
1791
1947
|
.then((request) => request(axios, basePath));
|
|
1792
1948
|
},
|
|
1793
1949
|
/**
|
|
1794
|
-
*
|
|
1795
|
-
* @param {string} id The `file` ID.
|
|
1796
|
-
* @param {
|
|
1950
|
+
* Remove a file from a `file-collection`.
|
|
1951
|
+
* @param {string} id The `file-collection` ID.
|
|
1952
|
+
* @param {string} [filterFileId] Comma-separated list of file-ids to filter on.
|
|
1797
1953
|
* @param {*} [options] Override http request option.
|
|
1798
1954
|
* @throws {RequiredError}
|
|
1799
1955
|
*/
|
|
1800
|
-
|
|
1956
|
+
removeFileCollectionFiles(id, filterFileId, options) {
|
|
1801
1957
|
return localVarFp
|
|
1802
|
-
.
|
|
1958
|
+
.removeFileCollectionFiles(id, filterFileId, options)
|
|
1803
1959
|
.then((request) => request(axios, basePath));
|
|
1804
1960
|
},
|
|
1805
1961
|
/**
|
|
1806
|
-
*
|
|
1807
|
-
* @param {string} id The `file` ID.
|
|
1808
|
-
* @param {
|
|
1962
|
+
* Update a `file-collection`.
|
|
1963
|
+
* @param {string} id The `file-collection` ID.
|
|
1964
|
+
* @param {UpdateFileCollectionRequest} updateFileCollectionRequest
|
|
1809
1965
|
* @param {*} [options] Override http request option.
|
|
1810
1966
|
* @throws {RequiredError}
|
|
1811
1967
|
*/
|
|
1812
|
-
|
|
1968
|
+
updateFileCollection(id, updateFileCollectionRequest, options) {
|
|
1813
1969
|
return localVarFp
|
|
1814
|
-
.
|
|
1970
|
+
.updateFileCollection(id, updateFileCollectionRequest, options)
|
|
1815
1971
|
.then((request) => request(axios, basePath));
|
|
1816
1972
|
},
|
|
1817
1973
|
};
|
|
1818
1974
|
};
|
|
1819
|
-
exports.
|
|
1975
|
+
exports.FileCollectionsApiFactory = FileCollectionsApiFactory;
|
|
1820
1976
|
/**
|
|
1821
|
-
*
|
|
1977
|
+
* FileCollectionsApi - object-oriented interface
|
|
1822
1978
|
* @export
|
|
1823
|
-
* @class
|
|
1979
|
+
* @class FileCollectionsApi
|
|
1824
1980
|
* @extends {BaseAPI}
|
|
1825
1981
|
*/
|
|
1826
|
-
class
|
|
1982
|
+
class FileCollectionsApi extends base_1.BaseAPI {
|
|
1983
|
+
/**
|
|
1984
|
+
* Add files to a `file-collection`.
|
|
1985
|
+
* @param {FileCollectionsApiAddFileCollectionFilesRequest} requestParameters Request parameters.
|
|
1986
|
+
* @param {*} [options] Override http request option.
|
|
1987
|
+
* @throws {RequiredError}
|
|
1988
|
+
* @memberof FileCollectionsApi
|
|
1989
|
+
*/
|
|
1990
|
+
addFileCollectionFiles(requestParameters, options) {
|
|
1991
|
+
return (0, exports.FileCollectionsApiFp)(this.configuration)
|
|
1992
|
+
.addFileCollectionFiles(requestParameters.id, requestParameters.fileIdList, options)
|
|
1993
|
+
.then((request) => request(this.axios, this.basePath));
|
|
1994
|
+
}
|
|
1995
|
+
/**
|
|
1996
|
+
* Create a `file-collection`.
|
|
1997
|
+
* @param {FileCollectionsApiCreateFileCollectionRequest} requestParameters Request parameters.
|
|
1998
|
+
* @param {*} [options] Override http request option.
|
|
1999
|
+
* @throws {RequiredError}
|
|
2000
|
+
* @memberof FileCollectionsApi
|
|
2001
|
+
*/
|
|
2002
|
+
createFileCollection(requestParameters, options) {
|
|
2003
|
+
return (0, exports.FileCollectionsApiFp)(this.configuration)
|
|
2004
|
+
.createFileCollection(requestParameters.createFileCollectionRequest, options)
|
|
2005
|
+
.then((request) => request(this.axios, this.basePath));
|
|
2006
|
+
}
|
|
2007
|
+
/**
|
|
2008
|
+
* Delete a `file-collection`.
|
|
2009
|
+
* @param {FileCollectionsApiDeleteFileCollectionRequest} requestParameters Request parameters.
|
|
2010
|
+
* @param {*} [options] Override http request option.
|
|
2011
|
+
* @throws {RequiredError}
|
|
2012
|
+
* @memberof FileCollectionsApi
|
|
2013
|
+
*/
|
|
2014
|
+
deleteFileCollection(requestParameters, options) {
|
|
2015
|
+
return (0, exports.FileCollectionsApiFp)(this.configuration)
|
|
2016
|
+
.deleteFileCollection(requestParameters.id, options)
|
|
2017
|
+
.then((request) => request(this.axios, this.basePath));
|
|
2018
|
+
}
|
|
2019
|
+
/**
|
|
2020
|
+
* Get a `file-collection` by ID.
|
|
2021
|
+
* @param {FileCollectionsApiGetFileCollectionRequest} requestParameters Request parameters.
|
|
2022
|
+
* @param {*} [options] Override http request option.
|
|
2023
|
+
* @throws {RequiredError}
|
|
2024
|
+
* @memberof FileCollectionsApi
|
|
2025
|
+
*/
|
|
2026
|
+
getFileCollection(requestParameters, options) {
|
|
2027
|
+
return (0, exports.FileCollectionsApiFp)(this.configuration)
|
|
2028
|
+
.getFileCollection(requestParameters.id, options)
|
|
2029
|
+
.then((request) => request(this.axios, this.basePath));
|
|
2030
|
+
}
|
|
2031
|
+
/**
|
|
2032
|
+
* List the files in a `file-collection`.
|
|
2033
|
+
* @param {FileCollectionsApiListFileCollectionFilesRequest} requestParameters Request parameters.
|
|
2034
|
+
* @param {*} [options] Override http request option.
|
|
2035
|
+
* @throws {RequiredError}
|
|
2036
|
+
* @memberof FileCollectionsApi
|
|
2037
|
+
*/
|
|
2038
|
+
listFileCollectionFiles(requestParameters, options) {
|
|
2039
|
+
return (0, exports.FileCollectionsApiFp)(this.configuration)
|
|
2040
|
+
.listFileCollectionFiles(requestParameters.id, requestParameters.pageCursor, requestParameters.pageSize, options)
|
|
2041
|
+
.then((request) => request(this.axios, this.basePath));
|
|
2042
|
+
}
|
|
2043
|
+
/**
|
|
2044
|
+
* List `file-collection`s by supplied ID.
|
|
2045
|
+
* @param {FileCollectionsApiListFileCollectionsRequest} requestParameters Request parameters.
|
|
2046
|
+
* @param {*} [options] Override http request option.
|
|
2047
|
+
* @throws {RequiredError}
|
|
2048
|
+
* @memberof FileCollectionsApi
|
|
2049
|
+
*/
|
|
2050
|
+
listFileCollections(requestParameters = {}, options) {
|
|
2051
|
+
return (0, exports.FileCollectionsApiFp)(this.configuration)
|
|
2052
|
+
.listFileCollections(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterSuppliedId, options)
|
|
2053
|
+
.then((request) => request(this.axios, this.basePath));
|
|
2054
|
+
}
|
|
2055
|
+
/**
|
|
2056
|
+
* Remove a file from a `file-collection`.
|
|
2057
|
+
* @param {FileCollectionsApiRemoveFileCollectionFilesRequest} requestParameters Request parameters.
|
|
2058
|
+
* @param {*} [options] Override http request option.
|
|
2059
|
+
* @throws {RequiredError}
|
|
2060
|
+
* @memberof FileCollectionsApi
|
|
2061
|
+
*/
|
|
2062
|
+
removeFileCollectionFiles(requestParameters, options) {
|
|
2063
|
+
return (0, exports.FileCollectionsApiFp)(this.configuration)
|
|
2064
|
+
.removeFileCollectionFiles(requestParameters.id, requestParameters.filterFileId, options)
|
|
2065
|
+
.then((request) => request(this.axios, this.basePath));
|
|
2066
|
+
}
|
|
2067
|
+
/**
|
|
2068
|
+
* Update a `file-collection`.
|
|
2069
|
+
* @param {FileCollectionsApiUpdateFileCollectionRequest} requestParameters Request parameters.
|
|
2070
|
+
* @param {*} [options] Override http request option.
|
|
2071
|
+
* @throws {RequiredError}
|
|
2072
|
+
* @memberof FileCollectionsApi
|
|
2073
|
+
*/
|
|
2074
|
+
updateFileCollection(requestParameters, options) {
|
|
2075
|
+
return (0, exports.FileCollectionsApiFp)(this.configuration)
|
|
2076
|
+
.updateFileCollection(requestParameters.id, requestParameters.updateFileCollectionRequest, options)
|
|
2077
|
+
.then((request) => request(this.axios, this.basePath));
|
|
2078
|
+
}
|
|
2079
|
+
}
|
|
2080
|
+
exports.FileCollectionsApi = FileCollectionsApi;
|
|
2081
|
+
/**
|
|
2082
|
+
* FileJobsApi - axios parameter creator
|
|
2083
|
+
* @export
|
|
2084
|
+
*/
|
|
2085
|
+
const FileJobsApiAxiosParamCreator = function (configuration) {
|
|
2086
|
+
return {
|
|
2087
|
+
/**
|
|
2088
|
+
* Create a `file-job`.
|
|
2089
|
+
* @param {CreateFileJobRequest} createFileJobRequest
|
|
2090
|
+
* @param {*} [options] Override http request option.
|
|
2091
|
+
* @throws {RequiredError}
|
|
2092
|
+
*/
|
|
2093
|
+
createFileJob: (createFileJobRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
2094
|
+
var _a;
|
|
2095
|
+
// verify required parameter 'createFileJobRequest' is not null or undefined
|
|
2096
|
+
(0, common_1.assertParamExists)('createFileJob', 'createFileJobRequest', createFileJobRequest);
|
|
2097
|
+
const localVarPath = `/file-jobs`;
|
|
2098
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2099
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2100
|
+
let baseOptions;
|
|
2101
|
+
if (configuration) {
|
|
2102
|
+
baseOptions = configuration.baseOptions;
|
|
2103
|
+
}
|
|
2104
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
2105
|
+
const localVarHeaderParameter = {};
|
|
2106
|
+
const localVarQueryParameter = {};
|
|
2107
|
+
// authentication OAuth2 required
|
|
2108
|
+
// oauth required
|
|
2109
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
2110
|
+
localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
|
|
2111
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2112
|
+
let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
|
|
2113
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2114
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createFileJobRequest, localVarRequestOptions, configuration);
|
|
2115
|
+
return {
|
|
2116
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2117
|
+
options: localVarRequestOptions,
|
|
2118
|
+
};
|
|
2119
|
+
}),
|
|
2120
|
+
/**
|
|
2121
|
+
* Get the status and result of a `file-job`.
|
|
2122
|
+
* @param {string} id The ID of a file job.
|
|
2123
|
+
* @param {*} [options] Override http request option.
|
|
2124
|
+
* @throws {RequiredError}
|
|
2125
|
+
*/
|
|
2126
|
+
getFileJob: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
2127
|
+
var _b;
|
|
2128
|
+
// verify required parameter 'id' is not null or undefined
|
|
2129
|
+
(0, common_1.assertParamExists)('getFileJob', 'id', id);
|
|
2130
|
+
const localVarPath = `/file-jobs/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
2131
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2132
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2133
|
+
let baseOptions;
|
|
2134
|
+
if (configuration) {
|
|
2135
|
+
baseOptions = configuration.baseOptions;
|
|
2136
|
+
}
|
|
2137
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2138
|
+
const localVarHeaderParameter = {};
|
|
2139
|
+
const localVarQueryParameter = {};
|
|
2140
|
+
// authentication OAuth2 required
|
|
2141
|
+
// oauth required
|
|
2142
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
2143
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2144
|
+
let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
|
|
2145
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2146
|
+
return {
|
|
2147
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2148
|
+
options: localVarRequestOptions,
|
|
2149
|
+
};
|
|
2150
|
+
}),
|
|
2151
|
+
};
|
|
2152
|
+
};
|
|
2153
|
+
exports.FileJobsApiAxiosParamCreator = FileJobsApiAxiosParamCreator;
|
|
2154
|
+
/**
|
|
2155
|
+
* FileJobsApi - functional programming interface
|
|
2156
|
+
* @export
|
|
2157
|
+
*/
|
|
2158
|
+
const FileJobsApiFp = function (configuration) {
|
|
2159
|
+
const localVarAxiosParamCreator = (0, exports.FileJobsApiAxiosParamCreator)(configuration);
|
|
2160
|
+
return {
|
|
2161
|
+
/**
|
|
2162
|
+
* Create a `file-job`.
|
|
2163
|
+
* @param {CreateFileJobRequest} createFileJobRequest
|
|
2164
|
+
* @param {*} [options] Override http request option.
|
|
2165
|
+
* @throws {RequiredError}
|
|
2166
|
+
*/
|
|
2167
|
+
createFileJob(createFileJobRequest, options) {
|
|
2168
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2169
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createFileJob(createFileJobRequest, options);
|
|
2170
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
2171
|
+
});
|
|
2172
|
+
},
|
|
2173
|
+
/**
|
|
2174
|
+
* Get the status and result of a `file-job`.
|
|
2175
|
+
* @param {string} id The ID of a file job.
|
|
2176
|
+
* @param {*} [options] Override http request option.
|
|
2177
|
+
* @throws {RequiredError}
|
|
2178
|
+
*/
|
|
2179
|
+
getFileJob(id, options) {
|
|
2180
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2181
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getFileJob(id, options);
|
|
2182
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
2183
|
+
});
|
|
2184
|
+
},
|
|
2185
|
+
};
|
|
2186
|
+
};
|
|
2187
|
+
exports.FileJobsApiFp = FileJobsApiFp;
|
|
2188
|
+
/**
|
|
2189
|
+
* FileJobsApi - factory interface
|
|
2190
|
+
* @export
|
|
2191
|
+
*/
|
|
2192
|
+
const FileJobsApiFactory = function (configuration, basePath, axios) {
|
|
2193
|
+
const localVarFp = (0, exports.FileJobsApiFp)(configuration);
|
|
2194
|
+
return {
|
|
2195
|
+
/**
|
|
2196
|
+
* Create a `file-job`.
|
|
2197
|
+
* @param {CreateFileJobRequest} createFileJobRequest
|
|
2198
|
+
* @param {*} [options] Override http request option.
|
|
2199
|
+
* @throws {RequiredError}
|
|
2200
|
+
*/
|
|
2201
|
+
createFileJob(createFileJobRequest, options) {
|
|
2202
|
+
return localVarFp
|
|
2203
|
+
.createFileJob(createFileJobRequest, options)
|
|
2204
|
+
.then((request) => request(axios, basePath));
|
|
2205
|
+
},
|
|
2206
|
+
/**
|
|
2207
|
+
* Get the status and result of a `file-job`.
|
|
2208
|
+
* @param {string} id The ID of a file job.
|
|
2209
|
+
* @param {*} [options] Override http request option.
|
|
2210
|
+
* @throws {RequiredError}
|
|
2211
|
+
*/
|
|
2212
|
+
getFileJob(id, options) {
|
|
2213
|
+
return localVarFp
|
|
2214
|
+
.getFileJob(id, options)
|
|
2215
|
+
.then((request) => request(axios, basePath));
|
|
2216
|
+
},
|
|
2217
|
+
};
|
|
2218
|
+
};
|
|
2219
|
+
exports.FileJobsApiFactory = FileJobsApiFactory;
|
|
2220
|
+
/**
|
|
2221
|
+
* FileJobsApi - object-oriented interface
|
|
2222
|
+
* @export
|
|
2223
|
+
* @class FileJobsApi
|
|
2224
|
+
* @extends {BaseAPI}
|
|
2225
|
+
*/
|
|
2226
|
+
class FileJobsApi extends base_1.BaseAPI {
|
|
2227
|
+
/**
|
|
2228
|
+
* Create a `file-job`.
|
|
2229
|
+
* @param {FileJobsApiCreateFileJobRequest} requestParameters Request parameters.
|
|
2230
|
+
* @param {*} [options] Override http request option.
|
|
2231
|
+
* @throws {RequiredError}
|
|
2232
|
+
* @memberof FileJobsApi
|
|
2233
|
+
*/
|
|
2234
|
+
createFileJob(requestParameters, options) {
|
|
2235
|
+
return (0, exports.FileJobsApiFp)(this.configuration)
|
|
2236
|
+
.createFileJob(requestParameters.createFileJobRequest, options)
|
|
2237
|
+
.then((request) => request(this.axios, this.basePath));
|
|
2238
|
+
}
|
|
2239
|
+
/**
|
|
2240
|
+
* Get the status and result of a `file-job`.
|
|
2241
|
+
* @param {FileJobsApiGetFileJobRequest} requestParameters Request parameters.
|
|
2242
|
+
* @param {*} [options] Override http request option.
|
|
2243
|
+
* @throws {RequiredError}
|
|
2244
|
+
* @memberof FileJobsApi
|
|
2245
|
+
*/
|
|
2246
|
+
getFileJob(requestParameters, options) {
|
|
2247
|
+
return (0, exports.FileJobsApiFp)(this.configuration)
|
|
2248
|
+
.getFileJob(requestParameters.id, options)
|
|
2249
|
+
.then((request) => request(this.axios, this.basePath));
|
|
2250
|
+
}
|
|
2251
|
+
}
|
|
2252
|
+
exports.FileJobsApi = FileJobsApi;
|
|
2253
|
+
/**
|
|
2254
|
+
* FilesApi - axios parameter creator
|
|
2255
|
+
* @export
|
|
2256
|
+
*/
|
|
2257
|
+
const FilesApiAxiosParamCreator = function (configuration) {
|
|
2258
|
+
return {
|
|
2259
|
+
/**
|
|
2260
|
+
* Create a download uri for a `file` by ID.
|
|
2261
|
+
* @param {string} id The `file` ID.
|
|
2262
|
+
* @param {CreateDownloadRequest} createDownloadRequest
|
|
2263
|
+
* @param {*} [options] Override http request option.
|
|
2264
|
+
* @throws {RequiredError}
|
|
2265
|
+
*/
|
|
2266
|
+
createDownloadUrl: (id, createDownloadRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
2267
|
+
var _a;
|
|
2268
|
+
// verify required parameter 'id' is not null or undefined
|
|
2269
|
+
(0, common_1.assertParamExists)('createDownloadUrl', 'id', id);
|
|
2270
|
+
// verify required parameter 'createDownloadRequest' is not null or undefined
|
|
2271
|
+
(0, common_1.assertParamExists)('createDownloadUrl', 'createDownloadRequest', createDownloadRequest);
|
|
2272
|
+
const localVarPath = `/files/{id}/download-url`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
2273
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2274
|
+
const localVarUrlObj = new URL(localVarPath, common_1.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 (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
2285
|
+
localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
|
|
2286
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2287
|
+
let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
|
|
2288
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2289
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createDownloadRequest, localVarRequestOptions, configuration);
|
|
2290
|
+
return {
|
|
2291
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2292
|
+
options: localVarRequestOptions,
|
|
2293
|
+
};
|
|
2294
|
+
}),
|
|
2295
|
+
/**
|
|
2296
|
+
* 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.
|
|
2297
|
+
* @param {CreateFileRequest} createFileRequest
|
|
2298
|
+
* @param {*} [options] Override http request option.
|
|
2299
|
+
* @throws {RequiredError}
|
|
2300
|
+
*/
|
|
2301
|
+
createFile: (createFileRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
2302
|
+
var _b;
|
|
2303
|
+
// verify required parameter 'createFileRequest' is not null or undefined
|
|
2304
|
+
(0, common_1.assertParamExists)('createFile', 'createFileRequest', createFileRequest);
|
|
2305
|
+
const localVarPath = `/files`;
|
|
2306
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2307
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2308
|
+
let baseOptions;
|
|
2309
|
+
if (configuration) {
|
|
2310
|
+
baseOptions = configuration.baseOptions;
|
|
2311
|
+
}
|
|
2312
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
2313
|
+
const localVarHeaderParameter = {};
|
|
2314
|
+
const localVarQueryParameter = {};
|
|
2315
|
+
// authentication OAuth2 required
|
|
2316
|
+
// oauth required
|
|
2317
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
2318
|
+
localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
|
|
2319
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2320
|
+
let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
|
|
2321
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2322
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createFileRequest, localVarRequestOptions, configuration);
|
|
2323
|
+
return {
|
|
2324
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2325
|
+
options: localVarRequestOptions,
|
|
2326
|
+
};
|
|
2327
|
+
}),
|
|
2328
|
+
/**
|
|
2329
|
+
* Delete a `file`.
|
|
2330
|
+
* @param {string} id The `file` ID.
|
|
2331
|
+
* @param {*} [options] Override http request option.
|
|
2332
|
+
* @throws {RequiredError}
|
|
2333
|
+
*/
|
|
2334
|
+
deleteFile: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
2335
|
+
var _c;
|
|
2336
|
+
// verify required parameter 'id' is not null or undefined
|
|
2337
|
+
(0, common_1.assertParamExists)('deleteFile', 'id', id);
|
|
2338
|
+
const localVarPath = `/files/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
2339
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2340
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2341
|
+
let baseOptions;
|
|
2342
|
+
if (configuration) {
|
|
2343
|
+
baseOptions = configuration.baseOptions;
|
|
2344
|
+
}
|
|
2345
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
2346
|
+
const localVarHeaderParameter = {};
|
|
2347
|
+
const localVarQueryParameter = {};
|
|
2348
|
+
// authentication OAuth2 required
|
|
2349
|
+
// oauth required
|
|
2350
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
2351
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2352
|
+
let headersFromBaseOptions = (_c = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _c !== void 0 ? _c : {};
|
|
2353
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2354
|
+
return {
|
|
2355
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2356
|
+
options: localVarRequestOptions,
|
|
2357
|
+
};
|
|
2358
|
+
}),
|
|
2359
|
+
/**
|
|
2360
|
+
* Get a `file` by ID.
|
|
2361
|
+
* @param {string} id The `file` ID.
|
|
2362
|
+
* @param {*} [options] Override http request option.
|
|
2363
|
+
* @throws {RequiredError}
|
|
2364
|
+
*/
|
|
2365
|
+
getFile: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
2366
|
+
var _d;
|
|
2367
|
+
// verify required parameter 'id' is not null or undefined
|
|
2368
|
+
(0, common_1.assertParamExists)('getFile', 'id', id);
|
|
2369
|
+
const localVarPath = `/files/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
2370
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2371
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2372
|
+
let baseOptions;
|
|
2373
|
+
if (configuration) {
|
|
2374
|
+
baseOptions = configuration.baseOptions;
|
|
2375
|
+
}
|
|
2376
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2377
|
+
const localVarHeaderParameter = {};
|
|
2378
|
+
const localVarQueryParameter = {};
|
|
2379
|
+
// authentication OAuth2 required
|
|
2380
|
+
// oauth required
|
|
2381
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
2382
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2383
|
+
let headersFromBaseOptions = (_d = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _d !== void 0 ? _d : {};
|
|
2384
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2385
|
+
return {
|
|
2386
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2387
|
+
options: localVarRequestOptions,
|
|
2388
|
+
};
|
|
2389
|
+
}),
|
|
2390
|
+
/**
|
|
2391
|
+
* Get `files`.
|
|
2392
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
2393
|
+
* @param {number} [pageSize] The number of items to return.
|
|
2394
|
+
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
2395
|
+
* @param {*} [options] Override http request option.
|
|
2396
|
+
* @throws {RequiredError}
|
|
2397
|
+
*/
|
|
2398
|
+
getFiles: (pageCursor, pageSize, filterSuppliedId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
2399
|
+
var _e;
|
|
2400
|
+
const localVarPath = `/files`;
|
|
2401
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2402
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2403
|
+
let baseOptions;
|
|
2404
|
+
if (configuration) {
|
|
2405
|
+
baseOptions = configuration.baseOptions;
|
|
2406
|
+
}
|
|
2407
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2408
|
+
const localVarHeaderParameter = {};
|
|
2409
|
+
const localVarQueryParameter = {};
|
|
2410
|
+
// authentication OAuth2 required
|
|
2411
|
+
// oauth required
|
|
2412
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
2413
|
+
if (pageCursor !== undefined) {
|
|
2414
|
+
localVarQueryParameter['page[cursor]'] = pageCursor;
|
|
2415
|
+
}
|
|
2416
|
+
if (pageSize !== undefined) {
|
|
2417
|
+
localVarQueryParameter['page[size]'] = pageSize;
|
|
2418
|
+
}
|
|
2419
|
+
if (filterSuppliedId !== undefined) {
|
|
2420
|
+
localVarQueryParameter['filter[suppliedId]'] = filterSuppliedId;
|
|
2421
|
+
}
|
|
2422
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2423
|
+
let headersFromBaseOptions = (_e = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _e !== void 0 ? _e : {};
|
|
2424
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2425
|
+
return {
|
|
2426
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2427
|
+
options: localVarRequestOptions,
|
|
2428
|
+
};
|
|
2429
|
+
}),
|
|
2430
|
+
/**
|
|
2431
|
+
* Update a `file`.
|
|
2432
|
+
* @param {string} id The `file` ID.
|
|
2433
|
+
* @param {UpdateFileRequest} updateFileRequest
|
|
2434
|
+
* @param {*} [options] Override http request option.
|
|
2435
|
+
* @throws {RequiredError}
|
|
2436
|
+
*/
|
|
2437
|
+
updateFile: (id, updateFileRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
2438
|
+
var _f;
|
|
2439
|
+
// verify required parameter 'id' is not null or undefined
|
|
2440
|
+
(0, common_1.assertParamExists)('updateFile', 'id', id);
|
|
2441
|
+
// verify required parameter 'updateFileRequest' is not null or undefined
|
|
2442
|
+
(0, common_1.assertParamExists)('updateFile', 'updateFileRequest', updateFileRequest);
|
|
2443
|
+
const localVarPath = `/files/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
2444
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2445
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2446
|
+
let baseOptions;
|
|
2447
|
+
if (configuration) {
|
|
2448
|
+
baseOptions = configuration.baseOptions;
|
|
2449
|
+
}
|
|
2450
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
2451
|
+
const localVarHeaderParameter = {};
|
|
2452
|
+
const localVarQueryParameter = {};
|
|
2453
|
+
// authentication OAuth2 required
|
|
2454
|
+
// oauth required
|
|
2455
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
2456
|
+
localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
|
|
2457
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2458
|
+
let headersFromBaseOptions = (_f = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _f !== void 0 ? _f : {};
|
|
2459
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2460
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateFileRequest, localVarRequestOptions, configuration);
|
|
2461
|
+
return {
|
|
2462
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2463
|
+
options: localVarRequestOptions,
|
|
2464
|
+
};
|
|
2465
|
+
}),
|
|
2466
|
+
/**
|
|
2467
|
+
* Upload a `file`. Once uploaded, create either parts or geometry sets via the createPart or createGeometrySet APIs.
|
|
2468
|
+
* @param {string} id The `file` ID.
|
|
2469
|
+
* @param {any} body
|
|
2470
|
+
* @param {*} [options] Override http request option.
|
|
2471
|
+
* @throws {RequiredError}
|
|
2472
|
+
*/
|
|
2473
|
+
uploadFile: (id, body, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
2474
|
+
var _g;
|
|
2475
|
+
// verify required parameter 'id' is not null or undefined
|
|
2476
|
+
(0, common_1.assertParamExists)('uploadFile', 'id', id);
|
|
2477
|
+
// verify required parameter 'body' is not null or undefined
|
|
2478
|
+
(0, common_1.assertParamExists)('uploadFile', 'body', body);
|
|
2479
|
+
const localVarPath = `/files/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
2480
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2481
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2482
|
+
let baseOptions;
|
|
2483
|
+
if (configuration) {
|
|
2484
|
+
baseOptions = configuration.baseOptions;
|
|
2485
|
+
}
|
|
2486
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
2487
|
+
const localVarHeaderParameter = {};
|
|
2488
|
+
const localVarQueryParameter = {};
|
|
2489
|
+
// authentication OAuth2 required
|
|
2490
|
+
// oauth required
|
|
2491
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
2492
|
+
localVarHeaderParameter['Content-Type'] = 'application/octet-stream';
|
|
2493
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2494
|
+
let headersFromBaseOptions = (_g = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _g !== void 0 ? _g : {};
|
|
2495
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2496
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
|
|
2497
|
+
return {
|
|
2498
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2499
|
+
options: localVarRequestOptions,
|
|
2500
|
+
};
|
|
2501
|
+
}),
|
|
2502
|
+
};
|
|
2503
|
+
};
|
|
2504
|
+
exports.FilesApiAxiosParamCreator = FilesApiAxiosParamCreator;
|
|
2505
|
+
/**
|
|
2506
|
+
* FilesApi - functional programming interface
|
|
2507
|
+
* @export
|
|
2508
|
+
*/
|
|
2509
|
+
const FilesApiFp = function (configuration) {
|
|
2510
|
+
const localVarAxiosParamCreator = (0, exports.FilesApiAxiosParamCreator)(configuration);
|
|
2511
|
+
return {
|
|
2512
|
+
/**
|
|
2513
|
+
* Create a download uri for a `file` by ID.
|
|
2514
|
+
* @param {string} id The `file` ID.
|
|
2515
|
+
* @param {CreateDownloadRequest} createDownloadRequest
|
|
2516
|
+
* @param {*} [options] Override http request option.
|
|
2517
|
+
* @throws {RequiredError}
|
|
2518
|
+
*/
|
|
2519
|
+
createDownloadUrl(id, createDownloadRequest, options) {
|
|
2520
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2521
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createDownloadUrl(id, createDownloadRequest, options);
|
|
2522
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
2523
|
+
});
|
|
2524
|
+
},
|
|
2525
|
+
/**
|
|
2526
|
+
* 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.
|
|
2527
|
+
* @param {CreateFileRequest} createFileRequest
|
|
2528
|
+
* @param {*} [options] Override http request option.
|
|
2529
|
+
* @throws {RequiredError}
|
|
2530
|
+
*/
|
|
2531
|
+
createFile(createFileRequest, options) {
|
|
2532
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2533
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createFile(createFileRequest, options);
|
|
2534
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
2535
|
+
});
|
|
2536
|
+
},
|
|
2537
|
+
/**
|
|
2538
|
+
* Delete a `file`.
|
|
2539
|
+
* @param {string} id The `file` ID.
|
|
2540
|
+
* @param {*} [options] Override http request option.
|
|
2541
|
+
* @throws {RequiredError}
|
|
2542
|
+
*/
|
|
2543
|
+
deleteFile(id, options) {
|
|
2544
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2545
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteFile(id, options);
|
|
2546
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
2547
|
+
});
|
|
2548
|
+
},
|
|
2549
|
+
/**
|
|
2550
|
+
* Get a `file` by ID.
|
|
2551
|
+
* @param {string} id The `file` ID.
|
|
2552
|
+
* @param {*} [options] Override http request option.
|
|
2553
|
+
* @throws {RequiredError}
|
|
2554
|
+
*/
|
|
2555
|
+
getFile(id, options) {
|
|
2556
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2557
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getFile(id, options);
|
|
2558
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
2559
|
+
});
|
|
2560
|
+
},
|
|
2561
|
+
/**
|
|
2562
|
+
* Get `files`.
|
|
2563
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
2564
|
+
* @param {number} [pageSize] The number of items to return.
|
|
2565
|
+
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
2566
|
+
* @param {*} [options] Override http request option.
|
|
2567
|
+
* @throws {RequiredError}
|
|
2568
|
+
*/
|
|
2569
|
+
getFiles(pageCursor, pageSize, filterSuppliedId, options) {
|
|
2570
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2571
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getFiles(pageCursor, pageSize, filterSuppliedId, options);
|
|
2572
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
2573
|
+
});
|
|
2574
|
+
},
|
|
2575
|
+
/**
|
|
2576
|
+
* Update a `file`.
|
|
2577
|
+
* @param {string} id The `file` ID.
|
|
2578
|
+
* @param {UpdateFileRequest} updateFileRequest
|
|
2579
|
+
* @param {*} [options] Override http request option.
|
|
2580
|
+
* @throws {RequiredError}
|
|
2581
|
+
*/
|
|
2582
|
+
updateFile(id, updateFileRequest, options) {
|
|
2583
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2584
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateFile(id, updateFileRequest, options);
|
|
2585
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
2586
|
+
});
|
|
2587
|
+
},
|
|
2588
|
+
/**
|
|
2589
|
+
* Upload a `file`. Once uploaded, create either parts or geometry sets via the createPart or createGeometrySet APIs.
|
|
2590
|
+
* @param {string} id The `file` ID.
|
|
2591
|
+
* @param {any} body
|
|
2592
|
+
* @param {*} [options] Override http request option.
|
|
2593
|
+
* @throws {RequiredError}
|
|
2594
|
+
*/
|
|
2595
|
+
uploadFile(id, body, options) {
|
|
2596
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2597
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.uploadFile(id, body, options);
|
|
2598
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
2599
|
+
});
|
|
2600
|
+
},
|
|
2601
|
+
};
|
|
2602
|
+
};
|
|
2603
|
+
exports.FilesApiFp = FilesApiFp;
|
|
2604
|
+
/**
|
|
2605
|
+
* FilesApi - factory interface
|
|
2606
|
+
* @export
|
|
2607
|
+
*/
|
|
2608
|
+
const FilesApiFactory = function (configuration, basePath, axios) {
|
|
2609
|
+
const localVarFp = (0, exports.FilesApiFp)(configuration);
|
|
2610
|
+
return {
|
|
2611
|
+
/**
|
|
2612
|
+
* Create a download uri for a `file` by ID.
|
|
2613
|
+
* @param {string} id The `file` ID.
|
|
2614
|
+
* @param {CreateDownloadRequest} createDownloadRequest
|
|
2615
|
+
* @param {*} [options] Override http request option.
|
|
2616
|
+
* @throws {RequiredError}
|
|
2617
|
+
*/
|
|
2618
|
+
createDownloadUrl(id, createDownloadRequest, options) {
|
|
2619
|
+
return localVarFp
|
|
2620
|
+
.createDownloadUrl(id, createDownloadRequest, options)
|
|
2621
|
+
.then((request) => request(axios, basePath));
|
|
2622
|
+
},
|
|
2623
|
+
/**
|
|
2624
|
+
* 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.
|
|
2625
|
+
* @param {CreateFileRequest} createFileRequest
|
|
2626
|
+
* @param {*} [options] Override http request option.
|
|
2627
|
+
* @throws {RequiredError}
|
|
2628
|
+
*/
|
|
2629
|
+
createFile(createFileRequest, options) {
|
|
2630
|
+
return localVarFp
|
|
2631
|
+
.createFile(createFileRequest, options)
|
|
2632
|
+
.then((request) => request(axios, basePath));
|
|
2633
|
+
},
|
|
2634
|
+
/**
|
|
2635
|
+
* Delete a `file`.
|
|
2636
|
+
* @param {string} id The `file` ID.
|
|
2637
|
+
* @param {*} [options] Override http request option.
|
|
2638
|
+
* @throws {RequiredError}
|
|
2639
|
+
*/
|
|
2640
|
+
deleteFile(id, options) {
|
|
2641
|
+
return localVarFp
|
|
2642
|
+
.deleteFile(id, options)
|
|
2643
|
+
.then((request) => request(axios, basePath));
|
|
2644
|
+
},
|
|
2645
|
+
/**
|
|
2646
|
+
* Get a `file` by ID.
|
|
2647
|
+
* @param {string} id The `file` ID.
|
|
2648
|
+
* @param {*} [options] Override http request option.
|
|
2649
|
+
* @throws {RequiredError}
|
|
2650
|
+
*/
|
|
2651
|
+
getFile(id, options) {
|
|
2652
|
+
return localVarFp
|
|
2653
|
+
.getFile(id, options)
|
|
2654
|
+
.then((request) => request(axios, basePath));
|
|
2655
|
+
},
|
|
2656
|
+
/**
|
|
2657
|
+
* Get `files`.
|
|
2658
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
2659
|
+
* @param {number} [pageSize] The number of items to return.
|
|
2660
|
+
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
2661
|
+
* @param {*} [options] Override http request option.
|
|
2662
|
+
* @throws {RequiredError}
|
|
2663
|
+
*/
|
|
2664
|
+
getFiles(pageCursor, pageSize, filterSuppliedId, options) {
|
|
2665
|
+
return localVarFp
|
|
2666
|
+
.getFiles(pageCursor, pageSize, filterSuppliedId, options)
|
|
2667
|
+
.then((request) => request(axios, basePath));
|
|
2668
|
+
},
|
|
2669
|
+
/**
|
|
2670
|
+
* Update a `file`.
|
|
2671
|
+
* @param {string} id The `file` ID.
|
|
2672
|
+
* @param {UpdateFileRequest} updateFileRequest
|
|
2673
|
+
* @param {*} [options] Override http request option.
|
|
2674
|
+
* @throws {RequiredError}
|
|
2675
|
+
*/
|
|
2676
|
+
updateFile(id, updateFileRequest, options) {
|
|
2677
|
+
return localVarFp
|
|
2678
|
+
.updateFile(id, updateFileRequest, options)
|
|
2679
|
+
.then((request) => request(axios, basePath));
|
|
2680
|
+
},
|
|
2681
|
+
/**
|
|
2682
|
+
* Upload a `file`. Once uploaded, create either parts or geometry sets via the createPart or createGeometrySet APIs.
|
|
2683
|
+
* @param {string} id The `file` ID.
|
|
2684
|
+
* @param {any} body
|
|
2685
|
+
* @param {*} [options] Override http request option.
|
|
2686
|
+
* @throws {RequiredError}
|
|
2687
|
+
*/
|
|
2688
|
+
uploadFile(id, body, options) {
|
|
2689
|
+
return localVarFp
|
|
2690
|
+
.uploadFile(id, body, options)
|
|
2691
|
+
.then((request) => request(axios, basePath));
|
|
2692
|
+
},
|
|
2693
|
+
};
|
|
2694
|
+
};
|
|
2695
|
+
exports.FilesApiFactory = FilesApiFactory;
|
|
2696
|
+
/**
|
|
2697
|
+
* FilesApi - object-oriented interface
|
|
2698
|
+
* @export
|
|
2699
|
+
* @class FilesApi
|
|
2700
|
+
* @extends {BaseAPI}
|
|
2701
|
+
*/
|
|
2702
|
+
class FilesApi extends base_1.BaseAPI {
|
|
2703
|
+
/**
|
|
2704
|
+
* Create a download uri for a `file` by ID.
|
|
2705
|
+
* @param {FilesApiCreateDownloadUrlRequest} requestParameters Request parameters.
|
|
2706
|
+
* @param {*} [options] Override http request option.
|
|
2707
|
+
* @throws {RequiredError}
|
|
2708
|
+
* @memberof FilesApi
|
|
2709
|
+
*/
|
|
2710
|
+
createDownloadUrl(requestParameters, options) {
|
|
2711
|
+
return (0, exports.FilesApiFp)(this.configuration)
|
|
2712
|
+
.createDownloadUrl(requestParameters.id, requestParameters.createDownloadRequest, options)
|
|
2713
|
+
.then((request) => request(this.axios, this.basePath));
|
|
2714
|
+
}
|
|
1827
2715
|
/**
|
|
1828
2716
|
* 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.
|
|
1829
2717
|
* @param {FilesApiCreateFileRequest} requestParameters Request parameters.
|
|
@@ -2983,7 +3871,7 @@ exports.Oauth2Api = Oauth2Api;
|
|
|
2983
3871
|
const PartRenditionsApiAxiosParamCreator = function (configuration) {
|
|
2984
3872
|
return {
|
|
2985
3873
|
/**
|
|
2986
|
-
*
|
|
3874
|
+
* Creates a part-rendition associated with a part-revision
|
|
2987
3875
|
* @param {string} id The `part-revision` ID.
|
|
2988
3876
|
* @param {CreatePartRenditionRequest} createPartRenditionRequest
|
|
2989
3877
|
* @param {*} [options] Override http request option.
|
|
@@ -3104,7 +3992,7 @@ const PartRenditionsApiFp = function (configuration) {
|
|
|
3104
3992
|
const localVarAxiosParamCreator = (0, exports.PartRenditionsApiAxiosParamCreator)(configuration);
|
|
3105
3993
|
return {
|
|
3106
3994
|
/**
|
|
3107
|
-
*
|
|
3995
|
+
* Creates a part-rendition associated with a part-revision
|
|
3108
3996
|
* @param {string} id The `part-revision` ID.
|
|
3109
3997
|
* @param {CreatePartRenditionRequest} createPartRenditionRequest
|
|
3110
3998
|
* @param {*} [options] Override http request option.
|
|
@@ -3154,7 +4042,7 @@ const PartRenditionsApiFactory = function (configuration, basePath, axios) {
|
|
|
3154
4042
|
const localVarFp = (0, exports.PartRenditionsApiFp)(configuration);
|
|
3155
4043
|
return {
|
|
3156
4044
|
/**
|
|
3157
|
-
*
|
|
4045
|
+
* Creates a part-rendition associated with a part-revision
|
|
3158
4046
|
* @param {string} id The `part-revision` ID.
|
|
3159
4047
|
* @param {CreatePartRenditionRequest} createPartRenditionRequest
|
|
3160
4048
|
* @param {*} [options] Override http request option.
|
|
@@ -3201,7 +4089,7 @@ exports.PartRenditionsApiFactory = PartRenditionsApiFactory;
|
|
|
3201
4089
|
*/
|
|
3202
4090
|
class PartRenditionsApi extends base_1.BaseAPI {
|
|
3203
4091
|
/**
|
|
3204
|
-
*
|
|
4092
|
+
* Creates a part-rendition associated with a part-revision
|
|
3205
4093
|
* @param {PartRenditionsApiCreatePartRenditionRequest} requestParameters Request parameters.
|
|
3206
4094
|
* @param {*} [options] Override http request option.
|
|
3207
4095
|
* @throws {RequiredError}
|
|
@@ -3245,7 +4133,7 @@ exports.PartRenditionsApi = PartRenditionsApi;
|
|
|
3245
4133
|
const PartRevisionInstancesApiAxiosParamCreator = function (configuration) {
|
|
3246
4134
|
return {
|
|
3247
4135
|
/**
|
|
3248
|
-
* 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
|
|
4136
|
+
* 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.
|
|
3249
4137
|
* @param {string} [filterParent] Parent ID to filter on.
|
|
3250
4138
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
3251
4139
|
* @param {number} [pageSize] The number of items to return.
|
|
@@ -3295,7 +4183,7 @@ const PartRevisionInstancesApiFp = function (configuration) {
|
|
|
3295
4183
|
const localVarAxiosParamCreator = (0, exports.PartRevisionInstancesApiAxiosParamCreator)(configuration);
|
|
3296
4184
|
return {
|
|
3297
4185
|
/**
|
|
3298
|
-
* 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
|
|
4186
|
+
* 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.
|
|
3299
4187
|
* @param {string} [filterParent] Parent ID to filter on.
|
|
3300
4188
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
3301
4189
|
* @param {number} [pageSize] The number of items to return.
|
|
@@ -3319,7 +4207,7 @@ const PartRevisionInstancesApiFactory = function (configuration, basePath, axios
|
|
|
3319
4207
|
const localVarFp = (0, exports.PartRevisionInstancesApiFp)(configuration);
|
|
3320
4208
|
return {
|
|
3321
4209
|
/**
|
|
3322
|
-
* 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
|
|
4210
|
+
* 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.
|
|
3323
4211
|
* @param {string} [filterParent] Parent ID to filter on.
|
|
3324
4212
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
3325
4213
|
* @param {number} [pageSize] The number of items to return.
|
|
@@ -3342,7 +4230,7 @@ exports.PartRevisionInstancesApiFactory = PartRevisionInstancesApiFactory;
|
|
|
3342
4230
|
*/
|
|
3343
4231
|
class PartRevisionInstancesApi extends base_1.BaseAPI {
|
|
3344
4232
|
/**
|
|
3345
|
-
* 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
|
|
4233
|
+
* 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.
|
|
3346
4234
|
* @param {PartRevisionInstancesApiGetPartRevisionInstanceListRequest} requestParameters Request parameters.
|
|
3347
4235
|
* @param {*} [options] Override http request option.
|
|
3348
4236
|
* @throws {RequiredError}
|
|
@@ -3587,7 +4475,7 @@ const PartRevisionsApiAxiosParamCreator = function (configuration) {
|
|
|
3587
4475
|
};
|
|
3588
4476
|
}),
|
|
3589
4477
|
/**
|
|
3590
|
-
* 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.
|
|
4478
|
+
* 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.
|
|
3591
4479
|
* @param {string} id The `part-revision` ID.
|
|
3592
4480
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
3593
4481
|
* @param {*} [options] Override http request option.
|
|
@@ -3709,7 +4597,7 @@ const PartRevisionsApiFp = function (configuration) {
|
|
|
3709
4597
|
});
|
|
3710
4598
|
},
|
|
3711
4599
|
/**
|
|
3712
|
-
* 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.
|
|
4600
|
+
* 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.
|
|
3713
4601
|
* @param {string} id The `part-revision` ID.
|
|
3714
4602
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
3715
4603
|
* @param {*} [options] Override http request option.
|
|
@@ -3803,7 +4691,7 @@ const PartRevisionsApiFactory = function (configuration, basePath, axios) {
|
|
|
3803
4691
|
.then((request) => request(axios, basePath));
|
|
3804
4692
|
},
|
|
3805
4693
|
/**
|
|
3806
|
-
* 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.
|
|
4694
|
+
* 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.
|
|
3807
4695
|
* @param {string} id The `part-revision` ID.
|
|
3808
4696
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
3809
4697
|
* @param {*} [options] Override http request option.
|
|
@@ -3885,7 +4773,7 @@ class PartRevisionsApi extends base_1.BaseAPI {
|
|
|
3885
4773
|
.then((request) => request(this.axios, this.basePath));
|
|
3886
4774
|
}
|
|
3887
4775
|
/**
|
|
3888
|
-
* 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.
|
|
4776
|
+
* 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.
|
|
3889
4777
|
* @param {PartRevisionsApiUpdatePartRevisionRequest} requestParameters Request parameters.
|
|
3890
4778
|
* @param {*} [options] Override http request option.
|
|
3891
4779
|
* @throws {RequiredError}
|
|
@@ -3905,7 +4793,7 @@ exports.PartRevisionsApi = PartRevisionsApi;
|
|
|
3905
4793
|
const PartsApiAxiosParamCreator = function (configuration) {
|
|
3906
4794
|
return {
|
|
3907
4795
|
/**
|
|
3908
|
-
* 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`
|
|
4796
|
+
* 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.
|
|
3909
4797
|
* @param {CreatePartRequest} createPartRequest
|
|
3910
4798
|
* @param {*} [options] Override http request option.
|
|
3911
4799
|
* @throws {RequiredError}
|
|
@@ -4085,7 +4973,7 @@ const PartsApiFp = function (configuration) {
|
|
|
4085
4973
|
const localVarAxiosParamCreator = (0, exports.PartsApiAxiosParamCreator)(configuration);
|
|
4086
4974
|
return {
|
|
4087
4975
|
/**
|
|
4088
|
-
* 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`
|
|
4976
|
+
* 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.
|
|
4089
4977
|
* @param {CreatePartRequest} createPartRequest
|
|
4090
4978
|
* @param {*} [options] Override http request option.
|
|
4091
4979
|
* @throws {RequiredError}
|
|
@@ -4158,7 +5046,7 @@ const PartsApiFactory = function (configuration, basePath, axios) {
|
|
|
4158
5046
|
const localVarFp = (0, exports.PartsApiFp)(configuration);
|
|
4159
5047
|
return {
|
|
4160
5048
|
/**
|
|
4161
|
-
* 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.
|
|
4162
5050
|
* @param {CreatePartRequest} createPartRequest
|
|
4163
5051
|
* @param {*} [options] Override http request option.
|
|
4164
5052
|
* @throws {RequiredError}
|
|
@@ -4226,7 +5114,7 @@ exports.PartsApiFactory = PartsApiFactory;
|
|
|
4226
5114
|
*/
|
|
4227
5115
|
class PartsApi extends base_1.BaseAPI {
|
|
4228
5116
|
/**
|
|
4229
|
-
* 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`
|
|
5117
|
+
* 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.
|
|
4230
5118
|
* @param {PartsApiCreatePartRequest} requestParameters Request parameters.
|
|
4231
5119
|
* @param {*} [options] Override http request option.
|
|
4232
5120
|
* @throws {RequiredError}
|
|
@@ -4411,7 +5299,7 @@ exports.PmiApi = PmiApi;
|
|
|
4411
5299
|
const PropertyEntriesApiAxiosParamCreator = function (configuration) {
|
|
4412
5300
|
return {
|
|
4413
5301
|
/**
|
|
4414
|
-
* Get `property-entries` by a resource ID
|
|
5302
|
+
* Get `property-entries` by a resource ID
|
|
4415
5303
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
4416
5304
|
* @param {number} [pageSize] The number of items to return.
|
|
4417
5305
|
* @param {string} [filterResourceId] A resource ID to filter on
|
|
@@ -4455,7 +5343,7 @@ const PropertyEntriesApiAxiosParamCreator = function (configuration) {
|
|
|
4455
5343
|
};
|
|
4456
5344
|
}),
|
|
4457
5345
|
/**
|
|
4458
|
-
* Upsert property-entries for a provided resource.
|
|
5346
|
+
* Upsert property-entries for a provided resource.
|
|
4459
5347
|
* @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
|
|
4460
5348
|
* @param {*} [options] Override http request option.
|
|
4461
5349
|
* @throws {RequiredError}
|
|
@@ -4498,7 +5386,7 @@ const PropertyEntriesApiFp = function (configuration) {
|
|
|
4498
5386
|
const localVarAxiosParamCreator = (0, exports.PropertyEntriesApiAxiosParamCreator)(configuration);
|
|
4499
5387
|
return {
|
|
4500
5388
|
/**
|
|
4501
|
-
* Get `property-entries` by a resource ID
|
|
5389
|
+
* Get `property-entries` by a resource ID
|
|
4502
5390
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
4503
5391
|
* @param {number} [pageSize] The number of items to return.
|
|
4504
5392
|
* @param {string} [filterResourceId] A resource ID to filter on
|
|
@@ -4513,7 +5401,7 @@ const PropertyEntriesApiFp = function (configuration) {
|
|
|
4513
5401
|
});
|
|
4514
5402
|
},
|
|
4515
5403
|
/**
|
|
4516
|
-
* Upsert property-entries for a provided resource.
|
|
5404
|
+
* Upsert property-entries for a provided resource.
|
|
4517
5405
|
* @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
|
|
4518
5406
|
* @param {*} [options] Override http request option.
|
|
4519
5407
|
* @throws {RequiredError}
|
|
@@ -4535,7 +5423,7 @@ const PropertyEntriesApiFactory = function (configuration, basePath, axios) {
|
|
|
4535
5423
|
const localVarFp = (0, exports.PropertyEntriesApiFp)(configuration);
|
|
4536
5424
|
return {
|
|
4537
5425
|
/**
|
|
4538
|
-
* Get `property-entries` by a resource ID
|
|
5426
|
+
* Get `property-entries` by a resource ID
|
|
4539
5427
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
4540
5428
|
* @param {number} [pageSize] The number of items to return.
|
|
4541
5429
|
* @param {string} [filterResourceId] A resource ID to filter on
|
|
@@ -4549,7 +5437,7 @@ const PropertyEntriesApiFactory = function (configuration, basePath, axios) {
|
|
|
4549
5437
|
.then((request) => request(axios, basePath));
|
|
4550
5438
|
},
|
|
4551
5439
|
/**
|
|
4552
|
-
* Upsert property-entries for a provided resource.
|
|
5440
|
+
* Upsert property-entries for a provided resource.
|
|
4553
5441
|
* @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
|
|
4554
5442
|
* @param {*} [options] Override http request option.
|
|
4555
5443
|
* @throws {RequiredError}
|
|
@@ -4570,7 +5458,7 @@ exports.PropertyEntriesApiFactory = PropertyEntriesApiFactory;
|
|
|
4570
5458
|
*/
|
|
4571
5459
|
class PropertyEntriesApi extends base_1.BaseAPI {
|
|
4572
5460
|
/**
|
|
4573
|
-
* Get `property-entries` by a resource ID
|
|
5461
|
+
* Get `property-entries` by a resource ID
|
|
4574
5462
|
* @param {PropertyEntriesApiGetPropertyEntriesRequest} requestParameters Request parameters.
|
|
4575
5463
|
* @param {*} [options] Override http request option.
|
|
4576
5464
|
* @throws {RequiredError}
|
|
@@ -4582,7 +5470,7 @@ class PropertyEntriesApi extends base_1.BaseAPI {
|
|
|
4582
5470
|
.then((request) => request(this.axios, this.basePath));
|
|
4583
5471
|
}
|
|
4584
5472
|
/**
|
|
4585
|
-
* Upsert property-entries for a provided resource.
|
|
5473
|
+
* Upsert property-entries for a provided resource.
|
|
4586
5474
|
* @param {PropertyEntriesApiUpsertPropertyEntriesRequest} requestParameters Request parameters.
|
|
4587
5475
|
* @param {*} [options] Override http request option.
|
|
4588
5476
|
* @throws {RequiredError}
|